Merge pull request 'docs: Add more documentation' (#5) from docs into main
Reviewed-on: #5
This commit is contained in:
commit
cd5366b34e
14
README.md
14
README.md
|
|
@ -1,6 +1,6 @@
|
|||
# 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
|
||||
|
||||
|
|
@ -12,18 +12,18 @@ Vous trouverez dans ce dépôt l'ensemble des services Open Source que j'utilise
|
|||
|
||||
### 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.
|
||||
- [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.
|
||||
- [Prometheus](./prometheus) : Un logiciel de surveillance informatique
|
||||
- [Docker Registry](./registry) : Une application qui permet de distribuer des images Docker
|
||||
- [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 ?
|
||||
|
||||
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
|
||||
|
||||
|
|
@ -36,9 +36,11 @@ Voici les commandes de base :
|
|||
|
||||
### ./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 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
|
||||
|
||||
|
|
@ -56,6 +58,8 @@ En haut de chaque script il y a `set -eu` qui veut dire :
|
|||
|
||||
## Tâches
|
||||
|
||||
> 🚧 Ses tâches ne sont pas à jour
|
||||
|
||||
Général :
|
||||
|
||||
- [ ] Mettre en place une rotation des logs
|
||||
|
|
|
|||
|
|
@ -13,3 +13,5 @@ Si nous allons dans le dossier `traefik.cool.life` par example, il est possible
|
|||
## 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.
|
||||
|
||||
> 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
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ La configuration est séparé en 3 fichiers :
|
|||
|
||||
## 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).
|
||||
|
||||
|
|
|
|||
|
|
@ -10,10 +10,12 @@
|
|||
>
|
||||
> -- <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
|
||||
|
||||
Exemple de commande :
|
||||
|
||||
```sh
|
||||
docker exec --user www-data -it nextcloud bash
|
||||
|
||||
|
|
|
|||
Reference in New Issue