Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Add README files for docker

Roland Geider64cb100428c3
diff --git a/extras/docker/apache/README.md b/extras/docker/apache/README.md
new file mode 100644
index 000000000..f9dbc43f4
--- /dev/null
+++ b/extras/docker/apache/README.md
@@ -0,0 +1,56 @@
+
+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.
+
+It is written with python/django and uses jQuery and some D3js for charts.
+
+Installation
+============
+
+This docker image contains an instance of the application running as a WSGI
+process under apache with a sqlite database. It is useful to just try it out and
+play around. To start it:
+
+
+```docker run -ti --name wger.apache --publish 8000:80 wger/apache```
+
+Then just open http://localhost:8000 and log in as: **admin**, password **admin**
+
+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.
+
+ twitter: https://twitter.com/wger_de
+ mailing list: https://groups.google.com/group/wger / [email protected], no registration needed
+ IRC: channel #wger on freenode.net, webchat: http://webchat.freenode.net/?channels=wger
+ issue tracker: https://github.com/rolandgeider/wger/issues
+
+Sources
+=======
+
+All the code and the content is freely available:
+
+ Main repository: https://github.com/rolandgeider/wger
+ Mirror: https://bitbucket.org/rolandgeider/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
new file mode 100644
index 000000000..89eeae6cd
--- /dev/null
+++ b/extras/docker/development/README.md
@@ -0,0 +1,63 @@
+
+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.
+
+It is written with python/django and uses jQuery and some D3js for charts.
+
+Installation
+============
+
+This docker image contains an instance of the application running with django's
+development server using a sqlite database. It can be used to quickly setup a
+development instance:
+
+```docker run -ti --name wger.devel --publish 8000:8000 wger/devel```
+
+Then, *within the docker image*, activate the virtualenv
+
+```source ~/venv/bin/activate```
+
+and start the development server
+
+```python manage.py runserver 0.0.0.0:8000```
+
+Then just open http://localhost:8000 and log in as: **admin**, password **admin**
+
+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.
+
+ twitter: https://twitter.com/wger_de
+ mailing list: https://groups.google.com/group/wger / [email protected], no registration needed
+ IRC: channel #wger on freenode.net, webchat: http://webchat.freenode.net/?channels=wger
+ issue tracker: https://github.com/rolandgeider/wger/issues
+
+Sources
+=======
+
+All the code and the content is freely available:
+
+ Main repository: https://github.com/rolandgeider/wger
+ Mirror: https://bitbucket.org/rolandgeider/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.