Documentation
| VoIPmonitor Documentation |
| Complete guides for the open-source VoIP monitoring and troubleshooting solution |
Installation by OS
Choose your operating system to get started with VoIPmonitor installation. Each guide covers both Sniffer and GUI setup.
| Distribution | Version | Status | Notes |
|---|---|---|---|
| Ubuntu | 24.04 LTS | Recommended | Latest LTS, best performance |
| 22.04 LTS | Supported | Long-term support until 2027 | |
| 20.04 LTS | Maintenance | Security updates until 2025 | |
| 18.04 LTS | EOL | Upgrade recommended | |
| Debian | 13 (Trixie) | Recommended | Latest stable release |
| 12 (Bookworm) | Supported | Previous stable | |
| 11 (Bullseye) | Supported | Previous stable, LTS until 2026 | |
| 10 (Buster) | Maintenance | ELTS until 2029 | |
| Rocky Linux | Rocky 10 | Recommended | Latest RHEL 10 compatible |
| Rocky 9 | Supported | RHEL 9 compatible, support until 2032 | |
| AlmaLinux | AlmaLinux 10 | Recommended | Latest RHEL 10 compatible |
| AlmaLinux 9 | Supported | RHEL 9 compatible | |
| CentOS | CentOS 8 Stream | Maintenance | Use Rocky/Alma for new installs |
| CentOS 7 | EOL | Migrate to Rocky/Alma | |
| FreeBSD | FreeBSD 11+ | Supported | See also FreeBSD, FreeBSD10 |
For legacy systems: Outdated Distributions Guide (CentOS 5/6, Debian 6-9, Ubuntu 12-16, Gentoo, ARM)
Quick Start After OS Selection
| Sniffer (Sensor) Installation | Web GUI Installation |
|---|---|
|
Sniffer Installation Guide - Complete setup instructions After installation:
|
GUI Installation Guide - Fresh install Reinstall/Upgrade GUI - Update existing installation After installation:
|
Getting Started
| New to VoIPmonitor? | Already Installed? |
|---|---|
|
1. Understand the Architecture - How components work together |
Upgrade: Sniffer | GUI |
Sniffer (Sensor)
The C++ packet capture engine - monitors network traffic, decodes VoIP protocols, and stores call data.
| Setup & Configuration | Capture Modes | Operations | Troubleshooting |
|---|---|---|---|
|
Installation Guide Configuration Reference Database Schema Systemd Service |
Sniffing Modes Distributed Mode SIPREC Recording Capture Rules |
Data Retention Upgrade Guide Performance Tuning Database Redundancy |
Troubleshooting Guide Performance Logs Memory Issues Capture Problems |
Protocols & Advanced
| VoIP Protocols | Encryption & Security | Hardware & Performance |
|---|---|---|
|
SIP Protocol RTP Protocol WebRTC SS7 Signaling AudioCodes Tunneling |
TLS/SRTP DTLS Manager API Encryption SSH Public Key |
Hardware Requirements DPDK Napatech Cards Hugepages Multiple Instances |
Performance & Memory
| Memory Management | Monitoring & Logging | Utilities & Scripts |
|---|---|---|
|
jemalloc tcmalloc CPU Affinity I/O Monitoring |
Logging Configuration Syslog Integration Collectd GDB Debugging |
PCAP Extraction Audio Creation API Duration Check Emergency Procedures |
Web GUI
Browser-based interface for call analysis, reporting, alerts, and system management.
| Setup & Access | Call Analysis | Monitoring & Alerts | Administration |
|---|---|---|---|
|
Installation Guide Reinstall/Upgrade HTTPS Setup Nginx Configuration |
CDR Browser CDR Aggregation Live Sniffer Active Calls |
Dashboard Alert System Charts & Graphs Network Map |
User Management GUI Settings Backup & Restore REST API |
Features & Tools
| Security & Authentication | Reporting & Billing | Advanced Features |
|---|---|---|
|
Two-Factor Auth Google Sign-In Microsoft Sign-In Shibboleth/SAML Automated Login |
Report Builder Billing Module Fraud Detection NER Statistics Country Grouping |
SIP Register SIP Messages Issue Tracker Groups Tools |
Integrations
| External Monitoring | Web Server | Data Export |
|---|---|---|
|
Nagios Nagios 4 SIP OPTIONS Monitoring |
PHP-FPM & Apache Security Hardening HAProxy |
API Downloads API Listing PCAP Analysis |
Infrastructure & Scaling
| High Availability | Database | Performance |
|---|---|---|
|
HA & Failover Galera Cluster Cloud Deployment OpenVPN |
MySQL TLS Master-Slave Master-Master ProxySQL |
Performance Tuning High-Perf Setup Swap Configuration SQL Queue Issues |
Voice Quality & Analysis
| Quality Metrics | Audio Processing |
|---|---|
|
Voice Quality Guide Jitter Analysis Silence Detection |
Audio Codecs Guide SpanDSP Library SoX Integration Whisper Integration |
Quick Reference
|
Changelogs |
Reference |
External Links |
AI Summary for RAG
Summary: Main documentation hub for VoIPmonitor - covers installation by OS, sniffer configuration, web GUI setup, scaling, high availability, and troubleshooting for the open-source VoIP monitoring solution. Keywords: documentation, main page, getting started, installation, gui, sniffer, overview, ubuntu, debian, centos, rocky, alma Key Questions:
- Where do I start with VoIPmonitor?
- How do I install VoIPmonitor?
- What documentation is available?
- Which Linux distribution should I use?