Fetch homeUrl from .well-known

[johannes-krude]

A custom home.html can be used to provide users with important information and rules. When users install element-desktop for a more permanent setup, the custom home.html is not shown anymore.

This commit introduces fetching of a custom homeUrl from .well-known/matrix/client["io.element.embedded_pages"]["home_url"]. As a result the home.html is also shown to element-desktop users.

I guess, this feature should also be documented in vector-im/element-web.

Notes: Configure custom home.html via .well-known/matrix/client["io.element.embedded_pages"]["home_url"] for all your element-web/desktop users

Signed-off-by: Johannes Krude [email protected]

Type: enhancement

---

Here's what your changelog entry will look like:

✨ Features

• Configure custom home.html via .well-known/matrix/client["io.element.embedded_pages"]["home_url"] for all your element-web/desktop users (#7790). Contributed by @johannes-krude.

[t3chguy]

Looks sane code-wise - needs documentation in element-web's repo somewhere

[johannes-krude]

The requested documentation has a separate PR element-hq/element-web#21066.

Is there anything else missing for this PR to get a proper review and move forward?

[kittykat]

Makes sense to have fallbacks from a product pov. For prioritisation, ideally it would be:

1. Use home_url from config.json if it exists
2. Check if server has a home_url
3. Use the built in default HomePage

Our use case for preferring config.json over server is in cases where we want users on a specific app to have a specific experience. For example, what we do for FOSDEM where we discourage accounts on the homeserver, but want to serve the same home page to all users to provide a high quality experience for the conference.

[t3chguy]

Code-wise LGTM

[t3chguy]

@johannes-krude please fix the merge conflict

[johannes-krude]

I merged this PR with develop and tested it.

Makes sense to have fallbacks from a product pov. For prioritisation, ideally it would be:

1. Use home_url from config.json if it exists

2. Check if server has a home_url

3. Use the built in default HomePage

getHomePageUrl now does the following:

1. return config.json["embeddedPages"]["homeUrl"] if it exists
2. return the deprecated config.json["welcomePageUrl"] if it exists
3. return .well-known/matrix/client["io.element.embedded_pages"]["home_url"] if it exists
4. return null which results in using the built in default HomePage

[t3chguy]

Two tiny nits

[johannes-krude]

So I guess this can be merged. 🎉

Thanks you for making this possible.