Go to file
Yohann D'ANELLO 52e8b46aa2 🐛 Last report date is a datetime, not a date 2020-08-09 15:50:51 +02:00
ansible Cron file must be owned by root 2020-08-06 08:21:05 +02:00
apps 🐛 Last report date is a datetime, not a date 2020-08-09 15:50:51 +02:00
locale Amount help text in transaction templates forms can be misleading: they type euros not cents 2020-08-09 14:52:57 +02:00
media/pic default picture is 200x200 2020-03-28 17:44:03 +01:00
note_kfet Use phone number validator 2020-08-05 14:14:51 +02:00
requirements 🐛 lxml is required to parse html pages 2020-08-06 12:30:14 +02:00
static Use var instead of let to declare a global var (turbolinks...) 2020-08-09 14:01:59 +02:00
templates Disable turbolinks for pages that require custom JS, like calendars or autocomplete fields 2020-08-09 15:31:38 +02:00
.dockerignore Rework on Docker image 2020-06-21 20:27:42 +02:00
.env_example Export activities in the Crans Wiki 2020-08-06 12:15:23 +02:00
.gitignore Backup database daily 2020-08-06 09:27:33 +02:00
.gitlab-ci.yml 💚 Add Python 3.8 to Gitlab CI 2020-07-30 20:45:17 +02:00
.gitmodules 💩 Use HTTPS rather than SSH to clone nk20-scripts (may be reverted later) 2020-07-15 08:25:52 +02:00
COPYING Add COPYING 2019-07-08 07:58:44 +02:00
Dockerfile Rework on Docker image 2020-06-21 20:27:42 +02:00
LICENSE Added LICENSE file 2019-09-18 14:46:10 +02:00
README.md Export activities in the Crans Wiki 2020-08-06 12:15:23 +02:00
entrypoint.sh Rework on Docker image 2020-06-21 20:27:42 +02:00
manage.py and so it begins 2019-07-07 20:49:02 +00:00
nginx_note.conf_docker Rework on Docker image 2020-06-21 20:27:42 +02:00
nginx_note.conf_example Use example.org in nginx_note.conf_example 2020-03-07 15:56:00 +01:00
note.cron Export activities in the Crans Wiki 2020-08-06 12:15:23 +02:00
tox.ini Bind GuestTransaction to entry rather than guest (fix OneToOneField) 2020-07-22 21:05:25 +02:00
uwsgi_note.ini Export activities in the Crans Wiki 2020-08-06 12:15:23 +02:00
uwsgi_params and so it begins 2019-07-07 20:49:02 +00:00

README.md

NoteKfet 2020

License: GPL v3 pipeline status coverage report

Installation sur un serveur

