Commit 03b749db authored by Daniel LACROIX's avatar Daniel LACROIX
Browse files

add LICENSE and README

parent 5b701f2f
MIT License
Copyright (c) 2020 Metropole de Lyon
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Présentation
=======================================
Fournit l'outil Etherpad Lite pour Laclasse utilisé avec les documents de Laclasse.
Prérequis
=======================================
Pour fonctionner, ce container à besoin d'avoir accès à une base de donnée MySQL accessible sur le nom d'hôte **db** avec le compte utilisateur **roundcube** et dont le nom de la base est **roundcube**.
Il a aussi besoin de **laclasse-service** accessible à l'adresse **http://service/** (donc au nom d'hôte **service** et sur le port **80**).
Les variables d'environnement suivantes doivent aussi être définie:
- **DB_PASSWORD**: mot de passe de la base MySQL
- **APIKEY**: une clef à choisir pour l'API d'Etherpad et qui doit aussi être configuré dans **laclasse-service**
Commandes
=======================================
Voici juste quelques commandes d'exemple.
Compilation:
------------
docker build ./ -t laclasse-etherpad
Exécution:
----------
docker run -e APIKEY=1234 -e DB_PASSWORD=pass -it laclasse-etherpad:latest
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment