Struct WellKnownConfig 

pub struct WellKnownConfig {
    pub client: Option<Url>,
    pub server: Option<OwnedServerName>,
    pub support_contact: BTreeMap<String, SupportContact>,
    pub support_policy: BTreeMap<String, SupportPolicy>,
    pub support_page: Option<Url>,
    pub support_role: Option<ContactRole>,
    pub support_email: Option<String>,
    pub support_mxid: Option<OwnedUserId>,
    pub support_pgp_key: Option<String>,
    pub livekit_url: Option<String>,
    pub rtc_transports: Vec<Value>,
}

Configures Matrix discovery documents and related response data.

Client and server fields drive the standard well-known responses. Support contacts, policies, and MatrixRTC transports populate their corresponding discovery data.

Fields

client: Option<Url>

The server URL that the client well-known file will serve.

This should not contain a port, and should just be a valid HTTPS URL. While this is unset, /.well-known/matrix/client answers 404 and auto-discovery from the server name yields nothing, so the base URL has to reach clients some other way. Leave it unset only when a reverse proxy or another host publishes that file for this domain.

example: “https://matrix.example.com”

server: Option<OwnedServerName>

The server base domain of the URL with a specific port that the server well-known file will serve. This should contain a port at the end, and should not be a URL.

reloadable: yes example: “matrix.example.com:443”

support_contact: BTreeMap<String, SupportContact>

Defines contacts published by the support discovery endpoint.

Each map value becomes one contact while its key is only a config identifier. Legacy scalar support fields are appended separately.

support_policy: BTreeMap<String, SupportPolicy>

Defines policies published by the support discovery endpoint.

Each map key becomes a policy identifier. The value supplies its version and localized documents.

support_page: Option<Url>

The URL of the support web page. This and the below generate the content of /.well-known/matrix/support.

example: “https://example.com/support”

support_role: Option<ContactRole>

The name of the support role.

display: hidden

support_email: Option<String>

The email address for the above support role.

display: hidden

support_mxid: Option<OwnedUserId>

The Matrix User ID for the above support role.

display: hidden

support_pgp_key: Option<String>

The PGP key (i.e. OpenPGP) that one may use for encrypted communications for the above support role. The value must be a URI. Use a web URL pointing to the key (for example “https://example.com/key.asc”), an OPENPGPKEY DNS record (“dns:…”), or a fingerprint carried with the “openpgp4fpr:” scheme. A bare fingerprint without a scheme, or raw inlined key material, is rejected at startup.

As this is a spec proposal (MSC4439), the identifier/prefix for this field is currently “dev.zirco.msc4439.pgp_key”

display: hidden

livekit_url: Option<String>

LiveKit JWT endpoint. Required for Element Call / MatrixRTC (MSC4143).

Note: You must also set client above to your homeserver URL.

reloadable: yes default: “”

rtc_transports: Vec<Value>

Custom MatrixRTC transports.

If you’re looking to setup Element Call / MatrixRTC with Livekit, you should not use this option and instead set livekit_url. This is only required if you want to configure a non-livekit MatrixRTC transport. There are no known client implementations that support any other transport types.

This option was previously the only way to configure a Livekit transport. It has been superseded by livekit_url.

Example:

[global.well_known]
client = "https://matrix.yourdomain.com"

[[global.well_known.rtc_transports]]
type = "livekit"
livekit_service_url = "https://livekit.yourdomain.com"

reloadable: yes default: []

Implementations

impl WellKnownConfig

pub fn get_contacts(&self) -> Vec<Contact>

Builds the support contacts advertised through well-known discovery.

Named contact entries are converted first. Legacy single-contact fields append one additional contact when a support role is configured.

impl WellKnownConfig

pub fn get_policies(&self) -> BTreeMap<String, Policies>

Builds the localized support policies advertised through discovery.

Outer map keys remain policy identifiers. Each configured language entry is converted into the corresponding Matrix policy representation.

impl WellKnownConfig

pub fn get_transports(&self) -> Result<Vec<RtcTransport>>

Build the configured RTC transports as RtcTransport values, the typed form shared between .well-known/matrix/client.rtc_foci and the /rtc/transports endpoint.

Trait Implementations

impl Clone for WellKnownConfig

fn clone(&self) -> WellKnownConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WellKnownConfig

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WellKnownConfig

fn default() -> WellKnownConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WellKnownConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for WellKnownConfig

fn fmt(&self, out: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.