Skip to content

Installation

RequirementMinimumRecommended
OSUbuntu 22.04 LTSUbuntu 24.04 LTS
CPU2 vCPU4 vCPU
RAM4 GB8 GB
Disk40 GB SSD100 GB SSD
NetworkPublic IPv4, ports 25/80/443/993/995 open+ IPv6
DNSMX, A, SPF, DKIM, DMARC records+ PTR (reverse DNS)

Docker and Docker Compose are installed automatically by the Vectis installer.

Terminal window
# Download the Vectis binary
curl -fsSL https://get.vectismail.com | sh
# Run preflight checks
vectis preflight
# Install (interactive — prompts for hostname, admin email, passwords)
vectis install
  1. Preflight checks — verifies OS, ports, DNS, Docker availability
  2. Generates secrets — database passwords, API secret, cookie key, DKIM keys
  3. Writes configconfig.yaml and secrets.yaml to /etc/vectis/
  4. Runs the config engine — generates Postfix, Dovecot, Rspamd, Traefik configs
  5. Starts Docker Compose — pulls images and starts all containers
  6. Runs migrations — creates the database schema
  7. Creates initial admin — the admin account you’ll use to log in

For automated deployments, you can separate preflight from install:

Terminal window
# Step 1: Check prerequisites (exits non-zero on failure)
vectis preflight --strict
# Step 2: Install with pre-written config files
vectis install --config /etc/vectis/config.yaml --secrets /etc/vectis/secrets.yaml
Terminal window
# Check all services are healthy
vectis status
# Open the admin dashboard
# https://your-hostname/admin
# Log in with the admin email and password from installation

After installation, your config lives in /etc/vectis/:

FilePurpose
config.yamlSystem configuration (hostname, TLS, resources, features)
secrets.yamlCredentials (database, API, DKIM paths, OIDC, ValidonX)
generated/Auto-generated service configs (do not edit manually)

Changes to config.yaml are applied via:

Terminal window
vectis config apply

This regenerates all service configs and restarts affected containers.