HOMER 7.x (Seven)

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

🚧 This is a work in progress, the process and instructions might change at any give time.

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 usure or just want a stand-alone capture system, please consider using our Installation Script on a vanilla system, launching our ready-to-go Docker containers, or joining our users mailing list where our community will welcome and help you move the first steps.

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: The Power of Timeseries & Machine Learning @Voip2Day 2018 spanish
HOMER 7: RTC Features @OpenSIPS Summit 2019
HOMER 7: Docker Workshop @KamailioWorld 2019

Installation

Ready to Install? Choose your preferred method from the following:

📦 Docker Containers

Starting Fresh or Testing? A ready to fire set of containers is available in many flavours:

📦 BASH Script

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

📦 Manual Mode (dev only)

Unlike its predecessors, HOMER Seven is completely dynamic, meaning there are many database, timeseries and logging backend combinations possible. Before installing the user should determine preferences and settings for each component. Not for first time users!

⚠️ Requirements

API + UI
- NodeJS 8.x+
DATA STORAGE (choose one)
- Postgres 9.x
- Elasticsearch
- Loki
TIMESERIES (choose one)
- InfluxDB
- Prometheus
- Elasticsearch

📦 Deploy HEP Capture Server (CS)

Install a HEP Capture Server based on your needs and preferences:

HEPlify-server ⭕ CS developed in go, ideal for heavy HEP packet loads
HEPop: ⭕ CS developed in nodejs, ideal for RTC events and JSON streams
- Configure HEP sockets
- Configure connectivity to DB and Timeseries DB

📦 Deploy a HOMER webapp

Install the Homer App

HOMER-APP ⭕ API + UI developed in nodejs, self-served
- Configure connectivity to DB and Timeseries DB
- Configure user access preferences

📦 Deploy a Capture Agent (CA)

Install a HEP Capture Agent based on your needs and preferences:

HEPlify ⭕ CA developed in go, portable, near zero configuration
CaptAgent: ⭕ CA developed in C, ideal for complex configurations
- Configure Capture settings
- Configure connectivity to HEP server
Native ⭕ Native HEP Agents in OpenSIPS, Kamailio, Asterisk, Freeswitch, RTP:Engine and more

Support

For professional support, remote installations, customizations or commercial requests please contact: [email protected]

For community support, updates, user discussion and experience exchange please join our users Mailing-List

For commercial licensing and support, please contact the QXIP Team at [http://qxip.net]

Developers

Contributors and Contributions to our project are always welcome! If you intend to participate and help us improve HOMER by sending patches, we kindly ask you to sign a standard CLA (Contributor License Agreement) which enables us to distribute your code alongside the project without restrictions present or future. It doesn’t require you to assign to us any copyright you have, the ownership of which remains in full with you. Developers can coordinate with the existing team via the homer-dev mailing list. 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!

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.

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

sts0mrg0 / homer Goto Github PK

homer's Introduction