hexparrot/mineos

Node.JS MineOS 镜像文档

镜像概述和主要用途

MineOS是一个Minecraft服务器管理前端工具，基于Node.js开发。相比传统Python版本，它利用Node.js的事件触发、异步模型及WebSocket技术，实现实时系统健康监控、磁盘内存使用统计和日志展示。该工具旨在简化Minecraft服务器的日常管理任务，适用于各类Linux和BSD系统。

核心功能和特性

• 实时监控：通过Web界面实时展示系统健康状态、磁盘与内存使用情况及服务器日志
• 服务器管理：支持创建/删除服务器、启动/重启/停止/终止服务器进程
• 数据管理：提供备份、归档、按计划备份及从恢复点恢复功能，可删除旧归档释放空间
• 配置管理：可视化编辑server.properties配置文件，支持选择FTB或Mojang官方服务器包
• 任务自动化：创建定时任务(cronjobs)，任务配置保存为可移植的cron.config格式
• 多服务器支持：兼容Pocketmine(PHAR格式)和BungeeCord服务器
• 安全认证：通过系统/etc/shadow文件进行身份验证，记录所有用户操作日志
• 运行模式：支持后台守护进程运行，可通过upstart/supervisord实现异常自动重启
• 命令行接口：提供CLI工具支持脚本化操作

使用场景和适用范围

适用于需要管理单个或多个Minecraft服务器的管理员，尤其适合以下场景：

• 希望通过Web界面直观管理服务器的用户
• 需要实时监控服务器状态和资源使用的场景
• 需自动化执行备份、重启等常规任务的服务器运维
• 管理不同类型Minecraft服务器(Pocketmine、BungeeCord等)的需求

已在Debian、Ubuntu、ArchLinux和FreeBSD系统测试通过，兼容大多数Linux和BSD变体。

详细使用方法和配置说明

前置要求

• 需root权限(身份验证依赖系统/etc/shadow)
• 依赖rsync 3.1.x及以上版本(3.0.x不支持复制时的chown功能)
• FreeBSD系统需挂载linprocfs到/usr/compat/linux/proc

Docker部署示例

基本运行命令

bash
docker run -d \
  --name mineos \
  -p 8443:8443 \
  -v /path/to/minecraft/data:/usr/games/minecraft \
  -v /etc/shadow:/etc/shadow:ro \
  --privileged \
  hexparrot/mineos-node

参数说明

• -p 8443:8443: 映射Web界面端口
• -v /path/to/minecraft/data:/usr/games/minecraft: 持久化服务器数据
• -v /etc/shadow:/etc/shadow:ro: 挂载系统影子文件用于身份验证
• --privileged: 提供必要权限以支持系统监控功能

服务管理

启动方式

• 后台运行(守护进程模式):

  bash
  node service.js [start|stop|restart|status]
  

• 前台运行(调试模式):

  bash
  node webui.js
  

初始化系统配置

根据容器内使用的初始化系统选择配置方式:

Upstart系统:

bash
cp /usr/games/minecraft/init/upstart_conf /etc/init/mineos.conf
start mineos

Supervisor系统:

bash
cp /usr/games/minecraft/init/supervisor_conf /etc/supervisor/conf.d/mineos.conf
supervisorctl reread
supervisorctl update
supervisorctl start mineos

Systemd系统:

bash
cp /usr/games/minecraft/init/systemd_conf /etc/systemd/system/mineos.service
systemctl enable mineos
systemctl start mineos

注意事项

• 不要与Python版MineOS共存(两者安装路径均为/usr/games/minecraft)
• FreeBSD系统额外配置:

  bash
  mount -t linprocfs linprocfs /usr/compat/linux/proc
  

• 使用CLANG编译器的系统需特殊安装NPM模块:

  bash
  echo "CXX=c++ npm install" | sh
  

开发与贡献

欢迎开发者贡献代码，无论擅长HTML、CSS还是Javascript(Node.js/Angular)，均可联系项目维护者讨论设计目标和贡献方向。

许可证

详见LICENSE.md文件。

支持

可通过以下途径获取支持:

• GitHub提交issue
• MineOS支持论坛发布帖子

计划功能(TODO)

• 实现Web界面常用任务宏定义功能
• 完善功能文档

未来计划(EVENTUALLY)

• 开发previous_versions功能，支持文件版本回滚和历史查看
• Web界面集成Java版本识别与JVM选择功能