Merge pull request #335 from HE-Arc/develop

Hotfix

backend/.env.example

@@ -1,17 +1,22 @@
-APP_NAME=Laravel
+APP_NAME=Caravel
 APP_ENV=local
-APP_KEY=
+APP_KEY=base64:jrlEJbH4+CR0rUg5IfzVqJ+IjDdGyKQncSiLZ2WQjVk=
 APP_DEBUG=true
-APP_URL=http://localhost
+APP_URL=http://127.0.0.1:8080
 
 LOG_CHANNEL=stack
 
+# Firebase configuration details https://github.com/kreait/laravel-firebase#configuration
+FIREBASE_CREDENTIALS= 
+FIREBASE_DATABASE_URL=
+FIREBASE_AUTHORIZATION_KEY=
+
 DB_CONNECTION=mysql
 DB_HOST=127.0.0.1
 DB_PORT=3306
-DB_DATABASE=laravel
+DB_DATABASE=caravel
 DB_USERNAME=root
-DB_PASSWORD=secret
+DB_PASSWORD=
 
 BROADCAST_DRIVER=log
 CACHE_DRIVER=file
@@ -23,24 +28,16 @@ REDIS_HOST=127.0.0.1
 REDIS_PASSWORD=null
 REDIS_PORT=6379
 
-MAIL_MAILER=smtp
-MAIL_HOST=smtp.mailtrap.io
-MAIL_PORT=2525
-MAIL_USERNAME=null
-MAIL_PASSWORD=null
-MAIL_ENCRYPTION=null
-MAIL_FROM_ADDRESS=null
-MAIL_FROM_NAME="${APP_NAME}"
-
-AWS_ACCESS_KEY_ID=
-AWS_SECRET_ACCESS_KEY=
-AWS_DEFAULT_REGION=us-east-1
-AWS_BUCKET=
-
-PUSHER_APP_ID=
-PUSHER_APP_KEY=
-PUSHER_APP_SECRET=
-PUSHER_APP_CLUSTER=mt1
-
 MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
 MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
+
+LDAP_LOGGING=true
+LDAP_CONNECTION=default
+LDAP_HOST=127.0.0.1
+LDAP_USERNAME="cn=admin,dc=planetexpress,dc=com"
+LDAP_PASSWORD=GoodNewsEveryone
+LDAP_PORT=10389
+LDAP_BASE_DN="ou=people,dc=planetexpress,dc=com"
+LDAP_TIMEOUT=5
+LDAP_SSL=false
+LDAP_TLS=false

docs/userguide.md

@@ -21,6 +21,7 @@ Les sections suivantes ont besoin que les éléments qui suivent soient install
 * Git
 * PHP (version >= 7.4)
 * Accès LDAP
+  * Optionnel : docker
 
 # Installation
 Dans un premier temps il faut cloner le projet depuis le GitHub avec la commande 
@@ -35,7 +36,19 @@ Naviguez dans le dossier backend
 > cd backend
 
 ### Configuration de l'environnement
-Avant de lancer toutes les commandes nécessaire, il faut configurer l'application, pour cela éditez le fichier `.env` et modifiez les éléments selon votre configuration, notamment les variables de DB, LDAP ainsi que les informations sur l'application tel que `APP_URL`.
+Avant de lancer toutes les commandes nécessaires, il faut configurer l'application. Pour cela renommez le fichier `.env.example` en `.env` et modifiez les éléments selon votre configuration, notamment les variables de DB, Firebase, LDAP ainsi que les informations sur l'application tel que `APP_URL`.
+
+#### Firebase (Optionnel)
+Pour la configuration de firebase, la documentation du plugin [laravel-firebase](https://github.com/kreait/laravel-firebase#configuration) doit être suivie.
+
+La configuration des paramètres se trouve directement depuis les paramètres du projet sur [Firebase](https://console.firebase.google.com/project/caravel-f05cb/).
+
+Le paramètre `FIREBASE_AUTHORIZATION_KEY` pour être récupéré dans l'onglet [Cloud Messaging](https://console.firebase.google.com/project/caravel-f05cb/settings/cloudmessaging).
+
+Pour les deux autres paramètres ils sont disponibles depuis l'onglet [Compte de service](https://console.firebase.google.com/project/caravel-f05cb/settings/serviceaccounts/adminsdk).
+
+#### DB
+Si vous utilisez MariaDB ou Mysql, la configuration issue du `.env.example` peut être laissée comme tel, il faudra simplement veiller à créer une database "caravel" et changer les logins si besoin.
 
 #### LDAP 
 Pour la partie LDAP, si vous ne disposez pas d'un LDAP, vous pouvez laissez la configuration par défaut et utilisez un LDAP de test 
@@ -58,8 +71,7 @@ Il faut donc éditer le fichier `config\auth.php` et adapter la ligne model
 ...
 ```
 
-Attention il ne faut pas oublier d'activer le module ldap dans le `php.ini` utilisé par votre système.
-
+Attention il ne faut pas oublier d'activer le module ldap dans le `php.ini` qui est utilisé par Laravel (un `where php` vous indiquera où se trouve l'exécutable, le `php.ini` est dans le même dossier).
 
 ### Installation
 Dans un premier temps il faut installer toutes les dépendances nécessaires au bon fonctionnement du backend avec composer
@@ -74,9 +86,9 @@ La base de donnée a besoin d'être nourrie pour les types de tâches, il faut d
 
 > php artisan db:seed --class=TaskTypeSeeder
 
-L'installation est terminée
+L'installation est terminée.
 
-pour vérifier que tout fonctionne, on peut lancer directement le serveur avec la commande 
+Pour vérifier que tout fonctionne, on peut lancer directement le serveur avec la commande 
 
 > php artisan serve
 
@@ -121,3 +133,8 @@ pour le backend
 Eventuellement si vous avez besoin d'un serveur LDAP il faut lancer 
 
 > docker run -d --rm -p 10389:10389 -p 10636:10636 rroemhild/test-openldap
+
+Si vous utilisez le OpenLDAP, les informations de connexion se trouvent sur le GitHub de l'[image](https://github.com/rroemhild/docker-test-openldap), elles sont donnés ici à titre indicatif :
+
+* mail : [email protected]
+* mot de pass : professor