📋 System RequirementsConfiguration requise

  • OS: Linux, macOS, or Windows (WSL2 recommended on Windows)
  • OS : Linux, macOS, ou Windows (WSL2 recommandé sous Windows)
  • Runtime: Bun ≥ 1.1 (bare metal) or Docker ≥ 24 (Docker install)
  • Runtime : Bun ≥ 1.1 (bare metal) ou Docker ≥ 24 (installation Docker)
  • Minecraft server: Must have RCON enabled in server.properties
  • Serveur Minecraft : RCON doit être activé dans server.properties
  • RAM: 256 MB minimum for CubeAdmin (separate from your Minecraft server)
  • RAM : 256 Mo minimum pour CubeAdmin (en dehors de votre serveur Minecraft)

Docker ComposeDocker Compose

The recommended way to run CubeAdmin alongside a Minecraft server on a single host. La méthode recommandée pour exécuter CubeAdmin avec un serveur Minecraft sur un seul hôte.

1 Clone the repository Cloner le dépôt
git clone https://github.com/your-org/cubeadmin.git
cd cubeadmin
2 Configure environment Configurer l'environnement
cp .env.example .env
# Edit .env — set BETTER_AUTH_SECRET and MC_RCON_PASSWORD at minimum
3 Start the stack Démarrer la stack
docker compose up -d
4 Open the panel Ouvrir le panneau
# Navigate to http://localhost:3000
# Register the first account — it becomes the superadmin automatically.

Bare Metal with BunBare Metal avec Bun

Run CubeAdmin directly on your host machine using Bun as the runtime. Exécutez CubeAdmin directement sur votre machine hôte avec Bun comme runtime.

1 Install Bun Installer Bun
curl -fsSL https://bun.sh/install | bash
2 Clone and install dependencies Cloner et installer les dépendances
git clone https://github.com/your-org/cubeadmin.git
cd cubeadmin
bun install
3 Configure environment Configurer l'environnement
cp .env.example .env.local
# Edit .env.local
4 Build and start Compiler et démarrer
bun run build
NODE_ENV=production bun --bun run server.ts

The first account registered on a fresh install is automatically granted the superadmin role. No pre-seeding or manual SQL required. Le premier compte créé sur une nouvelle installation obtient automatiquement le rôle superadmin. Aucun pré-remplissage ou SQL manuel requis.

Need more details? The wiki has full deployment guides including reverse proxy setup and systemd. Besoin de plus de détails ? Le wiki contient des guides complets incluant la configuration du reverse proxy et systemd.

Deployment Guide → Guide de déploiement →