what is aoirint_mcping_server?
aoirint_mcping_server is a monitoring tool designed to check the status of multiple Minecraft Bedrock and Java servers, providing real-time insights into server availability and performance.
how to use aoirint_mcping_server?
To use aoirint_mcping_server, you need to deploy it using Docker Compose. Copy the necessary configuration files, set up your environment variables, and start the services. After that, you can apply database migrations to ensure everything is set up correctly.
key features of aoirint_mcping_server?
- Monitors the status of multiple Minecraft Bedrock and Java servers.
- Utilizes a PostgreSQL database for persistence.
- Provides a Web API with Read/Write API key authentication for secure access.
use cases of aoirint_mcping_server?
- Monitoring the uptime and performance of Minecraft servers for gaming communities.
- Integrating server status checks into gaming dashboards or websites.
- Automating alerts for server downtime or performance issues.
FAQ from aoirint_mcping_server?
- What versions of Minecraft does this support?
It supports Bedrock 1.20.x and Java 1.20.x versions.
- How do I deploy the server monitoring tool?
You can deploy it using Docker Compose by configuring the necessary files and running the services.
- Is there a database requirement?
Yes, it uses a PostgreSQL database for data persistence.
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.ymltemplate.env->.env
Start Docker Compose services.
docker compose up -d
Then, apply database migrations.
Docker repository
- aoirint/aoirint_mcping_server_web_api
- aoirint/aoirint_mcping_server_java_updater
- aoirint/aoirint_mcping_server_bedrock_updater
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 .
