From 150e1938856ca8b69dea1b1198d14f5d7b6883aa Mon Sep 17 00:00:00 2001 From: William Petit Date: Fri, 24 Aug 2018 12:31:17 +0200 Subject: [PATCH] Ajout d'un README --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6bc02c3 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# JupyterHub + +Environnement "JupyterHub" dans Docker Compose dédié à la diffusion de cours interactifs. + +## Principes + +- Le compte "tuteur" a un répertoire `lessons` dans lequel il peut diffuser ses cours. +- Les comptes "étudiant" ont chacun un espaces personnel avec un accès en lecture seul au répertoire `lessons` du compte "tuteur". +- Les étudiants n'ont pas accès aux répertoires des autres étudiants. +- Le compte "tuteur" a accès à l'ensemble des espaces personnels des comptes "étudiant" via le répertoire `./students`. + +## Méthodologie proposée + +1. Le tuteur diffuse son cours dans le répertoire `lessons`. +2. Chaque étudiant copie ce cours dans son propre espace personnel afin de réaliser les exercices proposés. +3. Le tuteur peut valider/venir en aide à l'étudiant via son accès au répertoire personnel de celui ci. + +## Démarrage + +```bash + +# Définition du compte "tuteur" et de son mot de passe +echo TUTOR_USERNAME="" > .env +echo TUTOR_PASSWORD="" >> .env + +# Construction de l'environnement Compose +docker-compose build + +# Démarrage de JupyterHub +docker-compose up + +``` + +Puis ouvrir son navigateur à l'adresse `http://localhost:8000` et se connecter +avec les identifiants présents dans le fichier `.env` renseignés précédemment. + +Les données sont sauvegardées dans le répertoire `./data`. + +## Créer un nouveau compte étudiant + +```bash +docker-compose exec hub create-hub-student "" +``` +Un message du type `Student 'student1' created. Its password is '3iHjqPliT6'.` devrait s'afficher. + +L'étudiant pourra alors s'authentifier avec ces identifiants. +