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

update docker readme

Browse Source
This commit is contained in:
Shivaram Lingamneni 2021-11-28 01:26:36 -05:00
parent 72b51c00de
commit 0344e99bc6
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
distrib/docker/README.md
View File

@ -1,12 +1,14 @@
# Ergo Docker # Ergo Docker
This folder holds Ergo's Dockerfile and related materials. Ergo This folder holds Ergo's Dockerfile and related materials. Ergo
is published automatically to Docker Hub at is published automatically to the GitHub Container Repository at
[ergochat/ergo](https://hub.docker.com/r/ergochat/ergo). [ghcr.io/ergochat/ergo](https://ghcr.io/ergochat/ergo).
The `latest` tag tracks the `stable` branch of Ergo, which contains Most users should use either the `stable` tag (corresponding to the
the latest stable release. The `dev` tag tracks the master branch, which `stable` branch in git, which tracks the latest stable release), or
may by unstable and is not recommended for production. 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 ## Quick start
@ -16,7 +18,7 @@ certificates. To get a working ircd, all you need to do is run the image and
expose the ports: expose the ports:
```shell ```shell
docker run --name ergo -d -p 6667:6667 -p 6697:6697 ergochat/ergo:tag docker run --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). This will start Ergo and listen on ports 6667 (plain text) and 6697 (TLS).
@ -46,14 +48,14 @@ For example, to create a new docker volume and then mount it:
```shell ```shell
docker volume create ergo-data docker volume create ergo-data
docker run -d -v ergo-data:/ircd -p 6667:6667 -p 6697:6697 ergochat/ergo:tag docker run -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: Or to mount a folder from your host machine:
```shell ```shell
mkdir ergo-data mkdir ergo-data
docker run -d -v $(PWD)/ergo-data:/ircd -p 6667:6667 -p 6697:6697 ergochat/ergo:tag docker run -d -v $(PWD)/ergo-data:/ircd -p 6667:6667 -p 6697:6697 ghcr.io/ergochat/ergo:stable
``` ```
## Customising the config ## Customising the config