From f8b99580107ef8d24e853dd13eb4d9a6c275b485 Mon Sep 17 00:00:00 2001 From: David Baker Date: Thu, 21 Jan 2021 19:23:57 +0000 Subject: [PATCH] Docs for the voip translate pattern option --- docs/config.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/config.md b/docs/config.md index 063cdffb64..d9a36b911b 100644 --- a/docs/config.md +++ b/docs/config.md @@ -110,6 +110,18 @@ For a good example, see https://develop.element.io/config.json. 1. `logo`: An HTTP URL to the avatar for the desktop build. Should be 24x24, ideally an SVG. 1. `url`: An HTTP URL for where to send the user to download the desktop build. +1. `voip_mxid_translate_pattern`: Used to route VoIP calls to different Matrix IDs. + Any VoIP calls placed will instead be placed to the translated Matrix ID from the + pattern string but still appear to be with the original Matrix ID. Correspondingly, + incoming VoIP calls will be made to appear as if they came from a different Matrix ID. + The value is a template string with substitution `$(mxid)` which is the complete + URL-encoded native Matrix ID, using '=' instead of '%'. For example, a value of + `@_myappservice_$(mxid):example.org` would cause any VoIP call to `@bob:foo.example` + to be redirected to `@_myappservice_=40bob=3Afoo.example:example.org` and calls + from the latter to appear as if they were from the former. + This option is experimental and may be removed at any time without notice. It's + also strongly advised not to set this option unless you're absolutly certain you + know what you're doing. 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 Element