Homer

HOMER - 100% Open-Source SIP, VoIP, RTC Packet Capture & Monitoring

Programming language: Shell

License: GNU Affero General Public License v3.0

Tags: Communication systems     SIP    

Latest version: v5.0.1

README

HOMER

100% Open-Source VoIP & RTC Capture, Troubleshooting & Monitoring

HOMER is a robust, carrier-grade, scalable Packet and Event capture system and VoiP/RTC Monitoring Application based on the HEP/EEP protocol and ready to process & store insane amounts of signaling, rtc events, logs and statistics with instant search, end-to-end analysis and drill-down capabilities.

HOMER is already used by large enterprises, voice network operators, voip service providers and traffic carriers worldwide, has been implemented as a service in 3rd party voice platforms and is suitable for production.

HOMER 7+ is designed and delivered as a set of modular components and building blocks to be used stand-alone or in combination with other platforms.

Core Features

• Based on HEP Encapsulation, available everywhere
• Stand-Alone Capture Servers & Agents for any OS
• Supports advanced SIP, RTP/RTCP Reports, RTC Events and Custom protocols
• Multiple Database backend support for Packets, Logs, Timeseries in parallel
• Dynamic Mapping and Correlation for internal and external data sources
• Made by Humans, and Supported by the best community ever

Introduction

Unlike its predecessors, HOMER Seven is completely dynamic, meaning there are many database, timeseries and logging backend combinations possible - even at the same time! This opens up a number of new use-case options some users might find overwhelming at first - don't worry, its just about freedom of choice! If you're unsure or just want a stand-alone capture system, please consider using the below options or joining our friendly users mailing list where our community will welcome and help you move the first steps.

Installation

Ready to Install HOMER? Choose your preferred method from our Wiki :thumbsup:

Support

For community support, updates, user discussion and experience exchange please join our Matrix channel and Mailing-List. If you'd like to help the project or donate resources, drop us an email at [email protected]

For professional support, remote setups, customizations or commercial licensing please contact the QXIP Team at http://qxip.net

---

Presentations

If you'd like to get an idea about what HOMER is and what HOMER does, consider watching one of our presentations or workshops:

• HOMER 7: Workshop at @Cluecon 2021
• HOMER 7: Workshop @OpenSIPS Summit 2020
• HOMER 7: Mapping Insights with @adubovikov
• HOMER 7: The Power of Timeseries & Machine Learning @Voip2Day 2018 spanish
• HOMER 7: RTC Features @OpenSIPS Summit 2019
• HOMER 7: Docker Workshop @KamailioWorld 2019

<!--

:hand: Manual Setup

Installing HOMER 7.x is simple and does not require skills other than patience.

Requirements

Before proceeding, install the database requirements for HOMER 7.7:

• Postgres 11+ w/ root account for DATA and API
• Prometheus or InfluxDB for TIMESERIES
• (optional) Loki for LOGS

Once ready, proceed to install your HEP Stack:

• Install the sipcapture package repositories
• Install heplify-server
  • Configure with your Postgres instance for storing DATA
  • Configure with your Loki instance for storing LOGS
  • Configure Prometheus scrapers to HOMER:9096/metrics
• Install homer-app
  • Configure with your Postgres instance for API
  • Configure with your Prometheus or InfluxDB instances for reading TIMESERIES
  • Configure with your Loki instance for reading LOGS
• Install and Configure a HEP Capture Agent
  • Install heplify on a host with SIP/RTCP traffic
  • Configure with your SIP/RTCP portrange and send HEP traffic to heplify-server on port 9060
    • example: ./heplify -i eth0 -pr 5060-5080 -hs 10.20.30.40:9060
  • Use a native HEP client in Kamailio, OpenSIPS, Asterisk, Freeswitch and others
• Start your services and login on port 9080 as admin with password sipcapture (change it!)

---

:whale: Docker Containers

Starting Fresh or Testing? A ready to fire set of Docker containers is available in many flavours, ready to capture in minutes!

---

:package: BASH Script

Installing on a fresh, dedicated all-in-one server? Try our installer script supporting the latest Debian and CentOS releases.

-->

Developers

Contributors and Contributions to our project are always welcome! Developers and Users can coordinate with the existing team via our Matrix channel. If you'd like to join our internal team and volunteer to help with the project's many needs, feel free to contact us anytime!

⭐️ Project Assistance

If you want to say thank you or/and support active development:

• Add a GitHub Star to the project.
• Tweet about our project on Social Media @qxip @sipcapture
• Contribute guides and articles about our project on Dev.to, Medium, personal blog, etc.

License & Copyright

Homer components are released under the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

(C) 2008-2022 QXIP BV

---

Made by Humans

This Open-Source project is made possible by actual Humans without corporate sponsors, angels or patreons. If you use this software in production, please consider supporting its development with contributions or donations