gengitkan/README.md

49 lines
1.5 KiB
Markdown
Raw Normal View History

# GenGitKan
2019-11-28 11:50:51 +01:00
## Démarrer avec les sources
### Dépendances
- [Go >= 1.13](https://golang.org/)
### Procédure
```bash
cd client && npm install # Installation des dépendances client
2019-11-28 11:50:51 +01:00
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
2020-04-30 10:32:12 +02:00
PublicDir = ${GENGITKAN_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]
2020-04-30 10:32:12 +02:00
DBPath = ${GENGITKAN_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.
2019-11-28 11:50:51 +01:00
## Licence
[AGPL-3.0](./LICENSE)