diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 7c4e742cd5..425ec75542 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -33,6 +33,23 @@ In addition, configuration options referring to size use the following suffixes:
For example, setting `max_avatar_size: 10M` means that Synapse will not accept files larger than 10,485,760 bytes
for a user avatar.
+## Config Validation
+
+The configuration file can be validated with the following command:
+```bash
+python -m synapse.config read <config key to print> -c <path to config>
+```
+
+To validate the entire file, omit `read <config key to print>`:
+```bash
+python -m synapse.config -c <path to config>
+```
+
+To see how to set other options, check the help reference:
+```bash
+python -m synapse.config --help
+```
+
### YAML
The configuration file is a [YAML](https://yaml.org/) file, which means that certain syntax rules
apply if you want your config file to be read properly. A few helpful things to know:
@@ -566,7 +583,7 @@ listeners:
# Note that x_forwarded will default to true, when using a UNIX socket. Please see
# https://matrix-org.github.io/synapse/latest/reverse_proxy.html.
#
- - path: /var/run/synapse/main_public.sock
+ - path: /run/synapse/main_public.sock
type: http
resources:
- names: [client, federation]
@@ -3815,6 +3832,8 @@ Sub-options for this setting include:
* `system_mxid_display_name`: set the display name of the "notices" user
* `system_mxid_avatar_url`: set the avatar for the "notices" user
* `room_name`: set the room name of the server notices room
+* `auto_join`: boolean. If true, the user will be automatically joined to the room instead of being invited.
+ Defaults to false. _Added in Synapse 1.98.0._
Example configuration:
```yaml
@@ -3823,6 +3842,7 @@ server_notices:
system_mxid_display_name: "Server Notices"
system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ"
room_name: "Server Notices"
+ auto_join: true
```
---
### `enable_room_list_search`
@@ -4215,9 +4235,9 @@ Example configuration(#2, for UNIX sockets):
```yaml
instance_map:
main:
- path: /var/run/synapse/main_replication.sock
+ path: /run/synapse/main_replication.sock
worker1:
- path: /var/run/synapse/worker1_replication.sock
+ path: /run/synapse/worker1_replication.sock
```
---
### `stream_writers`
@@ -4403,13 +4423,13 @@ Example configuration(#2, using UNIX sockets with a `replication` listener):
```yaml
worker_listeners:
- type: http
- path: /var/run/synapse/worker_public.sock
+ path: /run/synapse/worker_replication.sock
resources:
- - names: [client, federation]
+ - names: [replication]
- type: http
- path: /var/run/synapse/worker_replication.sock
+ path: /run/synapse/worker_public.sock
resources:
- - names: [replication]
+ - names: [client, federation]
```
---
### `worker_manhole`
|
