Documentation: Difference between revisions

From VoIPmonitor.org
(Major redesign: Installation by OS primary, modern card layout, removed PF_RING/Netmap)
Line 1: Line 1:
__NOTOC__
{{DISPLAYTITLE:VoIPmonitor Documentation}}


{| style="width:100%; border:none; background:linear-gradient(135deg, #1e3a5f 0%, #2d5a87 100%); border-radius:12px; margin-bottom:20px; padding:25px; color:white;"
|-
| style="font-size:28px; font-weight:bold;" | VoIPmonitor Documentation
|-
| style="font-size:16px; opacity:0.9; margin-top:10px;" | Complete guides for the open-source VoIP monitoring and troubleshooting solution
|-
| style="margin-top:20px;" |
[[#Installation_by_OS|<span style="background:#4CAF50; color:white; padding:10px 20px; border-radius:6px; text-decoration:none; font-weight:bold; margin-right:10px;">Installation Guide</span>]]
[[Architecture|<span style="background:#2196F3; color:white; padding:10px 20px; border-radius:6px; text-decoration:none; font-weight:bold; margin-right:10px;">Architecture</span>]]
[[FAQ|<span style="background:rgba(255,255,255,0.2); color:white; padding:10px 20px; border-radius:6px; text-decoration:none; font-weight:bold;">FAQ</span>]]
|}


[[Architecture]]
== Installation by OS ==


[[Glossary]]
Choose your operating system to get started with VoIPmonitor installation. Each guide covers both Sniffer and GUI setup.


[[Scaling]]
{| class="wikitable" style="width:100%; text-align:center;"
|-
! style="background:#e8f5e9; width:20%;" | Distribution
! style="background:#e8f5e9; width:20%;" | Version
! style="background:#e8f5e9; width:15%;" | Status
! style="background:#e8f5e9; width:45%;" | Notes
|-
| rowspan="4" style="background:#fff; font-weight:bold;" | Ubuntu
| [[Ubuntu_24.04_LTS|24.04 LTS]] || <span style="color:green;">'''Recommended'''</span> || Latest LTS, best performance
|-
| [[Ubuntu_22.04_LTS|22.04 LTS]] || <span style="color:green;">Supported</span> || Long-term support until 2027
|-
| [[Ubuntu_20.04_LTS|20.04 LTS]] || <span style="color:orange;">Maintenance</span> || Security updates until 2025
|-
| [[Ubuntu_18.04_LTS|18.04 LTS]] || <span style="color:red;">EOL</span> || Upgrade recommended
|-
| rowspan="4" style="background:#fff; font-weight:bold;" | Debian
| [[Debian_13|13 (Trixie)]] || <span style="color:blue;">Testing</span> || Next stable release
|-
| [[Debian_12|12 (Bookworm)]] || <span style="color:green;">'''Recommended'''</span> || Current stable
|-
| [[Debian_11|11 (Bullseye)]] || <span style="color:green;">Supported</span> || Previous stable, LTS until 2026
|-
| [[Debian_10|10 (Buster)]] || <span style="color:orange;">Maintenance</span> || ELTS until 2029
|-
| rowspan="2" style="background:#fff; font-weight:bold;" | Rocky Linux
| [[Rocky_10|Rocky 10]] || <span style="color:blue;">Preview</span> || Early support
|-
| [[Rocky_9|Rocky 9]] || <span style="color:green;">'''Recommended'''</span> || RHEL 9 compatible, support until 2032
|-
| rowspan="2" style="background:#fff; font-weight:bold;" | AlmaLinux
| [[Almalinux_10|AlmaLinux 10]] || <span style="color:blue;">Preview</span> || Early support
|-
| [[Almalinux_9.5|AlmaLinux 9]] || <span style="color:green;">'''Recommended'''</span> || RHEL 9 compatible
|-
| rowspan="2" style="background:#fff; font-weight:bold;" | CentOS
| [[Centos_8|CentOS 8 Stream]] || <span style="color:orange;">Maintenance</span> || Use Rocky/Alma for new installs
|-
| [[Centos_7|CentOS 7]] || <span style="color:red;">EOL</span> || Migrate to Rocky/Alma
|-
| style="background:#fff; font-weight:bold;" | FreeBSD
| [[FreeBSD_11|FreeBSD 11+]] || <span style="color:green;">Supported</span> || See also [[FreeBSD]], [[FreeBSD10]]
|}
 
<small>For legacy systems: [[Outdated_distributions_installation|Outdated Distributions Guide]] (CentOS 5/6, Debian 6-9, Ubuntu 12-16, Gentoo, ARM)</small>
 
=== Quick Start After OS Selection ===


[[Data Cleaning]]
{| class="wikitable" style="width:100%;"
|-
! style="background:#fff3e0; width:50%;" | Sniffer (Sensor) Installation
! style="background:#e3f2fd; width:50%;" | Web GUI Installation
|-
| style="vertical-align:top; padding:15px;" |
'''[[Sniffer_installation|Sniffer Installation Guide]]''' - Complete setup instructions


[[Cloud]]
After installation:
* [[Sniffer_configuration|Configure voipmonitor.conf]] - Database, interface settings
* [[Sniffing_modes|Choose Sniffing Mode]] - Mirror port, SPAN, ERSPAN
* [[Systemd_for_voipmonitor_service_management|Service Management]] - Start/stop/enable
| style="vertical-align:top; padding:15px;" |
'''[[GUI_Installation|GUI Installation Guide]]''' - Fresh install


[[FAQ]]
'''[[Re-install_the_GUI|Reinstall/Upgrade GUI]]''' - Update existing installation


After installation:
* [[User_Management|Create Users]] - Accounts and permissions
* [[Settings|Configure Settings]] - System options
* [[Https|Enable HTTPS]] - Secure access
|}


= Installation =
== Getting Started ==


{| class="wikitable"
{| class="wikitable" style="width:100%; border-collapse:separate; border-spacing:0;"
|-
! Distribution !! Supported Versions
|-
| '''Debian''' || [[Debian 13]] | [[Debian 12]] | [[Debian 11]] | [[Debian 10]]
|-
| '''Ubuntu LTS''' || [[Ubuntu 24.04 LTS]] | [[Ubuntu 22.04 LTS]] | [[Ubuntu 20.04 LTS]] | [[Ubuntu 18.04 LTS]]
|-
|-
| '''Rocky Linux''' || [[Rocky 10]] | [[Rocky 9]]
! style="width:50%; background:#e8f5e9; padding:15px;" | New to VoIPmonitor?
! style="width:50%; background:#e3f2fd; padding:15px;" | Already Installed?
|-
|-
| '''AlmaLinux''' || [[Almalinux 10]] | [[Almalinux 9.5]]
| style="padding:15px; vertical-align:top;" |
'''1.''' [[Architecture|Understand the Architecture]] - How components work together<br/>
'''2.''' Choose your OS above and follow the installation guide<br/>
'''3.''' [[Sniffer_configuration|Configure the Sniffer]] - Essential settings<br/>
'''4.''' [[WEB_GUI_Manual|Explore the GUI]] - Feature overview
| style="padding:15px; vertical-align:top;" |
'''Upgrade:''' [[Sniffer_upgrade|Sniffer]] &#124; [[Re-install_the_GUI|GUI]]<br/>
'''Troubleshoot:''' [[Sniffer_troubleshooting|Sniffer Issues]] &#124; [[GUI_troubleshooting|GUI Issues]]<br/>
'''Scale:''' [[Scaling|Performance Tuning]] &#124; [[High_availability_redundancy_failover|High Availability]]<br/>
'''API:''' [[WEB_API|REST API Reference]]
|}
|}


[[Outdated distributions installation]]
== Sniffer (Sensor) ==


= WEB GUI =
The C++ packet capture engine - monitors network traffic, decodes VoIP protocols, and stores call data.


[[WEB GUI Manual]]
{| class="wikitable" style="width:100%;"
|-
! style="background:#fff3e0; width:25%;" | Setup & Configuration
! style="background:#e8f5e9; width:25%;" | Capture Modes
! style="background:#e3f2fd; width:25%;" | Operations
! style="background:#fce4ec; width:25%;" | Troubleshooting
|-
| style="vertical-align:top; padding:12px;" |
[[Sniffer_installation|'''Installation Guide''']]<br/><small>Static binary setup for all Linux</small>


[http://www.voipmonitor.org/changelog-gui GUI changelog]
[[Sniffer_configuration|'''Configuration Reference''']]<br/><small>voipmonitor.conf parameters</small>


[[Database_structure|'''Database Schema''']]<br/><small>CDR table structure</small>


= Sniffer =
[[Systemd_for_voipmonitor_service_management|'''Systemd Service''']]<br/><small>Service management</small>
| style="vertical-align:top; padding:12px;" |
[[Sniffing_modes|'''Sniffing Modes''']]<br/><small>Mirror port, SPAN, ERSPAN</small>


[[Sniffer manual]]
[[Sniffer_distributed_architecture|'''Distributed Mode''']]<br/><small>Client/Server architecture</small>


[[Sniffing modes]]
[[SIPREC|'''SIPREC Recording''']]<br/><small>SBC-based call recording</small>


[[Sniffer distributed architecture]]
[[Capture_rules|'''Capture Rules''']]<br/><small>Filter what gets recorded</small>
| style="vertical-align:top; padding:12px;" |
[[Data_Cleaning|'''Data Retention''']]<br/><small>Cleanup and rotation policies</small>


[[Sniffer installation]]
[[Sniffer_upgrade|'''Upgrade Guide''']]<br/><small>Update to latest version</small>


[[Sniffer configuration]]
[[Scaling|'''Performance Tuning''']]<br/><small>High-traffic optimization</small>


[[Sniffer upgrade]]
[[Redundant_database|'''Database Redundancy''']]<br/><small>Replication setup</small>
| style="vertical-align:top; padding:12px;" |
[[Sniffer_troubleshooting|'''Troubleshooting Guide''']]<br/><small>Common issues & solutions</small>


[[Sniffer troubleshooting]]
[[Understanding_the_Sniffer's_Performance_Log|'''Performance Logs''']]<br/><small>Interpret t0CPU, SQLq, etc.</small>


[[High-Performance VoIPmonitor and MySQL Setup Manual]]
[[Memoryleak|'''Memory Issues''']]<br/><small>Debugging memory usage</small>


[[WebRTC]]
[[Capture_rules_troubleshooting|'''Capture Problems''']]<br/><small>Why calls not captured</small>
|}


[[Tls|TLS SSL decryption]]
=== Protocols & Advanced ===


[[ss7|SS7 / ISUP]]
{| class="wikitable" style="width:100%;"
|-
! style="background:#f3e5f5;" | VoIP Protocols
! style="background:#e0f7fa;" | Encryption & Security
! style="background:#fff8e1;" | Hardware & Performance
|-
| style="vertical-align:top; padding:12px;" |
[[Understanding_the_SIP_Protocol|'''SIP Protocol''']] - Session Initiation Protocol<br/>
[[Understanding_the_RTP_Protocol|'''RTP Protocol''']] - Real-time Transport<br/>
[[Understanding_the_WebRTC_Protocol|'''WebRTC''']] - Browser-based VoIP<br/>
[[Ss7|'''SS7 Signaling''']] - Legacy telephony<br/>
[[Audiocodes_tunneling|'''AudioCodes Tunneling''']] - Proprietary protocol
| style="vertical-align:top; padding:12px;" |
[[Tls|'''TLS/SRTP''']] - Encrypted SIP/RTP<br/>
[[DTLS|'''DTLS''']] - Datagram TLS for WebRTC<br/>
[[Encryption_in_manager_api|'''Manager API Encryption''']] - Secure API<br/>
[[Pubkey|'''SSH Public Key''']] - Remote access
| style="vertical-align:top; padding:12px;" |
[[Hardware|'''Hardware Requirements''']] - Sizing guide<br/>
[[DPDK|'''DPDK''']] - Data Plane Development Kit<br/>
[[Napatech|'''Napatech Cards''']] - Hardware acceleration<br/>
[[Voipmonitor_and_hugepages|'''Hugepages''']] - Memory optimization<br/>
[[Multiple_sniffer_instancies|'''Multiple Instances''']] - Multi-sensor
|}


[[DPDK]]
=== Performance & Memory ===


[[Whisper]]
{| class="wikitable" style="width:100%;"
|-
! style="background:#e8eaf6;" | Memory Management
! style="background:#e0f2f1;" | Monitoring & Logging
! style="background:#fce4ec;" | Utilities & Scripts
|-
| style="vertical-align:top; padding:12px;" |
[[Jemalloc|'''jemalloc''']] - Memory allocator<br/>
[[Tcmalloc|'''tcmalloc''']] - Google allocator<br/>
[[T2cpu|'''CPU Affinity''']] - Core pinning<br/>
[[IO_Measurement|'''I/O Monitoring''']] - Disk performance
| style="vertical-align:top; padding:12px;" |
[[Logging|'''Logging Configuration''']] - Log settings<br/>
[[Syslog|'''Syslog Integration''']] - Remote logging<br/>
[[Collectd_installation|'''Collectd''']] - System metrics<br/>
[[Gdb|'''GDB Debugging''']] - Core dump analysis
| style="vertical-align:top; padding:12px;" |
[[Manual_PCAP_Extraction_from_spooldir|'''PCAP Extraction''']] - Manual export<br/>
[[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/>
[[Emergency_procedures|'''Emergency Procedures''']] - Critical issues
|}


[[Understanding the Sniffer's Performance Log]]
== Web GUI ==


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


= Guides =
{| class="wikitable" style="width:100%;"
|-
! style="background:#e3f2fd; width:25%;" | Setup & Access
! style="background:#e8f5e9; width:25%;" | Call Analysis
! style="background:#fff3e0; width:25%;" | Monitoring & Alerts
! style="background:#f3e5f5; width:25%;" | Administration
|-
| style="vertical-align:top; padding:12px;" |
[[GUI_Installation|'''Installation Guide''']]<br/><small>Fresh install</small>


[[Comprehensive Guide to VoIP Voice Quality]]
[[Re-install_the_GUI|'''Reinstall/Upgrade''']]<br/><small>Update existing</small>


[[Understanding the SIP Protocol]]
[[Https|'''HTTPS Setup''']]<br/><small>SSL/TLS configuration</small>


[[Understanding the RTP Protocol]]
[[Nginx|'''Nginx Configuration''']]<br/><small>Reverse proxy setup</small>
| style="vertical-align:top; padding:12px;" |
[[Call_Detail_Record_-_CDR|'''CDR Browser''']]<br/><small>Search and filter calls</small>


[[Understanding the WebRTC Protocol]]
[[CDR_Summary|'''CDR Aggregation''']]<br/><small>Statistics and summaries</small>


[[Audio Codecs - Comprehensive Guide]]
[[Live_sniffer|'''Live Sniffer''']]<br/><small>Real-time packet capture</small>


[[Merging or correlating multiple call legs]]
[[Active_calls|'''Active Calls''']]<br/><small>Currently active sessions</small>
| style="vertical-align:top; padding:12px;" |
[[Dashboardv2|'''Dashboard''']]<br/><small>Overview and widgets</small>


[[Securing the VoIPmonitor Web GUI HTTPS and Basic Auth]]
[[Alerts|'''Alert System''']]<br/><small>Notifications and triggers</small>


[[Backing Up GUI Configuration]]
[[Charts|'''Charts & Graphs''']]<br/><small>Visual analytics</small>


[[How to enable milliseconds precision]]
[[Network_map|'''Network Map''']]<br/><small>Topology visualization</small>
| style="vertical-align:top; padding:12px;" |
[[User_Management|'''User Management''']]<br/><small>Accounts and permissions</small>


[[high availability mariadb galera cluster]]
[[Settings|'''GUI Settings''']]<br/><small>System configuration</small>


[[high availability redundancy failover]]
[[Backup|'''Backup & Restore''']]<br/><small>Configuration backup</small>


[[GUI automate login]]  
[[WEB_API|'''REST API''']]<br/><small>Programmatic access</small>
|}


[[Nginx]]
=== Features & Tools ===


[[php-fpm & apache]]
{| class="wikitable" style="width:100%;"
|-
! style="background:#e0f2f1;" | Security & Authentication
! style="background:#fce4ec;" | Reporting & Billing
! style="background:#e8eaf6;" | Advanced Features
|-
| style="vertical-align:top; padding:12px;" |
[[2FA|'''Two-Factor Auth''']] - TOTP authentication<br/>
[[Google_Sign_in_usage|'''Google Sign-In''']] - OAuth integration<br/>
[[Microsoft_Sign_in_usage|'''Microsoft Sign-In''']] - Azure AD<br/>
[[Shibboleth_and_other_auth_modules|'''Shibboleth/SAML''']] - Enterprise SSO<br/>
[[GUI_automate_login|'''Automated Login''']] - Scripted access
| style="vertical-align:top; padding:12px;" |
[[Reports|'''Report Builder''']] - Custom reports<br/>
[[Billing|'''Billing Module''']] - Cost analysis<br/>
[[Anti-fraud|'''Fraud Detection''']] - Anomaly alerts<br/>
[[NER_(Network_Effectiveness_Ratio)|'''NER Statistics''']] - Network effectiveness<br/>
[[CountryGrouping|'''Country Grouping''']] - Geographic analysis
| style="vertical-align:top; padding:12px;" |
[[Register|'''SIP Register''']] - Registration tracking<br/>
[[MESSAGES|'''SIP Messages''']] - IM/SMS analysis<br/>
[[Issue_tracker|'''Issue Tracker''']] - Problem management<br/>
[[Groups|'''Groups''']] - Call grouping<br/>
[[Tools|'''Tools''']] - Utility functions
|}


[[Collectd installation]]
=== Integrations ===


[[openvpn]]
{| class="wikitable" style="width:100%;"
|-
! style="background:#fff8e1;" | External Monitoring
! style="background:#e3f2fd;" | Web Server
! style="background:#e8f5e9;" | Data Export
|-
| style="vertical-align:top; padding:12px;" |
[[Nagios|'''Nagios''']] - Legacy monitoring<br/>
[[Nagios4|'''Nagios 4''']] - Updated integration<br/>
[[SIP_OPTIONS/SUBSCRIBE/NOTIFY|'''SIP OPTIONS Monitoring''']] - Availability checks
| style="vertical-align:top; padding:12px;" |
[[Php-fpm_&_apache|'''PHP-FPM & Apache''']] - Web server setup<br/>
[[Securing_the_VoIPmonitor_Web_GUI_HTTPS_and_Basic_Auth|'''Security Hardening''']] - HTTPS & auth<br/>
[[Sample_HAproxy_configuration|'''HAProxy''']] - Load balancing
| style="vertical-align:top; padding:12px;" |
[[Download_of_pcap_files_/_audio_files_using_GUI's_api|'''API Downloads''']] - PCAP/audio export<br/>
[[Output_of_the_API_LISTING_task|'''API Listing''']] - Call list export<br/>
[[Pcap_worksheet|'''PCAP Analysis''']] - Packet inspection
|}


[[upgrade to bigint]]
== Infrastructure & Scaling ==


[[systemd for voipmonitor service management]]
{| class="wikitable" style="width:100%;"
|-
! style="background:#e8f5e9; width:33%;" | High Availability
! style="background:#e3f2fd; width:33%;" | Database
! style="background:#fff3e0; width:34%;" | Performance
|-
| style="vertical-align:top; padding:12px;" |
[[High_availability_redundancy_failover|'''HA & Failover''']]<br/><small>Redundancy setup</small>


[[Manual PCAP Extraction from spooldir]]
[[High_availability_mariadb_galera_cluster|'''Galera Cluster''']]<br/><small>Multi-master MySQL</small>


[[download of pcap files / audio files using GUI's api]]
[[Cloud|'''Cloud Deployment''']]<br/><small>AWS, GCP, Azure</small>


[[check calls duration using sniffer's api]]
[[Openvpn|'''OpenVPN''']]<br/><small>Secure tunneling</small>
| style="vertical-align:top; padding:12px;" |
[[SSL/TLS_connection_to_the_Mysql/MariaDB|'''MySQL TLS''']]<br/><small>Encrypted connections</small>


[[Re-install the GUI]]
[[Mysql_master-slave_replication_hints|'''Master-Slave''']]<br/><small>Read replicas</small>


[[ChunkPlayer]]
[[Mysql_master-master_replication_hints|'''Master-Master''']]<br/><small>Active-active setup</small>


[[IO Measurement]]
[[ProxySQL|'''ProxySQL''']]<br/><small>Connection pooling</small>
| style="vertical-align:top; padding:12px;" |
[[Scaling|'''Performance Tuning''']]<br/><small>Optimization guide</small>


[[Google Sign in usage]]
[[High-Performance_VoIPmonitor_and_MySQL_Setup_Manual|'''High-Perf Setup''']]<br/><small>Enterprise config</small>


[[Microsoft Sign in usage]]
[[Swap|'''Swap Configuration''']]<br/><small>Memory management</small>


[[SSL/TLS connection to the Mysql/MariaDB]]
[[SQL_queue_is_growing_in_a_peaktime|'''SQL Queue Issues''']]<br/><small>Peak time handling</small>
|}


[[ProxySQL]]
== Voice Quality & Analysis ==


[[Mysql master-master replication hints]]
{| class="wikitable" style="width:100%;"
|-
! style="background:#f3e5f5; width:50%;" | Quality Metrics
! style="background:#e0f7fa; width:50%;" | Audio Processing
|-
| style="vertical-align:top; padding:12px;" |
[[VoIP_Impairments|'''VoIP Impairments''']] - Comprehensive quality analysis<br/>
[[Comprehensive_Guide_to_VoIP_Voice_Quality|'''Voice Quality Guide''']] - MOS, R-Factor explained<br/>
[[Jitter-bug|'''Jitter Analysis''']] - Network timing issues<br/>
[[Silence_detection|'''Silence Detection''']] - Audio gap detection
| style="vertical-align:top; padding:12px;" |
[[Audio_Codecs_-_Comprehensive_Guide|'''Audio Codecs Guide''']] - G.711, G.729, Opus, etc.<br/>
[[Libspandsp|'''SpanDSP Library''']] - Fax/modem processing<br/>
[[Sox|'''SoX Integration''']] - Audio conversion<br/>
[[Whisper|'''Whisper Integration''']] - Speech-to-text
|}


[[Mysql master-slave replication hints]]
== Quick Reference ==


[[Napatech]]
{| style="width:100%; border:1px solid #ddd; border-radius:8px; padding:15px; background:#fafafa;"
 
|-
= troubleshooting =
| style="vertical-align:top; width:33%;" |
 
'''Changelogs'''
[[Cannot download pcap/audio from spooldir when using chrome and nginx]]
* [http://www.voipmonitor.org/changelog-sniffer Sniffer Changelog]
 
* [http://www.voipmonitor.org/changelog-gui GUI Changelog]
= Resources =
* [[Sniffer_news|Sniffer News]]
* [[GUI_news|GUI News]]
| style="vertical-align:top; width:33%;" |
'''Reference'''
* [[Architecture|System Architecture]]
* [[Glossary|Glossary of Terms]]
* [[FAQ|Frequently Asked Questions]]
* [[WEB_GUI_Manual|Complete GUI Manual]]
| style="vertical-align:top; width:34%;" |
'''External Links'''
* [http://www.voipmonitor.org/download Download Center]
* [https://github.com/voipmonitor GitHub Repository]
* [https://www.voipmonitor.org/support Contact Support]
|}


[http://www.voipmonitor.org/download Download]
== 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?

Revision as of 23:25, 4 January 2026


VoIPmonitor Documentation
Complete guides for the open-source VoIP monitoring and troubleshooting solution

Installation Guide Architecture FAQ

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 Preview Early support
Rocky 9 Recommended RHEL 9 compatible, support until 2032
AlmaLinux AlmaLinux 10 Preview Early support
AlmaLinux 9 Recommended 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
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
SSH Public Key - Remote access

Hardware Requirements - Sizing guide
DPDK - Data Plane Development Kit
Napatech Cards - Hardware acceleration
Hugepages - Memory optimization
Multiple Instances - Multi-sensor

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

VoIP Impairments - Comprehensive quality analysis
Voice Quality Guide - MOS, R-Factor 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?
Retrieved from "https://www.voipmonitor.org/doc/index.php?title=Documentation&oldid=6670"