Thumbnail
/ rani matterbridge.git

rani/matterbridge.git

Clone URL: https://git.buni.party/rani/matterbridge.git

Info Tree Commits Branches Tags Show Grep RSS

Viewing file on branch master

/ docs protocols irc settings.md
1# IRC settings
2
3> [!TIP]
4> This page contains the details about IRC settings. More general information about IRC support in matterbridge can be found in [README.md](README.md).
5
6## Charset
7
8If you know your charset, you can specify it manually. Otherwise it tries to detect this automatically.
9
10The selected charset will be converted to utf-8 when sent to other bridges.
11
12- Setting: **OPTIONAL**
13- Format: *string*
14- Example:
15 ```toml
16 Charset="utf-8"
17 ```
18
19## ColorNicks
20
21ColorNicks will show each nickname in a different color.
22Only works in IRC right now.
23
24- Setting: **OPTIONAL**, **RELOADABLE**
25- Format: *boolean*
26- Example:
27 ```toml
28 ColorNicks=true
29 ```
30
31## DebugLevel
32
33Debug log verbosity.
34
35- Setting: **OPTIONAL**
36- Default: *0*
37- Format: *int*
38- Example:
39 ```toml
40 DebugLevel=1
41 ```
42
43## JoinDelay
44
45Delay in milliseconds between channel joins.
46Only useful when you have a LOT of channels to join.
47
48- Setting: **OPTIONAL**, **RELOADABLE**
49- Default: *0*
50- Format: *int*
51- Example:
52 ```toml
53 JoinDelay=1000
54 ```
55
56## MessageDelay
57
58Flood control.
59Delay in milliseconds between each message send to the IRC server.
60
61- Setting: **OPTIONAL**, **RELOADABLE**
62- Default: *1300*
63- Format: *int*
64- Example:
65 ```toml
66 MessageDelay=1300
67 ```
68
69## MessageLength
70
71Maximum length of message sent to irc server. If it exceeds
72`<message clipped>` will be add to the message.
73
74- Setting: **OPTIONAL**, **RELOADABLE**
75- Default: *400*
76- Format: *int*
77- Example:
78 ```toml
79 MessageLength=400
80 ```
81
82## MessageQueue
83
84Maximum amount of messages to hold in queue. If queue is full
85messages will be dropped.
86`<message clipped>` will be add to the message that fills the queue.
87
88- Setting: **OPTIONAL**, **RELOADABLE**
89- Default: *30*
90- Format: *int*
91- Example:
92 ```toml
93 MessageQueue=30
94 ```
95
96## MessageSplit
97Split messages on `MessageLength` instead of showing the `<message clipped>`
98WARNING: this could lead to flooding
99
100- Setting: **OPTIONAL**, **RELOADABLE**
101- Format: *boolean*
102- Example:
103 ```toml
104 MessageSplit=true
105 ```
106
107## Nick *
108Your nick on irc.
109
110- Setting: REQUIRED
111- Format: *string*
112- Example:
113 ```toml
114 Nick="matterbot"
115 ```
116
117## NickServNick
118If you registered your bot with a service like Nickserv on freenode.
119Also being used when `UseSASL=true`
120Note: when `UseSASL=true`, this is the name of *your* account.
121Note: if you want do to quakenet auth, set NickServNick="Q@CServe.quakenet.org"
122
123- Setting: **OPTIONAL**
124- Format: *string*
125- Example:
126 ```toml
127 NickServNick="nickserv"
128 ```
129
130## NickServPassword
131The password you use if you registered your bot with a service like Nickserv on freenode.
132Also being used when `UseSASL=true`
133Also see `NickServNick`
134
135- Setting: **OPTIONAL**
136- Format: *string*
137- Example:
138 ```toml
139 NickServPassword="secret"
140 ```
141
142## NickServUsername
143Only used for quakenet auth.
144See https://github.com/42wim/matterbridge/issues/263 for more info
145
146- Setting: **OPTIONAL**
147- Format: *string*
148- Example:
149 ```toml
150 NickServUsername="username"
151 ```
152
153## NoSendJoinPart
154Do not send joins/parts to other bridges
155Currently works for messages from the following bridges: irc, mattermost, slack
156
157- Setting: **OPTIONAL**
158- Format: *boolean*
159- Example:
160 ```toml
161 NoSendJoinPart=true
162 ```
163
164## Password
165
166Password for irc server (if necessary)
167
168- Setting: **OPTIONAL**
169- Format: *string*
170- Example:
171 ```toml
172 Password="s3cret"
173 ```
174
175## Pingdelay
176
177PingDelay specifies how long to wait to send a ping to the irc server.
178You can use s for second, m for minute
179
180- Setting: **OPTIONAL**, **RELOADABLE**
181Default: "1m"
182- Example:
183 ```toml
184 PingDelay="1m"
185 ```
186
187## RejoinDelay
188Delay in seconds to rejoin a channel when kicked
189
190- Setting: **OPTIONAL**, **RELOADABLE**
191Default: 0
192- Format: *int*
193- Example:
194 ```toml
195 RejoinDelay=2
196 ```
197
198## RunCommands
199
200RunCommands allows you to send RAW irc commands after connection
201
202- Setting: **OPTIONAL**, **RELOADABLE**
203- Format: *List<string>*
204- Example:
205 ```toml
206 RunCommands=["PRIVMSG user :hello","PRIVMSG chanserv :something"]
207 ```
208
209## Server
210
211irc server to connect to.
212
213- Setting: REQUIRED
214- Format: *string* (hostname:port)
215- Example:
216 ```toml
217 Server="irc.freenode.net:6667"
218 ```
219
220## StripMarkdown
221
222Strips Markdown from messages
223
224- Setting: **OPTIONAL**
225- Format: *boolean*
226- Example:
227 ```toml
228 StripMarkdown=true
229 ```
230
231## UseSASL
232
233Enable SASL (PLAIN) authentication. (freenode requires this from eg AWS hosts)
234It uses `NickServNick` and `NickServPassword` as login and password
235
236- Setting: **OPTIONAL**
237- Format: *boolean*
238- Example:
239 ```toml
240 UseSASL=true
241 ```
242
243## UseTLS
244
245Enable to use TLS connection to your irc server.
246
247- Setting: **OPTIONAL**
248- Format: *boolean*
249- Example:
250 ```toml
251 UseTLS=true
252 ```
253
254## UseRelayMsg
255
256Enable to replace bot's nick with user's nick.
257- `RemoteNickFormat` has to contain `/`.
258The server has to support RELAYMSG.
259Bot may need to be channel operator to use RELAYMSG.
260
261- Setting: OPTIIONAL
262- Format: *boolean*
263- Example:
264 ```toml
265 UseRelayMsg=true
266 ```
267
268## VerboseJoinPart
269
270Enable to show verbose users joins/parts (ident@host) from other bridges
271Currently works for messages from the following bridges: irc
272
273- Setting: **OPTIONAL **
274- Format: *boolean*
275- Example:
276 ```toml
277 VerboseJoinPart=true
278 ```
279