auto-mcs Docker镜像文档

镜像概述和主要用途

auto-mcs Docker镜像是用于简化Minecraft服务器创建、部署和管理的工具。它提供直观的操作体验，让用户无需手动处理复杂的服务器安装与维护流程，即可快速搭建与朋友共享的Minecraft服务器。该镜像支持通过Telepath API进行远程管理，并可与GUI设备连接以使用更多高级功能。

核心功能和特性

• 快速部署：1分钟内完成服务器创建
• 多服务器类型支持：全面兼容Paper、Purpur、Fabric、Forge、Spigot、CraftBukkit和Vanilla
• 自动化管理：自动安装与更新服务器软件
• 灵活迁移：支持导入任何现有服务器（包括modpacks）
• 动态配置：实时切换世界、版本和发行版
• 备份管理：自动备份服务器数据
• 高级控制台：带通用脚本API的自定义控制台及内置IDE（兼容Vanilla）
• 崩溃检测：详细的崩溃报告与可视化查看
• 插件/模组管理：内置浏览器与安装器，支持自动更新插件
• 访问控制：防火墙式管理菜单，集成封禁、白名单和管理员权限设置
• 配置编辑：内置server.properties编辑器，简化配置修改

使用场景和适用范围

• 希望与朋友快速搭建Minecraft服务器，无需深入了解服务器配置的玩家
• 需要远程管理Minecraft服务器的场景（通过Telepath API连接GUI设备）
• 需部署多种类型Minecraft服务器（原版、模组化、插件化等）的用户
• 希望自动化服务器更新、备份和维护流程的管理员

详细使用方法和配置说明

命令参考

auto-mcs无头模式通过命令行交互，启动后将显示命令提示符。按?可查看帮助。创建基础Paper服务器的命令示例：

bash
# 创建名为"My Server"的Paper最新版服务器
server create paper:latest My Server

# 启动服务器
server launch My Server

• 按ESC可退出控制台，创建或启动其他服务器
• 在控制台中输入!help可查看Minecraft相关命令
• 使用console命令返回服务器控制台
• 通过--launch或-l参数可自动启动指定服务器：

  bash
  auto-mcs --launch "My Server, Server 2"
  

运行容器

基础用法

使用默认设置运行auto-mcs容器：

bash
docker run -d \
  --name auto-mcs \
  -p 8080:8080 \
  -p 7001:7001 \
  -p 25565:25565 \
  -v auto-mcs-data:/root/.auto-mcs \
  macarooniman/auto-mcs:latest \
  auto-mcs-ttyd \
  -W \
  -t disableLeaveAlert=true \
  -t titleFixed="auto-mcs (docker)" \
  -t fontSize=20 \
  -t theme="{\"background\": \"#1A1A1A\"}" \
  -p 8080 \
  -c root:auto-mcs \
  tmux -u -2 new -A -s -c ./auto-mcs

参数说明：

• -d：后台运行容器
• --name auto-mcs：指定容器名称
• 端口映射：
  • 8080:8080：TTYD终端访问端口
  • 7001:7001：Telepath API端口（用于远程管理）
  • 25565:25565：Minecraft服务器默认端口
• -v auto-mcs-data:/root/.auto-mcs：挂载卷以持久化数据（配置、服务器数据、备份等）
• macarooniman/auto-mcs:latest：使用最新版镜像
• 后续参数为TTYD终端配置，包括禁用离开提醒、固定标题、字体大小、主题设置等

安全提示：默认凭据为root:auto-mcs，强烈建议修改！例如将-c root:auto-mcs改为-c 用户名:密码。

Docker Compose配置

创建docker-compose.yml文件管理容器：

yaml
version: "3"
services:
  app:
    command: [
      "auto-mcs-ttyd",
      "-W",
      "-t", "disableLeaveAlert=true",
      "-t", "titleFixed=auto-mcs (docker)",
      "-t", "fontSize=20",
      "-t", "theme={\"background\": \"#1A1A1A\"}",
      "-p", "8080",
      "-c", "root:auto-mcs",  # 修改此处凭据！格式：用户名:密码
      "tmux", "-u", "-2", "new", "-A", "-s", "-c",
      "./auto-mcs"
    ]
    image: macarooniman/auto-mcs:latest
    container_name: auto-mcs
    stdin_open: true
    tty: true
    restart: always
    ports:
      - "8080:8080"   # TTYD终端
      - "7001:7001"   # Telepath API
      - "25565:25565" # Minecraft服务器端口（可根据需要添加更多）
    volumes:
      - auto-mcs-data:/root/.auto-mcs

