GitHub/ergo
3
0
Fork 0
mirror of https://github.com/ergochat/ergo.git synced 2024-12-23 19:22:41 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1705 from dallemon/docker_readme

Browse Source 
update docker readme
This commit is contained in:
Shivaram Lingamneni 2021-06-21 19:13:40 -04:00 committed by GitHub
commit e60c2a6806
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
distrib/docker/README.md
View File

@ -1,33 +1,33 @@
# Oragono Docker
# Ergo Docker
This folder holds Oragono's Dockerfile and related materials. Oragono
This folder holds Ergo's Dockerfile and related materials. Ergo
is published automatically to Docker Hub at
[oragono/oragono](https://hub.docker.com/r/oragono/oragono).
[ergochat/ergo](https://hub.docker.com/r/ergochat/ergo).
The `latest` tag tracks the `stable` branch of Oragono, which contains
The `latest` tag tracks the `stable` branch of Ergo, which contains
the latest stable release. The `dev` tag tracks the master branch, which
may by unstable and is not recommended for production.
## Quick start
The Oragono docker image is designed to work out of the box - it comes with a
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:
```shell
docker run --name oragono -d -p 6667:6667 -p 6697:6697 oragono/oragono:tag
docker run --name ergo -d -p 6667:6667 -p 6697:6697 ergochat/ergo:tag
```
This will start Oragono and listen on ports 6667 (plain text) and 6697 (TLS).
The first time Oragono runs it will create a config file with a randomised
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:
```shell
# Assuming your container is named `oragono`; use `docker container ls` to
# Assuming your container is named `ergo`; use `docker container ls` to
# find the name if you're not sure.
docker logs oragono
docker logs ergo
```
You should see a line similar to:
@ -38,42 +38,42 @@ Oper username:password is admin:cnn2tm9TP3GeI4vLaEMS
## Persisting data
Oragono has a persistent data store, used to keep account details, channel
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:
```shell
docker volume create oragono-data
docker run -d -v oragono-data:/ircd -p 6667:6667 -p 6697:6697 oragono/oragono:tag
docker volume create ergo-data
docker run -d -v ergo-data:/ircd -p 6667:6667 -p 6697:6697 ergochat/ergo:tag
```
Or to mount a folder from your host machine:
```shell
mkdir oragono-data
docker run -d -v $(PWD)/oragono-data:/ircd -p 6667:6667 -p 6697:6697 oragono/oragono:tag
mkdir ergo-data
docker run -d -v $(PWD)/ergo-data:/ircd -p 6667:6667 -p 6697:6697 ergochat/ergo:tag
```
## Customising the config
Oragono's config file is stored at /ircd/ircd.yaml. If the file does not
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:
```shell
# Assuming that your container is named `oragono`, as above.
docker cp oragono:/ircd/ircd.yaml .
# 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 oragono:/ircd/ircd.yaml
docker cp ircd.yaml ergo:/ircd/ircd.yaml
```
You can use the `/rehash` command to make Oragono reload its config, or
You can use the `/rehash` command to make Ergo reload its config, or
send it the HUP signal:
```shell
docker kill -HUP oragono
docker kill -HUP ergo
```
## Using custom TLS certificates
@ -82,23 +82,23 @@ 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](https://github.com/oragono/oragono/blob/master/docs/MANUAL.md#how-do-i-use-lets-encrypt-certificates).
[this manual entry](https://github.com/ergochat/ergo/blob/master/docs/MANUAL.md#using-valid-tls-certificates).
## Using docker-compose
This folder contains a sample docker-compose file which can be used
to start an Oragono instance with ports exposed and data persisted in
to start an Ergo instance with ports exposed and data persisted in
a docker volume. Simply download the file and then bring it up:
```shell
curl -O https://raw.githubusercontent.com/oragono/oragono/master/distrib/docker/docker-compose.yml
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 Oragono repository (not the `distrib/docker` directory):
the root of the Ergo repository (not the `distrib/docker` directory):
```shell
docker build .