ADD script permettant la mise à jour de la BD et le rechargement des modules lors...
[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>
25          start_mod = euphorik_daemon\r
26       </server>\r
27    c) Editer '/etc/init.d/yaws' et remplacer cette ligne :\r
28       script="$DAEMON -I $YAWS_ID $@"\r
29       par celle ci :\r
30       script="$DAEMON --sname yaws --mnesiadir \"/euphorik/BD\" -I $YAWS_ID $@"\r
31       FIXME : trouver une méthode plus élégante.\r
32 \r
33 3. Créer la base de donnée\r
34    a) Arreter Yaws (en root) :\r
35       $/etc/init.s/yaws stop\r
36    b) Lancer un noeud Erlang\r
37       - Se placer dans le répertoire /euphorik/modules/ebin\r
38       - Executer : \r
39          $erl -sname yaws -mnesia dir '"/euphorik/BD"'\r
40    c) Charger le module :\r
41       >l(euphorik_bd).\r
42    d) Créer la base :\r
43       >euphorik_bd:create().\r
44    e) Démarrer Yaws (en root) :\r
45       $/etc/init.s/yaws start\r
46    \r
47 4. Adminisatration du site Euphorik\r
48    a) Connexion au noeud "yaws"\r
49          erl -sname gb\r
50       puis dans la console :\r
51          CTRL-G\r
52          r yaws@overnux\r
53          c 2\r
54       Pour plus d'infos : http://www.ejabberd.im/interconnect-erl-nodes\r
55       Il est possible de connecter un shell directement sur le noeud de yaws comme ceci :\r
56          erl -sname gb -remsh yaws@overnux\r
57       \r
58    b) Utiliser les outils des modules\r
59       - Par exemple :\r
60          >euphorik_minichat:messages(10).\r
61          pour voir les 10 derniers messages   \r
62       \r
63    c) Ancienne méthode de connexion (plus compliqué)\r
64       - 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
65          (si le cookie de yaws est modifié il faut relancer yaws).\r
66       - Se placer dans le répertoire /euphorik/modules/ebin\r
67       - Executer : \r
68          $erl -sname toto\r
69          où "toto" est le nom du noeud (tout sauf "yaws")\r
70       - Charger le module du minichat :\r
71          >l(euphorik_minichat)\r
72       - Se connecter au noeud yaws :\r
73          >euphorik_minichat:connect()\r
74          la valeur retournée doit être : {ok,[yaws@overnux]}\r
75          \r
76    d) Informations sur la mémoire consommée :\r
77       Mémoire totale (ko) :\r
78           trunc(element(2, lists:nth(1, memory())) / 1024).\r
79       voir c:i() également\r