inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-06-15 19:55:34 +00:00
Code Activity

Sso docs (#414)

Browse Source 
* Add tip and fix link

* Add cross link

* Add example image for configuration file

* Expand SSO docs
This commit is contained in:
Oliver
2023-01-03 23:30:49 +11:00
committed by GitHub
parent d8d9ff6c49
commit be689a6f1e
6 changed files with 101 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/start/config.md
View File

@ -38,6 +38,9 @@ A configuration file *template* can be found on [GitHub](https://github.com/inve
!!! info "Template File"
The default configuration file (as defined by the template linked above) will be copied to the specifed configuration file location on first run, if a configuration file is not found in that location.
!!! tip "Restart Server"
The contents of the configuration file are read when the InevnTree server first launches. If any changes are made to the configuration file, ensure that the server is restarted, so that the changes can be made operational.
## Basic Options
The following basic options are available:
@ -193,7 +196,7 @@ Alternatively this location can be specified with the `INVENTREE_BACKUP_DIR` env
InvenTree provides allowance for additional sign-in options. The following options are not enabled by default, and care must be taken by the system administrator when configuring these settings.
### Single Sign on
### Single Sign On
SSO backends for all required authentication providers need to be added to the config file as a list under the key `social_backends`. The correct backend-name can be found in django-allauths [configuration documentation](https://django-allauth.readthedocs.io/en/latest/installation.html#django).
@ -202,6 +205,8 @@ If the selected providers need additional settings they must be added as dicts u
!!! warning "You are not done"
SSO still needs credentials for all providers and has to be enabled in the [global settings](../settings/global.md)!
!!! tip "More Info"
Refer to the [SSO documentation](../settings/SSO.md) for more information.
### Login Options