From 518bed504622ed745155373cce146944f834e3c9 Mon Sep 17 00:00:00 2001 From: Dieter Plaetinck Date: Sat, 4 May 2024 18:42:13 +0200 Subject: [PATCH] put building/obtaining image instructions before trying to run it. --- AUTHORS.rst | 1 + extras/docker/development/README.md | 25 +++++++++++++++---------- 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/AUTHORS.rst b/AUTHORS.rst index fc437ed7f1..02dfe98e12 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -76,6 +76,7 @@ Developers * Alexandra Rhodes - https://github.com/arhodes130 * Jayanth Bontha - https://github.com/JayanthBontha * Ethan Winters - https://github.com/ebwinters +* Dieter Plaetinck - https://github.com/Dieterbe Translators ----------- diff --git a/extras/docker/development/README.md b/extras/docker/development/README.md index cdb7c1d713..1b1536dfbe 100644 --- a/extras/docker/development/README.md +++ b/extras/docker/development/README.md @@ -18,7 +18,19 @@ it is self-contained). A more comfortable development version is provided in the compose folder. -### 1 - Start the container +### Obtaining/building the docker image + +We will run the `wger/server:latest` image in the next step. + +You can either download it from [dockerhub](https://hub.docker.com/r/wger/server); docker will do this automatically if you have no such image with that tag yet. +You can also run `docker pull wger/server` to get the latest version. (you can use `docker images` to see if your image is old) + +Alternatively, you can build it yourself from your wger code checkout. +To do this, you **must** build from the project root! + +```docker build -f extras/docker/development/Dockerfile --tag wger/server .``` + +### 2 - Start the container docker run -ti \ -v /path/to/your/wger/checkout:/home/wger/src \ @@ -37,7 +49,7 @@ You might also want to download the exercise images and the ingredients docker exec wger.devel python3 manage.py download-exercise-images docker exec wger.devel wger load-online-fixtures -### 2 - Open the Application +### 3 - Open the Application Just open and log in as: **admin**, password **adminadmin** @@ -49,20 +61,13 @@ To start developing again: ```sudo docker container start --attach wger.devel``` -### 3 - Other commands +### 4 - Other commands If you need to update the CSS/JS libraries or just issue some other command: docker exec -ti wger.devel yarn docker exec -ti wger.devel /bin/bash -## Building - -If you build this yourself, keep in mind that you **must** build from the -project root! - -```docker build -f extras/docker/development/Dockerfile --tag wger/server .``` - ## Contact Feel free to contact us if you found this useful or if there was something that