From 1aa48be01e8b8e5aaa9c1508bf5e095517414d2a Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Mon, 30 Sep 2019 13:05:15 -0600 Subject: [PATCH] Document permalinkPrefix setting There's no sample config changes because we don't want to encourage people using this setting. It is for very limited scenarios only: unfederated servers. --- docs/config.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/config.md b/docs/config.md index 1ff8a7cfb3..3a09c7f2d2 100644 --- a/docs/config.md +++ b/docs/config.md @@ -82,6 +82,10 @@ For a good example, see https://riot.im/develop/config.json. Defaults to `GB` if the given code is unknown or not provided. 1. `disable_custom_urls`: disallow the user to change the default homeserver when signing up or logging in. +1. `permalinkPrefix`: Used to change the URL that Riot generates permalinks with. + By default, this is "https://matrix.to" to generate matrix.to (spec) permalinks. + Set this to your Riot instance URL if you run an unfederated server (eg: + "https://riot.example.org"). Note that `index.html` also has an og:image meta tag that is set to an image hosted on riot.im. This is the image used if links to your copy of Riot