]> git.immae.eu Git - github/wallabag/wallabag.git/blame - docs/en/developer/docker.rst
Merge pull request #2968 from chrido/master
[github/wallabag/wallabag.git] / docs / en / developer / docker.rst
CommitLineData
29c9e8f1 1Run wallabag in docker-compose
8b909e7e
FM
2==============================
3
4In order to run your own development instance of wallabag, you may
5want to use the pre-configured docker compose files.
6
7Requirements
8------------
9
10Make sure to have `Docker
11<https://docs.docker.com/installation/ubuntulinux/>`__ and `Docker
12Compose <https://docs.docker.com/compose/install/>`__ availables on
13your system and up to date.
14
15Switch DBMS
16-----------
17
3495f78d 18By default, wallabag will start with a SQLite database.
29c9e8f1 19Since wallabag provides support for Postgresql and MySQL, docker
8b909e7e
FM
20containers are also available for these ones.
21
3495f78d 22In ``docker-compose.yml``, for the chosen DBMS uncomment:
8b909e7e
FM
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
29In order to keep running Symfony commands on your host (such as
3495f78d 30``wallabag:install``), you also should:
8b909e7e
FM
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
29c9e8f1 36Run wallabag
8b909e7e
FM
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
56f0150e 43#. ``php bin/console wallabag:install`` to create the schema
8b909e7e
FM
44#. ``docker-compose up`` to run the containers
45#. Finally, browse to http://localhost:8080/ to find your freshly
46 installed wallabag.
47
48At various step, you'll probably run into UNIX permission problems,
49bad paths in generated cache, etc…
50Operations like removing cache files or changing files owners might
51be frequently required, so don't be afraid !