Skip to content

Commit

Permalink
docs: latest software does work, so removing deprecation notice (#19)
Browse files Browse the repository at this point in the history
  • Loading branch information
itzg authored Apr 28, 2024
1 parent 4c952f6 commit 484fba3
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 14 deletions.
46 changes: 38 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
# UNSUPPORTED

This image is no longer actively supported since the upstream software no longer successfully establishes RCON connections. Issues and PRs are welcome to make suggestions for a suitable replacement.

---

[![Docker Pulls](https://img.shields.io/docker/pulls/itzg/rcon)](https://hub.docker.com/r/itzg/rcon)

This image lets you run the [rcon-web-admin](https://github.com/rcon-web-admin/rcon-web-admin) administration tool as a
Expand All @@ -13,10 +7,46 @@ can remain securely isolated within the Docker network.

## Getting Started

To get up and running quickly, use
To get up and running quickly, it is best use Docker Compose with a `docker-compose.yml` such as:

```yaml
version: '3.3'

services:
web:
image: itzg/rcon
environment:
RWA_USERNAME: admin
RWA_PASSWORD: admin
RWA_ADMIN: "TRUE"
# is referring to the service name 'mc' declared below
RWA_RCON_HOST: mc
# needs to match the password configured for the container, see RCON_PASSWORD below
RWA_RCON_PASSWORD: "changethis!"
ports:
- "4326:4326"
- "4327:4327"
mc:
image: itzg/minecraft-server
ports:
- "25565:25565"
# DO NOT expose rcon port 25575 here
environment:
EULA: "TRUE"
RCON_PASSWORD: "changethis!"
```
To manually create containers with `docker run`s, which is **not recommended**:

1. Create a user network
```shell
docker network create rcon
```
docker run -d --name rcon-web \
2. Create minecraft container with `--network rcon` and `--network-alias=mc`
3. Create rcon-web container with `--network rcon`, `-e RWA_RCON_HOST=mc`

```shell
docker run -d --name rcon-web --network rcon \
-p 4326:4326 -p 4327:4327 \
-e RWA_PASSWORD=password \
itzg/rcon
Expand Down
10 changes: 4 additions & 6 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
version: '3.3'

services:
web:
image: itzg/rcon
Expand All @@ -12,14 +10,14 @@ services:
# needs to match the RCON_PASSWORD configured for the container
RWA_RCON_PASSWORD: "demo"
ports:
- 4326:4326
- 4327:4327
- "4326:4326"
- "4327:4327"
mc:
image: itzg/minecraft-server
ports:
- 25565:25565
- "25565:25565"
environment:
EULA: "TRUE"
# password needs to be explicitly set,
# password needs to be explicitly set,
# otherwise random one is generated at each startup
RCON_PASSWORD: "demo"

0 comments on commit 484fba3

Please sign in to comment.