Documentation

From VoIPmonitor.org


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

Installation Guide Architecture FAQ

Installation by OS

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

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 Security updates until 2025
18.04 LTS EOL Upgrade recommended
Debian 13 (Trixie) Recommended Latest stable release
12 (Bookworm) Supported Previous stable
11 (Bullseye) Supported Previous stable, LTS until 2026
10 (Buster) Maintenance ELTS until 2029
Rocky Linux Rocky 10 Recommended Latest RHEL 10 compatible
Rocky 9 Supported RHEL 9 compatible, support until 2032
AlmaLinux AlmaLinux 10 Recommended Latest RHEL 10 compatible
AlmaLinux 9 Supported RHEL 9 compatible
CentOS CentOS 8 Stream Maintenance Use Rocky/Alma for new installs
CentOS 7 EOL Migrate to Rocky/Alma
FreeBSD FreeBSD 11+ Supported See also FreeBSD, FreeBSD10

For legacy systems: Outdated Distributions Guide (CentOS 5/6, Debian 6-9, Ubuntu 12-16, Gentoo, ARM)

Quick Start After OS Selection

Sniffer (Sensor) Installation Web GUI Installation

Sniffer Installation Guide - Complete setup instructions

After installation:

GUI Installation Guide - Fresh install

Reinstall/Upgrade GUI - Update existing installation

After installation:

Getting Started

New to VoIPmonitor? Already Installed?

1. Understand the Architecture - How components work together
2. Choose your OS above and follow the installation guide
3. Configure the Sniffer - Essential settings
4. Explore the GUI - Feature overview

Upgrade: Sniffer | GUI
Troubleshoot: Sniffer Issues | GUI Issues
Scale: Performance Tuning | High Availability
API: REST API Reference

Sniffer (Sensor)

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

Setup & Configuration Capture Modes Operations Troubleshooting

Installation Guide
Static binary setup for all Linux

Configuration Reference
voipmonitor.conf parameters

Database Schema
CDR table structure

Systemd Service
Service management

Sniffing Modes
Mirror port, SPAN, ERSPAN

Distributed Mode
Client/Server architecture

SIPREC Recording
SBC-based call recording

Capture Rules
Filter what gets recorded

Data Retention
Cleanup and rotation policies

Upgrade Guide
Update to latest version

Performance Tuning
High-traffic optimization

Database Redundancy
Replication setup

Troubleshooting Guide
Common issues & solutions

Performance Logs
Interpret t0CPU, SQLq, etc.

Memory Issues
Debugging memory usage

Capture Problems
Why calls not captured

Protocols & Advanced

VoIP Protocols Encryption & Security Hardware & Performance

SIP Protocol
Session Initiation Protocol

RTP Protocol
Real-time Transport

WebRTC
Browser-based VoIP

SS7 Signaling
Legacy telephony

AudioCodes Tunneling
Proprietary protocol

TLS/SRTP
Encrypted SIP/RTP

DTLS
Datagram TLS for WebRTC

Manager API Encryption
Secure API access

SSH Public Key
Remote access setup

Hardware Requirements
Sizing guide

DPDK
Data Plane Development Kit

Napatech Cards
Hardware acceleration

Hugepages
Memory optimization

Multiple Instances
Multi-sensor setup

Performance & Memory

Memory Management Monitoring & Logging Utilities & Scripts

jemalloc
Memory allocator

tcmalloc
Google allocator

CPU Affinity
Core pinning

I/O Monitoring
Disk performance

Logging Configuration
Log settings

Syslog Integration
Remote logging

Collectd
System metrics

GDB Debugging
Core dump analysis

PCAP Extraction
Manual export

Audio Creation
From packet dumps

API Duration Check
Call stats

Emergency Procedures
Critical issues

Web GUI

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

Setup & Access Call Analysis Monitoring & Alerts Administration

Installation Guide
Fresh install

Reinstall/Upgrade
Update existing

HTTPS Setup
SSL/TLS configuration

Nginx Configuration
Reverse proxy setup

CDR Browser
Search and filter calls

CDR Aggregation
Statistics and summaries

Live Sniffer
Real-time packet capture

Active Calls
Currently active sessions

Dashboard
Overview and widgets

Alert System
Notifications and triggers

Charts & Graphs
Visual analytics

Network Map
Topology visualization

User Management
Accounts and permissions

GUI Settings
System configuration

Backup & Restore
Configuration backup

REST API
Programmatic access

Features & Tools

Security & Authentication Reporting & Billing Advanced Features

Two-Factor Auth
TOTP authentication

Google Sign-In
OAuth integration

Microsoft Sign-In
Azure AD

Shibboleth/SAML
Enterprise SSO

Automated Login
Scripted access

Report Builder
Custom reports

Billing Module
Cost analysis

Fraud Detection
Anomaly alerts

NER Statistics
Network effectiveness

Country Grouping
Geographic analysis

SIP Register
Registration tracking

SIP Messages
IM/SMS analysis

Issue Tracker
Problem management

Groups
Call grouping

Tools
Utility functions

Integrations

External Monitoring Web Server Data Export

Nagios
Legacy monitoring

Nagios 4
Updated integration

SIP OPTIONS Monitoring
Availability checks

PHP-FPM & Apache
Web server setup

Security Hardening
HTTPS & auth

HAProxy
Load balancing

API Downloads
PCAP/audio export

API Listing
Call list export

PCAP Analysis
Packet inspection

Infrastructure & Scaling

High Availability Database Performance

HA & Failover
Redundancy setup

Galera Cluster
Multi-master MySQL

Cloud Deployment
AWS, GCP, Azure

OpenVPN
Secure tunneling

MySQL TLS
Encrypted connections

Master-Slave
Read replicas

Master-Master
Active-active setup

ProxySQL
Connection pooling

Performance Tuning
Optimization guide

High-Perf Setup
Enterprise config

Swap Configuration
Memory management

SQL Queue Issues
Peak time handling

Voice Quality & Analysis

Quality Metrics Audio Processing

Voice Quality Guide
MOS, R-Factor, impairments explained

Jitter Analysis
Network timing issues

Silence Detection
Audio gap detection

Audio Codecs Guide
G.711, G.729, Opus, etc.

SpanDSP Library
Fax/modem processing

SoX Integration
Audio conversion

Whisper Integration
Speech-to-text

Quick Reference

Changelogs

Reference

External Links

AI Summary for RAG

Summary: Main documentation hub for VoIPmonitor - covers installation by OS, sniffer configuration, web GUI setup, scaling, high availability, and troubleshooting for the open-source VoIP monitoring solution. Keywords: documentation, main page, getting started, installation, gui, sniffer, overview, ubuntu, debian, centos, rocky, alma Key Questions:

  • Where do I start with VoIPmonitor?
  • How do I install VoIPmonitor?
  • What documentation is available?
  • Which Linux distribution should I use?