diff --git a/docs/ConseilServeurDev.md b/docs/ConseilServeurDev.md index 06d9452cb..a54b09301 100644 --- a/docs/ConseilServeurDev.md +++ b/docs/ConseilServeurDev.md @@ -7,7 +7,7 @@ Commencez par lire ## Machine virtuelle -Il est confortable de développer dans une VM (un [container Docker](Docker.md) ferait +Il est confortable de développer dans une VM (un [container Docker](Docker.md#developpement) ferait aussi bien l'affaire). ### Conseils pour la machine virtuelle diff --git a/docs/Docker.md b/docs/Docker.md index a9e346ad0..df5b95bfd 100644 --- a/docs/Docker.md +++ b/docs/Docker.md @@ -75,3 +75,61 @@ Une image [`scodoc/scodoc`](https://hub.docker.com/r/scodoc/scodoc) est publiée --build-arg="IMAGE_DATE=$(date -u +\"%Y-%m-%dT%H:%M:%SZ\")" \ . ``` + +## Développement + +Editez le fichier [`docker-compose.yml`](https://git.scodoc.org/ScoDoc/ScoDoc/src/branch/master/docker-compose.yml) pour que le container scodoc démarre en mode développement : + +```diff + scodoc: + image: scodoc/scodoc ++ entrypoint: tail -f /dev/null + environment: ++ FLASK_ENV: development + [...] + ports: + - "127.0.0.1:8000:8000" ++ - "127.0.0.1:2222:22" +``` + +Démarrez les containers et ouvrez un shell dans le container scodoc : +```bash +docker compose up -d +docker exec -it scodoc bash +``` +Puis remplacer /opt/scodoc par un clone du git : +```bash +apt-get update +apt-get install git +mv /opt/scodoc /opt/off-scodoc +git clone https://git.scodoc.org/ScoDoc/ScoDoc.git /opt/scodoc +# (ou bien utiliser votre clone gitea si vous l'avez déjà créé !) + +# Donner ce répertoire à l'utilisateur scodoc: +chown -R scodoc:scodoc /opt/scodoc +``` +Il faut ensuite installer l'environnement et le fichier de configuration : +```bash +# Le plus simple est de piquer le virtualenv configuré par l'installeur : +mv /opt/off-scodoc/venv /opt/scodoc +``` +Et la config: +```bash +ln -s /opt/scodoc-data/.env /opt/scodoc +``` +Et enfin démarrer ssh pour pouvoir se connecter avec un IDE : +```bash +# Définir un mot de passe à l'utilisateur scodoc pour la connexion ssh +passwd scodoc + +# Installer et démarrer le serveur ssh +apt-get install openssh-server +service ssh start +``` +Vous pouvez maintenant vous connecter sur votre IDE avec `ssh scodoc@127.0.0.1 -p 2222 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null` et le mot de passe défini précédemment. + +Pour démarrer ScoDoc, en tant que root depuis le shell docker exec, il suffit de lancer : +```bash +/opt/scodoc/tools/docker-entrypoint.sh +``` +ScoDoc sera accessible sur http://127.0.0.1:8000/. Utilisez `Ctrl+C` pour l'arrêter.