Add some clarity to the config options

This commit is contained in:
Travis Ralston 2019-04-19 17:10:56 -06:00
parent e7bf643d8b
commit ab6ba0e0d8
2 changed files with 4 additions and 2 deletions

View File

@ -114,7 +114,9 @@ For a good example, see https://riot.im/develop/config.json.
with added support for a `server_name` under the `m.homeserver` section to display with added support for a `server_name` under the `m.homeserver` section to display
a custom homeserver name. Alternatively, the config can contain a `default_server_name` a custom homeserver name. Alternatively, the config can contain a `default_server_name`
instead which is where Riot will go to get that same object - see the `.well-known` instead which is where Riot will go to get that same object - see the `.well-known`
link above for more information. link above for more information. Note that the `default_server_name` is used to get
a complete server configuration whereas the `server_name` in the `default_server_config`
is for display purposes only.
* *Note*: The URLs can also be individually specified as `default_hs_url` and * *Note*: The URLs can also be individually specified as `default_hs_url` and
`default_is_url`, however these are deprecated. They are maintained for backwards `default_is_url`, however these are deprecated. They are maintained for backwards
compatibility with older configurations. `default_is_url` is respected only compatibility with older configurations. `default_is_url` is respected only

View File

@ -500,7 +500,7 @@ async function verifyServerConfig() {
// Add the newly built config to the actual config for use by the app // Add the newly built config to the actual config for use by the app
console.log("Updating SdkConfig with validated discovery information"); console.log("Updating SdkConfig with validated discovery information");
SdkConfig.add({"validated_discovery_config": validatedConfig}); SdkConfig.add({"validated_server_config": validatedConfig});
return SdkConfig.get(); return SdkConfig.get();
} }