ResiLien
/
services
2
0
Fork 0
Code Issues Pull Requests 3 Packages Projects Releases Wiki Activity

Merge pull request 'docs: Add more documentation' (#5) from docs into main 

Reviewed-on: https://git.weko.io/resilien/services/pulls/5
This commit is contained in:
killian 2021-10-23 16:07:16 +02:00
parent 88af04b233 f14f2cafeb
commit cd5366b34e
4 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,6 +1,6 @@
# Services # Services
Vous trouverez dans ce dépôt l'ensemble des services Open Source que j'utilise et mets à jour quotidiennement. Vous trouverez dans ce dépôt l'ensemble des services Open Source que RésiLien utilise et met à jour de façon presque hebdomadaire. L'ensemble des variables d'environnement enregistrées dans les fichiers `.env` est présent pour une logique d'exemple et n'a jamais été utilisé en production. Nous vous conseillons de ne jamais le faire si vous utilisez le dépôt.
## Liste des services ## Liste des services
@ -12,18 +12,18 @@ Vous trouverez dans ce dépôt l'ensemble des services Open Source que j'utilise
### Pour les devs / ops ### Pour les devs / ops
- [Drone](./drone) `en pause` : Un service d'intégration continue - [Drone](./drone) ⏸️ `en pause` : Un service d'intégration continue
- [Gitea](./gitea) : Un service Git auto-hébergé très simple à installer et à utiliser. Il est similaire à GitHub, Bitbucket ou Gitlab. - [Gitea](./gitea) : Un service Git auto-hébergé très simple à installer et à utiliser. Il est similaire à GitHub, Bitbucket ou Gitlab.
- [Grafana](./grafana) : Un outil de supervision simple et élégant - [Grafana](./grafana) : Un outil de supervision simple et élégant
- [PostgreSQL](./postgres) : PostgreSQL est un système de gestion de base de données relationnelle et objet. - [PostgreSQL](./postgres) : PostgreSQL est un système de gestion de base de données relationnelle et objet.
- [Prometheus](./prometheus) : Un logiciel de surveillance informatique - [Prometheus](./prometheus) : Un logiciel de surveillance informatique
- [Docker Registry](./registry) : Une application qui permet de distribuer des images Docker - [Docker Registry](./registry) : Une application qui permet de distribuer des images Docker
- [Traefik](./traefik) : Traefik, un reverse-proxy pour vos conteneurs - [Traefik](./traefik) : Traefik, un reverse-proxy pour vos conteneurs
- [Watchtower](./watchtower) `en pause` : Automatiser la mise à jour d'image docker - [Watchtower](./watchtower) : Automatiser la mise à jour d'image docker
## Comment ça marche ? ## Comment ça marche ?
Vous pouvez réutiliser ce dépôt pour votre infrastructure. J'ai mis une documentation dans le dossier [_examples_](./examples). Vous pouvez réutiliser ce dépôt pour vos services, il existe une documentation dans le dossier [_examples_](./examples).
### Docker et Docker Compose ### Docker et Docker Compose
@ -36,9 +36,11 @@ Voici les commandes de base :
### ./run ### ./run
> 🚧 RésiLien a changé de façon de faire et nous n'utilisons plus les scripts `run`. Nous passons maintenant par Ansible. Les scripts ne seront plus mis à jour et finiront peut être par être supprimés. Utilisez les avec précaution.
Vous pourrez trouver dans les dossiers des services un script bash `run`. Le principe est de faciliter la maintenance de chaque service. Vous pourrez trouver dans les dossiers des services un script bash `run`. Le principe est de faciliter la maintenance de chaque service.
Vous pouvez lancer le script sans paramètre pour afficher la documentation du script. Vous pouvez lancer le script sans paramètres pour afficher la documentation du script.
## Documentation ## Documentation
@ -56,6 +58,8 @@ En haut de chaque script il y a `set -eu` qui veut dire :
## Tâches ## Tâches
> 🚧 Ses tâches ne sont pas à jour
Général : Général :
- [ ] Mettre en place une rotation des logs - [ ] Mettre en place une rotation des logs

2
examples/README.md
View File

@ -13,3 +13,5 @@ Si nous allons dans le dossier `traefik.cool.life` par example, il est possible
## DOCKER_HOST ## DOCKER_HOST
Si vous gérez des serveurs à distance, il est possible d'utiliser la variable `DOCKER_HOST` dans votre fichier `.env` pour expliquer que le service doit s’exécuter sur ce serveur. Si vous gérez des serveurs à distance, il est possible d'utiliser la variable `DOCKER_HOST` dans votre fichier `.env` pour expliquer que le service doit s’exécuter sur ce serveur.
> Résilien utilise maintenant ce système avec une génération automatique des fichiers .env à l'aide d'Ansible, nous permettant de facilement déployer un nouveau service, de le déplacer de serveur

2
hedgedoc/README.md
View File

@ -11,7 +11,7 @@ La configuration est séparé en 3 fichiers :
## Configuration ## Configuration
[De nombreuses variables d'environnement][documentation] peuvent être précisé pour configurer HedgeDoc. [De nombreuses variables d'environnement][documentation] peuvent être précisé pour configurer HedgeDoc, elles n'ont pas tous été intégrées.
Modifier les variables dans le fichier [`.env`](../examples/hedgedoc.example.com/.env). Modifier les variables dans le fichier [`.env`](../examples/hedgedoc.example.com/.env).

4
nextcloud/README.md
View File

@ -10,10 +10,12 @@
> >
> -- <cite>[Github][github]</cite> > -- <cite>[Github][github]</cite>
On peut trouver [la documentation ici][documentation]. On peut trouver [la documentation ici][documentation] en anglais ou ici pour la [traduction française](https://doc-nextcloud-fr.indie.host/fr/) fait par [IndieHosters](https://indiehosters.net/) et [Paquerette](https://paquerette.eu/).
## Aide ## Aide
Exemple de commande :
```sh ```sh
docker exec --user www-data -it nextcloud bash docker exec --user www-data -it nextcloud bash