PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Document permalinkPrefix setting

Browse source 
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.
This commit is contained in:
Travis Ralston 2019-09-30 13:05:15 -06:00
parent ae7ccb613e
commit 1aa48be01e
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/config.md
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. Defaults to `GB` if the given code is unknown or not provided.
1. `disable_custom_urls`: disallow the user to change the 1. `disable_custom_urls`: disallow the user to change the
default homeserver when signing up or logging in. 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 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 hosted on riot.im. This is the image used if links to your copy of Riot