/MCSManager

轻量级,开箱即用,多实例和支持 Docker 的 Minecraft 服务端管理面板

Primary LanguageJavaScriptMIT LicenseMIT

doc_logo.png

Status Status Status Status

简单,易用,多实例,轻量级的 Minecraft Server 控制面板

官方网站 | 中文简体 | 中文繁體 | API 文档 | 二次开发参考文档


本项目 赞助者名单

简介

这是一款可以管理多个 Minecraft 服务端(支持群组端)的 Web 管理面板,并且可以分配多个子账号来分别管理不同的 Minecraft 服务端,支持绝大部分主流的服务端,甚至是其他非 Minecraft 的程序。

控制面板可运行在 Windows 与 Linux 平台,无需数据库与任何系统配置,只需安装 node 环境即可快速运行,属于轻量级的 Minecraft 服务端控制面板。

main_theme.png


运行环境

推荐 Node 10.16.0 以上,无需数据库和更改任何系统配置,开箱即可运行。


配置文件

配置文件是程序目录下的 property.js 文件,它会在你第一次运行的时候,自动生成。

此文件不会与 github 版本冲突,git pull 更新时也不会自动覆盖。


常见问题

问题 详情
无法正常安装面板? 参考教程
Linux 下面板如何后台运行? 参考方法
使用面板开启 Bedrock Server 参考教程
面板管理员的默认账号和密码是什么? 账号 #master 密码 123456
面板如何正确关闭? Ctrl+C
配置文件是什么? property.js 文件
如何修改面板默认端口? property.js 文件
如何配置反向代理? Apache 配置参考教程
配好反向代理却无法使用? Apache Nginx 宝塔上的Nginx
反代后文件管理偶尔失效? 请检查反代机器的防火墙是否拦截
我能修改登录页面吗? 修改教程
其他常见问题 查看 Wiki
关于HTTP跳转HTTPS的帮助 查看 Nginx 301永久重定向 范例

在 Windows 运行

对于 Windows 系统,已整合成直接运行版本,下载即可运行(建议使用管理员权限运行):

http://mcsm.suwings.top/ (官方站点)

  • 前往官方网站下载 Windows 版本即可,双击 运行.batStart.bat 文件即可。

在 Linux 运行

一行命令快速安装(适用于AMD64架构 Ubuntu/Centos/Debian/Archlinux)

wget -qO- https://gitee.com/Suwingser/MCSManager-installer/raw/master/install.sh | bash
  • 执行完成后,使用 systemctl start mcsm 即可启动面板服务。
  • 面板代码与运行环境自动安装在 /opt/ 目录下。

其他 Linux 发行版安装

  • 若一键安装不起作用,则可以尝试此步骤手动安装。
# 切换到安装目录,没有此目录请执行 mkdir /opt/
cd /opt/
# 下载运行环境
wget https://npm.taobao.org/mirrors/node/v12.16.1/node-v12.16.1-linux-x64.tar.gz
# 解压文件
tar -zxvf node-v12.16.1-linux-x64.tar.gz
# 链接程序到环境变量中
ln -s /opt/node-v12.16.1-linux-x64/bin/node /usr/bin/node
ln -s /opt/node-v12.16.1-linux-x64/bin/npm /usr/bin/npm
# 克隆仓库(若没有 git,请安装它,如 apt install -y git)
git clone https://github.com/suwings/mcsmanager.git
# 进入目录
cd mcsmanager/
# 安装依赖库
npm install
# 启动面板
npm start 
# 关闭面板使用 Ctrl+C 快捷键即可
  • 注意,这种安装方式不会自动注册面板到系统服务(Service),所以必须使用 screen 软件来管理。
  • 或者您可以 点击这里 来手动配置面板到系统

关于更多的安装说明,请 单击这里


MCSManager 9.0 版本

现在已处于开发阶段,请点击 star使其增加以支持开发团队,目前您依然可以继续使用 MCSManager 8.X 版本程序。

