Config file values need explanation

[anoadragon453]

Currently the config file is a bit of a mess. It has a collection of "default" values, but this is not the complete list of values. They are in an odd order (email things are not together for instance), and figuring out what each value does requires looking in the code (and there are no examples anywhere).

Ideally we'd have explanations in the generated config file, similar to Synapse, with examples for each one, and it would be organised better (correct ordering).

This isn't that hard, but someone needs to go ahead and do it, else every time someone sets up a Sydent dev environment they spent a couple hours figuring out how the config file works.

[richvdh]

this. so much this.

[richvdh]

Ideally we'd have explanations in the generated config file

Ideally we wouldn't generate a config file at all, imho. It is always going to be a poor substitute for actual documentation.

[Cyberes]

From #512:

I see that I indeed set server.name in the Sydent config to example.com rather than sydent.example.com. When I configured it I wasn't sure if server.name was supposed to be the Synapse's server name (which would be example.com) or Sydent's host. Can the configuration docs be updated to include a little snippet about this distinction?

[felipeavilis]

UP! I'd really like this documentation.