Merge branch 'develop' into dist/ubuntu/bionic/develop

README.md

@@ -1,4 +1,4 @@
-# Gitea Kan
+# GenGitKan
 
 ## Démarrer avec les sources
 
@@ -12,6 +12,37 @@
 make watch  # Surveiller les modifications sur le sources et compiler/démarrer le serveur
 ```
 
+Au premier lancement, le fichier de configuration doit être complété afin de d'utiliser l'instance Gitea ciblée comme fournisseur OAuth2.
+
+Modifier le fichier `data/server.conf` de la manière suivante (la forge Cadoles est utilisée dans cet exemple):
+
+```ini
+Debug = false
+
+[HTTP]
+Address     = :3000
+PublicDir   = ${GITEAKAN_HTTP_PUBDIR}
+
+[Gitea]
+BaseURL      = https://forge.cadoles.com
+ClientID     = <ClientID>
+ClientSecret = <ClientSecret>
+RedirectURL = http://localhost:3000/callback
+AuthURL = https://forge.cadoles.com/login/oauth/authorize
+LogoutURL = https://forge.cadoles.com/user/logout
+TokenURL = https://forge.cadoles.com/login/oauth/access_token
+APIBaseURL = https://forge.cadoles.com/api
+Scopes = api
+
+[Data]
+
+DBPath = ${GITEAKAN_DATA_DBPATH}
+```
+
+Les valeurs pour `<ClientID>` et `<ClientSecret>` sont à récupérer sur la page https://forge.cadoles.com/user/settings/applications, dans la section `Gérer les applications OAuth2`. 
+
+Vous devrez créer une application et configurer l'URL de redirection pour qu'elle corresponde à la valeur `RedirectURL` de votre fichier de configuration afin de pouvoir utiliser votre instance locale de GenGitKan.
+
 ## Licence
 
 [AGPL-3.0](./LICENSE)