You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

49 lines
1.1 KiB
Markdown

5 years ago
# Synapse Mozilla SAML MXID Mapper
Custom SAML auth response -> MXID mapping algorithm used during the Mozilla
Matrix trial run.
## Installation
This plugin can be installed via [PyPi](https://pypi.org):
```
pip install matrix-synapse-saml-moz
```
## Usage
### Config
5 years ago
Add the following in your Synapse config:
5 years ago
```yaml
saml2_config:
user_mapping_provider: "saml_mapping_provider.SamlMappingProvider"
5 years ago
```
### Configuration Options
Synapse allows SAML mapping providers to specify custom configuration through the
`saml2_config.user_mapping_provider_config` option.
The options supported by this provider are currently:
* `mxid_source_attribute` - The SAML attribute (after mapping via the
attribute maps) to use to derive the Matrix
ID from. 'uid' by default.
5 years ago
## Development and Testing
This repository uses `tox` to run linting and tests.
### Linting
5 years ago
Code is linted with the `flake8` tool. Run `tox -e pep8` to check for linting
errors in the codebase.
### Tests
This repository uses `unittest` to run the tests located in the `tests`
directory. They can be ran with `tox -e tests`.