Skip to content

settings.md

Latest commit

 

History

History
139 lines (101 loc) · 2.62 KB

settings.md

File metadata and controls

139 lines (101 loc) · 2.62 KB

Matrix settings

Tip

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

DeviceID

The device id use when logging in with MxID.

Unless this option is set, the Matrix client is unencrypted and MxID based login won't work.

  • Setting: OPTIONAL
  • Format: string
  • Example: 
    DeviceID="yourdeviceid"

HTMLDisable

Whether to disable sending of HTML content to matrix See 42wim#1022

  • Setting: OPTIONAL, RELOADABLE
  • Format: boolean
  • Example: 
    HTMLDisable=true

Login

login of your bot. Use a dedicated user for this and not your own! Messages sent from this user will not be relayed to avoid loops.

  • Setting: REQUIRED
  • Format: string
  • Example: 
    Login="yourlogin"

MxID

MxID of your bot. Use a dedicated user for this and not your own! Messages sent from this user will not be relayed to avoid loops.

  • Setting: REQUIRED
  • Format: string
  • Example: 
    MxID="@yourbot:example.net"

NoHomeServerSuffix

Whether to send the homeserver suffix. eg ":matrix.org" in @username:matrix.org to other bridges, or only send "username".(true only sends username)

  • Setting: OPTIONAL, RELOADABLE
  • Format: boolean
  • Example: 
    NoHomeServerSuffix=true

Password

password of your bot.

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

PickleKey

The key to use when accessing E2EE encryption in an encryption database.

Unless this option is set, the Matrix client is unencrypted.

  • Setting: OPTIONAL
  • Format: string
  • Example: 
    Password="yourpicklekey"

RecoveryKey

The key to use when accessing E2EE encryption in an encryption database.

Unless this option is set, the Matrix client won't be verified for encryption.

  • Setting: OPTIONAL
  • Format: string
  • Example: 
    RecoveryKey="yourrecoverykey"

Server

Server is your homeserver (eg https://matrix.org)

  • Setting: REQUIRED
  • Format: string
  • Example: 
    Server="https://matrix.org"

SessionFile

The database file to use when accessing E2EE encryption in an encryption database.

Unless this option is set, the Matrix client is unencrypted.

  • Setting: OPTIONAL
  • Format: string
  • Example: 
    SessionFile="yourdatabasefile.db"

UseUserName

Shows the username instead of the displayname

  • Setting: OPTIONAL, RELOADABLE
  • Format: boolean
  • Example: 
    UseUserName=true