From e9d772b47673dc71be889367bf7f559d81bcf58e Mon Sep 17 00:00:00 2001 From: Quentin Duchemin <quentinduchemin@tuta.io> Date: Fri, 7 Aug 2020 15:56:42 +0200 Subject: [PATCH] [Misc] Update doc for Mumble, SFTP and general template --- pica-etherpad/README.md | 9 --------- pica-murmur/README.md | 2 ++ pica-uploads/README.md | 36 ++++++++++++++++++++++++++++++++++-- template/README.md | 8 +++++++- 4 files changed, 43 insertions(+), 12 deletions(-) diff --git a/pica-etherpad/README.md b/pica-etherpad/README.md index 0220f346..320a7a79 100644 --- a/pica-etherpad/README.md +++ b/pica-etherpad/README.md @@ -6,15 +6,6 @@ Le Docker Compose associé permet de lancer deux instances : une principale et u Tous les fichiers présents ici suffisent à lancer correctement les conteneurs (application et base de données), si un Traefik tourne sur la machine cible. -<!-- TOC depthFrom:2 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 --> - -- [Configuration](#configuration) -- [Ajouter ou modifier un paramètre](#ajouter-ou-modifier-un-paramtre) -- [Mise à jour de l'image](#mise-jour-de-limage) -- [Ajout d'un plugin](#ajout-dun-plugin) - -<!-- /TOC --> - ## Mise à jour de l'image Pour mettre à jour la version d'Etherpad, il faut simplement modifir la variable `ETHERPAD_VERSION_BUILD` du [Dockerfile](./Dockerfile) et le tag dans l'image dans [docker-compose.yml](./docker-compose.yml). diff --git a/pica-murmur/README.md b/pica-murmur/README.md index 6cbcf39b..388750cd 100644 --- a/pica-murmur/README.md +++ b/pica-murmur/README.md @@ -11,6 +11,8 @@ Some environment variables allow to configure Murmur at startup : ## Mounted volumes Murmur store its server database and configuration files under `/data/` folder. You should mount this directory on your host. +Also, Murmur uses a certificate generated by [TLS Certs Monitor](../pica-tls-certs-monitor) : the folder `/DATA/docker/certs/voice.picasoft.net` on the machine should contain the certificate. See the specific documentation. + ## Network Murmur is listening both TCP and UDP on port 64738. You should bind this container port to your host. diff --git a/pica-uploads/README.md b/pica-uploads/README.md index 63d1e3c4..b4b797cb 100644 --- a/pica-uploads/README.md +++ b/pica-uploads/README.md @@ -1,3 +1,35 @@ -https://wiki.picasoft.net/doku.php?id=technique:adminsys:sftp +## Serveur SFTP et serveur web associé -https://hub.docker.com/r/atmoz/sftp +Ce dossier contient les fichiers nécessaires pour faire tourner le serveur SFTP de chez Picasoft ainsi qu'un serveur web permettant d'accéder aux fichiers. + +Il se base sur des images pré-construites et ne nécessite pas de construction manuelle d'image. + +### Principe + +Le Compose fournit permet de lancer deux services : +* Un serveur SFTP +* Un serveur web + +Ces deux services accèdent au même volume Docker. Le serveur web sert le contenu du volume, tandis que le serveur SFTP écrit dans le volume. + +Ce mécanisme permet de rendre immédiatement disponibles tous les fichiers uploadées via SFTP via le serveur web. + +### Configuration + +Le fichier de secrets contient la configuration nécessaire pour créer les utilisateurs autorisés à téléverser des fichiers sur le serveur SFTP. + +La syntaxe utilisée [est documentée ici](https://hub.docker.com/r/atmoz/sftp/). + +Notez que l'UID indiqué doit être celui de l'utilisateur `www-data` du serveur web, puisqu'il doit pouvoir accéder à ces fichiers. Le GID utilisé est celui du groupe `docker` de l'hôte, mais ce n'est pas un pré-requis. + +### Lancement + +Il suffit de copier le fichier `sftp.secrets.example` dans `sftp.secrets` et de choisir un mot de passe. Plusieurs utilisateurs peuvent être créés. Ce mot de passe doit être renseigné dans le [pass](https://gitlab.utc.fr/picasoft/interne/pass). + +### Mise à jour + +Il suffit de mettre à jour les tags des images utilisées dans le Docker Compose, de pousser les modifications sur ce dépôt et de relancer les nouveaux conteneurs. + +### Utilisation + +Voir la documentation utilisateur ici : https://wiki.picasoft.net/doku.php?id=technique:adminsys:sftp diff --git a/template/README.md b/template/README.md index 694e3074..d54268b9 100644 --- a/template/README.md +++ b/template/README.md @@ -12,6 +12,12 @@ In this README, you should explain, if applicable, the following : And everything that you find useful. +If you use a single folder for multiple Dockerfiles, *e.g.* 2, you can either : +* Create two subfolder containing a Dockerfile +* Or create two Dockerfile, with the name `<service>.Dockerfile` + +For example, the mail service uses two Dockerfile : one for the MTA, one for the MDA. + This README should act as a reference for all administration tasks. -However it should not contain user documentation, nor general advices about how to resolve build errors and so on. +However it should not contain user documentation, nor general advices about how to resolve build errors and so on (please use the Wiki). -- GitLab