Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
9b70311
Update ABOUT doc
michaelortmann Oct 16, 2024
0d92374
Update theme
michaelortmann Oct 16, 2024
360b653
Fix typo: intpreter ==> interpreter
michaelortmann Oct 16, 2024
7e603e4
Typo fix
michaelortmann Oct 16, 2024
a4f1805
Update doc firststeps - fingerprint and nickserv magick
michaelortmann Oct 16, 2024
c7c9c38
Fix indention, see bottom part of https://docs.eggheads.org/tutorials…
michaelortmann Oct 16, 2024
70637ca
Doc update: do not use public / in use ip addresses in doc, instead u…
michaelortmann Oct 16, 2024
64d7f67
Typo fix: Eggsrop -> Eggdrop
michaelortmann Nov 7, 2024
3eacc63
Typo fix: thee a list of servivce -> a list of service
michaelortmann Nov 9, 2024
c77ecd3
Typo fix: certifate -> certificate
michaelortmann Nov 9, 2024
2ea568c
ortherwise -> otherwise
michaelortmann Jan 30, 2025
06e7eba
priviledges -> privileges
michaelortmann Jan 30, 2025
4ac3e2f
Merge remote-tracking branch 'upstream/develop' into doc2
michaelortmann Jan 30, 2025
15121ce
Update doc/BUG-REPORT
michaelortmann Jan 30, 2025
6b27da3
crappy.com -> example.net
michaelortmann Jan 31, 2025
907d669
More doc IPs
michaelortmann Jan 31, 2025
1e44d8d
More example domain names
michaelortmann Feb 1, 2025
62a1553
Merge remote-tracking branch 'upstream/develop' into doc2
michaelortmann Jun 1, 2025
2a4be93
Update firststeps.rst
vanosg Jun 14, 2025
b808777
Update firststeps.rst
vanosg Jun 14, 2025
23330fd
Update firststeps.rst
vanosg Jun 14, 2025
e154ae0
Update setup.rst
vanosg Jun 14, 2025
7ce177c
Revert
michaelortmann Jun 16, 2025
8196291
Revert
michaelortmann Jun 16, 2025
4c1daca
Merge remote-tracking branch 'upstream/develop' into doc2
michaelortmann Jun 16, 2025
6192030
Revert
michaelortmann Jun 16, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions doc/BUG-REPORT
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
=====================================================================
Eggheads Eggdrop 1.9 Bug Report Form
Eggheads Eggdrop 1.10 Bug Report Form
=====================================================================

By reporting bugs, you help to improve the quality of Eggdrop which
Expand All @@ -26,7 +26,7 @@ DO NOT SEND HTML E-MAIL TO THE LISTS.
1) INFORMATION ABOUT YOUR EGGDROP

1.1) Eggdrop version:
1.9._
1.10._

1.2) Make type:
( ) dynamic
Expand All @@ -44,6 +44,7 @@ DO NOT SEND HTML E-MAIL TO THE LISTS.
2.1) Tcl library version:
( ) 8.5._
( ) 8.6._
( ) 9.0._
( ) Other - Which? ____

2.2) Tcl scripts used:
Expand Down
2 changes: 1 addition & 1 deletion doc/Changes0.7
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Eggdrop Changes (since version 0.6)
are stored in -- if not defined, the standard one line responses are
used -- otherwise, the file "help" is shown for default help, and all
other help requests are displayed only if there is a corresponding file
in the directory (error message ortherwise)
in the directory (error message otherwise)

- Default help responses are done through the helpbot if available

Expand Down
2 changes: 1 addition & 1 deletion doc/Changes1.10
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ Eggdrop v1.10.0rc1 (2024-08-08):
* Additional internals doc tweaks
2024-01-18 * Switch autoscripts to GitHub
2024-01-15 * change py init from Isolated to Python
2024-01-14 * Add Python intpreter to Eggdrop
2024-01-14 * Add Python interpreter to Eggdrop
[Patch by: Geo, thommey]
* Update docs
* Update copyright
Expand Down
2 changes: 1 addition & 1 deletion doc/Changes1.6
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Eggdrop Changes (since version 1.6.0)
- Added a new bind LOG triggered when text is sent to the logs.
Patch by: pseudo

- Fixed a bug in checking user priviledges for .chaddr on sharebots.
- Fixed a bug in checking user privileges for .chaddr on sharebots.
Patch by: thommey

- Added a new bind CRON as a crontab-like alternative to bind TIME.
Expand Down
2 changes: 1 addition & 1 deletion doc/Changes1.8
Original file line number Diff line number Diff line change
Expand Up @@ -1184,7 +1184,7 @@ Eggdrop v1.8.1rc1 (2017-03-01):
- Made some corrections to the contributors list, removed a duplicate entry.
Patch by: pseudo

- Fixed bind cron html documention to be in sync with non-html one.
- Fixed bind cron html documentation to be in sync with non-html one.
Found by: 64MAAMVDH / Patch by: thommey

