Documentation: Difference between revisions

From VoIPmonitor.org
(Enhance Getting Started section with registration, trial license, SBC/PBX direct installation, and Google Meet support assistance)
(Rewrite: streamlined structure, removed broken links, consolidated sections, cleaner navigation)
 
Line 10: Line 10:
| 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_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>]]
[[Sniffing_modes|<span style="background:#2196F3; color:white; padding:10px 20px; border-radius:6px; text-decoration:none; font-weight:bold; margin-right:10px;">Deployment Guide</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>]]
[[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>]]
|}
== 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 Checklist:'''
# Register at [https://www.voipmonitor.org www.voipmonitor.org]
# Get a '''30-day free trial license'''
# Choose deployment model:
#* '''All-in-One:''' GUI + DB + Sensor on one server
#* '''[[Sniffer_distributed_architecture|Distributed]]:''' Central GUI/DB with remote sensors
#* '''Direct:''' Install sensor directly on your PBX/SBC
# Follow OS installation guide below
# [[Sniffer_configuration|Configure the Sniffer]]
# Explore the [[Call_Detail_Record_-_CDR|CDR Browser]]
{{Tip|Need help? Contact VoIPmonitor support for a free Google Meet installation assistance session.}}
| 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 Tuning]]
* '''API:''' [[WEB_API|REST API Reference]]
'''Quick Links:'''
* [[FAQ|Frequently Asked Questions]]
* [[Glossary|Glossary of Terms]]
* [[License|License Management]]
|}
|}


== Installation by OS ==
== Installation by OS ==
Choose your operating system to get started with VoIPmonitor installation. Each guide covers both Sniffer and GUI setup.


{| class="wikitable" style="width:100%; text-align:center;"
{| class="wikitable" style="width:100%; text-align:center;"
Line 25: Line 57:
! style="background:#e8f5e9; width:45%;" | Notes
! style="background:#e8f5e9; width:45%;" | Notes
|-
|-
| rowspan="4" style="background:#fff; font-weight:bold;" | Ubuntu
| rowspan="3" 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_24.04_LTS|24.04 LTS]] || <span style="color:green;">'''Recommended'''</span> || Latest LTS, best performance
|-
|-
Line 32: Line 64:
| [[Ubuntu_20.04_LTS|20.04 LTS]] || <span style="color:orange;">Maintenance</span> || Extended maintenance
| [[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="3" style="background:#fff; font-weight:bold;" | Debian
|-
| rowspan="4" style="background:#fff; font-weight:bold;" | Debian
| [[Debian_13|13 (Trixie)]] || <span style="color:green;">'''Recommended'''</span> || Latest stable release
| [[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_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
| [[Debian_11|11 (Bullseye)]] || <span style="color:green;">Supported</span> || 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:green;">'''Recommended'''</span> || Latest RHEL 10 compatible
|-
| [[Rocky_9|Rocky 9]] || <span style="color:green;">Supported</span> || RHEL 9 compatible, support until 2032
|-
| rowspan="2" style="background:#fff; font-weight:bold;" | AlmaLinux
| [[Almalinux_10|AlmaLinux 10]] || <span style="color:green;">'''Recommended'''</span> || Latest RHEL 10 compatible
|-
|-
| [[Almalinux_9.5|AlmaLinux 9]] || <span style="color:green;">Supported</span> || RHEL 9 compatible
| rowspan="2" style="background:#fff; font-weight:bold;" | Rocky / Alma
| [[Rocky_10|Rocky 10]] / [[Almalinux_10|Alma 10]] || <span style="color:green;">'''Recommended'''</span> || Latest RHEL 10 compatible
|-
|-
| rowspan="2" style="background:#fff; font-weight:bold;" | CentOS
| [[Rocky_9|Rocky 9]] / [[Almalinux_9.5|Alma 9]] || <span style="color:green;">Supported</span> || RHEL 9 compatible
| [[Centos_8|CentOS 8 Stream]] || <span style="color:orange;">Maintenance</span> || Use Rocky/Alma for new installs
|-
|-
| style="background:#fff; font-weight:bold;" | CentOS
| [[Centos_7|CentOS 7]] || <span style="color:red;">EOL</span> || Migrate to Rocky/Alma
| [[Centos_7|CentOS 7]] || <span style="color:red;">EOL</span> || Migrate to Rocky/Alma
|-
|-
| style="background:#fff; font-weight:bold;" | FreeBSD
| style="background:#fff; font-weight:bold;" | FreeBSD
| [[FreeBSD_11|FreeBSD 11+]] || <span style="color:green;">Supported</span> || See also [[FreeBSD]], [[FreeBSD10]]
| [[FreeBSD_11|FreeBSD 11+]] || <span style="color:green;">Supported</span> || BSD installation guide
|}
|}


<small>For legacy systems: [[Outdated_distributions_installation|Outdated Distributions Guide]] (CentOS 5/6, Debian 6-9, Ubuntu 12-16, Gentoo, ARM)</small>
<small>Legacy systems: [[Outdated_distributions_installation|Outdated Distributions Guide]]</small>


=== Quick Start After OS Selection ===
=== After OS 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:15px;" |
'''[[Sniffer_installation|Sniffer Installation Guide]]''' - Complete setup instructions
# '''[[Sniffer_installation|Install Sniffer]]''' - Download and run installer
 
# '''[[Sniffer_configuration|Configure voipmonitor.conf]]''' - Database, interface
After installation:
# '''[[Sniffing_modes|Choose Capture Mode]]''' - SPAN, ERSPAN, tunnels
* [[Sniffer_configuration|Configure voipmonitor.conf]] - Database, interface settings
# '''[[Systemd_for_voipmonitor_service_management|Start Service]]''' - systemctl commands
* [[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;" |
| style="vertical-align:top; padding:15px;" |
'''[[GUI_Installation|GUI Installation Guide]]''' - Fresh install
# '''[[GUI_Installation|Install GUI]]''' or '''[[Re-install_the_GUI|Reinstall]]'''
 
# '''[[User_Management|Create Users]]''' - Accounts and permissions
'''[[Re-install_the_GUI|Reinstall/Upgrade GUI]]''' - Update existing installation
# '''[[Settings|Configure Settings]]''' - Sensors, system options
 
# '''[[Https|Enable HTTPS]]''' - Secure web access
After installation:
* [[User_Management|Create Users]] - Accounts and permissions
* [[Settings|Configure Settings]] - System options
* [[Https|Enable HTTPS]] - Secure access
|}
 
== Getting Started ==
 
{| class="wikitable" style="width:100%; border-collapse:separate; border-spacing:0;"
|-
! 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;" |
'''Getting Started Checklist:'''<br/><br/>
'''1.''' Register at [https://www.voipmonitor.org www.voipmonitor.org]<br/>
'''2.''' Get a '''30-day free trial license''' (self-hosted or cloud)<br/>
'''3.''' [[Architecture|Choose Your Deployment Model]]<br/>
* All-in-One: GUI + DB + Sensor on one server<br/>
* Distributed: Central GUI/DB with remote sensors<br/>
* Direct Sensor: Install directly on your SBC/PBX<br/><br/>
'''4.''' Choose your OS above and follow the installation guide<br/>
'''5.''' [[Sniffer_configuration|Configure the Sniffer]] - Essential settings<br/>
'''6.''' [[WEB_GUI_Manual|Explore the GUI]] - Feature overview
 
{{Tip|Need installation assistance? Contact VoIPmonitor support for a free Google Meet session to help you get started.}}
| 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]]
|}
|}


== Sniffer (Sensor) ==
== Sniffer (Sensor) Documentation ==


The C++ packet capture engine - monitors network traffic, decodes VoIP protocols, and stores call data.
The C++ packet capture engine that 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:25%;" | Configuration
! style="background:#e8f5e9; width:25%;" | Capture Modes
! style="background:#e8f5e9; width:25%;" | Deployment Modes
! style="background:#e3f2fd; width:25%;" | Operations
! style="background:#e3f2fd; width:25%;" | Operations
! style="background:#fce4ec; width:25%;" | Troubleshooting
! 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|'''Configuration Reference''']]<br/><small>voipmonitor.conf parameters</small>
[[Sniffer_configuration|'''Configuration Reference''']]<br/><small>voipmonitor.conf parameters</small>


Line 135: Line 121:


[[Systemd_for_voipmonitor_service_management|'''Systemd Service''']]<br/><small>Service management</small>
[[Systemd_for_voipmonitor_service_management|'''Systemd Service''']]<br/><small>Service management</small>
[[Multiple_sniffer_instancies|'''Multiple Instances''']]<br/><small>Multi-sensor on one host</small>
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[Sniffing_modes|'''Sniffing Modes''']]<br/><small>Mirror port, SPAN, ERSPAN</small>
[[Sniffing_modes|'''Deployment Guide''']]<br/><small>SPAN, ERSPAN, tunnels, HEP</small>


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


[[SIPREC|'''SIPREC Recording''']]<br/><small>SBC-based call recording</small>
[[Audiocodes_tunneling|'''AudioCodes Tunneling''']]<br/><small>SBC mirroring</small>


[[Capture_rules|'''Capture Rules''']]<br/><small>Filter what gets recorded</small>
[[Cloud|'''Cloud Deployment''']]<br/><small>AWS, hosted service</small>
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[Data_Cleaning|'''Data Retention''']]<br/><small>Cleanup and rotation policies</small>
[[Data_Cleaning|'''Data Retention''']]<br/><small>Cleanup and rotation</small>


[[Sniffer_upgrade|'''Upgrade Guide''']]<br/><small>Update to latest version</small>
[[Sniffer_upgrade|'''Upgrade Guide''']]<br/><small>Update to latest version</small>
Line 150: Line 138:
[[Scaling|'''Performance Tuning''']]<br/><small>High-traffic optimization</small>
[[Scaling|'''Performance Tuning''']]<br/><small>High-traffic optimization</small>


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


[[Understanding_the_Sniffer's_Performance_Log|'''Performance Logs''']]<br/><small>Interpret t0CPU, SQLq, etc.</small>
[[Database_troubleshooting|'''Database Issues''']]<br/><small>SQL queue, performance</small>


[[Memoryleak|'''Memory Issues''']]<br/><small>Debugging memory usage</small>
[[Emergency_procedures|'''Emergency Procedures''']]<br/><small>Bottleneck diagnosis</small>


[[Capture_rules_troubleshooting|'''Capture Problems''']]<br/><small>Why calls not captured</small>
[[Recovering_corrupted_database_tables|'''Table Recovery''']]<br/><small>Corrupted database repair</small>
|}
|}


=== Protocols & Advanced ===
=== Protocols & Encryption ===


{| class="wikitable" style="width:100%;"
{| class="wikitable" style="width:100%;"
|-
|-
! style="background:#f3e5f5; width:33%;" | VoIP Protocols
! style="background:#f3e5f5; width:33%;" | VoIP Protocols
! style="background:#e0f7fa; width:33%;" | Encryption & Security
! style="background:#e0f7fa; width:33%;" | Encryption
! style="background:#fff8e1; width:34%;" | Hardware & Performance
! style="background:#fff8e1; width:34%;" | Hardware Acceleration
|-
|-
| 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''']]<br/><small>Session Initiation Protocol</small>


[[Understanding_the_RTP_Protocol|'''RTP Protocol''']]<br/><small>Real-time Transport</small>
[[WebRTC|'''WebRTC Monitoring''']]<br/><small>Browser-based VoIP</small>
 
[[Understanding_the_WebRTC_Protocol|'''WebRTC''']]<br/><small>Browser-based VoIP</small>


[[Ss7|'''SS7 Signaling''']]<br/><small>Legacy telephony</small>
[[Register|'''SIP Registration''']]<br/><small>Registration tracking</small>


[[Audiocodes_tunneling|'''AudioCodes Tunneling''']]<br/><small>Proprietary protocol</small>
[[Merging_or_correlating_multiple_call_legs|'''Call Correlation''']]<br/><small>Linking call legs</small>
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[Tls|'''TLS/SRTP''']]<br/><small>Encrypted SIP/RTP</small>
[[Tls|'''TLS/SRTP Decryption''']]<br/><small>Encrypted SIP/RTP</small>
 
[[DTLS|'''DTLS''']]<br/><small>Datagram TLS for WebRTC</small>


[[Encryption_in_manager_api|'''Manager API Encryption''']]<br/><small>Secure API access</small>
[[Whisper|'''Whisper Transcription''']]<br/><small>Speech-to-text</small>


[[Pubkey|'''SSH Public Key''']]<br/><small>Remote access setup</small>
[[Silence_detection|'''Silence Detection''']]<br/><small>Audio analysis</small>
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[Hardware|'''Hardware Requirements''']]<br/><small>Sizing guide</small>
[[DPDK|'''DPDK''']]<br/><small>Kernel bypass for >6 Gbit/s</small>


[[DPDK|'''DPDK''']]<br/><small>Data Plane Development Kit</small>
[[Napatech|'''Napatech Cards''']]<br/><small>SmartNIC integration</small>
 
[[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>
|}
|}


=== Performance & Memory ===
== Web GUI Documentation ==
 
{| class="wikitable" style="width:100%;"
|-
! style="background:#e8eaf6; width:33%;" | Memory Management
! style="background:#e0f2f1; width:33%;" | Monitoring & Logging
! style="background:#fce4ec; width:34%;" | Utilities & Scripts
|-
| style="vertical-align:top; padding:12px;" |
[[Jemalloc|'''jemalloc''']]<br/><small>Memory allocator</small>
 
[[Tcmalloc|'''tcmalloc''']]<br/><small>Google allocator</small>
 
[[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''']]<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;" |
[[Manual_PCAP_Extraction_from_spooldir|'''PCAP Extraction''']]<br/><small>Manual export</small>
 
[[Create_audio_from_packet_dumps_located_in_a_spooldir|'''Audio Creation''']]<br/><small>From packet dumps</small>
 
[[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 ==


Browser-based interface for call analysis, reporting, alerts, and system management.
Browser-based interface for call analysis, reporting, alerts, and system management.
Line 239: Line 183:
{| class="wikitable" style="width:100%;"
{| class="wikitable" style="width:100%;"
|-
|-
! style="background:#e3f2fd; width:25%;" | Setup & Access
! style="background:#e3f2fd; width:25%;" | Setup
! style="background:#e8f5e9; width:25%;" | Call Analysis
! style="background:#e8f5e9; width:25%;" | Call Analysis
! style="background:#fff3e0; width:25%;" | Monitoring & Alerts
! style="background:#fff3e0; width:25%;" | Monitoring
! style="background:#f3e5f5; width:25%;" | Administration
! 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>
[[GUI_Installation|'''Installation''']]<br/><small>Fresh install</small>


[[Re-install_the_GUI|'''Reinstall/Upgrade''']]<br/><small>Update existing</small>
[[Re-install_the_GUI|'''Reinstall/Upgrade''']]<br/><small>Update existing</small>
Line 251: Line 195:
[[Https|'''HTTPS Setup''']]<br/><small>SSL/TLS configuration</small>
[[Https|'''HTTPS Setup''']]<br/><small>SSL/TLS configuration</small>


[[Nginx|'''Nginx Configuration''']]<br/><small>Reverse proxy setup</small>
[[Nginx|'''Nginx Proxy''']]<br/><small>Reverse proxy, timeouts</small>
 
[[GUI_Configuration_PHP|'''PHP Configuration''']]<br/><small>configuration.php settings</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>
[[Call_Detail_Record_-_CDR|'''CDR Browser''']]<br/><small>Search and filter calls</small>


[[CDR_Summary|'''CDR Aggregation''']]<br/><small>Statistics and summaries</small>
[[Active_calls|'''Active Calls''']]<br/><small>Real-time monitoring</small>


[[Live_sniffer|'''Live Sniffer''']]<br/><small>Real-time packet capture</small>
[[Charts|'''Charts & Graphs''']]<br/><small>Visual analytics</small>


[[Active_calls|'''Active Calls''']]<br/><small>Currently active sessions</small>
[[Reports|'''Reports''']]<br/><small>Daily, summary, custom</small>
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[Dashboardv2|'''Dashboard''']]<br/><small>Overview and widgets</small>
[[Alerts|'''Alert System''']]<br/><small>RTP, SIP, fraud alerts</small>


[[Alerts|'''Alert System''']]<br/><small>Notifications and triggers</small>
[[Anti-fraud|'''Fraud Detection''']]<br/><small>Country, sequential alerts</small>


[[Charts|'''Charts & Graphs''']]<br/><small>Visual analytics</small>
[[Register|'''SIP Register''']]<br/><small>Registration status</small>


[[Network_map|'''Network Map''']]<br/><small>Topology visualization</small>
[[Tools|'''Tools''']]<br/><small>MTR, IP lookup, debug</small>
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[User_Management|'''User Management''']]<br/><small>Accounts and permissions</small>
[[User_Management|'''User Management''']]<br/><small>Accounts, permissions</small>


[[Settings|'''GUI Settings''']]<br/><small>System configuration</small>
[[Settings|'''Sensor Settings''']]<br/><small>Multi-sensor config</small>


[[Backup|'''Backup & Restore''']]<br/><small>Configuration backup</small>
[[License|'''License Management''']]<br/><small>Channels, activation</small>


[[WEB_API|'''REST API''']]<br/><small>Programmatic access</small>
[[Backing_Up_GUI_Configuration|'''Backup & Restore''']]<br/><small>Configuration backup</small>
|}
|}


=== Features & Tools ===
=== Authentication & API ===


{| class="wikitable" style="width:100%;"
{| class="wikitable" style="width:100%;"
|-
|-
! style="background:#e0f2f1; width:33%;" | Security & Authentication
! style="background:#e0f2f1; width:50%;" | Authentication
! style="background:#fce4ec; width:33%;" | Reporting & Billing
! style="background:#fce4ec; width:50%;" | API & Integration
! style="background:#e8eaf6; width:34%;" | Advanced Features
|-
|-
| style="vertical-align:top; padding:12px;" |
| style="vertical-align:top; padding:12px;" |
[[2FA|'''Two-Factor Auth''']]<br/><small>TOTP authentication</small>
[[Google_Sign_in_usage|'''Google Sign-In''']]<br/><small>OAuth integration</small>
[[Google_Sign_in_usage|'''Google Sign-In''']]<br/><small>OAuth integration</small>


[[Microsoft_Sign_in_usage|'''Microsoft Sign-In''']]<br/><small>Azure AD</small>
[[Microsoft_Sign_in_usage|'''Microsoft Sign-In''']]<br/><small>Azure AD (in development)</small>


[[Shibboleth_and_other_auth_modules|'''Shibboleth/SAML''']]<br/><small>Enterprise SSO</small>
[[Groups|'''IP & Number Groups''']]<br/><small>Filtering, trunk/server classification</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>
[[WEB_API|'''REST API''']]<br/><small>HTTP API 2, CDR API</small>


[[Billing|'''Billing Module''']]<br/><small>Cost analysis</small>
[[Register_active|'''Manager API''']]<br/><small>TCP/socket commands</small>
 
[[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''']]<br/><small>Registration tracking</small>
 
[[MESSAGES|'''SIP Messages''']]<br/><small>IM/SMS analysis</small>
 
[[Issue_tracker|'''Issue Tracker''']]<br/><small>Problem management</small>
 
[[Groups|'''Groups''']]<br/><small>Call grouping</small>
 
[[Tools|'''Tools''']]<br/><small>Utility functions</small>
|}
 
