prolificinteractive/simplesamlphp-module-mongodb

一个用于在PHP 5.5或更高版本中为MongoDB提供SimpleSAML_Store实现的SimpleSAMLphp模块。

v2.0.1 2019-03-01 18:42 UTC

This package is not auto-updated.

Last update: 2024-09-23 08:25:24 UTC


README

Travis build status

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

功能

  • 可用于在MongoDB中作为后端存储会话
  • 支持副本集

要求

PHP 5.5或更高版本

SimpleSAMLphp

MongoDB

MongoDB PHP扩展

安装

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

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

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

使用

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

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

DB_MONGODB_HOST
DB_MONGODB_PORT
DB_MONGODB_USERNAME
DB_MONGODB_PASSWORD
DB_MONGODB_DATABASE

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

DB_DEFAULT_CONNECTION   # Must contain the substring "_replica"
DB_MONGODB_REPLICASET
DB_MONGODB_READ_PREFERENCE

有关DB_MONGODB_REPLICASETDB_MONGODB_READ_PREFERENCE的适当值的更多信息,请参阅MongoDB扩展PHP手册

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

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

为SimpleSAMLphp Mongo模块做出贡献

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

如果你希望为此项目做出贡献,请fork此存储库并提交一个pull请求。

许可

prolific

版权(c)2017 Prolific Interactive

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