ADD un README pour expliquer le projet et ses fichiers/dossiers

[euphorik.git] / doc / installation.txt

diff --git a/doc/installation.txt b/doc/installation.txt
index 4190db1..bc70dae 100644 (file)
--- a/doc/installation.txt
+++ b/doc/installation.txt
@@ -1,4 +1,4 @@
--- Description de l'installation de euphorik --\r
+-- Description de l'installation de Euphorik --\r
 \r
 Voici les différentes étapes décrivant l'installation du site euphorik. Certaines données sont a adaptées en fonction des besoins. L'installation est décrite pour le système d'exploitation Debian.\r
 \r
@@ -9,25 +9,54 @@ Voici les diff
 \r
 \r
 1. Installer Yaws\r
- a) $apt-get install yaws\r
+   a) $apt-get install yaws\r
 \r
 2. Configurer Yaws\r
- a) Ajouter les lignes suivantes dans /etc/yaws/yaws.conf :\r
-  - "ebin_dir = /euphorik/modules/ebin"\r
-  - "include_dir = /euphorik/modules/include"\r
- b) Le serveur virtuel est définit comme ceci dans /etc/yaws/conf.d/localhost.conf :\r
-   <server localhost>\r
-      port = 8081\r
-      listen = 0.0.0.0\r
-      docroot = /euphorik\r
-      allowed_scripts = [yaws]\r
-      appmods = <request, euphorik_requests>\r
-   </server>\r
- c) Editer '/etc/init.d/yaws' et remplacer cette ligne :\r
-  script="$DAEMON -I $YAWS_ID $@"\r
-  par celle ci :\r
-  script="$DAEMON --erlarg \"-smp auto\" --sname yaws --mnesiadir '\"/euphorik/BD\"' -I $YAWS_ID $@"\r
-  FIXME : trouver une méthode plus élégante.\r
+   a) Ajouter les lignes suivantes dans /etc/yaws/yaws.conf :\r
+      - "ebin_dir = /euphorik/modules/ebin"\r
+      - "include_dir = /euphorik/modules/include"\r
+   b) Le serveur virtuel est définit comme ceci dans /etc/yaws/conf.d/localhost.conf :\r
+      <server localhost>\r
+         port = 8081\r
+         listen = 0.0.0.0\r
+         docroot = /euphorik\r
+         allowed_scripts = [yaws]\r
+         appmods = <request, euphorik_requests>\r
+      </server>\r
+   c) Editer '/etc/init.d/yaws' et remplacer cette ligne :\r
+      script="$DAEMON -I $YAWS_ID $@"\r
+      par celle ci :\r
+      script="$DAEMON --erlarg \"-smp auto\" --sname yaws --mnesiadir '\"/euphorik/BD\"' -I $YAWS_ID $@"\r
+      FIXME : trouver une méthode plus élégante.\r
 \r
 3. Créer la base de donnée\r
-   TODO\r
+   a) Arreter Yaws (en root) :\r
+      $/etc/init.s/yaws stop\r
+   b) Lancer un noeud Erlang\r
+      - Se placer dans le répertoire /euphorik/modules/ebin\r
+      - Executer : \r
+         $erl -sname yaws -mnesia dir '"/euphorik/BD"'\r
+   c) Charger le module :\r
+      >l(euphorik_bd).\r
+   d) Créer la base :\r
+      >euphorik_bd:create().\r
+   e) Démarrer Yaws (en root) :\r
+      $/etc/init.s/yaws start\r
+      \r
+4. Administrer le site Euphorik\r
+   a) Connexion au noeud "yaws"\r
+      - Le cookie de Yaws (/var/run/yaws/.erlang.cookie ou /var/cache/yaws/.erlang.cookie) et celui de l'utilisateur courant (~/.erlang.cookie) doit être le même.\r
+         (si le cookie de yaws est modifié il faut relancer yaws).\r
+      - Se placer dans le répertoire /euphorik/modules/ebin\r
+      - Executer : \r
+         $erl -sname toto\r
+         où "toto" est le nom du noeud (tout sauf "yaws")\r
+      - Charger le module du minichat :\r
+         >l(euphorik_minichat)\r
+      - Se connecter au noeud yaws :\r
+         >euphorik_minichat:connect()\r
+         la valeur retournée doit être : {ok,[yaws@overnux]}\r
+   b) Utiliser les outils des modules\r
+      - Par exemple :\r
+         >euphorik_minichat:messages(10).\r
+         pour voir les 10 derniers messages\r