Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document missing server config options #18122

Draft
wants to merge 6 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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