diff --git a/pica-lufi/README.md b/pica-lufi/README.md index ab5b4a635496c2df431c4b8b7ddaf06eeb5e0a5b..81185f0223c60a2467348fca4bf708d6336a9a58 100644 --- a/pica-lufi/README.md +++ b/pica-lufi/README.md @@ -1,5 +1,26 @@ ## Lufi -Ce dossier comprend un travail en cours pour créer une instance de Lufi, un service libre de partage de fichier chiffrés. +Ce dossier comprend les fichiers nécessaires pour lancer une instance de [Lufi](https://framagit.org/fiat-tux/hat-softwares/lufi/), un service libre de partage de fichier chiffrés. -À mettre à jour. +### Configuration + +Le fichier de configuration principal est [lufi.conf](./lufi.conf). +Il peut recevoir des variables d'environnement avec la syntaxe suivante : `$ENV['<env_variable>']`. + +Le thème est injecté directement dans l'image à partir du dossier [picadrop](./picadrop). +Il ne contient pas de modifications esthétiques pour le moment, juste une modification des URL (CGU...). + +### Lancement + +Copier les fichiers de secrets en enlevant le `.example` et lancer le fichier Compose. + +### Mise à jour + +Il suffit de changer `LUFI_BUILD_VERSION` dans le `Dockerfile` et de reconstruire l'image. +Aucune autre opération n'est nécessaire pour effectuer les migrations et relancer le service. + +En revanche, on veillera à : +* Vérifier qu'aucun paramètre de configuration important n'est apparu dans le [template de configuration](https://framagit.org/fiat-tux/hat-softwares/lufi/-/blob/master/lufi.conf.template), sinon on le rajoutera. +* Vérifier qu'il n'y a pas eu d'amélioration majeure dans [le thème par défaut](https://framagit.org/fiat-tux/hat-softwares/lufi/-/tree/master/themes/default), sur lequel on se base, sinon on les rajoutera. + +De manière générale, on regardera le [changelog](https://framagit.org/fiat-tux/hat-softwares/lufi/-/releases) pour ne rien rater!