bottin/README.md
Victor Lacasse-Beaudoin 9a0bf87e7b Bump root version to v4
Remove all files from v3

Move all files from v4/ to project root
2023-05-29 18:19:31 -04:00

49 lines
1.1 KiB
Markdown

# agecem/bottin/v4
Version 4 du bottin de la masse étudiante, en Go
https://git.agecem.com/agecem/bottin
## fonctionalités
### Serveur API
- Insertion de membre et programme
- Lecture de membre
- Modification du nom d'usage de membre
### Client web
- Lecture de membre par requête au serveur API
## usage
Remplir .env avec les infos qui seront utilisées pour déployer le container
(Remplacer `bottin` par quelque chose de plus sécuritaire)
```sh
BOTTIN_POSTGRES_DATABASE=bottin
BOTTIN_POSTGRES_PASSWORD=bottin
BOTTIN_POSTGRES_USER=bottin
```
Déployer avec docker-compose
`$ docker-compose up -d`
Pour modifier la configuration du serveur API
`$ docker-compose exec -it api vi /etc/bottin/api.yaml`
*Y remplir au minimum le champs `api.key` (string)*
Pour modifier la configuration du client web
`$ docker-compose exec -it web vi /etc/bottin/web.yaml`
*Y remplir au minimum les champs `web.api.key` (string), `web.user` (string) et `web.password` (string)*
Redémarrer les containers une fois la configuration modifiée
`$ docker-compose down && docker-compose up -d`