{"id":15035839,"url":"https://github.com/mcsmanager/mcsmanager","last_synced_at":"2026-01-22T15:21:08.919Z","repository":{"id":37041566,"uuid":"110395561","full_name":"MCSManager/MCSManager","owner":"MCSManager","description":"Free, Secure, Distributed, Modern Control Panel for Minecraft and most Steam Game Servers.","archived":false,"fork":false,"pushed_at":"2025-05-07T02:49:48.000Z","size":49350,"stargazers_count":3777,"open_issues_count":151,"forks_count":408,"subscribers_count":27,"default_branch":"master","last_synced_at":"2025-05-07T03:36:38.717Z","etag":null,"topics":["docker","mcsmanager","minecraft","minecraft-server-software","nodejs","server-web-panel","steam-game-server-manager","webshell"],"latest_commit_sha":null,"homepage":"https://mcsmanager.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MCSManager.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":null,"patreon":"MCSManager","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"polar":null,"custom":null}},"created_at":"2017-11-12T01:41:58.000Z","updated_at":"2025-05-07T02:49:53.000Z","dependencies_parsed_at":"2023-11-15T05:31:38.304Z","dependency_job_id":"2dd0a71b-2b3b-4e32-b0e9-e6aa0c1ee0c9","html_url":"https://github.com/MCSManager/MCSManager","commit_stats":null,"previous_names":["suwings/mcsmanager"],"tags_count":78,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MCSManager%2FMCSManager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MCSManager%2FMCSManager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MCSManager%2FMCSManager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MCSManager%2FMCSManager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MCSManager","download_url":"https://codeload.github.com/MCSManager/MCSManager/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254020615,"owners_count":22000755,"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":["docker","mcsmanager","minecraft","minecraft-server-software","nodejs","server-web-panel","steam-game-server-manager","webshell"],"created_at":"2024-09-24T20:29:36.008Z","updated_at":"2026-01-18T01:41:47.605Z","avatar_url":"https://github.com/MCSManager.png","language":"TypeScript","readme":"\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://mcsmanager.com/\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://public-link.oss-cn-shenzhen.aliyuncs.com/mcsm_picture/logo.png\" alt=\"MCSManagerLogo.png\" width=\"510px\" /\u003e    \n  \u003c/a\u003e\n\n  \u003cbr /\u003e\n  \u003cbr /\u003e\n\n[![--](https://img.shields.io/badge/Support%20Platform-Windows/Linux/Mac-green.svg)](https://github.com/MCSManager)\n[![Status](https://img.shields.io/badge/NPM-v8.9.14-blue.svg)](https://www.npmjs.com/)\n[![Status](https://img.shields.io/badge/Node-v16.20.2-blue.svg)](https://nodejs.org/en/download/)\n[![Status](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/MCSManager)\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"http://mcsmanager.com/\"\u003e\u003cimg alt=\"Official Website\" src=\"https://img.shields.io/badge/Site-Official Website-yellow\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://docs.mcsmanager.com/\"\u003e\u003cimg alt=\"EnglishDocs\" src=\"https://img.shields.io/badge/Docs-English Document-blue\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://discord.gg/BNpYMVX7Cd\"\u003e\u003cimg alt=\"Discord\" src=\"https://img.shields.io/badge/Discord-Join Us-5866f4\"\u003e\u003c/a\u003e\n  \n\u003c/p\u003e\n\n\u003cbr /\u003e\n\n[English](README.md) - [简体中文](README_ZH.md) - [繁體中文](README_TW.md) - [日本語](README_JP.md) - [Deutsch](README_DE.md) - [Русский](README_RU.md) - [Spanish](README_ES.md) - [Thai](README_TH.md) - [Français](README_FR.md) - [Português BR](README_PTBR.md)\n\n\u003c/div\u003e\n\n\u003cbr /\u003e\n\n## What is this?\n\n**MCSManager Panel** (or simply **MCSM Panel**) is a fast-deploying, distributed, multi-user, and modern web-based management panel for **`Minecraft`**, **`Steam`**, and other game servers.\n\nMCSManager has gained popularity within the **`Minecraft`** and **`Steam`** gaming communities. It enables you to manage multiple physical or virtual servers from a single platform, and offers a **secure**, **reliable**, and **granular multi-user permission system**. The MCSM Panel continues to support server administrators, operators, and independent developers, managing servers like **`Minecraft`**, **`Terraria`**, and other **`Steam`**-based games for them.\n\nMCSM also has **commercial applications** in mind, such as private server hosting and sales by **IDC service providers**. Several small and medium-sized enterprises already use the panel as a combined **server management** and **sales platform**. In addition, it supports **multi-language environments**, making it accessible to users across different countries and regions.\n\n\u003cimg width=\"1871\" height=\"1342\" alt=\"terminal\" src=\"https://github.com/user-attachments/assets/7f6ed988-e402-4347-94ee-a0469f6658da\" /\u003e\n\n\u003cimg width=\"1915\" height=\"1386\" alt=\"market\" src=\"https://github.com/user-attachments/assets/fc276180-a826-476a-803e-a038f97115fc\" /\u003e\n\n\u003cimg width=\"3164\" height=\"2060\" alt=\"1\" src=\"https://github.com/user-attachments/assets/570d2447-66dc-4c0b-b2d2-4c3176b51d67\" /\u003e\n\n\u003cimg width=\"3164\" height=\"2060\" alt=\"3\" src=\"https://github.com/user-attachments/assets/2722cf9f-de9b-4630-b0ea-c00283791d8d\" /\u003e\n\n\u003cbr /\u003e\n\n## Features\n\n1. One-click deployment of **`Minecraft`** or **`Steam`** game servers via the built-in application marketplace.\n2. Compatible with most **`Steam`**-based game servers, including **`Palworld`**, **`Squad`**, **`Project Zomboid`**, **`Terraria`**, and more.\n3. Customizable web interface with drag-and-drop card layout to build your ideal dashboard.\n4. Full **Docker Hub** image support, with built-in multi-user access and support for commercial instance hosting services.\n5. Distributed architecture, managing multiple machines from a single web panel.\n6. Lightweight technology stack. The entire project can be developed and maintained with TypeScript alone.\n7. ...and much more.\n\n\u003cbr /\u003e\n\n## Runtime Environment\n\nThe control panel runs on both **`Windows`** and **`Linux`** platforms. No database installation is required. Simply install the **`Node.js`** runtime and a few basic **decompression utilities**.\n\n\u003e Requires **[Node.js 16.20.2](https://nodejs.org/en)** or higher.\n\u003e It is recommended to use the **latest LTS version** for best compatibility and stability.\n\n\u003cbr /\u003e\n\n## Official Documentation\n\nEnglish: https://docs.mcsmanager.com/\n\nChinese: https://docs.mcsmanager.com/zh_cn/\n\n\u003cbr /\u003e\n\n## Installation\n\n### Windows\n\n**For Windows systems, it comes as a ready-to-run integrated version - download and run it immediately.**\n\nArchive: https://download.mcsmanager.com/mcsmanager_windows_release.zip\n\nDouble-click `start.bat` to launch both the web panel and daemon process.\n\n\u003cbr /\u003e\n\n### Linux\n\n**One-line command quick installation**\n\n```bash\nsudo su -c \"wget -qO- https://script.mcsmanager.com/setup.sh | bash\"\n```\n\n**Usage after installation**\n\n```bash\nsystemctl start mcsm-{web,daemon} # Start panel\nsystemctl stop mcsm-{web,daemon}  # Stop panel\n```\n\n- Script only applies to Ubuntu/Centos/Debian/Archlinux\n- Panel code and runtime environment are automatically installed in the `/opt/mcsmanager/` directory.\n\n\u003cbr /\u003e\n\n**Linux Manual Installation**\n\n- If the one-click installation method doesn't work, you can install MCSManager manually by following the steps below:\n\n```bash\n# Step 1: Navigate to the installation directory (create it if it doesn't exist)\ncd /opt/\n\n# Step 2: (Optional) Download and install Node.js if it's not already installed\nwget https://nodejs.org/dist/v20.11.0/node-v20.11.0-linux-x64.tar.xz\ntar -xvf node-v20.11.0-linux-x64.tar.xz\n\n# Add Node.js and npm to the system path\nln -s /opt/node-v20.11.0-linux-x64/bin/node /usr/bin/node\nln -s /opt/node-v20.11.0-linux-x64/bin/npm /usr/bin/npm\n\n# Step 3: Prepare the MCSManager installation directory\nmkdir /opt/mcsmanager/\ncd /opt/mcsmanager/\n\n# Step 4: Download the latest MCSManager release\nwget https://github.com/MCSManager/MCSManager/releases/latest/download/mcsmanager_linux_release.tar.gz\ntar -zxf mcsmanager_linux_release.tar.gz\n\n# Step 5: Install dependencies\nchmod 775 install.sh\n./install.sh\n\n# Step 6: Open two terminal windows or use screen/tmux\n\n# In the first terminal: start the daemon\n./start-daemon.sh\n\n# In the second terminal: start the web service\n./start-web.sh\n\n# Step 7: Access the panel in your browser\n# Replace \u003cpublic IP\u003e with your server's actual IP address\nhttp://\u003cpublic IP\u003e:23333/\n\n# The web interface will automatically detect and connect to the local daemon in most cases.\n```\n\n\u003e The above steps do **not** register the panel as a system service.  \n\u003e To keep it running in the background, you’ll need to use tools like **`screen`** or **`tmux`**.\n\nIf you prefer to run MCSManager as a system service, please refer to the official documentation for setup instructions.\n\n\u003cbr /\u003e\n\n### Mac OS\n\n```bash\n\n# Step 1: Install Node.js (skip if already installed)\n# It's recommended to use the latest LTS version\nbrew install node\nnode -v\nnpm -v\n\n# Step 2: Download the latest release using curl\ncurl -L https://github.com/MCSManager/MCSManager/releases/latest/download/mcsmanager_linux_release.tar.gz -o mcsmanager_linux_release.tar.gz\n\n# Step 3: Extract the downloaded archive\ntar -zxf mcsmanager_linux_release.tar.gz\n\n# Step 4: Enter the extracted directory\ncd mcsmanager\n\n# Step 5: Make the installer executable and run it\nchmod 775 install.sh\n./install.sh\n\n# Step 6: Open two terminal windows or use screen/tmux to run services in parallel\n\n# In the first terminal: start the daemon\n./start-daemon.sh\n\n# In the second terminal: start the web service\n./start-web.sh\n\n# Access the panel at: http://localhost:23333/\n# The web interface will typically auto-detect and connect to the local daemon.\n```\n\n\u003cbr /\u003e\n\n### Docker Installation\n\nInstall the panel using docker-compose.yml, note that you need to modify all `\u003cCHANGE_ME_TO_INSTALL_PATH\u003e` in it to your actual installation directory.\n\n```yml\nservices:\n  web:\n    image: githubyumao/mcsmanager-web:latest\n    ports:\n      - \"23333:23333\"\n    volumes:\n      - /etc/localtime:/etc/localtime:ro\n      - \u003cCHANGE_ME_TO_INSTALL_PATH\u003e/web/data:/opt/mcsmanager/web/data\n      - \u003cCHANGE_ME_TO_INSTALL_PATH\u003e/web/logs:/opt/mcsmanager/web/logs\n\n  daemon:\n    image: githubyumao/mcsmanager-daemon:latest\n    restart: unless-stopped\n    ports:\n      - \"24444:24444\"\n    environment:\n      - MCSM_DOCKER_WORKSPACE_PATH=\u003cCHANGE_ME_TO_INSTALL_PATH\u003e/daemon/data/InstanceData\n    volumes:\n      - /etc/timezone:/etc/timezone:ro\n      - /etc/localtime:/etc/localtime:ro\n      - \u003cCHANGE_ME_TO_INSTALL_PATH\u003e/daemon/data:/opt/mcsmanager/daemon/data\n      - \u003cCHANGE_ME_TO_INSTALL_PATH\u003e/daemon/logs:/opt/mcsmanager/daemon/logs\n      - /var/run/docker.sock:/var/run/docker.sock\n```\n\nEnable using docker-compose.\n\n```bash\nmkdir -p \u003cCHANGE_ME_TO_INSTALL_PATH\u003e\ncd \u003cCHANGE_ME_TO_INSTALL_PATH\u003e\nvim docker-compose.yml # Write the above docker-compose.yml content here\ndocker compose pull \u0026\u0026 docker compose up -d\n```\n\nNote: After Docker installation, the Web side may no longer be able to automatically connect to the Daemon.\n\nAt this point, if you enter the panel, you should see some errors because the Web side has not successfully connected to the daemon side, you need to create a new node to connect them together.\n\n\u003cbr /\u003e\n\n## Contributing Code\n\nBefore contributing code to this project, please make sure to review the following:\n\n- **Must read:** [Issue #599 – Contribution Guidelines](https://github.com/MCSManager/MCSManager/issues/599)\n- Please maintain the existing code structure and formatting, **do not apply unnecessary or excessive formatting changes.**\n- All submitted code **must follow internationalization (i18n) standards**.\n\n\u003cbr /\u003e\n\n## Development\n\n### Project Structure\n\nThe project comprises three core modules:\n\n- Daemon backend (`daemon` directory)\n- Web backend (`panel` directory)\n- Web frontend (`frontend` directory)\n\n**Web Backend Responsibilities:**\n\n- User management\n- Node connectivity\n- Authentication and authorization\n- API services\n\n**Daemon Backend Responsibilities:**\n\n- Process management for server instances\n- Docker container operations\n- File system management\n- Real-time terminal access\n\n**Web Frontend Responsibilities:**\n\n- User interface implementation\n- Web backend integration\n- Direct node communication for optimized performance\n\n### Setting Up Development Environment\n\nSee: [DEVELOPMENT.md](./DEVELOPMENT.md)\n\n\u003cbr /\u003e\n\n## Browser Compatibility\n\nMCSManager supports all major modern browsers, including:\n\n- `Chrome`\n- `Firefox`\n- `Safari`\n- `Opera`\n\n**Internet Explorer (IE)** is no longer supported.\n\n\u003cbr /\u003e\n\n## Bug Reports\n\nWe welcome all bug reports and feedback. Your contributions help us improve the project.\n\nIf you encounter any issues, please report them via the [GitHub Issues](https://github.com/MCSManager/MCSManager/issues) page, and we’ll address them as soon as possible.\n\nFor serious **security vulnerabilities** that should not be disclosed publicly, please contact us directly at: **support@mcsmanager.com**\n\nOnce resolved, we will credit the discoverer in the relevant code or release notes.\n\n\u003cbr /\u003e\n\n## Contributors\n\n\u003ca href=\"https://openomy.com/MCSManager/MCSManager\" target=\"_blank\" style=\"display: block; width: 100%;\" align=\"center\"\u003e\n  \u003cimg src=\"https://openomy.com/svg?repo=MCSManager/MCSManager\u0026chart=bubble\u0026latestMonth=12\" target=\"_blank\" alt=\"Contribution Leaderboard\" style=\"display: block; width: 100%;\" /\u003e\n\u003c/a\u003e\n\n## License\n\nThis project is licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).\n\n\u0026copy; 2025 MCSManager. All rights reserved.\n","funding_links":["https://patreon.com/MCSManager"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmcsmanager%2Fmcsmanager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmcsmanager%2Fmcsmanager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmcsmanager%2Fmcsmanager/lists"}