https://github.com/kasefuchs/lazygate
Gate proxy plugin that shuts down your Minecraft server when it's idle and wakes it up when players connect.
https://github.com/kasefuchs/lazygate
docker gate-extension go golang minecraft minekube nomad plugin
Last synced: 3 months ago
JSON representation
Gate proxy plugin that shuts down your Minecraft server when it's idle and wakes it up when players connect.
- Host: GitHub
- URL: https://github.com/kasefuchs/lazygate
- Owner: kasefuchs
- License: mit
- Created: 2024-10-24T10:58:51.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-11-07T08:48:43.000Z (8 months ago)
- Last Synced: 2024-11-17T05:30:07.179Z (8 months ago)
- Topics: docker, gate-extension, go, golang, minecraft, minekube, nomad, plugin
- Language: Go
- Homepage:
- Size: 136 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LazyGate
## Table of Contents
- [About](#about)
- [Getting Started](#getting_started)
LazyGate is a [Gate proxy](https://github.com/minekube/gate) plugin that shuts down your Minecraft server when it's idle
and wakes it up when players connect.
### Installing
Add the `lazygate` module to your project:
```sh
go get github.com/kasefuchs/lazygate
```
Include the plugin in your list of proxy plugins:
```go
package main
import (
lazygate "github.com/kasefuchs/lazygate/pkg/plugin"
"go.minekube.com/gate/cmd/gate"
"go.minekube.com/gate/pkg/edition/java/proxy"
)
func main() {
proxy.Plugins = append(proxy.Plugins, lazygate.NewProxyPlugin())
gate.Execute()
}
```
### Configuring
Configure the plugin using environment variables:
```sh
# Provider to use. Currently available nomad & docker.
LAZYGATE_PROVIDER="nomad"
```
### Usage
LazyGate matches registered Gate servers with provider's allocations using labels:
**Docker Compose:**
```yaml
services:
minecraft-server-random:
labels:
lazygate.server: random_name
lazygate.time.minimumOnline: 2m
lazygate.time.inactivityThreshold: 5m
lazygate.queue.try: wait,kick
lazygate.queue.wait.timeout: 10s
lazygate.queue.wait.pingInterval: 2s
lazygate.queue.kick.starting: random_name is currently starting!
```
**Gate config:**
```yaml
---
config:
servers:
random_name: minecraft-server-random:25565
try:
- random_name
```
In this example, the `random_name` server will correspond to the `minecraft-server1` service.