Skip to main content
Version: 10.1

Getting Started

Welcome to the documentation for the FRAFOS Monitor, your VoIP SBC (Session Border Controller) and WebRTC Gateway monitoring software!

This guide will help you understand, deploy, and operate your VoIP monitoring solution, including dashboards, environment configuration, and troubleshooting tips.

What is FRAFOS Monitor?​

FRAFOS Monitor is a comprehensive monitoring solution that provides real-time visibility into the health, performance, and security of your VoIP infrastructure. It continuously tracks calls, registrations, alerts, and system metrics - enabling you to:

  • Ensure call quality and reliability
  • Detect and respond to security threats
  • Monitor SIP endpoints and registration status
  • Analyze traffic patterns and usage
  • Integrate with external systems (using APIs)

Key Features​

  • Dashboards: Real-time and historical views of call activity, alerts, and system status. See the Dashboards Overview and other dashboard guides for details.
  • Environment Variable Reference: Auto-generated documentation for all configuration options. See Environment Variables Reference.
  • Setup Guides: Step-by-step instructions for deployment and integration. See Installation Guide for Docker, Podman, and Kubernetes setups.
  • API Reference: Details for advanced integration and automation. The API section is a work in progress; check API Intro for updates.
  • Troubleshooting: Common issues and solutions for VoIP monitoring environments. Troubleshooting tips are included in dashboard and installation guides (e.g., Live Calls Troubleshooting).

Typical Deployment Steps​

  1. Prepare your environment (Linux server, Docker, Node.js, etc.)
  2. Configure environment variables for your VoIP SBC, monitoring stack, and integrations (see reference)
  3. Deploy the monitoring software using Docker, Kubernetes, or manual installation (see installation guide)
  4. Access dashboards and documentation via the web interface (see dashboard guides)
  5. Monitor, analyze, and respond to system events and alerts (see alerts and troubleshooting)

Documentation Structure​

  • Dashboards Overview: Visual guides for monitoring and analytics (see dashboards)
  • Environment Variables: Reference for all supported configuration options (see env.mdx)
  • Setup & Integration: Instructions for connecting to VoIP SBCs, databases, and storage (see installation guide)
  • API & Automation: Details for extending and automating your monitoring stack (see API Intro)
  • Troubleshooting & Support: Help for common issues and links to community resources (see troubleshooting)

Found a Bug?​

If you discover a bug or issue with the monitoring software or documentation, please open a support ticket.

Ready to get started? Explore the sidebar for guides, reference material, and best practices for VoIP SBC monitoring!