knot

Quick Start

Get Knot running in minutes. Choose the deployment path that matches your needs.

Recommended

Desktop Mode

Easiest way to get started

Run knot with no subcommand on your desktop: the full server starts with a system tray icon, and the first run launches a setup wizard in your browser that writes a complete knot.toml. Ideal for laptops, desktops, and trying Knot out.

Using the Config Wizard

Fastest way to get started

Run knot server config-wizard to generate a knot.toml through a guided web UI that walks you through each decision — database, networking, DNS, platforms, tunnel, security, and optional features. Sensible defaults are applied based on your deployment type.

Manual Setup

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

Quick Comparison

Feature	Local Containers	Nomad
Single Server	✅	✅
Multi-Server	✅	✅
Dependencies	Docker/Podman/Apple	Nomad, Consul, CSI
Setup Time	5-10 min	30+ min
Complexity	Low	High

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

What’s Next

After completing quick start: