csmith1865/ping-server
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
The REST server that powers the public API for mcstatus.io.
9 Commits 1 Branch 0 Tags 766 KiB
Go 98.5%
Makefile 1.5%
bc86906f48
Go to file
Jacob Gunther bc86906f48
Expose cache header in CORS
2022-08-21 20:08:03 -05:00
src Expose cache header in CORS 2022-08-21 20:08:03 -05:00
.gitignore Undo blocked servers cache list 2022-08-21 01:00:13 -05:00
config.example.yml Add X-Cache-Time-Remaining header 2022-08-21 19:24:39 -05:00
go.mod Update dependencies 2022-08-19 06:32:21 -05:00
go.sum Update dependencies 2022-08-19 06:32:21 -05:00
LICENSE Add initial code 2022-07-30 22:13:16 -05:00
Makefile Add initial code 2022-07-30 22:13:16 -05:00
README.md Add initial code 2022-07-30 22:13:16 -05: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

Installation

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

License

MIT License