Getting Started
Install CubeAdmin and connect it to your Minecraft server in under 10 minutes.
Prerequisites
- Bun ≥ 1.1 (for bare metal) or Docker ≥ 24 (recommended)
- A running Minecraft server with RCON enabled — see Enabling RCON
- 256 MB of free RAM for CubeAdmin (separate from your Minecraft server)
- Linux, macOS, or Windows with WSL2
Step 1 — Clone the repository
git clone https://github.com/your-org/cubeadmin.git cd cubeadmin
Step 2 — Configure your environment
Copy the example environment file and fill in the required values:
cp .env.example .env.local
At minimum, set these two variables:
BETTER_AUTH_SECRET=your-32-character-secret-here MC_RCON_PASSWORD=your-minecraft-rcon-password
Generate a secure secret with: openssl rand -base64 32
Step 3 — Install dependencies & build
bun install bun run build
Step 4 — Start CubeAdmin
NODE_ENV=production bun --bun run server.ts
Or in development mode:
bun dev
CubeAdmin will be available at http://localhost:3000.
First Login
Navigate to http://localhost:3000 and click Create an account. The very first account you register is automatically promoted to superadmin — no configuration needed.
After logging in, go to Server Settings and set your MC_SERVER_PATH and verify your RCON connection.
Connecting to your Minecraft server
CubeAdmin communicates with your Minecraft server in two ways:
- Process management — CubeAdmin spawns and manages the Minecraft server process directly (requires
MC_SERVER_PATHpointing to the server directory) - RCON — Used for sending commands, managing players, and running scheduled tasks (requires
MC_RCON_PASSWORDand RCON enabled inserver.properties)
See Enabling RCON for setup instructions.
Démarrage
Installez CubeAdmin et connectez-le à votre serveur Minecraft en moins de 10 minutes.
Prérequis
- Bun ≥ 1.1 (bare metal) ou Docker ≥ 24 (recommandé)
- Un serveur Minecraft en cours d'exécution avec RCON activé — voir Activer RCON
- 256 Mo de RAM libre pour CubeAdmin (hors serveur Minecraft)
- Linux, macOS, ou Windows avec WSL2
Étape 1 — Cloner le dépôt
git clone https://github.com/your-org/cubeadmin.git cd cubeadmin
Étape 2 — Configurer l'environnement
Copiez le fichier d'environnement exemple et renseignez les valeurs requises :
cp .env.example .env.local
Au minimum, définissez ces deux variables :
BETTER_AUTH_SECRET=votre-secret-de-32-caracteres MC_RCON_PASSWORD=votre-mot-de-passe-rcon-minecraft
Générez un secret sécurisé avec : openssl rand -base64 32
Étape 3 — Installer les dépendances & compiler
bun install bun run build
Étape 4 — Démarrer CubeAdmin
NODE_ENV=production bun --bun run server.ts
Ou en mode développement :
bun dev
CubeAdmin sera disponible sur http://localhost:3000.
Première connexion
Rendez-vous sur http://localhost:3000 et cliquez sur Créer un compte. Le tout premier compte créé est automatiquement promu superadmin — aucune configuration supplémentaire requise.
Après connexion, allez dans Paramètres du serveur et configurez MC_SERVER_PATH, puis vérifiez votre connexion RCON.
Connexion à votre serveur Minecraft
CubeAdmin communique avec votre serveur Minecraft de deux façons :
- Gestion de processus — CubeAdmin démarre et gère le processus Minecraft directement (nécessite
MC_SERVER_PATH) - RCON — Utilisé pour envoyer des commandes, gérer les joueurs et exécuter des tâches planifiées (nécessite
MC_RCON_PASSWORD)