summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorMatthew Hodgson <matthew@arasphere.net>2019-03-07 07:09:01 +0000
committerRichard van der Hoff <1389908+richvdh@users.noreply.github.com>2019-03-07 07:09:01 +0000
commit8f4b9f52102cd0b1dd95d1d97811eef8690f1288 (patch)
treeac60caa65229069359d2934fb15c317b45c6840f /docs
parentMerge pull request #4779 from matrix-org/travis/icons (diff)
downloadsynapse-8f4b9f52102cd0b1dd95d1d97811eef8690f1288.tar.xz
Reword the sample config header to be less scary (#4801)
Diffstat (limited to 'docs')
-rw-r--r--docs/.sample_config_header.yaml15
-rw-r--r--docs/sample_config.yaml15
2 files changed, 20 insertions, 10 deletions
diff --git a/docs/.sample_config_header.yaml b/docs/.sample_config_header.yaml
index 576fc98609..e001ef5983 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.
 
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index 3dd0b4a1a8..b62745dd6e 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 ##