update sample config

tweak changelog
changelog
2025-12-05 01:10:13 +00:00 · 2019-03-05 17:32:34 +00:00 · 2019-03-05 17:28:52 +00:00 · 2019-03-05 00:01:17 +00:00 · 2019-03-04 23:50:14 +00:00 · 2019-03-04 23:49:54 +00:00
3 changed files with 21 additions and 10 deletions
--- a/changelog.d/4801.feature
+++ b/changelog.d/4801.feature
@@ -0,0 +1 @@
+Include a default configuration file in the 'docs' directory.
--- 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.

--- 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 ##
Author	SHA1	Message	Date
Richard van der Hoff	d0dc0014c1	update sample config	2019-03-05 17:32:34 +00:00
Richard van der Hoff	054ed1ab5b	tweak changelog	2019-03-05 17:28:52 +00:00
Matthew Hodgson	b556fcda72	changelog	2019-03-05 00:01:17 +00:00
Matthew Hodgson	11d64ec4a9	remove trailing space	2019-03-04 23:50:14 +00:00
Matthew Hodgson	d70c2748af	reword the sample config header to be less scary	2019-03-04 23:49:54 +00:00
				`@@ -0,0 +1 @@`
				`Include a default configuration file in the 'docs' directory.`