Skip to content

Commit 8774ec3

Browse files
committed
[TASK] Add section about docker compose
1 parent 83aa48b commit 8774ec3

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

Documentation/Howto/RenderingDocs/Watch.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,31 @@ you can create a bash alias like:
7676
You can do this by changing the :bash:`-p` parameter, e.g. to
7777
:bash:`-p 8080:1337` to use TCP port `8080` on your host system.
7878

79+
Docker compose
80+
==============
81+
82+
If you are using `docker-compose <https://docs.docker.com/compose/>`_ to manage your
83+
development environment, you can add a service for the live rendering like this:
84+
85+
.. code-block:: yaml
86+
:caption: docker-compose.yml
87+
88+
services:
89+
render-wysiwyg:
90+
restart: "no"
91+
image: ghcr.io/typo3-documentation/render-guides:latest
92+
ports:
93+
- "1337:1337"
94+
volumes:
95+
- ./Documentation:/project/Documentation
96+
- ./Documentation-GENERATED-temp:/project/Documentation-GENERATED-temp
97+
command: ["--config=Documentation", "--watch"]
98+
99+
.. info::
100+
101+
Render guides was never optimized for long running services. You might need
102+
to restart the container from time to time to free up resources.
103+
79104
Limitations
80105
===========
81106

0 commit comments

Comments
 (0)