Update README.md

README.md

@@ -9,6 +9,8 @@ Re2o est un logiciel d'administration développé initiallement au rezometz. Il
 Il utilise le framework django avec python3. Il permet de gérer les adhérents, les machines, les factures, les droits d'accès, les switchs et la topologie du réseau.
 De cette manière, il est possible de pluguer très facilement des services dessus, qui accèdent à la base de donnée en passant par django (ex : dhcp), en chargeant la liste de toutes les mac-ip, ou la liste des mac-ip autorisées sur le réseau (adhérent à jour de cotisation).
 
+#Installation
+
 ## Installation des dépendances
 
 L'installation comporte 3 partie : le serveur web où se trouve le depot re2o ainsi que toutes ses dépendances, le serveur bdd (mysql ou pgsql) et le serveur ldap. Ces 3 serveurs peuvent en réalité être la même machine, ou séparés (recommandé en production).
@@ -71,14 +73,14 @@ Sur le serveur B, installer mysql ou postgresql, dans la version jessie ou stret
 Sur le serveur C (ldap), avec apt :
  * slapd (jessie/stretch)
 
-## Installation sur le serveur principal A
+### Installation sur le serveur principal A
 
 Cloner le dépot re2o à partir du gitlab, par exemple dans /var/www/re2o.
 Ensuite, il faut créer le fichier settings_local.py dans le sous dossier re2o, un settings_local.example.py est présent. Les options sont commentées, et des options par défaut existent.
 
 En particulier, il est nécessaire de générer un login/mdp admin pour le ldap et un login/mdp pour l'utilisateur sql (cf ci-dessous), à mettre dans settings_local.py
 
-## Installation du serveur mysql/postgresql sur B
+### Installation du serveur mysql/postgresql sur B
 
 Sur le serveur mysql ou postgresl, il est nécessaire de créer une base de donnée re2o, ainsi qu'un user re2o et un mot de passe associé. Ne pas oublier de faire écouter le serveur mysql ou postgresql avec les acl nécessaire pour que A puisse l'utiliser.
 
@@ -91,57 +93,47 @@ Voici les étapes à éxecuter pour mysql :
 Si les serveurs A et B ne sont pas la même machine, il est nécessaire de remplacer localhost par l'ip avec laquelle A contacte B dans les commandes du dessus.
 Une fois ces commandes effectuées, ne pas oublier de vérifier que newuser et password sont présents dans settings_local.py
 
-### Installation du serveur ldap
+### Installation du serveur ldap sur le serveur C
 
 Ceci se fait en plusieurs étapes : 
  * générer un login/mdp administrateur (par example mkpasswd sous debian)
  * Copier depuis re2o/install_utils (dans le dépot re2o) les fichiers db.ldiff et schema.ldiff (normalement sur le serveur A) sur le serveur C (par ex dans /tmp)
- * 
-### Insérer le mot de passe dans FILL_IN du schema.ldiff et db.ldiff, en hashant le mdp à l'aide de slappasswd
-
-### Remplacer dans schema.ldiff et db.ldiff 'dc=example,dc=org' par le suffixe de l'association
-
-### Arréter slapd
-
-service slapd stop
-
-### Supprimer les données existantes
-
-rm -rf /etc/ldap/slapd.d/*
-
-rm -rf /var/lib/ldap/*
+ * Hasher le mot de passe généré en utilisant la commande slappasswd (installée par slapd)
+ * Remplacer toutes les sections FILL_IN par le hash dans schema.ldiff et db.ldiff
+ * Remplacer dans schema.ldiff et db.ldiff 'dc=example,dc=org' par le suffixe de l'organisation
+ * Arréter slapd
+ * Supprimer les données existantes : '''rm -rf /etc/ldap/slapd.d/*''' et '''rm -rf /var/lib/ldap/*'''
+ * Injecter le nouveau schéma : '''slapadd -n 0 -l schema.ldiff -F /etc/ldap/slapd.d/''' et '''slapadd -n 1 -l db.ldiff'''
+ * Réparer les permissions (chown -R openldap:openldap /etc/ldap/slapd.d et chown -R openldap:openldap /var/lib/ldap) puis relancer slapd
 
-mkdir /var/lib/ldap/accesslog
+Normalement le serveur ldap démare et est fonctionnel. Par défaut tls n'est pas activé, il faut pour cela modifier le schéma pour indiquer l'emplacement du certificat.
+Pour visualiser et éditer le ldap, l'utilisation de shelldap est fortement recommandée, en utilisant en binddn cn=admin,dc=ldap,dc=example,dc=org et binddpw le mot de passe admin.
 
-### Ajoute les données et le schema
+## Configuration initiale
 
-slapadd -n 0 -l schema.ldiff -F /etc/ldap/slapd.d/
+Normalement à cette étape, le ldap et la bdd sql sont configurées correctement.
 
-slapadd -n 1 -l db.ldiff
+Il faut alors lancer dans le dépot re2o '''python3 manage.py migrate''' qui va structurer initialement la base de données.
+Les migrations sont normalement comitées au fur et à mesure, néanmoins cette étape peut crasher, merci de reporter les bugs.
 
-chown -R openldap:openldap /etc/ldap/slapd.d
+## Démarer le site web
 
-chown -R openldap:openldap /var/lib/ldap
+Il faut utiliser un moteur pour servir le site web. Nginx ou apache2 sont recommandés.
+Pour apache2 :
+ * apt install apache2
+ * apt install libapache2-mod-wsgi-py3 (pour le module wsgi)
 
-service slapd start
-
-## Installation du sql et démarage django
-
-Installer mysql ou postgresql
-
-Créer la base de donnée re2o, en créant un utilisateur re2o avec des droits sur une bdd re2o
-
-### Créer settings_local.py à partir de settings_local.example.py
-
-## Configuration 
+Un example de site apache2 se trouve dans install_utils ( re2o.conf)
+re2o/wsgi.py permet de fonctionner avec apache2 en production
 
-Le site est prêt a fonctionner, il faut simplement créer la base de donnée (par défaut re2o), et régler les variables présentes dans setting_local.py
-Un fichier d'exemple est disponible.
-Ensuite, effectuer les migrations. Un squelette de base de donnée, via un mysqldump peut être fourni.
+## Configuration avancée
 
-## Mise en production avec apache
+Une fois démaré, le site web devrait être accessible. 
+Pour créer un premier user, faire '''python3 manage.py createsuperuser''' qui va alors créer un user admin.
+Il est conseillé de créer alors les droits cableur, bureau, trésorier et infra, qui n'existent pas par défaut dans le menu adhérents.
+Il est également conseillé de créer un user portant le nom de l'association/organisation, qui possedera l'ensemble des machines.
 
-re2o/wsgi.py permet de fonctionner avec apache2 en production
+# Fonctionnement interne
 
 ## Fonctionnement avec les services