The REST server that powers the public API for mcstatus.io.

Go to file

Jacob Gunther e452e89d66 Remove graceful shutdown		2023-07-21 15:32:59 -05:00
.github/workflows	Remove Dependabot updates	2023-05-06 01:28:15 -05:00
src	Remove graceful shutdown	2023-07-21 15:32:59 -05:00
.gitignore	Undo blocked servers cache list	2022-08-21 01:00:13 -05:00
config.example.yml	Ability to enable/disable locks	2023-07-19 21:16:22 -05:00
docker-compose.yml	Dockerfile, Error handling, comments, docker-compose (#2 )	2023-03-30 10:53:31 -05:00
dockerfile	Dockerfile, Error handling, comments, docker-compose (#2 )	2023-03-30 10:53:31 -05:00
go.mod	Update dependencies	2023-07-19 21:18:52 -05:00
go.sum	Update dependencies	2023-07-19 21:18:52 -05:00
LICENSE	Add initial code	2022-07-30 22:13:16 -05:00
Makefile	Update dependencies	2023-04-16 16:57:10 -05:00
README.md	Add badges to README	2023-03-30 20:16:32 -05:00

README.md

Ping Server

The status retrieval/ping server that powers the API for mcstatus.io. This repository is open source to allow developers to run their own Minecraft server status API server.

If you do not know what you are doing, or think that the cache durations enforced on our official website are tolerable, I would highly recommend using the official API instead. It is much more reliable and reduces the complexity of hosting it yourself.

Official API Documentation

https://mcstatus.io/docs

Requirements

Git
Go
Redis
GNU Make (optional)

Installation

Clone the repository to a folder
- git clone https://github.com/mcstatus-io/ping-server.git
Move the working directory into the folder
- cd ping-server
Install all required dependencies
- go get ...
Build the executable
- Using GNU make
  - make
- Without GNU make
  - go build -o .\bin\main.exe .\src\*.go (Windows)
  - go build -o bin/main src/*.go (Unix)
Copy the config.example.yml file to config.yml and edit the details
Start the API server
- .\bin\main.exe (Windows)
- bin/main (Unix)

License

MIT License