Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/emilgardis/rcon-web-admin

Self hosted, online RCON administration tool for your game server.
https://github.com/emilgardis/rcon-web-admin

Last synced: about 2 months ago
JSON representation

Self hosted, online RCON administration tool for your game server.

Host: GitHub
URL: https://github.com/emilgardis/rcon-web-admin
Owner: Emilgardis
License: mit
Created: 2021-12-28T10:40:39.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2022-01-05T17:18:56.000Z (about 3 years ago)
Last Synced: 2024-10-14T15:41:01.906Z (3 months ago)
Language: JavaScript
Homepage:
Size: 803 KB
Stars: 7
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# RCON Web Admin

RCON Web Admin is a powerful web interface to control your RCON servers. All servers with RCON support should work.

This application can install and run on a server, Raspberry Pi, or other devices which are online 24/7.

Out of the box, RCON Web Admin can check users for high ping, VAC status, or filter the chat for you around the clock.

## Fork specifics

This fork of [rcon-web-admin](https://github.com/rcon-web-admin/rcon-web-admin) only needs one port (`4326`) for http and ws thanks to the work done on [Minecraft RCON Web Admin](https://github.com/chylex/Minecraft-RCON-Web-Admin).
I provide a [docker image](https://github.com/Emilgardis/RCON-Web-Admin/pkgs/container/rcon-web-admin) for this fork.

## Features

* RCON administration with your web browser
* Unlimited users and servers, admin roles can manage servers, users may use the dashboard.
* Granular user permissions to restrict access to specific server commands and interface components.
* If you wish to configure a user to only use the `say` command, you can.
* Powerful widget framework - Developers can add new dashboard components easily
* Responsive frontend which should display correctly on most devices, desktop or smartphone.
* Internationalization support
* One-click update for the core and all installed widgets
* `rcon.web` support (usually more stable than legacy RCON)
* Core widgets and their features:
* Console - Provides a console interface to directly execute and recieve output from RCON commands
* Autobot - For advanced users; an interface to write your own high-level code for automation
* Rustboard - A dedicated widget for the Rust. Provides tools such as the player & ban list, chat, kick/ban, admin/mod config, Steam info with VAC ban checking, and more
* Timed Commands - Schedule server commands you wish to execute at a specific datetime.

## Supported/tested games

* Rust (Most tested at the moment)
* Counter-Strike: Go (Basic tests with the console widget)
* Minecraft (Basic tests with the console widget)
* Note: Despite the lack of testing, all other servers with RCON support should work. The console widget is generic for all games.

## Widgets

All components of the dashboard are written as widgers. Widgets can be very simple to very complex, depending on what is necessary.
Widgets are written in HTML and JS. Visit [here](https://github.com/rcon-web-admin/rcon-web-admin/tree/master/public/widgets) for more information.

## Requirements

* NodeJS v12.13.1

## Windows Installation

* Download and install [NodeJS](https://nodejs.org)
* Download and unpack this repository

In the extracted directory, run the following commands:
```bash
$ npm install
$ node src/main.js install-core-widgets
```

## Linux Installation

> **Note**: It is strongly advised to avoid running this application as root or with `sudo`, it is not required.
> Also, avoid installing this application in a directory which can be accessed from the internet.
> This application launches a self-contained webserver with limited access to the `/public` folder.
> Failure to follow this advice could leave you vulnerable to security risks.

Run the following commands in the shell:
```bash
$ sudo apt-get install nodejs npm
$ sudo npm update npm -g
$ wget https://codeload.github.com/rcon-web-admin/rcon-web-admin/zip/master -O rcon-web-admin.zip
$ unzip rcon-web-admin.zip
$ mv rcon-web-admin-master rcon-web-admin
$ cd rcon-web-admin
$ npm install
$ node src/main.js install-core-widgets
$ chmod 0755 -R startscripts *
```

## Environment Variables

RCON Web Admin can be partially configured with environment variables. You may configure the initial user and server with these environment variables.

## Docker Usage

[itzg](https://hub.docker.com/r/itzg/) maintains a Docker image for RCON Web Admin, you can find the image [here (itzg/rcon)](https://hub.docker.com/r/itzg/rcon/).

## Linux Usage

```bash
$ sh startscripts/start-linux.sh start
$ sh startscripts/start-linux.sh stop
$ sh startscripts/start-linux.sh restart
```

## Windows Usage

```powershell
PS> startscripts/start-windows.bat
```

With basic usage, you can close the Powershell or Command Prompt window to stop the app.

## Visit the UI

With default configuration, the application will be available at http://localhost:4326 (if visiting remotely; substitute `localhost` with the IP or hostname of the host).

To modify the default port (4326) or allowed hosts, see `/config.template.js`.

## Boot script

On Linux you can automatically launch RCON Web Admin after each reboot by adding a line to crontab.

Run `crontab -e` while logged into the user you wish to execute the app on boot, and add the following line:

```shell
@reboot /path/to/startscripts/start-linux.sh start
```

## Troubleshooting

Linux: If you've installed it and `node` as not available but `nodejs` is, than create a symlink:

```shell
$ sudo ln -s $(which nodejs) /usr/bin/node
```