| 1 | # Matrix settings |
| 2 | |
| 3 | > [!TIP] |
| 4 | > This page contains the details about matrix settings. More general information about matrix support in matterbridge can be found in [README.md](README.md). |
| 5 | |
| 6 | ## DeviceID |
| 7 | |
| 8 | The device id use when logging in with MxID. |
| 9 | |
| 10 | Unless this option is set, the Matrix client is unencrypted and MxID based login won't work. |
| 11 | |
| 12 | - Setting: **OPTIONAL** |
| 13 | - Format: *string* |
| 14 | - Example: |
| 15 | ```toml |
| 16 | DeviceID="yourdeviceid" |
| 17 | ``` |
| 18 | |
| 19 | ## HTMLDisable |
| 20 | |
| 21 | Whether to disable sending of HTML content to matrix |
| 22 | See https://github.com/42wim/matterbridge/issues/1022 |
| 23 | |
| 24 | - Setting: **OPTIONAL**, **RELOADABLE** |
| 25 | - Format: *boolean* |
| 26 | - Example: |
| 27 | ```toml |
| 28 | HTMLDisable=true |
| 29 | ``` |
| 30 | |
| 31 | ## Login |
| 32 | |
| 33 | login of your bot. |
| 34 | Use a dedicated user for this and not your own! |
| 35 | Messages sent from this user will not be relayed to avoid loops. |
| 36 | |
| 37 | - Setting: **REQUIRED** |
| 38 | - Format: *string* |
| 39 | - Example: |
| 40 | ```toml |
| 41 | Login="yourlogin" |
| 42 | ``` |
| 43 | |
| 44 | ## MxID |
| 45 | |
| 46 | MxID of your bot. |
| 47 | Use a dedicated user for this and not your own! |
| 48 | Messages sent from this user will not be relayed to avoid loops. |
| 49 | |
| 50 | - Setting: **REQUIRED** |
| 51 | - Format: *string* |
| 52 | - Example: |
| 53 | ```toml |
| 54 | MxID="@yourbot:example.net" |
| 55 | ``` |
| 56 | |
| 57 | ## NoHomeServerSuffix |
| 58 | |
| 59 | Whether to send the homeserver suffix. eg ":matrix.org" in @username:matrix.org |
| 60 | to other bridges, or only send "username".(true only sends username) |
| 61 | |
| 62 | - Setting: **OPTIONAL**, **RELOADABLE** |
| 63 | - Format: *boolean* |
| 64 | - Example: |
| 65 | ```toml |
| 66 | NoHomeServerSuffix=true |
| 67 | ``` |
| 68 | |
| 69 | ## Password |
| 70 | |
| 71 | password of your bot. |
| 72 | |
| 73 | - Setting: **REQUIRED** |
| 74 | - Format: *string* |
| 75 | - Example: |
| 76 | ```toml |
| 77 | Password="yourpass" |
| 78 | ``` |
| 79 | |
| 80 | ## PickleKey |
| 81 | |
| 82 | The key to use when accessing E2EE encryption in an encryption database. |
| 83 | |
| 84 | Unless this option is set, the Matrix client is unencrypted. |
| 85 | |
| 86 | - Setting: **OPTIONAL** |
| 87 | - Format: *string* |
| 88 | - Example: |
| 89 | ```toml |
| 90 | Password="yourpicklekey" |
| 91 | ``` |
| 92 | |
| 93 | ## RecoveryKey |
| 94 | |
| 95 | The key to use when accessing E2EE encryption in an encryption database. |
| 96 | |
| 97 | Unless this option is set, the Matrix client won't be verified for encryption. |
| 98 | |
| 99 | - Setting: **OPTIONAL** |
| 100 | - Format: *string* |
| 101 | - Example: |
| 102 | ```toml |
| 103 | RecoveryKey="yourrecoverykey" |
| 104 | ``` |
| 105 | |
| 106 | ## Server |
| 107 | |
| 108 | Server is your homeserver (eg https://matrix.org) |
| 109 | |
| 110 | - Setting: **REQUIRED** |
| 111 | - Format: *string* |
| 112 | - Example: |
| 113 | ```toml |
| 114 | Server="https://matrix.org" |
| 115 | ``` |
| 116 | |
| 117 | ## SessionFile |
| 118 | |
| 119 | The database file to use when accessing E2EE encryption in an encryption database. |
| 120 | |
| 121 | Unless this option is set, the Matrix client is unencrypted. |
| 122 | |
| 123 | - Setting: **OPTIONAL** |
| 124 | - Format: *string* |
| 125 | - Example: |
| 126 | ```toml |
| 127 | SessionFile="yourdatabasefile.db" |
| 128 | ``` |
| 129 | |
| 130 | ## UseUserName |
| 131 | |
| 132 | Shows the username instead of the displayname |
| 133 | |
| 134 | - Setting: **OPTIONAL**, **RELOADABLE** |
| 135 | - Format: *boolean* |
| 136 | - Example: |
| 137 | ```toml |
| 138 | UseUserName=true |
| 139 | ``` |
| 140 | |