=== Integrations ===
 
{| class="wikitable" style="width:100%;"
|-
! style="background:#fff8e1; width:33%;" | External Monitoring
! style="background:#e3f2fd; width:33%;" | Web Server
! style="background:#e8f5e9; width:34%;" | Data Export
|-
| style="vertical-align:top; padding:12px;" |
[[Nagios|'''Nagios''']]<br/><small>Legacy monitoring</small>
 
[[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''']]<br/><small>Web server setup</small>
 
[[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''']]<br/><small>PCAP/audio export</small>
 
[[Output_of_the_API_LISTING_task|'''API Listing''']]<br/><small>Call list export</small>
 
[[Pcap_worksheet|'''PCAP Analysis''']]<br/><small>Packet inspection</small>
|}
 
== Infrastructure & Scaling ==
 
{| 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>
 
[[High_availability_mariadb_galera_cluster|'''Galera Cluster''']]<br/><small>Multi-master MySQL</small>
 
[[Cloud|'''Cloud Deployment''']]<br/><small>AWS, GCP, Azure</small>
 
[[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>
 
[[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>
|}
|}


Line 385: Line 248:
|-
|-
! style="background:#f3e5f5; width:50%;" | Quality Metrics
! style="background:#f3e5f5; width:50%;" | Quality Metrics
! style="background:#e0f7fa; width:50%;" | Audio Processing
! style="background:#e0f7fa; width:50%;" | Reference
|-
|-
| 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>
[[Comprehensive_Guide_to_VoIP_Voice_Quality|'''Voice Quality Guide''']]<br/><small>MOS, jitter, packet loss, E-model explained</small>


[[Jitter-bug|'''Jitter Analysis''']]<br/><small>Network timing issues</small>
[[Silence_detection|'''Silence Detection''']]<br/><small>One-way audio, clipping detection</small>


[[Silence_detection|'''Silence Detection''']]<br/><small>Audio gap detection</small>
[[Glossary|'''Glossary''']]<br/><small>KPI definitions: ASR, NER, ACD, PDD, PDV</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>
[[Database_structure|'''CDR Database Schema''']]<br/><small>Quality metric columns</small>
 
[[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>
[[Charts|'''Quality Charts''']]<br/><small>MOS, jitter visualization</small>
|}
|}


Line 409: Line 268:
| 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://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 Getting Started section provides a beginner-friendly checklist: (1) Register at www.voipmonitor.org, (2) Get a 30-day free trial license (self-hosted or cloud), (3) Choose deployment model (All-in-One, Distributed, or Direct on SBC/PBX), (4) Follow OS-specific installation guide. Contact VoIPmonitor support for a free Google Meet session for installation assistance. 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, register, 30-day trial, trial license, sbc, pbx, direct installation, google meet, support assistance
'''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 register for VoIPmonitor?
* How do I get a 30-day free trial license?
* How do I get a 30-day free trial license?
* What are the deployment options for VoIPmonitor?
* Which Linux distribution should I use for VoIPmonitor?
* Can I install VoIPmonitor directly on my SBC/PBX?
* 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 16:48, 8 January 2026


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

Installation Guide Deployment Guide FAQ

Getting Started

New to VoIPmonitor? Already Installed?

Quick Start Checklist:

  1. Register at www.voipmonitor.org
  2. Get a 30-day free trial license
  3. Choose deployment model:
    • All-in-One: GUI + DB + Sensor on one server
    • Distributed: Central GUI/DB with remote sensors
    • Direct: Install sensor directly on your PBX/SBC
  4. Follow OS installation guide below
  5. Configure the Sniffer
  6. Explore the CDR Browser

💡 Tip: Need help? Contact VoIPmonitor support for a free Google Meet installation assistance session.

Common Tasks:

Quick Links:

Installation by OS

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 Extended maintenance
Debian 13 (Trixie) Recommended Latest stable release
12 (Bookworm) Supported Previous stable
11 (Bullseye) Supported LTS until 2026
Rocky / Alma Rocky 10 / Alma 10 Recommended Latest RHEL 10 compatible
Rocky 9 / Alma 9 Supported RHEL 9 compatible
CentOS CentOS 7 EOL Migrate to Rocky/Alma
FreeBSD FreeBSD 11+ Supported BSD installation guide

Legacy systems: Outdated Distributions Guide

After OS Installation

Sniffer (Sensor) Web GUI
  1. Install Sniffer - Download and run installer
  2. Configure voipmonitor.conf - Database, interface
  3. Choose Capture Mode - SPAN, ERSPAN, tunnels
  4. Start Service - systemctl commands
  1. Install GUI or Reinstall
  2. Create Users - Accounts and permissions
  3. Configure Settings - Sensors, system options
  4. Enable HTTPS - Secure web access

Sniffer (Sensor) Documentation

The C++ packet capture engine that monitors network traffic, decodes VoIP protocols, and stores call data.

Configuration Deployment Modes Operations Troubleshooting

Configuration Reference
voipmonitor.conf parameters

Database Schema
CDR table structure

Systemd Service
Service management

Multiple Instances
Multi-sensor on one host

Deployment Guide
SPAN, ERSPAN, tunnels, HEP

Distributed Mode
Client/Server architecture

AudioCodes Tunneling
SBC mirroring

Cloud Deployment
AWS, hosted service

Data Retention
Cleanup and rotation

Upgrade Guide
Update to latest version

Performance Tuning
High-traffic optimization

Database Redundancy
Migration and replication

Troubleshooting Guide
Common issues & solutions

Database Issues
SQL queue, performance

Emergency Procedures
Bottleneck diagnosis

Table Recovery
Corrupted database repair

Protocols & Encryption

VoIP Protocols Encryption Hardware Acceleration

SIP Protocol
Session Initiation Protocol

WebRTC Monitoring
Browser-based VoIP

SIP Registration
Registration tracking

Call Correlation
Linking call legs

TLS/SRTP Decryption
Encrypted SIP/RTP

Whisper Transcription
Speech-to-text

Silence Detection
Audio analysis

DPDK
Kernel bypass for >6 Gbit/s

Napatech Cards
SmartNIC integration

Web GUI Documentation

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

Setup Call Analysis Monitoring Administration

Installation
Fresh install

Reinstall/Upgrade
Update existing

HTTPS Setup
SSL/TLS configuration

Nginx Proxy
Reverse proxy, timeouts

PHP Configuration
configuration.php settings

CDR Browser
Search and filter calls

Active Calls
Real-time monitoring

Charts & Graphs
Visual analytics

Reports
Daily, summary, custom

Alert System
RTP, SIP, fraud alerts

Fraud Detection
Country, sequential alerts

SIP Register
Registration status

Tools
MTR, IP lookup, debug

User Management
Accounts, permissions

Sensor Settings
Multi-sensor config

License Management
Channels, activation

Backup & Restore
Configuration backup

Authentication & API

Authentication API & Integration

Google Sign-In
OAuth integration

Microsoft Sign-In
Azure AD (in development)

IP & Number Groups
Filtering, trunk/server classification

REST API
HTTP API 2, CDR API

Manager API
TCP/socket commands

Voice Quality & Analysis

Quality Metrics Reference

Voice Quality Guide
MOS, jitter, packet loss, E-model explained

Silence Detection
One-way audio, clipping detection

Glossary
KPI definitions: ASR, NER, ACD, PDD, PDV

CDR Database Schema
Quality metric columns

Quality Charts
MOS, jitter visualization

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=10105"