You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Daniel Oaks 2a9b9fe802
Merge pull request #9 from csmith/instructions
3 days ago
Dockerfile grab the amd64 build, not the arm64 one (thanks @csmith) 2 weeks ago
README.md Add instructions, update compose file. 4 days ago
docker-compose.yml Add instructions, update compose file. 4 days ago
run.sh Entrypoint/exec fix suggested by @csmith, and some more metadata 2 weeks ago

README.md

Oragono Docker

This repo holds Oragono’s Dockerfiles and related materials.

Tags

The following tags are available:

  • dev - latest development version; published periodically (may be unstable)

Quick start

The Oragono 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 -d -P oragono/oragono:tag

This will start Oragono and listen on ports 6667 (plain text) and 6697 (TLS).

Persisting data

Oragono 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 oragono-data
docker run -d -v oragono-data:/ircd -P oragono/oragono:tag

Or to mount a folder from your host machine:

mkdir oragono-data
docker run -d -v $(PWD)/oragono-data:/ircd -P oragono/oragono:tag

Customising the config

Oragono’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:

# These commands assume the container is named `oragono`
# If you didn't name it, use `docker container ls` to find the name
docker cp oragono:/ircd/ircd.yaml .
vim ircd.yaml # edit the config to your liking
docker cp ircd.yaml oragono:/ircd/ircd.yaml

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

docker kill -HUP oragono

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 repository contains a sample docker-compose file which can be used to start an Oragono 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/oragono/oragono-docker/master/docker-compose.yml
docker-compose up -d