Quick Start
Get knot running in minutes. Choose the deployment path that matches your needs.
Deployment Options
Local Containers
Recommended for most users
- Single Server: Quick setup on one machine with Docker, Podman, or Apple Containers
- Multi-Server: Scale across multiple servers with automatic node selection and load balancing
- No orchestrator required: No Nomad, Kubernetes, or other dependencies needed
- Setup time: 5-10 minutes
Best for:
- Individual developers
- Small to medium teams
- Quick testing and evaluation
- Multi-server setups without Nomad complexity
Nomad Cluster
For enterprise-scale deployments
- Leverage existing Nomad infrastructure
- CSI storage drivers and ingress controllers
- Advanced job constraints and scheduling
- Setup time: 30+ minutes
Best for:
- Production deployments
- Large teams
- High availability needs
- Organizations with existing Nomad infrastructure
Desktop Client
Run locally or connect to servers
- Run containers on your desktop
- Connect to existing servers for shared templates
- SSH access to spaces
- Port forwarding and tunnel creation
- File transfers
- Setup time: 2 minutes
Best for:
- Individual developers working locally
- Remote developers connecting to shared servers
- Quick testing without server setup
Quick Comparison
| Feature | Local Containers | Nomad | Client |
|---|---|---|---|
| Single Server | ✅ | ✅ | ✅ |
| Multi-Server | ✅ | ✅ | N/A |
| Dependencies | Docker/Podman/Apple | Nomad, Consul, CSI | None |
| Setup Time | 5-10 min | 30+ min | 2 min |
| Complexity | Low | High | Very Low |
What You’ll Learn
Local Containers Path:
- Install knot binary
- Configure server
- Create admin user
- Create first template
- Launch first space
- Access via web terminal
Nomad Path:
- Install knot binary
- Configure for Nomad
- Deploy to cluster
- Create admin user
- Create Nomad template
- Launch space in cluster
Client Path:
- Install client binary
- Run locally or connect to server
- Configure SSH
- Access spaces
What’s Next
After completing quick start: