Documentation: Difference between revisions

Revision as of 23:36, 4 January 2026

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)	Testing	Next stable release
	12 (Bookworm)	Recommended	Current 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 Linux	Rocky 9	Supported	RHEL 9 compatible, support until 2032
AlmaLinux	AlmaLinux 10	Recommended	Latest RHEL 10 compatible
AlmaLinux	AlmaLinux 9	Supported	RHEL 9 compatible
CentOS	CentOS 8 Stream	Maintenance	Use Rocky/Alma for new installs
CentOS	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: Configure voipmonitor.conf - Database, interface settings Choose Sniffing Mode - Mirror port, SPAN, ERSPAN Service Management - Start/stop/enable	GUI Installation Guide - Fresh install Reinstall/Upgrade GUI - Update existing installation After installation: Create Users - Accounts and permissions Configure Settings - System options Enable HTTPS - Secure access

Getting Started

New to VoIPmonitor?	Already Installed?
1. Understand the Architecture - How components work together 2. Choose your OS above and follow the installation guide 3. Configure the Sniffer - Essential settings 4. Explore the GUI - Feature overview	Upgrade: Sniffer \| GUI Troubleshoot: Sniffer Issues \| GUI Issues Scale: Performance Tuning \| High Availability API: REST API Reference

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 Static binary setup for all Linux Configuration Reference voipmonitor.conf parameters Database Schema CDR table structure Systemd Service Service management	Sniffing Modes Mirror port, SPAN, ERSPAN Distributed Mode Client/Server architecture SIPREC Recording SBC-based call recording Capture Rules Filter what gets recorded	Data Retention Cleanup and rotation policies Upgrade Guide Update to latest version Performance Tuning High-traffic optimization Database Redundancy Replication setup	Troubleshooting Guide Common issues & solutions Performance Logs Interpret t0CPU, SQLq, etc. Memory Issues Debugging memory usage Capture Problems Why calls not captured

Protocols & Advanced

VoIP Protocols	Encryption & Security	Hardware & Performance
SIP Protocol Session Initiation Protocol RTP Protocol Real-time Transport WebRTC Browser-based VoIP SS7 Signaling Legacy telephony AudioCodes Tunneling Proprietary protocol	TLS/SRTP Encrypted SIP/RTP DTLS Datagram TLS for WebRTC Manager API Encryption Secure API access SSH Public Key Remote access setup	Hardware Requirements Sizing guide DPDK Data Plane Development Kit Napatech Cards Hardware acceleration Hugepages Memory optimization Multiple Instances Multi-sensor setup

Performance & Memory

Memory Management	Monitoring & Logging	Utilities & Scripts
jemalloc Memory allocator tcmalloc Google allocator CPU Affinity Core pinning I/O Monitoring Disk performance	Logging Configuration Log settings Syslog Integration Remote logging Collectd System metrics GDB Debugging Core dump analysis	PCAP Extraction Manual export Audio Creation From packet dumps API Duration Check Call stats Emergency Procedures Critical issues

Web GUI

Browser-based interface for call analysis, reporting, alerts, and system management.

Setup & Access	Call Analysis	Monitoring & Alerts	Administration
Installation Guide Fresh install Reinstall/Upgrade Update existing HTTPS Setup SSL/TLS configuration Nginx Configuration Reverse proxy setup	CDR Browser Search and filter calls CDR Aggregation Statistics and summaries Live Sniffer Real-time packet capture Active Calls Currently active sessions	Dashboard Overview and widgets Alert System Notifications and triggers Charts & Graphs Visual analytics Network Map Topology visualization	User Management Accounts and permissions GUI Settings System configuration Backup & Restore Configuration backup REST API Programmatic access

Features & Tools

Security & Authentication	Reporting & Billing	Advanced Features
Two-Factor Auth TOTP authentication Google Sign-In OAuth integration Microsoft Sign-In Azure AD Shibboleth/SAML Enterprise SSO Automated Login Scripted access	Report Builder Custom reports Billing Module Cost analysis Fraud Detection Anomaly alerts NER Statistics Network effectiveness Country Grouping Geographic analysis	SIP Register Registration tracking SIP Messages IM/SMS analysis Issue Tracker Problem management Groups Call grouping Tools Utility functions

