Skip to content

Commit 116c97e

Browse files
committed
Moved how to down; small tweaks
1 parent e653bda commit 116c97e

File tree

1 file changed

+31
-26
lines changed

1 file changed

+31
-26
lines changed

appendix/environment-variables.rst

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
Environment Variables
22
=====================
33

4-
Find the available environment variables below with default values, if
5-
applicable. The variables for docker and package based installations might be
6-
different in some cases. You can find a hint in the tables below with the
4+
Find the most important environment variables below with default values, if
5+
applicable. The variables for docker and package based installations can be
6+
different in some cases. You can find a badge in the tables below with the
77
following meaning:
88

99
- |docker| => Only available for docker installations
@@ -14,29 +14,8 @@ For easy copy/pasting of variables, please have a look at the
1414
`.env.dist file for docker in Github <https://github.com/zammad/zammad-docker-compose/blob/master/.env.dist>`_
1515
or go to the section at the end of the page for a
1616
:ref:`collection of package installation variables <collection-package-variables>`.
17-
18-
.. note:: **How to set an environment variable?**
19-
20-
It depends on how you installed Zammad (package, docker).
21-
Either set it via ``zammad config`` command as you can see below, use your
22-
system's way of setting variables via command line
23-
(e.g. ``export VARIABLE=value)``, place an ``.env`` file in the directory or
24-
even use a GUI like Portainer to define them for a docker installation.
25-
26-
Example for package installations:
27-
28-
.. code-block:: sh
29-
30-
# set OPTION to "value"
31-
$ zammad config:set OPTION=value
32-
$ systemctl restart zammad
33-
34-
# get OPTION
35-
$ zammad config:get OPTION
36-
37-
# unset OPTION
38-
$ zammad config:unset OPTION
39-
$ systemctl restart zammad
17+
If you want to know how to set these variables, have a look at
18+
:ref:`how-to-env-var`.
4019

4120
.. hint::
4221

@@ -319,6 +298,32 @@ Nginx
319298
:height: 24px
320299
:width: 24px
321300

301+
.. _how-to-env-var:
302+
303+
How to Set Environment Variables
304+
--------------------------------
305+
306+
It depends on how you installed Zammad (package, docker).
307+
Either set it via ``zammad config`` command as you can see below, use your
308+
system's way of setting variables via command line
309+
(e.g. ``export VARIABLE=value)``, place an ``.env`` file in the directory or
310+
even use a GUI like Portainer to define them for a docker installation.
311+
312+
Example for package installations:
313+
314+
.. code-block:: sh
315+
316+
# set OPTION to "value"
317+
$ zammad config:set OPTION=value
318+
$ systemctl restart zammad
319+
320+
# get OPTION
321+
$ zammad config:get OPTION
322+
323+
# unset OPTION
324+
$ zammad config:unset OPTION
325+
$ systemctl restart zammad
326+
322327
.. _collection-package-variables:
323328

324329
Collection for Package Installation

0 commit comments

Comments
 (0)