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