Skip to content

Commit

Permalink
Add activation info
Browse files Browse the repository at this point in the history
  • Loading branch information
stmichaelis authored Sep 13, 2024
1 parent d65a858 commit 75f9dc6
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,17 @@ You can install the plugin directly from PyPI:
```
pip install indico-sso-group-mapping
```

After installation, activate the plugin via adding it to the `PLUGINS` variable in `indico.conf`:
```
PLUGINS = {'sso_group_mapping'}
```
## Functionality
This plugin adds users logging in via a given identity provider, configurably filtered by the domain of the identity, to a configurable local group. The goal is to grant privileges (such as room booking) to all users using a given identity provider and, optionally, identity domain. An example use case would be Shibboleth SSO via federated identities, only granting those users with a given identity domain local privileges.

Furthermore, this plugin features a celery cron job which can optionally clean out users from the local group after they have not used the configured identity provider and identity domain for a configured number of days. This covers changes in a user's affiliation.

## Settings
After installation, the plugin (named `SSO Group Mapping`) offers various settings in the Admin backend.
After installation, the plugin (named `SSO Group Mapping`) offers various settings in the Admin backend in the `Plugins` category of the sidebar.

### Provider
The identity provider to which accounts need to be associated to be added to the group.
Expand Down

0 comments on commit 75f9dc6

Please sign in to comment.