{"id":15706969,"url":"https://github.com/lmangani/docker-opensips-hepclient","last_synced_at":"2025-07-11T18:39:08.791Z","repository":{"id":88157571,"uuid":"108399993","full_name":"lmangani/docker-opensips-hepclient","owner":"lmangani","description":"OpenSIPS 3.1 HEP Client Container","archived":false,"fork":false,"pushed_at":"2020-10-23T11:16:49.000Z","size":1392,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-12T19:13:29.958Z","etag":null,"topics":["docker","hep","hep3","mi","opensips","rest","rtpengine","xlog"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lmangani.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["lmangani"]}},"created_at":"2017-10-26T11:02:01.000Z","updated_at":"2022-10-24T17:09:27.000Z","dependencies_parsed_at":null,"dependency_job_id":"5dc9ff74-3e77-4322-99c2-5dd845cd2214","html_url":"https://github.com/lmangani/docker-opensips-hepclient","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmangani%2Fdocker-opensips-hepclient","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmangani%2Fdocker-opensips-hepclient/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmangani%2Fdocker-opensips-hepclient/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmangani%2Fdocker-opensips-hepclient/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lmangani","download_url":"https://codeload.github.com/lmangani/docker-opensips-hepclient/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253805848,"owners_count":21967053,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","hep","hep3","mi","opensips","rest","rtpengine","xlog"],"created_at":"2024-10-03T20:31:52.297Z","updated_at":"2025-05-12T19:13:43.292Z","avatar_url":"https://github.com/lmangani.png","language":"Shell","funding_links":["https://github.com/sponsors/lmangani"],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"https://user-images.githubusercontent.com/1423657/55069501-8348c400-5084-11e9-9931-fefe0f9874a7.png\" width=200 /\u003e\n\u003cimg src=\"https://opensips.org/pub/opensips/logos/logo.png\" width=400 /\u003e\n\n\u003cbr\u003e\n\u003cbr clear=both/\u003e\n\n# OpenSIPS 3.1 + HEP\n### [SIP|REST|XLOG|MI] Types\nThis repository provides a proof-of-concept OpenSIPS/RTPEngine/HEP contraption, capable of emitting several advanced **OpenSIPS HEP** Types to **HOMER**/**HEPIC**, not to be used for any production purpose what-so-ever.\n\nThis container will act as an *insecure* pass-through proxy + relay and allow any destination such as your existing SIP PBX for testing and hacking.\n\n\n### Quick Start\nAutomated builds of the image are available on [DockerHub](https://hub.docker.com/r/qxip/homer-hepswitch)\n```sh\n$ docker pull qxip/docker-opensips-hepclient\n```\n\n### Usage\nBuild or pull the image, and customize the settings, and use docker-compose to manage the container:\n```yaml\nversion: '2'\nservices:\n  opensips-hepclient:\n    image: qxip/docker-opensips-hepclient\n    privileged: true\n    restart: always\n    environment:\n      ADVERTISED_RANGE_FIRST: 20000\n      ADVERTISED_RANGE_LAST: 20100\n      HOMER_SERVER: '172.16.90.60'\n      HOMER_PORT: 9060\n    volumes:\n       - /var/lib/mysql\n    ports:\n      - \"5060:5060/udp\"\n      - \"5061:5061/tcp\"\n      - \"20000-20100:20000-20100/udp\"\n```\n```sh\n$ docker-compose up\n```\n\n_NB: Call relay is enabled on this dev image, so all calls will be forwarded in proxy mode, and HEP logs sent to the configured ```$HOMER_SERVER```_\n\n\n### Optional: Custom Build w/ RTPEngine kernel modules\nIn order for RTPEngine to insert and use its kernel modules on a given system, the container must be built for the specific underlying OS kernel version. Please use the ```dev``` branch to produce a source-compiled build.\n```\ngit clone https://github.com/lmangani/docker-opensips-hepclient\ncd docker-opensips-hepclient\ndocker build -t qxip/docker-opensips-hepclient .\n```\n\n------------\n\n## HEP Configuration\nThe following key configuration elements control the new HEP features in OpenSIPS 3.1\n\n### Trace modules\n```\n### Configure an HEP Endpoint\nloadmodule \"proto_hep.so\"\nmodparam(\"proto_hep\", \"hep_id\", \"[hid]127.0.0.1:9060;transport=udp;version=3\")\n#### Configure Tracer to use HEP Protocol \nloadmodule \"tracer.so\"\nmodparam(\"tracer\", \"trace_id\", \"[tid]uri=hep:hid\")\n```\n\n### HEP Route\n```\nroute[to_homer] {\n\txlog(\"SCRIPT:DBG: sending message out to Homer\\n\");\n\t# see declaration of tid in trace_id section\n\t$var(trace_id) = \"tid\";\n\t$var(trace_type) = NULL;\n\n\tif (!has_totag()) {\n\t\tif (is_method(\"INVITE\"))\n\t\t\t$var(trace_type) = \"dialog\";\n\t\telse if (!is_method(\"CANCEL\"))\n\t\t\t$var(trace_type) = \"transaction\";\n\t} else if (is_method(\"SUBSCRIBE|NOTIFY\")) {\n\t\t$var(trace_type) = \"transaction\";\n\t} else {\n\t\t$var(trace_type) = NULL;\n\t}\n\n\t# do trace here\n\tswitch ($var(trace_type)) {\n\tcase \"dialog\":\n\t\ttrace(\"$var(trace_id)\", \"d\", \"sip|xlog|rest\");\n\t\tbreak;\n\tcase \"transaction\":\n\t\ttrace(\"$var(trace_id)\", \"t\", \"sip|xlog\");\n\t\tbreak;\n\tcase \"message\":\n\t\ttrace(\"$var(trace_id)\", \"m\", \"sip|xlog\");\n\t\tbreak;\n\t}\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flmangani%2Fdocker-opensips-hepclient","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flmangani%2Fdocker-opensips-hepclient","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flmangani%2Fdocker-opensips-hepclient/lists"}