| 1 | # Slack settings |
| 2 | |
| 3 | > [!TIP] |
| 4 | > This page contains the details about slack settings. More general information about slack support in matterbridge can be found in [README.md](README.md). |
| 5 | |
| 6 | ## Debug |
| 7 | |
| 8 | Extra slack specific debug info, warning this generates a lot of output. |
| 9 | |
| 10 | - Setting: **OPTIONAL**, **RELOADABLE** |
| 11 | - Format: *boolean* |
| 12 | - Example: |
| 13 | ```toml |
| 14 | Debug=true |
| 15 | ``` |
| 16 | |
| 17 | ## PreserveThreading |
| 18 | |
| 19 | Opportunistically preserve threaded replies between Slack channels. |
| 20 | This only works if the parent message is still in the cache. |
| 21 | Cache is flushed between restarts. |
| 22 | Note: Not currently working on gateways with mixed bridges of |
| 23 | both slack and slack-legacy type. Context in issue #624. |
| 24 | |
| 25 | - Setting: **OPTIONAL**, **RELOADABLE** |
| 26 | - Format: *boolean* |
| 27 | - Example: |
| 28 | ```toml |
| 29 | PreserveThreading=true |
| 30 | ``` |
| 31 | |
| 32 | ## ShowUserTyping |
| 33 | |
| 34 | Enable showing "user_typing" events from across gateway when available. |
| 35 | Protip: Set your bot/user's "Full Name" to be "Someone (over chat bridge)", |
| 36 | and so the message will say "Someone (over chat bridge) is typing". |
| 37 | |
| 38 | - Setting: **OPTIONAL**, **RELOADABLE** |
| 39 | - Format: *boolean* |
| 40 | - Example: |
| 41 | ```toml |
| 42 | ShowUserTyping=true |
| 43 | ``` |
| 44 | |
| 45 | ## SyncTopic |
| 46 | |
| 47 | Enable to sync topic/purpose changes from other bridges |
| 48 | Only works syncing topic changes from slack bridge for now |
| 49 | |
| 50 | - Setting: **OPTIONAL**, **RELOADABLE** |
| 51 | - Format: *boolean* |
| 52 | - Example: |
| 53 | ```toml |
| 54 | SyncTopic=true |
| 55 | ``` |
| 56 | |
| 57 | ## Token |
| 58 | |
| 59 | Token to connect with the Slack API |
| 60 | |
| 61 | - Setting: **REQUIRED** (when not using webhooks) |
| 62 | - Format: *string* |
| 63 | - Example: |
| 64 | ```toml |
| 65 | Token="yourslacktoken" |
| 66 | ``` |
| 67 | |
| 68 | ### IconURL |
| 69 | |
| 70 | > [!WARNING] |
| 71 | > NOT RECOMMENDED TO USE INCOMING/OUTGOING WEBHOOK. |
| 72 | > USE DEDICATED BOT USER WHEN POSSIBLE! |
| 73 | |
| 74 | Icon that will be showed in slack. |
| 75 | The string "{NICK}" (case sensitive) will be replaced by the actual nick / username. |
| 76 | The string "{BRIDGE}" (case sensitive) will be replaced by the sending bridge. |
| 77 | The string "{LABEL}" (case sensitive) will be replaced by label= field of the sending bridge. |
| 78 | The string "{PROTOCOL}" (case sensitive) will be replaced by the protocol used by the bridge. |
| 79 | |
| 80 | - Setting: **OPTIONAL** |
| 81 | - Format: *string* |
| 82 | - Example: |
| 83 | ```toml |
| 84 | IconURL="https://robohash.org/{NICK}.png?size=48x48" |
| 85 | ``` |
| 86 | |
| 87 | ### WebhookBindAddress |
| 88 | |
| 89 | > [!WARNING] |
| 90 | > NOT RECOMMENDED TO USE INCOMING/OUTGOING WEBHOOK. |
| 91 | > USE DEDICATED BOT USER WHEN POSSIBLE! |
| 92 | |
| 93 | Address to listen on for outgoing webhook requests from slack. |
| 94 | See account settings - integrations - outgoing webhooks on slack |
| 95 | |
| 96 | - Setting: **OPTIONAL** |
| 97 | - Format: *string* |
| 98 | - Example: |
| 99 | ```toml |
| 100 | WebhookBindAddress="0.0.0.0:9999" |
| 101 | ``` |
| 102 | |
| 103 | ### WebhookURL |
| 104 | |
| 105 | > [!WARNING] |
| 106 | > NOT RECOMMENDED TO USE INCOMING/OUTGOING WEBHOOK. |
| 107 | > USE DEDICATED BOT USER WHEN POSSIBLE! |
| 108 | |
| 109 | Url is your incoming webhook url as specified in slack. |
| 110 | See account settings - integrations - incoming webhooks on slack |
| 111 | |
| 112 | - Setting: **OPTIONAL** |
| 113 | - Format: *string* |
| 114 | - Example: |
| 115 | ```toml |
| 116 | WebhookURL="https://hooks.slack.com/services/yourhook" |
| 117 | ``` |
| 118 | |
