use .env for project configuration

Author: imperosol

.env.example

@@ -0,0 +1,83 @@
+HTTPS=off
+DEBUG=true
+
+# This is not the real key used in prod
+SECRET_KEY=(4sjxvhz@m5$0a$j0_pqicnc$s!vbve)z+&++m%g%bjhlz4+g2
+
+DATABASE_URL=sqlite:///db.sqlite3
+# uncomment the next line if you want to use a postgres database
+#DATABASE_URL=postgres://user:[email protected]:5432/sith
+CACHE_URL=redis://127.0.0.1:6379/0
+
+MEDIA_ROOT=data
+STATIC_ROOT=static
+
+DEFAULT_FROM_EMAIL=[email protected]
+SITH_COM_EMAIL=[email protected]
+
+HONEYPOT_VALUE=content
+HONEYPOT_FIELD_NAME=body2
+HONEYPOT_FIELD_NAME_FORUM=message2
+
+EMAIL_BACKEND=django.core.mail.backends.console.EmailBackend
+EMAIL_HOST=localhost
+EMAIL_PORT=25
+
+SITH_URL=127.0.0.1:8000
+SITH_NAME="AE UTBM"
+
+SITH_MAIN_CLUB_ID=1
+
+SITH_GROUP_ROOT_ID=1
+SITH_GROUP_PUBLIC_ID=2
+SITH_GROUP_SUBSCRIBERS_ID=3
+SITH_GROUP_OLD_SUBSCRIBERS_ID=4
+SITH_GROUP_ACCOUNTING_ADMIN_ID=5
+SITH_GROUP_COM_ADMIN_ID=6
+SITH_GROUP_COUNTER_ADMIN_ID=7
+SITH_GROUP_BANNED_ALCOHOL_ID=8
+SITH_GROUP_BANNED_COUNTER_ID=9
+SITH_GROUP_BANNED_SUBSCRIPTION_ID=10
+SITH_GROUP_SAS_ADMIN_ID=11
+SITH_GROUP_FORUM_ADMIN_ID=12
+SITH_GROUP_PEDAGOGY_ADMIN_ID=13
+
+SITH_CLUB_REFOUND_ID=89
+SITH_COUNTER_REFOUND_ID=38
+SITH_PRODUCT_REFOUND_ID=5
+
+# Counter
+
+SITH_COUNTER_ACCOUNT_DUMP_ID=39
+
+# Defines which product type is the refilling type, and thus increases the account amount
+SITH_COUNTER_PRODUCTTYPE_REFILLING=3
+
+SITH_ECOCUP_CONS=1152
+SITH_ECOCUP_DECO=1151
+
+# Defines which product is the one year subscription and which one is the six month subscription
+SITH_PRODUCT_SUBSCRIPTION_ONE_SEMESTER=1
+SITH_PRODUCT_SUBSCRIPTION_TWO_SEMESTERS=2
+SITH_PRODUCTTYPE_SUBSCRIPTION=2
+
+# Defines which club lets its members the ability to see users subscription history
+# 14 => "Intégration" club
+SITH_CAN_CREATE_SUBSCRIPTION_HISTORY=1
+SITH_CAN_READ_SUBSCRIPTION_HISTORY=1
+
+# SAS variables
+SITH_SAS_ROOT_DIR_ID=4
+
+# ET variables
+SITH_EBOUTIC_CB_ENABLED=true
+SITH_EBOUTIC_ET_URL="https://preprod-tpeweb.e-transactions.fr/cgi/MYchoix_pagepaiement.cgi"
+SITH_EBOUTIC_PBX_SITE=1999888
+SITH_EBOUTIC_PBX_RANG=32
+SITH_EBOUTIC_PBX_IDENTIFIANT=2
+SITH_EBOUTIC_HMAC_KEY=0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF
+SITH_EBOUTIC_PUB_KEY_PATH=sith/et_keys/pubkey.pem
+
+SITH_MAILING_FETCH_KEY=IloveMails
+SENTRY_DSN=
+SENTRY_ENV=production

.github/workflows/ci.yml

@@ -7,6 +7,10 @@ on:
     branches: [master, taiste]
   workflow_dispatch:
 
+env:
+  SECRET_KEY: notTheRealOne
+  DATABASE_URL: sqlite:///db.sqlite3
+
 jobs:
   pre-commit:
     name: Launch pre-commits checks (ruff)

.gitignore

