Documentation: Difference between revisions

From VoIPmonitor.org
(Add AI Support button to header and Quick Reference)
 
(12 intermediate revisions by 2 users not shown)
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|<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>]]
[[#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>]
|}


[[Architecture]]
== Getting Started ==


[[Glossary]]
{| 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]]


[[Scaling]]
'''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]]


[[Data Cleaning]]
'''Quick Links:'''
* [[FAQ|FAQ]] {{!}} [[Glossary|Glossary]] {{!}} [[License|License]]
* [[Uninstall|Uninstall VoIPmonitor]]
|}


[[Cloud]]
== Installation ==


[[FAQ]]
=== OS Installation Guides ===


 
{| class="wikitable" style="width:100%; text-align:center;"
= Installation =
|-
 
! style="background:#e8f5e9; width:20%;" | Distribution
{| class="wikitable"
! style="background:#e8f5e9; width:60%;" | Versions
! style="background:#e8f5e9; width:20%;" | Status
|-
|-
! Distribution !! Supported Versions
| 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''' || [[Debian 13]] | [[Debian 12]] | [[Debian 11]] | [[Debian 10]]
| 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>
|-
|-
| '''Ubuntu LTS''' || [[Ubuntu 24.04 LTS]] | [[Ubuntu 22.04 LTS]] | [[Ubuntu 20.04 LTS]] | [[Ubuntu 18.04 LTS]]
| style="font-weight:bold;" | Rocky / Alma
| [[Rocky_10|Rocky 10]] {{!}} [[Rocky_9|Rocky 9]] {{!}} [[Almalinux_10|Alma 10]] {{!}} [[Almalinux_9.5|Alma 9]]
| <span style="color:green;">Supported</span>
|-
|-
| '''Rocky Linux''' || [[Rocky 10]] | [[Rocky 9]]
| 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>
|-
|-
| '''AlmaLinux''' || [[Almalinux 10]] | [[Almalinux 9.5]]
| style="font-weight:bold;" | FreeBSD
| [[FreeBSD_11|FreeBSD 11]] {{!}} [[FreeBSD10|FreeBSD 10]] {{!}} [[FreeBSD101|FreeBSD 10.1]]
| <span style="color:green;">Supported</span>
|}
|}


[[Outdated distributions installation]]
<small>Legacy: [[Outdated_distributions_installation|Outdated Distributions Guide]]</small>


= WEB GUI =
=== Component Installation ===


[[WEB GUI Manual]]
{| class="wikitable" style="width:100%;"
|-
! style="background:#fff3e0; width:50%;" | Sniffer (Sensor)
! style="background:#e3f2fd; width:50%;" | Web GUI
|-
| style="vertical-align:top; padding:12px;" |
* [[Sniffer_installation|'''Installation Guide''']] - Binary download and setup
* [[Sniffer_configuration|'''Configuration Reference''']] - voipmonitor.conf
* [[Systemd_for_voipmonitor_service_management|'''Systemd Service''']] - Service management
* [[Sniffer_upgrade|'''Upgrade Guide''']] - Update to latest version
| style="vertical-align:top; padding:12px;" |
* [[GUI_installation|'''Installation Guide''']] - PHP, database, IonCube
* [[Re-install_the_GUI|'''Reinstall/Upgrade''']] - Update existing
* [[License|'''License Activation''']] - Trial and commercial
* [[Uninstall|'''Uninstall''']] - Complete removal
|}


