Element-web: complete configuration options explanation

Created on 1 Oct 2019  路  4Comments  路  Source: vector-im/element-web

It is kinda hard for non-experienced developer to deal with new software especially when there is minimum information about how does it work. I find config doc for Riot not very descriptive. For example, there are no explanation for enable_presence_by_hs_url and hosting_signup_link options at all while in sample JSON config (https://riot.im/develop/config.json) these elements are presented. My suggestion is to improve Riot configuration documentation.

suggestion documentation

All 4 comments

I'm honestly not sure if enable_presence_by_hs_url does anything at all. If you search the entire codebase of this project the only place that shows up is in sample config files...

Now there is an explanation in https://github.com/vector-im/riot-web/blob/master/docs/config.md :

  1. enable_presence_by_hs_url: The property key should be the URL of the homeserver and its value defines whether to enable/disable the presence status display from that homeserver. If no options are configured, presence is shown for all homeservers.

But what exactly does that mean? for a not experienced user this is still not clear. What is the "presence status"?

People who aren't experienced shouldn't be editing config.json anyway.

Then there should be a section that explains for those, which values are relevant to noon experienced users, for example you should add your Homeserver to the directory

Was this page helpful?
0 / 5 - 0 ratings