bottin/README.md

58 lines
1.4 KiB
Markdown
Raw Normal View History

# agecem/bottin
2023-03-06 14:01:18 -05:00
Bottin de la masse étudiante, en Go
2023-03-06 14:01:18 -05:00
https://git.agecem.com/agecem/bottin
2023-03-06 14:01:18 -05:00
## fonctionalités
2023-03-06 14:01:18 -05:00
### Serveur API
2023-03-06 14:01:18 -05:00
- Insertion de membre et programme
- Lecture de membre
- Modification du nom d'usage de membre
2023-03-06 14:01:18 -05:00
### Client web
2023-03-06 14:01:18 -05:00
- Lecture de membre par requête au serveur API
2023-03-06 14:01:18 -05:00
## usage
2023-03-06 14:01:18 -05:00
Remplir .env avec les infos qui seront utilisées pour déployer le container
2023-03-06 14:01:18 -05:00
Au minimum, il faut ces 3 entrées:
*Remplacer `bottin` par quelque chose de plus sécuritaire*
2023-03-06 14:01:18 -05:00
```sh
BOTTIN_SERVER_DB_DATABASE=bottin
BOTTIN_SERVER_DB_PASSWORD=bottin
BOTTIN_SERVER_DB_USER=bottin
2023-03-06 14:01:18 -05:00
```
*D'autres entrées peuvent être ajoutées, voir `config.go` pour les options*
Déployer avec docker-compose
2023-03-06 14:01:18 -05:00
`$ docker-compose up -d`
2023-03-06 14:01:18 -05:00
### Optionnel: configuration par fichiers YAML
*seulement nécessaire si les fichiers `.env` et `docker-compose.yaml` ne contiennent pas toute l'information nécessaire*
Pour modifier la configuration du serveur API
2023-03-06 14:01:18 -05:00
`$ docker-compose exec -it api vi /etc/bottin/api.yaml`
2023-03-06 14:01:18 -05:00
*Y remplir au minimum le champs `server.api.key` (string)*
2023-03-06 14:01:18 -05:00
Pour modifier la configuration du client web
2023-03-06 14:01:18 -05:00
`$ docker-compose exec -it ui vi /etc/bottin/ui.yaml`
2023-03-06 14:01:18 -05:00
*Y remplir au minimum les champs `server.ui.api.key` (string), `server.ui.user` (string) et `server.ui.password` (string)*
2023-03-06 14:01:18 -05:00
Redémarrer les containers une fois la configuration modifiée
2023-03-06 14:01:18 -05:00
`$ docker-compose down && docker-compose up -d`