瀏覽代碼

update docker readme

tags/v2.8.0-rc1
Daniel Thamdrup 2 年之前
父節點
當前提交
2abfa66802
共有 1 個檔案被更改,包括 25 行新增25 行删除
  1. 25
    25
      distrib/docker/README.md

+ 25
- 25
distrib/docker/README.md 查看文件

@@ -1,33 +1,33 @@
1
-# Oragono Docker
1
+# Ergo Docker
2 2
 
3
-This folder holds Oragono's Dockerfile and related materials. Oragono
3
+This folder holds Ergo's Dockerfile and related materials. Ergo
4 4
 is published automatically to Docker Hub at
5
-[oragono/oragono](https://hub.docker.com/r/oragono/oragono).
5
+[ergochat/ergo](https://hub.docker.com/r/ergochat/ergo).
6 6
 
7
-The `latest` tag tracks the `stable` branch of Oragono, which contains
7
+The `latest` tag tracks the `stable` branch of Ergo, which contains
8 8
 the latest stable release. The `dev` tag tracks the master branch, which
9 9
 may by unstable and is not recommended for production.
10 10
 
11 11
 ## Quick start
12 12
 
13
-The Oragono docker image is designed to work out of the box - it comes with a
13
+The Ergo docker image is designed to work out of the box - it comes with a
14 14
 usable default config and will automatically generate self-signed TLS
15 15
 certificates. To get a working ircd, all you need to do is run the image and
16 16
 expose the ports:
17 17
 
18 18
 ```shell
19
-docker run --name oragono -d -p 6667:6667 -p 6697:6697 oragono/oragono:tag
19
+docker run --name ergo -d -p 6667:6667 -p 6697:6697 ergochat/ergo:tag
20 20
 ```
21 21
 
22
-This will start Oragono and listen on ports 6667 (plain text) and 6697 (TLS).
23
-The first time Oragono runs it will create a config file with a randomised
22
+This will start Ergo and listen on ports 6667 (plain text) and 6697 (TLS).
23
+The first time Ergo runs it will create a config file with a randomised
24 24
 oper password. This is output to stdout, and you can view it with the docker
25 25
 logs command:
26 26
 
27 27
 ```shell
28
-# Assuming your container is named `oragono`; use `docker container ls` to
28
+# Assuming your container is named `ergo`; use `docker container ls` to
29 29
 # find the name if you're not sure.
30
-docker logs oragono
30
+docker logs ergo
31 31
 ```
32 32
 
33 33
 You should see a line similar to:
@@ -38,42 +38,42 @@ Oper username:password is admin:cnn2tm9TP3GeI4vLaEMS
38 38
 
39 39
 ## Persisting data
40 40
 
41
-Oragono has a persistent data store, used to keep account details, channel
41
+Ergo has a persistent data store, used to keep account details, channel
42 42
 registrations, and so on. To persist this data across restarts, you can mount
43 43
 a volume at /ircd.
44 44
 
45 45
 For example, to create a new docker volume and then mount it:
46 46
 
47 47
 ```shell
48
-docker volume create oragono-data
49
-docker run -d -v oragono-data:/ircd -p 6667:6667 -p 6697:6697 oragono/oragono:tag
48
+docker volume create ergo-data
49
+docker run -d -v ergo-data:/ircd -p 6667:6667 -p 6697:6697 ergochat/ergo:tag
50 50
 ```
51 51
 
52 52
 Or to mount a folder from your host machine:
53 53
 
54 54
 ```shell
55
-mkdir oragono-data
56
-docker run -d -v $(PWD)/oragono-data:/ircd -p 6667:6667 -p 6697:6697 oragono/oragono:tag
55
+mkdir ergo-data
56
+docker run -d -v $(PWD)/ergo-data:/ircd -p 6667:6667 -p 6697:6697 ergochat/ergo:tag
57 57
 ```
58 58
 
59 59
 ## Customising the config
60 60
 
61
-Oragono's config file is stored at /ircd/ircd.yaml. If the file does not
61
+Ergo's config file is stored at /ircd/ircd.yaml. If the file does not
62 62
 exist, the default config will be written out. You can copy the config from
63 63
 the container, edit it, and then copy it back:
64 64
 
65 65
 ```shell
66
-# Assuming that your container is named `oragono`, as above.
67
-docker cp oragono:/ircd/ircd.yaml .
66
+# Assuming that your container is named `ergo`, as above.
67
+docker cp ergo:/ircd/ircd.yaml .
68 68
 vim ircd.yaml # edit the config to your liking
69
-docker cp ircd.yaml oragono:/ircd/ircd.yaml
69
+docker cp ircd.yaml ergo:/ircd/ircd.yaml
70 70
 ```
71 71
 
72
-You can use the `/rehash` command to make Oragono reload its config, or
72
+You can use the `/rehash` command to make Ergo reload its config, or
73 73
 send it the HUP signal:
74 74
 
75 75
 ```shell
76
-docker kill -HUP oragono
76
+docker kill -HUP ergo
77 77
 ```
78 78
 
79 79
 ## Using custom TLS certificates
@@ -82,23 +82,23 @@ TLS certs will by default be read from /ircd/tls.crt, with a private key
82 82
 in /ircd/tls.key. You can customise this path in the ircd.yaml file if
83 83
 you wish to mount the certificates from another volume. For information
84 84
 on using Let's Encrypt certificates, see
85
-[this manual entry](https://github.com/oragono/oragono/blob/master/docs/MANUAL.md#how-do-i-use-lets-encrypt-certificates).
85
+[this manual entry](https://github.com/ergochat/ergo/blob/master/docs/MANUAL.md#using-valid-tls-certificates).
86 86
 
87 87
 ## Using docker-compose
88 88
 
89 89
 This folder contains a sample docker-compose file which can be used
90
-to start an Oragono instance with ports exposed and data persisted in
90
+to start an Ergo instance with ports exposed and data persisted in
91 91
 a docker volume. Simply download the file and then bring it up:
92 92
 
93 93
 ```shell
94
-curl -O https://raw.githubusercontent.com/oragono/oragono/master/distrib/docker/docker-compose.yml
94
+curl -O https://raw.githubusercontent.com/ergochat/ergo/master/distrib/docker/docker-compose.yml
95 95
 docker-compose up -d
96 96
 ```
97 97
 
98 98
 ## Building
99 99
 
100 100
 If you wish to manually build the docker image, you need to do so from
101
-the root of the Oragono repository (not the `distrib/docker` directory):
101
+the root of the Ergo repository (not the `distrib/docker` directory):
102 102
 
103 103
 ```shell
104 104
 docker build .

Loading…
取消
儲存