Documentation
Install, configure, and integrate.
Everything you need to deploy TRIVLA agents, connect them to your portal, and query the REST API.
Getting started
TRIVLA documentation
TRIVLA has three components: the agent (edge sensor), the portal & API (control plane), and analytics storage (MySQL, Redis, StarRocks). This guide walks through installation and configuration.
Self-host the portal
Run the free, open-source portal & API with Docker, or use TRIVLA Cloud.
🐧Linux installation
Install on Ubuntu, Debian, RHEL, and other distributions with nftables.
🌊FreeBSD / NetBSD
Install with pf firewall and package dependencies.
🪟Windows installation
Deploy with WFP and Npcap on Server and Desktop.
🔗API reference
REST endpoints for agents, licenses, and alerts.
🛒WordPress & Shopify
Account security plugins for your storefront — download and docs.
💬Community forum
Read guides and discussions; sign in to ask questions.
Licensing
Each agent requires a license key. Keys are bound to your account, signed by TRIVLA, and validated on first connection. The agent caches the license in local SQLite for offline operation.
- In your portal, open Manage → Licenses. Click Get free Community key, or buy a Professional / Enterprise key from your account at trivla.com.
- Copy the key and apply it during agent installation or via
trivla-agent license set <KEY>. - The agent registers with the portal API and begins streaming telemetry.
The free Community key includes core features and free agent seats. Professional and Enterprise plans add advanced analytics, TLS decryption, and more seats — see pricing.
Firewall rules
Firewall policy is defined in the portal and pushed to agents. Supported rule types:
- ✓ Block / allow IP and CIDR
- ✓ Block / allow country and ASN (Geo-IP via MaxMind GeoLite2)
- ✓ Rate limiting and protocol blocking
Backends are selected automatically: nftables + ipset on Linux, pf on BSD, WFP on Windows.
Portal connection
Configure the agent to point at your portal API endpoint. For self-hosted deployments:
[portal]
url = https://portal.example.com/api/v1
license_key = trvl_xxxxxxxxxxxxxxxx
[agent]
name = edge-fw-01
interfaces = eth0,eth1For TRIVLA Cloud, use https://portal.trivla.com/api/v1 as the default endpoint.