rani/matterbridge.git

Viewing file on branch master

1	# Discord settings
2
3	> [!TIP]
4	> This page contains the details about discord settings. More general information about discord support in matterbridge can be found in [README.md](README.md).
5
6	## Server
7
8	Name or uid of your server/guild.
9
10	For example, If you want to bridge `https://discord.com/channels/AAAA/BBBB`, then this should be `AAAA`.
11
12	- Setting: REQUIRED
13	- Format: string
14	- Example:
15	```toml
16	Server="yourservername"
17	```
18
19	## Token
20
21	Token to connect with Discord API. See [account.md](account.md) for
22	instructions to generate your token. If you want roles/groups mentions to be
23	shown with names instead of ID, you'll need to give your bot the "Manage Roles"
24	permission.
25
26	- Setting: REQUIRED
27	- Format: string
28	- Example:
29	```toml
30	Token="YOUR_TOKEN_HERE"
31	```
32
33	## AllowMention
34
35	AllowMention controls which mentions are allowed.
36
37	If not specified, all mentions are allowed. Note that even when a mention is
38	not allowed, it will still be displayed nicely and be clickable. It just
39	prevents the ping/notification.
40
41	- Setting: OPTIONAL
42	- Format: List[string]
43	- Possible values:
44	- `"everyone"` allows `@everyone` and `@here` mentions
45	- `"roles"` allows `@role` mentions
46	- `"users"` allows `@user` mentions
47	- Example:
48	```toml
49	AllowMention=["everyone", "roles", "users"]
50	```
51
52	## ShowEmbeds
53
54	Shows title, description and URL of embedded messages (sent by other bots)
55
56	- Setting: OPTIONAL, RELOADABLE
57	- Format: boolean
58	- Example:
59	```toml
60	ShowEmbeds=true
61	```
62
63	## UseUserName
64
65	Shows the username instead of the server nickname
66
67	- Setting: OPTIONAL, RELOADABLE
68	- Format: boolean
69	- Example:
70	```toml
71	UseUserName=true
72	```
73
74	## UseDiscriminator
75
76	Show `#xxxx` discriminator with `UseUserName`
77
78	- Setting: OPTIONAL, RELOADABLE
79	- Format: boolean
80	- Example:
81	```toml
82	UseDiscriminator=true
83	```
84
85	## AlwaysDownloadFiles
86
87	Any uploads will be always downloaded as files and re-uploaded to the destination
88	gateway or the mediaproxy if enabled instead of forwarding URLs to Discord's CDNs.
89	By default, any file uploads from Discord gets forwarded as a list URLs to the
90	Discord CDN.
91
92	Use this if direct use of Discord CDN leads inconveniences or just unavailable
93	directly due to various reasons.
94
95	- Setting: OPTIONAL, RELOADABLE
96	- Format: boolean
97	- Example:
98	```toml
99	AlwaysDownloadFiles=true
100	```
101
102	## WebhookURL
103
104	Specify WebhookURL. If given, will relay messages using the Webhook, which
105	gives a better look to messages.
106
107	If you have multiple discord channels, it is recommended to use the
108	`AutoWebHooks` setting. Alternatively, you'll have to specify the webhook URL
109	for each gateway and not in the account configuration.
110
111	- Setting: OPTIONAL
112	- Format: string
113	- Example:
114	```toml
115	WebhookURL="Yourwebhooktokenhere"
116	```
117
118	## AutoWebhooks
119
120	Relay messages using the Webhook, which gives a better look to messages. Needs "Manage Webhooks" permission to function.
121
122	AutoWebhooks automatically configures message sending in the style of puppets.
123	This is an easier alternative to manually configuring "WebhookURL" for each gateway,
124	as turning this on will automatically load or create webhooks for each channel.
125	This feature requires the "Manage Webhooks" permission (either globally or as per-channel).
126
127
128	Setting: OPTIONAL \
129	Format: boolean \
130	Example:
131
132	```toml
133	AutoWebhooks=true
134	```
135