inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-04-27 05:06:43 +00:00
Code

Add documentation for SSO callback URL (#418)

Browse Source
This commit is contained in:
Oliver 2023-01-08 00:29:00 +11:00 committed by GitHub
parent bfdb3f9989
commit 67b97f1e4d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/settings/SSO.md
View File

@ -16,6 +16,7 @@ The basic requirements for configuring SSO are outlined below:
1. Enable the required providers in the [config file](../start/config.md#single-sign-on).
1. Create an external *app* with your provider of choice
1. Add the required client configurations in the `SocialApp` app in the [admin interface](../settings/admin.md).
1. Configure the *callback* URL for the external app.
1. Enable SSO for the users in the [global settings](../settings/global.md).
1. Configure [e-mail](../settings/email.md).
@ -83,6 +84,15 @@ Configure the social application entry with the app details:
!!! success "Multiple Applications"
To provide support for multiple SSO applications, simply repeat this process and create another social application entry
### Configure Callback URL
The external SSO application must be provided with a *callback* URL - a URL by which it can communicate with the InvenTree server. The specific *name* that the external SSO application uses for this callback URL may vary, with some authentication applications referring to it with other names such as *reply* or *redirect*.
In any case, the URL is is specific to your installation and the SSO provider. The general pattern for this URL is: `{% raw %}<hostname>/accounts/<provider>/login/callback/{% endraw %}`.
!!! success "Works for Local Installs"
Your server does not need to be "public facing" for this to work. For example the URL `http://localhost:1234/accounts/github/login/callback/` would be perfectly valid!
### Enable SSO Settings
Now that the social application is created, you need to enable SSO authentication for the InvenTree server.