Browse Source

add --init to suggested docker run invocations (#2097)

* add --init to suggested docker run invocations

See #2096; this should fix unreaped zombies when using an auth-script or
ip-check-script that spawns its own subprocesses, then exits before reaping
them.

* add a note on why --init
tags/v2.13.0-rc1
Shivaram Lingamneni 5 months ago
parent
commit
a5af245102
No account linked to committer's email address
1 changed files with 8 additions and 3 deletions
  1. 8
    3
      distrib/docker/README.md

+ 8
- 3
distrib/docker/README.md View File

@@ -18,7 +18,7 @@ certificates. To get a working ircd, all you need to do is run the image and
18 18
 expose the ports:
19 19
 
20 20
 ```shell
21
-docker run --name ergo -d -p 6667:6667 -p 6697:6697 ghcr.io/ergochat/ergo:stable
21
+docker run --init --name ergo -d -p 6667:6667 -p 6697:6697 ghcr.io/ergochat/ergo:stable
22 22
 ```
23 23
 
24 24
 This will start Ergo and listen on ports 6667 (plain text) and 6697 (TLS).
@@ -38,6 +38,11 @@ You should see a line similar to:
38 38
 Oper username:password is admin:cnn2tm9TP3GeI4vLaEMS
39 39
 ```
40 40
 
41
+We recommend the use of `--init` (`init: true` in docker-compose) to solve an
42
+edge case involving unreaped zombie processes when Ergo's script API is used
43
+for authentication or IP validation. For more details, see
44
+[krallin/tini#8](https://github.com/krallin/tini/issues/8).
45
+
41 46
 ## Persisting data
42 47
 
43 48
 Ergo has a persistent data store, used to keep account details, channel
@@ -48,14 +53,14 @@ For example, to create a new docker volume and then mount it:
48 53
 
49 54
 ```shell
50 55
 docker volume create ergo-data
51
-docker run -d -v ergo-data:/ircd -p 6667:6667 -p 6697:6697 ghcr.io/ergochat/ergo:stable
56
+docker run --init -d -v ergo-data:/ircd -p 6667:6667 -p 6697:6697 ghcr.io/ergochat/ergo:stable
52 57
 ```
53 58
 
54 59
 Or to mount a folder from your host machine:
55 60
 
56 61
 ```shell
57 62
 mkdir ergo-data
58
-docker run -d -v $(PWD)/ergo-data:/ircd -p 6667:6667 -p 6697:6697 ghcr.io/ergochat/ergo:stable
63
+docker run --init -d -v $(PWD)/ergo-data:/ircd -p 6667:6667 -p 6697:6697 ghcr.io/ergochat/ergo:stable
59 64
 ```
60 65
 
61 66
 ## Customising the config

Loading…
Cancel
Save