Skip to content

Latest commit

 

History

History
113 lines (75 loc) · 4.44 KB

README.md

File metadata and controls

113 lines (75 loc) · 4.44 KB
Raw

kubecraft-proxy

contributors last update open issues license

A reverse proxy for Minecraft server using gRPC for configuration. The goal is to provide a simple way to configure a Minecraft server without having to restart the proxy.

This is useful for Minecraft servers running in a cloud environment where the servers are ephemeral and can be created at any time or for users that want to expose multiple servers on the same IP address and port.

⚠️ This project is still in early development and should NOT be used in production.

⚠️ This project is NOT affiliated with Mojang Studios or Microsoft.

⚠️ This project is NOT a BungeeCord alternative. This project is a reverse proxy and does not provide any of the features that BungeeCord provides.

Features

  • Reverse proxy for Minecraft servers
  • gRPC API for configuration
  • Support for multiple Minecraft versions at the same time

Roadmap

  • Display Placeholder Server
  • TCPShield/RealIP Protocol Support
  • Prometheus Support

Installation

The best way to install the proxy is to use the provided Docker image. The image is available on Docker Hub.

docker run -d -p 25565:25565 -p 65535:65535 kubecraft/kubecraft-proxy:latest

The proxy requires the following ports to be exposed:

  • 25565: Minecraft server port
  • 65535: gRPC server port

Note: Please make sure to not expose the gRPC port to the public internet as it is not secured and everyone can change the configuration of the proxy.

But, if you don't want to use Docker, you can download the binary from the releases page or build it yourself following the instructions below.

git clone https://github.com/kubecraft-cloud/kubecraft-proxy
cd kubecraft-proxy/
cargo build --release

You can then run the proxy using the following command:

./target/release/kubecraft-proxy

Configuration

The proxy can be configured using the gRPC API. The API is available on port 65535 by default.

⚠️ The API is not secured and should not be exposed to the public internet.

Example

The following example shows how to configure the proxy with the gRPC API, in the example we use grpcurl to interact with the API but you can use any gRPC client you want.

You can find the protobuf definition of the API here.

Get all minecraft servers

This example shows how to get all the Minecraft servers in the proxy configuration.

grpcurl -plaintext localhost:65535 proxy.ProxyService/ListBackend

Put a new minecraft server

This example shows how to put a new Minecraft server in the proxy configuration. The proxy will then redirect all the traffic that matches the hostname game.example.com to the Minecraft server at 192.168.1.10:25565.

grpcurl -plaintext -d '{"hostname":"game.example.com","redirect_ip":"192.168.1.10","redirect_port":25565}' \
    localhost:65535 proxy.ProxyService/PutBackend

Delete a minecraft server

This example shows how to delete a Minecraft server from the proxy configuration. The proxy will then stop redirecting all the traffic that matches the hostname game.example.com.

grpcurl -plaintext -d '{"hostname":"game.example.com","redirect_ip":"192.168.1.10","redirect_port":25565}' \
    localhost:65535 proxy.ProxyService/DeleteBackend

Contributing

Contributions are welcome. Please follow the standard Git workflow - fork, branch, and pull request.

License

This project is licensed under the Apache 2.0 - see the LICENSE file for details.