docs enhancement (step by step installation of OpenID Connect)

doc/DOCS.md

@@ -78,6 +78,18 @@ And to promote them as an administrator of your instance:
 
 To use OpenID Connect, the YunoHost admin must:
 
-* install the [dex_ynh](https://github.com/YunoHost-Apps/dex_ynh) package (note that your server must compile it, which can be resource-intensive)
+* Install the [dex_ynh](https://github.com/YunoHost-Apps/dex_ynh) package (note that your server must compile it, which can be resource-intensive)
-* configure Dex properly during the installation (all entered information will be used in the next step, so keep it in a safe place)
+* Configure Dex properly during the installation (all entered information will be used in the next step, so keep it in a safe place)
-* configure GTS using the config panel's OIDC form: `Applications > GoToSocial > Config Panel > OpenID Connect settings`
+  * Domain: as you wish (may be a sub-domain of your GTS instance, like "dex.gts.example.com")
+  * 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
+* 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, 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!

doc/DOCS_fr.md

@@ -78,6 +78,18 @@ Et pour promouvoir un compte en tant qu'administrateur de votre instance :
 
 Pour utiliser OpenID Connect, l'admin YunoHost doit:
 
-* installer le package [dex_ynh](https://github.com/YunoHost-Apps/dex_ynh) (notez que votre serveur doit le compiler, ce qui peut être gourmand en ressources)
+* Installer le package [dex_ynh](https://github.com/YunoHost-Apps/dex_ynh) (notez que votre serveur doit le compiler, ce qui peut être gourmand en ressources)
-* configurer Dex correctement durant l'installation (toutes les informations renseignées seront utilisées lors de l'étape suivante, donc conservez-les soigneusement)
+* Configurer Dex correctement durant l'installation (toutes les informations renseignées seront utilisées lors de l'étape suivante, donc conservez-les soigneusement)
-* configurer GTS en utilisant le formulaire OIDC du panneau de configuration : `Applications > GoToSocial > Panneau de configuration > OpenID Connect settings`
+  * Nom de domaine : ce que vous voulez (peut-être un sous domaine de votre instance GTS, comme "dex.gts.example.com")
+  * 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
+* 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 rpécédente, 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 !