Skip to content

Commit 38a187b

Browse files
committed
Improved wording and placement, removed danger boxes
1 parent 42422a2 commit 38a187b

File tree

2 files changed

+20
-26
lines changed

2 files changed

+20
-26
lines changed

appendix/configure-env-vars.rst

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -113,11 +113,15 @@ ZAMMAD_WEBSOCKET_PORT
113113
Default: ``6042``
114114

115115
RAILS_TRUSTED_PROXIES
116-
By default, Zammad trusts localhost proxies only. Set IP addresses or host
117-
names of your existing reverse proxies. Host names are resolved during the
118-
start of Zammad. A change of the host name requires a restart of Zammad.
116+
This setting is important for the correct detection of client IP addresses
117+
and features based on it, like rate limiting.
119118

120-
Default: ``['127.0.0.1', '::1']``
119+
By default, Zammad trusts localhost proxies only. Any additional proxy servers
120+
will have to be added here, by IP address (if static) or by host name.
121+
Host names are resolved during the start of Zammad, so that a restart is required
122+
whenever the IP address of a proxy server changes.
123+
124+
Default: ``127.0.0.1,::1``
121125

122126
.. _performance_tuning:
123127

@@ -174,14 +178,6 @@ ZAMMAD_PROCESS_SCHEDULED_JOBS_WORKERS
174178
| Default: **unset**
175179
| Maximum number of workers: ``1``
176180
177-
.. danger::
178-
179-
Disable processing of scheduled jobs by setting
180-
``ZAMMAD_PROCESS_SCHEDULED_JOBS_DISABLE``.
181-
182-
Doing so on productive instances will draw important parts of your
183-
instance not working. **WE STRONGLY** encourage against using this flag.
184-
185181
ZAMMAD_PROCESS_DELAYED_JOBS_WORKERS
186182
How many processes should work on delayed jobs?
187183

@@ -194,14 +190,6 @@ ZAMMAD_PROCESS_DELAYED_JOBS_WORKERS
194190
195191
.. warning:: 🥵 **This option can be very CPU-intensive.**
196192

197-
.. danger::
198-
199-
Disable processing of delayed jobs by setting
200-
``ZAMMAD_PROCESS_DELAYED_JOBS_DISABLE``.
201-
202-
Doing so on productive instances will draw important parts of your
203-
instance not working. **WE STRONGLY** encourage against using this flag.
204-
205193

206194
ZAMMAD_PROCESS_DELAYED_AI_JOBS_WORKERS
207195
How many instances of AI workers should run simultaneously. AI workers handle

install/docker-compose/environment.rst

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,18 @@ Zammad
3838
* - ZAMMAD_FQDN
3939
- ``(unset)``
4040
- Set the :admin-docs:`FQDN </settings/system/base.html>` for your instance.
41+
* - RAILS_TRUSTED_PROXIES
42+
- ``127.0.0.1,::1``
43+
- This setting is important for the correct detection of client IP addresses
44+
and features based on it, like rate limiting.
45+
46+
By default, Zammad trusts localhost proxies only. Any additional proxy servers
47+
will have to be added here, by IP address (if static) or by host name.
48+
Host names are resolved during the start of Zammad, so that a restart is required
49+
whenever the IP address of a proxy server changes.
50+
51+
Note that in docker context, Zammad may see the network gateway IP address instead of the
52+
actual proxy server IP address, if it is placed in another network.
4153
* - ZAMMAD_WEB_CONCURRENCY
4254
- ``(unset)``
4355
- Allows spawning ``n`` workers to allow more simultaneous connections for
@@ -72,12 +84,6 @@ Zammad
7284

7385
In case you applied :doc:`docker hardware resource limits </install/docker-compose/docker-compose-scenarios>`,
7486
the zammad-scheduler CPU setting should match the sum of all worker settings variables.
75-
* - RAILS_TRUSTED_PROXIES
76-
- ``['127.0.0.1', '::1']``
77-
- By default, Zammad trusts localhost proxies only. Set IP addresses or host
78-
names of your existing reverse proxies. Host names are resolved during
79-
the start of Zammad. A change of the host name requires a restart of
80-
Zammad.
8187
* - MEMCACHE_SERVERS
8288
- ``zammad-memcached:11211``
8389
- Provide your own Memcached instance to Zammad if you already have one.

0 commit comments

Comments
 (0)