Commit 6e2189a5 authored by Mikael Salson's avatar Mikael Salson
Browse files

INSTALLATION.md: Update with Docker

parent c557a292
# INSTALLATION D'ALECSIA
## Installation avec Docker
Ajoutez éventuellement des comptes et mots de passe dans le fichier
`docker/alecsia/conf/passwords.yml`. Ces comptes doivent soit correspondre à
des comptes enseignants (et doivent donc être présents dans le teacherbook qui
est initialisé avec le fichier SQL `docker/dump.sql`) soit correspondre à des
comptes étudiants (pour l'instant il n'y a pas la possibilité de les créer
automatiquement il faut les créer à la main une fois le teacherbook installé).
Éditez éventuellement les volumes pour les mettre à l'endroit qui vous
convient et faites en sorte que les répertoires de logs et d'upload soit
accessibles en écriture par tout le monde.
Une fois cette configuration faite on peut lancer les conteneurs en se rendant
dans le répertoire `docker`, puis :
```
docker-compose up -d
```
Then the Alecsia web application should be available at:
http://localhost:8080/alecsia/web/app_dev.php (with usernames/passwords as set
in `passwords.yml`.
The teacherbook (used by Alecsia) is accessible through: http://localhost:8080/teacherbook/ (for instance: http://localhost:8080/teacherbook/teacher/hopper should return the user Grace Hopper).
## Installation sans Docker
Télécharger Alecsia ne suffit pas : ce dossier n'est en effet pas fourni avec l'ensemble
des composants permettant de faire fonctionner l'application. Ces fichiers, les "vendors"
, sont des plug-ins qu'il ne serait pas judicieux d'inclure dans un dépôt git.
## Logiciels pré-requis
### Logiciels pré-requis
Par ailleurs Alecsia a certains pré-requis technologiques :
- PHP 5.5+. Alecsia ne fonctionne pas avec les versions récentes de PHP (par ex. PHP 7)
......@@ -20,7 +47,7 @@ Par ailleurs Alecsia a certains pré-requis technologiques :
Dans le cas où vous utilisez un système basé sur Debian/Ubuntu vous pouvez
essayer (à vos risques et périls) le script `server_install.sh`.
### Script d'installation du serveur
#### Script d'installation du serveur
Durant l'installation, il vous faudra rentrer un mot de passe pour
l'administrateur de la base de données. C'est celui-là qui vous sera utile
......@@ -28,7 +55,7 @@ pour que PhpMyAdmin puisse s'y connecter.
La connexion à PhpMyAdmin doit être possible depuis l'adresse `http://localhost/phpmyadmin`.
## Installation d'Alecsia
### Installation d'Alecsia
De plus, une phase de configuration est nécessaire pour faire fonctionner Alecsia.
Le présent document donne donc une marche à suivre afin de parvenir à obtenir une copie
......@@ -36,7 +63,7 @@ d'Alecsia exécutable sur votre machine.
Mettez-vous dans un répertoire de travail.
### Installation du teacherbook
#### Installation du teacherbook
Alecsia repose sur une liste des enseignants connus afin de savoir si la
personne qui vient de se connecter est enseignante ou étudiante.
......@@ -52,7 +79,7 @@ composer install
```
pour installer les composants nécessaires à l'application.
### Configurer le teacherbook
#### Configurer le teacherbook
Le fichier `config.php.example` contient un exemple de fichier de
configuration. Copiez-le et renommez-le en `config.php` et modifiez les
......@@ -67,9 +94,9 @@ Peuplez la base de données avec le fichier `dump.sql` (il est par exemple
possible d'importer des données SQL depuis PhpMyAdmin, sinon cela peut être
fait en ligne de commande).
### Se conecter à son teacherbook
#### Se conecter à son teacherbook
## I. TÉLÉCHARGEMENT DES VENDORS
### I. TÉLÉCHARGEMENT DES VENDORS
> Symfony utilise composer. Lancer 'composer install' à la racine.
Il téléchargera les vendors : cela devrait prendre quelques minutes.
......@@ -77,7 +104,7 @@ fait en ligne de commande).
> Vérifiez qu'un dossier "vendor" a été créé à la racine du dossier Alecsia.
## II. CONFIGURATION
### II. CONFIGURATION
> Tentez de lancer http://<chemin_vers_alecsia>/web/config.php
Ce fichier a pour but de tester si la configuration du serveur est correcte.
......@@ -103,7 +130,7 @@ fait en ligne de commande).
> Le répertoire où les travaux d'étudiants seront uploadés est déterminé par le chemin spécifié dans le fichier `app/config/parameters.yml` sous la variable `alecsia.upload_dir`. Ce répertoire doit être accessible en écriture par le serveur web.
## III. CRÉATION DE LA STRUCTURE DE BDD
### III. CRÉATION DE LA STRUCTURE DE BDD
> Exécutez 'app/console doctrine:schema:create'
Si tout se passe bien, la commande remplira la base de données avec les
......@@ -112,7 +139,7 @@ fait en ligne de commande).
> Si vous venez d'une précédente installation de Alecsia, il s'agira alors
de lancer 'app/console doctrine:schema:update'.
## IV. TEACHER BOOK
### IV. TEACHER BOOK
> Installer le teacher book (récupérer l'application sur le dépôt https://git.framasoft.org/mikaels/teacherbook)
......@@ -121,7 +148,7 @@ fait en ligne de commande).
> Modifier la valeur de la variable de configuration alecsia.lille1.teacherbook
dans le fichier parameters.yml
## V. PHPUNIT
### V. PHPUNIT
> Le lancement des tests unitaires nécessite l'installation de phpunit
......@@ -132,23 +159,23 @@ sudo pear install pear.phpunit.de/PHPUnit
> Ensuite on peut tranquillement faire à la racine un
phpunit -c app/
## VI. Déployer l'application
### VI. Déployer l'application
Il devrait être nécessaire de faire un :
```
app/console assets:install
```
## VII. ACCÉDER À L'APPLICATION
### VII. ACCÉDER À L'APPLICATION
Il suffit d'accéder au fichier `web/app.php` (pour la version production) ou à `web/app_dev.php` (pour la version développement).
Attention la version production nécessite l'accès au SSO/CAS de Lille 1 alors que pour la version développement l'authentification ne se fait que par un fichier (pour plus de détail voir la partie « Authentification ») du fichier [doc/dev.org](doc/dev.org).
## QUE FAIRE SI ALECSIA NE MARCHE PLUS APRES UN PULL
### QUE FAIRE SI ALECSIA NE MARCHE PLUS APRES UN PULL
> Lancez le script 'composer update'
## APRÈS UNE MISE À JOUR DE SYMFONY
### APRÈS UNE MISE À JOUR DE SYMFONY
```
php ./vendor/sensio/distribution-bundle/Sensio/Bundle/DistributionBundle/Resources/bin/build_bootstrap.php
......
Markdown is supported
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