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

Go to file

Jacob Gunther 3c060d5794 Update dependencies		2023-02-28 00:46:32 -06:00
.github/workflows	Fix GitHub actions	2022-08-23 03:09:35 -05:00
src	Fetch blocked servers without Redis	2023-02-26 14:22:03 -06:00
.gitignore	Undo blocked servers cache list	2022-08-21 01:00:13 -05:00
config.example.yml	Fetch blocked servers without Redis	2023-02-26 14:22:03 -06:00
go.mod	Update dependencies	2023-02-28 00:46:32 -06:00
go.sum	Update dependencies	2023-02-28 00:46:32 -06:00
LICENSE	Add initial code	2022-07-30 22:13:16 -05:00
Makefile	Fetch blocked servers without Redis	2023-02-26 14:22:03 -06:00
README.md	Fetch blocked servers without Redis	2023-02-26 14:22:03 -06:00

README.md

API Server

The REST 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.

Requirements

Git
Go
Redis
GNU Make (optional)

Installation

Clone the repository to a folder
- git clone https://github.com/mcstatus-io/api-server.git
Move the working directory into the folder
- cd api-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