Skip to content

Add new env var docs for develop tag #2255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jan 2, 2023
Merged

Add new env var docs for develop tag #2255

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7fe8477
Add package install directions
vanosg Mar 15, 2022
b96979e
change irc servers
vanosg Mar 15, 2022
7bc6f76
fix formatting
vanosg Mar 15, 2022
2b29d45
Update server env docs
vanosg Jun 9, 2022
210c326
Finish sentence
vanosg Jun 9, 2022
fe7661f
Merge branch 'master' of github.com:docker-library/docs
vanosg Jun 9, 2022
4b78b43
typo fix
vanosg Jun 9, 2022
d093924
Add new env var docs for develop
vanosg Jan 2, 2023
9616656
Merge branch 'docker-library:master' into master
vanosg Jan 2, 2023
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
12 changes: 12 additions & 0 deletions eggdrop/content.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,18 @@ This variable sets the nickname used by eggdrop. After the first use, you should

This variable will set the TCP port that Eggdrop will listen for incoming connections on (the equivilent of `listen XXXX all` in the config). If you set this, you will likely need to adjust the `-p` flag to match in your `docker run` command.

### `EGGOWNER` (available for testing in develop tag only)

This variable creates the first account handle for Eggdrop. This is the handle you will log in with, and will have full owner permissions. If you use this environment variable, you must also set the EGGOWNER_PASS environment variable or the container will not start. It can only be used the first time Eggdrop is run. If you are providing your own config file (not using one the one generated by docker on first run), you must add "source scripts/docker.tcl" to the end of your config file to enable this functionality. This variable may be removed after the first run of a container.

### `EGGOWNER_PASS` (available for testing in develop tag only)

This variable sets the password for the EGGOWNER handle. Setting it without setting the EGGOWNER environment variable will not do anything. This variable may be removed after the first run of a container.

### `CHANNELS` (available for testing in develop tag only)

This variable contains a list of channels Eggdrop will attempt to create when the container runs (if they do not already exist). The format for this variable is a comma-separated list (CHANNELS=#chan1,chan2,#chan3"). This variable can be removed once a channel has been added.

## Long-term Persistence

After running the eggdrop container for the first time, the configuration file, user file and channel file will all be available inside the container at `/home/eggdrop/eggdrop/data/` . HOWEVER! These files are only as persistent as the container they exist in. If you expect to use a different container over the course of using the Eggdrop docker image (intentionally or not) you will want to create a persistent data store.
Expand Down