Skip to content

Commit

Permalink
Document missing server config options (#18122)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
MadLittleMods authored Feb 12, 2025
1 parent 74aa478 commit 0b1830b
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 0 deletions.
1 change: 1 addition & 0 deletions changelog.d/18122.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document missing server config options (`daemonize`, `print_pidfile`, `user_agent_suffix`, `use_frozen_dicts`, `manhole`).
58 changes: 58 additions & 0 deletions docs/usage/configuration/config_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,53 @@ Example configuration:
pid_file: DATADIR/homeserver.pid
```
---
### `daemonize`

Specifies whether Synapse should be started as a daemon process. If Synapse is being
managed by [systemd](../../systemd-with-workers/), this option must be omitted or set to
`false`.

This can also be set by the `--daemonize` (`-D`) argument when starting Synapse.

See `worker_daemonize` for more information on daemonizing workers.

Example configuration:
```yaml
daemonize: true
```
---
### `print_pidfile`

Print the path to the pidfile just before daemonizing. Defaults to false.

This can also be set by the `--print-pidfile` argument when starting Synapse.

Example configuration:
```yaml
print_pidfile: true
```
---
### `user_agent_suffix`

A suffix that is appended to the Synapse user-agent (ex. `Synapse/v1.123.0`). Defaults
to None

Example configuration:
```yaml
user_agent_suffix: " (I'm a teapot; Linux x86_64)"
```
---
### `use_frozen_dicts`

Determines whether we should freeze the internal dict object in `FrozenEvent`. Freezing
prevents bugs where we accidentally share e.g. signature dicts. However, freezing a
dict is expensive. Defaults to false.

Example configuration:
```yaml
use_frozen_dicts: true
```
---
### `web_client_location`

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

---
### `manhole`

Turn on the Twisted telnet manhole service on the given port. Defaults to none.

This can also be set by the `--manhole` argument when starting Synapse.

Example configuration:
```yaml
manhole: 1234
```
---
### `manhole_settings`

Expand Down

0 comments on commit 0b1830b

Please sign in to comment.