On supposera pour la suite que vous utilisez Debian/Ubuntu sur un serveur tout nu ou bien configuré.

  1. Paquets nécessaires

     $ sudo apt install nginx python3 python3-pip python3-dev uwsgi
     $ sudo apt install uwsgi-plugin-python3 python3-venv git acl
    

    La génération des factures de l'application trésorerie nécessite une installation de LaTeX suffisante :

     $ sudo apt install texlive-latex-extra texlive-fonts-extra texlive-lang-french
    
  2. Clonage du dépot

    on se met au bon endroit :

     $ cd /var/www/
     $ mkdir note_kfet
     $ sudo chown www-data:www-data note_kfet
     $ sudo usermod -a -G www-data $USER
     $ sudo chmod g+ws note_kfet
     $ sudo setfacl -d -m "g::rwx" note_kfet
     $ cd note_kfet
     $ git clone git@gitlab.crans.org:bde/nk20.git .
    
  3. Environment Virtuel

    À la racine du projet:

     $ python3 -m venv env
     $ source env/bin/activate
     (env)$ pip3 install -r requirements/base.txt
     (env)$ pip3 install -r requirements/prod.txt # uniquement en prod, nécessite un base postgres
     (env)$ deactivate
    
  4. uwsgi et Nginx

    Un exemple de conf est disponible :

     $ cp nginx_note.conf_example nginx_note.conf
    

    Modifier le fichier pour être en accord avec le reste de votre config

    On utilise uwsgi et Nginx pour gérer le coté serveur :

    $ sudo ln -sf /var/www/note_kfet/nginx_note.conf /etc/nginx/sites-enabled/
    

    Si l'on a un emperor (plusieurs instance uwsgi):

     $ sudo ln -sf /var/www/note_kfet/uwsgi_note.ini /etc/uwsgi/sites/
    

    Sinon:

     $ sudo ln -sf /var/www/note_kfet/uwsgi_note.ini /etc/uwsgi/apps-enabled/
    

    Le touch-reload est activé par défault, pour redémarrer la note il suffit donc de faire touch uwsgi_note.ini.

  5. Base de données

    En prod on utilise postgresql.

     $ sudo apt-get install postgresql postgresql-contrib libpq-dev
     (env)$ pip3 install psycopg2
    

    La config de la base de donnée se fait comme suit:

    a. On se connecte au shell de psql

     $ sudo su - postgres
     $ psql
    

    b. On sécurise l'utilisateur postgres

     postgres=# \password
     Enter new password:
    

    Conservez ce mot de passe de la meme manière que tous les autres.

    c. On créer la basse de donnée, et l'utilisateur associé

     postgres=# CREATE USER note WITH PASSWORD 'un_mot_de_passe_sur';
     CREATE ROLE
     postgres=# CREATE DATABASE note_db OWNER note;
     CREATE DATABASE
    

    Si tout va bien :

     postgres=#\list
     List of databases
        Name    |  Owner   | Encoding |   Collate   |    Ctype    |   Access privileges   
     -----------+----------+----------+-------------+-------------+-----------------------
      note_db   | note     | UTF8     | fr_FR.UTF-8 | fr_FR.UTF-8 | 
      postgres  | postgres | UTF8     | fr_FR.UTF-8 | fr_FR.UTF-8 | 
      template0 | postgres | UTF8     | fr_FR.UTF-8 | fr_FR.UTF-8 | =c/postgres+postgres=CTc/postgres
      template1 | postgres | UTF8     | fr_FR.UTF-8 | fr_FR.UTF-8 | =c/postgres  +postgres=CTc/postgres
     (4 rows)
    
  6. Variable d'environnement et Migrations

    On copie le fichier .env_example vers le fichier .env à la racine du projet et on renseigne des secrets et des paramètres :

     DJANGO_APP_STAGE=dev # ou "prod" 
     DJANGO_DEV_STORE_METHOD=sqllite # ou "postgres"
     DJANGO_DB_HOST=localhost
     DJANGO_DB_NAME=note_db
     DJANGO_DB_USER=note
     DJANGO_DB_PASSWORD=CHANGE_ME
     DJANGO_DB_PORT=
     DJANGO_SECRET_KEY=CHANGE_ME
     DJANGO_SETTINGS_MODULE="note_kfet.settings
     DOMAIN=localhost # note.example.com
     CONTACT_EMAIL=tresorerie.bde@localhost
     NOTE_URL=localhost # URL où accéder à la note
     # Le reste n'est utile qu'en production, pour configurer l'envoi des mails
     NOTE_MAIL=notekfet@localhost
     EMAIL_HOST=smtp.localhost
     EMAIL_PORT=465
     EMAIL_USER=notekfet@localhost
     EMAIL_PASSWORD=CHANGE_ME
     WIKI_USER=NoteKfet2020
     WIKI_PASSWORD=CHANGE_ME
    

    Ensuite on (re)bascule dans l'environement virtuel et on lance les migrations

     $ source /env/bin/activate
     (env)$ ./manage.py check # pas de bêtise qui traine
     (env)$ ./manage.py makemigrations
     (env)$ ./manage.py migrate
    
  7. Enjoy

Installer avec Docker

Il est possible de travailler sur une instance Docker.

  1. Cloner le dépôt là où vous voulez :

     $ git clone git@gitlab.crans.org:bde/nk20.git
    
  2. Copiez le fichier .env_example à la racine du projet vers le fichier .env, et mettez à jour vos variables d'environnement

  3. Dans le fichier docker_compose.yml, qu'on suppose déjà configuré, ajouter les lignes suivantes, en les adaptant à la configuration voulue :

     nk20:
       build: /chemin/vers/nk20
       volumes:
         - /chemin/vers/nk20:/code/
       env_file: /chemin/vers/nk20/.env
       restart: always
       labels:
         - traefik.domain=ndd.example.com
         - traefik.frontend.rule=Host:ndd.example.com
         - traefik.port=8000
    
  4. Enjoy :

     $ docker-compose up -d nk20
    

Installer un serveur de développement

Avec ./manage.py runserver il est très rapide de mettre en place un serveur de développement par exemple sur son ordinateur.

  1. Cloner le dépôt là où vous voulez :

     $ git clone git@gitlab.crans.org:bde/nk20.git && cd nk20
    
  2. Créer un environnement Python isolé pour ne pas interférer avec les versions de paquets systèmes :

     $ python3 -m venv venv
     $ source venv/bin/activate
     (env)$ pip install -r requirements/base.txt
    
  3. Copier le fichier .env_example vers .env à la racine du projet et mettre à jour ce qu'il faut

  4. Migrations et chargement des données initiales :

     (env)$ ./manage.py makemigrations
     (env)$ ./manage.py migrate
     (env)$ ./manage.py loaddata initial
    
  5. Créer un super-utilisateur :

     (env)$ ./manage.py createsuperuser
    
  6. Enjoy :

     (env)$ ./manage.py runserver 0.0.0.0:8000
    

En mettant 0.0.0.0:8000 après runserver, vous rendez votre instance Django accessible depuis l'ensemble de votre réseau, pratique pour tester le rendu de la note sur un téléphone !

Cahier des Charges

Il est disponible ici.

Documentation

La documentation est générée par django et son module admindocs. Commentez votre code !