From a81f0a99ee8b562c3bd9afa9f0be8ac1a00332f5 Mon Sep 17 00:00:00 2001 From: Loan Robert Date: Fri, 31 May 2024 19:10:18 +0200 Subject: [PATCH] Fix documentation formatting --- .../maintainers/fileSharingProcess.md | 76 +++++++++---------- 1 file changed, 38 insertions(+), 38 deletions(-) diff --git a/documentation/maintainers/fileSharingProcess.md b/documentation/maintainers/fileSharingProcess.md index 0c6846b..c59249a 100644 --- a/documentation/maintainers/fileSharingProcess.md +++ b/documentation/maintainers/fileSharingProcess.md @@ -54,21 +54,22 @@ Il va donc requêter l'url de l'instance Nextcloud, et plus précisément, une u "user": "identifiant_nextcloud_de_lutilisateur" } ``` +🧪 +Pour tester que Nextcloud peut répondre au serveur d'identité, on peut tester simplement la communication avec la commande suivante en ssh depuis ce serveur d'identité : -> Pour tester que Nextcloud peut répondre au serveur d'identité, on peut tester simplement la communication avec la commande suivante en ssh depuis ce serveur d'identité : -> -> `curl --location --request POST 'https:///apps/sessiontoken/token' --header 'Content-Type: application/x-www-form-urlencoded' --data-urlencode 'apikey=' --data-urlencode 'user='` -> -> la réponse devrait-être la suivante : -> ``` -> { -> "token": "token-de-lutilisateur", -> "loginName": "identifiant_nextcloud_de_lutilisateur", -> "deviceToken": { -> ... -> } -> } -> ``` +`curl --location --request POST 'https:///apps/sessiontoken/token' --header 'Content-Type: application/x-www-form-urlencoded' --data-urlencode 'apikey=' --data-urlencode 'user='` + +la réponse devrait-être la suivante : +``` +{ + "token": "token-de-lutilisateur", + "loginName": "identifiant_nextcloud_de_lutilisateur", + "deviceToken": { + ... + } +} +``` +🧪 Le serveur d'identité va alors renvoyer cette information à B3Desk. @@ -76,12 +77,7 @@ Le serveur d'identité va alors renvoyer cette information à B3Desk. Pour récupérer le token d'identification de l'utilisateur auprès de Nextcloud, B3Desk va donc requêter ce serveur d'identité. -Afin de construire la requête, B3Desk a besoin des variables d'environnement suivantes : - -- :attr:`~b3desk.settings.MainSettings.NC_LOGIN_API_URL` -- :attr:`~b3desk.settings.MainSettings.NC_LOGIN_API_KEY` - -Il va donc requêter :attr:`~b3desk.settings.MainSettings.NC_LOGIN_API_URL` en POST avec un header "x-api-key" renseignant la variable :attr:`~b3desk.settings.MainSettings.NC_LOGIN_API_KEY` et un body contenant le username de l'utilisateur B3Desk : +B3Desk a besoin de variables d'environnement pour requêter `NC_LOGIN_API_URL` en POST avec un header "x-api-key" renseignant la variable `NC_LOGIN_API_KEY` et un body contenant le username de l'utilisateur B3Desk : ``` { @@ -89,17 +85,19 @@ Il va donc requêter :attr:`~b3desk.settings.MainSettings.NC_LOGIN_API_URL` en P } ``` -> Pour tester que le serveur d'identité est capable d'interroger l'instance Nextcloud et de répondre avec le token utilisateur, on peut tester la communication entre B3Desk et ce serveur (et par la même occasion le Nextcloud) en ssh depuis le serveur B3Desk : -> -> `curl --location --request POST '' --header 'x-api-key: ' --header 'Content-Type: application/json' --data-raw '{"username":""}'` -> -> la réponse devrait être au moins la suivante (si le `nc_login` est maquant dans la réponse, il sera ajouté par B3Desk) : -> ``` -> { -> "nctoken": "token-de-lutilisateur", -> "nclocator": "url_nextcloud", -> } -> ``` +🧪 +Pour tester que le serveur d'identité est capable d'interroger l'instance Nextcloud et de répondre avec le token utilisateur, on peut tester la communication entre B3Desk et ce serveur (et par la même occasion le Nextcloud) en ssh depuis le serveur B3Desk : + +`curl --location --request POST '' --header 'x-api-key: ' --header 'Content-Type: application/json' --data-raw '{"username":""}'` + +la réponse devrait être au moins la suivante (si le `nc_login` est maquant dans la réponse, il sera ajouté par B3Desk) : +``` +{ + "nctoken": "token-de-lutilisateur", + "nclocator": "url_nextcloud", +} +``` +🧪 ##### Cas particulier : L'identifiant de l'utilisateur B3Desk n'est pas le même que l'identifiant Nextcloud @@ -107,13 +105,15 @@ Dans le cas où l'identifiant d'un utilisateur donné sur B3Desk n'est pas le m B3Desk va donc requêter un autre serveur d'identité pour, à partir de l'email, retrouver l'identifiant Nextcloud de l'utilisateur. Il faut suivre la documentation {ref}`Jumelage avec Apps` pour bien configurer B3Desk et le serveur d'identité secondaire. -> Pour tester que B3Desk est bien capable de retrouver l'identifiant Nextcloud d'un utilisateur à partir de son mail, on peut exécuter la commande de cette documentation : -> -> ``` -> docker exec -it flask get-apps-id -> ``` -> -> Cette commande devrait répondre `ID from secondary identity provider for email : ` +🧪 +Pour tester que B3Desk est bien capable de retrouver l'identifiant Nextcloud d'un utilisateur à partir de son mail, on peut exécuter la commande de cette documentation : + +``` +docker exec -it flask get-apps-id +``` + +Cette commande devrait répondre `ID from secondary identity provider for email : ` +🧪 ### Utilisation du Filepicker