article
README
🚀 aoirint_mcping_server 项目说明
本项目可监控多个 Minecraft Bedrock 和 Java 服务器的状态,使用 PostgreSQL 数据库持久化数据,并提供带认证的 Web API 接口。
✨ 主要特性
- 监控多个 Minecraft Bedrock 和 Java 服务器的状态。
- 使用 PostgreSQL 数据库进行数据持久化。
- 提供 Web API 接口,支持读写 API 密钥认证。
📋 支持的 Minecraft 服务端版本
| 服务端类型 | 支持版本 | | ---- | ---- | | Bedrock 版本 | 1.20.x | | Java 版本 | 1.20.x |
📦 安装指南
使用 Docker 组合(Docker Compose)
将以下文件复制到一个新的目录中并进行配置:
docker-compose.ymltemplate.env->.env
启动 Docker 组合服务:
docker compose up -d
随后,应用数据库迁移。
🐳 Docker 镜像仓库
- aoirint/aoirint_mcping_server_web_api
- aoirint/aoirint_mcping_server_java_updater
- aoirint/aoirint_mcping_server_bedrock_updater
🔧 数据库迁移
该项目使用 golang-migrate 进行数据库迁移。 要应用迁移,请运行以下命令:
docker compose run --rm migrate -path=/migrations -database="postgres://postgres:postgres_password@postgres:5432/postgres?sslmode=disable" up
📚 详细文档
库管理
- Python 版本:3.12 该项目使用 Poetry 进行依赖管理。
代码格式化
poetry run ruff check --fix
poetry run ruff format
poetry run mypy .
Scan to contact