Integrations

External Monitoring	Web Server	Data Export
Nagios Legacy monitoring Nagios 4 Updated integration SIP OPTIONS Monitoring Availability checks	PHP-FPM & Apache Web server setup Security Hardening HTTPS & auth HAProxy Load balancing	API Downloads PCAP/audio export API Listing Call list export PCAP Analysis Packet inspection

Infrastructure & Scaling

High Availability	Database	Performance
HA & Failover Redundancy setup Galera Cluster Multi-master MySQL Cloud Deployment AWS, GCP, Azure OpenVPN Secure tunneling	MySQL TLS Encrypted connections Master-Slave Read replicas Master-Master Active-active setup ProxySQL Connection pooling	Performance Tuning Optimization guide High-Perf Setup Enterprise config Swap Configuration Memory management SQL Queue Issues Peak time handling

Voice Quality & Analysis

Quality Metrics	Audio Processing
Voice Quality Guide MOS, R-Factor, impairments explained Jitter Analysis Network timing issues Silence Detection Audio gap detection	Audio Codecs Guide G.711, G.729, Opus, etc. SpanDSP Library Fax/modem processing SoX Integration Audio conversion Whisper Integration Speech-to-text

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?

@@ Line 157: / Line 157: @@
 {| class="wikitable" style="width:100%;"
 |-
-! style="background:#f3e5f5;" | VoIP Protocols
+! style="background:#f3e5f5; width:33%;" | VoIP Protocols
-! style="background:#e0f7fa;" | Encryption & Security
+! style="background:#e0f7fa; width:33%;" | Encryption & Security
-! style="background:#fff8e1;" | Hardware & Performance
+! style="background:#fff8e1; width:34%;" | Hardware & Performance
 |-
 | style="vertical-align:top; padding:12px;" |
-[[Understanding_the_SIP_Protocol|'''SIP Protocol''']] - Session Initiation Protocol<br/>
+[[Understanding_the_SIP_Protocol|'''SIP Protocol''']]<br/><small>Session Initiation Protocol</small>
-[[Understanding_the_RTP_Protocol|'''RTP Protocol''']] - Real-time Transport<br/>
-[[Understanding_the_WebRTC_Protocol|'''WebRTC''']] - Browser-based VoIP<br/>
+[[Understanding_the_RTP_Protocol|'''RTP Protocol''']]<br/><small>Real-time Transport</small>
-[[Ss7|'''SS7 Signaling''']] - Legacy telephony<br/>
-[[Audiocodes_tunneling|'''AudioCodes Tunneling''']] - Proprietary protocol
+[[Understanding_the_WebRTC_Protocol|'''WebRTC''']]<br/><small>Browser-based VoIP</small>
+[[Ss7|'''SS7 Signaling''']]<br/><small>Legacy telephony</small>
+[[Audiocodes_tunneling|'''AudioCodes Tunneling''']]<br/><small>Proprietary protocol</small>
 | style="vertical-align:top; padding:12px;" |
-[[Tls|'''TLS/SRTP''']] - Encrypted SIP/RTP<br/>
+[[Tls|'''TLS/SRTP''']]<br/><small>Encrypted SIP/RTP</small>
-[[DTLS|'''DTLS''']] - Datagram TLS for WebRTC<br/>
-[[Encryption_in_manager_api|'''Manager API Encryption''']] - Secure API<br/>
+[[DTLS|'''DTLS''']]<br/><small>Datagram TLS for WebRTC</small>
-[[Pubkey|'''SSH Public Key''']] - Remote access
+[[Encryption_in_manager_api|'''Manager API Encryption''']]<br/><small>Secure API access</small>
+[[Pubkey|'''SSH Public Key''']]<br/><small>Remote access setup</small>
 | style="vertical-align:top; padding:12px;" |
-[[Hardware|'''Hardware Requirements''']] - Sizing guide<br/>
+[[Hardware|'''Hardware Requirements''']]<br/><small>Sizing guide</small>
-[[DPDK|'''DPDK''']] - Data Plane Development Kit<br/>
-[[Napatech|'''Napatech Cards''']] - Hardware acceleration<br/>
+[[DPDK|'''DPDK''']]<br/><small>Data Plane Development Kit</small>
-[[Voipmonitor_and_hugepages|'''Hugepages''']] - Memory optimization<br/>
-[[Multiple_sniffer_instancies|'''Multiple Instances''']] - Multi-sensor
+[[Napatech|'''Napatech Cards''']]<br/><small>Hardware acceleration</small>
+[[Voipmonitor_and_hugepages|'''Hugepages''']]<br/><small>Memory optimization</small>
+[[Multiple_sniffer_instancies|'''Multiple Instances''']]<br/><small>Multi-sensor setup</small>
 |}
