inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2026-09-02 10:18:42 +00:00
Code Activity

Clarify SSO setup via Database Admin interface (#12474)

Browse Source 
* Clarify SSO setup via Database Admin interface

Fixes #10415 by documenting that Social applications are
configured in Django admin at /admin/, not via config.yaml or API.

* docs: move Database Admin access details to db_admin.md

Per review: drop the access-how-to from SSO.md and link to the Database Admin guide instead.

---------

Co-authored-by: Matthias Mair <code@mjmair.com>
This commit is contained in:
Senior Data Engineer
2026-09-01 21:59:08 +10:00
committed by GitHub
co-authored by Matthias Mair
parent e1ff60a64c
commit ffcbbf6292
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/settings/SSO.md
+7 -4
View File
@@ -18,11 +18,14 @@ The basic requirements for configuring SSO are outlined below:
1. Enable backend for each required SSO provider(s) in the [config file or environment variables](../start/config.md#single-sign-on). 1. Enable backend for each required SSO provider(s) in the [config file or environment variables](../start/config.md#single-sign-on).
1. Create an external *app* with your provider of choice 1. Create an external *app* with your provider of choice
1. Add the required client configurations in the `SocialApp` app in the [Database Admin interface](../settings/db_admin.md). 1. Add the required client configurations as a *Social application* in the [Database Admin interface](./db_admin.md).
1. Configure the *callback* URL for the external app. 1. Configure the *callback* URL for the external app.
1. Enable SSO for the users in the [global settings](../settings/global.md). 1. Enable SSO for the users in the [global settings](../settings/global.md).
1. Configure [e-mail](../settings/email.md). 1. Configure [e-mail](../settings/email.md).
!!! info "Two-step setup"
Provider modules are enabled in `config.yaml` (or environment variables). Client IDs, secrets, and site assignments are **not** configured there — they must be added as *Social applications* in the [Database Admin interface](./db_admin.md). SSO providers cannot be configured via the InvenTree API.
### Enable Provider Backends ### Enable Provider Backends
The first step is to ensure that the required provider modules are installed, via your installation [configuration file](../start/config.md#single-sign-on). The first step is to ensure that the required provider modules are installed, via your installation [configuration file](../start/config.md#single-sign-on).
@@ -61,13 +64,13 @@ In general, the external app will generate a *key* and *secret* pair - although
### Add Client Configurations ### Add Client Configurations
Once your external SSO app has been created, you need to create a new *SocialAccount* client configuration (via the InvenTree admin interface). Once your external SSO app has been created, you need to create a new *Social application* entry in the [Database Admin interface](./db_admin.md) (under **Social accounts** → **Social applications** — not in the Admin Center).
#### Create Social Application #### Create Social Application
In the admin interface, select *Add Social Application* Select **Add social application** (top right of the social applications list). Social applications are listed under the **Social accounts** section of the Database Admin — not in the InvenTree Admin Center settings screens.
{{ image("settings/social_account_add.png", "Add Social Application") }} {{ image("settings/social_account_add.png", "Database Admin — Social applications section") }}
#### Configure Social Application #### Configure Social Application