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.

Find answers to the most common questions about kombify. Can’t find what you’re looking for? Contact support or ask in our Discord community.
Use your browser’s search (Ctrl/Cmd + F) to find specific topics quickly.

​
Getting Started

kombify is a platform that guides you through building and managing self-hosted infrastructure. It transforms fragmented homelab setups into professional, documented, and maintainable systems.The platform consists of:
  • kombify TechStack - Orchestration engine for deploying infrastructure
  • kombify Simulate - Simulation environment for testing before deploying
  • kombify StackKits - Pre-built templates for common setups
  • kombify Cloud - Cloud dashboard for management and collaboration
Learn more →
kombify offers both free and paid tiers:
TierPriceIncludes
CommunityFreeCore tools, self-hosted, 3 nodes
Pro$19/monthUnlimited nodes, priority support
EnterpriseCustomSSO, SLA, dedicated support
All core tools (TechStack, Simulate, StackKits) are open source and free to self-host. kombify Cloud provides optional cloud features.View pricing →
Minimum requirements:
  • A Linux server (Ubuntu 22.04+ recommended) or Docker-capable machine
  • Basic command-line familiarity
  • 15 minutes of time
For full deployment:
  • At least one physical or virtual machine for nodes
  • Network access between nodes
  • (Optional) Domain name for public services
Quick start guide →
Yes! kombify is designed for users of all skill levels:
  • Beginners: Use the Easy Wizard in kombify Cloud to answer simple questions and generate a working configuration
  • Intermediate: Edit the generated kombination.yaml to customize your setup
  • Advanced: Create custom StackKits with CUE schemas
Start with Easy Wizard →

​
Installation & Setup

The fastest way is using Docker Compose:
curl -fsSL https://get.kombify.dev | sh
Or manually:
git clone https://github.com/kombify/kombifyStack
cd kombifyStack
docker compose up -d
Self-hosting guide →
kombify TechStack and Simulate run in Docker, so they work anywhere Docker runs:
  • Windows: Use Docker Desktop or WSL2
  • macOS: Use Docker Desktop
  • Linux: Native Docker or Podman
For managed nodes (where your services run), Linux is required.
ServicePortProtocolPurpose
Stack API5260HTTPREST API
Stack gRPC5263gRPCAgent communication
Sim API5270HTTPREST API
Sim UI5271HTTPWeb interface
PocketBase8090HTTPAdmin UI (internal)
All ports are configurable via environment variables.
1

Generate agent certificate

make certs-agent AGENT=my-node-01
2

Run bootstrap on the node

curl -fsSL https://your-stack-host/bootstrap.sh | sh
3

Verify connection

Check the node appears in Stack dashboard or API:
curl https://your-stack-host/api/v1/nodes
Detailed guide →

​
Configuration

kombination.yaml is the central specification file for your infrastructure. It declares:
  • Which StackKit (template) to use
  • Which nodes to manage
  • Which services to deploy
  • Custom configuration overrides
Example:
stackkit: base-kit

nodes:
  - name: main-server
    type: local
    connection:
      host: 192.168.1.100

services:
  - traefik
  - authelia
  - homepage

config:
  domain: home.example.com
  email: admin@example.com
StackKits support multiple customization levels:1. Configuration overrides (simplest):
config:
  traefik:
    dashboard: true
    logLevel: DEBUG
2. Service selection:
services:
  - traefik
  - +grafana  # Add optional service
  - -homepage # Remove default service
3. Custom StackKit (advanced): Create your own StackKit extending an existing one.Customization guide →
Yes! kombify can import existing setups:
kombify import docker-compose.yml
This generates a kombination.yaml based on your current setup, which you can then enhance with StackKit features.

​
Simulation

kombify Simulate creates virtual environments to test your configuration before deploying to real hardware. This helps you:
  • Catch configuration errors early
  • Test service interactions
  • Validate networking and security
  • Train without risking production
Sim overview →
BackendSpeedFidelityUse Case
Docker⚡ FastMediumQuick iteration, container workloads
QEMU🐢 SlowerHighFull VM testing, bare-metal simulation
ExternalVariesHighestCloud VMs, real hardware
Recommendation: Start with Docker for speed, use QEMU for final validation.Engine configuration →
# Get node SSH info
curl https://api.kombify.io/v1/simulation/nodes/my-sim-node

# SSH using provided credentials
ssh -p 2222 root@localhost
Default credentials for simulations: root / kombifySSH access guide →

​
Troubleshooting

Common causes:
  1. Certificate mismatch - Regenerate agent certificate
  2. Network blocked - Ensure port 5263 is open
  3. DNS resolution - Check agent can resolve Stack hostname
  4. Time sync - Ensure clocks are synchronized (NTP)
Debug steps:
# On the agent node
journalctl -u kombify-agent -f

# Test connectivity
nc -zv your-stack-host 5263

# Verify certificate
openssl s_client -connect your-stack-host:5263
Full troubleshooting →
Validation errors mean your kombination.yaml doesn’t match the StackKit schema.To debug:
# Run validation locally
kombify validate kombination.yaml

# See detailed schema
kombify schema show base-kit
Common fixes:
  • Check for typos in service names
  • Ensure required fields are present
  • Verify YAML indentation
Checklist:
  • Verify services are running: docker ps or check dashboard
  • Check Traefik is routing correctly: access Traefik dashboard
  • Verify DNS/hosts entries point to correct IP
  • Check firewall allows traffic on ports 80/443
  • Verify SSL certificates are valid (if using HTTPS)
Quick test:
# Check container logs
docker logs traefik

# Test local access
curl -H "Host: myservice.home.local" http://localhost
ComponentLog Location
Stackdocker logs kombify-stack or /var/log/kombify/
Simdocker logs kombify-sim
Agentjournalctl -u kombify-agent
ServicesVia Docker: docker logs <container>
Enable debug logging:
export KOMBISTACK_LOG_LEVEL=debug

​
Security

kombify follows security best practices:✅ mTLS encryption for all agent-core communication
✅ Certificate-based auth - no passwords in transit
✅ Principle of least privilege - agents have minimal permissions
✅ Audit logging - all actions are logged
✅ Open source - security-auditable codeSecurity guide →
# Generate new CA (if compromised)
make certs-rotate-ca

# Generate new agent cert
make certs-agent AGENT=my-node-01 ROTATE=true

# Restart agent to pick up new cert
systemctl restart kombify-agent
Yes! Import your CA during setup:
export KOMBIFY_CA_CERT=/path/to/ca.crt
export KOMBIFY_CA_KEY=/path/to/ca.key
make setup
Or configure in kombination.yaml:
security:
  ca:
    cert: /path/to/ca.crt
    key: /path/to/ca.key

​
Comparison

FeaturekombifyPortainer
FocusFull lifecycle managementContainer management
IaCYes (OpenTofu)Limited
TestingBuilt-in simulationNo
TemplatesStackKits (CUE)Compose only
Multi-nodeNativeEnterprise only
Use kombify if: You want guided infrastructure setup with testing. Use Portainer if: You just need container visibility.
FeaturekombifyAnsible
Learning curveLowMedium-High
AbstractionIntent-drivenTask-based
SimulationBuilt-inMolecule (separate)
State managementAutomaticManual
Use kombify if: You want opinionated, guided deployments. Use Ansible if: You need maximum flexibility for custom automation.

​
Still Have Questions?

Discord Community

Get help from the community

GitHub Discussions

Ask technical questions

Email Support

Contact the team directly