Bläddra i källkod

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
tags/v2.9.0-rc1
erin 2 år sedan
förälder
incheckning
b8e38819d8
2 ändrade filer med 9 tillägg och 9 borttagningar
  1. 2
    2
      distrib/docker/README.md
  2. 7
    7
      docs/MANUAL.md

+ 2
- 2
distrib/docker/README.md Visa fil

@@ -1,7 +1,7 @@
1 1
 # Ergo Docker
2 2
 
3
-This folder holds Ergo's Dockerfile and related materials. Ergo
4
-is published automatically to the GitHub Container Registry at
3
+This folder holds Ergo's Docker compose file. The Dockerfile is in the root 
4
+directory. Ergo is published automatically to the GitHub Container Registry at
5 5
 [ghcr.io/ergochat/ergo](https://ghcr.io/ergochat/ergo).
6 6
 
7 7
 Most users should use either the `stable` tag (corresponding to the

+ 7
- 7
docs/MANUAL.md Visa fil

@@ -135,11 +135,11 @@ To start the server, type `./ergo run` and hit enter, and the server should be r
135 135
 
136 136
 ## Docker
137 137
 
138
-1. Pull the latest version of Ergo: `docker pull oragono/oragono:latest`
139
-1. Create a volume for persistent data: `docker volume create oragono-data`
140
-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`
138
+1. Pull the latest version of Ergo: `docker pull ghcr.io/ergochat/ergo:stable`
139
+1. Create a volume for persistent data: `docker volume create ergo-data`
140
+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`
141 141
 
142
-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).
142
+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).
143 143
 
144 144
 
145 145
 ## Building from source
@@ -170,8 +170,8 @@ Ergo can also be configured using environment variables, using the following tec
170 170
 
171 171
 1. Find the "path" of the config variable you want to override in the YAML file, e.g., `server.websockets.allowed-origins`
172 172
 1. Convert each path component from "kebab case" to "screaming snake case", e.g., `SERVER`, `WEBSOCKETS`, and `ALLOWED_ORIGINS`.
173
-1. Prepend `ORAGONO` to the components, then join them all together using `__` as the separator, e.g., `ORAGONO__SERVER__WEBSOCKETS__ALLOWED_ORIGINS`.
174
-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"]'`
173
+1. Prepend `ERGO` to the components, then join them all together using `__` as the separator, e.g., `ERGO__SERVER__WEBSOCKETS__ALLOWED_ORIGINS`.
174
+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"]'`
175 175
 
176 176
 However, settings that were overridden using this technique cannot be rehashed --- changing them will require restarting the server.
177 177
 
@@ -1134,7 +1134,7 @@ Note that after a failed script invocation, Ergo will proceed to check the crede
1134 1134
 
1135 1135
 ## DNSBLs and other IP checking systems
1136 1136
 
1137
-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.
1137
+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.
1138 1138
 
1139 1139
 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:
1140 1140
 

Laddar…
Avbryt
Spara