Skip to content

Commit 0b1830b

Browse files
Document missing server config options (#18122)
I was looking into the `USE_FROZEN_DICTS` option during the review of #18103 (comment) and noticed that there are several other server config options that aren't in the docs.
1 parent 74aa478 commit 0b1830b

2 files changed

Lines changed: 59 additions & 0 deletions

File tree

changelog.d/18122.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Document missing server config options (`daemonize`, `print_pidfile`, `user_agent_suffix`, `use_frozen_dicts`, `manhole`).

docs/usage/configuration/config_documentation.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,53 @@ Example configuration:
162162
pid_file: DATADIR/homeserver.pid
163163
```
164164
---
165+
### `daemonize`
166+
167+
Specifies whether Synapse should be started as a daemon process. If Synapse is being
168+
managed by [systemd](../../systemd-with-workers/), this option must be omitted or set to
169+
`false`.
170+
171+
This can also be set by the `--daemonize` (`-D`) argument when starting Synapse.
172+
173+
See `worker_daemonize` for more information on daemonizing workers.
174+
175+
Example configuration:
176+
```yaml
177+
daemonize: true
178+
```
179+
---
180+
### `print_pidfile`
181+
182+
Print the path to the pidfile just before daemonizing. Defaults to false.
183+
184+
This can also be set by the `--print-pidfile` argument when starting Synapse.
185+
186+
Example configuration:
187+
```yaml
188+
print_pidfile: true
189+
```
190+
---
191+
### `user_agent_suffix`
192+
193+
A suffix that is appended to the Synapse user-agent (ex. `Synapse/v1.123.0`). Defaults
194+
to None
195+
196+
Example configuration:
197+
```yaml
198+
user_agent_suffix: " (I'm a teapot; Linux x86_64)"
199+
```
200+
---
201+
### `use_frozen_dicts`
202+
203+
Determines whether we should freeze the internal dict object in `FrozenEvent`. Freezing
204+
prevents bugs where we accidentally share e.g. signature dicts. However, freezing a
205+
dict is expensive. Defaults to false.
206+
207+
Example configuration:
208+
```yaml
209+
use_frozen_dicts: true
210+
```
211+
---
165212
### `web_client_location`
166213

167214
The absolute URL to the web client which `/` will redirect to. Defaults to none.
@@ -595,6 +642,17 @@ listeners:
595642
- names: [client, federation]
596643
```
597644

645+
---
646+
### `manhole`
647+
648+
Turn on the Twisted telnet manhole service on the given port. Defaults to none.
649+
650+
This can also be set by the `--manhole` argument when starting Synapse.
651+
652+
Example configuration:
653+
```yaml
654+
manhole: 1234
655+
```
598656
---
599657
### `manhole_settings`
600658

0 commit comments

Comments
 (0)