https://github.com/aoirint/aoirint_mcping_server

Headless status monitor with HTTP JSON API for Minecraft Bedrock/Java server
https://github.com/aoirint/aoirint_mcping_server

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/aoirint/aoirint_mcping_server
• Owner: aoirint
• License: mit
• Created: 2023-02-18T10:53:06.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-10T04:19:18.000Z (6 months ago)
• Last Synced: 2024-07-10T06:43:10.728Z (6 months ago)
• Language: Python
• Homepage:
• Size: 360 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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.

```shell

docker compose up -d

```

Then, [apply database migrations](#database-migration).

## Docker repository

- [aoirint/aoirint_mcping_server_web_api](https://hub.docker.com/r/aoirint/aoirint_mcping_server_web_api)

- [aoirint/aoirint_mcping_server_java_updater](https://hub.docker.com/r/aoirint/aoirint_mcping_server_java_updater)

- [aoirint/aoirint_mcping_server_bedrock_updater](https://hub.docker.com/r/aoirint/aoirint_mcping_server_bedrock_updater)

## Database migration

This repository uses [golang-migrate](https://github.com/golang-migrate/migrate).

To apply the migrations,

```shell

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

```

## Library management

This repository uses [Poetry](https://github.com/python-poetry/poetry).