From eca6db6aebac23dacb8bf03f65b7b36fa648385f Mon Sep 17 00:00:00 2001 From: OniriCorpe Date: Sun, 5 Nov 2023 06:02:26 +0100 Subject: [PATCH] last docs fixes --- doc/DOCS.md | 4 ++-- doc/DOCS_fr.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/DOCS.md b/doc/DOCS.md index b3e7175..bf2f997 100644 --- a/doc/DOCS.md +++ b/doc/DOCS.md @@ -86,12 +86,12 @@ To use OpenID Connect, the YunoHost admin must: * Path: only `/` if you wish to install it on a sub-domain of your instance, otherwise as you wish * Name of the app: "GoToSocial", "GTS-test", "YNH-GoToSocial" or anything that makes sense to you and does not contain a space (it will be used as "client ID" in the next step) * OIDC secret: a long and random password of at least 30 characters - * Callback URI: `https://gts.example.com/auth/callback` by replacing the `gts.example.com` by the domain name of your GTS instance + * Callback URI: `gts.example.com/auth/callback` by replacing the `gts.example.com` by the domain name of your GTS instance (without the `https://`!) * Configure GTS using the config panel's OIDC form: `Applications > GoToSocial > Config Panel > OpenID Connect settings` * Activate OpenID Connect: `true` * Name of the OIDC IDP: "Dex" or any other name that makes sense * Skip the normal verification flow of tokens returned: keep on `false` ( **never** change to `true` unless you know what you're doing!) - * OIDC issuer URI: the domain name to which you assigned Dex in the previous step, with the final slash, e.g. `https://dex.gts.example.com/` (this is **NOT** the URL of your GTS instance) + * OIDC issuer URI: the domain name to which you assigned Dex in the previous step, with the final slash `/`, e.g. `https://dex.gts.example.com/` (this is **NOT** the URL of your GTS instance) * OIDC client ID: the app name defined at the Dex installation step (e.g. "GoToSocial", "GTS-test", "YNH-GoToSocial") * OIDC client secret: the long password randomly generated during Dex's installation step * Save, wait until GTS reboots and test! diff --git a/doc/DOCS_fr.md b/doc/DOCS_fr.md index 1d548f1..bc87f2e 100644 --- a/doc/DOCS_fr.md +++ b/doc/DOCS_fr.md @@ -86,12 +86,12 @@ Pour utiliser OpenID Connect, l'admin YunoHost doit: * Chemin : juste `/` si vous souhaitez l'installer sur un sous domaine de votre instance, sinon comme vous voulez * Nom de l'app : "GoToSocial", "GTS-test", "YNH-GoToSocial" ou n'importe quel nom qui vous semble correct qui ne possède pas d'espace (sera utilisé comme "client ID" dans l'étape suivante) * OIDC secret : un mot de passe long généré aléatoirement d'au minimum une trentaine de caractères - * Callback URI : `https://gts.example.com/auth/callback` en remplaçant `gts.example.com` par le nom de domaine de votre instance GTS + * Callback URI : `gts.example.com/auth/callback` en remplaçant `gts.example.com` par le nom de domaine de votre instance GTS (sans le `https://` !) * Configurer GTS en utilisant le formulaire OIDC du panneau de configuration : `Applications > GoToSocial > Panneau de configuration > OpenID Connect settings` * Activer OpenID Connect : `true` * Nom de l'OIDC IDP : "Dex" ou n'importe quel nom qui vous semble correct * Passer la vérification du flux des jetons renvoyés : laisser sur `false` (ne **jamais** passer à `true` sauf si vous savez ce que vous faites !) - * URI du fournisseur OIDC : le nom de domaine auquel vous avez assigné Dex lors de l'étape précédente, barre oblique finale incluse, par exemple `https://dex.gts.example.com/` (ce **N'est PAS** l'URL de votre instance GTS) + * URI du fournisseur OIDC : le nom de domaine auquel vous avez assigné Dex lors de l'étape précédente, barre oblique `/` finale incluse, par exemple `https://dex.gts.example.com/` (ce **N'est PAS** l'URL de votre instance GTS) * Client ID du fournisseur OIDC : le nom de l'app renseigné lors de l'étape d'installation de Dex (exemples : "GoToSocial", "GTS-test", "YNH-GoToSocial") * Client secret du fournisseur OIDC : le long mot de passé généré aléatoirement lors de l'étape d'installation de Dex * Sauvegardez, patientez le temps que GTS redémarre puis testez !