Synapse: Please can we ship a homeserver.yaml.sample (SYN-772)

[matrixbot]

Submitted by @​matthew:matrix.org
So that folks can see more easily what the new options are that they should be c+p'ing into their live config

(Imported from https://matrix.org/jira/browse/SYN-772)

[danpe]

👍

[ara4n]

Meanwhile the Debian packages look to ship with a config file from 2016?!

https://github.com/matrix-org/package-synapse-debian/blob/debian/debian/homeserver.yaml

[benqrn]

The sample configs generated upon a fresh install of Synapse (from apt) appear to be obsolete (homeserver.yaml is dated Nov 20, 2017) and do not include all of the available current config options. Running "python -m synapse.app.homeserver --generate-config" does appear to give me the latest config file though.

Perhaps this should be a separate issue, but it's certainly relevant to including a useful sample config.

[rubo77]

Please add all new options.

Especially for the new DSGVO from 25.5.2018

[rubo77]

I think i found is all and added it as PR here: https://github.com/matrix-org/package-synapse-debian/pull/31

Here are the docs: https://github.com/matrix-org/synapse/blob/master/docs/consent_tracking.md

[abeluck]

Would love to see this updated. As a synapse newbie, the lack of an up to date sample config makes it difficult to get up and running.

[digititus]

Agreed. Especially when moving from 0.3x --> 0.99 / 1.0

[richvdh]

This is definitely a thing I want to fix, but for anyone coming to this in the meantime: be aware that synapse ships with a generate_config script which will generate a sample config.

[richvdh]

https://github.com/matrix-org/synapse/blob/develop/docs/sample_config.yaml

[Valodim]

Could you please rename this file in the repo to something that includes "homeserver"? I've found myself googling for a sample homeserver yaml several times now, and the easiest way to find it is via this issue where you have to guess it'll be linked from some comment. A filename like "homeserver.sample.yaml" would make that much easier.