mirror/MCSManager
2
0
Fork 1
mirror of https://github.com/MCSManager/MCSManager.git synced 2024-11-27 06:59:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

发布 MCSM9 源代码

Browse Source
This commit is contained in:
Suwings 2022-02-02 13:35:59 +08:00
parent 7f3fc734c2
commit 05a9171fd0
1 changed files with 69 additions and 91 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

160
README.md
View File

@ -1,69 +1,59 @@
![doc_logo.png](/public/common/doc_logo.png)
[![Status](https://img.shields.io/badge/npm-v6.9.0-blue.svg)](https://www.npmjs.com/)
[![Status](https://img.shields.io/badge/node-v10.16.0-blue.svg)](https://nodejs.org/en/download/)
[![Status](https://travis-ci.org/Suwings/MCSManager.svg?branch=master)](https://travis-ci.org/Suwings/MCSManager)
[![Status](https://img.shields.io/badge/License-MIT-red.svg)](https://github.com/Suwings/MCSManager)
![doc_logo.png](/docs/logo.png)
[![Status](https://img.shields.io/badge/npm-v6.14.15-blue.svg)](https://www.npmjs.com/)
[![Status](https://img.shields.io/badge/node-v14.17.6-blue.svg)](https://nodejs.org/en/download/)
[![Status](https://img.shields.io/badge/License-GPL-red.svg)](https://github.com/Suwings/MCSManager)
简单，易用，多实例，轻量级的 Minecraft Server 控制面板
简单，易用，多实例，轻量级的 Minecraft Server 控制面板
[官方网站](http://mcsmanager.com/) | [中文简体](https://github.com/Suwings/MCSManager) | [中文繁體](README-traditional.md) | [API 文档](https://github.com/Suwings/MCSManager/wiki/API-Documentation) | [二次开发参考文档](https://github.com/Suwings/MCSManager/wiki/Development_Document)
[官方网站](http://mcsmanager.com/) | [中文简体](https://github.com/Suwings/MCSManager) | [中文繁體](README-traditional.md) | [API 文档](https://github.com/Suwings/MCSManager/wiki/API-Documentation) | [二次开发参考文档](https://github.com/Suwings/MCSManager/wiki/Development_Document)
<br />
简介
-----------
## 简介
这是一款可以管理多个 Minecraft 服务端（支持群组端）的 Web 管理面板，并且可以分配多个子账号来分别管理不同的 Minecraft 服务端，支持绝大部分主流的服务端，甚至是其他非 Minecraft 的程序。
控制面板可运行在 Windows 与 Linux 平台，无需数据库与任何系统配置，只需安装 node 环境即可快速运行，属于轻量级的 Minecraft 服务端控制面板。
![main_theme.png](/public/common/main_theme.png)
![main_theme.png](docs/panel.png)
<br />
运行环境
-----------
推荐 `Node 10.16.0` 以上，无需数据库和更改任何系统配置，开箱即可运行。
## 运行环境
必须 `Node 14.17.0` 以上，无需数据库和更改任何系统配置，开箱即可运行。
<br />
## 配置与数据文件
配置文件
-----------
配置文件是程序目录下的 `property.js` 文件，它会在你第一次运行的时候，自动生成。
> 此文件不会与 github 版本冲突，git pull 更新时也不会自动覆盖。
<br />
## 常见问题
常见问题
-----------
| 问题 | 详情 |
| ------------------------ | --------------------------------------------------------------------------------------------- |
无法正常安装面板？| [参考教程](https://github.com/Suwings/MCSManager/wiki/Linux-%E4%B8%8B%E5%AE%89%E8%A3%85%E4%B8%8E%E4%BD%BF%E7%94%A8%E8%AF%A6%E8%A7%A3)
Linux 下面板如何后台运行？ | [参考方法](https://github.com/Suwings/MCSManager/wiki/Linux-%E4%B8%8B%E5%AE%89%E8%A3%85%E4%B8%8E%E4%BD%BF%E7%94%A8%E8%AF%A6%E8%A7%A3#%E4%BF%9D%E6%8C%81%E5%90%8E%E5%8F%B0%E8%BF%90%E8%A1%8C)
使用面板开启 `Bedrock Server` 端 | [参考教程](https://github.com/Suwings/MCSManager/wiki/%E4%BD%BF%E7%94%A8%E9%9D%A2%E6%9D%BF%E5%BC%80%E5%90%AF-Bedrock_server-%E6%9C%8D%E5%8A%A1%E7%AB%AF)
面板管理员的默认账号和密码是什么？ | 账号 `#master` 密码 `123456`
面板如何正确关闭？ | `Ctrl+C`
配置文件是什么？ | `property.js` 文件
如何修改面板默认端口？ | `property.js` 文件
如何配置反向代理？ | [Apache 配置参考教程](https://github.com/Suwings/MCSManager/wiki/%E4%BD%BF%E7%94%A8-Apache2.4-%E8%BF%9B%E8%A1%8C%E5%8F%8D%E5%90%91%E4%BB%A3%E7%90%86)
配好反向代理却无法使用？ | [Apache](https://github.com/Suwings/MCSManager/issues/34) [Nginx](https://github.com/Suwings/MCSManager/issues/22) [宝塔上的Nginx](https://github.com/Suwings/MCSManager/wiki/%E5%85%B3%E4%BA%8E%E5%AE%9D%E5%A1%94%E9%9D%A2%E6%9D%BF%E7%9A%84-Nginx-%E5%8F%8D%E5%90%91%E4%BB%A3%E7%90%86%E4%BB%A5%E5%8F%8ASSL%E8%AF%81%E4%B9%A6%E9%83%A8%E7%BD%B2)
反代后文件管理偶尔失效? | 请检查反代机器的防火墙是否拦截
我能修改登录页面吗？| [修改教程](https://github.com/Suwings/MCSManager/wiki/%E8%87%AA%E5%AE%9A%E4%B9%89%E4%BF%AE%E6%94%B9%E7%99%BB%E5%BD%95%E9%A1%B5%E9%9D%A2)
其他常见问题 | [查看 Wiki](https://github.com/Suwings/MCSManager/wiki)
关于HTTP跳转HTTPS的帮助 | [查看 Nginx 301永久重定向 范例](https://github.com/Suwings/MCSManager/wiki/Nginx%E5%85%A8%E5%B1%80301%E6%B0%B8%E4%B9%85%E9%87%8D%E5%AE%9A%E5%90%91)
| 问题 | 详情 |
| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 无法正常安装面板？ | [参考教程](https://github.com/Suwings/MCSManager/wiki/Linux-%E4%B8%8B%E5%AE%89%E8%A3%85%E4%B8%8E%E4%BD%BF%E7%94%A8%E8%AF%A6%E8%A7%A3) |
| Linux 下面板如何后台运行？ | [参考方法](https://github.com/Suwings/MCSManager/wiki/Linux-%E4%B8%8B%E5%AE%89%E8%A3%85%E4%B8%8E%E4%BD%BF%E7%94%A8%E8%AF%A6%E8%A7%A3#%E4%BF%9D%E6%8C%81%E5%90%8E%E5%8F%B0%E8%BF%90%E8%A1%8C) |
| 使用面板开启 `Bedrock Server` 端 | [参考教程](https://github.com/Suwings/MCSManager/wiki/%E4%BD%BF%E7%94%A8%E9%9D%A2%E6%9D%BF%E5%BC%80%E5%90%AF-Bedrock_server-%E6%9C%8D%E5%8A%A1%E7%AB%AF) |
| 面板管理员的默认账号和密码是什么？ | 账号 `#master` 密码 `123456` |
| 面板如何正确关闭？ | `Ctrl+C` |
| 配置文件是什么？ | `property.js` 文件 |
| 如何修改面板默认端口？ | `property.js` 文件 |
| 如何配置反向代理？ | [Apache 配置参考教程](https://github.com/Suwings/MCSManager/wiki/%E4%BD%BF%E7%94%A8-Apache2.4-%E8%BF%9B%E8%A1%8C%E5%8F%8D%E5%90%91%E4%BB%A3%E7%90%86) |
| 配好反向代理却无法使用？ | [Apache](https://github.com/Suwings/MCSManager/issues/34) [Nginx](https://github.com/Suwings/MCSManager/issues/22) [宝塔上的 Nginx](https://github.com/Suwings/MCSManager/wiki/%E5%85%B3%E4%BA%8E%E5%AE%9D%E5%A1%94%E9%9D%A2%E6%9D%BF%E7%9A%84-Nginx-%E5%8F%8D%E5%90%91%E4%BB%A3%E7%90%86%E4%BB%A5%E5%8F%8ASSL%E8%AF%81%E4%B9%A6%E9%83%A8%E7%BD%B2) |
| 反代后文件管理偶尔失效? | 请检查反代机器的防火墙是否拦截 |
| 我能修改登录页面吗？ | [修改教程](https://github.com/Suwings/MCSManager/wiki/%E8%87%AA%E5%AE%9A%E4%B9%89%E4%BF%AE%E6%94%B9%E7%99%BB%E5%BD%95%E9%A1%B5%E9%9D%A2) |
| 其他常见问题 | [查看 Wiki](https://github.com/Suwings/MCSManager/wiki) |
| 关于 HTTP 跳转 HTTPS 的帮助 | [查看 Nginx 301 永久重定向 范例](https://github.com/Suwings/MCSManager/wiki/Nginx%E5%85%A8%E5%B1%80301%E6%B0%B8%E4%B9%85%E9%87%8D%E5%AE%9A%E5%90%91) |
<br />
## MCSManager 9.0 版本大更新
MCSManager 9.0 版本大更新
-----------
现在已处于测试阶段，请点击 `star`使其增加以支持开发团队，目前您依然可以继续使用 MCSManager 8.X 版本程序。
[MCSManager 网页界面项目](https://github.com/Suwings/MCSManager-UI)
@ -72,10 +62,8 @@ MCSManager 9.0 版本大更新
<br />
## 在 Windows 运行
在 Windows 运行
-----------
对于 Windows 系统，**已整合成直接运行版本，下载即可运行**(建议使用管理员权限运行):
http://mcsm.suwings.top/ (官方站点)
@ -84,11 +72,9 @@ http://mcsm.suwings.top/ (官方站点)
<br />
## 在 Linux 运行
在 Linux 运行
-----------
**一行命令快速安装（适用于AMD64架构 Ubuntu/Centos/Debian/Archlinux）**
**一行命令快速安装（适用于 AMD64 架构 Ubuntu/Centos/Debian/Archlinux）**
```bash
wget -qO- https://gitee.com/Suwingser/MCSManager-installer/raw/master/install.sh | bash
@ -120,20 +106,18 @@ cd mcsmanager/
# 安装依赖库
npm install
# 启动面板
npm start
npm start
# 关闭面板使用 Ctrl+C 快捷键即可
```
- 注意，这种安装方式不会自动注册面板到系统服务（Service），所以必须使用 `screen` 软件来管理。
- 或者您可以 [点击这里](https://github.com/Suwings/MCSManager/wiki/%E4%BD%BF%E7%94%A8-systemctl-%E7%AE%A1%E7%90%86%E5%99%A8) 来手动配置面板到系统
> 关于更多的安装说明，请 [单击这里](https://github.com/Suwings/MCSManager/wiki/Linux-%E4%B8%8B%E5%AE%89%E8%A3%85%E4%B8%8E%E4%BD%BF%E7%94%A8%E8%AF%A6%E8%A7%A3)
> 关于更多的安装说明，请 [单击这里](https://github.com/Suwings/MCSManager/wiki/Linux-%E4%B8%8B%E5%AE%89%E8%A3%85%E4%B8%8E%E4%BD%BF%E7%94%A8%E8%AF%A6%E8%A7%A3)
<br />
在 MacOS 运行
-----------
## 在 MacOS 运行
安装 `node`, `npm`, 和 `homebrew`
@ -162,9 +146,7 @@ npm start
<br />
通过 Docker 启动 MC 服务端
-----------
## 通过 Docker 启动 MC 服务端
我们支持面板在 Linux 系统下，配合 Docker 以命令的形式，来创建 Minecraft 服务端所需 Java 环境镜像，并且在容器中启动和关闭你的 Minecraft 服务端。
@ -174,50 +156,46 @@ npm start
**安装 Docker:** [单击跳转](https://github.com/Suwings/MCSManager/blob/gh-pages/Question_2.md)
<br />
## 项目目录结构
项目目录结构
-----------
**注意:** 并不是所有目录的文件我们都建议你进行更改！
| 目录名 | 详情/解释 |
| ------------------------ | --------------------------------------------------------------------------------------------- |
| **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](https://github.com/Suwings/IndependentFileManager))|
| 目录名 | 详情/解释 |
| --------------------------------- | ------------------------------------------------------------------------------------------------------ |
| **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](https://github.com/Suwings/IndependentFileManager)) |
<br />
浏览器兼容性
-----------
## 浏览器兼容性
- `ECMAScript 5` 标准
- `IE 11+` `Chrome` `Firefox` `Safari` `Opera` 等现代主流浏览器
**例外:** 文件在线管理界面需要 `IE 11+`
**例外:** 文件在线管理界面需要 `IE 11+`
<br />
反向代理 与 SSL
-----------
## 反向代理 与 SSL
尽管默认没有 Https ，您可能在公共网络下不太放心，但是我们不传递明文的密码，可以保证你的账号的密码是难以泄露的。
@ -227,7 +205,7 @@ npm start
反向代理之前，建议你阅读 `property.js` 文件
> 里面有各类的设置，包括 gzip压缩，端口和ip绑定等等。
> 里面有各类的设置，包括 gzip 压缩，端口和 ip 绑定等等。
**实现 HTTPS 与 WSS**
@ -243,12 +221,12 @@ npm start
[SSL 功能实现示例](https://github.com/Suwings/MCSManager/issues/146)
**注意:** [Nginx 反向代理注意](https://github.com/Suwings/MCSManager/issues/22) | [Apache 反向代理注意](https://github.com/Suwings/MCSManager/issues/34) | [关于 Caddy 反向代理坑](https://github.com/Suwings/MCSManager/issues/122)
**注意:** [Nginx 反向代理注意](https://github.com/Suwings/MCSManager/issues/22) | [Apache 反向代理注意](https://github.com/Suwings/MCSManager/issues/34) | [关于 Caddy 反向代理坑](https://github.com/Suwings/MCSManager/issues/122)
<br />
权限系统
-----------
## 权限系统
尤其注意的是，为了更加简化面板权限系统，我们只分为两种账号。
`管理账号` 凡是以 # 字符开头的用户，均为管理账号，列如 `#master` `#admin` `#test`
@ -261,8 +239,8 @@ npm start
<br />
问题报告
-----------
## 问题报告
欢迎发现任何 BUG 及时反馈，必当及时修复。
若发现严重安全漏洞又不便公开发布，请发送邮件至: Suwings@outlook.com，安全问题修复后将在代码中附加漏洞发现者姓名。