gabefraser / minepass

Minecraft Whitelister via HTTP

MinePass - Minecraft Whitelister

MinePass is a powerful Minecraft whitelisting tool that allows you to manage your server's whitelist remotely over the internet. With MinePass, you can easily control access to your Minecraft server, add or remove players from the whitelist, and ensure a safe and secure gaming experience for your community.

Features

• Easy-to-use web interface for managing your server's whitelist.
• Secure authentication to protect your server from unauthorized access.
• Real-time updates to the Minecraft whitelist without the need for server restarts.
• Compatibility with popular Minecraft server software.
• User-friendly design for both server administrators and players.

Getting Started

Running MinePass in a Docker Container

1. Pull the MinePass Docker image from Docker Hub

   docker pull gabefraser/minepass:latest

2. Run MinePass in a Docker container, specifying the necessary environment variables and ports. Replace the placeholders with your configuration.

   docker run -d \
   -e MP_HOST=YOUR_SERVER_IP \
   -e MP_PASSWORD=YOUR_SERVER_RCON_PASSWORD \
   -e MP_UI_PASSWORD=YOUR_UI_PASSWORD \
   -e MP_TITLE=YOUR_TITLE \ # optional, will default to "MinePass"
   -p 8080:8080 \
   gabefraser/minepass:latest

Usage

There are 2 ways you can communicate with this.

Via the Web UI

Once the Docker image is up and running, head over to 0.0.0.0:8080 (your IP will differ depending if you're self hosting on your machine/dedicated server).

Via the Web API

There are currently 2 endpoints available. You can find them below.

Each endpoint requires the following header as this is used to validate the request is coming from a trusted source.

{
    "X-Api-Key": "YOUR_UI_PASSWORD"
}

URL	Method	Body
api/whitelist/add	POST	{ "username": "string" }
api/whitelist/remove	POST	{ "username": "string" }

Credits

MinePass is made possible thanks to the contributions and support from the following individuals and projects:

• gin-gonic/gin: Gin is a web framework written in Go.
• gorcon/rcon: Source RCON Protocol implementation in Go.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Feedback and Support

If you encounter any issues or have suggestions for improving MinePass, please open an issue on the GitHub repository.

We hope you find MinePass to be a valuable tool for managing your Minecraft server's whitelist. Happy gaming!