{"id":16620667,"url":"https://github.com/spikehd/openmcpanel","last_synced_at":"2025-10-07T06:12:06.371Z","repository":{"id":231461785,"uuid":"779792559","full_name":"SpikeHD/OpenMCPanel","owner":"SpikeHD","description":"Create, manage, and monitor one, few, or many Minecraft servers using a web-based UI.","archived":false,"fork":false,"pushed_at":"2024-04-08T00:18:56.000Z","size":351,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-17T22:44:38.295Z","etag":null,"topics":["admin-panel","deployment","minecraft","monitoring","server"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SpikeHD.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-30T20:00:44.000Z","updated_at":"2024-10-23T17:44:07.000Z","dependencies_parsed_at":"2024-04-04T05:26:23.405Z","dependency_job_id":"246d2613-e577-466f-8c13-73b45758cac1","html_url":"https://github.com/SpikeHD/OpenMCPanel","commit_stats":null,"previous_names":["spikehd/openmcpanel"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2FOpenMCPanel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2FOpenMCPanel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2FOpenMCPanel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2FOpenMCPanel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SpikeHD","download_url":"https://codeload.github.com/SpikeHD/OpenMCPanel/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242995916,"owners_count":20218829,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["admin-panel","deployment","minecraft","monitoring","server"],"created_at":"2024-10-12T02:44:53.292Z","updated_at":"2025-10-07T06:12:01.319Z","avatar_url":"https://github.com/SpikeHD.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg width=\"10%\" src=\"web/public/icons/omcp_icon.png\"\u003e\n  \u003ch1\u003eOpenMCPanel\u003c/h1\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n \u003cimg src=\"https://img.shields.io/github/actions/workflow/status/SpikeHD/OpenMCPanel/build.yml\" /\u003e\n \u003cimg src=\"https://img.shields.io/github/repo-size/SpikeHD/OpenMCPanel\" /\u003e\n \u003cimg src=\"https://img.shields.io/github/commit-activity/m/SpikeHD/OpenMCPanel\" /\u003e\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e\n \u003cimg src=\"https://img.shields.io/github/release-date/SpikeHD/OpenMCPanel\" /\u003e\n \u003cimg src=\"https://img.shields.io/github/stars/SpikeHD/OpenMCPanel\" /\u003e\n \u003cimg src=\"https://img.shields.io/github/downloads/SpikeHD/OpenMCPanel/total\" /\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n  Create, manage, and monitor one, few, or many Minecraft servers using a web-based UI. Powered by \u003ca href=\"https://github.com/itzg/docker-minecraft-server\"\u003eitzg/docker-minecraft-server\u003c/a\u003e.\n  \u003cbr /\u003e\n  https://discord.gg/agQ9mRdHMZ\n\u003c/div\u003e\n\n# Table of Contents\n\n- [Features](#features)\n- [Get Started](#get-started)\n  - [Prerequisites](#prerequisites)\n  - [Steps](#steps)\n- [Building](#building)\n  - [Prerequisites](#prerequisites-1)\n  - [Steps](#steps-1)\n- [Recommendations](#recommendations)\n\n# Features\n\n* **One-Click Server Deployment** - Deploy a Minecraft server with a single click.\n* **Multiple Server Type Support** - Vanilla, Spigot, Paper, Fabric, etc. are all supported. Modpacks and mod lists are also supported!\n* **Simple Server Management** - Start and stop, manual and scheduled backups, on-the-fly command running, and more.\n* **Realtime Monitoring** - Keep track of player count, memory usage, and more.\n\n# Get Started\n\n## Prerequisites\n\n* [Docker](https://docs.docker.com/get-docker/) (or an equivalent, such as [Podman](https://podman.io/))\n* Webserver (such as [NGINX](https://www.nginx.com/))\n\n## Steps\n\n1. Download the latest release and extract it (you can also download [an Actions build](https://www.github.com/SpikeHD/OpenMCPanel/actions/workflows/build.yml)):\n```bash\n# Windows\ncurl -L \"https://www.github.com/SpikeHD/OpenMCPanel/releases/latest/download/omcp_win64.zip\" -o omcp.zip\nunzip omcp.zip\n\n# Linux/MacOS\ncurl -L \"https://www.github.com/SpikeHD/OpenMCPanel/releases/latest/download/omcp_linux64.tar.gz\" -o omcp.tar.gz\ntar -xzf omcp.tar.gz\n```\n\n2. Run the binary:\n```bash\n# Windows\n./omcp.exe --help\n\n# Linux/MacOS\n./omcp --help\n```\n\n\u003e [!NOTE]\n\u003e If you'd just like to play around with OpenMCPanel, you can specfiy `--address \u003cyour_external_ip\u003e` which will expose the server\n\u003e **(INSECURELY, no HTTPS!)** to the web without the need for a reverse proxy. This is NOT recommended for anything more than brief testing.\n\u003e\n\u003e You can also (again, **SUPER INSECURE**, only use this for testing/evalutation) specify `--no-auth` to disable the username/password requirement.\n\u003e Again, this is NOT recommended for anything more than brief testing.\n\n3. After reviewing the options, start the server with a configuration of your liking:\n```bash\n# Windows\n./omcp.exe --log omcp.log --port 8080 --username Tester\n\n# Linux/MacOS\n./omcp --log omcp.log --port 8080 --username Tester\n```\n\n4. Open your web browser and navigate to `http://localhost:[PORT]` to access the panel! You are ready to deploy!\n\nIf you need to access the web interface remotely, make sure to configure your webserver to reverse-proxy to the port you specified\n\n# Building\n\n## Prerequisites\n\n* [Node.js](https://nodejs.org/en/download/) (or your favorite runtime)\n* [Rust and Cargo](https://www.rust-lang.org/tools/install)\n\n## Steps\n\n1. Clone the repository:\n```bash\ngit clone https://github.com/SpikeHD/OpenMCPanel.git\ncd OpenMCPanel\n```\n\n2. Install the dependencies:\n```bash\ncd web\nnpm install\n```\n\n3. Build the project:\n```bash\n# Build the frontend\nnpm run build\n\n# Build the backend\ncd ..\ncargo build --release\n```\n\nYour binary will be located at `target/release/omcp`.\n\n# Recommendations\n\n* [fail2ban](https://github.com/fail2ban/fail2ban) - Protect from brute force attacks\n\n# TODO\n\n* [ ] Multilingual support\n* [ ] Remote Docker host support\n* [ ] Custom .jar support\n\n# Contributing\n\nIssues, PRs, etc. are all welcome!\n\n# Screenshots\n\n\u003cdetails\u003e\n  \u003csummary\u003eClick to expand\u003c/summary\u003e\n  \n  ![image](https://github.com/SpikeHD/OpenMCPanel/assets/25207995/9bcb5a02-f914-4b79-9f1c-3ccf9adce331)\n  \n  ![image](https://github.com/SpikeHD/OpenMCPanel/assets/25207995/fecb8ba4-95e6-4499-806b-e4a707252af5)\n  \n  ![image](https://github.com/SpikeHD/OpenMCPanel/assets/25207995/bde6c815-7285-48ca-9495-c529e3a5432c)\n\u003c/details\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspikehd%2Fopenmcpanel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspikehd%2Fopenmcpanel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspikehd%2Fopenmcpanel/lists"}