Skip to content

Commit d392684

Browse files
committed
update readme
1 parent de722b7 commit d392684

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,26 +17,48 @@ to ensure the Minecraft server is stopped gracefully when the container is sent
1717
Enable debug logging
1818
-detach-stdin
1919
Don't forward stdin and allow process to be put in background
20+
-named-pipe string
21+
Optional path to create and read a named pipe for console input
22+
-remote-console
23+
Allow remote shell connections over SSH to server console
2024
-shell string
2125
When set, pass the arguments to this shell
26+
-stop-command string
27+
Which command to send to the server to stop it (default "stop")
2228
-stop-duration duration
2329
Amount of time in Golang duration to wait after sending the 'stop' command.
2430
-stop-server-announce-delay duration
2531
Amount of time in Golang duration to wait after announcing server shutdown
32+
-websocket-address string
33+
Bind address for websocket server (env WEBSOCKET_ADDRESS) (default "0.0.0.0:80")
34+
-websocket-allowed-origins value
35+
Comma-separated list of trusted origins (env WEBSOCKET_ALLOWED_ORIGINS)
36+
-websocket-console
37+
Allow remote shell over websocket
38+
-websocket-disable-authentication
39+
Disable websocket authentication (env WEBSOCKET_DISABLE_AUTHENTICATION)
40+
-websocket-disable-origin-check
41+
Disable checking if origin is trusted (env WEBSOCKET_DISABLE_ORIGIN_CHECK)
42+
-websocket-log-buffer-size int
43+
Number of log lines to save and send to connecting clients (env WEBSOCKET_LOG_BUFFER_SIZE) (default 50)
44+
-websocket-password string
45+
Password will be the same as RCON_PASSWORD if unset (env WEBSOCKET_PASSWORD)
2646
```
2747

2848
The `-stop-server-announce-delay` can by bypassed by sending a `SIGUSR1` signal to the `mc-server-runner` process.
2949
This works in cases where a prior `SIGTERM` has already been sent **and** in cases where no prior signal has been sent.
3050

3151
## Development Testing
3252

33-
Start a golang container for building and execution. The port is only needed for remote console functionality:
34-
53+
Start a golang container for building and execution:
54+
> Port 2222 is used for remote ssh console
55+
Port 80 is used for remote websocket console
3556
```bash
3657
docker run -it --rm \
3758
-v ${PWD}:/build \
3859
-w /build \
3960
-p 2222:2222 \
61+
-p 80:80 \
4062
golang:1.19
4163
```
4264

0 commit comments

Comments
 (0)