Installation
System Requirements
Section titled “System Requirements”| Requirement | Minimum | Recommended |
|---|---|---|
| OS | Ubuntu 22.04 LTS | Ubuntu 24.04 LTS |
| CPU | 2 vCPU | 4 vCPU |
| RAM | 4 GB | 8 GB |
| Disk | 40 GB SSD | 100 GB SSD |
| Network | Public IPv4, ports 25/80/443/993/995 open | + IPv6 |
| DNS | MX, A, SPF, DKIM, DMARC records | + PTR (reverse DNS) |
Docker and Docker Compose are installed automatically by the Vectis installer.
Quick Install
Section titled “Quick Install”# Download the Vectis binarycurl -fsSL https://get.vectismail.com | sh
# Run preflight checksvectis preflight
# Install (interactive — prompts for hostname, admin email, passwords)vectis installWhat the installer does
Section titled “What the installer does”- Preflight checks — verifies OS, ports, DNS, Docker availability
- Generates secrets — database passwords, API secret, cookie key, DKIM keys
- Writes config —
config.yamlandsecrets.yamlto/etc/vectis/ - Runs the config engine — generates Postfix, Dovecot, Rspamd, Traefik configs
- Starts Docker Compose — pulls images and starts all containers
- Runs migrations — creates the database schema
- Creates initial admin — the admin account you’ll use to log in
Two-Step Install (Advanced)
Section titled “Two-Step Install (Advanced)”For automated deployments, you can separate preflight from install:
# Step 1: Check prerequisites (exits non-zero on failure)vectis preflight --strict
# Step 2: Install with pre-written config filesvectis install --config /etc/vectis/config.yaml --secrets /etc/vectis/secrets.yamlVerifying the Installation
Section titled “Verifying the Installation”# Check all services are healthyvectis status
# Open the admin dashboard# https://your-hostname/admin# Log in with the admin email and password from installationConfiguration Files
Section titled “Configuration Files”After installation, your config lives in /etc/vectis/:
| File | Purpose |
|---|---|
config.yaml | System configuration (hostname, TLS, resources, features) |
secrets.yaml | Credentials (database, API, DKIM paths, OIDC, ValidonX) |
generated/ | Auto-generated service configs (do not edit manually) |
Changes to config.yaml are applied via:
vectis config applyThis regenerates all service configs and restarts affected containers.