https://github.com/prolificinteractive/simplesamlphp-module-mongodb
SimpleSAML Store implementation for MongoDB PHP Library
https://github.com/prolificinteractive/simplesamlphp-module-mongodb
Last synced: about 1 year ago
JSON representation
SimpleSAML Store implementation for MongoDB PHP Library
- Host: GitHub
- URL: https://github.com/prolificinteractive/simplesamlphp-module-mongodb
- Owner: prolificinteractive
- License: mit
- Created: 2019-02-20T23:03:08.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-01T18:47:57.000Z (over 7 years ago)
- Last Synced: 2024-04-14T15:22:15.796Z (about 2 years ago)
- Language: PHP
- Homepage:
- Size: 32.2 KB
- Stars: 2
- Watchers: 5
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SimpleSAMLphp MongoDB Module
[](https://travis-ci.org/prolificinteractive/simplesamlphp-module-mongodb)
This module is an implementation of a SimpleSAMLphp (SSP) data store to add support for the MongoDB PHP library.
## Features
- Can be used for backend storage of sessions in MongoDB
- Includes support for replica sets
## Requirements
PHP 5.5 or higher
[SimpleSAMLphp](https://simplesamlphp.org/)
[MongoDB](https://www.mongodb.com/)
[MongoDB PHP extension](http://php.net/manual/en/book.mongodb.php)
## Installation
If your project manages SSP with [Composer](https://getcomposer.org/) run:
```
php composer.phar require prolificinteractive/simplesamlphp-module-mongodb
```
This command will add `prolificinteractive/simplesamlphp-module-mongodb` to your projects' composer.json file and install the module
into SSP's `modules` directory, which relative to your project's root directory is conventionally `vendor/simplesamlphp/simplesamlphp/modules`.
## Usage
Set the `store.type` option in your SSP config file to `mongo:Store`.
Provide your MongoDB connection information to the module by copying the file provided in the `config-templates` directory into SSP's config directory, and setting the following environment variables:
```
DB_MONGODB_HOST
DB_MONGODB_PORT
DB_MONGODB_USERNAME
DB_MONGODB_PASSWORD
DB_MONGODB_DATABASE
```
If your connecting to a replica set, you'll need to set the following environment variables below as well:
```
DB_DEFAULT_CONNECTION # Must contain the substring "_replica"
DB_MONGODB_REPLICASET
DB_MONGODB_READ_PREFERENCE
```
See the [MongoDB extension PHP Manual](http://php.net/manual/en/set.mongodb.php) for more information about appropriate values for `DB_MONGODB_REPLICASET` and `DB_MONGODB_READ_PREFERENCE`.
Finally, you can enable the module by creating an empty file name `enable` in the `vendor/simplesamlphp/simplesamlphp/modules/mongodb` directory.
**Note:** This module stores PHP session data in the `session` collection.
## Contributing to SimpleSAMLphp Mongo Module
To report a bug or enhancement request, feel free to file an issue under the respective heading.
If you wish to contribute to the project, fork this repo and submit a pull request.
## License
Copyright (c) 2017 Prolific Interactive
SimpleSAMLphp Mongo Module is maintained and sponsored by Prolific Interactive. It may be redistributed under the terms specified in the [LICENSE] file.
[LICENSE]: ./LICENSE