Commit ca0688fb authored by Bertrand Gauthier's avatar Bertrand Gauthier
Browse files

Corrections suite aux tests à Toulon

parent 84d5ae9a
Loading
Loading
Loading
Loading
+3 −3
Changes for bin/database/build/sql/08_create_fixture.sql.dist: 3 added lines, 3 removed lines.
Original line number Diff line number Diff line
@@ -11,15 +11,15 @@ select nextval('individu_id_seq'),
       'Premier',
       'Premier',
       'François',
       'francois.premier@univ.fr',
       'francois.premier@{ETAB_DOMAINE}',
       'INCONNU::00012345',
       '00012345',
       1, 1, 1
;
insert into utilisateur (id, username, email, display_name, password, individu_id)
select nextval('utilisateur_id_seq'),
       'premierf@univ.fr', -- du genre EPPN (si shibboleth activé) ou supannAliasLogin (si LDAP activé)
       'francois.premier@univ.fr',
       'premierf@{ETAB_DOMAINE}', -- du genre EPPN (si shibboleth activé) ou supannAliasLogin (si LDAP activé)
       'francois.premier@{ETAB_DOMAINE}',
       'François PREMIER',
       'shib', -- 'shib' (si authentification shibboleth), ou 'ldap' (si auth LDAP), ou mdp bcrypté (si auth BDD locale)
       i.id
+2 −3
Changes for config/application.config.php: 2 added lines, 3 removed lines.
Original line number Diff line number Diff line
<?php

$env = getenv('APPLICATION_ENV') ?: 'production';

