Commit d57038d3 authored by Daniel LACROIX's avatar Daniel LACROIX
Browse files

update doc

parent 5c2b447a
......@@ -8,14 +8,29 @@ Fournit l'outil Etherpad Lite pour Laclasse utilisé avec les documents de Lacla
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 **etherpad** et dont le nom de la base est **etherpad**.
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 **etherpad** et
dont le nom de la base est **etherpad**.
Il a aussi besoin de **laclasse-service** accessible à l'adresse **http://service/** (donc au nom d'hôte **service** et sur le port **80**).
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**
- **APP_ID**: id de cette application dans Laclasse pour utiliser les APIs
- **APP_KEY**: mot de passe de cette application dans Laclasse pour utiliser les APIs
- **BASE_URL**: url de base sur laquelle est hébergé Laclasse (ex: **https://www.laclasse.com**)
Les variables optionnelles suivantes peuvent être configurées:
- **DB_HOST**: Serveur de la base de donnée (défaut: **db**)
- **DB_PORT**: Port de la base de donnée (défaut: **3306**)
- **DB_USER**: Utilisateur de la base de donnée (défault: **etherpad**)
- **DB_NAME**: Nom de la base de donnée (défault: **etherpad**)
- **AUTH_URL**: URL interne pour vérifier les droits d'accès aux fichiers (default: **http://service/api/docs/current/isauthenticated**)
- **SSO_URL**: URL publique de base pour le SSO (défaut: **BASE_URL**)
Commandes
=======================================
......@@ -30,4 +45,5 @@ Compilation:
Exécution:
----------
docker run -e APIKEY=1234 -e DB_PASSWORD=pass -it laclasse-etherpad:latest
docker run -e APIKEY=1234 -e DB_PASSWORD=pass -e APP_ID=PAD -e APP_KEY=pass \
-it laclasse-etherpad:latest
......@@ -21,16 +21,18 @@ fi
REPLACE_VARS='DB_HOST DB_PORT DB_USER DB_NAME DB_PASSWORD APIKEY AUTH_URL SSO_URL BASE_URL APP_ID APP_KEY'
# check if needed vars are present
if [ -z "$DB_PASSWORD" ] || [ -z "$APIKEY" ] || [ -z "$APP_ID" ] || [ -z "$APP_KEY" ]; then
if [ -z "$DB_PASSWORD" ] || [ -z "$APIKEY" ] || [ -z "$APP_ID" ] || [ -z "$APP_KEY" ] || [ -z "$BASE_URL" ]; then
echo "Error: The following environment variables MUST be defined."
echo " - DB_PASSWORD: database password"
echo " - APIKEY: Etherpad secret API key"
echo " - APIKEY : Etherpad secret API key"
echo " - APP_ID : id of the APP in Laclasse"
echo " - APP_KEY: password if the APP in Laclasse"
echo " - BASE_URL: base public URL of Laclasse (ex: https://www.laclasse.com)"
echo " The following environment variables are optional"
echo " - DB_HOST: database host (default: db)"
echo " - DB_PORT: database port (default: 3306)"
echo " - DB_USER: database user (default: etherpad)"
echo " - DB_NAME: database name (default: etherpad)"
echo " - BASE_URL: HTTP URL"
echo " - AUTH_URL: auth service URL (default: http://service/api/docs/current/isauthenticated)"
echo " - SSO_URL: sso service URL (default: BASE_URL)"
exit 1
......
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