@@ Line 184: / Line 195: @@
 {| class="wikitable" style="width:100%;"
 |-
-! style="background:#e8eaf6;" | Memory Management
+! style="background:#e8eaf6; width:33%;" | Memory Management
-! style="background:#e0f2f1;" | Monitoring & Logging
+! style="background:#e0f2f1; width:33%;" | Monitoring & Logging
-! style="background:#fce4ec;" | Utilities & Scripts
+! style="background:#fce4ec; width:34%;" | Utilities & Scripts
 |-
 | style="vertical-align:top; padding:12px;" |
-[[Jemalloc|'''jemalloc''']] - Memory allocator<br/>
+[[Jemalloc|'''jemalloc''']]<br/><small>Memory allocator</small>
-[[Tcmalloc|'''tcmalloc''']] - Google allocator<br/>
-[[T2cpu|'''CPU Affinity''']] - Core pinning<br/>
+[[Tcmalloc|'''tcmalloc''']]<br/><small>Google allocator</small>
-[[IO_Measurement|'''I/O Monitoring''']] - Disk performance
+[[T2cpu|'''CPU Affinity''']]<br/><small>Core pinning</small>
+[[IO_Measurement|'''I/O Monitoring''']]<br/><small>Disk performance</small>
 | style="vertical-align:top; padding:12px;" |
-[[Logging|'''Logging Configuration''']] - Log settings<br/>
+[[Logging|'''Logging Configuration''']]<br/><small>Log settings</small>
-[[Syslog|'''Syslog Integration''']] - Remote logging<br/>
-[[Collectd_installation|'''Collectd''']] - System metrics<br/>
+[[Syslog|'''Syslog Integration''']]<br/><small>Remote logging</small>
-[[Gdb|'''GDB Debugging''']] - Core dump analysis
+[[Collectd_installation|'''Collectd''']]<br/><small>System metrics</small>
+[[Gdb|'''GDB Debugging''']]<br/><small>Core dump analysis</small>
 | style="vertical-align:top; padding:12px;" |
-[[Manual_PCAP_Extraction_from_spooldir|'''PCAP Extraction''']] - Manual export<br/>
+[[Manual_PCAP_Extraction_from_spooldir|'''PCAP Extraction''']]<br/><small>Manual export</small>
-[[Create_audio_from_packet_dumps_located_in_a_spooldir|'''Audio Creation''']] - From packet dumps<br/>
-[[Check_calls_duration_using_sniffer's_api|'''API Duration Check''']] - Call stats<br/>
+[[Create_audio_from_packet_dumps_located_in_a_spooldir|'''Audio Creation''']]<br/><small>From packet dumps</small>
-[[Emergency_procedures|'''Emergency Procedures''']] - Critical issues
+[[Check_calls_duration_using_sniffer's_api|'''API Duration Check''']]<br/><small>Call stats</small>
+[[Emergency_procedures|'''Emergency Procedures''']]<br/><small>Critical issues</small>
 |}
@@ Line 254: / Line 274: @@
 {| class="wikitable" style="width:100%;"
 |-
-! style="background:#e0f2f1;" | Security & Authentication
+! style="background:#e0f2f1; width:33%;" | Security & Authentication
-! style="background:#fce4ec;" | Reporting & Billing
+! style="background:#fce4ec; width:33%;" | Reporting & Billing
-! style="background:#e8eaf6;" | Advanced Features
+! style="background:#e8eaf6; width:34%;" | Advanced Features
 |-
 | style="vertical-align:top; padding:12px;" |
-[[2FA|'''Two-Factor Auth''']] - TOTP authentication<br/>
+[[2FA|'''Two-Factor Auth''']]<br/><small>TOTP authentication</small>
-[[Google_Sign_in_usage|'''Google Sign-In''']] - OAuth integration<br/>
-[[Microsoft_Sign_in_usage|'''Microsoft Sign-In''']] - Azure AD<br/>
+[[Google_Sign_in_usage|'''Google Sign-In''']]<br/><small>OAuth integration</small>
-[[Shibboleth_and_other_auth_modules|'''Shibboleth/SAML''']] - Enterprise SSO<br/>
-[[GUI_automate_login|'''Automated Login''']] - Scripted access
+[[Microsoft_Sign_in_usage|'''Microsoft Sign-In''']]<br/><small>Azure AD</small>
+[[Shibboleth_and_other_auth_modules|'''Shibboleth/SAML''']]<br/><small>Enterprise SSO</small>
+[[GUI_automate_login|'''Automated Login''']]<br/><small>Scripted access</small>
 | style="vertical-align:top; padding:12px;" |
-[[Reports|'''Report Builder''']] - Custom reports<br/>
+[[Reports|'''Report Builder''']]<br/><small>Custom reports</small>
-[[Billing|'''Billing Module''']] - Cost analysis<br/>
-[[Anti-fraud|'''Fraud Detection''']] - Anomaly alerts<br/>
+[[Billing|'''Billing Module''']]<br/><small>Cost analysis</small>
-[[NER_(Network_Effectiveness_Ratio)|'''NER Statistics''']] - Network effectiveness<br/>
-[[CountryGrouping|'''Country Grouping''']] - Geographic analysis
+[[Anti-fraud|'''Fraud Detection''']]<br/><small>Anomaly alerts</small>
+[[NER_(Network_Effectiveness_Ratio)|'''NER Statistics''']]<br/><small>Network effectiveness</small>
+[[CountryGrouping|'''Country Grouping''']]<br/><small>Geographic analysis</small>
 | style="vertical-align:top; padding:12px;" |
-[[Register|'''SIP Register''']] - Registration tracking<br/>
+[[Register|'''SIP Register''']]<br/><small>Registration tracking</small>
-[[MESSAGES|'''SIP Messages''']] - IM/SMS analysis<br/>
-[[Issue_tracker|'''Issue Tracker''']] - Problem management<br/>
+[[MESSAGES|'''SIP Messages''']]<br/><small>IM/SMS analysis</small>
-[[Groups|'''Groups''']] - Call grouping<br/>
-[[Tools|'''Tools''']] - Utility functions
+[[Issue_tracker|'''Issue Tracker''']]<br/><small>Problem management</small>
+[[Groups|'''Groups''']]<br/><small>Call grouping</small>
+[[Tools|'''Tools''']]<br/><small>Utility functions</small>
 |}
@@ Line 282: / Line 314: @@
 {| class="wikitable" style="width:100%;"
 |-
-! style="background:#fff8e1;" | External Monitoring
+! style="background:#fff8e1; width:33%;" | External Monitoring
-! style="background:#e3f2fd;" | Web Server
+! style="background:#e3f2fd; width:33%;" | Web Server
-! style="background:#e8f5e9;" | Data Export
+! style="background:#e8f5e9; width:34%;" | Data Export
 |-
 | style="vertical-align:top; padding:12px;" |
-[[Nagios|'''Nagios''']] - Legacy monitoring<br/>
+[[Nagios|'''Nagios''']]<br/><small>Legacy monitoring</small>
-[[Nagios4|'''Nagios 4''']] - Updated integration<br/>
-[[SIP_OPTIONS/SUBSCRIBE/NOTIFY|'''SIP OPTIONS Monitoring''']] - Availability checks
+[[Nagios4|'''Nagios 4''']]<br/><small>Updated integration</small>
+[[SIP_OPTIONS/SUBSCRIBE/NOTIFY|'''SIP OPTIONS Monitoring''']]<br/><small>Availability checks</small>
 | style="vertical-align:top; padding:12px;" |
-[[Php-fpm_&_apache|'''PHP-FPM & Apache''']] - Web server setup<br/>
+[[Php-fpm_&_apache|'''PHP-FPM & Apache''']]<br/><small>Web server setup</small>
-[[Securing_the_VoIPmonitor_Web_GUI_HTTPS_and_Basic_Auth|'''Security Hardening''']] - HTTPS & auth<br/>
-[[Sample_HAproxy_configuration|'''HAProxy''']] - Load balancing
+[[Securing_the_VoIPmonitor_Web_GUI_HTTPS_and_Basic_Auth|'''Security Hardening''']]<br/><small>HTTPS & auth</small>
+[[Sample_HAproxy_configuration|'''HAProxy''']]<br/><small>Load balancing</small>
 | style="vertical-align:top; padding:12px;" |
-[[Download_of_pcap_files_/_audio_files_using_GUI's_api|'''API Downloads''']] - PCAP/audio export<br/>
+[[Download_of_pcap_files_/_audio_files_using_GUI's_api|'''API Downloads''']]<br/><small>PCAP/audio export</small>
-[[Output_of_the_API_LISTING_task|'''API Listing''']] - Call list export<br/>
-[[Pcap_worksheet|'''PCAP Analysis''']] - Packet inspection
+[[Output_of_the_API_LISTING_task|'''API Listing''']]<br/><small>Call list export</small>
+[[Pcap_worksheet|'''PCAP Analysis''']]<br/><small>Packet inspection</small>
 |}
@@ Line 342: / Line 380: @@
 |-
 | style="vertical-align:top; padding:12px;" |
-[[VoIP_Impairments|'''VoIP Impairments''']] - Comprehensive quality analysis<br/>
+[[Comprehensive_Guide_to_VoIP_Voice_Quality|'''Voice Quality Guide''']]<br/><small>MOS, R-Factor, impairments explained</small>
-[[Comprehensive_Guide_to_VoIP_Voice_Quality|'''Voice Quality Guide''']] - MOS, R-Factor explained<br/>
-[[Jitter-bug|'''Jitter Analysis''']] - Network timing issues<br/>
+[[Jitter-bug|'''Jitter Analysis''']]<br/><small>Network timing issues</small>
-[[Silence_detection|'''Silence Detection''']] - Audio gap detection
+[[Silence_detection|'''Silence Detection''']]<br/><small>Audio gap detection</small>
 | style="vertical-align:top; padding:12px;" |
-[[Audio_Codecs_-_Comprehensive_Guide|'''Audio Codecs Guide''']] - G.711, G.729, Opus, etc.<br/>
+[[Audio_Codecs_-_Comprehensive_Guide|'''Audio Codecs Guide''']]<br/><small>G.711, G.729, Opus, etc.</small>
-[[Libspandsp|'''SpanDSP Library''']] - Fax/modem processing<br/>
-[[Sox|'''SoX Integration''']] - Audio conversion<br/>
+[[Libspandsp|'''SpanDSP Library''']]<br/><small>Fax/modem processing</small>
-[[Whisper|'''Whisper Integration''']] - Speech-to-text
+[[Sox|'''SoX Integration''']]<br/><small>Audio conversion</small>
+[[Whisper|'''Whisper Integration''']]<br/><small>Speech-to-text</small>
 |}