You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: doc/sphinx_source/tutorials/firststeps.rst
+9-5
Original file line number
Diff line number
Diff line change
@@ -80,10 +80,10 @@ which will enforce the s, n, and t flags on a channel.
80
80
Automatically restarting an Eggdrop
81
81
-----------------------------------
82
82
83
-
A common question asked by users is, how can I configure Eggdrop to automatically restart should it die, such as after a reboot? Historically, Eggdrop relied on the host's crontab system to run a script (called botchk) every ten minutes to see if the eggdrop is running. If the eggdrop is not running, the script will restart the bot, with an optional email sent to the user informing them of the action. Newer systems come with systemd, which can provide better real-time monitoring of processes such as Eggdrop. You probably want to use systemd if your system has it.
83
+
A common question asked by users is, how can I configure Eggdrop to automatically restart should it die, such as after a reboot? Historically, Eggdrop relied on the host's crontab system to run a script (called botchk) every ten minutes to see if the eggdrop is running. If the eggdrop is not running, the script will restart the bot, with an optional email sent to the user informing them of the action. Newer Linux systems come with systemd, which can provide better real-time monitoring of processes such as Eggdrop. You probably want to use systemd if your system has it.
84
84
85
-
Crontab Method (Old)
86
-
^^^^^^^^^^^^^^^^^^^^
85
+
Crontab Method
86
+
^^^^^^^^^^^^^^
87
87
88
88
1. Enter the directory you installed your Eggdrop to. Most commonly, this is ~/eggdrop (also known as /home/<username>/eggdrop).
89
89
@@ -103,8 +103,8 @@ By default, it should create an entry that looks similar to::
103
103
104
104
This will run the generated botchk script every ten minutes and restart your Eggdrop if it is not running during the check. Also note that if you run autobotchk from the scripts directory, you'll have to manually specify your config file location with the -dir option. To remove a crontab entry, use ``crontab -e`` to open the crontab file in your system's default editor and remove the crontab line.
105
105
106
-
Systemd Method (Newer Systems)
107
-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
106
+
Systemd Method (Newer Linux Systems)
107
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
108
108
109
109
1. Enter the directory you installed your Eggdrop to. Most commonly, this is ~/eggdrop (also known as /home/<username>/eggdrop).
110
110
@@ -173,3 +173,7 @@ You will need to determine your public key fingerprint by using::
173
173
Then, ensure you have those keys loaded in the ssl-privatekey and ssl-certificate settings in the config file. Finally, to add this certificate to your NickServ account, type::
174
174
175
175
/msg NickServ cert add <fingerprint string from above goes here>
176
+
177
+
* **SCRAM-SHA-256**: To use this method, set sasl-mechanism to 3.
178
+
179
+
* **SCRAM-SHA-512**: To use this method, set sasl-mechanism to 4.
Copy file name to clipboardexpand all lines: doc/sphinx_source/tutorials/userfilesharing.rst
+12-12
Original file line number
Diff line number
Diff line change
@@ -15,36 +15,36 @@ How to share userfiles- the super-short version
15
15
On the Hub Bot
16
16
^^^^^^^^^^^^^^
17
17
18
-
# Ensure you know what ports your bot is listening on, this is set in the config and those ports will be used in the example below. For this example, our config looks like::
18
+
#. Ensure you know what ports your bot is listening on, this is set in the config and those ports will be used in the example below. For this example, our config looks like::
19
19
20
-
listen +3333/+4444 all
20
+
listen +3333/+4444 all
21
21
22
-
# On the hub (for this example, the Hub is called Hubalicious), add the leaf bot (for this example, the Leaf is called LeifErikson) with `.+bot LeifErikson <IP_address_of_LiefErikson> +4444/+3333 <LiefErikson_hostmask>`.
22
+
#. On the hub (for this example, the Hub is called Hubalicious), add the leaf bot (for this example, the Leaf is called LeifErikson) with ``.+bot LeifErikson <IP_address_of_LiefErikson> +4444/+3333 <LiefErikson_hostmask>``.
23
23
24
-
# On the hub, give the leaf bot the appropriate leaf sharing flags with `.botattr LiefErikson +gs`.
24
+
#. On the hub, give the leaf bot the appropriate leaf sharing flags with ``.botattr LiefErikson +gs``.
25
25
26
26
On the Leaf Bot
27
27
^^^^^^^^^^^^^^^
28
28
29
-
# Ensure you know what ports your bot is listening on, this is set in the config and those ports will be used in the example below. For this example, our config looks like::
29
+
#. Ensure you know what ports your bot is listening on, this is set in the config and those ports will be used in the example below. For this example, our config looks like::
30
30
31
-
listen +5555/+6666 all
31
+
listen +5555/+6666 all
32
32
33
-
# Now on the leaf, add the hub bot with `.+bot Hubalicious <IP_address_of_Hubalicious> +6666/+5555 <Hubalicious hostmask>`.
33
+
#. Now on the leaf, add the hub bot with ``.+bot Hubalicious <IP_address_of_Hubalicious> +6666/+5555 <Hubalicious hostmask>``.
34
34
35
-
# On the leaf, give the hub bot the appropriate hub and sharing flags with `.botattr Hubalicious +ghp`.
35
+
#. On the leaf, give the hub bot the appropriate hub and sharing flags with ``.botattr Hubalicious +ghp``.
36
36
37
-
At this point, the leaf bot should attempt to connect to the hub bot within the next minute, or you can force the link connection with `.link Hubalicious`. You can also use .bottree to see your botnet structure.
37
+
At this point, the leaf bot should attempt to connect to the hub bot within the next minute, or you can force the link connection with ``.link Hubalicious``. You can also use .bottree to see your botnet structure.
38
38
39
39
Explaining the Linking/Sharing Process
40
40
--------------------------------------
41
41
42
-
Eggdrop bots can talk to each other for a variety of reasons. In order for an Eggdrop to talk to another Eggdrop for anything, they must link. This is done by adding a bot record the remote bot on the hub bot (In our example above, using `.+bot LeifErikson` on Hubalicious, and using `.+bot Hubalicious` on LiefErikson). Once the bot records are added, bots can be manually connected using the `.link` command.
42
+
Eggdrop bots can talk to each other for a variety of reasons. In order for an Eggdrop to talk to another Eggdrop for anything, they must link. This is done by adding a bot record the remote bot on the hub bot (In our example above, using ``.+bot LeifErikson`` on Hubalicious, and using ``.+bot Hubalicious`` on LiefErikson). Once the bot records are added, bots can be manually connected using the ``.link`` command.
43
43
44
44
In the example above, we add the +s bot flag to LiefErikson's bot record on Hubalicious to tell Hubalicious that LiefErikson is not only allowed to connect, but is authorized to download the userfiles from Hubalicious. Similarly, we add the +p bot flag to Hubalicious's bot record on LiefErikson to tell LiefErikson that Hubalicous is authorized to send userfiles to LiefErikson. The +h bot flag is added to Hubalicious's bot record on LiefErikson so tell LiefErikson that Hubalicious is the hub, and it should always try to automatically connect to Hubalicious.
45
45
46
-
Lastly, the +g flag is used on both bot records to indicate that Hubalicious is authorized to send userfiles for all channels. This is a shortcut method to sharing all channels instead of setting the `+shared` channel setting on the hub for each channel userfile you wish the hub to share (set via .chanset), and using the `|+s #channel` bot flag for each channel userfile that the leaf is authorized to receive userfiles from the hub. As an example of channel-specific userfile sharing, you would use `.botattr LiefErikson |+s #theforest` on Hubalicious to set #theforest as a channel authorized to be shared to LiefErikson, and `chanset #theforest +shared` to tell LiefErikson to accept the channel userfile for #theforest.
46
+
Lastly, the +g flag is used on both bot records to indicate that Hubalicious is authorized to send userfiles for all channels. This is a shortcut method to sharing all channels instead of setting the ``+shared`` channel setting on the hub for each channel userfile you wish the hub to share (set via .chanset), and using the ``|+s #channel`` bot flag for each channel userfile that the leaf is authorized to receive userfiles from the hub. As an example of channel-specific userfile sharing, you would use ``.botattr LiefErikson |+s #theforest`` on Hubalicious to set #theforest as a channel authorized to be shared to LiefErikson, and ``.chanset #theforest +shared`` to tell LiefErikson to accept the channel userfile for #theforest.
47
47
48
-
One more commonly used flag is the `+a` flag. This flag specifies an alternate hub to connect to in case the primary hub goes down. The alternate hub should be linked to hub and maintain all channel userfiles the hub maintains to ensure there is no desynchronization while the hub bot is down. Should the hub bot go down, and assuming the `+h` flag is set for the hub on a leaf, the leafbost will automatically try to reconnect to the hub every minute, even if it makes a connection with the alternate hub in the meantime. An alternate hub is added the same as a hub, except swapping out the `h` for the `a`: `.botattr AltRock +agp`.
48
+
One more commonly used flag is the ``+a`` flag. This flag specifies an alternate hub to connect to in case the primary hub goes down. The alternate hub should be linked to hub and maintain all channel userfiles the hub maintains to ensure there is no desynchronization while the hub bot is down. Should the hub bot go down, and assuming the ``+h`` flag is set for the hub on a leaf, the leafbost will automatically try to reconnect to the hub every minute, even if it makes a connection with the alternate hub in the meantime. An alternate hub is added the same as a hub, except swapping out the ``h`` for the ``a``: ``.botattr AltRock +agp``.
49
49
50
50
Now that you have a hub and leaf bot successfully connected and sharing userfiles, you can repeat the `On the Leaf Bot`_ section to add additional leafs to your hub.
Description: an interface to the new generic userfile support. Without an entry-type, it returns a flat key/value list (dict) of all set entries. Valid entry types are:
0 commit comments