Installation

Quick start gets both services running with a single command:

curl -sSL https://raw.githubusercontent.com/bantex01/VectorStep-Dist/main/install.sh | bash

That needs Docker and nothing else — VectorStep is distributed as container images, so there is no source to check out and nothing to compile. Add --service-only if the Gateway runs elsewhere, or --postgres for PostgreSQL instead of the SQLite default — see Deployment. This section is the full reference to sit alongside quick start, organised by how you actually intend to run this rather than crammed into one page.

• Docker — pull the published images, docker run or docker compose for local evaluation.
• Kubernetes — plain manifests for a real cluster, plus the two constraints (single replica, in-process migrations) worth knowing before you apply them.
• Linux — the installer on a plain VM under Docker, plus running the stack under systemd so it survives a reboot; or, with no Docker available, standalone binaries under systemd instead (--native — amd64 and arm64, no Python, no source).
• macOS — Docker Desktop and the installer; called out separately since the two platforms may diverge later.
• Windows — Docker Desktop, or WSL2 if you prefer a Linux shell.

For the config file itself once something’s running — every field, the database decision, migrations — see Deployment. Before anything here faces real traffic, work through Securing a deployment — network placement, authentication, TLS, and the rest of the checklist. Evaluating this for production and wondering about scale or resilience? Scaling & availability says plainly where things stand today.