MOD maj de la faq et du todo
[euphorik.git] / doc / installation.txt
1 -- Description de l'installation de Euphorik --\r
2 \r
3 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
4 \r
5 * On admet que le dossier de base est "/euphorik".\r
6 * On admet que l'utilisateur courant est "toto" et qu'il possède "/euphorik"\r
7 * Tout ce qui commence par un '$' correspond à une ligne de commande tapée dans le shell de l'OS.\r
8 * Tout ce qui commence par un '>' correspond à une instruction dans le shell de erlang.\r
9 \r
10 \r
11 1. Installer Yaws\r
12    a) $apt-get install yaws\r
13 \r
14 2. Configurer Yaws\r
15    a) Ajouter les lignes suivantes dans /etc/yaws/yaws.conf :\r
16       - "ebin_dir = /euphorik/modules/ebin"\r
17       - "include_dir = /euphorik/modules/include"\r
18    b) Le serveur virtuel est définit comme ceci dans /etc/yaws/conf.d/localhost.conf :\r
19       <server localhost>\r
20          port = 8081\r
21          listen = 0.0.0.0\r
22          docroot = /euphorik\r
23          allowed_scripts = [yaws]\r
24          appmods = <request, euphorik_requests>\r
25       </server>\r
26    c) Editer '/etc/init.d/yaws' et remplacer cette ligne :\r
27       script="$DAEMON -I $YAWS_ID $@"\r
28       par celle ci :\r
29       script="$DAEMON --erlarg \"-smp auto\" --sname yaws --mnesiadir '\"/euphorik/BD\"' -I $YAWS_ID $@"\r
30       FIXME : trouver une méthode plus élégante.\r
31 \r
32 3. Créer la base de donnée\r
33    a) Arreter Yaws (en root) :\r
34       $/etc/init.s/yaws stop\r
35    b) Lancer un noeud Erlang\r
36       - Se placer dans le répertoire /euphorik/modules/ebin\r
37       - Executer : \r
38          $erl -sname yaws -mnesia dir '"/euphorik/BD"'\r
39    c) Charger le module :\r
40       >l(euphorik_bd).\r
41    d) Créer la base :\r
42       >euphorik_bd:create().\r
43    e) Démarrer Yaws (en root) :\r
44       $/etc/init.s/yaws start\r
45       \r
46 4. Administrer le site Euphorik\r
47    a) Connexion au noeud "yaws"\r
48       - 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
49          (si le cookie de yaws est modifié il faut relancer yaws).\r
50       - Se placer dans le répertoire /euphorik/modules/ebin\r
51       - Executer : \r
52          $erl -sname toto\r
53          où "toto" est le nom du noeud (tout sauf "yaws")\r
54       - Charger le module du minichat :\r
55          >l(euphorik_minichat)\r
56       - Se connecter au noeud yaws :\r
57          >euphorik_minichat:connect()\r
58          la valeur retournée doit être : {ok,[yaws@overnux]}\r
59    b) Utiliser les outils des modules\r
60       - Par exemple :\r
61          >euphorik_minichat:messages(10).\r
62          pour voir les 10 derniers messages\r