mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-12-15 17:51:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Reword the sample config header to be less scary (#4801)

Browse source
This commit is contained in:
Matthew Hodgson 2019-03-07 07:09:01 +00:00 committed by Richard van der Hoff
parent 06cbf79fe3
commit 8f4b9f5210
3 changed files with 21 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/4801.feature Normal file
View file

@ -0,0 +1 @@
Include a default configuration file in the 'docs' directory.

15
docs/.sample_config_header.yaml
View file

@ -1,7 +1,12 @@
# This file is a reference to the configuration options which can be set in # The config is maintained as an up-to-date snapshot of the default
# homeserver.yaml. # homeserver.yaml configuration generated by Synapse.
# #
# Note that it is not quite ready to be used as-is. If you are starting from # It is intended to act as a reference for the default configuration,
# scratch, it is easier to generate the config files following the instructions # helping admins keep track of new options and other changes, and compare
# in INSTALL.md. # 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.

15
docs/sample_config.yaml
View file

@ -1,9 +1,14 @@
# This file is a reference to the configuration options which can be set in # The config is maintained as an up-to-date snapshot of the default
# homeserver.yaml. # homeserver.yaml configuration generated by Synapse.
# #
# Note that it is not quite ready to be used as-is. If you are starting from # It is intended to act as a reference for the default configuration,
# scratch, it is easier to generate the config files following the instructions # helping admins keep track of new options and other changes, and compare
# in INSTALL.md. # 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 ## ## Server ##