From 6563b4c4134df6fc3ee9886437d4213738bc2af2 Mon Sep 17 00:00:00 2001 From: Oliver Date: Sat, 16 Sep 2023 12:17:43 +1000 Subject: [PATCH] Pin setuptools version for docker CI (#5552) * Pin setuptools version for docker CI * Fix doc links --- .github/workflows/docker.yaml | 2 +- docs/docs/settings/SSO.md | 10 +++++----- docs/docs/start/config.md | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/docker.yaml b/.github/workflows/docker.yaml index 34e319e048..54c8098ac0 100644 --- a/.github/workflows/docker.yaml +++ b/.github/workflows/docker.yaml @@ -60,7 +60,7 @@ jobs: docker-compose run inventree-dev-server invoke update docker-compose run inventree-dev-server invoke setup-dev docker-compose up -d - docker-compose run inventree-dev-server pip install --upgrade setuptools + docker-compose run inventree-dev-server pip install setuptools==68.1.2 docker-compose run inventree-dev-server invoke wait - name: Check Data Directory # The following file structure should have been created by the docker image diff --git a/docs/docs/settings/SSO.md b/docs/docs/settings/SSO.md index 542f40238c..3ca9a7d863 100644 --- a/docs/docs/settings/SSO.md +++ b/docs/docs/settings/SSO.md @@ -4,10 +4,10 @@ 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 [providers](https://django-allauth.readthedocs.io/en/latest/providers.html). +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 [providers](https://django-allauth.readthedocs.io/en/latest/socialaccount/providers/index.html). !!! tip "Provider Documentation" - There are a lot of technical considerations when configuring a particular SSO provider. A good starting point is the [django-allauth documentation](https://django-allauth.readthedocs.io/en/latest/providers.html) + There are a lot of technical considerations when configuring a particular SSO provider. A good starting point is the [django-allauth documentation](https://django-allauth.readthedocs.io/en/latest/socialaccount/providers/index.html) ## SSO Configuration @@ -28,8 +28,8 @@ There are two variables in the configuration file which define the operation of | Key | Description | More Info | | --- | --- | --- | -| `social_backends` | A *list* of provider backends enabled for the InvenTree instance | [django-allauth docs](https://django-allauth.readthedocs.io/en/latest/installation.html) | -| `social_providers` | A *dict* of settings specific to the installed providers | [provider documentation](https://django-allauth.readthedocs.io/en/latest/providers.html) | +| `social_backends` | A *list* of provider backends enabled for the InvenTree instance | [django-allauth docs](https://django-allauth.readthedocs.io/en/latest/installation/quickstart.html) | +| `social_providers` | A *dict* of settings specific to the installed providers | [provider documentation](https://django-allauth.readthedocs.io/en/latest/socialaccount/providers/index.html) | In the example below, SSO provider modules are activated for *google*, *github* and *microsoft*. Specific configuration options are specified for the *microsoft* provider module: @@ -48,7 +48,7 @@ In the example below, SSO provider modules are activated for *google*, *github* The next step is to create an external authentication app with your provider of choice. This step is wholly separate to your InvenTree installation, and must be performed before continuing further. !!! info "Read the Documentation" - The [django-allauth documentation](https://django-allauth.readthedocs.io/en/latest/providers.html) is a good starting point here. There are also a number of good tutorials online (at least for the major supported SSO providers). + The [django-allauth documentation](https://django-allauth.readthedocs.io/en/latest/socialaccount/providers/index.html) is a good starting point here. There are also a number of good tutorials online (at least for the major supported SSO providers). In general, the external app will generate a *key* and *secret* pair - although different terminology may be used, depending on the provider. diff --git a/docs/docs/start/config.md b/docs/docs/start/config.md index a0176970c1..ae8497731b 100644 --- a/docs/docs/start/config.md +++ b/docs/docs/start/config.md @@ -235,9 +235,9 @@ InvenTree provides allowance for additional sign-in options. The following optio ### 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). +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/quickstart.html). -If the selected providers need additional settings they must be added as dicts under the key `social_providers`. The correct settings can be found in the django-allauths [provider documentation](https://django-allauth.readthedocs.io/en/latest/providers.html). +If the selected providers need additional settings they must be added as dicts under the key `social_providers`. The correct settings can be found in the django-allauths [provider documentation](https://django-allauth.readthedocs.io/en/latest/socialaccount/providers/index.html). !!! warning "You are not done" SSO still needs credentials for all providers and has to be enabled in the [global settings](../settings/global.md)!