Getting Started

runtz can run as a self-hosted stack with Docker Compose or as a Kubernetes deployment with Helm.

Requirements

• Docker and Docker Compose for local runs.
• Kubernetes and Helm for cluster installs.

Docker Compose

Download the compose file and start the platform in detached mode:

curl -fsSL https://runtz.dev/home/docker-compose.yml -o docker-compose.yml
docker compose up -d

Open the platform:

http://localhost:3000

The backend health endpoint is available at:

http://localhost:8080/health

MongoDB is available on:

localhost:27017

If 8080, 3000 or 27017 are already in use, change BACKEND_PORT, FRONTEND_PORT, MONGODB_PORT and NEXT_PUBLIC_API_URL in .env.

Helm

Add the runtz chart repository, update it, and install the platform:

helm repo add runtz https://runtz.dev/charts
helm repo update
helm upgrade --install runtz runtz/runtz \
  --namespace runtz \
  --create-namespace

First access

On the first access, runtz asks for:

• Usuário Admin
• Password
• Workspace Name

After this setup, the admin user can create workspaces and manage users in Settings.

Environment variables

PORT=8080
MONGODB_URI=mongodb://mongodb:27017
MONGODB_DATABASE=runtz
JWT_SECRET=change-me-before-sharing
RUNTZ_INGEST_TOKEN=dev-ingest-token
CORS_ALLOWED_ORIGINS=http://localhost:3000
NEXT_PUBLIC_API_URL=http://localhost:8080