Up and running in three steps
vConfig runs on your own Linux server with Docker. The installer takes care of everything.
Run the installer
On a clean Ubuntu 24.04 LTS server (4 vCPU / 8 GB RAM minimum), run one line as root. It installs Docker if missing, frees ports 80/443 if something else holds them, and brings up six containers — app, gateway, AI worker, database, Prometheus and snmp-exporter.
$ curl -fsSL https://vconfig.ai/install.sh | sudo bash
Log in
The installer prints the URL and a generated admin password when it finishes. Open https://your-server (plain http:// on port 80 redirects there), sign in as admin, and change the password when prompted. Lost it? Run vconfigctl password on the server.
Add devices — or activate a license
Add devices under Devices → Add, or let SNMP discovery find them for you. Up to 10 devices are free forever. Bought a plan? Paste the license key under Settings → License — it activates online and takes effect without a restart.
System requirements
| Component | Minimum | Recommended |
|---|---|---|
| OS | Ubuntu 24.04 LTS | Ubuntu 24.04 LTS |
| CPU / RAM | 4 vCPU / 8 GB | 8 vCPU / 16 GB |
| Disk | 500 GB+ | 1 TB+ |
| Network | SSH/Telnet reachability to managed devices; outbound HTTPS to vconfig.ai for activation and updates | |
Ports to open
| Direction | Port | Purpose |
|---|---|---|
| Inbound | TCP 443 | Web UI and API, over TLS |
| Inbound | TCP 80 | 301 redirect to HTTPS only |
| Inbound | TCP 8443 | Web terminal and bastion sessions (WebSocket) |
| Inbound | UDP/TCP 514 | Device syslog — the port is published at install time, but ingestion stays off until you enable it under Settings → Syslog (logs grow the disk, so it is your call) |
| Inbound | UDP 2055 | NetFlow v5/v9, IPFIX and sFlow on one port — for Visualization → Traffic analysis. Also published but off until enabled; sample on the device (1:1000 is a sane start) or a busy router buries the collector. |
| Inbound | TCP 21 + 50100-50140, TCP 2222 | Firmware image distribution: devices pull images from vConfig over FTP (passive range) or SCP. SCP uses 2222 because port 22 belongs to the host sshd. Skip both with VCONFIG_TRANSFER_PORTS=0 if you publish images from your own server. |
| Outbound | TCP 22, TCP 23 | SSH / Telnet to managed devices — backups, inventory, terminal |
| Outbound | UDP 161 | SNMP discovery and metrics |
| Outbound | ICMP | Reachability and SLA probes |
| Outbound | TCP 443 | vconfig.ai — license activation and update checks only |
Every port above can be changed at install time. Optional integrations add their own: SMTP for email alerts (587 by default), LDAP/LDAPS (389/636) and cloud provider APIs (TCP 443).
Detailed instructions, offline installation and upgrade guides live in the installation documentation.