added a trivial documentation

README.md

@@ -1,2 +1,103 @@
-# egg
+# Eggdrop botpack
 
+## What
+This repo contains a botpack based on `Eggdrop` (https://www.eggheads.org) with `netbots` TCL botnet control script and a brand new `getops.mod` routine.
+
+## Howto
+
+### Installation
+For every bot you've to install, please `scp/rsync/cp` the `ngbot.sh` script into bot's homedir.  
+Then, run:
+```sh
+./ngbot.sh --all
+```
+Adjust the `eggdrop.conf` file with suitable values, then run the eggdrop:
+```sh
+cd ~/bot1
+./eggdrop -m eggdrop.conf
+```
+
+### First access to bots
+Login to every bot via `telnet` or `nc` / `ncat` command:
+```
+nc ip_address port
+```
+Then type `NEW` as first user to the bot, then create our user typing our login user and then our login password.  
+
+### Create a botnet
+
+#### Add the first user
+
+Only on the HUB bot, add our hostname:
+```
+.+host loginuser *!user@vhost
+```
+
+#### Adding the leaf bots to the hub
+
+Login to the HUB bot via `telnet` or `nc` / `ncat` command:
+```
+nc ip_address port
+```
+Then use your login credentials to access to party line.
+
+Now add all the leaf bots to the hub.
+
+For every leaf type:
+```
+.+bot LeafName ip_address listen_port
+.chattr LeafName +fo
+.botattr LeafName +sl
+.+host LeafName nick!user@vhost
+```
+
+#### Adding the hub bot to every leaf bot
+
+Login to the leaf bot via `telnet` or `nc` / `ncat` command:
+```
+nc ip_address port
+```
+Then use your login credentials to access to party line.
+
+Now add the hub bot to all the leafs.
+
+Into every leaf type:
+```
+.+bot HubName ip_address listen_port
+.chattr HubName +fo
+.botattr HubName +ph
+```
+
+After few seconds / one minute, you can see the linking results and you can see the botnet with the following command:
+```
+.bottree
+- Link    = Encrypted link    + Userfile Sharing
+------------------------------------------------
+Hub
+  |-+LeafOne
+  |-+LeafTwo
+  `-+LeafThree
+------------------------------------------------
+```
+
+After all the bots are properly linked, the netbots tcl has to recognize the botnet.  
+One the HUB type:
+```
+.netbots add LeafOne LeafTwo LeafThree
+```
+And you can see on the hub:
+```
+Added LeafOne LeafTwo LeafThree to the netbot list
+```
+On the leafs you can see:
+```
+Hub: chattr LeafOne +bfloZ
+Hub: chattr LeafTwo +bfloZ
+Hub: chattr LeafThree +bfloZ
+```
+
+Now you can control the botnet via `netbots.tcl` commands
+
+## Security
+
+For security reasons, we recommend to use a VPN like `WireGuard` to safe communications among bots.