Documentation

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: Install Sniffer - Download and configure Install GUI - Web interface setup Configure voipmonitor.conf 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: Upgrade: Sniffer \| GUI Troubleshoot: Sniffer \| GUI \| Database Scale: Performance \| HA Quick Links: FAQ \| Glossary \| License Uninstall VoIPmonitor

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
Installation Guide - Binary download and setup Configuration Reference - voipmonitor.conf Systemd Service - Service management Upgrade Guide - Update to latest version	Installation Guide - PHP, database, IonCube Reinstall/Upgrade - Update existing License Activation - Trial and commercial Uninstall - Complete removal

Architecture & Deployment

System Design	Deployment Modes	Multi-Sensor
Architecture Overview - Components and data flow Sniffer Internals - Deep dive Database Schema - CDR tables	Sniffing Modes - SPAN, TAP, tunnels Distributed Architecture - Client/server Cloud Deployment - Hosted service	Multiple Instances - Multi-sensor setup Promiscuous Mode - Interface config

Configuration

Sniffer Configuration	GUI Configuration
voipmonitor.conf Reference - All parameters Capture Rules - Filter SIP/RTP by IP, port, patterns IPv6 Processing - Enable IPv6 support Milliseconds Precision - High-precision timing	configuration.php - PHP settings GUI Settings - System options Network Interface - Promiscuous mode

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
SIP Protocol - Session Initiation Protocol deep dive RTP Protocol - Real-time Transport and quality metrics WebRTC Protocol - Browser-based VoIP Voice Quality Guide - MOS, jitter, packet loss SS7 Signaling - Legacy telephony	TLS/SRTP - Encrypted SIP/RTP decryption DTLS - Datagram TLS for WebRTC MySQL TLS - Encrypted database connections

GUI Features

Call Analysis

CDR & Calls CDR Browser - Main call interface Active Calls - Real-time monitoring Live Sniffer - Packet capture	Correlation Call Correlation - Link call legs CDR Summary - Aggregated stats	Visualization Charts - Time-series graphs Dashboard - Customizable panels Reports - Scheduled exports	Quality NER - Network Effectiveness Ratio Silence Detection - Audio analysis

Monitoring & Alerts

Alerts Alert System - Email notifications Fraud Detection - GeoIP alerts	SIP Monitoring SIP Register - Registration tracking Active Registrations - Current state OPTIONS/SUBSCRIBE - Availability	Other SIP Messages - Instant messaging Issue Tracker - Ticketing system

User & Access Management

User Management - Accounts and permissions Groups - IP/number grouping Country Grouping - GeoIP grouping Billing - Rate calculations Glossary - Terminology

Security & Authentication

Authentication Methods	Security & Privacy
Two-Factor Auth - TOTP setup Authentication Overview - All methods Google Sign-In - OAuth Microsoft Sign-In - Azure AD REMOTE_USER - Shibboleth, SAML	Security Best Practices HTTPS & Basic Auth Data Privacy & Masking - IP anonymization CALEA Compliance - Lawful intercept

Database

Setup & Structure	Troubleshooting & Maintenance
Database Schema - Table reference MySQL 5.7 - Version specifics MySQL 8 Upgrade - Compatibility fixes Upgrade to BigInt - Large deployments	Database Troubleshooting - Common issues Table Recovery - Repair procedures SQL Queue Issues - Peak time handling HAProxy/ProxySQL - Load balancing

High Availability & Replication

HA & Failover Overview - Strategies Galera Cluster - Multi-master setup Database Redundancy - Options	Master-Slave Replication Master-Master Replication

Performance & Scaling

Optimization	Hardware Acceleration	System Tuning
Scaling Guide - Large deployments High-Performance Setup Performance Tuning Performance Logs	DPDK - 6+ Gbit/s capture Napatech Cards - SmartNIC Hardware Requirements	DB Bottlenecks Swap Configuration Hugepages Jemalloc - Memory allocator

Troubleshooting

General FAQ Emergency Procedures	Sniffer Sniffer Issues I/O Measurement	GUI GUI Issues	Database Database Issues Table Recovery

API & Integration

APIs	Integrations
REST API - HTTP API reference Manager API - TCP port 5029 PCAP/Audio Download - File API ChunkPlayer - Live audio streaming	EasyCallerID - CallerID lookup Collectd - System monitoring Nagios - Nagios integration Nginx - Reverse proxy

Maintenance & Backup

Upgrade Sniffer Upgrade GUI Reinstall	Backup GUI Backup Table Backup Disaster Recovery	Maintenance Data Cleaning - Cleanspool Reprocess Calls Safe Shutdown

Advanced Features

Whisper - Speech-to-text transcription Silence Detection - Audio analysis Audio Codecs Guide Manual PCAP Extraction	CDR Delay Optimization IP Accounting

Tools & Utilities

Built-in Tools - Overview Git - Repository access SoX - Audio processing Tshark - Wireshark CLI	Batch Download Script Probe Backup Script

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?