Browse Source

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.
pull/11007/head
Travis Ralston 3 years ago
parent
commit
1aa48be01e
  1. 4
      docs/config.md

4
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

Loading…
Cancel
Save