Consider supplying a more complete example configuration file
See original GitHub issuehttps://github.com/matrix-org/synapse/pull/12941 replaced the generated 2850-line sample configuration file with a very bare-bones starting point.
I still believe that was a good decision for all the reasons set out in #8159 , however a lot of people have found it surprising so I am opening this issue as a place to discuss whether there is a sensible middle ground.
One thing that might be worthwhile is an example file containing some of the settings you are likely to need to configure (eg: url previews, turn server) without attempting to be comprehensive. The CUPS project does something like this (it generates an example cupsd.conf
from https://github.com/OpenPrinting/cups/blob/master/conf/cupsd.conf.in; the authoritative documentation is managed separately at https://github.com/OpenPrinting/cups/blob/master/man/cupsd.conf.5).
Issue Analytics
- State:
- Created a year ago
- Comments:7 (4 by maintainers)
Please return the config file as it was. We are already used to it. I have to set up new matrix-synapse instances often, so I do it automatically. Constant changes in the config file force scripts to be rewritten. Yes, the old config file was large, but it was well documented.
I also vote for bringing back the old big but transparent config file with all the available options and the documentation included in it. The config removal and the separation of docs and code made me to trust my Homeserver less.