Skip to content

settings.md

Latest commit

 

History

History
149 lines (114 loc) · 3.75 KB

settings.md

File metadata and controls

149 lines (114 loc) · 3.75 KB

XMPP settings

Tip

This page contains the details about xmpp settings. More general information about xmpp support in matterbridge can be found in README.md.

Note

XMPP (the protocol) is also known as Jabber (the open federation). These two terms are used interchangeably. To learn more about Jabber/XMPP, see joinjabber.org.

Jid

Jabber Identifier, the XMPP login for matterbridge's account.

  • Setting: REQUIRED
  • Format: string
  • Example: 
    Jid="user@example.com"

MUC

The Multi User Chat (MUC) server where the bot will find the defined gateway channels. At the moment, bridging a room on a different MUC requires creating a separate account entry in the configuration.

TODO: test if a matterbridge instance can be connected to the same account with two configurations at the same time; this is allowed by XMPP protocol but requires matterbridge to behave properly in terms of XMPP protocol

  • Setting: REQUIRED
  • Format: string
  • Example: 
    Muc="conference.jabber.example.com"

Nick

Your nick in the rooms

  • Setting: REQUIRED
  • Format: string
  • Example: 
    Nick="xmppbot"

NoTLS (DEPRECATED)

Warning

This setting has been deprecated. matterbridge will refuse to start if you are using it. You should use the new UseDirectTls and NoStartTls settings instead.

  • Setting: OPTIONAL
  • Format: boolean
  • Example: 
    NoTLS=true

UseDirectTLS

Enables direct TLS connection to your server. Most servers by default only support StartTLS, so this option should only be enabled if you know what you are doing. When UseDirectTLS is not set, and NoStartTls is enabled, a plaintext connection is established, which should only be used in a local testing environment.

  • Setting: OPTIONAL
  • Format: boolean
  • Example: 
    UseDirectTLS=true

NoStartTLS

Disable StartTLS connection to your server. If you'd like to use direct TLS, enable the UseDirectTLS setting. Otherwise, a plaintext connection is established, which should only be used in a local testing environment.

  • Setting: OPTIONAL
  • Format: boolean
  • Example: 
    NoStartTLS=true

Password

Password for the Jid's account.

  • Setting: REQUIRED
  • Format: string
  • Example: 
    Password="yourpass"

Server

XMPP server to connect to.

  • Setting: REQUIRED
  • Format: string (hostname:port)
  • Example: 
    Server="jabber.example.com:5222"

Mechanism

Force an explicit SASL mechanism for authentication. This is a very advanced setting when debugging authentication problems and potential upstream go-xmpp authentication bugs. If you don't understand it, you don't need it.

  • Setting: OPTIONAL
  • Format: string
  • Example: 
    Mechanism="PLAIN"

NoPLAIN

Prevent using PLAIN SASL authentication to the server. This is an advanced setting which is incompatible with many servers (eg. those using LDAP auth). When enabled, this setting will make sure your configured password is never sent to the server, only establishing a secure handshake such as SCRAM.

  • Setting: OPTIONAL
  • Format: boolean
  • Example: 
    NoPLAIN=true

WebhookURL

Warning

The WebhookURL setting has been removed. It was using a custom prosody module mod_slack_webhooks which may or may not still be functional, but is not documented to work with the latest prosody releases.

If you are still successfully using this feature, please open an issue documenting your setup so that we can support it again in the future.