OpenMCPanel

Table of Contents

• Features
• Get Started
• Prerequisites
• Steps
• Building
• Prerequisites
• Steps
• 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 (or an equivalent, such as Podman)
• Webserver (such as NGINX)

Steps

1. Download the latest release and extract it (you can also download an Actions build): ```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 ```

1. 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 <your_external_ip> 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.

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

1. 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 (or your favorite runtime)
• Rust and Cargo

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 - Protect from brute force attacks

TODO

• [ ] Multilingual support
• [ ] Remote Docker host support
• [ ] Custom .jar support

Contributing

Issues, PRs, etc. are all welcome!

Screenshots