@@ -21,3 +21,4 @@ node_modules/
 
 # compiled documentation
 site/
+.env

docs/howto/prod.md

@@ -2,13 +2,13 @@
 
 Pour connecter l'application à une instance de sentry (ex: https://sentry.io),
 il est nécessaire de configurer la variable `SENTRY_DSN`
-dans le fichier `settings_custom.py`.
+dans le fichier `.env`.
 Cette variable est composée d'un lien complet vers votre projet sentry.
 
 ## Récupérer les statiques
 
 Nous utilisons du SCSS dans le projet.
-En environnement de développement (`DEBUG=True`),
+En environnement de développement (`DEBUG=true`),
 le SCSS est compilé à chaque fois que le fichier est demandé.
 Pour la production, le projet considère 
 que chacun des fichiers est déjà compilé.

docs/tutorial/install-advanced.md

@@ -47,19 +47,19 @@ Commencez par installer les dépendances système :
     === "Debian/Ubuntu"
 
         ```bash
-        sudo apt install postgresql redis libq-dev nginx
+        sudo apt install postgresql libq-dev nginx
         ```
 
     === "Arch Linux"
 
         ```bash
-        sudo pacman -S postgresql redis nginx
+        sudo pacman -S postgresql nginx
         ```
 
 === "macOS"
 
     ```bash
-    brew install postgresql redis lipbq nginx
+    brew install postgresql lipbq nginx
     export PATH="/usr/local/opt/libpq/bin:$PATH"
     source ~/.zshrc
     ```
@@ -77,34 +77,6 @@ poetry install --with prod
     C'est parce que ces dépendances compilent certains modules
     à l'installation.
 
-## Configurer Redis
-
-Redis est utilisé comme cache.
-Assurez-vous qu'il tourne :
-
-```bash
-sudo systemctl redis status
-```
-
-Et s'il ne tourne pas, démarrez-le :
-
-```bash
-sudo systemctl start redis
-sudo systemctl enable redis  # si vous voulez que redis démarre automatiquement au boot
-```
-
-Puis ajoutez le code suivant à la fin de votre fichier
-`settings_custom.py` :
-
-```python
-CACHES = {
-    "default": {
-        "BACKEND": "django.core.cache.backends.redis.RedisCache",
-        "LOCATION": "redis://127.0.0.1:6379",
-    }
-}
-```
-
 ## Configurer PostgreSQL
 
 PostgreSQL est utilisé comme base de données.
@@ -139,26 +111,19 @@ en étant connecté en tant que postgres :
 psql -d sith -c "GRANT ALL PRIVILEGES ON SCHEMA public to sith";
 ```
 
-Puis ajoutez le code suivant à la fin de votre
-`settings_custom.py` :
-
-```python
-DATABASES = {
-    "default": {
-        "ENGINE": "django.db.backends.postgresql",
-        "NAME": "sith",
-        "USER": "sith",
-        "PASSWORD": "password",
-        "HOST": "localhost",
-        "PORT": "",  # laissez ce champ vide pour que le choix du port soit automatique
-    }
-}
+Puis modifiez votre `.env`.
+Dedans, décommentez l'url de la base de données
+de postgres et commentez l'url de sqlite :
+
+```dotenv
+#DATABASE_URL=sqlite:///db.sqlite3
+DATABASE_URL=postgres://sith:password@localhost:5432/sith
 ```
 
 Enfin, créez vos données :
 
 ```bash
-poetry run ./manage.py populate
+poetry run ./manage.py setup
 ```
 
 !!! note
@@ -247,7 +212,7 @@ Puis lancez ou relancez nginx :
 sudo systemctl restart nginx
 ```
 
-Dans votre `settings_custom.py`, remplacez `DEBUG=True` par `DEBUG=False`.
+Dans votre `.env`, remplacez `DEBUG=true` par `DEBUG=false`.
 
 Enfin, démarrez le serveur Django :
 

docs/tutorial/install.md

@@ -8,6 +8,7 @@ Certaines dépendances sont nécessaires niveau système :
 - zlib1g-dev
 - python
 - gettext
+- redis
 
 ### Installer WSL
 
@@ -79,7 +80,7 @@ cd /mnt/<la_lettre_du_disque>/vos/fichiers/comme/dhab
         ```bash
         sudo apt install build-essential libssl-dev libjpeg-dev zlib1g-dev python-dev npm \
                  libffi-dev python-dev-is-python3 pkg-config \
-                 gettext git pipx
+                 gettext git pipx redis
 
         pipx install poetry
         ```
@@ -91,7 +92,7 @@ cd /mnt/<la_lettre_du_disque>/vos/fichiers/comme/dhab
 
         sudo pacman -S python
         
-        sudo pacman -S gcc git gettext pkgconf python-poetry npm
+        sudo pacman -S gcc git gettext pkgconf python-poetry redis npm
         ```
 
 === "macOS"
@@ -100,7 +101,7 @@ cd /mnt/<la_lettre_du_disque>/vos/fichiers/comme/dhab
     Il est également nécessaire d'avoir installé xcode
 
     ```bash    
-    brew install git python pipx npm
+    brew install git python pipx redis npm
     pipx install poetry
 
     # Pour bien configurer gettext
@@ -112,6 +113,15 @@ cd /mnt/<la_lettre_du_disque>/vos/fichiers/comme/dhab
         Si vous rencontrez des erreurs lors de votre configuration, n'hésitez pas à vérifier l'état de votre installation homebrew avec :code:`brew doctor`
 
 
+Parmi les dépendances installées se trouve redis (que nous utilisons comme cache).
+Redis est un service qui doit être activé pour être utilisé.
+Pour cela, effectuez les commandes :
+
+```bash
+sudo systemctl start redis
+sudo systemctl enable redis  # si vous voulez que redis démarre automatiquement au boot
+```
+
 ## Finaliser l'installation
 
 Clonez le projet (depuis votre console WSL, si vous utilisez WSL)
@@ -133,20 +143,24 @@ poetry run ./manage.py install_xapian
     de texte à l'écran.
     C'est normal, il ne faut pas avoir peur.
 
-Maintenant que les dépendances sont installées, nous
-allons créer la base de données, la remplir avec des données de test,
-et compiler les traductions.
-Cependant, avant de faire cela, il est nécessaire de modifier
-la configuration pour signifier que nous sommes en mode développement.
-Pour cela, nous allons créer un fichier `sith/settings_custom.py`
-et l'utiliser pour surcharger les settings de base.
+Une fois les dépendances installées, il faut encore
+mettre en place quelques éléments de configuration,
+qui peuvent varier d'un environnement à l'autre.
+Ces variables sont stockées dans un fichier `.env`.
+Pour le créer, vous pouvez copier le fichier `.env.example` :
 
 ```bash
-echo "DEBUG=True" > sith/settings_custom.py
-echo 'SITH_URL = "localhost:8000"' >> sith/settings_custom.py
+cp .env.example .env
 ```
 
-Enfin, nous pouvons lancer les commandes suivantes :
+Les variables par défaut contenues dans le fichier `.env`
+devraient convenir pour le développement, sans modification.
+
+Maintenant que les dépendances sont installées
+et la configuration remplie, nous allons pouvoir générer
+des données utiles pendant le développement.
+
+Pour cela, lancez les commandes suivantes :
 
 ```bash
 # Activation de l'environnement virtuel
@@ -187,6 +201,30 @@ python manage.py runserver
     [http://localhost:8000/api/docs](http://localhost:8000/api/docs),
     une interface swagger, avec toutes les routes de l'API.
 
+!!! question "Pourquoi l'installation est aussi complexe ?"
+
+    Cette question nous a été posée de nombreuses fois par des personnes
+    essayant d'installer le projet.
+    Il y a en effet un certain nombre d'étapes à suivre,
+    de paquets à installer et de commandes à exécuter.
+    
+    Le processus d'installation peut donc sembler complexe.
+
+    En réalité, il est difficile de faire plus simple.
+    En effet, un site web a besoin de beaucoup de composants
+    pour être développé : il lui faut au minimum
+    une base de données, un cache, un bundler Javascript
+    et un interpréteur pour le code du serveur.
+    Pour nos besoin particuliers, nous utilisons également
+    un moteur de recherche full-text.
+    
+    Nous avons tenté au maximum de limiter le nombre de dépendances
+    et de sélecionner les plus simples à installer.
+    Cependant, il est impossible de retirer l'intégralité
+    de la complexité du processus.
+    Si vous rencontrez des difficulté lors de l'installation,
+    n'hésitez pas à demander de l'aide.
+
 ## Générer la documentation
 
 La documentation est automatiquement mise en ligne à chaque envoi de code sur GitHub.