Skip to content

Commit 74a1782

Browse files
vanosgyosifkit
authored andcommitted
Update eggdrop docs (#799)
* Update eggdrop content.md
1 parent 18fd84b commit 74a1782

File tree

1 file changed

+33
-5
lines changed

1 file changed

+33
-5
lines changed

eggdrop/content.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,29 @@ To run this container the first time, you'll need to pass in, at minimum, a nick
1414
$ docker run -ti -e NICK=FooBot -e SERVER=irc.freenode.net -v /path/for/host/data:/home/eggdrop/eggdrop/data eggdrop
1515
```
1616

17-
should be used. This will modify the appropriate values within the config file, then start your bot with the nickname FooBot and connect it to irc.freenode.net.
17+
should be used. This will modify the appropriate values within the config file, then start your bot with the nickname FooBot and connect it to irc.freenode.net. These variables are only needed for your first run- after the first use, you can edit the config file directly. Additional configuration options are listed in the following sections.
1818

19-
These variables are only needed for your first run- after the first use, you can edit the config file directly.
19+
Please note that, even in daemon mode, the `-i` flag for `docker run` is required.
20+
21+
## Environmental Variables
22+
23+
### `SERVER`
24+
25+
This variable sets the IRC server Eggdrop will connect to. Examples are:
26+
27+
```console
28+
-e SERVER=just.a.normal.server
29+
-e SERVER=you.need.to.change.this:6667
30+
-e SERVER=another.example.com:7000:password
31+
-e SERVER=[2001:db8:618:5c0:263::]:6669:password
32+
-e SERVER=ssl.example.net:+6697
33+
```
34+
35+
Only one server can be specified via an environmental variable. The + denotes an SSL-enabled port. After the first run, it is advised to edit the eggdrop config directly to add additional servers (see Long-term Persistence below).
36+
37+
### `NICK`
38+
39+
This variable sets the nickname used by eggdrop. After the first use, you should change it by editing the eggdrop config directly (see Long-term Persistence below).
2040

2141
## Long-term Persistence
2242

@@ -26,15 +46,23 @@ After running the eggdrop container for the first time, the configuration file,
2646
$ docker run -i -e NICK=FooBot -e SERVER=irc.freenode.net -v /path/to/eggdrop/files:/home/eggdrop/eggdrop/data -d eggdrop
2747
```
2848

29-
Please note that, even in daemon mode, the `-i` flag for `docker run` is required.
49+
If you provide your own config file, specify it as the argument to the docker container:
50+
51+
```console
52+
$ docker run -i -v /path/to/eggdrop/files:/home/eggdrop/eggdrop/data -d eggdrop mybot.conf
53+
```
54+
55+
Any config file used with docker MUST end in .conf, such as eggdrop.conf or mybot.conf
3056

3157
## Adding scripts
3258

33-
An easy way to add scripts would be to create a scripts directory on the host and mount it to `/home/eggdrop/eggdrop/data`. This would be accomplished by adding an option similar to
59+
An easy way to add scripts would be to create a scripts directory on the host and mount it to `/home/eggdrop/eggdrop/scripts` (or the path of your choosing). This would be accomplished by adding an option similar to
3460

61+
```console
3562
-v /path/to/host/scripts:/home/eggdrop/eggdrop/scripts
63+
```
3664

37-
to your docker run command line (and of course, don't forget to edit your configuration file to actually load it!)
65+
to your docker run command line (and then edit your config file to load the scripts from the path that matches where you mounted the scripts dir).
3866

3967
## Exposing network ports
4068

0 commit comments

Comments
 (0)