- Replaced most dns.mod preprocessor definitions with config variables.
Expand Down
4 changes: 2 additions & 2 deletions doc/sphinx_source/_themes/agogo/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<div class="headertitle"><a
href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a></div>
{%- endblock %}
<div class="rel" role="navigation" aria-label="related navigation">
<div class="rel" role="navigation" aria-label="Related">
{%- for rellink in rellinks|reverse %}
<a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags|e }}"
{{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>
Expand Down Expand Up @@ -76,7 +76,7 @@ <h3 style="margin-top: 1.5em;">{{ _('Search') }}</h3>
<div class="footer-wrapper">
<div class="footer">
<div class="left">
<div role="navigation" aria-label="related navigaton">
<div role="navigation" aria-label="Related">
{%- for rellink in rellinks|reverse %}
<a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags|e }}"
{{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>
Expand Down
15 changes: 6 additions & 9 deletions doc/sphinx_source/about/about.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
About Eggdrop
Last revised: July 27, 2010

=============
About Eggdrop
=============
Expand Down Expand Up @@ -38,10 +35,10 @@ About Eggdrop
for information on setting up a botnet.

Eggdrop is always being improved and adjusted because there are bugs to
be fixed and features to be added (if the users demand them, and they
make actually sense). In fact, it existed for several years as v0.7 -
v0.9 before finally going 1.0. This version of Eggdrop is part of the
1.9 tree. A valiant effort has been made to chase down and destroy bugs.
be fixed and features to be added (if the users demand them, and they
make actually sense). In fact, it existed for several years as v0.7 - v0.9
before finally going 1.0. This version of Eggdrop is part of the
1.10 tree. A valiant effort has been made to chase down and destroy bugs.

To use Eggdrop, you need:

Expand All @@ -50,8 +47,8 @@ About Eggdrop
* A pretty good knowledge of IRC and Unix, including how to compile
programs, how to read, and what DCC chat is, at absolute minimum.

* About 5-7 MB of disk space. The Eggdrop tarball is about 5.4 MB
unpacked.
* About 8 MB of disk space for the installed Eggdrop. The Eggdrop
tarball is about 10 MB unpacked.

* Tcl -- Eggdrop cannot compile without Tcl installed on your shell.

Expand Down
10 changes: 7 additions & 3 deletions doc/sphinx_source/tutorials/firststeps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,15 +150,15 @@ Simple Authentication and Security Layer (SASL) is becoming a prevalant method o

* **PLAIN**: To use this method, set sasl-mechanism to 0. This method passes the username and password (set in the sasl-username and sasl-password config file settings) to the IRC server in plaintext. If you only connect to the IRC server using a connection protected by SSL/TLS this is a generally safe method of authentication; however you probably want to avoid this method if you connect to a server on a non-protected port as the exchange itself is not encrypted.

* **ECDSA-NIST256P-CHALLENGE**: To use this method, set sasl-mechanism to 1. This method uses a public/private keypair to authenticate, so no username/password is required. Not all servers support this method. If your server does support this, you you must generate a certificate pair using::
* **ECDSA-NIST256P-CHALLENGE**: To use this method, set sasl-mechanism to 1. This method uses a public/private keypair to authenticate, so no username/password is required. Not all servers support this method. If your server does support this, you must generate a certificate pair using::

openssl ecparam -genkey -name prime256v1 -out eggdrop-ecdsa.pem

You will need to determine your public key fingerprint by using::

openssl ec -noout -text -conv_form compressed -in eggdrop-ecdsa.pem | grep '^pub:' -A 3 | tail -n 3 | tr -d ' \n:' | xxd -r -p | base64
openssl ec -noout -text -conv_form compressed -in eggdrop-ecdsa.pem 2>/dev/null | grep '^pub:' -A 3 | tail -n 3 | tr -d ' \n:' | xxd -r -p | base64

Then, authenticate with your NickServ service and register your public certificate with NickServ. You can view your public key On Libera for example, it is done by::
Then, authenticate with your NickServ service and register your public certificate with NickServ. On Libera for example, it is done by::

/msg NickServ set pubkey <fingerprint string from above goes here>

Expand All @@ -174,6 +174,10 @@ Then, ensure you have those keys loaded in the ssl-privatekey and ssl-certificat

/msg NickServ cert add <fingerprint string from above goes here>

Alternatively you could connect via ssl and if NickServ supports it, make it automatically determine and add your fingerprint in just the right format:

/msg NickServ cert add

* **SCRAM-SHA-256**: To use this method, set sasl-mechanism to 3.

* **SCRAM-SHA-512**: To use this method, set sasl-mechanism to 4.
2 changes: 1 addition & 1 deletion doc/sphinx_source/tutorials/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Below are some of the common settings used for Eggdrop:

:set vhost4: you'll need to set this if you want your bot to use a vhost. This setting lets you choose which IP to use if your shell has multiple. Use vhost4 for an IPv4 address (ie, 1.2.3.4) See also: vhost6

:set vhost6: the same as vhost4, only for IPv6 addresses (ie, 5254:dead:b33f::1337:f270).
:set vhost6: the same as vhost4, only for IPv6 addresses (ie, 2001:db8:dead:b33f::1337:f270).

:logfile: keeping logs is a good idea. Generally, you should have one log for bot stuff, and one log for each of your channels. To capture bot stuff, add the line ``logfile mcobxs * "botnick.log"`` to the config. To capture channel stuff, add ``logfile jkp #donkeys "#donkeys.log"``, ``logfile jkp #horses "#horses.log"``, etc. Make sure you remove the sample logfile lines for the channel #lamest. If you'd like to put your logfiles in their own directory, specify the directory in the log name (e.g. ``logfile jkp #donkeys "logs/#donkeys.log"`` to write the logfiles in the /logs directory).

Expand Down
2 changes: 1 addition & 1 deletion doc/sphinx_source/using/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ bind <arguments>

An important difference to note is that Eggdrop Python has its own ``bind`` command implemented. You will generally want to create binds using the Python ``bind`` command and not import bind from eggdrop.tcl because a Python bind will call a Python function, whereas using the Tcl bind will call a Tcl function (not one from the script you are writing).

The python version of the bind command is used to create a bind that triggers a python function. The python bind takes the same arguments as the Tcl binds, but here each argument is passed individually. For example, a bind that would look like ``bind pub * !foo myproc`` in Tcl is written as ``bind("pub", "*", "!foo", myproc)``. For more information on Eggsrop bind argument syntax please see :ref:`bind_types`. The eggdrop.tcl.bind command should not be used as it will attempt to call a Tcl proc.
The python version of the bind command is used to create a bind that triggers a python function. The python bind takes the same arguments as the Tcl binds, but here each argument is passed individually. For example, a bind that would look like ``bind pub * !foo myproc`` in Tcl is written as ``bind("pub", "*", "!foo", myproc)``. For more information on Eggdrop bind argument syntax please see :ref:`bind_types`. The eggdrop.tcl.bind command should not be used as it will attempt to call a Tcl proc.

The ``bind`` command returns a PythonBind object that has an ``unbind`` method::

Expand Down
2 changes: 1 addition & 1 deletion doc/sphinx_source/using/tcl-commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2801,7 +2801,7 @@ botnick
botname
^^^^^^^

Value: the current nick!user\@host that the server sees (for example: "Valis!valis\@crappy.com")
Value: the current nick!user\@host that the server sees (for example: "Valis!valis\@example.net")

Module: server

Expand Down
4 changes: 2 additions & 2 deletions eggdrop-basic.conf
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ set username "lamest"

## This setting defines which contact person should be shown in .status,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert this file to its original state, thanks

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

set admin "Lamer <email: lamer@lamest.lame.org>" < here we use it as default setting, so you are fine with my change here?

## /msg help, and other places. You really should include this information.
set admin "Lamer <email: lamer@lamest.lame.org>"
set admin "Lamer <email: lamer@lame.example.org>"

## 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.
Expand Down Expand Up @@ -230,7 +230,7 @@ set help-path "help/"
# a valid IP assigned to the host Eggdrop is running on in front of the port
# (this replaces the listen-addr setting used prior to Eggdrop v1.9)
#
# listen 1.2.3.4 3333 all
# listen 192.0.2.1 3333 all
#
# 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.
Expand Down
4 changes: 2 additions & 2 deletions eggdrop.conf
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ set username "lamest"

# This setting defines which contact person should be shown in .status,
# /msg help, and other places. You really should include this information.
set admin "Lamer <email: lamer@lamest.lame.org>"
set admin "Lamer <email: lamer@lame.example.org>"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert this file to its original state, thanks

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also default setting in config.

# 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.
Expand Down Expand Up @@ -295,7 +295,7 @@ set userfile-perm 0600
# a valid IP assigned to the host Eggdrop is running on in front of the port
# (this replaces the listen-addr setting used prior to Eggdrop v1.9)
#
# listen 1.2.3.4 3333 all
# listen 192.0.2.1 3333 all
#
# 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.
Expand Down
6 changes: 3 additions & 3 deletions ssl.conf
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ subjectAltName = @alt_names
# Addresses could be hostnames or IPv4/v6 addresses.

DNS.1 =
#DNS.2 = this.bot.net
#DNS.3 = lamestbot.net
#DNS.2 = example.net
#DNS.3 = example.org
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert this file to its original state, thanks

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

commented out, but also default setting in config

#DNS.4 = ...
#IP.1 = 99.99.0.0
#IP.1 = 192.0.2.0
#IP.2 = 2001:db8:618:5c0:263::
Loading