element-hq / element-hq/synapse

Consider supplying a more complete example configuration file

Open
#13,306 0 comments 0 reactions 0 assignees View on GitHub
A-Docs T-Enhancement
Dominant language
Python
Stars
4.6k
Forks
600
Avg merge
5d 22h
Merged PRs (30d)
51

Description

This issue has been migrated from [#13306](https://github.com/matrix-org/synapse/issues/13306).

---

https://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).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.