{"id":15288871,"url":"https://github.com/stefandeveloper/heidpi","last_synced_at":"2025-09-11T21:12:04.959Z","repository":{"id":65485893,"uuid":"578523170","full_name":"stefanDeveloper/heiDPI","owner":"stefanDeveloper","description":"nDPId Docker Image for packet inspection","archived":false,"fork":false,"pushed_at":"2024-11-25T09:52:52.000Z","size":14633,"stargazers_count":0,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-07T04:45:57.789Z","etag":null,"topics":["docker","docker-image","dpi","libndpi","linux","ndpi","ndpid"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stefanDeveloper.png","metadata":{"files":{"readme":"README.consumer.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}},"created_at":"2022-12-15T09:01:47.000Z","updated_at":"2024-11-25T09:52:56.000Z","dependencies_parsed_at":"2024-01-30T11:30:53.645Z","dependency_job_id":"1595ff78-da70-49f5-a6f6-c5766ba17cca","html_url":"https://github.com/stefanDeveloper/heiDPI","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefanDeveloper%2FheiDPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefanDeveloper%2FheiDPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefanDeveloper%2FheiDPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefanDeveloper%2FheiDPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stefanDeveloper","download_url":"https://codeload.github.com/stefanDeveloper/heiDPI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252816520,"owners_count":21808702,"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","docker-image","dpi","libndpi","linux","ndpi","ndpid"],"created_at":"2024-09-30T15:53:56.254Z","updated_at":"2025-09-11T21:12:04.924Z","avatar_url":"https://github.com/stefanDeveloper.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![heiFIP Logo](https://raw.githubusercontent.com/stefanDeveloper/heiDPI/main/assets/heidpi_logo.png?raw=true)\n\n\n--------------------------------------------------------------------------------\n\n[nDPId](https://github.com/utoni/nDPId) Docker Image for deep packet inspection. As described in [nDPId](https://github.com/utoni/nDPId/blob/main/README.md), we split the image into producer and consumer image for a more generic purpose. For the producer, the image starts the UNIX and UDP socket and nDPId respectively. Via environment variables, users can adapt the nDPId daemon and nDPIsrvd. As by now, we support all current nDPId parameters.\n\n\u003ctable\u003e\n\u003ctr\u003e\n  \u003ctd\u003e\u003cb\u003eProject License\u003c/b\u003e\u003c/td\u003e\n  \u003ctd\u003e\n    \u003ca href=\"https://github.com/stefanDeveloper/heidpi/blob/main/LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/l/heidpi?logo=gnu\u0026style=for-the-badge\u0026color=blue\" alt=\"License\" /\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n  \u003ctd\u003e\u003cb\u003eContinuous Integration\u003c/b\u003e\u003c/td\u003e\n  \u003ctd\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/stefanDeveloper/heifip/actions/workflows/docker-publish-consumer.yml\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/actions/workflow/status/stefanDeveloper/heidpi/docker-publish-consumer.yml?branch=main\u0026logo=docker\u0026style=for-the-badge\u0026label=docker\" alt=\"Docker WorkFlows\" /\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n## Getting Started\n\nInstall using PyPi:\n\n```sh\ncd ./heidpi-logger \u0026\u0026 cmake . \u0026\u0026 make\n```\n\nUse the CLI for quick usage:\n\n```\n\u003e ./heidpi_cpp -h\nusage: heidpi_cpp [-h] [--host HOST | --unix UNIX] [--port PORT] [--write WRITE]\n            [--config CONFIG] [--filter FILTER]\n            [--show-daemon-events]\n            [--show-packet-events]\n            [--show-error-events]\n            [--show-flow-events]\n```\n\n### Prerequisities\n\n\nIn order to run this container you'll need docker installed.\n\n* [Windows](https://docs.docker.com/windows/started)\n* [OS X](https://docs.docker.com/mac/started/)\n* [Linux](https://docs.docker.com/linux/started/)\n\n### Usage\n\nPull images:\n\n```sh\ndocker pull stefan96/heidpi-producer:main\ndocker pull stefan96/heidpi-consumer:main\n```\n\nRun producer and consumer separately from each other using UDP socket:\n\n```sh\ndocker run -p 127.0.0.1:7000:7000 --net host stefan96/heidpi-producer:main\ndocker run -e HOST=127.0.0.1 --net host stefan96/heidpi-consumer:main\n```\n\nor use the `docker-compose.yml`:\n\n```sh\ndocker-compose up\n```\n\nAdditionally, you use a UNIX socket:\n\n```sh\ndocker run -v ${PWD}/heidpi-data:/tmp/ --net host stefan96/heidpi-producer:main\ndocker run -v ${PWD}/heidpi-data:/tmp/ -v ${PWD}/heidpi-logs:/var/log -e UNIX=/tmp/nDPIsrvd-daemon-distributor.sock --net host stefan96/heidpi-consumer:main\n```\n\n## Environment Variables\n\n### Consumer\n\n| Variable                     | Type    | Default           |\n|------------------------------|---------|-------------------|\n| `UNIX` | `string` | |\n| `HOST` | `string` | |\n| `PORT` | `int` | 7000 |\n| `JSON_PATH` | `string` | `/var/log/nDPIdsrvd.json` |\n| `SHOW_ERROR_EVENTS` | `int` | 0 |\n| `SHOW_DAEMON_EVENTS` | `int` | 0 |\n| `SHOW_PACKET_EVENTS` | `int` | 0 |\n| `SHOW_FLOW_EVENTS` | `int` | 1 |\n| `MAX_BUFFERED_LINES` | `int` | 1024 |\n\n### Config file\n\nYou can change the default configuration by mounting a config file `/usr/src/app/config.yml`:\n\n```yaml\nflow_event:\n  ignore_fields: []\n  flow_event_name:\n    - update\n    - end\n    - idle\n    - detected\n  filename: flow_event\n  threads: 25\n```\n\n## License\n\nThis project is licensed under the GPL-3.0 license - see the [LICENSE.md](LICENSE.md) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstefandeveloper%2Fheidpi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstefandeveloper%2Fheidpi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstefandeveloper%2Fheidpi/lists"}