Skip to content

Commit 1aa48be

Browse files
turt2liveturt2live
committed
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.
1 parent ae7ccb6 commit 1aa48be

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

‎docs/config.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,10 @@ For a good example, see https://riot.im/develop/config.json.
8282
Defaults to `GB` if the given code is unknown or not provided.
8383
1. `disable_custom_urls`: disallow the user to change the
8484
default homeserver when signing up or logging in.
85+
1. `permalinkPrefix`: Used to change the URL that Riot generates permalinks with.
86+
By default, this is "https://matrix.to" to generate matrix.to (spec) permalinks.
87+
Set this to your Riot instance URL if you run an unfederated server (eg:
88+
"https://riot.example.org").
8589

8690
Note that `index.html` also has an og:image meta tag that is set to an image
8791
hosted on riot.im. This is the image used if links to your copy of Riot

0 commit comments

Comments
 (0)