| 1 | # Matterbridge API settings |
| 2 | |
| 3 | > [!TIP] |
| 4 | > This page contains the details about matterbridge API settings. More general information about the matterbridge API can be found in [README.md](README.md). |
| 5 | |
| 6 | ## BindAddress |
| 7 | |
| 8 | Address to listen on for API |
| 9 | |
| 10 | - Setting: **REQUIRED** |
| 11 | - Format: *string* |
| 12 | - Example: |
| 13 | ```toml |
| 14 | BindAddress="127.0.0.1:4242" |
| 15 | ``` |
| 16 | |
| 17 | ## Buffer |
| 18 | |
| 19 | Amount of messages to keep in memory |
| 20 | |
| 21 | - Setting: **OPTIONAL**, **RELOADABLE** |
| 22 | - Format: *int* |
| 23 | - Default: *10* |
| 24 | - Example: |
| 25 | ```toml |
| 26 | Buffer=1000 |
| 27 | ``` |
| 28 | |
| 29 | ## Token |
| 30 | |
| 31 | HTTP Bearer token used for authentication. If unset, no authentication |
| 32 | will be applied at all and anyone who can reach the API will be able |
| 33 | to control your matterbridge instance. |
| 34 | |
| 35 | - Setting: **OPTIONAL**, **RELOADABLE** |
| 36 | - Format: *string* |
| 37 | - Example: |
| 38 | ```toml |
| 39 | Token="mytoken" |
| 40 | ``` |
| 41 | |
