-
Notifications
You must be signed in to change notification settings - Fork 1
Config File
The network configuration file stores all the settings for a particular network connection.
Defined by [Identity] header on a section and configures the bot's identity on the IRC network.
botnick = Snowboard
Specifies the bot's nick on IRC. Defaults to Snowboard
realname = Project Snowboard
Specifies the bot's real name on IRC. Defaults to Project Snowboard
Defined by [Network] header on a section.
network = Network
Specifies the name of the IRC network. Defaults to Network
servers = irc.server.com:6667
servers = ssl.server.com:+6697
servers = server1.com:6667,server2.com:6666,server3.com:+6697
Required setting. Specifies the server:port of the IRC network.
To specify an SSL connection add a '+' sign in front of the port number, as in the 2nd example line. Multiple servers are expressed through a comma separated list as in the 3rd example line.
channels = #Channel1,#Channel2,#Channel3
Required setting. Specifies the channels for the bot to join on connect.
Specifying more than one channel is done through a comma separated list as in the example above.
sslVerify = 1
Instructs the bot to verify SSL certificates or not. Defaults to 1.
A value of 1 instructs the bot to verify certificates and refuse to connect with an invalid server certificate.
A value of 0 instructs the bot to ignore certificate verification and complete the SSL connection without checking. This is a security risk and opens the possibility of a Man-in-the-Middle attack but some IRC servers are known to have certificates that won't verify. Additionally, many private IRC servers have certificates that will not verify.
Even though it is more of a security risk than a fully verified connection it does not harm the encryption of the connection itself, and some security is always better than none so long as the bots owner understands the risks.
retries = 3
Configures how many times a server should be tried before the next server in the list is used. Defaults to 3.
delay = 5
Configures how much time the bot should wait before attempting to connect again. Defaults to 5.
pingtimer = 300
Configures how much time the bot should wait (in seconds), on an idle connection, before it pings the server to verify the connection. Defaults to 300 or 5 minutes.
Ideally this should be set to more time than the servers own ping routine. Servers often employ a similar method to detect failed connections and will ping on an interval of inactivity. While there is no reason a server would mind if a connection is pinged from the client-side (the bot) on a regular basis, I would not set this to lower than 120 to avoid being a nuisance to the server.
checktimer = 300
Configures how long (in seconds) the bot will wait between cleaning up its internal master list of nicks that it has seen. Defaults to 300 or 5 minutes.
While it isn't strictly speaking required to keep track of who is actually online, this allows the bot to expire nicks off of its master list after they are not online (unless a QUIT message for that user is received). This also allows a user to stay authenticated even if they are not on any channel.
Defined by [Messages] header on a section.
quit = Project Snowboard https://github.com/dwhagar/snowboard
Configures the quit message for the bot to use when it intentionally quits IRC. Defaults to Project Snowboard https://github.com/dwhagar/snowboard.