1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
|
<!DOCTYPE html>
<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Eggdrop Core Settings — Eggdrop 1.10.1rc2 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../_static/eggdrop.css?v=ab48a1b6" />
<script src="../_static/documentation_options.js?v=290de6c6"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="The Party Line" href="partyline.html" />
<link rel="prev" title="Eggdrop Features" href="features.html" />
</head><body>
<div class="header-wrapper" role="banner">
<div class="header">
<div class="headertitle"><a
href="../index.html">Eggdrop 1.10.1rc2 documentation</a></div>
<div class="rel" role="navigation" aria-label="related navigation">
<a href="features.html" title="Eggdrop Features"
accesskey="P">previous</a> |
<a href="partyline.html" title="The Party Line"
accesskey="N">next</a>
</div>
</div>
</div>
<div class="content-wrapper">
<div class="content">
<div class="sidebar">
<h3>Table of Contents</h3>
<p class="caption" role="heading"><span class="caption-text">Installing Eggdrop</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../install/readme.html">README</a></li>
<li class="toctree-l1"><a class="reference internal" href="../install/install.html">Installing Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="../install/upgrading.html">Upgrading Eggdrop</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Using Eggdrop</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="features.html">Eggdrop Features</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Eggdrop Core Settings</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#executable-path">Executable Path</a></li>
<li class="toctree-l2"><a class="reference internal" href="#basic-settings">Basic Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="#log-files">Log Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="#console-settings">Console Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="#file-and-directory-settings">File and Directory Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="#botnet-dcc-telnet-settings">Botnet/Dcc/Telnet Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="#advanced-settings">Advanced Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ssl-settings">SSL Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="#modules">Modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="#scripts">Scripts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="partyline.html">The Party Line</a></li>
<li class="toctree-l1"><a class="reference internal" href="autoscripts.html">Eggdrop Autoscripts</a></li>
<li class="toctree-l1"><a class="reference internal" href="users.html">Users and Flags</a></li>
<li class="toctree-l1"><a class="reference internal" href="bans.html">Bans, Invites, and Exempts</a></li>
<li class="toctree-l1"><a class="reference internal" href="botnet.html">Botnet Sharing and Linking</a></li>
<li class="toctree-l1"><a class="reference internal" href="ipv6.html">IPv6 support</a></li>
<li class="toctree-l1"><a class="reference internal" href="tls.html">TLS support</a></li>
<li class="toctree-l1"><a class="reference internal" href="ircv3.html">IRCv3 support</a></li>
<li class="toctree-l1"><a class="reference internal" href="accounts.html">Account tracking in Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="pbkdf2info.html">Encryption/Hashing</a></li>
<li class="toctree-l1"><a class="reference internal" href="python.html">Using the Python Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="twitchinfo.html">Twitch</a></li>
<li class="toctree-l1"><a class="reference internal" href="tricks.html">Advanced Tips</a></li>
<li class="toctree-l1"><a class="reference internal" href="text-sub.html">Textfile Substitutions</a></li>
<li class="toctree-l1"><a class="reference internal" href="tcl-commands.html">Eggdrop Tcl Commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="twitch-tcl-commands.html">Eggdrop Twitch Tcl Commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="patch.html">Patching Eggdrop</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/setup.html">Setting Up Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/firststeps.html">Common First Steps</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/tlssetup.html">Enabling TLS Security on Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/userfilesharing.html">Sharing Userfiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/firstscript.html">Writing an Eggdrop Tcl Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/module.html">Writing a Basic Eggdrop Module</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Eggdrop Modules</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../modules/index.html">Eggdrop Module Information</a></li>
<li class="toctree-l1"><a class="reference internal" href="../modules/included.html">Modules included with Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="../modules/writing.html">How to Write an Eggdrop Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../modules/internals.html">Eggdrop Bind Internals</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">About Eggdrop</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../about/about.html">About Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="../about/legal.html">Boring legal stuff</a></li>
</ul>
<div role="search">
<h3 style="margin-top: 1.5em;">Search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<p>Last revised: August 29, 2023</p>
<section id="eggdrop-core-settings">
<h1>Eggdrop Core Settings<a class="headerlink" href="#eggdrop-core-settings" title="Link to this heading">¶</a></h1>
<p>This file describes the syntax and all the settings of your Eggdrop
configuration file. Please note that you don’t need to set all of these
variables to make your bot work properly.</p>
<section id="executable-path">
<h2>Executable Path<a class="headerlink" href="#executable-path" title="Link to this heading">¶</a></h2>
<p>The first line in an Eggdrop configuration file should contain
a fully qualified path to your Eggdrop executable. It has to be
implemented in the way the example shows to make the config file
work as a shell script.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="ch">#! /path/to/eggdrop</span>
</pre></div>
</div>
</section>
<section id="basic-settings">
<h2>Basic Settings<a class="headerlink" href="#basic-settings" title="Link to this heading">¶</a></h2>
<p>You can change the basic Eggdrop appearance and behavior in this section.</p>
<blockquote>
<div><dl class="simple">
<dt>set username “lamest”</dt><dd><p>This setting defines the username the bot uses on IRC. This setting has
no effect if an ident daemon is running on your bot’s machine.</p>
</dd>
<dt>set admin “Lamer <email: <a class="reference external" href="mailto:lamer%40lamest.lame.org">lamer<span>@</span>lamest<span>.</span>lame<span>.</span>org</a>>”</dt><dd><p>This setting defines which contact person should be shown in .status,
/msg help, and other places. You really should include this information.</p>
</dd>
<dt>set network “SomeIrcNetwork”</dt><dd><p>This setting is used only for info to share with others on your botnet.
Set this to the IRC network your bot is connected to.</p>
</dd>
<dt>set timezone “EST”</dt><dd><p>This setting defines which timezone is your bot in. It’s used for internal
routines as well as for logfile timestamping and scripting purposes.
The timezone string specifies the name of the timezone and must be three
or more alphabetic characters. For example, Central European Time(UTC+1)
should be “CET”.</p>
</dd>
<dt>set offset “5”</dt><dd><p>The offset setting specifies the time value to be added to the local
time to get Coordinated Universal Time (UTC aka GMT). The offset is
positive if the local timezone is west of the Prime Meridian and
negative if it is east. The value (in hours) must be between -23 and
23. For example, if the timezone is UTC+1, the offset is -1.</p>
</dd>
<dt>set env(TZ) “$timezone $offset” (disabled by default)</dt><dd><p>If you don’t want to use the timezone setting for scripting purposes
only, but instead everywhere possible, then use this setting.</p>
</dd>
</dl>
<div class="line-block">
<div class="line">set vhost4 “99.99.0.0”</div>
<div class="line">set vhost4 “virtual.host.com”</div>
<div class="line-block">
<div class="line">If you’re using virtual hosting (your machine has more than 1 IP), you
may want to specify the particular IP to bind to. You can specify either
by hostname or by IP. Note that this is not used for listening. Use the
‘listen’ command to specify the listening address.</div>
</div>
</div>
<div class="line-block">
<div class="line">set vhost6 “2001:db8:618:5c0:263::”</div>
<div class="line">set vhost6 “my.ipv6.host.com”</div>
<div class="line-block">
<div class="line">IPv6 vhost to bind to for outgoing IPv6 connections. You can set it
to any valid IPv6 address or hostname, resolving to an IPv6 address.
Note that this is not used for listening. Use the ‘listen’ command
to specify the listening address.</div>
</div>
</div>
<dl>
<dt>set prefer-ipv6 “1”</dt><dd><p>Prefer IPv6 over IPv4 for connections and dns resolution.
If the preferred protocol family is not supported, other possible
families will be tried.</p>
</dd>
<dt>addlang “english”</dt><dd><p>If you want to have your Eggdrop messages displayed in another language,
change this command to match your preferences. An alternative would be
to set the environment variable EGG_LANG to that value.</p>
<p>Languages included with Eggdrop: Danish, English, French, Finnish,
German.</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="log-files">
<h2>Log Files<a class="headerlink" href="#log-files" title="Link to this heading">¶</a></h2>
<p>Eggdrop is capable of logging various things, from channel chatter to
partyline commands and file transfers.</p>
<p>Logfiles are normally kept for 24 hours. Afterwards, they will be renamed
to “(logfilename).yesterday”. After 48 hours, they will be overwritten by
the logfile of the next day.</p>
<blockquote>
<div><dl class="simple">
<dt>set max-logs 20</dt><dd><p>This is the maximum number of concurrent logfiles that can be opened
for writing at one time. At most, this value should be the maximum
number of channels you expect to create log files for. There is no
value for ‘infinity’; very few cases should ever require more than 20.
A decrease to this value while running will require a restart (not rehash)
of the bot. However, don’t decrease it below 5.</p>
</dd>
<dt>set max-logsize 0</dt><dd><p>This is the maximum size of your logfiles. Set it to 0 to disable.
This value is in kilobytes, so ‘550’ would mean cycle logs when it
reaches the size of 550 kilobytes. Note that this only works if you
have keep-all-logs set to 0 (OFF).</p>
</dd>
<dt>set raw-log 0</dt><dd><p>This setting allows you the logging of raw incoming server traffic via
console/log flag ‘r’, raw outgoing server traffic via console/log mode
‘v’, raw incoming botnet traffic via console/log mode ‘t’, raw outgoing
botnet traffic via console/log mode ‘u’, raw outgoing share traffic via
console/log mode ‘g’, and raw incoming share traffic via console/log
mode ‘h’. These flags can create a large security hole, allowing people
to see user passwords. This is now restricted to +n users only. Please
choose your owners with care.</p>
</dd>
</dl>
</div></blockquote>
<dl>
<dt>logfile <logflags> <channel> “logs/logfile”</dt><dd><blockquote>
<div><p>This setting tells the bot what should be logged, from where, and to
which file.</p>
<p>Logfile flags:</p>
<blockquote>
<div><table class="docutils align-default">
<tbody>
<tr class="row-odd"><td><p>b</p></td>
<td><p>information about bot linking and userfile sharing</p></td>
</tr>
<tr class="row-even"><td><p>c</p></td>
<td><p>commands</p></td>
</tr>
<tr class="row-odd"><td><p>d</p></td>
<td><p>misc debug information</p></td>
</tr>
<tr class="row-even"><td><p>g</p></td>
<td><p>raw outgoing share traffic</p></td>
</tr>
<tr class="row-odd"><td><p>h</p></td>
<td><p>raw incoming share traffic</p></td>
</tr>
<tr class="row-even"><td><p>j</p></td>
<td><p>joins, parts, quits, and netsplits on the channel</p></td>
</tr>
<tr class="row-odd"><td><p>k</p></td>
<td><p>kicks, bans, and mode changes on the channel</p></td>
</tr>
<tr class="row-even"><td><p>l</p></td>
<td><p>linked bot messages</p></td>
</tr>
<tr class="row-odd"><td><p>m</p></td>
<td><p>private msgs, notices and ctcps to the bot</p></td>
</tr>
<tr class="row-even"><td><p>o</p></td>
<td><p>misc info, errors, etc (IMPORTANT STUFF)</p></td>
</tr>
<tr class="row-odd"><td><p>p</p></td>
<td><p>public text on the channel</p></td>
</tr>
<tr class="row-even"><td><p>r</p></td>
<td><p>raw incoming server traffic</p></td>
</tr>
<tr class="row-odd"><td><p>s</p></td>
<td><p>server connects, disconnects, and notices</p></td>
</tr>
<tr class="row-even"><td><p>t</p></td>
<td><p>raw incoming botnet traffic</p></td>
</tr>
<tr class="row-odd"><td><p>u</p></td>
<td><p>raw outgoing botnet traffic</p></td>
</tr>
<tr class="row-even"><td><p>v</p></td>
<td><p>raw outgoing server traffic</p></td>
</tr>
<tr class="row-odd"><td><p>w</p></td>
<td><p>wallops (make sure the bot sets +w in init-server)</p></td>
</tr>
<tr class="row-even"><td><p>x</p></td>
<td><p>file transfers and file-area commands</p></td>
</tr>
</tbody>
</table>
</div></blockquote>
<p>Note that modes d, h, r, t, and v can fill disk quotas quickly. There are
also eight user-defined levels (1-8) which can be used by Tcl scripts.</p>
<p>Each logfile belongs to a certain channel. Events of type ‘k’, ‘j’, and
‘p’ are logged to whatever channel they happened on. Most other events
are currently logged to every channel. You can make a logfile belong to
all channels by assigning it to channel “*”.</p>
<p>Examples:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">logfile</span> <span class="n">mco</span> <span class="o">*</span> <span class="s2">"logs/eggdrop.log"</span>
<span class="n">logfile</span> <span class="n">jpk</span> <span class="c1">#lamest "logs/lamest.log"</span>
</pre></div>
</div>
<p>In ‘eggdrop.log’, put private msgs/ctcps, commands, misc info, and errors
from any channel.</p>
<p>In ‘lamest.log’, log all joins, parts, kicks, bans, public chatter, and
mode changes from #lamest.</p>
</div></blockquote>
<dl class="simple">
<dt>set log-time 1</dt><dd><p>Use this feature to timestamp entries in the log file.</p>
</dd>
<dt>set timestamp-format “[%H:%M:%S]”</dt><dd><p>Set the following to the timestamp for the logfile entries. Popular times
might be “[%H:%M]” (hour, min), or “[%H:%M:%S]” (hour, min, sec).
Read ‘man strftime’ for more formatting options. Keep it below 32 chars.</p>
</dd>
<dt>set keep-all-logs 0</dt><dd><p>If you want to keep your logfiles forever, turn this setting on. All
logfiles will get the suffix
“.[day, 2 digits][month, 3 letters][year, 4 digits]”. Note that your
quota/hard-disk might be filled by this, so check your logfiles
often and download them.</p>
</dd>
<dt>set switch-logfiles-at 300</dt><dd><p>You can specify when Eggdrop should switch logfiles and start fresh.
use military time for this setting. 300 is the default, and describes
03:00 (AM).</p>
</dd>
<dt>set quiet-save 0</dt><dd><p>“Writing user file…” and “Writing channel file…” messages won’t be
logged anymore if this option is enabled. If you set it to 2, the
“Backing up user file…” and “Backing up channel file…” messages will
also not be logged. In addition to this, you can disable the “Switching
logfiles…” and the new date message at midnight, by setting this to 3.</p>
</dd>
<dt>set logfile-suffix “.%d%b%Y”</dt><dd><p>If keep-all-logs is 1, this setting will define the suffix of the
logfiles. The default will result in a suffix like “04May2000”. “%Y%m%d”
will produce the often used yyyymmdd format. Read the strftime manpages
for more options.</p>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="console-settings">
<h2>Console Settings<a class="headerlink" href="#console-settings" title="Link to this heading">¶</a></h2>
<blockquote>
<div><dl class="simple">
<dt>set console “mkcoblxs”</dt><dd><p>This is the default console mode. It uses the same event flags as the
log files do. The console channel is automatically set to your “primary”
channel, which is set in the modules section of the config file. Masters
can change their console channel and modes with the ‘.console’ command.</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="file-and-directory-settings">
<h2>File and Directory Settings<a class="headerlink" href="#file-and-directory-settings" title="Link to this heading">¶</a></h2>
<blockquote>
<div><dl>
<dt>set userfile “LamestBot.user”</dt><dd><p>Specify here the filename your userfile should be saved as.</p>
</dd>
<dt>set pidfile “pid.LamestBot”</dt><dd><p>Specify here the filename Eggdrop will save its pid to. If no pidfile is
specified, pid.(botnet-nick) will be used.</p>
</dd>
<dt>set help-path “help/”</dt><dd><p>Specify here where Eggdrop should look for help files. Don’t modify this
setting unless you know what you’re doing!</p>
</dd>
<dt>set text-path “text/”</dt><dd><p>Specify here where Eggdrop should look for text files. This is used for
certain Tcl and DCC commands.</p>
</dd>
<dt>set motd “text/motd”</dt><dd><p>The MOTD (Message Of The day) is displayed when people dcc chat or telnet
to the bot. Look at doc/TEXT-SUBSTITUTIONS for options.</p>
</dd>
<dt>set telnet-banner “text/banner”</dt><dd><p>This banner will be displayed on telnet connections. Look at
doc/text-substitutions.doc for options.</p>
</dd>
<dt>set userfile-perm 0600</dt><dd><p>This specifies what permissions the user, channel, and notes files should
be set to. The octal values are the same as for the chmod system command.</p>
<p>To remind you:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">|</span> <span class="n">u</span> <span class="n">g</span> <span class="n">o</span> <span class="n">u</span> <span class="n">g</span> <span class="n">o</span> <span class="n">u</span> <span class="n">g</span> <span class="n">o</span>
<span class="o">|</span><span class="mi">0600</span> <span class="n">rw</span><span class="o">-------</span> <span class="mi">0400</span> <span class="n">r</span><span class="o">--------</span> <span class="mi">0200</span> <span class="o">-</span><span class="n">w</span><span class="o">-------</span> <span class="n">u</span> <span class="o">-</span> <span class="n">user</span>
<span class="o">|</span><span class="mi">0660</span> <span class="n">rw</span><span class="o">-</span><span class="n">rw</span><span class="o">----</span> <span class="mi">0440</span> <span class="n">r</span><span class="o">--</span><span class="n">r</span><span class="o">-----</span> <span class="mi">0220</span> <span class="o">-</span><span class="n">w</span><span class="o">--</span><span class="n">w</span><span class="o">----</span> <span class="n">g</span> <span class="o">-</span> <span class="n">group</span>
<span class="o">|</span><span class="mi">0666</span> <span class="n">rw</span><span class="o">-</span><span class="n">rw</span><span class="o">-</span><span class="n">rw</span><span class="o">-</span> <span class="mi">0444</span> <span class="n">r</span><span class="o">--</span><span class="n">r</span><span class="o">--</span><span class="n">r</span><span class="o">--</span> <span class="mi">0222</span> <span class="o">-</span><span class="n">w</span><span class="o">--</span><span class="n">w</span><span class="o">--</span><span class="n">w</span><span class="o">-</span> <span class="n">o</span> <span class="o">-</span> <span class="n">others</span>
</pre></div>
</div>
<p>Note that the default 0600 is the most secure one and should only be
changed if you need your files for shell scripting or other external
applications.</p>
</dd>
<dt>set mod-path “modules/”</dt><dd><p>This path specifies the path were Eggdrop should look for its modules.
If you run the bot from the compilation directory, you will want to set
this to “”. If you use ‘make install’ (like all good kiddies do ;), this
is a fine default. Otherwise, use your head :).</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="botnet-dcc-telnet-settings">
<h2>Botnet/Dcc/Telnet Settings<a class="headerlink" href="#botnet-dcc-telnet-settings" title="Link to this heading">¶</a></h2>
<p>Settings in this section should be unimportant for you until you deal with
botnets (multiple Eggdrops connected together to maximize efficiency). You
should read doc/BOTNET before modifying these settings.</p>
<blockquote>
<div><dl>
<dt>set botnet-nick “LlamaBot” (disabled by default)</dt><dd><p>If you want to use a different nickname on the botnet than you use on
IRC (i.e. if you’re on an un-trusted botnet), un-comment this line
and set it to the nick you would like to use.</p>
</dd>
<dt>listen <port> <mode></dt><dd><p>This opens a telnet port by which you and other bots can interact with
the Eggdrop by telneting in.</p>
<p>There are more options for the listen command in doc/tcl-commands.doc.
Note that if you are running more than one bot on the same machine, you
will want to space the telnet ports at LEAST 5 apart, although 10 is even
better.</p>
<p>Valid ports are typically anything between 1025 and 65535 assuming the
port is not already in use.</p>
<p>If you would like the bot to listen for users and bots in separate ports,
use the following format:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">listen</span> <span class="mi">3333</span> <span class="n">bots</span>
<span class="n">listen</span> <span class="mi">4444</span> <span class="n">users</span>
</pre></div>
</div>
<p>If you wish to use only one port, use this format:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">listen</span> <span class="mi">3333</span> <span class="nb">all</span>
</pre></div>
</div>
<p>You can setup a SSL port by prepending a plus sign to it:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">listen</span> <span class="o">+</span><span class="mi">5555</span> <span class="nb">all</span>
</pre></div>
</div>
<p>You need to un-comment this line and change the port number in order to
open the listen port. You should not keep this set to 3333.</p>
</dd>
<dt>set remote-boots 2</dt><dd><p>This setting defines whether or not people can boot users on the Eggdrop
from other bots in your botnet. Valid settings are:</p>
<table class="docutils align-default">
<tbody>
<tr class="row-odd"><td><p>0</p></td>
<td><p>allow <em>no</em> outside boots</p></td>
</tr>
<tr class="row-even"><td><p>1</p></td>
<td><p>allow boots from sharebots</p></td>
</tr>
<tr class="row-odd"><td><p>2</p></td>
<td><p>allow any boots</p></td>
</tr>
</tbody>
</table>
</dd>
<dt>set share-unlinks 1</dt><dd><p>This setting prohibits Eggdrop to unlink from share bots if an remote
bots tells so.</p>
</dd>
<dt>set protect-telnet 0</dt><dd><p>This setting will drop telnet connections not matching a known host.</p>
</dd>
<dt>set dcc-sanitycheck 0</dt><dd><p>This setting will make the bot ignore DCC chat requests which appear to
have bogus information on the grounds that the user may have been trying
to make the bot connect to somewhere that will get it into trouble, or
that the user has a broken client, in which case the connect wouldn’t
work anyway.</p>
</dd>
<dt>set ident-timeout 5</dt><dd><p>This setting defines the time in seconds the bot should wait for ident reply
before the lookup fails. The default ident on timeout is ‘telnet’.</p>
</dd>
<dt>set require-p 0</dt><dd><p>Define here whether or not a +o user still needs the +p flag to dcc the
bot.</p>
</dd>
<dt>set open-telnets 0</dt><dd><p>If you want people allow to telnet in and type ‘NEW’ to become a new user,
set this to 1. This is similar to the ‘hello’ msg command. The
protect-telnet setting must be set to 0 to use this.</p>
</dd>
<dt>set stealth-telnets 0</dt><dd><p>If you don’t want Eggdrop to identify itself as an Eggdrop on a telnet
connection, set this setting to 1. Eggdrop will display ‘Nickname’
instead.</p>
</dd>
<dt>set use-telnet-banner 0</dt><dd><p>If you want Eggdrop to display a banner when telneting in, set this
setting to 1. The telnet banner is set by ‘set telnet-banner’.</p>
</dd>
<dt>set connect-timeout 15</dt><dd><p>This setting defines a time in seconds that the bot should wait before
a dcc chat, telnet, or relay connection times out.</p>
</dd>
<dt>set dcc-flood-thr 3</dt><dd><p>Specify here the number of lines to accept from a user on the partyline
within 1 second before they are considered to be flooding and therefore
get booted.</p>
</dd>
<dt>set telnet-flood 5:60</dt><dd><p>Define here how many telnet connection attempts in how many seconds from
the same host constitute a flood. The correct format is Attempts:Seconds.</p>
</dd>
<dt>set paranoid-telnet-flood 1</dt><dd><p>If you want telnet-flood to apply even to +f users, set this setting
to 1.</p>
</dd>
<dt>set resolve-timeout 15</dt><dd><p>Set here the amount of seconds before giving up on hostname/address
lookup (you might want to increase this if you are on a slow network).</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="advanced-settings">
<h2>Advanced Settings<a class="headerlink" href="#advanced-settings" title="Link to this heading">¶</a></h2>
<blockquote>
<div><dl>
<dt>set firewall “!sun-barr.ebay:3666”</dt><dd><p>Set this to your socks host if your Eggdrop sits behind a firewall. If
you use a Sun “telnet passthru” firewall, prefix the host with a “!”.</p>
</dd>
<dt>set nat-ip “127.0.0.1”</dt><dd><p>If you have a NAT firewall (you box has an IP in one of the following
ranges: 192.168.0.0-192.168.255.255, 172.16.0.0-172.31.255.255,
10.0.0.0-10.255.255.255 and your firewall transparently changes your
address to a unique address for your box) or you have IP masquerading
between you and the rest of the world, and /dcc chat, /ctcp chat or
userfile sharing aren’t working, enter your outside IP here. This IP
is used for transfers only, and has nothing to do with the vhost4/6 or
listen settings. You may still need to set them.</p>
</dd>
<dt>set reserved-portrange 2010:2020</dt><dd><p>If you want all dcc file transfers to use a particular portrange either
because you’re behind a firewall, or for other security reasons, set it
here.</p>
</dd>
<dt>set ignore-time 15</dt><dd><p>Set the time in minutes that temporary ignores should last.</p>
</dd>
<dt>set hourly-updates 00</dt><dd><p>Define here what Eggdrop considers ‘hourly’. All calls to it, including
such things as note notifying or userfile saving, are affected by this.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">set</span> <span class="n">hourly</span><span class="o">-</span><span class="n">updates</span> <span class="mi">15</span>
</pre></div>
</div>
<p>The bot will save its userfile 15 minutes past every hour.</p>
</dd>
<dt>set owner “MrLame, MrsLame”</dt><dd><p>Un-comment this line and set the list of owners of the bot.
You NEED to change this setting.</p>
</dd>
<dt>set notify-newusers “$owner”</dt><dd><p>Who should a note be sent to when new users are learned?</p>
</dd>
<dt>set default-flags “hp”</dt><dd><p>Enter the flags that all new users should get by default. See ‘.help
whois’ on the partyline for a list of flags and their descriptions.</p>
</dd>
<dt>set whois-fields “url birthday”</dt><dd><p>Enter all user-defined fields that should be displayed in a ‘.whois’.
This will only be shown if the user has one of these extra fields.
You might prefer to comment this out and use the userinfo1.0.tcl script
which provides commands for changing all of these.</p>
</dd>
</dl>
<p>#unbind dcc n tcl *dcc:tcl</p>
<dl class="simple">
<dt>#unbind dcc n set *dcc:set</dt><dd><p>Uncomment these two lines if you wish to disable the .tcl and .set commands.
If you select your owners wisely, you should be okay leaving these enabled.</p>
</dd>
<dt>set must-be-owner 1</dt><dd><p>If you enable this setting, only permanent owners (owner setting) will
be able to use .tcl and .set. Moreover, if you want to only let permanent
owners use .dump, then set this to 2.</p>
</dd>
<dt>unbind dcc n simul *dcc:simul</dt><dd><p>Comment out this line to add the ‘simul’ partyline command (owners
can manipulate other people on the party line). Please select owners
wisely and use this command ethically!</p>
</dd>
<dt>set max-dcc 50</dt><dd><p>Set here the maximum number of dcc connections you will allow. You can
increase this later, but never decrease it.</p>
</dd>
<dt>set allow-dk-cmds 1</dt><dd><p>Enable this setting if you want +d & +k users to use commands bound
as -|-.</p>
</dd>
<dt>set dupwait-timeout 5</dt><dd><p>If your Eggdrop rejects bots that actually have already disconnected
from another hub, but the disconnect information has not yet spread
over the botnet due to lag, use this setting. The bot will wait
dupwait-timeout seconds before it checks again and then finally
reject the bot.</p>
</dd>
<dt>set cidr-support 0</dt><dd><p>Enables cidr support for b/e/I modes if set to 1. This means the bot
will understand and match modes in cidr notation, and will be able to
put and enforce such bans or unban itself, if banned with a cidr mask.
Do NOT set this, if your network/server does not support cidr!</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="ssl-settings">
<h2>SSL Settings<a class="headerlink" href="#ssl-settings" title="Link to this heading">¶</a></h2>
<p>Settings in this section take effect when eggdrop is compiled with TLS
support.</p>
<blockquote>
<div><dl>
<dt>set ssl-privatekey “eggdrop.key”</dt><dd><p>File containing your private key, needed for the SSL certificate
(see below). You can create one issuing the following command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">openssl</span> <span class="n">genrsa</span> <span class="o">-</span><span class="n">out</span> <span class="n">eggdrop</span><span class="o">.</span><span class="n">key</span> <span class="mi">4096</span>
</pre></div>
</div>
<p>It will create a 4096 bit RSA key, strong enough for eggdrop.
This is required for SSL hubs/listen ports, secure file transfer and
/ctcp botnick schat
For your convenience, you can type ‘make sslcert’ after ‘make install’
and you’ll get a key and a certificate in your DEST directory.</p>
</dd>
<dt>set ssl-certificate “eggdrop.crt”</dt><dd><p>Specify the filename where your SSL certificate is located. If you
don’t set this, eggdrop will not be able to act as a server in SSL
connections, as with most ciphers a certificate and a private key
are required on the server side. Must be in PEM format.
If you don’t have one, you can create it using the following command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">openssl</span> <span class="n">req</span> <span class="o">-</span><span class="n">new</span> <span class="o">-</span><span class="n">key</span> <span class="n">eggdrop</span><span class="o">.</span><span class="n">key</span> <span class="o">-</span><span class="n">x509</span> <span class="o">-</span><span class="n">out</span> <span class="n">eggdrop</span><span class="o">.</span><span class="n">crt</span> <span class="o">-</span><span class="n">days</span> <span class="mi">365</span>
</pre></div>
</div>
<p>This is required for SSL hubs/listen ports, secure file transfer and
/ctcp botnick schat
For your convenience, you can type ‘make sslcert’ after ‘make install’
and you’ll get a key and a certificate in your DEST directory.</p>
</dd>
<dt>set ssl-verify-depth 9</dt><dd><p>Sets the maximum depth for the certificate chain verification that shall
be allowed for ssl. When certificate verification is enabled, any chain
exceeding this depth will fail verification.</p>
</dd>
</dl>
<div class="line-block">
<div class="line">set ssl-capath “/etc/ssl/”</div>
<div class="line">set ssl-cafile “”</div>
<div class="line-block">
<div class="line">Specify the location at which CA certificates for verification purposes
are located. These certificates are trusted. If you don’t set this,
certificate verification will not work.</div>
</div>
</div>
<dl>
<dt>set ssl-ciphers “”</dt><dd><p>Specify the list of ciphers (in order of preference) allowed for use with
ssl. The cipher list is one or more cipher strings separated by colons,
commas or spaces. Unavailable ciphers are silently ignored unless no
usable cipher could be found. For the list of possible cipher strings
and their meanings, please refer to the ciphers(1) manual.
Note: if you set this, the value replaces any ciphers OpenSSL might use by
default. To include the default ciphers, you can put DEFAULT as a cipher
string in the list.
For example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">set</span> <span class="n">ssl</span><span class="o">-</span><span class="n">ciphers</span> <span class="s2">"DEFAULT ADH"</span>
</pre></div>
</div>
<p>… will make eggdrop allow the default OpenSSL selection plus anonymous
DH ciphers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">set</span> <span class="n">ssl</span><span class="o">-</span><span class="n">ciphers</span> <span class="s2">"ALL"</span>
</pre></div>
</div>
<p>… will make eggdrop allow all ciphers supported by OpenSSL, in a
reasonable order.</p>
</dd>
<dt>set ssl-cert-auth 0</dt><dd><p>Enable certificate authorization. Set to 1 to allow users and bots to
identify automatically by their certificate fingerprints. Setting it
to 2 to will force fingerprint logins. With a value of 2, users without
a fingerprint set or with a certificate UID not matching their handle
won’t be allowed to login on SSL enabled telnet ports. Fingerprints
must be set in advance with the .fprint and .chfinger commands.
NOTE: this setting has no effect on plain-text ports.</p>
</dd>
</dl>
<p>You can control SSL certificate verification using the following variables.
All of them are flag-based. You can set them by adding together the numbers
for all exceptions you want to enable. By default certificate verification
is disabled and all certificates are assumed to be valid.</p>
<p>The options are the following:</p>
<blockquote>
<div><table class="docutils align-default">
<tbody>
<tr class="row-odd"><td><p>0</p></td>
<td><p>disable verification</p></td>
</tr>
<tr class="row-even"><td><p>1</p></td>
<td><p>enable certificate verification</p></td>
</tr>
<tr class="row-odd"><td><p>2</p></td>
<td><p>allow self-signed certificates</p></td>
</tr>
<tr class="row-even"><td><p>4</p></td>
<td><p>don’t check peer common or alt names</p></td>
</tr>
<tr class="row-odd"><td><p>8</p></td>
<td><p>allow expired certificates</p></td>
</tr>
<tr class="row-even"><td><p>16</p></td>
<td><p>allow certificates which are not valid yet</p></td>
</tr>
<tr class="row-odd"><td><p>32</p></td>
<td><p>allow revoked certificates</p></td>
</tr>
</tbody>
</table>
</div></blockquote>
<dl class="simple">
<dt>set ssl-verify-dcc 0</dt><dd><p>Control certificate verification for DCC chats (only /dcc chat botnick)</p>
</dd>
<dt>set ssl-verify-bots 0</dt><dd><p>Control certificate verification for linking to hubs</p>
</dd>
<dt>set ssl-verify-clients 0</dt><dd><p>Control certificate verification for SSL listening ports. This includes
leaf bots connecting, users telneting in and /ctcp bot chat.</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="modules">
<h2>Modules<a class="headerlink" href="#modules" title="Link to this heading">¶</a></h2>
<p>After the core settings, you should start loading modules. Modules are
loaded by the command “loadmodule <module>”. Eggdrop looks for modules
in the directory you specified by the mod-path setting in the files
and directories section.</p>
<p>Please note that for different configurations, different modules are needed.
Four examples:</p>
<blockquote>
<div><dl class="simple">
<dt>Channel Security Bot:</dt><dd><p>This bot needs the channels, blowfish, console, dns, irc, and (if you
like) ctcp modules loaded. More is not needed and makes the bot slower.</p>
</dd>
<dt>Public IRC Bot:</dt><dd><p>A public bot should have all modules available loaded since they provide
all functions for everyday use.</p>
</dd>
<dt>Secure Filesys Bot:</dt><dd><p>This bot needs all normal IRC operating modules, but not the notes, seen,
ctcp or share modules.</p>
</dd>
<dt>Limbo Bot:</dt><dd><p>A limbo bot (serves as a botnet hub outside IRC) just needs the
channels, console, dns, and maybe notes or share modules loaded. Of
course, an encryption module needs to be loaded here, too.</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="scripts">
<h2>Scripts<a class="headerlink" href="#scripts" title="Link to this heading">¶</a></h2>
<p>The scripts section should be placed at the end of the config file. All
modules should be loaded and their variables should be set at this point.</p>
<blockquote>
<div><dl>
<dt>source scripts/script.tcl</dt><dd><p>This line loads script.tcl from the scripts directory inside your
Eggdrop’s directory. All scripts should be put there, although you can
place them where you like as long as you can supply a fully qualified
path to them.</p>
<p>Some commonly loaded scripts are alltools.tcl and action.fix.tcl.</p>
<p>The appropriate source lines are:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">source</span> <span class="n">scripts</span><span class="o">/</span><span class="n">alltools</span><span class="o">.</span><span class="n">tcl</span>
<span class="n">source</span> <span class="n">scripts</span><span class="o">/</span><span class="n">action</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">tcl</span>
</pre></div>
</div>
</dd>
</dl>
</div></blockquote>
<p>Copyright (C) 2000 - 2025 Eggheads Development Team</p>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="footer-wrapper">
<div class="footer">
<div class="left">
<div role="navigation" aria-label="related navigaton">
<a href="features.html" title="Eggdrop Features"
>previous</a> |
<a href="partyline.html" title="The Party Line"
>next</a>
</div>
<div role="note" aria-label="source link">
</div>
</div>
<div class="right">
<div class="footer" role="contentinfo">
© Copyright 2025, Eggheads.
Last updated on Aug 15, 2025.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</body>
</html>
|
