aoirint_mcping_server Quick Start Guide

概述

aoirint_mcping_server 是一个用于监控多个 Minecraft 服务器状态的工具，支持数据持久化和 API 访问控制。

主要功能

• 监控 Minecraft Bedrock/Java 服务器状态（支持 1.20.x 版本）
• 使用 PostgreSQL 数据库持久化数据
• 提供带认证的 Web API

快速部署

使用 Docker Compose

1. 创建新目录并复制以下文件：

   • docker-compose.yml
   • 将 template.env 复制为 .env 并进行配置

2. 启动服务：

   docker compose up -d
   

3. 应用数据库迁移：

   docker compose run --rm migrate -path=/migrations -database="postgres://postgres:postgres_password@postgres:5432/postgres?sslmode=disable" up
   

Docker 镜像

• aoirint/aoirint_mcping_server_web_api
• aoirint/aoirint_mcping_server_java_updater
• aoirint/aoirint_mcping_server_bedrock_updater

开发信息

• 基于 Python 3.12
• 使用 Poetry 管理依赖
• 代码格式化：

  poetry run ruff check --fix
  poetry run ruff format
  poetry run mypy .