62c7e886e9 | ||
---|---|---|
apps | ||
locale/fr/LC_MESSAGES | ||
note_kfet | ||
static | ||
templates | ||
.coveragerc | ||
.gitignore | ||
.gitlab-ci.yml | ||
.pylintrc | ||
COPYING | ||
LICENSE | ||
README.md | ||
manage.py | ||
nginx_note.conf | ||
requirements.txt | ||
tox.ini | ||
uwsgi_note.ini | ||
uwsgi_params |
README.md
NoteKfet 2020
Installation sur un serveur
On supposera pour la suite que vous utiliser debian/ubuntu sur un serveur tout nu ou bien configuré.
-
Paquets nécessaires
$ sudo apt install nginx python3 python3-pip python3-dev uwsgi $ sudo apt install uwsgi-plugin-python3 python3-virtualenv git
-
Clonage du dépot
on se met au bon endroit :
$ cd /var/www/ $ mkdir note_kfet $ cd note_kfet $ git clone git@gitlab.crans.org:bde/nk20.git .
-
Environment Virtuel
À la racine du projet:
$ virtualenv env $ source /env/bin/activate (env)$ pip install -r requirements.txt (env)$ deactivate
-
uwsgi et Nginx
On utilise uwsgi et Nginx pour gérer le coté serveu :
$ sudo ln -s /var/www/note_kfet/nginx_note.conf /etc/nginx/sites-enabled/
Modifier la config nginx pour l'adapter à votre server!
Si l'on a un emperor (plusieurs instance uwsgi):
$ sudo ln -s /var/www/note_kfet/uwsgi_note.ini /etc/uwsgi/sites/
Sinon:
$ sudo ln -s /var/www/note_kfet/uwsgi_note.ini /etc/uwsgi/apps-enabled/
-
Base de données
En prod on utilise postgresql.
$ sudo apt-get install postgresql postgresql-contrib libpq-dev (env)$ pip 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)
NB: cette config est en adéquation avec note_kfet/settings/production.py
. penser à changer le mots de passe dans note_kfet/settings/secrets.py
-
Variable d'environnement et Migrations
on modifie le fichier d'environnement: ``` # env/bin/activate: deactivate () { ... # Unset local environment variables unset DJANGO_APP_STAGE } ... #at end of the file: export DJANGO_APP_STAGE="prod" ```
Ensuite on bascule dans l'environement virtuel et on lance les migrations
$ source /env/bin/activate
(env)$ ./manage.py makemigrations
(env)$ ./manage.py migrate
- Enjoy
Installer en local
Il est tout a fait possible de travailler en local, vive ./manage.py runserver
!
-
Cloner le dépot là ou vous voulez:
$ git clone git@gitlab.crans.org:bde/nk20.git
-
Initialiser l'environnement Virtuel
$ cd nk20 $ virtualenv env $ source /env/bin/activate (env)$ pip install -r requirements.txt
-
Migrations:
(env)$ ./manage.py makemigrations (env)$ ./manage.py migrate
-
Enjoy:
(env)$ ./manage.py runserver
Minimal Setup
-
Créer un superuser :
(env)$ ./manage.py createsuperuser
Avec ce dernier vous pouvez vous connecter à l'interface admin de Django, avoir accès à la doc auto-générée du projet, jouer avec des models, etc ...
Cahier des Charges
Il est disponible ici.
Documentation
La documentation est générée par django et son module admindocs. *Commenter votre code !