Browse Source

Update README, switch docker-compose to :latest

Add instructions about finding the oper password, and detail
the new :latest tag.

Switch the docker-compose file to :latest as you probably
want a stable version by default.

Closes #10; closes #11
pull/12/head
Chris Smith 5 years ago
parent
commit
7781c60007
2 changed files with 20 additions and 5 deletions
  1. 19
    4
      README.md
  2. 1
    1
      docker-compose.yml

+ 19
- 4
README.md View File

@@ -7,7 +7,8 @@ related materials.
7 7
 
8 8
 The following tags are available:
9 9
 
10
- * `dev` - latest development version; published periodically (may be unstable)
10
+ * `latest` - latest stable release
11
+ * `dev` - latest development version (may be unstable)
11 12
 
12 13
 ## Quick start
13 14
 
@@ -17,10 +18,25 @@ certificates. To get a working ircd, all you need to do is run the image and
17 18
 expose the ports:
18 19
 
19 20
 ```shell
20
-docker run -d -P oragono/oragono:tag
21
+docker run --name oragono -d -P oragono/oragono:tag
21 22
 ```
22 23
 
23 24
 This will start Oragono and listen on ports 6667 (plain text) and 6697 (TLS).
25
+The first time Oragono runs it will create a config file with a randomised
26
+oper password. This is output to stdout, and you can view it with the docker
27
+logs command:
28
+
29
+```shell
30
+# Assuming your container is named `oragono`; use `docker container ls` to
31
+# find the name if you're not sure.
32
+docker logs oragono
33
+```
34
+
35
+You should see a line similar to:
36
+
37
+```
38
+Oper username:password is dan:cnn2tm9TP3GeI4vLaEMS
39
+```
24 40
 
25 41
 ## Persisting data
26 42
 
@@ -49,8 +65,7 @@ exist, the default config will be written out. You can copy the config from
49 65
 the container, edit it, and then copy it back:
50 66
 
51 67
 ```shell
52
-# These commands assume the container is named `oragono`
53
-# If you didn't name it, use `docker container ls` to find the name
68
+# Assuming that your container is named `oragono`, as above.
54 69
 docker cp oragono:/ircd/ircd.yaml .
55 70
 vim ircd.yaml # edit the config to your liking
56 71
 docker cp ircd.yaml oragono:/ircd/ircd.yaml

+ 1
- 1
docker-compose.yml View File

@@ -2,7 +2,7 @@ version: "3.2"
2 2
 
3 3
 services:
4 4
   oragono:
5
-    image: oragono/oragono:dev
5
+    image: oragono/oragono:latest
6 6
     ports:
7 7
       - "6667:6667/tcp"
8 8
       - "6697:6697/tcp"

Loading…
Cancel
Save