docs: Update documentation
This commit is contained in:
parent
f9821adc68
commit
e3e653d700
10
README.md
10
README.md
|
|
@ -1,12 +1,12 @@
|
|||
# Services
|
||||
|
||||
Vous trouverez dans ce dépôt l'ensemble des services Open Source que je propose.
|
||||
Vous trouverez dans ce dépôt l'ensemble des services Open Source que j'utilise et mets à jour quotidiennement.
|
||||
|
||||
## Liste des services
|
||||
|
||||
### Pour les utilisateurs
|
||||
|
||||
- [CodiMD](./codimd) : Prise de note en Markdown collaborative en temps réel
|
||||
- [HedgeDoc](./hedgedoc) : 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
|
||||
|
|
@ -51,17 +51,18 @@ En haut de chaque script il y a `set -eu` qui veut dire :
|
|||
|
||||
- [Gestion de service avec Traefik](https://github.com/lfache/awesome-traefik)
|
||||
- [Exemple de service docker](https://github.com/crazy-max)
|
||||
- [LinuxServer qui construit et maintient des images Docker](https://www.linuxserver.io/)
|
||||
|
||||
## 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)
|
||||
- [ ] Mettre à jour la documentation des services (HedgeDoc, 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
|
||||
- [ ] [HedgeDoc] Mettre à jour les scripts de sauvegarde et restauration pour correspondre à la nouvelle architecture
|
||||
- [ ] [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)
|
||||
|
|
@ -74,6 +75,7 @@ Services :
|
|||
|
||||
Réalisées :
|
||||
|
||||
- [x] ~~[CodiMD] Modifier l'image pour utiliser le fork [HedgeDoc](https://hedgedoc.org/) (2021-07-27)~~
|
||||
- [x] ~~[Nextcloud] Mise à jour de Redis en version [6.0.13](https://github.com/redis/redis/releases/tag/6.0.13) (2021-05-04)~~
|
||||
- [x] ~~[Grafana] Mise à jour en version [7.5.5](https://github.com/grafana/grafana/releases/tag/v7.5.5) (2021-05-04)~~
|
||||
- [x] ~~Mettre à jour la documentation général et rapatrier les tâches des services ici (2021-05-04)~~
|
||||
|
|
|
|||
|
|
@ -2,17 +2,17 @@
|
|||
# DOCKER
|
||||
|
||||
#DOCKER_CONTEXT=
|
||||
#DOCKER_HOST=
|
||||
#DOCKER_HOST= // Pour déployer sur un serveur distant
|
||||
SERVICES_DIR=../..
|
||||
COMPOSE_FILE=${SERVICES_DIR}/hedgedoc/docker-compose.yml:${SERVICES_DIR}/hedgedoc/docker-compose.traefik.yml:${SERVICES_DIR}/postgres/docker-compose.yml
|
||||
COMPOSE_PROJECT_NAME=hedgedoc_exemple_fr
|
||||
COMPOSE_PROJECT_NAME=hedgedoc_example_com
|
||||
|
||||
##########
|
||||
# HEDGEDOC
|
||||
|
||||
HEDGEDOC_DOMAIN=hedgedoc.exemple.fr
|
||||
HEDGEDOC_VOLUME_NAME=hedgedoc_exemple_fr_hedgedoc
|
||||
HEDGEDOC_CONTAINER_NAME=hedgedoc_exemple_fr_hedgedoc
|
||||
HEDGEDOC_DOMAIN=hedgedoc.example.com
|
||||
HEDGEDOC_VOLUME_NAME=hedgedoc_example_com_hedgedoc
|
||||
HEDGEDOC_CONTAINER_NAME=hedgedoc_example_com_hedgedoc
|
||||
#HEDGEDOC_IMAGE=
|
||||
|
||||
# https://docs.hedgedoc.org/configuration/
|
||||
|
|
@ -32,12 +32,12 @@ CMD_SESSION_SECRET=/ADm6sOuQ/EOhUA+xcmkQOtk9QDhggjsFBKQCLKrC6U=
|
|||
POSTGRES_USER=user
|
||||
POSTGRES_PASSWORD=password
|
||||
POSTGRES_DB=database
|
||||
POSTGRES_VOLUME_NAME=hedgedoc_exemple_fr_postgres
|
||||
POSTGRES_CONTAINER_NAME=hedgedoc_exemple_fr_postgres
|
||||
POSTGRES_VOLUME_NAME=hedgedoc_example_com_postgres
|
||||
POSTGRES_CONTAINER_NAME=hedgedoc_example_com_postgres
|
||||
#POSTGRES_IMAGE=
|
||||
|
||||
#########
|
||||
# TRAEFIK
|
||||
|
||||
#TRAEFIK_NETWORK_NAME=
|
||||
TRAEFIK_ROUTER_NAME=hedgedoc_exemple_fr # Don't use char '.'
|
||||
TRAEFIK_ROUTER_NAME=hedgedoc_example_com # Don't use char '.'
|
||||
|
|
@ -5,14 +5,15 @@
|
|||
## Docker compose
|
||||
|
||||
La configuration est séparé en 3 fichiers :
|
||||
- docker-compose.yml avec le service spécifique à HedgeDoc
|
||||
- ../postgres/docker-compose.yml pour la partie base de donnée
|
||||
- [`./docker-compose.yml`](./docker-compose.yml) avec le service spécifique à HedgeDoc
|
||||
- [`./docker-compose.traefik.yml`](./docker-compose.traefik.yml) pour la partie Traefik
|
||||
- [`../postgres/docker-compose.yml`](../postgres/docker-compose.yml) pour la partie base de donnée PostgreSQL
|
||||
|
||||
## Configuration
|
||||
|
||||
[De nombreuses variables d'environnement][documentation] peuvent être précisé pour configurer HedgeDoc.
|
||||
|
||||
Modifier les variables dans le fichier `.env`.
|
||||
Modifier les variables dans le fichier [`.env`](../examples/hedgedoc.example.com/.env).
|
||||
|
||||
Lancer le service :
|
||||
|
||||
|
|
@ -24,7 +25,7 @@ docker-compose up -d
|
|||
|
||||
- [Site officiel][website]
|
||||
- [Github][github]
|
||||
- [L'image Docker][docker]
|
||||
- [L'image Docker de LinuxServer][docker]
|
||||
|
||||
[website]: https://hedgedoc.org/
|
||||
[docker]: https://hub.docker.com/r/linuxserver/hedgedoc
|
||||
|
|
|
|||
Reference in New Issue