README

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

功能

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

需求

PHP 5.5或更高版本

SimpleSAMLphp

MongoDB

MongoDB PHP扩展

安装

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

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

此命令将把makeitheady/simplesamlphp-module-mongo添加到项目的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集合中。

运行测试

在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模块做出贡献

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

如果你希望为项目做出贡献，请在此repo上创建分支并提交拉取请求。

许可

版权（c）2017 Prolific Interactive

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