aoirint_mcping_server

aoirint_mcping_server

By aoirint GitHub

Headless status monitor with HTTP JSON API for Minecraft Bedrock/Java server

Overview

what is aoirint_mcping_server?

aoirint_mcping_server is a headless status monitoring tool that provides an HTTP JSON API for Minecraft Bedrock and Java servers, allowing users to track their server status efficiently.

how to use aoirint_mcping_server?

To use aoirint_mcping_server, configure your environment using the provided Docker Compose files, run the services, and apply necessary database migrations for data persistence.

key features of aoirint_mcping_server?

  • Monitors the status of multiple Minecraft Bedrock and Java servers.
  • Utilizes PostgreSQL for data persistence.
  • Offers a Web API that supports Read/Write operations secured by API key authentication.

use cases of aoirint_mcping_server?

  1. Real-time monitoring of Minecraft server health and performance.
  2. Managing multiple Minecraft server instances from a single interface.
  3. Integrating game server status into custom applications via the JSON API.

FAQ from aoirint_mcping_server?

  • What Minecraft server versions are supported?

The tool supports Minecraft Bedrock version 1.20.x and Java version 1.20.x.

  • How can I deploy the service?

You can deploy it using Docker Compose by copying the necessary files and starting the services with the specified commands.

  • Is there documentation for database migration?

Yes, the repository uses golang-migrate for database migrations, and instructions are provided in the documentation.

Content

aoirint_mcping_server

Feature

  • Monitoring status of multiple Minecraft Bedrock/Java servers
  • Persistence by PostgreSQL database
  • Web API with Read/Write API key authentication

Supported Minecraft server versions

  • Bedrock 1.20.x
  • Java 1.20.x

Deploy

Docker Compose

Copy these files to a new directory and configure.

  • docker-compose.yml
  • template.env -> .env

Start Docker Compose services.

docker compose up -d

Then, apply database migrations.

Docker repository

Database migration

This repository uses golang-migrate.

To apply the migrations,

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

Library management

  • Python 3.12

This repository uses Poetry.

Code format

poetry run ruff check --fix
poetry run ruff format

poetry run mypy .
No tools information available.
No content found.