nk20/README.md

202 lines
6.5 KiB
Markdown
Raw Normal View History

2019-07-07 21:31:20 +00:00
# NoteKfet 2020
2019-07-08 10:59:27 +00:00
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.txt)
[![pipeline status](https://gitlab.crans.org/bde/nk20/badges/master/pipeline.svg)](https://gitlab.crans.org/bde/nk20/nk20/commits/master)
[![coverage report](https://gitlab.crans.org/bde/nk20/badges/master/coverage.svg)](https://gitlab.crans.org/bde/nk20/commits/master)
2019-07-07 21:31:20 +00:00
## Installation sur un serveur
On supposera pour la suite que vous utiliser debian/ubuntu sur un serveur tout nu ou bien configuré.
1. Paquets nécessaires
2020-01-21 21:03:59 +00:00
$ sudo apt install nginx python3 python3-pip python3-dev uwsgi
$ sudo apt install uwsgi-plugin-python3 python3-venv git acl
2019-07-07 21:31:20 +00:00
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
2019-07-07 21:31:20 +00:00
$ cd note_kfet
$ git clone git@gitlab.crans.org:bde/nk20.git .
3. Environment Virtuel
2019-08-15 15:59:56 +00:00
2019-07-07 21:31:20 +00:00
À la racine du projet:
$ python3 -m venv env
$ source env/bin/activate
2020-03-08 21:42:22 +00:00
(env)$ pip3 install -r requirements/base.txt
2020-03-20 19:46:44 +00:00
(env)$ pip3 install -r requirements/prod.txt # uniquement en prod, nécessite un base postgres
2019-07-07 21:31:20 +00:00
(env)$ deactivate
4. uwsgi et Nginx
2020-02-02 12:41:43 +00:00
Un exemple de conf est disponible :
$ cp nginx_note.conf_example nginx_note.conf
2020-03-11 14:54:12 +00:00
***Modifier le fichier pour être en accord avec le reste de votre config***
2020-02-02 12:41:43 +00:00
2020-03-07 20:29:45 +00:00
On utilise uwsgi et Nginx pour gérer le coté serveur :
2019-07-07 21:31:20 +00:00
2020-03-11 14:54:12 +00:00
$ sudo ln -sf /var/www/note_kfet/nginx_note.conf /etc/nginx/sites-enabled/
2019-08-15 15:59:56 +00:00
2020-03-11 14:54:12 +00:00
Si l'on a un emperor (plusieurs instance uwsgi):
2019-08-15 15:59:56 +00:00
2020-01-28 20:15:36 +00:00
$ sudo ln -sf /var/www/note_kfet/uwsgi_note.ini /etc/uwsgi/sites/
2019-07-07 21:31:20 +00:00
2019-08-15 15:59:56 +00:00
Sinon:
2020-01-28 20:15:36 +00:00
$ sudo ln -sf /var/www/note_kfet/uwsgi_note.ini /etc/uwsgi/apps-enabled/
2019-08-15 15:59:56 +00:00
2020-02-02 12:41:43 +00:00
Le touch-reload est activé par défault, pour redémarrer la note il suffit donc de faire `touch uwsgi_note.ini`.
2019-07-07 21:31:20 +00:00
5. Base de données
2020-01-27 21:36:59 +00:00
En prod on utilise postgresql.
$ sudo apt-get install postgresql postgresql-contrib libpq-dev
(env)$ pip3 install psycopg2
2020-01-27 21:36:59 +00:00
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
2020-03-11 14:54:12 +00:00
Si tout va bien :
2020-01-27 21:36:59 +00:00
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)
2020-01-27 21:36:59 +00:00
6. Variable d'environnement et Migrations
2020-03-11 14:54:12 +00:00
On copie le fichier `.env_example` vers le fichier `.env` à la racine du projet
et on renseigne des secrets et des paramètres :
2020-03-20 19:46:44 +00:00
DJANGO_APP_STAGE="dev" # ou "prod"
DJANGO_DEV_STORE_METHOD="sqllite" # ou "postgres"
2020-03-11 16:13:19 +00:00
DJANGO_DB_HOST="localhost"
DJANGO_DB_NAME="note_db"
DJANGO_DB_USER="note"
2020-03-20 19:46:44 +00:00
DJANGO_DB_PASSWORD="CHANGE_ME"
2020-03-11 16:13:19 +00:00
DJANGO_DB_PORT=""
DJANGO_SECRET_KEY="CHANGE_ME"
DJANGO_SETTINGS_MODULE="note_kfet.settings"
2020-03-20 19:46:44 +00:00
DOMAIN="localhost" # note.example.com
2020-03-11 16:51:42 +00:00
CONTACT_EMAIL="tresorerie.bde@localhost"
2020-03-20 19:46:44 +00:00
NOTE_URL="localhost" # serveur cas note.example.com si auto-hébergé.
2020-03-11 14:54:12 +00:00
Ensuite on (re)bascule dans l'environement virtuel et on lance les migrations
2020-02-20 21:10:37 +00:00
2020-01-27 21:36:59 +00:00
$ source /env/bin/activate
2020-03-11 14:54:12 +00:00
(env)$ ./manage.py check # pas de bêtise qui traine
2020-01-27 21:36:59 +00:00
(env)$ ./manage.py makemigrations
(env)$ ./manage.py migrate
7. Enjoy
2020-02-03 10:50:42 +00:00
## Installer avec Docker
Il est possible de travailler sur une instance Docker.
1. Cloner le dépôt là où vous voulez :
2020-01-27 21:36:59 +00:00
2020-02-03 10:50:42 +00:00
$ git clone git@gitlab.crans.org:bde/nk20.git
2020-03-11 14:54:12 +00:00
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é,
2020-02-20 21:10:37 +00:00
ajouter les lignes suivantes, en les adaptant à la configuration voulue :
2020-02-03 10:50:42 +00:00
nk20:
build: /chemin/vers/nk20
volumes:
- /chemin/vers/nk20:/code/
2020-03-11 14:54:12 +00:00
env_file: /chemin/vers/nk20/.env
2020-02-03 10:50:42 +00:00
restart: always
labels:
- traefik.domain=ndd.example.com
- traefik.frontend.rule=Host:ndd.example.com
2020-02-03 10:50:42 +00:00
- traefik.port=8000
3. Enjoy :
$ docker-compose up -d nk20
2019-08-15 15:59:56 +00:00
2020-02-20 21:10:37 +00:00
## Installer un serveur de développement
2019-07-07 21:31:20 +00:00
2020-02-20 21:10:37 +00:00
Avec `./manage.py runserver` il est très rapide de mettre en place
un serveur de développement par exemple sur son ordinateur.
2019-07-07 21:31:20 +00:00
2020-02-03 10:50:42 +00:00
1. Cloner le dépôt là où vous voulez :
2019-08-15 15:59:56 +00:00
2020-02-20 21:10:37 +00:00
$ git clone git@gitlab.crans.org:bde/nk20.git && cd nk20
2019-08-15 15:59:56 +00:00
2020-02-20 21:10:37 +00:00
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
2020-03-20 19:46:44 +00:00
(env)$ pip install -r requirements/base.txt
2019-08-15 15:59:56 +00:00
2020-03-11 14:54:12 +00:00
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 :
2019-08-15 15:59:56 +00:00
(env)$ ./manage.py makemigrations
(env)$ ./manage.py migrate
2020-02-20 21:10:37 +00:00
(env)$ ./manage.py loaddata initial
2019-08-15 15:59:56 +00:00
2020-03-11 14:54:12 +00:00
5. Créer un super-utilisateur :
2019-08-15 15:59:56 +00:00
2020-02-20 21:10:37 +00:00
(env)$ ./manage.py createsuperuser
2020-01-21 21:03:59 +00:00
2020-03-11 14:54:12 +00:00
6. Enjoy :
2020-01-21 21:03:59 +00:00
2020-02-20 21:10:37 +00:00
(env)$ ./manage.py runserver 0.0.0.0:8000
2020-01-21 21:03:59 +00:00
2020-02-20 21:10:37 +00:00
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 !
2019-08-15 15:59:56 +00:00
2019-07-07 21:31:20 +00:00
## Cahier des Charges
2019-07-07 21:36:04 +00:00
Il est disponible [ici](https://wiki.crans.org/NoteKfet/NoteKfet2018/CdC).
2019-07-07 21:31:20 +00:00
## Documentation
2020-02-20 21:10:37 +00:00
La documentation est générée par django et son module admindocs.
2020-03-11 14:54:12 +00:00
**Commentez votre code !**