Skip to content

Admin Quickstart

Get MAGK running on your server in under 15 minutes. This guide covers the essential steps — for detailed configuration options, see the Installation Guide.

Prerequisites

  • Server meeting the System Requirements
  • Docker and Docker Compose installed
  • Domain with DNS pointing to your server
  • SSH access to the server

Step 1: Clone the Repository

git clone https://github.com/magktech/magk.git
cd magk

Step 2: Configure Environment

Copy the environment template and edit it with your settings:

cp .env.template .env

At minimum, set these variables:

Variable Description Example
DOMAIN Your public domain magktech.com
SSL_EMAIL Let's Encrypt contact email admin@magktech.com
POSTGRES_PASSWORD Database password Generate with openssl rand -base64 24
RABBITMQ_PASSWORD Message queue password Generate with openssl rand -base64 24
BETTER_AUTH_SECRET Auth session secret Generate with openssl rand -hex 32

Secret Generation

Generate secure random values for all password and secret fields: 

openssl rand -base64 24  # For passwords
openssl rand -hex 32     # For secrets/keys

For the full list of configuration options, see the Configuration Reference.

Step 3: Build and Start

docker compose -f compose/docker-compose.yml \
  -f compose/docker-compose.traefik.yml \
  -f compose/docker-compose.production.yml \
  build

docker compose -f compose/docker-compose.yml \
  -f compose/docker-compose.traefik.yml \
  -f compose/docker-compose.production.yml \
  up -d

Wait for all services to become healthy:

docker compose -f compose/docker-compose.yml ps

Step 4: Access the Admin Dashboard

  1. Open https://yourdomain.com in your browser
  2. Log in with the default admin credentials (set during initial setup)
  3. Navigate to the Dashboard to verify all services are running

Step 5: Create Your First User

  1. Go to Admin → User Management
  2. Click Create User
  3. Fill in the user details and assign a role (Admin, Organizer, or Player)
  4. The new user can now log in at https://yourdomain.com/login

Step 6: Basic Platform Setup

After your first login, complete these initial configuration tasks:

  1. Settings — Review and update platform branding, default map provider, and notification preferences. See Settings.
  2. Certificates — Generate the TAK CA certificate for client authentication. See Certificate Management.
  3. Nodes (optional) — Upload firmware and create config templates if using MAGK Node devices. See Node Management.

What's Next?