Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kombify.io/llms.txt

Use this file to discover all available pages before exploring further.

Create your first simulated homelab in under 5 minutes.

​
Prerequisites

  • Docker installed and running
  • 2GB free RAM
  • Basic terminal knowledge

​
Step 1: Start Simulate

docker run -d \
  --name kombisim \
  -p 5270:5270 \
  -p 30000-39999:30000-39999 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  ghcr.io/kombify/sim:latest

​
Step 2: Create a Simulation

# Create a new simulation
curl -X POST http://localhost:5270/api/v1/simulations \
  -H "Content-Type: application/json" \
  -d '{"name": "my-homelab"}'
Save the returned id - you’ll need it.

​
Step 3: Add a Node

curl -X POST http://localhost:5270/api/v1/nodes \
  -H "Content-Type: application/json" \
  -d '{
    "name": "server-1",
    "simulation_id": "YOUR_SIM_ID",
    "os": "ubuntu-22.04"
  }'

​
Step 4: SSH into Your Node

ssh -p 30001 root@localhost
# Password: kombisim
# Port is dynamically assigned - check node details for exact port
You now have a fully functional Ubuntu server to test with!

​
Step 5: Check API Health

curl http://localhost:5270/health

​
What’s Next?

Templates

Use pre-built simulation templates

Self-Hosting Guide

Persistent setup with Docker Compose