diff options
author | Fabien MEURILLON <fabien@meurillon.org> | 2016-01-09 19:02:24 +0100 |
---|---|---|
committer | Fabien MEURILLON <fabien@meurillon.org> | 2016-01-10 15:01:20 +0100 |
commit | 8b909e7ea7773807fdcae6e1cc08b2e62084bfd9 (patch) | |
tree | bf542779791d5d90fe18a44d582fc02276cdf041 /docs/en/developer/docker.rst | |
parent | 1d41effebc613b91bb84404711fb555f050a1700 (diff) | |
download | wallabag-8b909e7ea7773807fdcae6e1cc08b2e62084bfd9.tar.gz wallabag-8b909e7ea7773807fdcae6e1cc08b2e62084bfd9.tar.zst wallabag-8b909e7ea7773807fdcae6e1cc08b2e62084bfd9.zip |
Add documentation to run docker-compose
Diffstat (limited to 'docs/en/developer/docker.rst')
-rw-r--r-- | docs/en/developer/docker.rst | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/en/developer/docker.rst b/docs/en/developer/docker.rst new file mode 100644 index 00000000..9ed9dde2 --- /dev/null +++ b/docs/en/developer/docker.rst | |||
@@ -0,0 +1,51 @@ | |||
1 | Run Wallabag in docker-compose | ||
2 | ============================== | ||
3 | |||
4 | In order to run your own development instance of wallabag, you may | ||
5 | want to use the pre-configured docker compose files. | ||
6 | |||
7 | Requirements | ||
8 | ------------ | ||
9 | |||
10 | Make sure to have `Docker | ||
11 | <https://docs.docker.com/installation/ubuntulinux/>`__ and `Docker | ||
12 | Compose <https://docs.docker.com/compose/install/>`__ availables on | ||
13 | your system and up to date. | ||
14 | |||
15 | Switch DBMS | ||
16 | ----------- | ||
17 | |||
18 | By default, Wallabag will start with a sqlite database. | ||
19 | Since Wallabag provide support for Postgresql and MySQL, docker | ||
20 | containers are also available for these ones. | ||
21 | |||
22 | In ``docker-compose.yml``, for the chosen DBMS uncomment : | ||
23 | |||
24 | - the container definition (``postgres`` or ``mariadb`` root level | ||
25 | block) | ||
26 | - the container link in the ``php`` container | ||
27 | - the container env file in the ``php`` container | ||
28 | |||
29 | In order to keep running Symfony commands on your host (such as | ||
30 | ``wallabag:install``), you also should : | ||
31 | |||
32 | - source the proper env files on your command line, so variables | ||
33 | like ``SYMFONY__ENV__DATABASE_HOST`` will exist. | ||
34 | - create a ``127.0.0.1 rdbms`` on your system ``hosts`` file | ||
35 | |||
36 | Run Wallabag | ||
37 | ------------ | ||
38 | |||
39 | #. Fork and clone the project | ||
40 | #. Edit ``app/config/parameters.yml`` to replace ``database_*`` | ||
41 | properties with commented ones (with values prefixed by ``env.``) | ||
42 | #. ``composer install`` the project dependencies | ||
43 | #. ``php app/console wallabag:install`` to create the schema | ||
44 | #. ``docker-compose up`` to run the containers | ||
45 | #. Finally, browse to http://localhost:8080/ to find your freshly | ||
46 | installed wallabag. | ||
47 | |||
48 | At various step, you'll probably run into UNIX permission problems, | ||
49 | bad paths in generated cache, etc… | ||
50 | Operations like removing cache files or changing files owners might | ||
51 | be frequently required, so don't be afraid ! | ||