Skip to content

Commit dd9c9f8

Browse files
authored
Merge pull request #1655 from wger-project/clarify-where-to-get-image-before-trying-to-run
put building/obtaining image instructions before trying to run it.
2 parents ef335dc + 875fe4b commit dd9c9f8

File tree

3 files changed

+21
-11
lines changed

3 files changed

+21
-11
lines changed

AUTHORS.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ Developers
7676
* Alexandra Rhodes - https://github.com/arhodes130
7777
* Jayanth Bontha - https://github.com/JayanthBontha
7878
* Ethan Winters - https://github.com/ebwinters
79+
* Dieter Plaetinck - https://github.com/Dieterbe
7980

8081
Translators
8182
-----------

extras/docker/development/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ RUN apt update \
3131

3232
# Build the necessary python wheels
3333
# Note that the --mount tmpfs is a workaround for https://github.com/rust-lang/cargo/issues/8719
34-
COPY requirements* .
34+
COPY requirements* ./
3535
RUN --mount=type=tmpfs,target=/root/.cargo \
3636
pip3 wheel --no-cache-dir --wheel-dir /wheels -r requirements_docker.txt
3737

extras/docker/development/README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,23 @@ it is self-contained).
1818

1919
A more comfortable development version is provided in the compose folder.
2020

21-
### 1 - Start the container
21+
### 1 - Installing docker
22+
23+
Install docker, and the docker buildx tool (if they are separate packages on your system, e.g. on Arch Linux)
24+
25+
### 2 - Obtaining/building the docker image
26+
27+
We will run the `wger/server:latest` image in the next step.
28+
29+
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.
30+
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)
31+
32+
Alternatively, you can build it yourself from your wger code checkout.
33+
To do this, you **must** build from the project root!
34+
35+
```docker build -f extras/docker/development/Dockerfile --tag wger/server .```
36+
37+
### 3 - Start the container
2238

2339
docker run -ti \
2440
-v /path/to/your/wger/checkout:/home/wger/src \
@@ -37,7 +53,7 @@ You might also want to download the exercise images and the ingredients
3753
docker exec wger.devel python3 manage.py download-exercise-images
3854
docker exec wger.devel wger load-online-fixtures
3955

40-
### 2 - Open the Application
56+
### 4 - Open the Application
4157

4258
Just open <http://localhost:8000> and log in as: **admin**, password **adminadmin**
4359

@@ -49,20 +65,13 @@ To start developing again:
4965

5066
```sudo docker container start --attach wger.devel```
5167

52-
### 3 - Other commands
68+
### 5 - Other commands
5369

5470
If you need to update the CSS/JS libraries or just issue some other command:
5571

5672
docker exec -ti wger.devel yarn
5773
docker exec -ti wger.devel /bin/bash
5874

59-
## Building
60-
61-
If you build this yourself, keep in mind that you **must** build from the
62-
project root!
63-
64-
```docker build -f extras/docker/development/Dockerfile --tag wger/server .```
65-
6675
## Contact
6776

6877
Feel free to contact us if you found this useful or if there was something that

0 commit comments

Comments
 (0)