diff options
| author | Matthew Hodgson <matthew@matrix.org> | 2019-03-04 23:49:54 +0000 |
|---|---|---|
| committer | Matthew Hodgson <matthew@matrix.org> | 2019-03-04 23:49:54 +0000 |
| commit | d70c2748af32520f2d6f7b1b0c32acf73b7ec6a0 (patch) | |
| tree | ee7521016d43cc5a575f7ce4a745eae33da523bb | |
| parent | Merge pull request #4798 from matrix-org/rav/rr_debug (diff) | |
| download | synapse-d70c2748af32520f2d6f7b1b0c32acf73b7ec6a0.tar.xz | |
reword the sample config header to be less scary
| -rw-r--r-- | docs/.sample_config_header.yaml | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/docs/.sample_config_header.yaml b/docs/.sample_config_header.yaml index 576fc98609..2f2201fdcc 100644 --- a/docs/.sample_config_header.yaml +++ b/docs/.sample_config_header.yaml @@ -1,7 +1,12 @@ -# 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. |