diff options
| author | Richard van der Hoff <richard@matrix.org> | 2019-03-05 17:32:34 +0000 |
|---|---|---|
| committer | Richard van der Hoff <richard@matrix.org> | 2019-03-05 17:32:34 +0000 |
| commit | d0dc0014c16bad62ed313ca79d9ba2f2b94325db (patch) | |
| tree | 2f577aeb29467a78b62d4bfd0134ba89295417f9 | |
| parent | tweak changelog (diff) | |
| download | synapse-matthew/sample-config.tar.xz | |
update sample config github/matthew/sample-config matthew/sample-config
| -rw-r--r-- | docs/sample_config.yaml | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index 7cf58d2182..12a3b1c561 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -1,9 +1,14 @@ -# This file is a reference to the configuration options which can be set in -# homeserver.yaml. +# The config is maintained as an up-to-date snapshot of the default +# homeserver.yaml configuration generated by Synapse. # -# Note that it is not quite ready to be used as-is. If you are starting from -# scratch, it is easier to generate the config files following the instructions -# in INSTALL.md. +# It is intended to act as a reference for the default configuration, +# helping admins keep track of new options and other changes, and compare +# their configs with the current default. As such, many of the actual +# config values shown are placeholders. +# +# It is *not* intended to be copied and used as the basis for a real +# homeserver.yaml. Instead, if you are starting from scratch, please generate +# a fresh config using Synapse by following the instructions in INSTALL.md. ## Server ## |