Commit 4c203646 authored by Bertrand Gauthier's avatar Bertrand Gauthier
Browse files

Documentation : amélioration de la doc d'installation.

parent a4cd5063

CHANGELOG.md

+1 −0
Changes for CHANGELOG.md: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
@@ -5,6 +5,7 @@ Journal des modifications 
-----

- Module Step-Star > Ligne de commande : améliorations des logs (affichage des critères appliqués, notamment) ; factorisation.

- Module Step-Star : suppression du paramètre de config 'clean_after_work', remplacé par un paramètre de ligne de commande ou de formulaire.

- Documentation : amélioration de la doc d'installation.



8.2.0

-----

doc/INSTALL.md

+20 −20
Changes for doc/INSTALL.md: 20 added lines, 20 removed lines.
Original line number Diff line number Diff line
@@ -36,6 +36,21 @@ git clone https://github.com/EsupPortail/sygal.git /app 
Si vous êtes à l'aise, libre à vous une fois que tout fonctionne de changer d'emplacement et de modifier en conséquence

les configs nécessaires sur le serveur.*



Normalement, vous ne devez installer que les versions officielles, c'est à dire les versions taguées, du genre `8.2.0`

par exemple.



Placez-vous dans le répertoire des sources de l'application puis lancez les commandes suivantes pour obtenir la liste des

versions officielles (taguées) :

```bash

git fetch && git fetch --tags && git tag

```



Si la version la plus récente est par exemple la `8.2.0`, utilisez les commandes suivantes pour "installer" cette version

sur votre serveur :

```bash

git checkout --force 8.2.0

```





### Configuration du serveur
@@ -44,8 +59,11 @@ les configs nécessaires sur le serveur.* 
- Vous trouverez dans le répertoire des sources d'ESUP-SyGAL récupérées à l'instant un script `Dockerfile.sh`, 

  sorte de version sh du Dockerfile, contenant de quoi mettre à niveau et/ou installer les packages nécessaires.



- Plutôt que de le lancer d'un seul bloc, ouvrez-le dans un autre terminal pour le visualiser, ce qui vous permettra 

  de copier-coller-lancer les commandes qu'il contient par petits groupes.

- Vous ne devez pas le lancer d'un seul bloc, ouvrez-le dans un autre terminal pour l'avoir sous la main.



- Lisez et appliquez les pré-requis mentionnés dans les commentaires en entête du script.



- Copiez-collez-lancez les commandes qu'il contient par petits groupes.



- Ensuite, si vous maîtrisez les impacts, vérifiez et ajustez éventuellement sur votre serveur les fichiers 

  de configs suivants (créés/modifiés par le script) :
@@ -80,24 +98,6 @@ error_log = /var/log/php-fpm.log 
```





### Installation d'une version précise de l'application



Normalement, vous ne devez installer que les versions officielles, c'est à dire les versions taguées, du genre `8.1.0`

par exemple.



Placez-vous dans le répertoire des sources de l'application puis lancez les commandes suivantes pour obtenir la liste des

versions officielles (taguées) :

```bash

git fetch && git fetch --tags && git tag

```



Si la version la plus récente est par exemple la `8.1.0`, utilisez les commandes suivantes pour "installer" cette version 

sur votre serveur :

```bash

git checkout --force 8.1.0

```





### Mode développement vs. production



Pour commencer, placez l'application en mode "développement" afin d'activer l'affichage détaillé des futures erreurs