From a26aadb983a613cd2654b5e156200fd0a203b319 Mon Sep 17 00:00:00 2001 From: Antoine Nguyen Date: Fri, 19 Oct 2018 10:03:41 +0200 Subject: [PATCH] Added documentation about docker image. --- doc/contributing/getting_started.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/contributing/getting_started.rst b/doc/contributing/getting_started.rst index c4325275a..7cfdaccba 100644 --- a/doc/contributing/getting_started.rst +++ b/doc/contributing/getting_started.rst @@ -5,6 +5,23 @@ Useful tips You would like to work on Modoboa but you don't know where to start? You're at the right place! Browse this page to learn useful tips. +Docker +====== + +A docker image is available for developers. To use it, you must +install `docker `_ and +`docker-compose `_ first. + +Then, just run the following command:: + + $ docker-compose up + +It will start the docker environment and make a Modoboa instance +available at ``http://localhost:8000``. + +If you don't want to use docker or need a more complex development +setup, go to the next section. + .. _venv_for_dev: Prepare a virtual environment