/[cvs]/eggdrop1.9/doc/settings/CORE
ViewVC logotype

Contents of /eggdrop1.9/doc/settings/CORE

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.2 - (show annotations) (download)
Thu Dec 11 00:49:10 2003 UTC (16 years, 8 months ago) by wcc
Branch: MAIN
CVS Tags: HEAD
Changes since 1.1: +1 -1 lines
* 2004 copyright.

1 Eggdrop Core Settings
2 Last revised: Feburary 03, 2003
3 _________________________________________________________________
4
5 Eggdrop Core Settings
6
7
8 This file describes the syntax and all the settings of your Eggdrop
9 configuration file. Please note that you don't need to set all of these
10 variables to make your bot work properly.
11
12
13 ##### EXECUTABLE PATH #####
14
15
16 The first line in an Eggdrop configuration file should contain
17 a fully qualified path to your Eggdrop executable. It has to be
18 implemented in the way the example shows to make the config file
19 work as a shell script.
20
21 Example:
22
23 #! /path/to/eggdrop
24
25
26 ##### BASIC STUFF #####
27
28 You can change the basic Eggdrop appearance and behavior in this section.
29
30 set myname "LamestBot"
31 This is used to identify the bot. You MUST set this.
32
33
34 set username "lamest"
35 This setting defines the username the bot uses on IRC. This setting has
36 no effect if an ident daemon is running on your bot's machine.
37
38
39 set admin "Lamer <email: lamer@lamest.lame.org>"
40 This setting defines which contact person should be shown in .status,
41 /msg help, and other places. You really should include this information.
42
43
44 set network "SomeIrcNetwork"
45 This setting is used only for info to share with others on your botnet.
46 Set this to the IRC network your bot is connected to.
47
48
49 set dcc_command_chars "./"
50 These characters at the beginning of text signify a command on the
51 partyline.
52
53
54 set timezone "EST"
55 This setting defines the timezone is your bot in. It's used for internal
56 routines as well as for logfile timestamping and scripting purposes.
57 The timezone string specifies the name of the timezone and must be three
58 or more alphabetic characters. For example, Central European Time(UTC+1)
59 should be "CET".
60
61
62 set offset "5"
63 The offset setting specifies the time value to be added to the local
64 time to get Coordinated Universal Time (UTC aka GMT). The offset is
65 positive if the local timezone is west of the Prime Meridian and
66 negative if it is east. The value (in hours) must be between -23 and
67 23. For example, if the timezone is UTC+1, the offset is -1.
68
69
70 set env(TZ) "$timezone $offset" (disabled by default)
71 If you don't want to use the timezone setting for scripting purposes only,
72 but instead everywhere possible, then use this setting.
73
74
75 set my_ip "99.99.0.0"
76 set my_ip6 "3ffe:1337::1"
77 If you're using virtual hosting (your machine has more than 1 IP), you may
78 want to specify the particular IP to bind to. my_ip will be used for IPv4
79 hosts, and my_ip6 will be used for IPv6 hosts.
80
81
82 ##### LOG FILES #####
83
84 Eggdrop is capable of logging various things, from channel chatter to
85 partyline commands and file transfers.
86
87 Logfiles are normally kept for 24 hours. Afterwards, they will be renamed
88 to "(logfilename).yesterday". After 48 hours, they will be overwritten by
89 the logfile of the next day.
90
91
92 set max_logsize 0
93 This is the maximum size of your logfiles. Set it to 0 to disable.
94 This value is in kilobytes, so '550' would mean cycle logs when it
95 reaches the size of 550 kilobytes. Note that this only works if you
96 have keep-all-logs set to 0 (OFF).
97
98
99 set quick_logs 0
100 This could be good if you have had a problem with logfiles filling
101 your quota/hard disk or if you log +p and publish it to the web, and
102 you need more up-to-date info. Note that this setting might increase
103 the CPU usage of your bot (on the other hand it will decrease your RAM
104 usage).
105
106 set raw_log 0
107 This setting allows you the logging of raw incoming server traffic via
108 console/log flag 'r', raw outgoing server traffic via console/log mode 'v',
109 raw botnet traffic via console/log mode 't', and raw share traffic via
110 console/log mode 'h'. These flags can create a large security hole,
111 allowing people to see user passwords. This is now restricted to +n users
112 only. Please choose your owners with care.
113
114 logfile <logflags> <channel> "logs/logfile"
115 This setting tells the bot what should be logged, from where, and to
116 which file.
117
118 Logfile flags:
119 b - information about bot linking and userfile sharing
120 c - commands
121 d - misc debug information
122 h - raw share traffic
123 j - joins, parts, quits, and netsplits on the channel
124 k - kicks, bans, and mode changes on the channel
125 m - private msgs, notices and ctcps to the bot
126 o - misc info, errors, etc (IMPORTANT STUFF)
127 p - public text on the channel
128 r - raw incoming server traffic
129 s - server connects, disconnects, and notices
130 t - raw botnet traffic
131 v - raw outgoing server traffic
132 w - wallops (make sure the bot sets +w in init-server)
133 x - file transfers and file-area commands
134
135 Note that modes d, h, r, t, and v can fill disk quotas quickly. There are
136 also eight user-defined levels (1-8) which can be used by Tcl scripts.
137
138 Each logfile belongs to a certain channel. Events of type 'k', 'j', and 'p'
139 are logged to whatever channel they happened on. Most other events are
140 currently logged to every channel. You can make a logfile belong to all
141 channels by assigning it to channel "*".
142
143 Examples:
144
145 logfile mco * "logs/eggdrop.log"
146 logfile jpk #lamest "logs/lamest.log"
147
148 In 'eggdrop.log', put private msgs/ctcps, commands, misc info, and errors
149 from any channel.
150
151 In 'lamest.log', log all joins, parts, kicks, bans, public chatter, and
152 mode changes from #lamest.
153
154
155 set keep_all_logs 0
156 If you want to keep your logfiles forever, turn this setting on. All
157 logfiles will get the suffix
158 ".[day, 2 digits][month, 3 letters][year, 4 digits]". Note that your
159 quota/hard-disk might be filled by this, so check your logfiles
160 often and download them.
161
162
163 set logfile_suffix ".%d%b%Y"
164 If keep_all_logs is 1, this setting will define the suffix of the logfiles.
165 The default will result in a suffix like "04May2000". "%Y%m%d" will produce
166 the often used yyyymmdd format. Read the strftime manpages for more options.
167 NOTE: On systems which don't support strftime, the default format will
168 be used _always_.
169
170
171 set switch_logfiles_at 300
172 You can specify when Eggdrop should switch logfiles and start fresh.
173 use military time for this setting. 300 is the default, and describes
174 03:00 (AM).
175
176
177 ##### CONSOLE #####
178
179 set console "mkcobxs"
180 This is the default console mode. It uses the same event flags as the log
181 files do. The console channel is automatically set to your "primary" channel,
182 which is set in the modules section of the config file. Masters can change
183 their console channel and modes with the '.console' command.
184
185
186
187 ##### FILES AND DIRECTORIES #####
188
189 set userfile "LamestBot.user"
190 Specify here the filename your userfile should be saved as.
191
192
193 set pidfile "pid.LamestBot"
194 Specify here the filename Eggdrop will save its pid to. If no pidfile is
195 specified, pid.(myname) will be used.
196
197
198 set help_path "help/"
199 Specify here where Eggdrop should look for help files. Don't modify this
200 setting unless you know what you're doing!
201
202
203 set text_path "text/"
204 Specify here where Eggdrop should look for text files. This is used for
205 certain Tcl and DCC commands.
206
207
208 set temp_path "/tmp"
209 Set here a place to store temporary files.
210
211
212 set motd "text/motd"
213 The MOTD (Message Of The day) is displayed when people dcc chat or telnet
214 to the bot. Look at doc/text-substitutions.doc for options.
215
216
217 set telnet_banner "text/banner"
218 This banner will be displayed on telnet connections. Look at
219 doc/text-substitutions.doc for options.
220
221
222 set userfile_perm 0600
223 This specifies what permissions the user, channel, and notes files should be set to.
224 The octal values are the same as for the chmod system command.
225
226 To remind you:
227
228 u g o u g o u g o
229 0600 rw------- 0400 r-------- 0200 -w------- u - user
230 0660 rw-rw---- 0440 r--r----- 0220 -w--w---- g - group
231 0666 rw-rw-rw- 0444 r--r--r-- 0222 -w--w--w- o - others
232
233 Note that the default 0600 is the most secure one and should only be
234 changed if you need your files for shell scripting or other external
235 applications.
236
237
238 set mod_path "modules/"
239 This path specifies the path were Eggdrop should look for its modules.
240 If you run the bot from the compilation directory, you will want to set
241 this to "". If you use 'make install' (like all good kiddies do ;), this
242 is a fine default. Otherwise, use your head :).
243
244
245
246 ##### DCC/NETWORK #####
247
248 listen <port> <mode>
249 The listen command opens a telnet port by which you or other bots can
250 interact with the Eggdrop by telneting in.
251
252 Valid ports are typically anything between 1025 and 65535 assuming the
253 port is not already in use.
254
255 Valid modes are 'all', 'bots', and 'users'. You can assign special ports
256 for users and bots, or one for all.
257
258 Examples:
259
260 listen 3333 bots
261 listen 4444 users
262
263 Or:
264
265 listen 3333 all
266
267 There are more options for the listen command in doc/tcl-commands.doc.
268 Note that if you are running more than one bot on the same machine, you
269 will want to space the telnet ports at LEAST 5 apart. 10 is even better.
270
271
272 set protect_telnet 0
273 This setting will drop telnet connections not matching a known host. It
274 greatly improves protection from IRCops, but makes it impossible to add
275 hosts on limbo (NOIRC) bots or have NEW as a valid login.
276
277
278 set ident_timeout 5
279 This settings defines a time in seconds that the bot should wait before
280 a dcc chat, telnet, or relay connection times out.
281
282
283 set connect_timeout 15
284 This settings defines a time in seconds that the bot should wait before
285 a dcc chat, telnet, or relay connection times out.
286
287
288 set dcc_flood_thr 3
289 Specify here the number of lines to accept from a user on the partyline
290 within 1 second before they are considered to be flooding and therefore
291 get booted.
292
293
294 set telnet_flood 5:60
295 Define here how many telnet connection attempts in how many seconds from
296 the same host constitute a flood. The correct format is Attempts:Seconds.
297
298
299 set paranoid_telnet_flood 1
300 If you want telnet-flood to apply even to +f users, set this setting to 1.
301
302
303 set resolve_timeout 15
304 Set here the amount of seconds before giving up on hostname/address
305 lookup (you might want to increase this if you are on a slow network).
306
307
308
309 ##### MORE ADVANCED SETTINGS #####
310
311 set firewall "!sun-barr.ebay:3666"
312 Set this to your socks host if your Eggdrop sits behind a firewall. If
313 you use a Sun "telnet passthru" firewall, prefix the host with a "!".
314
315
316 set nat-ip "127.0.0.1"
317 If you have a NAT firewall (you box has an IP in one of the following
318 ranges: 192.168.0.0-192.168.255.255, 172.16.0.0-172.31.255.255,
319 10.0.0.0-10.255.255.255 and your firewall transparently changes your
320 address to a unique address for your box) or you have IP masquerading
321 between you and the rest of the world, and /dcc chat, /ctcp chat or
322 userfile sharing aren't working, enter your outside IP here. Do not
323 enter anything for my_ip if you use this setting.
324
325
326 set reserved_portrange 2010:2020
327 If you want all dcc file transfers to use a particular portrange either
328 because you're behind a firewall, or for other security reasons, set it
329 here.
330
331
332 set ignore_time 15
333 Set the time in minutes that temporary ignores should last.
334
335
336 set hourly_updates 00
337 Define here what Eggdrop considers 'hourly'. All calls to it, including such
338 things as note notifying or userfile saving, are affected by this.
339
340 Example:
341
342 set hourly_updates 15
343
344 The bot will save its userfile 15 minutes past every hour.
345
346
347 set owner "MrLame, MrsLame"
348 Un-comment this line and set the list of owners of the bot.
349 You NEED to change this setting.
350
351
352 set notify_newusers "$owner"
353 Who should a note be sent to when new users are learned?
354
355
356 set default_flags "hp"
357 Enter the flags that all new users should get by default. See '.help
358 whois' on the partyline for a list of flags and their descriptions.
359
360
361 set whois_fields "url birthday"
362 Enter all user-defined fields that should be displayed in a '.whois'.
363 This will only be shown if the user has one of these extra fields.
364 You might prefer to comment this out and use the userinfo1.0.tcl script
365 which provides commands for changing all of these.
366
367
368 set die_on_sighup 0
369 Enable this setting if you want your Eggdrop to die upon receiving a SIGHUP
370 kill signal. Otherwise, the Eggdrop will just save its userfile and rehash.
371
372
373 set die_on_sigterm 0
374 Enable this setting if you want your Eggdrop to die upon receiving a SIGTERM
375 kill signal. Otherwise, the Eggdrop will just save its userfile and rehash.
376
377
378 unbind dcc n tcl *dcc:tcl
379 unbind dcc n set *dcc:set
380 Comment these two lines if you wish to enable the .tcl and .set commands.
381 If you select your owners wisely, you should be okay enabling these.
382
383
384 unbind dcc n simul *dcc:simul
385 Comment out this line to add the 'simul' partyline command (owners
386 can manipulate other people on the party line). Please select owners
387 wisely and use this command ethically!
388
389
390 set max_dcc 50
391 Set here the maximum number of dcc connections you will allow. You can
392 increase this later, but never decrease it.
393
394
395 set dupwait_timeout 5
396 If your Eggdrop rejects bots that actually have already disconnected from
397 another hub, but the disconnect information has not yet spread over the
398 botnet due to lag, use this setting. The bot will wait dupwait-timeout
399 seconds before it checks again and then finally reject the bot.
400
401
402
403 ##### MODULES #####
404
405 After the core settings, you should start loading modules. Modules are
406 loaded by the command "loadmodule <module>". Eggdrop looks for modules in
407 the directory you specified by the module-path setting in the files and
408 directories section.
409
410 Please note that for different configurations, different modules are needed.
411 Four examples:
412
413 Channel Security Bot:
414 This bot needs the channels, blowfish, console, dns, irc, and (if you
415 like) ctcp modules loaded. More is not needed and makes the bot slower.
416
417 Public IRC Bot:
418 A public bot should have all modules available loaded since they provide
419 all functions for everyday use.
420
421 Secure Filesys Bot:
422 This bot needs all normal IRC operating modules, but not the notes, seen,
423 ctcp or share modules.
424
425 Limbo Bot:
426 A limbo bot (serves as a botnet hub outside IRC) just needs the channels,
427 console, dns, and maybe notes or share modules loaded. Of course, blowfish
428 needs to be loaded here, too.
429
430
431
432 ##### SCRIPTS #####
433
434 The scripts section should be placed at the end of the config file. All modules
435 should be loaded and their variables should be set at this point.
436
437 source scripts/script.tcl
438 This line loads script.tcl from the scripts directory inside your Eggdrop's
439 directory. All scripts should be put there, although you can place them where
440 you like as long as you can supply a fully qualified path to them.
441
442 Some commonly loaded scripts are alltools.tcl and action.fix.tcl.
443
444 The appropriate source lines are:
445
446 source scripts/alltools.tcl
447 source scripts/action.fix.tcl
448 _________________________________________________________________
449
450 Copyright (C) 2000, 2001, 2002, 2003, 2004 Eggheads Development Team

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23