From 2dc26b4c5d0c2e4b201193d4fee36341dac57d92 Mon Sep 17 00:00:00 2001 From: "J. Ryan Stinnett" Date: Tue, 19 Feb 2019 16:17:27 +0000 Subject: [PATCH] Document and recommend `default_server_name` This the recommended way to define a default server (instead of the existing HS and IS URL options). It will use `.well-known` discovery to find the URLs. See https://github.com/vector-im/riot-web/issues/8763. --- README.md | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 10fef7360e..d7c7ba96eb 100644 --- a/README.md +++ b/README.md @@ -116,17 +116,24 @@ config.json You can configure the app by copying `config.sample.json` to `config.json` and customising it: -For a good example, see https://riot.im/develop/config.json +For a good example, see https://riot.im/develop/config.json. -1. `default_hs_url` is the default homeserver url. -1. `default_is_url` is the default identity server url (this is the server used - for verifying third party identifiers like email addresses). If this is blank, - registering with an email address, adding an email address to your account, - or inviting users via email address will not work. Matrix identity servers are - very simple web services which map third party identifiers (currently only email - addresses) to matrix IDs: see http://matrix.org/docs/spec/identity_service/unstable.html - for more details. Currently the only public matrix identity servers are https://matrix.org - and https://vector.im. In future identity servers will be decentralised. +1. `default_server_name` sets the default server name to use for authentication. + This will trigger Riot to ask + `https:///.well-known/matrix/client` for the homeserver and + identity server URLs to use. This is the recommended approach for setting a + default server. However, it is also possible to use the following to directly + configure each of the URLs: + * `default_hs_url` sets the default homeserver URL. + * `default_is_url` sets the default identity server URL (this is the server used + for verifying third party identifiers like email addresses). If this is blank, + registering with an email address, adding an email address to your account, + or inviting users via email address will not work. Matrix identity servers are + very simple web services which map third party identifiers (currently only email + addresses) to matrix IDs: see http://matrix.org/docs/spec/identity_service/unstable.html + for more details. Currently the only public matrix identity servers are https://matrix.org + and https://vector.im. In the future, identity servers will be decentralised. + * Riot will report an error if you accidentally configure both `default_server_name` _and_ `default_hs_url` since it's unclear which should take priority. 1. `features`: Lookup of optional features that may be `enable`d, `disable`d, or exposed to the user in the `labs` section of settings. The available optional experimental features vary from release to release.