{"id":18115840,"url":"https://github.com/kasefuchs/lazygate","last_synced_at":"2026-03-12T13:34:31.219Z","repository":{"id":259767351,"uuid":"877851052","full_name":"kasefuchs/lazygate","owner":"kasefuchs","description":"Gate proxy plugin that shuts down your Minecraft server when it's idle and wakes it up when players connect.","archived":false,"fork":false,"pushed_at":"2024-11-07T08:48:43.000Z","size":139,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-17T05:30:07.179Z","etag":null,"topics":["docker","gate-extension","go","golang","minecraft","minekube","nomad","plugin"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kasefuchs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-24T10:58:51.000Z","updated_at":"2024-11-16T21:57:51.000Z","dependencies_parsed_at":"2024-10-27T23:14:33.756Z","dependency_job_id":"1aab1598-d9c2-463e-b6b9-54e11a403fd3","html_url":"https://github.com/kasefuchs/lazygate","commit_stats":null,"previous_names":["kasefuchs/lazygate"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kasefuchs%2Flazygate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kasefuchs%2Flazygate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kasefuchs%2Flazygate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kasefuchs%2Flazygate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kasefuchs","download_url":"https://codeload.github.com/kasefuchs/lazygate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246264725,"owners_count":20749515,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","gate-extension","go","golang","minecraft","minekube","nomad","plugin"],"created_at":"2024-11-01T04:00:47.761Z","updated_at":"2026-03-12T13:34:31.202Z","avatar_url":"https://github.com/kasefuchs.png","language":"Go","readme":"# LazyGate\n\n## Table of Contents\n\n- [About](#about)\n- [Getting Started](#getting_started)\n\n## About \u003ca name = \"about\"\u003e\u003c/a\u003e\n\n**LazyGate** is a [Gate proxy](https://github.com/minekube/gate) plugin that automatically manages the uptime of your Minecraft server. It stops the server when idle and starts it again when players connect.\n\n## Getting Started \u003ca name = \"getting_started\"\u003e\u003c/a\u003e\n\n### Installing\n\nAdd the `lazygate` module to your project:\n\n```sh\ngo get github.com/kasefuchs/lazygate\n```\n\nInclude the plugin in your list of proxy plugins:\n\n```go\npackage main\n\nimport (\n\tlazygate \"github.com/kasefuchs/lazygate/pkg/plugin\"\n\t\"go.minekube.com/gate/cmd/gate\"\n\t\"go.minekube.com/gate/pkg/edition/java/proxy\"\n)\n\nfunc main() {\n\tproxy.Plugins = append(proxy.Plugins, lazygate.NewProxyPlugin())\n\n\tgate.Execute()\n}\n```\n\n### Configuring\n\nConfigure the plugin using environment variables:\n\n```sh\n# Provider to use. Currently available nomad, docker and pufferpanel.\nLAZYGATE_PLUGIN_PROVIDER=\"nomad\"\n\n# Namespace to use.\nLAZYGATE_PLUGIN_NAMESPACE=\"default\"\n```\n\n### Usage\n\n#### Docker\n\nLazyGate matches registered Gate servers with provider's allocations using labels:\n\n**Docker Compose:**\n\n```yaml\nservices:\n  minecraft-server-random:\n    labels:\n      lazygate.allocation.server: random_name\n      lazygate.allocation.time.minimumOnline: 2m\n      lazygate.allocation.time.inactivityThreshold: 5m\n      lazygate.queues: wait,kick\n      lazygate.queue.wait.timeout: 10s\n      lazygate.queue.wait.pingInterval: 2s\n      lazygate.queue.kick.reason: random_name is currently starting!\n```\n\n**Gate config:**\n\n```yaml\n---\nconfig:\n  servers:\n    random_name: minecraft-server-random:25565\n  try:\n    - random_name\n```\n\nIn this example, the `random_name` server will correspond to the `minecraft-server1` service.\n\n#### PufferPanel\n\n**Enviroment Variables for Gate**\n\n```sh\nLAZYGATE_PLUGIN_PROVIDER=\"pufferpanel\"\nLAZYGATE_PLUGIN_NAMESPACE=\"default\"\nLAZYGATE_PROVIDER_PUFFERPANEL_BASEURL=\"\u003curl\u003e\"\nLAZYGATE_PROVIDER_PUFFERPANEL_CLIENTID=\"\u003cclientid\u003e\"\nLAZYGATE_PROVIDER_PUFFERPANEL_CLIENTSECRET=\"\u003cclientsecret\u003e\"\nLAZYGATE_PROVIDER_PUFFERPANEL_CONFIGFILEPATH=\"lazygate.json\"\n```\n\n**_URL:_** The Url from pufferpanel e.g. `https://panel.example.com`\n\n**_CLIENTID \u0026 CLIENTSECRET:_** The Client ID and Client Secret can you generate from Pufferpanel. Account (Top Right) -\u003e OAuth2 Client -\u003e Create New OAuth Client\n\n**Gate config:**\n\n```yaml\n---\nconfig:\n  servers:\n    random_name: minecraft-server-random:25565\n  try:\n    - random_name\n```\n\n**Server config**\n\nCreate a `lazygate.json` file inside pufferpanel files:\n\n```json\n{\n  \"lazygate.allocation.server\": \"random_name\",\n  \"lazygate.allocation.time.minimumOnline\": \"2m\",\n  \"lazygate.allocation.time.inactivityThreshold\": \"5m\",\n  \"lazygate.queues\": \"wait,kick\",\n  \"lazygate.queue.wait.timeout\": \"10s\",\n  \"lazygate.queue.wait.pingInterval\": \"2s\",\n  \"lazygate.queue.kick.reason\": \"random_name is currently starting!\"\n}\n```\n\n**Extras**\n\nIf you're running your Gate Server also inside Docker on the same host as Pufferpanel you have to pass your pufferpanel domain as extrahost.\n","funding_links":[],"categories":["Uncategorized"],"sub_categories":["Uncategorized"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkasefuchs%2Flazygate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkasefuchs%2Flazygate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkasefuchs%2Flazygate/lists"}