Documentation
Your worlds. Your infrastructure.
A guide to getting it running.
Install the panel on infrastructure you manage, build and deploy modpacks, configure your setup, and find the reference you need along the way.
Start here
Section titled “Start here”Understand Carbon PanelWhat the panel does and how it fits your Minecraft setup.
Install with Docker ComposeRequirements, the Compose file, data paths, and first startup.
Configure your installationConfiguration files, environment variables, and available settings.
Build a modpackCreate, import and edit a pack, then export or deploy it.
Run and change your servers
Section titled “Run and change your servers”Install datapacks on a serverBrowse Modrinth, upload an archive, and manage the world's datapacks folder.
Stage updatesPrepare config, mod, datapack and module changes and apply them in one window.
Sleep and wakeFreeze or stop idle servers and wake them when a player joins.
Route players by hostnameGive every server its own hostname on one port with the built-in proxy.
Keep it running
Section titled “Keep it running”Back up your serversCreate backups, set retention, and understand the restore workflow.
Set up single sign-onConnect an identity provider. Start with Keycloak or choose a provider in the sidebar.
Explore the APIBrowse the API schema generated from the same application snapshot as these docs.
Check the docs versionSee exactly which application commit this documentation describes.
These pages come from the Carbon Panel repository. The version label above identifies the application snapshot; it does not imply that a stable release has been published.