premises

module

v0.11.2 Latest Latest Go to latest Published: Feb 22, 2026 License: AGPL-3.0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kofuk/premises

Links

Open Source Insights

README ¶

Premises

"Premises" is a software to build on-demand Minecraft server on cloud.

Premises consists of the following 2 parts:

Frontend that determine configuration of the server, and creates VM. (Control Panel)
Software to actually configure game and monitor that the server alive. (Runner)

Features

Launch Minecraft server from Web.
Save world data on S3 and select world to load.
Monitor server status in real time.
Monitor CPU usage of server in real time.
Instantly take snapshot of running world and restore it.

Deploying

Kubernetes

You can deploy Premises to Kubernetes using the Helm chart. You will still need to prepare PostgreSQL, Valkey instances and environment variables to configure Premises.
See the test manifest for an example.

$ helm upgrade --install premises premises \
    --repo https://premises.kofuk.org/charts

This Helm chart will make use of LoadBalancer service to expose Minecraft and proxy backend port to the internet. Please make sure your Kubernetes cluster supports LoadBalancer service type.

Docker Compose

Deploying to Kubernetes is the recommended method, but legacy methods using Docker Compose can also be used. See documentation for step to setup Premises on your server.

License

GNU Affero General Public License v3.0 or later.

Directories ¶

Path	Synopsis
cmd
mcserver-fake command
ostack-fake command
common module
controlpanel
cmd/pmctl command
cmd/premises command
internal/admincli
internal/auth
internal/config
internal/conoha
internal/conoha/apitypes
internal/cron
internal/db
internal/db/model
internal/db/model/migrations
internal/gameconfig
internal/handler
internal/kvs
internal/launcher
internal/launcher/server
internal/longpoll
internal/mcversions
internal/monitor
internal/proxy
internal/startup
internal/streaming
internal/world
home module
internal
entity
entity/runner
entity/web
fake/mcserver
fake/mcserver/logging
fake/ostack
fake/ostack/dockerstack
fake/ostack/dockerstack/wrapper
fake/ostack/entity
mc/launchermeta
mc/nbt
mc/protocol
otel
retry
s3wrap
ostack-fake module
runner module
cmd/premises-runner command
internal/api
internal/commands/cleanup
internal/commands/cli
internal/commands/connector
internal/commands/exteriord
internal/commands/exteriord/exterior
internal/commands/exteriord/exterior/scheduler
internal/commands/exteriord/outbound
internal/commands/exteriord/proc
internal/commands/mclauncher
internal/commands/mclauncher/core Package core is a generated GoMock package.	Package core is a generated GoMock package.
internal/commands/mclauncher/core/util
internal/commands/mclauncher/middleware/autoversion
internal/commands/mclauncher/middleware/autoversion/leveldat
internal/commands/mclauncher/middleware/eula
internal/commands/mclauncher/middleware/monitoring
internal/commands/mclauncher/middleware/monitoring/watchdog Package watchdog is a generated GoMock package.	Package watchdog is a generated GoMock package.
internal/commands/mclauncher/middleware/serverjar
internal/commands/mclauncher/middleware/serverproperties
internal/commands/mclauncher/middleware/world
internal/commands/mclauncher/middleware/world/service Package service is a generated GoMock package.	Package service is a generated GoMock package.
internal/commands/mclauncher/quickundo
internal/commands/mclauncher/rcon Package rcon is a generated GoMock package.	Package rcon is a generated GoMock package.
internal/commands/mclauncher/repository
internal/commands/serversetup
internal/commands/snapshot
internal/commands/systemstat
internal/commands/sysupdate
internal/config
internal/env Package env is a generated GoMock package.	Package env is a generated GoMock package.
internal/exterior
internal/fs
internal/metadata
internal/rpc
internal/rpc/types
internal/system Package system is a generated GoMock package.	Package system is a generated GoMock package.
internal/util
tests
proxy-perf/simple command
proxy-perf/twostep/connector command
proxy-perf/twostep/proxy command

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL