8
0
Fork 0
mirror of https://gitlab2.federez.net/re2o/re2o synced 2024-12-23 07:23:46 +00:00

Ajoute readme

This commit is contained in:
chirac 2016-07-07 12:28:20 +02:00
parent 46663eeb44
commit 71736bfbb7

32
README.md Normal file
View file

@ -0,0 +1,32 @@
== Re2o ==
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 :
Dépendances :
python3-django (1.8, jessie-backports)
django-bootstrap3 (pip install)
python3-django-macaddress (stretch)
python3-dateutil (jessie-backports)
Moteur de db conseillé (mysql), postgresql fonctionne également.
Pour mysql, il faut installer :
mysql-server (jessie)
python3-mysqldb (jessie-backports)
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.
Configuration avec apache :
re2o/wsgi.py permet de fonctionner avec apache2 en production