From a7146a5991ad336e36cc32fd6009a620193b05fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Wed, 9 Sep 2015 11:53:54 +0200 Subject: [PATCH] add very quick start with docker instruction --- source/installation/index.rst | 27 +++++++- .../very_quick_start_with_docker.rst | 63 +++++++++++++++++++ 2 files changed, 88 insertions(+), 2 deletions(-) create mode 100644 source/installation/very_quick_start_with_docker.rst diff --git a/source/installation/index.rst b/source/installation/index.rst index 260b3e845..d869f22c8 100644 --- a/source/installation/index.rst +++ b/source/installation/index.rst @@ -11,18 +11,41 @@ A copy of the license is included in the section entitled "GNU Free Documentation License". -Instructions about installation +Installation ############################### -You will learn here : +Very quick install with docker +================================= .. toctree:: :maxdepth: 2 + Very quick install with docker + +Usage in production +==================== + +.. toctree:: + :maxdepth: 2 + How to install the software + +Update Chill and maintenance +============================== + +.. toctree:: + :titlesonly: + Update Chill Add bundles to your installation Uninstall Chill + +Database preparation +===================== + +.. toctree:: + :titlesonly: + Install a PosgresSql server Install production webserver diff --git a/source/installation/very_quick_start_with_docker.rst b/source/installation/very_quick_start_with_docker.rst new file mode 100644 index 000000000..5f65abe09 --- /dev/null +++ b/source/installation/very_quick_start_with_docker.rst @@ -0,0 +1,63 @@ +.. Copyright (C) 2014 Champs Libres Cooperative SCRLFS + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.3 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. + A copy of the license is included in the section entitled "GNU + Free Documentation License". + +Very quick start with docker +############################# + + +.. _quick-start-with-docker: + +We have created a `docker container `_ to let you test `Chill` easily. + +.. note:: + + We assume docker is already installed on your machine. If Docker is not installed, have a look at `the install page in the docker documentation `. + +Starting the containers +======================== + +Prepare a database: + +.. code-block:: bash + + docker run --rm --name=chill_database chill/database + +The first time you will run this command, the image will be downloaded from docker registry. Please be patient. + +Run the container containing the code and attach it to the database : + +.. code-block:: bash + + docker run --rm --link chill_database:db -p 8989:8000 --name=chill_php chill/demo-flavor + +The image will also be downloaded from docker registry on first run. + +You can then browse on `http://localhost:8989 `_ and login with the created users, like `center a_social`. + +Stopping the containers +======================= + +.. code-block:: bash + + docker stop chill_php + docker stop chill_database + +Limitations +============ + +* Those container should not be used in production +* The database should not be persisted or store persistant information: at each container startup, the container's data will be erased and replaced by new (partially) random fixtures + + +.. _the composer documentation: https://getcomposer.org/doc/ +.. _the composer introduction: https://getcomposer.org/doc/00-intro.md +.. _the standard architecture: https://github.com/Champs-Libres/chill-standard +.. _composer: https://getcomposer.org +.. _Firefox: https://www.mozilla.org +.. _symfony framework: http://symfony.com +.. _*unaccent* extension: http://www.postgresql.org/docs/current/static/unaccent.html