synapse-product/docs
Richard van der Hoff fd463b4f5d
Comment out most options in the generated config. (#4863)
Make it so that most options in the config are optional, and commented out in
the generated config.

The reasons this is a good thing are as follows:

* If we decide that we should change the default for an option, we can do so,
  and only those admins that have deliberately chosen to override that option
  will be stuck on the old setting.

* It moves us towards a point where we can get rid of the super-surprising
  feature of synapse where the default settings for the config come from the
  generated yaml.

* It makes setting up a test config for unit testing an order of magnitude
  easier (see forthcoming PR).

* It makes the generated config more consistent, and hopefully easier for users
  to understand.
2019-03-19 10:06:40 +00:00
..
admin_api add API documentation 2019-03-02 03:07:04 +01:00
privacy_policy_templates/en Update documentation and templates for new consent 2018-10-12 17:53:14 -06:00
sphinx oops 2017-10-13 14:26:07 +01:00
.sample_config_header.yaml Reword the sample config header to be less scary (#4801) 2019-03-07 07:09:01 +00:00
ACME.md Minor tweaks to acme docs (#4689) 2019-02-22 10:56:42 +00:00
ancient_architecture_notes.rst move stuff out of implementation-notes - /everything/ here should be implementation-notes now 2014-11-12 00:18:25 +02:00
application_services.rst Fix link to A-S spec 2016-05-23 16:29:38 +01:00
architecture.rst move stuff out of implementation-notes - /everything/ here should be implementation-notes now 2014-11-12 00:18:25 +02:00
CAPTCHA_SETUP.rst Update CAPTCHA_SETUP.rst X-Forwarded-For docs 2017-02-08 21:21:02 -08:00
code_style.rst code_style.rst: formatting 2018-05-31 16:11:34 +01:00
consent_tracking.md Add config variables for enabling terms auth and the policy name (#4142) 2018-11-06 10:32:34 +00:00
federate.md fix orphaned sentence 2019-03-12 16:57:17 +00:00
log_contexts.rst Do a GC after each test to fix logcontext leaks (#4227) 2018-11-27 13:00:33 +11:00
manhole.md Notes on the manhole 2018-05-23 13:47:34 +01:00
media_repository.rst clarify these instructions a media-repo specific 2014-12-24 16:56:32 +00:00
metrics-howto.rst Fix metric documentation tables (#3341) 2018-06-06 15:52:37 +10:00
MSC1711_certificates_FAQ.md Synapse 0.99.1 (2019-02-14) 2019-02-14 14:41:40 +00:00
password_auth_providers.rst Factor _AccountHandler proxy out to ModuleApi 2017-11-02 14:36:11 +00:00
postgres.rst doc/postgres.rest: fix displaying of the last command block 2018-06-04 22:41:52 +00:00
README.rst move matrix-generic content to new matrix-doc git project 2014-10-09 20:38:00 +02:00
replication.rst Update replication docs 2017-04-11 16:21:12 +01:00
reverse_proxy.rst Fix v4v6 option in HAProxy example config (#4790) 2019-03-04 13:19:41 +00:00
sample_config.yaml Comment out most options in the generated config. (#4863) 2019-03-19 10:06:40 +00:00
server_notices.md Let users leave the server notice room after joining 2018-05-25 11:07:21 +01:00
tcp_replication.rst Fix tightloop over connecting to replication server 2019-02-26 15:05:41 +00:00
turn-howto.rst Remove mention of lt-cred-mech in the sample coturn config. (#4333) 2018-12-28 23:31:49 +00:00
url_previews.md move url_previews to MD as RST does my head in 2017-10-29 20:47:17 +00:00
user_directory.md simplify instructions for regenerating user_dir 2017-11-04 19:34:59 +00:00
workers.rst Allow /keys/{changes,query} API to run on worker 2019-03-04 18:30:01 +00:00

All matrix-generic documentation now lives in its own project at

github.com/matrix-org/matrix-doc.git

Only Synapse implementation-specific documentation lives here now
(together with some older stuff will be shortly migrated over to matrix-doc)