https://github.com/spikehd/openmcpanel
Create, manage, and monitor one, few, or many Minecraft servers using a web-based UI.
https://github.com/spikehd/openmcpanel
admin-panel deployment minecraft monitoring server
Last synced: 6 months ago
JSON representation
Create, manage, and monitor one, few, or many Minecraft servers using a web-based UI.
- Host: GitHub
- URL: https://github.com/spikehd/openmcpanel
- Owner: SpikeHD
- License: gpl-3.0
- Created: 2024-03-30T20:00:44.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T00:18:56.000Z (almost 2 years ago)
- Last Synced: 2025-01-17T22:44:38.295Z (about 1 year ago)
- Topics: admin-panel, deployment, minecraft, monitoring, server
- Language: TypeScript
- Homepage:
- Size: 343 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
OpenMCPanel
Create, manage, and monitor one, few, or many Minecraft servers using a web-based UI. Powered by itzg/docker-minecraft-server.
https://discord.gg/agQ9mRdHMZ
# Table of Contents
- [Features](#features)
- [Get Started](#get-started)
- [Prerequisites](#prerequisites)
- [Steps](#steps)
- [Building](#building)
- [Prerequisites](#prerequisites-1)
- [Steps](#steps-1)
- [Recommendations](#recommendations)
# Features
* **One-Click Server Deployment** - Deploy a Minecraft server with a single click.
* **Multiple Server Type Support** - Vanilla, Spigot, Paper, Fabric, etc. are all supported. Modpacks and mod lists are also supported!
* **Simple Server Management** - Start and stop, manual and scheduled backups, on-the-fly command running, and more.
* **Realtime Monitoring** - Keep track of player count, memory usage, and more.
# Get Started
## Prerequisites
* [Docker](https://docs.docker.com/get-docker/) (or an equivalent, such as [Podman](https://podman.io/))
* Webserver (such as [NGINX](https://www.nginx.com/))
## Steps
1. Download the latest release and extract it (you can also download [an Actions build](https://www.github.com/SpikeHD/OpenMCPanel/actions/workflows/build.yml)):
```bash
# Windows
curl -L "https://www.github.com/SpikeHD/OpenMCPanel/releases/latest/download/omcp_win64.zip" -o omcp.zip
unzip omcp.zip
# Linux/MacOS
curl -L "https://www.github.com/SpikeHD/OpenMCPanel/releases/latest/download/omcp_linux64.tar.gz" -o omcp.tar.gz
tar -xzf omcp.tar.gz
```
2. Run the binary:
```bash
# Windows
./omcp.exe --help
# Linux/MacOS
./omcp --help
```
> [!NOTE]
> If you'd just like to play around with OpenMCPanel, you can specfiy `--address ` which will expose the server
> **(INSECURELY, no HTTPS!)** to the web without the need for a reverse proxy. This is NOT recommended for anything more than brief testing.
>
> You can also (again, **SUPER INSECURE**, only use this for testing/evalutation) specify `--no-auth` to disable the username/password requirement.
> Again, this is NOT recommended for anything more than brief testing.
3. After reviewing the options, start the server with a configuration of your liking:
```bash
# Windows
./omcp.exe --log omcp.log --port 8080 --username Tester
# Linux/MacOS
./omcp --log omcp.log --port 8080 --username Tester
```
4. Open your web browser and navigate to `http://localhost:[PORT]` to access the panel! You are ready to deploy!
If you need to access the web interface remotely, make sure to configure your webserver to reverse-proxy to the port you specified
# Building
## Prerequisites
* [Node.js](https://nodejs.org/en/download/) (or your favorite runtime)
* [Rust and Cargo](https://www.rust-lang.org/tools/install)
## Steps
1. Clone the repository:
```bash
git clone https://github.com/SpikeHD/OpenMCPanel.git
cd OpenMCPanel
```
2. Install the dependencies:
```bash
cd web
npm install
```
3. Build the project:
```bash
# Build the frontend
npm run build
# Build the backend
cd ..
cargo build --release
```
Your binary will be located at `target/release/omcp`.
# Recommendations
* [fail2ban](https://github.com/fail2ban/fail2ban) - Protect from brute force attacks
# TODO
* [ ] Multilingual support
* [ ] Remote Docker host support
* [ ] Custom .jar support
# Contributing
Issues, PRs, etc. are all welcome!
# Screenshots
Click to expand
