Skip to content

Latest commit

 

History

History
113 lines (83 loc) · 3.64 KB

README.md

File metadata and controls

113 lines (83 loc) · 3.64 KB
Raw

Ergo Docker

This folder holds Ergo's Docker compose file. The Dockerfile is in the root directory. Ergo is published automatically to the GitHub Container Registry at ghcr.io/ergochat/ergo.

Most users should use either the stable tag (corresponding to the stable branch in git, which tracks the latest stable release), or a tag corresponding to a tagged version (e.g. v2.8.0). The master tag corresponds to the master branch, which is not recommended for production use. The latest tag is not recommended.

Quick start

The Ergo docker image is designed to work out of the box - it comes with a usable default config and will automatically generate self-signed TLS certificates. To get a working ircd, all you need to do is run the image and expose the ports:

docker run --init --name ergo -d -p 6667:6667 -p 6697:6697 ghcr.io/ergochat/ergo:stable

This will start Ergo and listen on ports 6667 (plain text) and 6697 (TLS). The first time Ergo runs it will create a config file with a randomised oper password. This is output to stdout, and you can view it with the docker logs command:

# Assuming your container is named `ergo`; use `docker container ls` to
# find the name if you're not sure.
docker logs ergo

You should see a line similar to:

Oper username:password is admin:cnn2tm9TP3GeI4vLaEMS

We recommend the use of --init (init: true in docker-compose) to solve an edge case involving unreaped zombie processes when Ergo's script API is used for authentication or IP validation. For more details, see krallin/tini#8.

Persisting data

Ergo has a persistent data store, used to keep account details, channel registrations, and so on. To persist this data across restarts, you can mount a volume at /ircd.

For example, to create a new docker volume and then mount it:

docker volume create ergo-data
docker run --init -d -v ergo-data:/ircd -p 6667:6667 -p 6697:6697 ghcr.io/ergochat/ergo:stable

Or to mount a folder from your host machine:

mkdir ergo-data
docker run --init -d -v $(PWD)/ergo-data:/ircd -p 6667:6667 -p 6697:6697 ghcr.io/ergochat/ergo:stable

Customising the config

Ergo's config file is stored at /ircd/ircd.yaml. If the file does not exist, the default config will be written out. You can copy the config from the container, edit it, and then copy it back:

# Assuming that your container is named `ergo`, as above.
docker cp ergo:/ircd/ircd.yaml .
vim ircd.yaml # edit the config to your liking
docker cp ircd.yaml ergo:/ircd/ircd.yaml

You can use the /rehash command to make Ergo reload its config, or send it the HUP signal:

docker kill -s SIGHUP ergo

Using custom TLS certificates

TLS certs will by default be read from /ircd/tls.crt, with a private key in /ircd/tls.key. You can customise this path in the ircd.yaml file if you wish to mount the certificates from another volume. For information on using Let's Encrypt certificates, see this manual entry.

Using docker-compose

This folder contains a sample docker-compose file which can be used to start an Ergo instance with ports exposed and data persisted in a docker volume. Simply download the file and then bring it up:

curl -O https://raw.githubusercontent.com/ergochat/ergo/master/distrib/docker/docker-compose.yml
docker-compose up -d

Building

If you wish to manually build the docker image, you need to do so from the root of the Ergo repository (not the distrib/docker directory):

docker build .