docker-rcon-web-admin - GitLite

KO | EN

gitlite — search

#javascript #ai #go #golang #android #rust #java #cli #awesome-list #vue #security #ios #openai #open-source

docker-rcon-web-admin

(★ 121)

A Docker image that runs rcon-web-admin

File Explorer

Download Latest Version (.zip)

- - build.yml
.gitignore
docker-compose.yml
Dockerfile
LICENSE
README.md

# Installation Guide

1. Get the code

git clone https://github.com/itzg/docker-rcon-web-admin

Downloads the entire project code from GitHub to your computer.

cd docker-rcon-web-admin

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker network create rcon

Type this command into your terminal and run it.

docker run -d --name rcon-web --network rcon \

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![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
Docker container. A great benefit of running rcon-web-admin in Docker, especially
in a Docker Composition is that the RCON port of your game server
can remain securely isolated within the Docker network.

## Getting Started

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
```
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
```

With that you can follow the [regular instructions](https://github.com/rcon-web-admin/rcon-web-admin#visit-the-ui) and
access the web UI at http://YOUR_DOCKER_HOST:4326

## Options

### [Environment Variables](https://github.com/rcon-web-admin/rcon-web-admin#environment-variables)

`RWA_ENV` is preset to "TRUE" in this image, so [all of the environment variables described in rcon-web-admin](https://github.com/rcon-web-admin/rcon-web-admin#environment-variables) are available for use.

- `RWA_PASSWORD` : required to be set for the initial user (by default `admin`) password
- `RWA_RCON_HOST` : should be set to the Minecraft server's hostname, such as the service name in a Docker Compose deployment

### VOLUMEs

* /opt/rcon-web-admin/db

### PORTs

* 4326 : web UI
* 4327 : websocket access from UI

## Examples

### Running with itzg/minecraft-server

To run this with the `itzg/minecraft-server` image, simply download/modify
[this docker-compose.yml](https://github.com/itzg/docker-rcon-web-admin/raw/master/docker-compose.yml)
and then use `docker-compose` or `docker stack deploy -c` to bring up the composition.

With that particular composition, configure a new server as shown here (with an RCON password of "testing")

![](https://i.imgur.com/qTrwkaO.png)

With the server configured, go to the Dashboard and pick the server "minecraft". The following
shows adding a "Console" widget and running the "help" command against Minecraft:

![](https://i.imgur.com/UYr7I7C.png)