inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-10-31 12:55:37 +00:00
Code Activity

overview document for sso

Browse Source
This commit is contained in:
Matthias Mair
2021-09-09 07:42:36 +02:00
parent ea2fa644f2
commit 3ee9915dfe
2 changed files with 26 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/admin/SSO.md Normal file
View File

@@ -0,0 +1,25 @@
---
title: InvenTree Single Sign On
---
## Single Sign On
InvenTree provides the possibility to use 3rd party services to authenticate users. This functionality makes use of [django-allauth](https://django-allauth.readthedocs.io/en/latest/) and supports a wide array of OpenID and OAuth [provider](https://django-allauth.readthedocs.io/en/latest/providers.html).
### Configuration
To use SSO you have to:
1. Enable the needed providers in the [config file](../start/config.md#Single-Sign-on).
1. Add the required client configurations in the `SocialApp` app in the [admin interface](../admin/admin.md).
1. Enable SSO for the users in the [dynamic settings](../admin/settings.md).
### Security Consideration
You should use SSL for your website if you want to use this feature. Also set your callback-endpoints to `https://` addresses to reduce the risk of leaking user's tokens.
Tokens for authenticating the users to the providers they registered with are saved in the database.
So ensure your database is protected and not open to the internet.
Make sure all users with admin privileges have sufficient passwords - they can read out your client configurations with providers and all auth-tokens from users.
Never share your installs secret key!