Merge pull request #11007 from vector-im/travis/permalinks

Document permalinkPrefix setting
This commit is contained in:
Travis Ralston 2019-10-01 08:41:29 -06:00 committed by GitHub
commit 6173841768
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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