Commit 9409d60f authored by Bertrand Gauthier's avatar Bertrand Gauthier
Browse files

Correction doc d'installation ; suppression de la doc qui doit rester dans le wiki gitlab

parent faa4406c
......@@ -18,40 +18,54 @@ et les met à disposition pour leur lecture via des requêtes GET.
### Obtention des sources
La première fois que vous installez le ws, vous devez lancer la commande suivante :
```bash
$ git clone git@git.unicaen.fr:dsi/sygal-import-ws.git
$ cd sygal-import-ws
```
### Installation des dépendances
Lancer la commande suivante pour obtenir la liste des versions disponibles du ws.
```bash
$ git fetch && git fetch --tags && git tag
```
Une fois les sources obtenues, il faut installer les packages requis par le ws.
Et si la version la plus récente est par exemple la `1.0`, utilisez la commande suivante pour "basculer" sur cette version :
```bash
$ git checkout 1.0
```
Cette installation se fait via *composer* (https://getcomposer.org/) :
### Installation des dépendances
Installez les packages requis par le ws via *composer* (https://getcomposer.org/) comme ceci :
```bash
$ composer install
```
### Création du fichier "users.htpasswd"
### Fichier "users.htpasswd"
Ce fichier contient les utilisateurs/mot de passe autorisés à appeler le ws.
Se placer dans le répertoire **config** des sources et lancer la commande suivante pour créer le fichier "users.htpasswd"
contenant un utilisateur `sygal-app` dont le mot de passe va vous être demandé :
S'il s'agit d'une mise à jour du ws, vous avez déjà fait la manip, inutile de lire ce paragraphe.
S'il s'agit de la première installation du ws, placez-vous dans le répertoire `config` des sources et lancer la
commande suivante pour créer le fichier "users.htpasswd" contenant un utilisateur `sygal-app` dont le mot de passe
va vous être demandé :
```bash
$ htpasswd -c users.htpasswd sygal-app
```
Si vous manquez d'idée pour le mot de passe, utilsez la commande suivante :
```bash
$ pwgen 16 1 --symbols --secure
```
### Complétion des fichiers de config
### Fichiers de config
S'il s'agit d'une mise à jour du ws, vous avez déjà fait la manip, inutile de lire ce paragraphe.
Deux fichiers situés dans le répertoire **config** ont besoin d'être complétés puis renommés :
S'il s'agit de la première installation du ws, 2 fichiers situés dans le répertoire `config/autoload` ont besoin d'être
complétés puis renommés :
- **local.php.dist** : qui est notamment utilisé pour l'authentification.
- clé `htpasswd` qui désigne le chemin du fichier "users.htpasswd" évoqué plus haut
......@@ -60,21 +74,18 @@ Deux fichiers situés dans le répertoire **config** ont besoin d'être complét
Une fois ces fichiers complétés, changer leur extension `.php.dist` en `.php`.
### Activer/désactiver le mode développement
### Interface d'admin Apigility
Passer en mode développement ouvre l'accès à l'interface de modification du ws.
Cette fonctionnalité est réservée aux développeurs du ws.
Attention: Le mode développement est **INTERDIT EN PRODUCTION**.
Pour activer/désactiver le mode développement :
Passer en mode développement ouvre l'accès à l'interface Apigility de modification du ws.
Cette fonctionnalité est réservée aux développeurs du ws et est **INTERDIT EN PRODUCTION**.
Désactivez le mode développement ainsi :
```bash
$ composer development-enable
$ composer development-disable
```
## Lancement du web service *pour le dévelopement*
### Solution 1 : le serveur interne PHP
......@@ -109,13 +120,17 @@ Par exemple, `0.0.0.0:8080->8080/tcp` indique que le ws est accessible sur la ma
## Les services fournis
Chaque vue en base de données peut être interrogée via un service dédié :
* Acteur : localhost:8080/acteur
* Doctorant : localhost:8080/doctorant
* Individu : localhost:8080/individu
* Role : localhost:8080/role
* Source : localhost:8080/source
* These : localhost:8080/these
* Variable : localhost:8080/variable
* Acteur : localhost:8080/acteur
* Doctorant : localhost:8080/doctorant
* Individu : localhost:8080/individu
* Role : localhost:8080/role
* Source : localhost:8080/source
* These : localhost:8080/these
* Variable : localhost:8080/variable
* Structure : localhost:8080/structure
* Etablissement : localhost:8080/etablissement
* Ecole doctorale : localhost:8080/ecole-doctorale
* Unite de recherche : localhost:8080/unite-recherche
Exemple :
```bash
......
# Mise à jour du web service
Cette page explique la procédure d'installation d'une nouvelle version du web service (ws).
## Mise à jour des sources
- Sur le serveur où est installé le web service, placez-vous dans le répertoire du web service :
normalement, c'est "/var/www/html/sygal-import-ws/".
- Lancez la commande `git fetch && git fetch --tags && git tag` pour obtenir la liste des versions disponibles du ws.
- Si la version la plus récente est par exemple la `1.0`, lancez la commande `git checkout 1.0` pour "basculer" sur la version 1.0 du ws.
- Ouvrez le fichier README.md et suivez les instructions du paragraphe "Installation".
NB: n'activez pas le "mode développement".
## Configuration
Cf. `INSTALL.md` au paragraphe correspondant à la version choisie.
## Vues Oracle
Idem.
# Première installation du web service
Cette page présente la procédure à suivre pour installer le web service pour la première fois.
## A/ Préalables
- Rendez-vous à l'adresse https://git.unicaen.fr/dsi/sygal-import-ws.
- Connectez-vous via la fédération d'identité Renater.
Si vous n'accédez à rien, c'est que par défaut vous n'avez pas accès au projet "sygal-import-ws", il faut nous demander de vous habiliter sur le projet pour pouvoir continuer, envoyez-nous un mail...
## B/ Config serveur et sources du ws
- Installez une Debian Stretch + PHP7 + Apache comme base de départ.
- Installez les sources de l'appli :
- Créez une clé SSH sur le serveur : https://git.unicaen.fr/help/ssh/README
- Sur Gitlab, déclarez cette clé SSH dans les paramètres de votre compte : https://git.unicaen.fr/profile/keys
- Sur le serveur, placez-vous dans le répertoire `/var/www/html/`.
- Faites un `git clone git@git.unicaen.fr:dsi/sygal-import-ws.git`, ce qui va "installer" les sources du ws dans le répertoire "sygal-import-ws".
- Placez-vous dans le répertoire "/var/www/html/sygal-import-ws/".
- Lancez la commande `git fetch && git fetch --tags && git tag` pour obtenir la liste des versions disponibles du ws.
- Si la version la plus récente est par exemple la `1.0`, lancez la commande `git checkout 1.0` pour "basculer" sur la version 1.0 du ws.
- Ouvrez le fichier README.md et suivez les instructions du paragraphe "Installation".
NB: n'activez pas le "mode développement".
- Poursuivez l'installation du serveur :
- Même sans connaître Docker, le fichier `Dockerfile.php7.dev` fourni avec les sources est compréhensible et fournit toutes les étapes nécessaires pour atteindre la config parfaite!
Une remarque sur l'installation du package PHP Oracle OCI8 : vous aurez besoin des 3 fichiers `instantclient-*` situés dans le répertoire `docker/`.
- La config Apache pour le ws est dans le répertoire `docker/` : `apache-site.conf`, `apache-site-ssl.conf` et `apache-ports.conf`.
- La config PHP est aussi dans le répertoire `docker/` : `php.conf`.
## C/ Réseau
- Le ws doit écouter sur les port 8080 (en http) et 8443 (en https).
- Autoriser l'accès depuis l'extérieur sur ces ports (on vous dira notre IP de sortie si besoin).
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment