Documentation: Difference between revisions

From VoIPmonitor.org
(Add AI Support button to header and Quick Reference)
 
(5 intermediate revisions by 2 users not shown)
Line 9: Line 9:
|-
|-
| style="margin-top:20px;" |
| 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>]]
[[#Installation|<span style="background:#4CAF50; color:white; padding:10px 20px; border-radius:6px; text-decoration:none; font-weight:bold; margin-right:10px;">Installation</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>]]
[[#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>]]
[[#GUI_Features|<span style="background:#9C27B0; color:white; padding:10px 20px; border-radius:6px; text-decoration:none; font-weight:bold; margin-right:10px;">GUI Features</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; margin-right:10px;">FAQ</span>]]
[https://www.voipmonitor.org/vmchat-ui.php <span style="background:#FF9800; color:white; padding:10px 20px; border-radius:6px; text-decoration:none; font-weight:bold;">🤖 AI Support</span>]
|}
|}


== Installation by OS ==
== Getting Started ==
 
{| class="wikitable" style="width:100%;"
|-
! style="width:50%; background:#e8f5e9; padding:15px;" | New to VoIPmonitor?
! style="width:50%; background:#e3f2fd; padding:15px;" | Already Installed?
|-
| style="padding:15px; vertical-align:top;" |
'''Quick Start:'''
# [[Sniffer_installation|Install Sniffer]] - Download and configure
# [[GUI_installation|Install GUI]] - Web interface setup
# [[Sniffer_configuration|Configure voipmonitor.conf]]
# [[License|Activate License]]
 
'''Deployment Models:'''
* '''All-in-One:''' GUI + DB + Sensor on one server
* '''[[Sniffer_distributed_architecture|Distributed]]:''' Central GUI with remote sensors
* '''[[Cloud|Cloud]]:''' VoIPmonitor hosted service
| style="padding:15px; vertical-align:top;" |
'''Common Tasks:'''
* '''Upgrade:''' [[Sniffer_upgrade|Sniffer]] {{!}} [[Re-install_the_GUI|GUI]]
* '''Troubleshoot:''' [[Sniffer_troubleshooting|Sniffer]] {{!}} [[GUI_troubleshooting|GUI]] {{!}} [[Database_troubleshooting|Database]]
* '''Scale:''' [[Scaling|Performance]] {{!}} [[High_availability_redundancy_failover|HA]]


Choose your operating system to get started with VoIPmonitor installation. Each guide covers both Sniffer and GUI setup.
'''Quick Links:'''
* [[FAQ|FAQ]] {{!}} [[Glossary|Glossary]] {{!}} [[License|License]]
* [[Uninstall|Uninstall VoIPmonitor]]
|}
 
== Installation ==
 
=== OS Installation Guides ===


{| class="wikitable" style="width:100%; text-align:center;"
{| class="wikitable" style="width:100%; text-align:center;"
|-
|-
! style="background:#e8f5e9; width:20%;" | Distribution
! style="background:#e8f5e9; width:20%;" | Distribution
! style="background:#e8f5e9; width:20%;" | Version
! style="background:#e8f5e9; width:60%;" | Versions
! style="background:#e8f5e9; width:15%;" | Status
! style="background:#e8f5e9; width:20%;" | 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> || Extended maintenance
|-
| [[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:green;">'''Recommended'''</span> || Latest stable release
|-
| [[Debian_12|12 (Bookworm)]] || <span style="color:green;">Supported</span> || Previous stable
|-
|-
| [[Debian_11|11 (Bullseye)]] || <span style="color:green;">Supported</span> || Previous stable, LTS until 2026
| style="font-weight:bold;" | Ubuntu
| [[Ubuntu_24.04_LTS|24.04 LTS]] {{!}} [[Ubuntu_22.04_LTS|22.04 LTS]] {{!}} [[Ubuntu_20.04_LTS|20.04 LTS]] {{!}} [[Ubuntu_18.04_LTS|18.04]] {{!}} [[Ubuntu_16.04_LTS|16.04]] {{!}} [[Ubuntu_14.04_LTS|14.04]]
| <span style="color:green;">Supported</span>
|-
|-
| [[Debian_10|10 (Buster)]] || <span style="color:orange;">Maintenance</span> || ELTS until 2029
| style="font-weight:bold;" | Debian
| [[Debian_13|13]] {{!}} [[Debian_12|12]] {{!}} [[Debian_11|11]] {{!}} [[Debian_10|10]] {{!}} [[Debian_9|9]] {{!}} [[Debian_8|8]] {{!}} [[Debian_7|7]] {{!}} [[Debian_6|6]]
| <span style="color:green;">Supported</span>
|-
|-
| rowspan="2" style="background:#fff; font-weight:bold;" | Rocky Linux
| style="font-weight:bold;" | Rocky / Alma
| [[Rocky_10|Rocky 10]] || <span style="color:green;">'''Recommended'''</span> || Latest RHEL 10 compatible
| [[Rocky_10|Rocky 10]] {{!}} [[Rocky_9|Rocky 9]] {{!}} [[Almalinux_10|Alma 10]] {{!}} [[Almalinux_9.5|Alma 9]]
| <span style="color:green;">Supported</span>
|-
|-
| [[Rocky_9|Rocky 9]] || <span style="color:green;">Supported</span> || RHEL 9 compatible, support until 2032
| style="font-weight:bold;" | CentOS
| [[Centos_8|CentOS 8]] {{!}} [[Centos_7|CentOS 7]] {{!}} [[Centos_6.5|CentOS 6.5]]
| <span style="color:red;">EOL</span>
|-
|-
| rowspan="2" style="background:#fff; font-weight:bold;" | AlmaLinux
| style="font-weight:bold;" | FreeBSD
| [[Almalinux_10|AlmaLinux 10]] || <span style="color:green;">'''Recommended'''</span> || Latest RHEL 10 compatible
| [[FreeBSD_11|FreeBSD 11]] {{!}} [[FreeBSD10|FreeBSD 10]] {{!}} [[FreeBSD101|FreeBSD 10.1]]
|-
| <span style="color:green;">Supported</span>
| [[Almalinux_9.5|AlmaLinux 9]] || <span style="color:green;">Supported</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>
<small>Legacy: [[Outdated_distributions_installation|Outdated Distributions Guide]]</small>


=== Quick Start After OS Selection ===
=== Component Installation ===


{| class="wikitable" style="width:100%;"
{| class="wikitable" style="width:100%;"
|-
|-
! style="background:#fff3e0; width:50%;" | Sniffer (Sensor) Installation
! style="background:#fff3e0; width:50%;" | Sniffer (Sensor)
! style="background:#e3f2fd; width:50%;" | Web GUI Installation
! style="background:#e3f2fd; width:50%;" | Web GUI
|-
|-
| style="vertical-align:top; padding:15px;" |
| style="vertical-align:top; padding:12px;" |
'''[[Sniffer_installation|Sniffer Installation Guide]]''' - Complete setup instructions
* [[Sniffer_installation|'''Installation Guide''']] - Binary download and setup
 
* [[Sniffer_configuration|'''Configuration Reference''']] - voipmonitor.conf
After installation:
* [[Systemd_for_voipmonitor_service_management|'''Systemd Service''']] - Service management
* [[Sniffer_configuration|Configure voipmonitor.conf]] - Database, interface settings
* [[Sniffer_upgrade|'''Upgrade Guide''']] - Update to latest version
* [[Sniffing_modes|Choose Sniffing Mode]] - Mirror port, SPAN, ERSPAN
| style="vertical-align:top; padding:12px;" |
* [[Systemd_for_voipmonitor_service_management|Service Management]] - Start/stop/enable
* [[GUI_installation|'''Installation Guide''']] - PHP, database, IonCube
| style="vertical-align:top; padding:15px;" |
* [[Re-install_the_GUI|'''Reinstall/Upgrade''']] - Update existing
'''[[GUI_Installation|GUI Installation Guide]]''' - Fresh install
* [[License|'''License Activation''']] - Trial and commercial
 
* [[Uninstall|'''Uninstall''']] - Complete removal
'''[[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
|}
|}


== Getting Started ==
== Architecture & Deployment ==


{| class="wikitable" style="width:100%; border-collapse:separate; border-spacing:0;"
{| class="wikitable" style="width:100%;"
|-
|-
! style="width:50%; background:#e8f5e9; padding:15px;" | New to VoIPmonitor?
! style="background:#e3f2fd; width:33%;" | System Design
! style="width:50%; background:#e3f2fd; padding:15px;" | Already Installed?
! style="background:#e8f5e9; width:33%;" | Deployment Modes
! style="background:#fff3e0; width:34%;" | Multi-Sensor
|-
|-
| style="padding:15px; vertical-align:top;" |
| style="vertical-align:top; padding:12px;" |
'''1.''' [[Architecture|Understand the Architecture]] - How components work together<br/>
* [[Architecture|'''Architecture Overview''']] - Components and data flow
'''2.''' Choose your OS above and follow the installation guide<br/>
* [[Sniffer_detailed_architecture|'''Sniffer Internals''']] - Deep dive
'''3.''' [[Sniffer_configuration|Configure the Sniffer]] - Essential settings<br/>
* [[Database_structure|'''Database Schema''']] - CDR tables
'''4.''' [[WEB_GUI_Manual|Explore the GUI]] - Feature overview
| style="vertical-align:top; padding:12px;" |
| style="padding:15px; vertical-align:top;" |
* [[Sniffing_modes|'''Sniffing Modes''']] - SPAN, TAP, tunnels
'''Upgrade:''' [[Sniffer_upgrade|Sniffer]] &#124; [[Re-install_the_GUI|GUI]]<br/>
* [[Sniffer_distributed_architecture|'''Distributed Architecture''']] - Client/server
'''Troubleshoot:''' [[Sniffer_troubleshooting|Sniffer Issues]] &#124; [[GUI_troubleshooting|GUI Issues]]<br/>
* [[Cloud|'''Cloud Deployment''']] - Hosted service
'''Scale:''' [[Scaling|Performance Tuning]] &#124; [[High_availability_redundancy_failover|High Availability]]<br/>
| style="vertical-align:top; padding:12px;" |
'''API:''' [[WEB_API|REST API Reference]]
* [[Multiple_sniffer_instancies|'''Multiple Instances''']] - Multi-sensor setup
* [[Promiscuous|'''Promiscuous Mode''']] - Interface config
|}
|}


== Sniffer (Sensor) ==
== Configuration ==
 
The C++ packet capture engine - monitors network traffic, decodes VoIP protocols, and stores call data.


{| class="wikitable" style="width:100%;"
{| class="wikitable" style="width:100%;"
|-
|-
! style="background:#fff3e0; width:25%;" | Setup & Configuration
! style="background:#fff3e0; width:50%;" | Sniffer Configuration
! style="background:#e8f5e9; width:25%;" | Capture Modes
! style="background:#e3f2fd; width:50%;" | GUI Configuration
! style="background:#e3f2fd; width:25%;" | Operations
! style="background:#fce4ec; width:25%;" | Troubleshooting
|-
|-
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[Sniffer_installation|'''Installation Guide''']]<br/><small>Static binary setup for all Linux</small>
* [[Sniffer_configuration|'''voipmonitor.conf Reference''']] - All parameters
 
* [[Capture_rules|'''Capture Rules''']] - Filter SIP/RTP by IP, port, patterns
[[Sniffer_configuration|'''Configuration Reference''']]<br/><small>voipmonitor.conf parameters</small>
* [[How_to_enable_ipv6_processing|'''IPv6 Processing''']] - Enable IPv6 support
 
* [[How_to_enable_milliseconds_precision|'''Milliseconds Precision''']] - High-precision timing
[[Database_structure|'''Database Schema''']]<br/><small>CDR table structure</small>
 
[[Systemd_for_voipmonitor_service_management|'''Systemd Service''']]<br/><small>Service management</small>
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[Sniffing_modes|'''Sniffing Modes''']]<br/><small>Mirror port, SPAN, ERSPAN</small>
* [[GUI_Configuration_PHP|'''configuration.php''']] - PHP settings
* [[Settings|'''GUI Settings''']] - System options
* [[Promiscuous|'''Network Interface''']] - Promiscuous mode
|}


[[Sniffer_distributed_architecture|'''Distributed Mode''']]<br/><small>Client/Server architecture</small>
=== Protocol-Specific Configuration ===


[[SIPREC|'''SIPREC Recording''']]<br/><small>SBC-based call recording</small>
{| class="wikitable" style="width:100%;"
 
|-
[[Capture_rules|'''Capture Rules''']]<br/><small>Filter what gets recorded</small>
! style="background:#f3e5f5;" | Protocol
| style="vertical-align:top; padding:12px;" |
! style="background:#f3e5f5;" | Description
[[Data_Cleaning|'''Data Retention''']]<br/><small>Cleanup and rotation policies</small>
|-
 
| [[SIPREC|'''SIPREC''']] || SIPREC recording integration (Orecx, Orascom)
[[Sniffer_upgrade|'''Upgrade Guide''']]<br/><small>Update to latest version</small>
|-
 
| [[WebRTC|'''WebRTC''']] || WebRTC call monitoring setup
[[Scaling|'''Performance Tuning''']]<br/><small>High-traffic optimization</small>
|-
 
| [[Audiocodes_tunneling|'''AudioCodes Tunneling''']] || SBC packet forwarding
[[Redundant_database|'''Database Redundancy''']]<br/><small>Replication setup</small>
|-
| style="vertical-align:top; padding:12px;" |
| [[Ribbon7k_monitoring_profiles|'''Ribbon Profiles''']] || Ribbon/Sonus monitoring
[[Sniffer_troubleshooting|'''Troubleshooting Guide''']]<br/><small>Common issues & solutions</small>
|-
 
| [[DTLS|'''DTLS''']] || DTLS/SRTP handling
[[Understanding_the_Sniffer's_Performance_Log|'''Performance Logs''']]<br/><small>Interpret t0CPU, SQLq, etc.</small>
 
[[Memoryleak|'''Memory Issues''']]<br/><small>Debugging memory usage</small>
 
[[Capture_rules_troubleshooting|'''Capture Problems''']]<br/><small>Why calls not captured</small>
|}
|}


=== Protocols & Advanced ===
== Protocols & Standards ==


{| class="wikitable" style="width:100%;"
{| class="wikitable" style="width:100%;"
|-
|-
! style="background:#f3e5f5; width:33%;" | VoIP Protocols
! style="background:#e0f7fa; width:50%;" | Protocol Guides
! style="background:#e0f7fa; width:33%;" | Encryption & Security
! style="background:#f3e5f5; width:50%;" | Encryption & Security
! style="background:#fff8e1; width:34%;" | Hardware & Performance
|-
|-
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[Understanding_the_SIP_Protocol|'''SIP Protocol''']]<br/><small>Session Initiation Protocol</small>
* [[Understanding_the_SIP_Protocol|'''SIP Protocol''']] - Session Initiation Protocol deep dive
* [[Understanding_the_RTP_Protocol|'''RTP Protocol''']] - Real-time Transport and quality metrics
* [[Understanding_the_WebRTC_Protocol|'''WebRTC Protocol''']] - Browser-based VoIP
* [[Comprehensive_Guide_to_VoIP_Voice_Quality|'''Voice Quality Guide''']] - MOS, jitter, packet loss
* [[Ss7|'''SS7 Signaling''']] - Legacy telephony
| style="vertical-align:top; padding:12px;" |
* [[Tls|'''TLS/SRTP''']] - Encrypted SIP/RTP decryption
* [[DTLS|'''DTLS''']] - Datagram TLS for WebRTC
* [[SSL/TLS_connection_to_the_Mysql/MariaDB|'''MySQL TLS''']] - Encrypted database connections
|}


[[Understanding_the_RTP_Protocol|'''RTP Protocol''']]<br/><small>Real-time Transport</small>
== GUI Features ==


[[Understanding_the_WebRTC_Protocol|'''WebRTC''']]<br/><small>Browser-based VoIP</small>
=== Call Analysis ===


[[Ss7|'''SS7 Signaling''']]<br/><small>Legacy telephony</small>
{| class="wikitable" style="width:100%;"
|-
| style="width:25%; vertical-align:top; padding:12px;" |
'''CDR & Calls'''
* [[Call_Detail_Record_-_CDR|'''CDR Browser''']] - Main call interface
* [[Active_calls|'''Active Calls''']] - Real-time monitoring
* [[Live_sniffer|'''Live Sniffer''']] - Packet capture
| style="width:25%; vertical-align:top; padding:12px;" |
'''Correlation'''
* [[Merging_or_correlating_multiple_call_legs|'''Call Correlation''']] - Link call legs
* [[CDR_Summary|'''CDR Summary''']] - Aggregated stats
| style="width:25%; vertical-align:top; padding:12px;" |
'''Visualization'''
* [[Charts|'''Charts''']] - Time-series graphs
* [[Dashboardv2|'''Dashboard''']] - Customizable panels
* [[Reports|'''Reports''']] - Scheduled exports
| style="width:25%; vertical-align:top; padding:12px;" |
'''Quality'''
* [[NER_(Network_Effectiveness_Ratio)|'''NER''']] - Network Effectiveness Ratio
* [[Silence_detection|'''Silence Detection''']] - Audio analysis
|}


[[Audiocodes_tunneling|'''AudioCodes Tunneling''']]<br/><small>Proprietary protocol</small>
=== Monitoring & Alerts ===
| style="vertical-align:top; padding:12px;" |
[[Tls|'''TLS/SRTP''']]<br/><small>Encrypted SIP/RTP</small>


[[DTLS|'''DTLS''']]<br/><small>Datagram TLS for WebRTC</small>
{| class="wikitable" style="width:100%;"
|-
| style="width:33%; vertical-align:top; padding:12px;" |
'''Alerts'''
* [[Alerts|'''Alert System''']] - Email notifications
* [[Anti-fraud|'''Fraud Detection''']] - GeoIP alerts
| style="width:33%; vertical-align:top; padding:12px;" |
'''SIP Monitoring'''
* [[Register|'''SIP Register''']] - Registration tracking
* [[Register_active|'''Active Registrations''']] - Current state
* [[SIP_OPTIONS/SUBSCRIBE/NOTIFY|'''OPTIONS/SUBSCRIBE''']] - Availability
| style="width:34%; vertical-align:top; padding:12px;" |
'''Other'''
* [[MESSAGES|'''SIP Messages''']] - Instant messaging
* [[Issue_tracker|'''Issue Tracker''']] - Ticketing system
|}


[[Encryption_in_manager_api|'''Manager API Encryption''']]<br/><small>Secure API access</small>
=== User & Access Management ===


[[Pubkey|'''SSH Public Key''']]<br/><small>Remote access setup</small>
{| class="wikitable" style="width:100%;"
|-
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[Hardware|'''Hardware Requirements''']]<br/><small>Sizing guide</small>
* [[User_Management|'''User Management''']] - Accounts and permissions
 
* [[Groups|'''Groups''']] - IP/number grouping
[[DPDK|'''DPDK''']]<br/><small>Data Plane Development Kit</small>
* [[CountryGrouping|'''Country Grouping''']] - GeoIP grouping
 
* [[Billing|'''Billing''']] - Rate calculations
[[Napatech|'''Napatech Cards''']]<br/><small>Hardware acceleration</small>
* [[Glossary|'''Glossary''']] - Terminology
 
[[Voipmonitor_and_hugepages|'''Hugepages''']]<br/><small>Memory optimization</small>
 
[[Multiple_sniffer_instancies|'''Multiple Instances''']]<br/><small>Multi-sensor setup</small>
|}
|}


=== Performance & Memory ===
== Security & Authentication ==


{| class="wikitable" style="width:100%;"
{| class="wikitable" style="width:100%;"
|-
|-
! style="background:#e8eaf6; width:33%;" | Memory Management
! style="background:#fce4ec; width:50%;" | Authentication Methods
! style="background:#e0f2f1; width:33%;" | Monitoring & Logging
! style="background:#e8eaf6; width:50%;" | Security & Privacy
! style="background:#fce4ec; width:34%;" | Utilities & Scripts
|-
|-
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[Jemalloc|'''jemalloc''']]<br/><small>Memory allocator</small>
* [[2FA|'''Two-Factor Auth''']] - TOTP setup
 
* [[Authentication|'''Authentication Overview''']] - All methods
[[Tcmalloc|'''tcmalloc''']]<br/><small>Google allocator</small>
* [[Google_Sign_in_usage|'''Google Sign-In''']] - OAuth
 
* [[Microsoft_Sign_in_usage|'''Microsoft Sign-In''']] - Azure AD
[[T2cpu|'''CPU Affinity''']]<br/><small>Core pinning</small>
* [[REMOTE_USER_Authentication|'''REMOTE_USER''']] - Shibboleth, SAML
 
[[IO_Measurement|'''I/O Monitoring''']]<br/><small>Disk performance</small>
| style="vertical-align:top; padding:12px;" |
[[Logging|'''Logging Configuration''']]<br/><small>Log settings</small>
 
[[Syslog|'''Syslog Integration''']]<br/><small>Remote logging</small>
 
[[Collectd_installation|'''Collectd''']]<br/><small>System metrics</small>
 
[[Gdb|'''GDB Debugging''']]<br/><small>Core dump analysis</small>
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[Manual_PCAP_Extraction_from_spooldir|'''PCAP Extraction''']]<br/><small>Manual export</small>
* [[Security_Policy_and_Posture|'''Security Best Practices''']]
 
* [[Securing_the_VoIPmonitor_Web_GUI_HTTPS_and_Basic_Auth|'''HTTPS & Basic Auth''']]
[[Create_audio_from_packet_dumps_located_in_a_spooldir|'''Audio Creation''']]<br/><small>From packet dumps</small>
* [[Data_Privacy_and_Data_Masking|'''Data Privacy & Masking''']] - IP anonymization
 
* [[CALEA_compliance|'''CALEA Compliance''']] - Lawful intercept
[[Check_calls_duration_using_sniffer's_api|'''API Duration Check''']]<br/><small>Call stats</small>
 
[[Emergency_procedures|'''Emergency Procedures''']]<br/><small>Critical issues</small>
|}
|}


== Web GUI ==
== Database ==
 
Browser-based interface for call analysis, reporting, alerts, and system management.


{| class="wikitable" style="width:100%;"
{| class="wikitable" style="width:100%;"
|-
|-
! style="background:#e3f2fd; width:25%;" | Setup & Access
! style="background:#fff3e0; width:50%;" | Setup & Structure
! style="background:#e8f5e9; width:25%;" | Call Analysis
! style="background:#fce4ec; width:50%;" | Troubleshooting & Maintenance
! style="background:#fff3e0; width:25%;" | Monitoring & Alerts
! style="background:#f3e5f5; width:25%;" | Administration
|-
|-
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[GUI_Installation|'''Installation Guide''']]<br/><small>Fresh install</small>
* [[Database_structure|'''Database Schema''']] - Table reference
 
* [[Mysql_5.7|'''MySQL 5.7''']] - Version specifics
[[Re-install_the_GUI|'''Reinstall/Upgrade''']]<br/><small>Update existing</small>
* [[MySQL_8_upgrade_stored_routine_fix|'''MySQL 8 Upgrade''']] - Compatibility fixes
 
* [[Upgrade_to_bigint|'''Upgrade to BigInt''']] - Large deployments
[[Https|'''HTTPS Setup''']]<br/><small>SSL/TLS configuration</small>
 
[[Nginx|'''Nginx Configuration''']]<br/><small>Reverse proxy setup</small>
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[Call_Detail_Record_-_CDR|'''CDR Browser''']]<br/><small>Search and filter calls</small>
* [[Database_troubleshooting|'''Database Troubleshooting''']] - Common issues
* [[Recovering_corrupted_database_tables|'''Table Recovery''']] - Repair procedures
* [[SQL_queue_is_growing_in_a_peaktime|'''SQL Queue Issues''']] - Peak time handling
* [[Sample_HAproxy_configuration|'''HAProxy/ProxySQL''']] - Load balancing
|}


[[CDR_Summary|'''CDR Aggregation''']]<br/><small>Statistics and summaries</small>
== High Availability & Replication ==


[[Live_sniffer|'''Live Sniffer''']]<br/><small>Real-time packet capture</small>
{| class="wikitable" style="width:100%;"
 
|-
[[Active_calls|'''Active Calls''']]<br/><small>Currently active sessions</small>
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[Dashboardv2|'''Dashboard''']]<br/><small>Overview and widgets</small>
* [[High_availability_redundancy_failover|'''HA & Failover Overview''']] - Strategies
 
* [[High_availability_mariadb_galera_cluster|'''Galera Cluster''']] - Multi-master setup
[[Alerts|'''Alert System''']]<br/><small>Notifications and triggers</small>
* [[Redundant_database|'''Database Redundancy''']] - Options
 
[[Charts|'''Charts & Graphs''']]<br/><small>Visual analytics</small>
 
[[Network_map|'''Network Map''']]<br/><small>Topology visualization</small>
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[User_Management|'''User Management''']]<br/><small>Accounts and permissions</small>
* [[Mysql_master-slave_replication_hints|'''Master-Slave Replication''']]
 
* [[Mysql_master-master_replication_hints|'''Master-Master Replication''']]
[[Settings|'''GUI Settings''']]<br/><small>System configuration</small>
 
[[Backup|'''Backup & Restore''']]<br/><small>Configuration backup</small>
 
[[WEB_API|'''REST API''']]<br/><small>Programmatic access</small>
|}
|}


=== Features & Tools ===
== Performance & Scaling ==


{| class="wikitable" style="width:100%;"
{| class="wikitable" style="width:100%;"
|-
|-
! style="background:#e0f2f1; width:33%;" | Security & Authentication
! style="background:#e8f5e9; width:33%;" | Optimization
! style="background:#fce4ec; width:33%;" | Reporting & Billing
! style="background:#e3f2fd; width:33%;" | Hardware Acceleration
! style="background:#e8eaf6; width:34%;" | Advanced Features
! style="background:#fff3e0; width:34%;" | System Tuning
|-
|-
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[2FA|'''Two-Factor Auth''']]<br/><small>TOTP authentication</small>
* [[Scaling|'''Scaling Guide''']] - Large deployments
 
* [[High-Performance_VoIPmonitor_and_MySQL_Setup_Manual|'''High-Performance Setup''']]
[[Google_Sign_in_usage|'''Google Sign-In''']]<br/><small>OAuth integration</small>
* [[Sniffer_performance|'''Performance Tuning''']]
 
* [[Understanding_the_Sniffer's_Performance_Log|'''Performance Logs''']]
[[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;" |
| style="vertical-align:top; padding:12px;" |
[[Reports|'''Report Builder''']]<br/><small>Custom reports</small>
* [[DPDK|'''DPDK''']] - 6+ Gbit/s capture
 
* [[Napatech|'''Napatech Cards''']] - SmartNIC
[[Billing|'''Billing Module''']]<br/><small>Cost analysis</small>
* [[Hardware|'''Hardware Requirements''']]
 
[[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;" |
| style="vertical-align:top; padding:12px;" |
[[Register|'''SIP Register''']]<br/><small>Registration tracking</small>
* [[Diagnosing_Database_Bottlenecks_Using_Sensor_RRD_Charts|'''DB Bottlenecks''']]
* [[Swap|'''Swap Configuration''']]
* [[Voipmonitor_and_hugepages|'''Hugepages''']]
* [[Jemalloc|'''Jemalloc''']] - Memory allocator
|}


[[MESSAGES|'''SIP Messages''']]<br/><small>IM/SMS analysis</small>
== Troubleshooting ==


[[Issue_tracker|'''Issue Tracker''']]<br/><small>Problem management</small>
{| class="wikitable" style="width:100%;"
 
|-
[[Groups|'''Groups''']]<br/><small>Call grouping</small>
| style="width:25%; vertical-align:top; padding:12px;" |
 
'''General'''
[[Tools|'''Tools''']]<br/><small>Utility functions</small>
* [[FAQ|'''FAQ''']]
* [[Emergency_procedures|'''Emergency Procedures''']]
| style="width:25%; vertical-align:top; padding:12px;" |
'''Sniffer'''
* [[Sniffer_troubleshooting|'''Sniffer Issues''']]
* [[IO_Measurement|'''I/O Measurement''']]
| style="width:25%; vertical-align:top; padding:12px;" |
'''GUI'''
* [[GUI_troubleshooting|'''GUI Issues''']]
| style="width:25%; vertical-align:top; padding:12px;" |
'''Database'''
* [[Database_troubleshooting|'''Database Issues''']]
* [[Recovering_corrupted_database_tables|'''Table Recovery''']]
|}
|}


=== Integrations ===
== API & Integration ==


{| class="wikitable" style="width:100%;"
{| class="wikitable" style="width:100%;"
|-
|-
! style="background:#fff8e1; width:33%;" | External Monitoring
! style="background:#e3f2fd; width:50%;" | APIs
! style="background:#e3f2fd; width:33%;" | Web Server
! style="background:#e8f5e9; width:50%;" | Integrations
! style="background:#e8f5e9; width:34%;" | Data Export
|-
|-
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[Nagios|'''Nagios''']]<br/><small>Legacy monitoring</small>
* [[WEB_API|'''REST API''']] - HTTP API reference
 
* [[Manager_API|'''Manager API''']] - TCP port 5029
[[Nagios4|'''Nagios 4''']]<br/><small>Updated integration</small>
* [[Download_of_pcap_files_/_audio_files_using_GUI's_api|'''PCAP/Audio Download''']] - File API
 
* [[ChunkPlayer|'''ChunkPlayer''']] - Live audio streaming
[[SIP_OPTIONS/SUBSCRIBE/NOTIFY|'''SIP OPTIONS Monitoring''']]<br/><small>Availability checks</small>
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[Php-fpm_&_apache|'''PHP-FPM & Apache''']]<br/><small>Web server setup</small>
* [[EasyCallerID|'''EasyCallerID''']] - CallerID lookup
* [[Collectd_installation|'''Collectd''']] - System monitoring
* [[Nagios|'''Nagios''']] - Nagios integration
* [[Nginx|'''Nginx''']] - Reverse proxy
|}


[[Securing_the_VoIPmonitor_Web_GUI_HTTPS_and_Basic_Auth|'''Security Hardening''']]<br/><small>HTTPS & auth</small>
== Maintenance & Backup ==


[[Sample_HAproxy_configuration|'''HAProxy''']]<br/><small>Load balancing</small>
{| class="wikitable" style="width:100%;"
| style="vertical-align:top; padding:12px;" |
|-
[[Download_of_pcap_files_/_audio_files_using_GUI's_api|'''API Downloads''']]<br/><small>PCAP/audio export</small>
| style="width:33%; vertical-align:top; padding:12px;" |
 
'''Upgrade'''
[[Output_of_the_API_LISTING_task|'''API Listing''']]<br/><small>Call list export</small>
* [[Sniffer_upgrade|'''Sniffer Upgrade''']]
 
* [[Re-install_the_GUI|'''GUI Reinstall''']]
[[Pcap_worksheet|'''PCAP Analysis''']]<br/><small>Packet inspection</small>
| style="width:33%; vertical-align:top; padding:12px;" |
'''Backup'''
* [[Backing_Up_GUI_Configuration|'''GUI Backup''']]
* [[Backup_and_restore_GUI_tables|'''Table Backup''']]
* [[Disaster_Recovery|'''Disaster Recovery''']]
| style="width:34%; vertical-align:top; padding:12px;" |
'''Maintenance'''
* [[Data_Cleaning|'''Data Cleaning''']] - Cleanspool
* [[Reprocess_Historical_Calls|'''Reprocess Calls''']]
* [[VPS_Host_Maintenance_Shutdown|'''Safe Shutdown''']]
|}
|}


== Infrastructure & Scaling ==
== Advanced Features ==


{| class="wikitable" style="width:100%;"
{| 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;" |
| style="vertical-align:top; padding:12px;" |
[[High_availability_redundancy_failover|'''HA & Failover''']]<br/><small>Redundancy setup</small>
* [[Whisper|'''Whisper''']] - Speech-to-text transcription
 
* [[Silence_detection|'''Silence Detection''']] - Audio analysis
[[High_availability_mariadb_galera_cluster|'''Galera Cluster''']]<br/><small>Multi-master MySQL</small>
* [[Audio_Codecs_-_Comprehensive_Guide|'''Audio Codecs Guide''']]
 
* [[Manual_PCAP_Extraction_from_spooldir|'''Manual PCAP Extraction''']]
[[Cloud|'''Cloud Deployment''']]<br/><small>AWS, GCP, Azure</small>
 
[[Openvpn|'''OpenVPN''']]<br/><small>Secure tunneling</small>
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[SSL/TLS_connection_to_the_Mysql/MariaDB|'''MySQL TLS''']]<br/><small>Encrypted connections</small>
* [[Minimizing_Delay_Between_Call_End_and_CDR_Database_Storage|'''CDR Delay Optimization''']]
 
* [[Ipaccount|'''IP Accounting''']]
[[Mysql_master-slave_replication_hints|'''Master-Slave''']]<br/><small>Read replicas</small>
 
[[Mysql_master-master_replication_hints|'''Master-Master''']]<br/><small>Active-active setup</small>
 
[[ProxySQL|'''ProxySQL''']]<br/><small>Connection pooling</small>
| style="vertical-align:top; padding:12px;" |
[[Scaling|'''Performance Tuning''']]<br/><small>Optimization guide</small>
 
[[High-Performance_VoIPmonitor_and_MySQL_Setup_Manual|'''High-Perf Setup''']]<br/><small>Enterprise config</small>
 
[[Swap|'''Swap Configuration''']]<br/><small>Memory management</small>
 
[[SQL_queue_is_growing_in_a_peaktime|'''SQL Queue Issues''']]<br/><small>Peak time handling</small>
|}
|}


== Voice Quality & Analysis ==
== Tools & Utilities ==


{| class="wikitable" style="width:100%;"
{| 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;" |
| style="vertical-align:top; padding:12px;" |
[[Comprehensive_Guide_to_VoIP_Voice_Quality|'''Voice Quality Guide''']]<br/><small>MOS, R-Factor, impairments explained</small>
* [[Tools|'''Built-in Tools''']] - Overview
 
* [[Git|'''Git''']] - Repository access
[[Jitter-bug|'''Jitter Analysis''']]<br/><small>Network timing issues</small>
* [[Sox|'''SoX''']] - Audio processing
 
* [[Tshark|'''Tshark''']] - Wireshark CLI
[[Silence_detection|'''Silence Detection''']]<br/><small>Audio gap detection</small>
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[Audio_Codecs_-_Comprehensive_Guide|'''Audio Codecs Guide''']]<br/><small>G.711, G.729, Opus, etc.</small>
* [[Script-for-big-batchdownloads|'''Batch Download Script''']]
 
* [[Script-for-probes-backup|'''Probe Backup Script''']]
[[Libspandsp|'''SpanDSP Library''']]<br/><small>Fax/modem processing</small>
 
[[Sox|'''SoX Integration''']]<br/><small>Audio conversion</small>
 
[[Whisper|'''Whisper Integration''']]<br/><small>Speech-to-text</small>
|}
|}


Line 401: Line 400:
| style="vertical-align:top; width:33%;" |
| style="vertical-align:top; width:33%;" |
'''Changelogs'''
'''Changelogs'''
* [http://www.voipmonitor.org/changelog-sniffer Sniffer Changelog]
* [https://www.voipmonitor.org/changelog-sniffer Sniffer Changelog]
* [http://www.voipmonitor.org/changelog-gui GUI Changelog]
* [https://www.voipmonitor.org/changelog-gui GUI Changelog]
* [[Sniffer_news|Sniffer News]]
* [[GUI_news|GUI News]]
| style="vertical-align:top; width:33%;" |
| style="vertical-align:top; width:33%;" |
'''Reference'''
'''Downloads'''
* [[Architecture|System Architecture]]
* [https://www.voipmonitor.org/download Download Center]
* [[Glossary|Glossary of Terms]]
* [https://github.com/voipmonitor GitHub Repository]
* [[FAQ|Frequently Asked Questions]]
* [[WEB_GUI_Manual|Complete GUI Manual]]
| style="vertical-align:top; width:34%;" |
| style="vertical-align:top; width:34%;" |
'''External Links'''
'''Support'''
* [http://www.voipmonitor.org/download Download Center]
* [https://www.voipmonitor.org/vmchat-ui.php '''🤖 AI Support''']
* [https://github.com/voipmonitor GitHub Repository]
* [https://www.voipmonitor.org/support Contact Support]
* [https://www.voipmonitor.org/support Contact Support]
* [[FAQ|FAQ]]
|}
|}


== AI Summary for RAG ==
== AI Summary for RAG ==


'''Summary:''' Main documentation hub for VoIPmonitor - the open-source VoIP monitoring and troubleshooting solution. This page provides a comprehensive index to all documentation including: OS-specific installation guides (Ubuntu, Debian, Rocky Linux, AlmaLinux, CentOS, FreeBSD), sniffer (sensor) configuration and troubleshooting, web GUI setup and features, distributed architecture, encryption/TLS support, performance tuning and scaling, high availability with Galera cluster, voice quality analysis (MOS, jitter, packet loss), and REST API reference. The documentation covers both basic setup for new users and advanced topics like DPDK acceleration, Napatech hardware, and enterprise SSO integration.
'''Summary:''' Main documentation portal for VoIPmonitor - open-source VoIP monitoring and troubleshooting. Index provides links to: OS-specific installation (Ubuntu 24.04/22.04/20.04, Debian 13/12/11, Rocky/Alma 10/9, FreeBSD), sniffer configuration and troubleshooting, distributed architecture (client/server mode), web GUI setup, TLS/SRTP decryption, performance tuning, database management, voice quality analysis. Getting started: (1) Register at voipmonitor.org, (2) Get 30-day trial license, (3) Choose deployment (All-in-One, Distributed, or Direct on PBX/SBC), (4) Follow OS guide. Free Google Meet installation assistance available.


'''Keywords:''' documentation, main page, getting started, installation, gui, sniffer, sensor, overview, ubuntu, debian, centos, rocky, almalinux, freebsd, voipmonitor, voip monitoring, sip, rtp, cdr, call detail record, packet capture, voice quality, mos, troubleshooting, configuration, api, scaling, high availability, galera, distributed architecture
'''Keywords:''' documentation, index, portal, installation, ubuntu, debian, rocky linux, almalinux, freebsd, sniffer, sensor, gui, getting started, 30-day trial, distributed architecture, all-in-one, pbx, sbc, troubleshooting, configuration, api, scaling, voice quality, mos


'''Key Questions:'''
'''Key Questions:'''
* Where do I start with VoIPmonitor?
* Where do I start with VoIPmonitor?
* How do I get a 30-day free trial license?
* Which Linux distribution should I use for VoIPmonitor?
* How do I install VoIPmonitor on Ubuntu/Debian/Rocky Linux?
* How do I install VoIPmonitor on Ubuntu/Debian/Rocky Linux?
* What documentation is available for VoIPmonitor?
* What are the deployment options (All-in-One vs Distributed)?
* Which Linux distribution should I use for VoIPmonitor?
* Can I install VoIPmonitor directly on my PBX/SBC?
* How do I configure the VoIPmonitor sniffer?
* How do I configure the sniffer after installation?
* How do I install the VoIPmonitor web GUI?
* Where can I find troubleshooting guides?
* Where can I find troubleshooting guides?
* How do I scale VoIPmonitor for high traffic?
* How do I upgrade VoIPmonitor sniffer and GUI?
* What protocols does VoIPmonitor support?
* How do I set up distributed architecture with multiple sensors?

Latest revision as of 01:40, 10 January 2026


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

Installation Architecture GUI Features FAQ 🤖 AI Support

Getting Started

New to VoIPmonitor? Already Installed?

Quick Start:

  1. Install Sniffer - Download and configure
  2. Install GUI - Web interface setup
  3. Configure voipmonitor.conf
  4. Activate License

Deployment Models:

  • All-in-One: GUI + DB + Sensor on one server
  • Distributed: Central GUI with remote sensors
  • Cloud: VoIPmonitor hosted service

Common Tasks:

Quick Links:

Installation

OS Installation Guides

Distribution Versions Status
Ubuntu 24.04 LTS | 22.04 LTS | 20.04 LTS | 18.04 | 16.04 | 14.04 Supported
Debian 13 | 12 | 11 | 10 | 9 | 8 | 7 | 6 Supported
Rocky / Alma Rocky 10 | Rocky 9 | Alma 10 | Alma 9 Supported
CentOS CentOS 8 | CentOS 7 | CentOS 6.5 EOL
FreeBSD FreeBSD 11 | FreeBSD 10 | FreeBSD 10.1 Supported

Legacy: Outdated Distributions Guide

Component Installation

Sniffer (Sensor) Web GUI

Architecture & Deployment

System Design Deployment Modes Multi-Sensor

Configuration

Sniffer Configuration GUI Configuration

Protocol-Specific Configuration

Protocol Description
SIPREC SIPREC recording integration (Orecx, Orascom)
WebRTC WebRTC call monitoring setup
AudioCodes Tunneling SBC packet forwarding
Ribbon Profiles Ribbon/Sonus monitoring
DTLS DTLS/SRTP handling

Protocols & Standards

Protocol Guides Encryption & Security
  • TLS/SRTP - Encrypted SIP/RTP decryption
  • DTLS - Datagram TLS for WebRTC
  • MySQL TLS - Encrypted database connections

GUI Features

Call Analysis

CDR & Calls

Correlation

Visualization

Quality

Monitoring & Alerts

Alerts

SIP Monitoring

Other

User & Access Management

Security & Authentication

Authentication Methods Security & Privacy

Database

Setup & Structure Troubleshooting & Maintenance

High Availability & Replication

Performance & Scaling

Optimization Hardware Acceleration System Tuning

Troubleshooting

General

Sniffer

GUI

Database

API & Integration

APIs Integrations

Maintenance & Backup

Upgrade

Backup

Maintenance

Advanced Features

Tools & Utilities

Quick Reference

Changelogs

Downloads

Support


AI Summary for RAG

Summary: Main documentation portal for VoIPmonitor - open-source VoIP monitoring and troubleshooting. Index provides links to: OS-specific installation (Ubuntu 24.04/22.04/20.04, Debian 13/12/11, Rocky/Alma 10/9, FreeBSD), sniffer configuration and troubleshooting, distributed architecture (client/server mode), web GUI setup, TLS/SRTP decryption, performance tuning, database management, voice quality analysis. Getting started: (1) Register at voipmonitor.org, (2) Get 30-day trial license, (3) Choose deployment (All-in-One, Distributed, or Direct on PBX/SBC), (4) Follow OS guide. Free Google Meet installation assistance available.

Keywords: documentation, index, portal, installation, ubuntu, debian, rocky linux, almalinux, freebsd, sniffer, sensor, gui, getting started, 30-day trial, distributed architecture, all-in-one, pbx, sbc, troubleshooting, configuration, api, scaling, voice quality, mos

Key Questions:

  • Where do I start with VoIPmonitor?
  • How do I get a 30-day free trial license?
  • Which Linux distribution should I use for VoIPmonitor?
  • How do I install VoIPmonitor on Ubuntu/Debian/Rocky Linux?
  • What are the deployment options (All-in-One vs Distributed)?
  • Can I install VoIPmonitor directly on my PBX/SBC?
  • How do I configure the sniffer after installation?
  • Where can I find troubleshooting guides?
  • How do I upgrade VoIPmonitor sniffer and GUI?
Retrieved from "https://www.voipmonitor.org/doc/index.php?title=Documentation&oldid=10537"