From fba41a26df7a6754c2be9a767cd7a4610da7efd1 Mon Sep 17 00:00:00 2001 From: erin Date: Fri, 3 Dec 2021 11:10:52 -0800 Subject: [PATCH 1/2] Update docker repo location in docs and docker-compose.yml --- distrib/docker/docker-compose.yml | 2 +- docs/MANUAL.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/distrib/docker/docker-compose.yml b/distrib/docker/docker-compose.yml index de44d26f..969d9239 100644 --- a/distrib/docker/docker-compose.yml +++ b/distrib/docker/docker-compose.yml @@ -2,7 +2,7 @@ version: "3.8" services: ergo: - image: ergochat/ergo:latest + image: ghcr.io/ergochat/ergo:stable ports: - "6667:6667/tcp" - "6697:6697/tcp" diff --git a/docs/MANUAL.md b/docs/MANUAL.md index 99be905b..b9449c2c 100644 --- a/docs/MANUAL.md +++ b/docs/MANUAL.md @@ -137,7 +137,7 @@ To start the server, type `./ergo run` and hit enter, and the server should be r 1. Pull the latest version of Ergo: `docker pull oragono/oragono:latest` 1. Create a volume for persistent data: `docker volume create oragono-data` -1. Run the container, exposing the default ports: `docker run -d --name oragono -v oragono-data:/ircd-data -p 6667:6667 -p 6697:6697 oragono/oragono:latest` +1. Run the container, exposing the default ports: `docker run -d --name oragono -v oragono-data:/ircd-data -p 6667:6667 -p 6697:6697 ghcr.io/ergochat/ergo:stable` For further information and a sample docker-compose file see the separate [Docker documentation](https://github.com/oragono/oragono/blob/master/distrib/docker/README.md). From b8e38819d83d15cc1bab0d62942c8742e3e05e5e Mon Sep 17 00:00:00 2001 From: erin Date: Fri, 3 Dec 2021 12:07:05 -0800 Subject: [PATCH 2/2] Update oragono references to ergo - Environment variable prefix - DNSBL repo URI - Project and repo names in link to Docker-specific instructions - Docker container and volume names in docker run command --- distrib/docker/README.md | 4 ++-- docs/MANUAL.md | 14 +++++++------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/distrib/docker/README.md b/distrib/docker/README.md index 5b480716..ea638a0b 100644 --- a/distrib/docker/README.md +++ b/distrib/docker/README.md @@ -1,7 +1,7 @@ # Ergo Docker -This folder holds Ergo's Dockerfile and related materials. Ergo -is published automatically to the GitHub Container Registry at +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](https://ghcr.io/ergochat/ergo). Most users should use either the `stable` tag (corresponding to the diff --git a/docs/MANUAL.md b/docs/MANUAL.md index b9449c2c..5fd8c9ce 100644 --- a/docs/MANUAL.md +++ b/docs/MANUAL.md @@ -135,11 +135,11 @@ To start the server, type `./ergo run` and hit enter, and the server should be r ## Docker -1. Pull the latest version of Ergo: `docker pull oragono/oragono:latest` -1. Create a volume for persistent data: `docker volume create oragono-data` -1. Run the container, exposing the default ports: `docker run -d --name oragono -v oragono-data:/ircd-data -p 6667:6667 -p 6697:6697 ghcr.io/ergochat/ergo:stable` +1. Pull the latest version of Ergo: `docker pull ghcr.io/ergochat/ergo:stable` +1. Create a volume for persistent data: `docker volume create ergo-data` +1. Run the container, exposing the default ports: `docker run -d --name ergo -v ergo-data:/ircd -p 6667:6667 -p 6697:6697 ghcr.io/ergochat/ergo:stable` -For further information and a sample docker-compose file see the separate [Docker documentation](https://github.com/oragono/oragono/blob/master/distrib/docker/README.md). +For further information and a sample docker-compose file see the separate [Docker documentation](https://github.com/ergochat/ergo/blob/master/distrib/docker/README.md). ## Building from source @@ -170,8 +170,8 @@ Ergo can also be configured using environment variables, using the following tec 1. Find the "path" of the config variable you want to override in the YAML file, e.g., `server.websockets.allowed-origins` 1. Convert each path component from "kebab case" to "screaming snake case", e.g., `SERVER`, `WEBSOCKETS`, and `ALLOWED_ORIGINS`. -1. Prepend `ORAGONO` to the components, then join them all together using `__` as the separator, e.g., `ORAGONO__SERVER__WEBSOCKETS__ALLOWED_ORIGINS`. -1. Set the environment variable of this name to a JSON (or YAML) value that will be deserialized into this config field, e.g., `export ORAGONO__SERVER__WEBSOCKETS__ALLOWED_ORIGINS='["https://irc.example.com", "https://chat.example.com"]'` +1. Prepend `ERGO` to the components, then join them all together using `__` as the separator, e.g., `ERGO__SERVER__WEBSOCKETS__ALLOWED_ORIGINS`. +1. Set the environment variable of this name to a JSON (or YAML) value that will be deserialized into this config field, e.g., `export ERGO__SERVER__WEBSOCKETS__ALLOWED_ORIGINS='["https://irc.example.com", "https://chat.example.com"]'` However, settings that were overridden using this technique cannot be rehashed --- changing them will require restarting the server. @@ -1134,7 +1134,7 @@ Note that after a failed script invocation, Ergo will proceed to check the crede ## DNSBLs and other IP checking systems -Similarly, Ergo can be configured to call arbitrary scripts to validate user IPs. These scripts can either reject the connection, or require that the user log in with SASL. In particular, we provide an [oragono-dnsbl](https://github.com/oragono/oragono-dnsbl) plugin for querying DNSBLs. +Similarly, Ergo can be configured to call arbitrary scripts to validate user IPs. These scripts can either reject the connection, or require that the user log in with SASL. In particular, we provide an [ergo-dnsbl](https://github.com/ergochat/ergo-dnsbl) plugin for querying DNSBLs. The API is similar to the auth-script API described above (one line of JSON in, one line of JSON out). The input is a JSON dictionary with the following keys: