Skip to content

Commit 9da99e7

Browse files
committed
Fixes #614 - Adjustments for docker installation
1 parent 53b2776 commit 9da99e7

File tree

2 files changed

+26
-20
lines changed

2 files changed

+26
-20
lines changed

install/docker-compose.rst

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Prerequisites
1919
* This documentation expects you already have a working
2020
`Docker Compose <https://docs.docker.com/compose/>`_ environment.
2121
* Make sure to have at least 4 GB of RAM to run the containers.
22-
* You should adjust your host's settings to run Elasticsearch properly:
22+
* Adjust your host's settings to run Elasticsearch properly:
2323

2424
.. code-block:: sh
2525
@@ -38,6 +38,9 @@ Step 1: Add Stack
3838
choose your target environment, select **Stacks** and
3939
choose **Add stack** as you can see in the screenshot below.
4040

41+
.. figure:: /images/install/docker-compose/portainer/portainer-stacks.png
42+
:alt: Screenshot showing portainer UI with stacks section and highlighted "Add stack" button
43+
4144
Step 2: Build From Repository
4245
Switch to **Repository** build method and provide the information below:
4346

@@ -46,25 +49,22 @@ Step 2: Build From Repository
4649
- **Repository reference**: ``refs/heads/master``
4750
- **Compose path**: ``docker-compose.yml`` (default)
4851

49-
If you want to customize the stack, read on in
50-
:ref:`the customization section <customizing-stack>` below.
52+
In some cases, our default environment is not what a Docker-Compose user is
53+
looking for. You can customize the stack using pre-defined scenarios and
54+
adjust environment variables. Jump to the
55+
:ref:`the customization section <customizing-stack>` below to find more
56+
information.
5157

52-
Zammad runs on port ``8080`` by default. If you want to use another port, you
53-
can set it via the variable ``NGINX_EXPOSE_PORT``.
58+
.. figure:: /images/install/docker-compose/portainer/portainer-stack-creation.png
59+
:alt: Screenshot showing stack creation with necessary information
5460

5561
Step 3: Deploy the Stack
62+
Finally, click the **Deploy the stack** button. The first time, it may take
63+
some time until the Docker images are fetched.
64+
5665
After the stack is ready, you can access Zammad via the configured docker
5766
host and port, e.g. ``http://localhost:8080/``.
5867

59-
.. figure:: /images/install/docker-compose/portainer/portainer-stacks.png
60-
:alt: Screenshot showing portainer UI with stacks section and highlighted "Add stack" button
61-
62-
In the **Stacks** section in Portainer select **Add stack**.
63-
64-
.. figure:: /images/install/docker-compose/portainer/portainer-stack-creation.png
65-
:alt: Screenshot showing stack creation with necessary information
66-
67-
Stack creation with provided information in **Repository** screen
6868

6969
Deployment with Docker-Compose
7070
------------------------------
@@ -85,17 +85,15 @@ Step 2: Adjust Environment as Needed
8585
:ref:`customization section <customizing-stack>` below to find more
8686
information.
8787

88-
Zammad runs on port ``8080`` by default. If you want to use another port, you
89-
can set it via the variable ``NGINX_EXPOSE_PORT``.
90-
9188
Step 3: Start the stack
9289
.. code-block:: sh
9390
9491
cd zammad-docker-compose
9592
docker compose up -d
9693
97-
Optional: Use an additional ``.yml`` file from the scenarios folder to
98-
apply one of the :doc:`pre-defined scenarios <docker-compose/docker-compose-scenarios>`.
94+
Optional: Use an additional ``.yml`` file to use a pre-defines scenario.
95+
Read on in the :ref:`Customizing the Zammad Stack <customizing-stack>`
96+
section.
9997

10098
After the stack is ready, you can access Zammad via the configured docker
10199
host and port, e.g. ``http://localhost:8080/``.

install/docker-compose/environment.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
Docker Environment Variables
22
****************************
33

4-
Zammad's docker stack supports these environment variables.
4+
Find the available docker environment variables below with default values, if
5+
applicable. You might also be interested in the
6+
:doc:`environment variables documentation </appendix/configure-env-vars>`.
7+
8+
.. hint::
9+
10+
If you want to use a ``.env`` file, you can use the provided ``.env.dist``
11+
file and copy it to ``.env``. That way it will be picked up by Docker-Compose
12+
automatically and not overwritten during updates.
513

614
Zammad
715
------

0 commit comments

Comments
 (0)