re2o/README.md

# Re2o

Gnu public license v2.0

## Avant propos 

Re2o est un logiciel d'administration développé initiallement au rezometz. Il se veut agnostique au réseau considéré, de manière à être installable en quelques clics.

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

### Prérequis

Dépendances :

Avec apt (recommandé):
 * python3-django (1.8, jessie-backports)
 * python3-django-macaddress (stretch)
 * python3-dateutil (jessie-backports)
 * texlive (jessie)
 * texlive-latex-base (jessie)
 * texlive-fonts-recommended (jessie)
 * python3-djangorestframework (jessie)
 * python3-django-reversion (stretch)
 * slapd (jessie)

Paquets préalables à installer avec apt : 
 * libsasl2-dev (stable)
 * libldap2-dev (stable)
 * libssl-dev (stable)

Avec pip3 (pip3 install):
 * django-bootstrap3
 * django-ldapdb

Moteur de db conseillé (mysql), postgresql fonctionne également.
Pour mysql, il faut installer :

 * python3-mysqldb (jessie-backports)

Sur le serveur mysql :
 * mysql-server (jessie)

## Installation du ldap, opérations à réaliser en root

### 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/*

mkdir /var/lib/ldap/accesslog

### Ajoute les données et le schema

slapadd -n 0 -l schema.ldiff -F /etc/ldap/slapd.d/

slapadd -n 1 -l db.ldiff

chown -R openldap:openldap /etc/ldap/slapd.d

chown -R openldap:openldap /var/lib/ldap

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 

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.

## Mise en production avec apache

re2o/wsgi.py permet de fonctionner avec apache2 en production

## Fonctionnement avec les services

Pour charger les objets django, il suffit de faire User.objects.all() pour tous les users par exemple. 
Cependant, pour que les services fonctionnent de manière simple, des fonctions toutes prètes existent deja pour charger la liste des users autorisés à se connecter ( has_access(user)), etc. Ces fonctions sont personnalisables, et permettent un fonctionnement très simple des services.