Aller au contenu

Installer Néobab

Installer le paquet Python

Néobab est écrit en Python. Il faut s'assurer d'avoir un système où une version récente est disponible.

Il est conseillé de travailler dans un environnement virtuel. Toutes les commandes suivantes sont exécutées une fois cet environnement activé.

$ pip install -U pip setuptools
$ pip install wheel
$ pip install neobab

En fonction de votre environnement, il faudra choisir et installer un pilote pour la base de données :

$ pip install neobab[mysql]

Configurer l'application

Un fichier de configuration .ini (config.ini dans la suite de ce document) doit être créé. Il est conseillé de démarrer à partir du fichier config_sample.ini.

Les variables suivantes devraient être changées :

  • app_url
  • sqlalchemy.url (ex. : mysql+pymysql://<user>:<password>@<host>[:<port>]/<dbname>)
  • data_dir (le dossier où seront sauvegarder les attachements)
  • ldap.*
  • smtp.*
  • auth.secret
  • session.secret

Pour plus de sécurité et si l'application est servie via le protocol HTTPS :

  • headers.secured = true
  • session.secure = true

Préparer de la base de donnée

Une fois l'application configurée, il faut initialiser la base de données :

$ neobab config.ini db init

Lancer l'application

L'application devrait être lancée et servie derrière un serveur web comme, par exemple, Apache.

Il est possible, pour des besoins de tests, de la démarrer sans serveur web, avec la commande suivante :

$ pip install gunicorn
$ gunicorn --reload --paste config.ini --access-logfile - --error-logfile -