$modules = ['Zend\Cache',
$modules = [
    'Zend\Cache',
    'Zend\Filter',
    'Zend\Form',
    'Zend\Hydrator',
−9

File deleted.

+72 −12
Changes for doc/INSTALL.md: 72 added lines, 12 removed lines.
Original line number Diff line number Diff line
# Installation de SyGAL



## Création de la base de données

Reportez-vous au [README consacré à la création de la base de données](database/README.md).



## Installation 

Pour ce qui est de l'installation du serveur d'application, n'ayant pas à Caen les compétences 
@@ -14,6 +16,7 @@ un serveur *entièrement dédié à l'application*.
Si vous voulez déployer l'application avec Docker, faites-le à partir du `Dockerfile` présent et n'hésitez pas à 
proposer votre contribution pour améliorer cette doc d'install !


### Première obtention des sources de l'application

*NB : la procédure proposée ici part d'un serveur *Debian Stretch* tout nu et couvre l'installation de tous les packages 
@@ -33,6 +36,7 @@ git clone https://github.com/EsupPortail/sygal.git /app
Libre à vous une fois que tout fonctionne de changer d'emplacement et de modifier en conséquence les configs
nécessaires.*


### Configuration du serveur

Sur le serveur, récupérez le dépôt git de l'image Docker de SyGAL puis placez-vous dans le répertoire créé :
@@ -64,6 +68,17 @@ créés ou modifiés par le script `Dockerfile.sh` :
NB : Vérifiez dans le script `Dockerfile.sh` que vous venez de lancer mais normalement 
`APACHE_CONF_DIR=/etc/apache2` et `PHP_CONF_DIR=/etc/php/7.3`.

La variable `APPLICATION_ENV` déclarée dans la config Apache `${APACHE_CONF_DIR}/sites-available/app-ssl.conf` permet
de spécifier à l'application PHP dans quel "environnement de fonctionnemant" elle tourne.
Notamment, lorsque sa valeur est `development`, cela active l'affichage détaillé des erreurs rencontrées par SyGAL :
```apacheconf
<VirtualHost *:443>
     # ...
     SetEnv APPLICATION_ENV "development"
# ...
```


### 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 `2.1.5`
@@ -81,22 +96,41 @@ sur votre serveur :
git checkout --force 2.1.5 && bash install.sh
```


### Mode développement vs. production

Pour commencer, placez l'application en mode "développement" afin d'activer l'affichage détaillé des futures erreurs 
rencontrées. Pour cela placez-vous dans le répertoire des sources de l'application puis lancez la commande suivante :
```bash
vendor/bin/zf-development-mode enable
```

Lorsque l'application sera sur un serveur de production, il faudra penser à désactiver le mode "développement" :
```bash
vendor/bin/zf-development-mode disable
```


### Configuration du moteur PHP pour SyGAL

Si vous êtes sur un serveur de PROD, corrigez les lignes suivantes du fichier de config PHP 
`/etc/php/7.3/fpm/conf.d/90-app.ini` :

```
    display_errors = Off
    ...
    #...
    opcache.enable = 1
    ...
    #...
    xdebug.remote_enable = 0
```


### Fichiers de config de l'application

Placez-vous dans le répertoire de l'application puis descendez dans le répertoire `config/autoload/`.

Supprimez l'extension `.dist` des fichiers `local.php.dist` et `secret.local.php.dist`, ex :
Supprimez l'extension `.dist` des fichiers `local.php.dist` et `secret.local.php.dist`, et préfixez-les pour bien
signifier l'environnement de fonctionnement concerné (version de production, de test, de developement). 
Exemple :
```bash
APPLICATION_ENV="production"
cp -n local.php.dist        ${APPLICATION_ENV}.local.php 
@@ -105,7 +139,8 @@ cp -n secret.local.php.dist ${APPLICATION_ENV}.secret.local.php

Dans la suite, vous adapterez le contenu de ces fichiers à votre situation.

#### `unicaen-app.global.php`

#### Fichier `unicaen-app.global.php`

- Adaptez les URL des pages "Mentions légales" et "Informatique et liberté" pour votre établissement :

@@ -117,7 +152,7 @@ Dans la suite, vous adapterez le contenu de ces fichiers à votre situation.
            'informatiqueEtLibertes' => "http://www.unicaen.fr/acces-direct/informatique-et-libertes/",
```

#### `${APPLICATION_ENV}.local.php`
#### Fichier `${APPLICATION_ENV}.local.php`

- Adaptez le `'label'`, `'title'` et `'uri'` du lien mentionnant votre établissement dans le pied de page de 
  l'application :
@@ -146,7 +181,7 @@ Dans la suite, vous adapterez le contenu de ces fichiers à votre situation.
```
*NB : ce répertoire doit être autorisé en écriture à l'utilisateur `www-data` (ou équivalent).*

#### `${APPLICATION_ENV}.secret.local.php`
#### Fichier `${APPLICATION_ENV}.secret.local.php`

- Dans la config de connexion au WS suivante, `UCN` doit être remplacé par le code établissement choisi lors
de la création de votre établissement dans la base de données (dans le script [`07_init.sql`](database/sql/07_init.sql)) :
@@ -185,25 +220,45 @@ de la création de votre établissement dans la base de données (dans le script
                ],
```

- La config fournie permet de simuler l'authentification Shibboleth de l'utilisateur 'premierf@univ.fr' 
créé en base de données (dans le script [`08_create_fixture.sql`](database/sql/08_create_fixture.sql)) avec le rôle "Administrateur technique".
Cela permet d'accéder aux pages de gestion des droits d'accès.
- Les lignes de config suivantes permettent de simuler l'authentification Shibboleth d'un premier utilisateur
  'premierf@xxxxx.fr' créé en base de données avec le rôle "Administrateur technique" (par le script
  [`08_create_fixture.sql`](database/sql/08_create_fixture.sql)).
  Cela permet d'avoir un accès quasi omnipotent à l'application, notamment aux pages de gestion des droits d'accès.

```php
    'unicaen-auth' => [
        'shib' => [
            'simulate' => [
                'HTTP_EPPN'           => $eppn = 'premierf@univ.fr',
                'HTTP_EPPN'           => $eppn = 'premierf@domaine.fr',
                'HTTP_SUPANNEMPID'    => '00012345',
                'HTTP_DISPLAYNAME'    => $eppn,
                'HTTP_MAIL'           => $eppn,
                'HTTP_GIVENNAME'      => 'François',
                'HTTP_SN'             => 'Premier',
                'HTTP_SUPANNCIVILITE' => 'M.'
                'HTTP_SUPANNCIVILITE' => 'M.',
```

- Théoriquement, à ce stade l'application SyGAL devrait être accessible.

- Ajustez si besoin la config concernant l'envoi de mails et dans un premier temps activez la "redirection" de tous 
  les mails envoyés par l'application vers une ou plusieurs adresses existantes, exemple :
  
```php
    'unicaen-app' => [
        'mail' => [
            // ...
            'transport_options' => [
                'host' => 'smtp.domaine.fr',
                'port' => 25,
            ],
            'from' => 'ne-pas-repondre@domaine.fr',
            'redirect_to' => [
                'votre.email@domaine.fr',
            ],
            // ...
```



## Dans l'application SyGAL elle-même

@@ -211,6 +266,7 @@ Si vous n'avez rien changé à la config de l'application concernant Shibboleth
la page d'accueil de SyGAL sur "Connexion" puis sur "Fédération d'identité", vous devriez être dans la peau de 
François Premier, administrateur technique de test créé en base de données (dans le script [`07_init.sql`](database/sql/07_init.sql)).


### Droits d'accès

Dans l'application SyGAL, allez dans menu "Droits d'accès" > "Gestion des profils de rôle".
@@ -232,8 +288,10 @@ NB : "UCN" n'est qu'un exemple et pour vous ce sera le code établissement chois
de la création de votre établissement dans la base de données (dans le script [`07_init.sql`](database/sql/07_init.sql)) 



## Import de données


### Installation du web service

Vous devez à présent installer le web service d'import de données, 
@@ -241,6 +299,7 @@ reportez-vous au projet `sygal-import-ws`sur
[sur github.com/EsupPortail](https://github.com/EsupPortail/sygal-import-ws) ou sur 
[sur git.unicaen.fr](https://git.unicaen.fr/open-source/sygal-import-ws).


### Lancement de l'import seul

Il s'agit de l'interrogation du web service pour remplir les tables temporaires TMP_*.
@@ -269,6 +328,7 @@ Pour lancer l'interrogation du web service *puis* la synchronisation des tables
    
*NB : `UCN` doit être remplacé par le code établissement choisi lors de la création de votre établissement.*


### Programmation des tâches périodiques

Un certains nombres de tâches périodiques doivent être programmées sur le serveur. 
+6 −23
Changes for migration/README.md: 6 added lines, 23 removed lines.
Original line number Diff line number Diff line
@@ -27,7 +27,8 @@ ora2pg-image \
./export_schema.sh -c ./config/ora2pg.conf
```

Les scripts sont générés dans `${PWD}/migration/ora2pg/schema/`.
*Les scripts sont générés dans `${PWD}/migration/ora2pg/schema/`.*

Pour effacer les existants :
```bash
sudo rm -f \
@@ -125,6 +126,7 @@ PROFIL_PRIVILEGE,\
SOUTENANCE_CONFIGURATION,\
SOUTENANCE_ETAT,\
SOUTENANCE_QUALITE,\
TYPE_RAPPORT,\
TYPE_STRUCTURE,\
TYPE_VALIDATION,\
VERSION_FICHIER,\
@@ -139,12 +141,6 @@ sudo rm -rf migration/ora2pg/data/*



Vidage éventuel de la base PostgreSQL
-------------------------------------

**Si besoin**, le script `migration/pg_clean.sql` permet de vider entièrement la base de données PostgreSQL.


Import des objets et données dans la base PostgreSQL
----------------------------------------------------

@@ -156,9 +152,11 @@ PGDATABASE=sygal \
PGUSER=ad_sygal \
PGHOST=localhost \
PGPORT=5432 \
PGPASSWORD=MOT_DE_PASSE_PAR_DEFAUT
PGPASSWORD=azerty
```

**Si besoin**, utiliser le script `migration/pg_clean.sql` pour vider entièrement la base de données PostgreSQL.

2) Lancer l'import

```bash
@@ -197,21 +195,6 @@ psql -d ${PGDATABASE} -h ${PGHOST} -U ${PGUSER} -f /tmp/pg_after_import.sql
```


Collecte des scripts d'install
------------------------------

Lancer le script suivant :
```
bash ${PWD}/migration/bin/prepare_distrib_scripts.sh 
```

Les scripts sont générés dans `${PWD}/migration/distrib/`.

Ils complètent les scripts situés dans `${PWD}/doc/database/`.
```
cp -rv ${PWD}/migration/distrib/* ${PWD}/doc/database/
```


The end
-------
Loading