README

此模块是SimpleSAMLphp (SSP)数据存储的实现，用于添加对MongoDB PHP库的支持。

特性

可用于MongoDB的会话后端存储
支持副本集

需求

PHP 5.5或更高

SimpleSAMLphp

MongoDB

MongoDB PHP扩展

安装

如果你的项目使用Composer管理SSP，请运行

php composer.phar require makeitheady/simplesamlphp-module-mongodb

此命令将添加makeitheady/simplesamlphp-module-mongodb到你的项目的composer.json文件中，并将模块安装到SSP的modules目录中，该目录相对于你的项目根目录通常是vendor/simplesamlphp/simplesamlphp/modules。

使用

将SSP配置文件中的store.type选项设置为mongo:Store。

通过将提供的文件从config-templates目录复制到SSP的配置目录，并通过设置以下环境变量，向模块提供你的MongoDB连接信息：

DB_DEFAULT_CONNECTION
DB_MONGODB_HOST
DB_MONGODB_PORT
DB_MONGODB_USERNAME
DB_MONGODB_PASSWORD
DB_MONGODB_DATABASE

DB_DEFAULT_CONNECTION - 可以设置为以下配置

mongodb - default
mongodb_replica - mongodb replica set
mongodb_replica_string - full mongo db connection string with replica set

如果你连接到副本集，你还需要设置以下环境变量

DB_DEFAULT_CONNECTION   # Must contain the substring "_replica"
DB_MONGODB_REPLICASET
DB_MONGODB_READ_PREFERENCE

有关DB_MONGODB_REPLICASET和DB_MONGODB_READ_PREFERENCE的正确值的更多信息，请参阅MongoDB扩展PHP手册。

如果你想使用完整的数据库连接字符串，你还需要设置以下环境变量

DB_DEFAULT_CONNECTION=mongodb_replica_string
DB_MONGODB_DSN=<mongodb connection string>
DB_MONGODB_DATABASE

最后，通过在vendor/simplesamlphp/simplesamlphp/modules/mongodb目录中创建一个名为enable的空文件来启用模块。

注意：此模块将PHP会话数据存储在session集合中。

运行测试

在fixture目录下设置配置。test/lib/Store/fixture/single-host/module_mongodb.php 手动设置环境变量

export DB_DEFAULT_CONNECTION=<database connection>
export DB_MONGODB_DATABASE=<database>

运行测试

vendor/bin/phpunit --bootstrap vendor/autoload.php --testsuite Store Tests

为SimpleSAMLphp Mongo模块做出贡献

要报告错误或增强请求，请随意在相应的标题下提交问题。

如果你希望为该项目做出贡献，请在此存储库上进行Fork并提交pull请求。

许可证

版权（c）2017 Prolific Interactive

SimpleSAMLphp Mongo模块由Prolific Interactive维护和赞助。它可以根据LICENSE文件中指定的条款重新分发。

makeitheady / simplesamlphp-module-mongodb

维护者

详细信息

README

特性

需求

安装

使用

运行测试

为SimpleSAMLphp Mongo模块做出贡献

许可证