[http://www.voipmonitor.org/changelog-gui GUI changelog]
== Architecture & Deployment ==


{| class="wikitable" style="width:100%;"
|-
! style="background:#e3f2fd; width:33%;" | System Design
! style="background:#e8f5e9; width:33%;" | Deployment Modes
! style="background:#fff3e0; width:34%;" | Multi-Sensor
|-
| style="vertical-align:top; padding:12px;" |
* [[Architecture|'''Architecture Overview''']] - Components and data flow
* [[Sniffer_detailed_architecture|'''Sniffer Internals''']] - Deep dive
* [[Database_structure|'''Database Schema''']] - CDR tables
| style="vertical-align:top; padding:12px;" |
* [[Sniffing_modes|'''Sniffing Modes''']] - SPAN, TAP, tunnels
* [[Sniffer_distributed_architecture|'''Distributed Architecture''']] - Client/server
* [[Cloud|'''Cloud Deployment''']] - Hosted service
| style="vertical-align:top; padding:12px;" |
* [[Multiple_sniffer_instancies|'''Multiple Instances''']] - Multi-sensor setup
* [[Promiscuous|'''Promiscuous Mode''']] - Interface config
|}


= Sniffer =
== Configuration ==


[[Sniffer manual]]
{| class="wikitable" style="width:100%;"
|-
! style="background:#fff3e0; width:50%;" | Sniffer Configuration
! style="background:#e3f2fd; width:50%;" | GUI Configuration
|-
| style="vertical-align:top; padding:12px;" |
* [[Sniffer_configuration|'''voipmonitor.conf Reference''']] - All parameters
* [[Capture_rules|'''Capture Rules''']] - Filter SIP/RTP by IP, port, patterns
* [[How_to_enable_ipv6_processing|'''IPv6 Processing''']] - Enable IPv6 support
* [[How_to_enable_milliseconds_precision|'''Milliseconds Precision''']] - High-precision timing
| style="vertical-align:top; padding:12px;" |
* [[GUI_Configuration_PHP|'''configuration.php''']] - PHP settings
* [[Settings|'''GUI Settings''']] - System options
* [[Promiscuous|'''Network Interface''']] - Promiscuous mode
|}


[[Sniffing modes]]
=== Protocol-Specific Configuration ===


[[Sniffer distributed architecture]]
{| class="wikitable" style="width:100%;"
|-
! style="background:#f3e5f5;" | Protocol
! style="background:#f3e5f5;" | Description
|-
| [[SIPREC|'''SIPREC''']] || SIPREC recording integration (Orecx, Orascom)
|-
| [[WebRTC|'''WebRTC''']] || WebRTC call monitoring setup
|-
| [[Audiocodes_tunneling|'''AudioCodes Tunneling''']] || SBC packet forwarding
|-
| [[Ribbon7k_monitoring_profiles|'''Ribbon Profiles''']] || Ribbon/Sonus monitoring
|-
| [[DTLS|'''DTLS''']] || DTLS/SRTP handling
|}


[[Sniffer installation]]
== Protocols & Standards ==


[[Sniffer configuration]]
{| class="wikitable" style="width:100%;"
|-
! style="background:#e0f7fa; width:50%;" | Protocol Guides
! style="background:#f3e5f5; width:50%;" | Encryption & Security
|-
| style="vertical-align:top; padding:12px;" |
* [[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
|}


[[Sniffer upgrade]]
== GUI Features ==


[[Sniffer troubleshooting]]
=== Call Analysis ===


[[High-Performance VoIPmonitor and MySQL Setup Manual]]
{| 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
|}


[[WebRTC]]
=== Monitoring & Alerts ===


[[Tls|TLS SSL decryption]]
{| 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
|}


[[ss7|SS7 / ISUP]]
=== User & Access Management ===


[[DPDK]]
{| class="wikitable" style="width:100%;"
|-
| style="vertical-align:top; padding:12px;" |
* [[User_Management|'''User Management''']] - Accounts and permissions
* [[Groups|'''Groups''']] - IP/number grouping
* [[CountryGrouping|'''Country Grouping''']] - GeoIP grouping
* [[Billing|'''Billing''']] - Rate calculations
* [[Glossary|'''Glossary''']] - Terminology
|}


[[Whisper]]
== Security & Authentication ==


[[Understanding the Sniffer's Performance Log]]
{| class="wikitable" style="width:100%;"
|-
! style="background:#fce4ec; width:50%;" | Authentication Methods
! style="background:#e8eaf6; width:50%;" | Security & Privacy
|-
| style="vertical-align:top; padding:12px;" |
* [[2FA|'''Two-Factor Auth''']] - TOTP setup
* [[Authentication|'''Authentication Overview''']] - All methods
* [[Google_Sign_in_usage|'''Google Sign-In''']] - OAuth
* [[Microsoft_Sign_in_usage|'''Microsoft Sign-In''']] - Azure AD
* [[REMOTE_USER_Authentication|'''REMOTE_USER''']] - Shibboleth, SAML
| style="vertical-align:top; padding:12px;" |
* [[Security_Policy_and_Posture|'''Security Best Practices''']]
* [[Securing_the_VoIPmonitor_Web_GUI_HTTPS_and_Basic_Auth|'''HTTPS & Basic Auth''']]
* [[Data_Privacy_and_Data_Masking|'''Data Privacy & Masking''']] - IP anonymization
* [[CALEA_compliance|'''CALEA Compliance''']] - Lawful intercept
|}


[[SIPREC]]
== Database ==


= Guides =
{| class="wikitable" style="width:100%;"
|-
! style="background:#fff3e0; width:50%;" | Setup & Structure
! style="background:#fce4ec; width:50%;" | Troubleshooting & Maintenance
|-
| style="vertical-align:top; padding:12px;" |
* [[Database_structure|'''Database Schema''']] - Table reference
* [[Mysql_5.7|'''MySQL 5.7''']] - Version specifics
* [[MySQL_8_upgrade_stored_routine_fix|'''MySQL 8 Upgrade''']] - Compatibility fixes
* [[Upgrade_to_bigint|'''Upgrade to BigInt''']] - Large deployments
| style="vertical-align:top; padding:12px;" |
* [[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
|}


[[Comprehensive Guide to VoIP Voice Quality]]
== High Availability & Replication ==


[[Understanding the SIP Protocol]]
{| class="wikitable" style="width:100%;"
|-
| style="vertical-align:top; padding:12px;" |
* [[High_availability_redundancy_failover|'''HA & Failover Overview''']] - Strategies
* [[High_availability_mariadb_galera_cluster|'''Galera Cluster''']] - Multi-master setup
* [[Redundant_database|'''Database Redundancy''']] - Options
| style="vertical-align:top; padding:12px;" |
* [[Mysql_master-slave_replication_hints|'''Master-Slave Replication''']]
* [[Mysql_master-master_replication_hints|'''Master-Master Replication''']]
|}


[[Understanding the RTP Protocol]]
== Performance & Scaling ==


[[Understanding the WebRTC Protocol]]
{| class="wikitable" style="width:100%;"
|-
! style="background:#e8f5e9; width:33%;" | Optimization
! style="background:#e3f2fd; width:33%;" | Hardware Acceleration
! style="background:#fff3e0; width:34%;" | System Tuning
|-
| style="vertical-align:top; padding:12px;" |
* [[Scaling|'''Scaling Guide''']] - Large deployments
* [[High-Performance_VoIPmonitor_and_MySQL_Setup_Manual|'''High-Performance Setup''']]
* [[Sniffer_performance|'''Performance Tuning''']]
* [[Understanding_the_Sniffer's_Performance_Log|'''Performance Logs''']]
| style="vertical-align:top; padding:12px;" |
* [[DPDK|'''DPDK''']] - 6+ Gbit/s capture
* [[Napatech|'''Napatech Cards''']] - SmartNIC
* [[Hardware|'''Hardware Requirements''']]
| style="vertical-align:top; padding:12px;" |
* [[Diagnosing_Database_Bottlenecks_Using_Sensor_RRD_Charts|'''DB Bottlenecks''']]
* [[Swap|'''Swap Configuration''']]
* [[Voipmonitor_and_hugepages|'''Hugepages''']]
* [[Jemalloc|'''Jemalloc''']] - Memory allocator
|}


[[Audio Codecs - Comprehensive Guide]]
== Troubleshooting ==


[[Merging or correlating multiple call legs]]
{| class="wikitable" style="width:100%;"
|-
| style="width:25%; vertical-align:top; padding:12px;" |
'''General'''
* [[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''']]
|}


[[Securing the VoIPmonitor Web GUI HTTPS and Basic Auth]]
== API & Integration ==


[[Backing Up GUI Configuration]]
{| class="wikitable" style="width:100%;"
|-
! style="background:#e3f2fd; width:50%;" | APIs
! style="background:#e8f5e9; width:50%;" | Integrations
|-
| style="vertical-align:top; padding:12px;" |
* [[WEB_API|'''REST API''']] - HTTP API reference
* [[Manager_API|'''Manager API''']] - TCP port 5029
* [[Download_of_pcap_files_/_audio_files_using_GUI's_api|'''PCAP/Audio Download''']] - File API
* [[ChunkPlayer|'''ChunkPlayer''']] - Live audio streaming
| style="vertical-align:top; padding:12px;" |
* [[EasyCallerID|'''EasyCallerID''']] - CallerID lookup
* [[Collectd_installation|'''Collectd''']] - System monitoring
* [[Nagios|'''Nagios''']] - Nagios integration
* [[Nginx|'''Nginx''']] - Reverse proxy
|}


[[How to enable milliseconds precision]]
== Maintenance & Backup ==


[[high availability mariadb galera cluster]]
{| class="wikitable" style="width:100%;"
|-
| style="width:33%; vertical-align:top; padding:12px;" |
'''Upgrade'''
* [[Sniffer_upgrade|'''Sniffer Upgrade''']]
* [[Re-install_the_GUI|'''GUI Reinstall''']]
| 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''']]
|}


[[high availability redundancy failover]]
== Advanced Features ==


[[GUI automate login]]  
{| class="wikitable" style="width:100%;"
|-
| style="vertical-align:top; padding:12px;" |
* [[Whisper|'''Whisper''']] - Speech-to-text transcription
* [[Silence_detection|'''Silence Detection''']] - Audio analysis
* [[Audio_Codecs_-_Comprehensive_Guide|'''Audio Codecs Guide''']]
* [[Manual_PCAP_Extraction_from_spooldir|'''Manual PCAP Extraction''']]
| style="vertical-align:top; padding:12px;" |
* [[Minimizing_Delay_Between_Call_End_and_CDR_Database_Storage|'''CDR Delay Optimization''']]
* [[Ipaccount|'''IP Accounting''']]
|}


[[Nginx]]
== Tools & Utilities ==


[[php-fpm & apache]]
{| class="wikitable" style="width:100%;"
|-
| style="vertical-align:top; padding:12px;" |
* [[Tools|'''Built-in Tools''']] - Overview
* [[Git|'''Git''']] - Repository access
* [[Sox|'''SoX''']] - Audio processing
* [[Tshark|'''Tshark''']] - Wireshark CLI
| style="vertical-align:top; padding:12px;" |
* [[Script-for-big-batchdownloads|'''Batch Download Script''']]
* [[Script-for-probes-backup|'''Probe Backup Script''']]
|}


[[Collectd installation]]
== Quick Reference ==


[[openvpn]]
{| style="width:100%; border:1px solid #ddd; border-radius:8px; padding:15px; background:#fafafa;"
 
|-
[[upgrade to bigint]]
| style="vertical-align:top; width:33%;" |
 
'''Changelogs'''
[[systemd for voipmonitor service management]]
* [https://www.voipmonitor.org/changelog-sniffer Sniffer Changelog]
 
* [https://www.voipmonitor.org/changelog-gui GUI Changelog]
[[Manual PCAP Extraction from spooldir]]
| style="vertical-align:top; width:33%;" |
 
'''Downloads'''
[[download of pcap files / audio files using GUI's api]]
* [https://www.voipmonitor.org/download Download Center]
 
* [https://github.com/voipmonitor GitHub Repository]
[[check calls duration using sniffer's api]]
| style="vertical-align:top; width:34%;" |
 
'''Support'''
[[Re-install the GUI]]
* [https://www.voipmonitor.org/vmchat-ui.php '''🤖 AI Support''']
 
* [https://www.voipmonitor.org/support Contact Support]
[[ChunkPlayer]]
* [[FAQ|FAQ]]
 
|}
[[IO Measurement]]
 
[[Google Sign in usage]]
 
[[Microsoft Sign in usage]]
 
[[SSL/TLS connection to the Mysql/MariaDB]]
 
[[ProxySQL]]
 
[[Mysql master-master replication hints]]


[[Mysql master-slave replication hints]]


[[Napatech]]


= troubleshooting =
== AI Summary for RAG ==


[[Cannot download pcap/audio from spooldir when using chrome and nginx]]
'''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.


= Resources =
'''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


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

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"