docs: Update README and TODO lists
This commit is contained in:
parent
b7271981d1
commit
cf22b8b78e
75
README.md
75
README.md
|
|
@ -2,17 +2,31 @@
|
|||
|
||||
Vous trouverez dans ce dépôt l'ensemble des services Open Source que je propose.
|
||||
|
||||
## Liste des services
|
||||
|
||||
### Pour les utilisateurs
|
||||
|
||||
- [CodiMD](./codimd) : Prise de note en Markdown collaborative en temps réel
|
||||
- [Nextcloud](./nextcloud) : Site d'hébergement de fichiers et une plateforme de collaboration
|
||||
|
||||
### Pour les devs / ops
|
||||
|
||||
- [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
|
||||
|
||||
## Comment ça marche ?
|
||||
|
||||
Vous pouvez réutiliser ce dépôt pour votre infrastructure.
|
||||
|
||||
J'ai mis une documentation dans le dossier [_examples_][examples]
|
||||
|
||||
## Commandes
|
||||
Vous pouvez réutiliser ce dépôt pour votre infrastructure. J'ai mis une documentation dans le dossier [_examples_](./examples).
|
||||
|
||||
### Docker et Docker Compose
|
||||
|
||||
L'ensemble des services est géré avec [Docker][docker] et [Docker Compose][docker-compose].
|
||||
L'ensemble des services est géré avec [Docker](https://docs.docker.com/engine/) et [Docker Compose](https://docs.docker.com/compose/).
|
||||
|
||||
Voici les commandes de base :
|
||||
|
||||
|
|
@ -25,18 +39,7 @@ Vous pourrez trouver dans les dossiers des services un script bash `run`. Le pri
|
|||
|
||||
Vous pouvez lancer le script sans paramètre pour afficher la documentation du script.
|
||||
|
||||
## Liste des services
|
||||
|
||||
### Pour les devs
|
||||
|
||||
- [PostgreSQL][postgres] : PostgreSQL est un système de gestion de base de données relationnelle et objet.
|
||||
- [Gitea][gitea] : Un service Git auto-hébergé très simple à installer et à utiliser. Il est similaire à GitHub, Bitbucket ou Gitlab.
|
||||
|
||||
### Pour les ops
|
||||
|
||||
- [Traefik][traefik] : Traefik, un reverse-proxy pour vos conteneurs
|
||||
|
||||
## Informations
|
||||
## Documentation
|
||||
|
||||
### `set -eu` ?
|
||||
|
||||
|
|
@ -44,14 +47,32 @@ En haut de chaque script il y a `set -eu` qui veut dire :
|
|||
- -e Exit immediately if a command exits with a non-zero status.
|
||||
- -u Treat unset variables as an error when substituting.
|
||||
|
||||
## Références
|
||||
### Références
|
||||
|
||||
https://github.com/lfache/awesome-traefik
|
||||
- [Gestion de service avec Traefik](https://github.com/lfache/awesome-traefik)
|
||||
- [Exemple de service docker](https://github.com/crazy-max)
|
||||
|
||||
[examples]: ./examples
|
||||
[docker]: https://docs.docker.com/engine/
|
||||
[docker-compose]: https://docs.docker.com/compose/
|
||||
[postgres]: ./postgres
|
||||
[gitea]: ./gitea
|
||||
[traefik]: ./traefik
|
||||
[script]: https://gist.github.com/pirate/265e19a8a768a48cf12834ec87fb0eed²
|
||||
## Tâches
|
||||
|
||||
Général :
|
||||
|
||||
- [ ] Mettre en place une rotation des logs
|
||||
- [ ] Mettre à jour la documentation des services (CodiMD, Drone, Gitea, Grafana, Nextcloud, Postgres, Prometheus, Registry, Traefik, Watchtower)
|
||||
|
||||
Services :
|
||||
|
||||
- [ ] [CodiMD] Modifier l'image pour utiliser le fork [HedgeDoc](https://hedgedoc.org/) surtout quand [la version 2.0](https://github.com/hedgedoc/hedgedoc/milestone/6) sera sortie
|
||||
- [ ] [Drone] Création d'un script de sauvegarde et restauration
|
||||
- [ ] [Nextcloud] Ajout des informations SMTP
|
||||
- [ ] [Nextcloud] Prendre les bonnes pratique sur le dépot de [crazy-max](https://github.com/crazy-max/docker-nextcloud/blob/master/examples/traefik/docker-compose.yml)
|
||||
- [ ] [Traefik] Mise en place d'un script pour sauvegarder/restaurer les certificats et la configuration
|
||||
- [ ] [Traefik] Mettre en place les _metrics_
|
||||
- [ ] [Traefik] Mettre en place l'_accesslog_
|
||||
- [ ] [WireGuard] Ajouter le service pour la création de tunnel VPN
|
||||
|
||||
Réalisées :
|
||||
|
||||
- [x] ~~Mettre à jour la documentation général et rapatrier les tâches des services ici (2021-05-04)~~
|
||||
- [x] ~~[Nextcloud] Mise en place d'une sauvegarde / restauration de sauvegarde~~
|
||||
- [x] ~~[Nextcloud] [Modifier la gestion des jobs](https://docs.nextcloud.com//server/latest/admin_manual/configuration_server/background_jobs_configuration.html#cron)~~
|
||||
- [x] ~~[Nextcloud] [Ajouter un redis](https://www.it-connect.fr/nextcloud-activer-et-configurer-le-cache-redis/) pour une meilleure performance~~
|
||||
|
|
|
|||
|
|
@ -10,10 +10,6 @@
|
|||
- [Code source][source]
|
||||
- [Docker Hub][dockerhub]
|
||||
|
||||
## TODO
|
||||
|
||||
- Création d'un script de sauvegarde et restauration
|
||||
|
||||
[article]: https://www.codeflow.site/fr/article/how-to-perform-continuous-integration-testing-with-drone-io-on-coreos-and-docker
|
||||
[site]: https://drone.io/
|
||||
[source]: https://github.com/drone/drone
|
||||
|
|
|
|||
|
|
@ -4,10 +4,6 @@
|
|||
>
|
||||
> <cite>[Documentation][documentation]</cite>
|
||||
|
||||
## Configuration
|
||||
|
||||
TODO
|
||||
|
||||
## Commandes
|
||||
|
||||
```sh
|
||||
|
|
|
|||
|
|
@ -46,14 +46,6 @@ Ajout de imagemagick :
|
|||
docker-compose exec nextcloud-fpm apk add --no-cache imagemagick
|
||||
```
|
||||
|
||||
## TODO
|
||||
|
||||
- [x] Mise en place d'une sauvegarde / restauration de sauvegarde
|
||||
- [x] crontab https://docs.nextcloud.com//server/latest/admin_manual/configuration_server/background_jobs_configuration.html#cron
|
||||
- [x] Ajouter un redis : https://www.it-connect.fr/nextcloud-activer-et-configurer-le-cache-redis/
|
||||
- [ ] Ajout des informations SMTP
|
||||
- [ ] Prendre les bonnes pratique sur https://github.com/crazy-max/docker-nextcloud/blob/master/examples/traefik/docker-compose.yml
|
||||
|
||||
[github]: https://github.com/nextcloud/server
|
||||
[documentation]: https://docs.nextcloud.com/server/latest/admin_manual/contents.html
|
||||
[backup]: https://docs.nextcloud.com/server/latest/admin_manual/maintenance/backup.html
|
||||
|
|
|
|||
|
|
@ -49,10 +49,6 @@ curl -u "$REGISTRY_USER:$REGISTRY_PASSWORD" -X GET https://$REGISTRY_DOMAIN/v2/_
|
|||
- [Documentation][documentation]
|
||||
- [Docker Hub][dockerhub]
|
||||
|
||||
## TODO
|
||||
|
||||
- Supprimer le Dockerfile et importer directement le dossier auth depuis docker-compose
|
||||
|
||||
[article]: https://blog.eleven-labs.com/fr/mise-en-place-docker-registry-privee/
|
||||
[documentation]: https://docs.docker.com/registry/
|
||||
[dockerhub]: https://hub.docker.com/_/registry
|
||||
|
|
|
|||
|
|
@ -14,14 +14,6 @@ Les variables contenu dans `.env` permettent de changer :
|
|||
- `TRAEFIK_IMAGE` : la version
|
||||
- `TRAEFIK_DOMAIN` : le nom de domaine
|
||||
|
||||
## TODO
|
||||
|
||||
- Mise en place d'un script pour sauvegarder les certificats et la configuration (mais vu que tout peut être généré directement avec docker-compose ça ne sera pas une priorité)
|
||||
- Mise en place d'un script pour restaurer une sauvegarde
|
||||
- Mettre en place les _metrics_
|
||||
- Mettre en place une rotation des logs
|
||||
- Mettre en place l'_accesslog_
|
||||
|
||||
## Liens
|
||||
|
||||
- [Site Officiel][site]
|
||||
|
|
|
|||
Loading…
Reference in New Issue