volumes:
  auto-mcs-data:

启动容器：

bash
docker-compose up -d

访问TTYD Web界面

容器运行后，通过浏览器访问http://localhost:8080打开TTYD基于Web的终端。默认登录凭据：

• 用户名：root
• 密码：auto-mcs

安全提示：首次登录后立即修改默认凭据，避免未授权访问。

数据持久化

所有配置文件、服务器数据和备份均存储在/root/.auto-mcs目录。通过Docker卷auto-mcs-data实现持久化，确保容器重启或重建后数据不丢失。在docker run中通过-v auto-mcs-data:/root/.auto-mcs指定，或在Docker Compose中通过volumes配置。

本地构建镜像

前置要求

• 克隆auto-mcs仓库：git clone [***]
• 克隆auto-mcs-ttyd仓库：git clone [***]
• 安装Alpine Linux 3.15

构建步骤

1. 在Alpine系统中，进入auto-mcs仓库根目录，运行构建脚本：

bash
# 安装依赖并创建虚拟环境
apk add python3 py3-pip gcc pangomm-dev pkgconfig python3-dev zlib-dev libffi-dev musl-dev linux-headers mtdev-dev mtdev
spec_file="auto-mcs.docker.spec"
cd build-tools
current=$( pwd )
python3.9 -m pip install --upgrade pip setuptools wheel
python3.9 -m venv ./venv
source ./venv/bin/activate
pip install -r reqs-docker.txt
cd $current
cp $spec_file ../source
cd ../source

# 构建auto-mcs
pyinstaller $spec_file --upx-dir $current/upx/linux --clean
cd $current
rm -rf ../source/$spec_file
mv -f ../source/dist ../docker
deactivate

2. 进入auto-mcs-ttyd仓库根目录，构建ttyd：

bash
# 安装依赖
apk add build-base libwebsockets-evlib_uv bsd-compat-headers cmake json-c-dev libuv-dev libwebsockets-dev openssl-dev>3 samurai zlib-dev

# 构建auto-mcs-ttyd
mkdir build && cd build
cmake ..
make && make install
mv -f ./ttyd ../../auto-mcs/docker

3. 进入auto-mcs/docker目录，构建Docker镜像：

bash
docker build -t yourusername/auto-mcs:latest .

4. 如需构建多架构镜像（如amd64、arm64），使用Docker Buildx：

bash
docker buildx build --platform linux/amd64,linux/arm64 \
  -t yourusername/auto-mcs:latest --push .

Dockerfile说明

dockerfile
FROM alpine:3.20

ARG TARGETARCH
ARG ttyd_binary="[***]{TARGETARCH}"

COPY auto-mcs-${TARGETARCH} /auto-mcs

RUN apk update && apk upgrade && \
    apk add --no-cache wget json-c lib***3 libssl3 libuv libwebsockets libwebsockets-evlib_uv tmux musl zlib && \
    echo "set -g status off" > /root/.tmux.conf && \
    chmod +x /auto-mcs && \
    wget -O /usr/bin/auto-mcs-ttyd "$ttyd_binary" && \
    chmod +x /usr/bin/auto-mcs-ttyd

支持的标签和架构

• 标签：latest（稳定版）、beta（测试版）、特定版本号（如v1.0.0）
• 架构：amd64、arm64

支持与反馈

• 文档：访问***网站获取完整指南
• 问题跟踪：通过GitHub Issues提交bug报告或功能请求
• 社区支持：加入***社区获取帮助和讨论

许可证

auto-mcs采用GPL-3.0许可证。使用时请遵守所有依赖软件的许可证要求。

贡献

欢迎通过GitHub提交issue或pull request参与贡献。提交PR前请阅读贡献指南。