Trisul Documentation
Welcome to the Trisul Network Analytics documentation. Trisul does real-time streaming traffic analysis, deep packet inspection and long-term network telemetry, so you can see network usage, bandwidth trends and security threats.
Whether you are setting up Trisul for the first time, managing probes and hubs, analyzing traffic patterns, or developing custom analytics with Lua and APIs, the documentation guides below will help you find what you need.
Start with the Quickstart. It takes you from a blank server to your first login. To choose a product mode first, see Product Modes.
Core Documentation Guides
🗃️ Start Here
Architecture, data flow pipeline, product modes, and guided setup instructions.
🗃️ Admin Guide
Server administration, probes, hubs, Web Admin, contexts, and storage maintenance.
🗃️ User Guide
Day-to-day analytics, traffic monitoring, flow querying, alerts, and reporting.
🗃️ Learn Trisul
Core concepts, terminology, home networks, and streaming flow deduplication.
🗃️ Reference
Technical specifications for configuration files, CLI utilities, and plugins.
📄️ Changelog
This changelog outlines the key updates, improvements, and fixes made to Trisul across various releases. Browse through the release notes below to learn about the latest features, enhancements, and bug fixes.
Additional Resources
Looking for specialized product solutions or developer APIs?
- Product Guides: One guide per product mode: Trisul NetFlow Analyzer, Trisul NSM, Trisul IPDR DoT Compliance Solution, and Trisul ISP Analytics.
- LUA API Guide: Build custom streaming real-time network traffic processors and metrics using Trisul's embedded Lua engine.
- TRP Query API Guide: Programmatically query Trisul's high-speed analytics database via the Trisul Remote Protocol (TRP).
- Troubleshooting Guide: Step-by-step diagnostic workflows for common setup and operational issues.
- HowTos: Short task guides, such as changing the web server port or setting up HTTPS.
- Glossary: Definitions of the networking and Trisul terms used in these docs.