MCSManager 网页界面项目

MCSManager 守护进程项目


通过 Docker 启动 MC 服务端

我们支持面板在 Linux 系统下,配合 Docker 以命令的形式,来创建 Minecraft 服务端所需 Java 环境镜像,并且在容器中启动和关闭你的 Minecraft 服务端。

如果你不会使用,请点击具体使用方法 链接,如果你还未安装 Docker 请点击 安装Docker 的链接。

具体使用方法: 单击跳转

安装 Docker: 单击跳转


项目目录结构

注意: 并不是所有目录的文件我们都建议你进行更改!

目录名 详情/解释
property.js 控制面板配置文件
core/logo.txt               控制台输出 logo 文字
public/ 前端所有代码,资源目录,前后端分离,使用 ws 和 ajax 通讯
public/login/               纯 UI 逻辑登陆页面
public/template/             前端业务模板,每个模板拥有着一个生命周期,开始与结束。
public/onlinefs_public/       文件在线管理模块前端所有代码
public/common/js/meum.js 控制面板左侧菜单列表
public/common/js/login.js 通用登录流程逻辑,可重复利用在各类 HTML 登录模板
server/server_core           Minecraft 服务端核心目录,包括服务端文件,配置,Mod,以及插件
server/x.json               Minecraft 服务器面板配置文件
users/x.json               控制面板用户配置文件
route/                     控制器,HTTP 请求业务逻辑层(可二次扩展)
route/websocket/             控制器,Webscoket 请求业务逻辑层(可二次扩展)
core/Process/               Minecraft Server 类实现
core/User/                   User 类实现
core/DataModel.js             数据持久化模型,几乎是所有的配置的 I/O 模型
model/                     模型层,用于提供控制器与服务端,用户操作,也提供设计模式模型
helper/                     业务逻辑辅助层,用于辅助和重复利用业务逻辑
onlinefs/                     文件管理独立模块 (Suwings/IndependentFileManager)

浏览器兼容性

  • ECMAScript 5 标准
  • IE 11+ Chrome Firefox Safari Opera 等现代主流浏览器

例外: 文件在线管理界面需要 IE 11+


自定义设计

你可以对前端以及后端进行任何程度的修改,包括版权声明。


反向代理 与 SSL

尽管默认没有 Https ,您可能在公共网络下不太放心,但是我们不传递明文的密码,可以保证你的账号的密码是难以泄露的。

具体密码传递过程可参考 单击这里跳转

Property 文件

反向代理之前,建议你阅读 property.js 文件

里面有各类的设置,包括 gzip压缩,端口和ip绑定等等。

实现 HTTPS 与 WSS

打开前端 URL 定位文件 public/common/URL.js, 将 http 与 ws 改成 https 与 wss;

可保证前端所有请求均为 https 和 wss,但是后端方面还需要配置 SSL 与 反向代理。

反向代理

后端请通过反向代理完成,或自行修改 Express 初始化 App。

Apache 反向代理教程

SSL 功能实现示例

注意: Nginx 反向代理注意 | Apache 反向代理注意 | 关于 Caddy 反向代理坑


权限系统

尤其注意的是,为了更加简化面板权限系统,我们只分为两种账号。

管理账号 凡是以 # 字符开头的用户,均为管理账号,列如 #master #admin #test

普通账号 不以 # 字符开头的用户,列如 test usernameww xxx

普通账号能够管理的服务器只能由管理账号来进行设定,管理账号可以管理任何服务器,并且能管理所有用户。

具体使用,我想你只需要运行就知道,设计的十分简单。


问题报告

欢迎发现任何 BUG 及时反馈,必当及时修复。

若发现严重安全漏洞又不便公开发布,请发送邮件至: Suwings@outlook.com,安全问题修复后将在代码中附加漏洞发现者姓名。


开源协议

MIT License