1%{help=set botnet-nick}%{+n} 2### %bset botnet-nick%b <nickname> 3 If you want to use a different nickname on the botnet than you 4 use on IRC (i.e. if you're on an un-trusted botnet), set this 5 setting to the nick you would like to use. 6%{help=set userfile}%{+n} 7### %bset userfile%b <filename> 8 Specify here the filename your userfile should be saved as. 9%{help=set motd}%{+n} 10### %bset motd%b <filename> 11 The MOTD (Message Of The day) is displayed when people dcc chat or 12 telnet to the bot. Look at doc/TEXT-SUBSTITUTIONS for options. 13%{help=set telnet-banner}%{+n} 14### %bset telnet-banner%b <filename> 15 This banner will be displayed on telnet connections. Look at 16 doc/TEXT-SUBSTITUTIONS for options. 17%{help=set admin}%{+n} 18### %bset admin%b <admin-info> 19 This setting defines which contact person should be shown in 20 .status, /msg help, and other places. You really should include 21 this information. 22%{help=set notify-newusers}%{+n} 23### %bset notify-newusers%b <nickname-list> 24 Who should a note be sent to when new users are learned? 25%{help=set owner}%{+n} 26### %bset owner%b <nickname-list> 27 This is a list of owners of the bot. 28%{help=set vhost4}%{+n} 29### %bset vhost4%b <ipv4-address|hostname> 30 If you're using virtual hosting (your machine has more than 1 IP), 31 you may want to set this to a particular IP to bind to. You can 32 specify either by hostname or by IP. Note that this is not used for 33 listening. Use the listen-addr variable to specify the listening 34 address. 35%{help=set vhost6}%{+n} 36### %bset vhost6%b <ipv6-address|hostname> 37 IPv6 vhost to bind to for outgoing IPv6 connections. You can set it 38 to any valid IPv6 address or hostname, resolving to an IPv6 address. 39 Note that this is not used for listening. Use the listen-addr 40 variable to specify the listening address. 41%{help=set nat-ip}%{+n} 42### %bset nat-ip%b <ip-address> 43 If you have a NAT firewall (you box has an IP in one of the 44 following ranges: 192.168.0.0-192.168.255.255, 45 172.16.0.0-172.31.255.255, 10.0.0.0-10.255.255.255 and your 46 firewall transparently changes your address to a unique address 47 for your box) or you have IP masquerading between you and the 48 rest of the world, and /dcc chat, /ctcp chat or userfile sharing 49 aren't working, enter your outside IP here. This IP is used for 50 transfers only, and has nothing to do with the vhost4/6 or 51 listen-addr settings. You may still need to set them. 52%{help=set listen-addr}%{+n} 53### %bset listen-addr%b <ip-address/hostname> 54 You can specify a particular IPv4/IPv6 address (or hostname) 55 to bind for listening, e.g. for the 'listen' tcl command or 56 for file sending. 57%{help=set prefer-ipv6}%{+n} 58### %bset prefer-ipv6%b <0/1> 59 Prefer IPv6 over IPv4 for connections and dns resolution. 60 If the preferred protocol family is not supported, the other 61 one will be tried. 62%{help=set dcc-sanitycheck}%{+n} 63### %bset dcc-sanitycheck%b <0/1> 64 This setting will make the bot ignore DCC chat requests which 65 appear to have bogus information on the grounds that the user may 66 have been trying to make the bot connect to somewhere that will 67 get it into trouble, or that the user has a broken client, in 68 which case the connect wouldn't work anyway. 69%{help=set network}%{+n} 70### %bset network%b <net-name> 71 This setting is used only for info to share with others on your 72 botnet. Set this to the IRC network your bot is connected to. 73%{help=set whois-fields}%{+n} 74### %bset whois-fields%b <field-list> 75 Enter all user-defined fields that should be displayed in a 76 '.whois'. This will only be shown if the user has one of these 77 extra fields. You might prefer to comment this out and use the 78 userinfo1.0.tcl script which provides commands for changing all 79 of these. 80%{help=set username}%{+n} 81### %bset username%b <username> 82 This setting defines the username the bot uses on IRC. This setting 83 has no effect if an ident daemon is running on your bot's machine. 84%{help=set version}%{+n} 85### %bset version%b 86 Current bot version - "1.1.2+pl1 1010201 pl1"; first item is the 87 text version, second item is a numerical version, and any following 88 items are the names of patches that have been added. 89%{help=set firewall}%{+n} 90### %bset firewall%b <host:port> 91 Set this to your socks host if your Eggdrop sits behind a 92 firewall. If you use a Sun "telnet passthru" firewall, prefix 93 the host with a '!'. 94%{help=set telnet-flood}%{+n} 95### %bset telnet-flood%b <times:seconds> 96 Define here how many telnet connection attempts in how many 97 seconds from the same host constitute a flood. The correct 98 format is Attempts:Seconds. 99%{help=set paranoid-telnet-flood}%{+n} 100### %bset paranoid-telnet-flood%b <0/1> 101 If you want telnet-flood to apply even to +f users, set this 102 setting to 1. 103%{help=set ignore-time}%{+n} 104### %bset ignore-time%b <time> 105 The time in minutes that temporary ignores should last. 106%{help=set dcc-flood-thr}%{+n} 107### %bset dcc-flood-thr%b <number> 108 Specify here the number of lines to accept from a user on the 109 partyline within 1 second before they are considered to be 110 flooding and therefore get booted. 111%{help=set hourly-updates}%{+n} 112### %bset hourly-updates%b <military time> 113 Define here what Eggdrop considers 'hourly'. All calls to it, 114 including such things as note notifying or userfile saving, are 115 affected by this. 116%{help=set switch-logfiles-at}%{+n} 117### %bset switch-logfiles-at%b <military-time> 118 You can specify when Eggdrop should switch logfiles and start 119 fresh. You must use military time for this setting. 300 is the 120 default, and describes 03:00 (AM). 121%{help=set connect-timeout}%{+n} 122### %bset connect-timeout%b <seconds> 123 This setting defines a time in seconds that the bot should 124 wait before a dcc chat, telnet, or relay connection times out. 125%{help=set resolve-timeout}%{+n} 126### %bset resolve-timeout%b <seconds> 127 Set here the amount of seconds before giving up on hostname/address 128 lookup (you might want to increase this if you are on a slow network). 129 The default is RES_TIMEOUT, which is generally 5, the allowed maximum is 130 RES_MAXRETRANS (see <resolv.h>). 131%{help=set dupwait-timeout}%{+n} 132### %bset dupwait-timeout%b <seconds> 133 If your Eggdrop rejects bots that actually have already 134 disconnected from another hub, but the disconnect information has 135 not yet spread over the botnet due to lag, use this setting. The 136 bot will wait dupwait-timeout seconds before it checks again and 137 then finally reject the bot. 138%{help=set reserved-portrange}%{+n} 139### %bset reserved-portrange%b <lowport>:<highport> 140 If you want all dcc file transfers to use a particular portrange 141 either because you're behind a firewall, or for other security 142 reasons, set it here. 143%{help=set require-p}%{+n} 144### %bset require-p%b <0/1> 145 Define here whether or not a +o user still needs the +p flag to 146 dcc the bot. 147%{help=set keep-all-logs}%{+n} 148### %bset keep-all-logs%b <0/1> 149 If you want to keep your logfiles forever, turn this setting on. 150 All logfiles will get suffix 151 ".[2 digit day][3 letter month][4 digit year]". Note that your 152 quota/hard-disk might be filled by this, so check your logfiles 153 often and download them. 154%{help=set open-telnets}%{+n} 155### %bset open-telnets%b <0/1> 156 If you want people allow to telnet in and type 'NEW' to become a 157 new user, set this to 1. This is similar to the 'hello' msg 158 command. The protect-telnet setting must be set to 0 to use this. 159%{help=set stealth-telnets}%{+n} 160### %bset stealth-telnets%b <0/1> 161 If you don't want Eggdrop to identify itself as an eggdrop on a 162 telnet connection, set this setting to 1. Eggdrop will display a 163 logon prompt with only the contents of the stealth-prompt setting. 164%{help=set stealth-prompt}%{+n} 165### %bset stealth-prompt%b <string> 166 If stealth-telnets is 1, the string in this setting will replace 167 the traditional Eggdrop banner. 168%{help=set use-telnet-banner}%{+n} 169### %bset use-telnet-banner%b <0/1> 170 If you want Eggdrop to display a banner when telneting in, set 171 this setting to 1. The telnet banner is set by 'set telnet-banner'. 172%{help=set handlen}%{+n} 173### %bset handlen%b 174 This is the max length handles may be on the bot. 175%{help=set console}%{+n} 176### %bset console%b <console-flags> 177 This is the default console mode. It uses the same event flags 178 as the log files do. The console channel is automatically set to 179 your "primary" channel, which is set in the modules section of 180 the config file. Masters can change their console channel and modes 181 with the '.console' command. 182%{help=set default-flags}%{+n} 183### %bset default-flags%b <flags> 184 Enter the flags that all new users should get by default. See 185 '.help whois' on the partyline for a list of flags and their 186 descriptions. 187%{help=set log-time}%{+n} 188### %bset log-time%b <0/1> 189 Use this feature to timestamp entries in the log file. 190%{help=set timestamp-format}%{+n} 191### %bset timestamp-format%b <format> 192 Set the following to the timestamp for the logfile entries. Popular 193 times might be "[%H:%M]" (hour,min), or "[%H:%M:%S]" (hour, min, sec). 194 Read `man strftime' for more formatting options. Keep it below 32 195 chars. 196%{help=set max-logsize}%{+n} 197### %bset max-logsize%b <filesize> 198 This is the maximum size of your logfiles. Set it to 0 to disable. 199 This value is in kilobytes, so '550' would mean cycle logs when it 200 reaches the size of 550 kilobytes. Note that this only works if you 201 have keep-all-logs 0 (OFF). 202%{help=set quick-logs}%{+n} 203### %bset quick-logs%b <0/1> 204 This could be good if you have had problem with the logfile 205 filling your quota/hard disk or if you log +p and publish it to 206 the web and need more up-to-date info. Note that this setting 207 might increase the CPU usage of your bot (on the other hand it will 208 decrease your mem usage). 209%{help=set logfile-suffix}%{+n} 210### %bset logfile-suffix%b <suffix> 211 If keep-all-logs is 1, this setting will define the suffix of the 212 logfiles. The default will result in a suffix like "04May2000". 213 "%Y%m%d" will produce the often used yyyymmdd format. Read the 214 strftime manpages for more options. NOTE: On systems which don't 215 support strftime, the default format will be used _always_. 216%{help=set quiet-save}%{+n} 217### %bset quiet-save%b <0/1/2/3> 218 "Writing user file..." and "Writing channel file..." messages won't 219 be logged anymore if this option is enabled. If you set it to 2, the 220 "Backing up user file..." and "Backing up channel file..." messages 221 will also not be logged. In addition to this, you can disable the 222 "Switching logfiles..." and the new date message at midnight, by 223 setting this to 3. 224%{help=set remote-boots}%{+n} 225### %bset remote-boots%b <0/1> 226 This setting defines whether or not people can boot users on the 227 Eggdrop from other bots in your botnet. Valid settings are: 228 0 - allow *no* outside boots 229 1 - allow boots from sharebots 230 2 - allow any boots 231%{help=set max-socks}%{+n} 232### %bset max-socks%b <max dcc connections> 233 Set here the maximum number of socket connections you will allow. You can 234 increase this later, but never decrease it below current usage. If you're 235 using Tcl threads, this is a per-thread maximum. 236%{help=set max-logs}%{+n} 237### %bset max-logs%b <max number of logs> 238 This is the maximum number of logfiles allowed. This setting 239 can be increased; however, don't decrease it. 240%{help=set protect-telnet}%{+n} 241### %bset protect-telnet%b <0/1> 242 This setting will drop telnet connections not matching a known 243 host. 244%{help=set ident-timeout}%{+n} 245### %bset ident-timeout%b <timeout> 246 This setting defines the time in seconds the bot should wait for ident 247 reply before the lookup fails. The default ident on timeout is 'telnet'. 248%{help=set share-unlinks}%{+n} 249### %bset share-unlinks%b 0/1 250 This setting prohibits remote bots from telling your Eggdrop to 251 unlink from share bots. 252%{help=set cidr-support}%{+n} 253### %bset cidr-support%b <0/1> 254 Enables cidr support for b/e/I modes if set to 1. This means the 255 bot will understand and match modes in cidr notation, and will 256 be able to put and enforce such bans or unban itself, if banned 257 with a cidr mask. 258 Warning: enabling this on servers which don't support cidr may 259 result in kick floods or other problems. 260%{help=set allow-dk-cmds}%{+n} 261### %bset allow-dk-cmds%b <0/1> 262 Enable this setting if you want +d & +k users to use commands 263 bound as -|-. 264%{help=set userfile-perm}%{+n} 265### %bset userfile-perm%b <octal value> 266 This specifies what permissions the user, channel, and notes 267 files should be set to. The octal values are the same as for 268 the chmod system command. 269%{help=set ssl-certificate}%{+n} 270### %bset ssl-certificate%b <filename> 271 Specify the filename where your SSL certificate is located. If 272 you don't set this, eggdrop will not be able to act as a server 273 in SSL connections, as with most ciphers a certificate and a 274 private key are required on the server side. Must be in PEM 275 format. 276%{help=set ssl-privatekey}%{+n} 277### %bset ssl-privatekey%b <filename> 278 File containing your private RSA key used for SSL connections. 279%{help=set ssl-verify-depth}%{+n} 280### %bset ssl-verify-depth%b <depth> 281 Sets the maximum depth for the certificate chain verification 282 that will be allowed for ssl. When certificate verification is 283 enabled, any chain exceeding this depth will fail verification. 284%{help=set ssl-capath}%{+n} 285### %bset ssl-capath%b <directory> 286 Specify the location where CA certificates for verification 287 purposes are located. These certificates are trusted. If you 288 don't set this or ssl-cafile, certificate verification will not 289 work. 290 291See also: ssl-cafile 292%{help=set ssl-cafile}%{+n} 293### %bset ssl-cafile%b <filename> 294 Specify a file which contains CA certificates for verification 295 purposes. These certificates are trusted. If you don't set this 296 or ssl-capath, certificate verification will not work. 297 298See also: set ssl-capath 299%{help=set ssl-protocols}%{+n} 300### %bset ssl-protocols%b <protocol list> 301 Specify the list of protocols allowed for use with ssl. The protocol list 302 is one or more protocol strings separated by spaces. Available protocols 303 are SSLv2, SSLv3, TLSv1, TLSv1.1, TLSv1.2, TLSv1.3. Default is 304 "TLSv1 TLSv1.1 TLSv1.2 TLSv1.3". 305%{help=set ssl-dhparam}%{+n} 306### %bset ssl-dhparam%b <filename> 307 Specify dhparam filename. You can create it using the following command: 308 openssl dhparam -out dhparam.pem 4096 309%{help=set ssl-ciphers}%{+n} 310### %bset ssl-ciphers%b <cipher list> 311 Specify the list of ciphers (in order of preference) allowed for 312 use with ssl. The cipher list is one or more cipher strings 313 separated by colons, commas or spaces. Unavailable ciphers are 314 silently ignored unless no usable cipher could be found. For the 315 list of possible cipher strings and their meanings, please refer 316 to the ciphers(1) manual. 317 If you set this, the value replaces any ciphers OpenSSL might use 318 by default. To include the default ciphers, you can put DEFAULT 319 as a cipher string in the list. This setting may not impact TLSv1.3 320 ciphersuites. 321%{help=set ssl-cert-auth}%{+n} 322### %bset ssl-cert-auth%b <0/1/2> 323 Enable certificate authorization. Set to 1 to allow users and bots 324 to identify automatically by their certificate fingerprints. Setting 325 it to 2 to will force fingerprint logins. With a value of 2, users 326 without a fingerprint set or with a certificate UID not matching 327 their handle won't be allowed to login on SSL enabled telnet ports. 328 Fingerprints must be set in advance with the .fprint and .chfinger 329 commands. 330 NOTE: this setting has no effect on plain-text ports. 331%{help=set ssl-verify-dcc}%{+n} 332### %bset ssl-verify-dcc%b <#> 333 Control certificate verification for DCC chats (/dcc chat botnick) 334 335See also: set ssl-verify-clients 336%{help=set ssl-verify-bots}%{+n} 337### %bset ssl-verify-bots%b <#> 338 Control certificate verification for linking to hubs 339 340See also: set ssl-verify-clients 341%{help=set ssl-verify-clients}%{+n} 342### %bset ssl-verify-clients%b <#> 343 Control cerfificate verification for SSL listening ports. This includes 344 leaf bots connecting to us, users telneting in and /ctcp bot chat. 345 You can set this by adding together the numbers for all exceptions you 346 want to enable. By default certificate verification is disabled and all 347 certificates are assumed to be valid. 348 There are the following exceptions with their corresponding numbers: 349 1 enable certificate verification 350 2 allow self-signed certificates 351 4 don't check peer common or alt names 352 8 allow expired certificates 353 16 allow certificates which are not valid yet 354 32 allow revoked certificates 355