Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Add README to docker-compose folder

Roland Geider5f8b20e4dd7d
diff --git a/extras/docker/apache/Dockerfile b/extras/docker/apache/Dockerfile
index 646bc0c82..1aaeffc0b 100644
--- a/extras/docker/apache/Dockerfile
+++ b/extras/docker/apache/Dockerfile
@@ -30,7 +30,7 @@ RUN apt-get update \
&& rm -rf /var/lib/apt/lists/*
# Set up the application
-COPY . .
+COPY requirements* ./
RUN pip3 wheel --no-cache-dir --wheel-dir /usr/src/app/wheels -r requirements_devel.txt
diff --git a/extras/docker/apache/venvwrapper b/extras/docker/apache/venvwrapper
index be9737069..749f6c7bc 100644
--- a/extras/docker/apache/venvwrapper
+++ b/extras/docker/apache/venvwrapper
@@ -1,4 +1,5 @@
-#!/bin/sh
+#!/bin/bash
+
. /home/wger/venv/bin/activate
python /home/wger/src/manage.py "$@"
diff --git a/extras/docker/compose/README b/extras/docker/compose/README
deleted file mode 100644
index a4ecd765e..000000000
--- a/extras/docker/compose/README
+++ /dev/null
@@ -1 +0,0 @@
-http://capside.com/labs/deploying-full-django-stack-with-docker-compose/
diff --git a/extras/docker/compose/README.md b/extras/docker/compose/README.md
new file mode 100644
index 000000000..551e2dd61
--- /dev/null
+++ b/extras/docker/compose/README.md
@@ -0,0 +1,92 @@
+# Development image for wger
+
+Thank you for downloading wger Workout Manager. wger (ˈvɛɡɐ) is a free, open
+source web application that manages your exercises and personal workouts, weight
+and diet plans. It can also be used as a simple gym management utility, providing
+different administrative roles (trainer, manager, etc.). It offers a REST API
+as well, for easy integration with other projects and tools.
+
+
+## Usage
+
+This docker-compose file starts up a development environment with django's
+development server, postgres as a database and redis for caching and saving
+the sessions. It binds your current code checkout into the volume, if you
+don't want or have one, use the wger/apache image, it is self-contained.
+
+### 1 - Start all services
+
+To start all services:
+
+ docker-compose -f extras/docker/compose/docker-compose.yml up
+
+Then open <http://localhost:8000> and log in as: **admin**, password **admin**
+
+
+### 2 - Lifecycle Management
+
+To stop all services issue a stop command, this will preserve all containers
+and volumes:
+
+ docker-compose -f extras/docker/compose/docker-compose.yml stop
+
+To start everything up again:
+
+ docker-compose -f extras/docker/compose/docker-compose.yml start
+
+To remove all containers (except for the postgres volume)
+
+ docker-compose -f extras/docker/compose/docker-compose.yml down
+
+To view the application's log:
+
+ docker-compose -f extras/docker/compose/docker-compose.yml logs -f
+
+### 2 - Other commands
+
+You might need to issue other commands or do other manual work in the container,
+e.g.
+
+ docker-compose -f extras/docker/compose/docker-compose.yml exec web python3 manage.py bower install
+ docker-compose -f extras/docker/compose/docker-compose.yml exec web /bin/bash
+
+
+## Building
+
+If you want to build this yourself, keep in mind that you **must** build from the
+project root. Make sure the wger/devel image is available locally as well:
+
+ docker-compose -f extras/docker/compose/docker-compose.yml build.
+
+
+## Contact
+
+Feel free to contact us if you found this useful or if there was something that
+didn't behave as you expected. We can't fix what we don't know about, so please
+report liberally. If you're not sure if something is a bug or not, feel free to
+file a bug anyway.
+
+* gitter: <https://gitter.im/wger-project/wger>
+* issue tracker: <https://github.com/wger-project/wger/issues>
+* twitter: <https://twitter.com/wger_de>
+* mailing list: <https://groups.google.com/group/wger> / [email protected], no registration needed
+
+## Sources
+
+All the code and the content is freely available:
+
+* Main repository: <https://github.com/wger-project/wger>
+
+## Licence
+
+The application is licenced under the Affero GNU General Public License 3 or
+later (AGPL 3+).
+
+The initial exercise and ingredient data is licensed additionally under one of
+the Creative Commons licenses, see the individual exercises for more details.
+
+The documentation is released under a CC-BY-SA either version 4 of the License,
+or (at your option) any later version.
+
+Some images where taken from Wikipedia, see the SOURCES file in their respective
+folders for more details.
diff --git a/extras/docker/development/README.md b/extras/docker/development/README.md
index 535461c4e..569787ed6 100644
--- a/extras/docker/development/README.md
+++ b/extras/docker/development/README.md
@@ -30,7 +30,7 @@ use the more verbose mount instead:
### 2 - Download additional files
On the first run, you need to download some CSS and JS files with bower (
-as well as everytime there are updates):
+as well as every time there are updates):
docker exec -ti wger.devel python3 manage.py bower install