From f1a8754e4159badb8321d5d50770810d676824fd Mon Sep 17 00:00:00 2001 From: Steve Mendes Reis Date: Thu, 29 Jul 2021 18:24:00 +0200 Subject: [PATCH] update guide --- docs/userguide.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/docs/userguide.md b/docs/userguide.md index 1ba8e54..827793e 100644 --- a/docs/userguide.md +++ b/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 : professor@planetexpress.com +* mot de pass : professor