Documentation

VoIPmonitor Documentation

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

Getting Started

New to VoIPmonitor?	Already Installed?
Quick Start Checklist: Register at www.voipmonitor.org Get a 30-day free trial license 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 Follow OS installation guide below Configure the Sniffer Explore the CDR Browser 💡 Tip: Need help? Contact VoIPmonitor support for a free Google Meet installation assistance session.	Common Tasks: Upgrade: Sniffer \| GUI Troubleshoot: Sniffer \| GUI \| Database Scale: Performance Tuning API: REST API Reference Quick Links: Frequently Asked Questions Glossary of Terms License Management

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 / Alma	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
Install Sniffer - Download and run installer Configure voipmonitor.conf - Database, interface Choose Capture Mode - SPAN, ERSPAN, tunnels Start Service - systemctl commands	Install GUI or Reinstall Create Users - Accounts and permissions Configure Settings - Sensors, system options 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?