{"id":13588005,"url":"https://github.com/ntop/docker-ntop","last_synced_at":"2025-05-16T05:03:05.416Z","repository":{"id":42910620,"uuid":"140333989","full_name":"ntop/docker-ntop","owner":"ntop","description":"A collection of Dockerfile for running ntop applications on Docker","archived":false,"fork":false,"pushed_at":"2025-05-13T13:16:31.000Z","size":44,"stargazers_count":356,"open_issues_count":10,"forks_count":37,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-05-13T14:34:59.938Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ntop.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2018-07-09T19:41:17.000Z","updated_at":"2025-05-13T13:16:35.000Z","dependencies_parsed_at":"2024-07-30T17:46:02.054Z","dependency_job_id":"c4b9bd94-9d85-4275-a496-0e3721cb4c2f","html_url":"https://github.com/ntop/docker-ntop","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/ntop%2Fdocker-ntop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntop%2Fdocker-ntop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntop%2Fdocker-ntop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ntop%2Fdocker-ntop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ntop","download_url":"https://codeload.github.com/ntop/docker-ntop/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254471028,"owners_count":22076582,"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":[],"created_at":"2024-08-01T15:06:27.819Z","updated_at":"2025-05-16T05:03:05.350Z","avatar_url":"https://github.com/ntop.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# ntop Dockerfiles\n\nThis repository contains configuration files used to generate Docker images registered on [Dockerhub](https://hub.docker.com/u/ntop).\n\n## Prerequisites\n\nIn order to use the PF_RING tools or take advantage of the PF_RING acceleration when using the ntop\napplications, the PF_RING kernel module and drivers need to be loaded on the host system. Please\nread the instructions in the [PF_RING User's Guide](http://www.ntop.org/guides/pf_ring/get_started/index.html)\nand [Using PF_RING with Docker](https://www.ntop.org/guides/pf_ring/containers/docker.html)\n\n## License Note\n\nCommercial ntop tools require a license which is based on a system identifier which is computed on locally attached network interfaces and other hardware components. If you want to use within all the Docker containers the same license generated for the host OS, the containers must use [host networking](https://docs.docker.com/network/host/) and map the license file from the host. Example:\n\n```bash\ndocker run -it --net=host -v /etc/nprobe.license:/etc/nprobe.license nprobe -i eth1\n```\n\nFor docker-compose, see the [Compose file reference](https://docs.docker.com/compose/compose-file/compose-file-v3/#network_mode).\n\n### Cloud License\n\nWhen running a Cloud license, the application needs to connect to the Cloud and the cloud.conf configuration file is required. Please create it in the container or map the cloud.conf file from the host. Example:\n\n```bash\ndocker run -it --net=host -v /etc/nprobe.license:/etc/nprobe.license -v /etc/ntop/cloud.conf:/etc/ntop/cloud.conf:ro nprobe -i eth1\n```\n\n# Docker Compose\n\nThe following is an example `compose.yml` configuration file to create containers for ntopng, \nan nProbe collector, and a ClickHouse server for [historic flows](https://www.ntop.org/guides/ntopng/clickhouse.html) (included with Enterprise L or better).\nA sample configuration file for running ntopng and ClickHouse is also available under compose/ntopng.\n\nExample `compose.yml` file:\n```\nservices:\n  nprobe_collector:\n    image: ntop/nprobe:stable\n    restart: always\n    network_mode: \"host\"\n    volumes:\n      - /etc/nprobe.license:/etc/nprobe.license:ro\n    command: ['nprobe', '--zmq', '\"tcp://ntopng:5556\"', '--interface', 'none', '-n', 'none', '--collector-port', '2055', '-T', '\"@NTOPNG@\"', '--collector-passthrough']\n\n  ntopng:\n    image: ntop/ntopng:latest\n    restart: always\n    network_mode: \"host\"\n    volumes:\n      - /etc/ntopng.license:/etc/ntopng.license:ro\n    command: ['--interface', 'tcp://*:5556c', '-F', 'clickhouse', '--disable-login'] # , '--insecure']\n    depends_on:\n      - clickhouse\n      - nprobe_collector\n      \n  clickhouse:\n    image: clickhouse/clickhouse-server:latest\n    network_mode: \"host\"\n    restart: always\n    volumes:\n      - clickhouse_data:/var/lib/clickhouse\n      - clickhouse_logs:/var/log/clickhouse-server/\n      \nvolumes:\n  clickhouse_data:\n  clickhouse_logs:\n\n```\n\n# PF_RING Tools\n\n## Install and Run\n\n```bash\ndocker build -t pfring -f Dockerfile.pfring .\ndocker run --net=host pfring pfcount -i eno1\n```\n\nIf you want to use a ZC interface, you need to access the license file from the container,\nyou can use the -v|--volume option for this:\n\n```bash\ndocker run --net=host -v 001122334455:/etc/pf_ring/001122334455 pfring pfcount -i zc:eth1\n```\n\nFor additional info please read the [PF_RING User's Guide](http://www.ntop.org/guides/pf_ring/containers/docker.html)\n\n# ntopng\n\n## Install and Run\n\n```bash\ndocker build -t ntopng -f Dockerfile.ntopng .\ndocker run -it --net=host ntopng -i eno1\n```\n\n# nProbe\n\n## Install and Run\n\n```bash\ndocker build -t nprobe -f Dockerfile.nprobe .\ndocker run -it --net=host nprobe -i eno1\n```\n\n# nTap\n\n## Install and Run\n\n```bash\ndocker build -t nprobe -f Dockerfile.ntap.dev .\ndocker run -it --net=host ntap -i eth0 -c \u003cntap_collector_ip\u003e:1234 -k my_pwd\n```\n# nProbe Cento\n\n## Install and Run\n\n```bash\ndocker build -t cento -f Dockerfile.cento .\ndocker run -it --net=host cento -i eno1\n```\n\n# n2disk\n\n## Install and Run\n\n```bash\ndocker build -t n2disk -f Dockerfile.n2disk .\ndocker run -it --cap-add IPC_LOCK --net=host n2disk -i eno1 -o /tmp\n```\n\nNote: IPC_LOCK is required to use the Direct IO support in n2disk, which required mlock.\n\n# nScrub\n\n## Install and Run\n\n```bash\ndocker build -t nscrub -f Dockerfile.nscrub .\ndocker run -it --net=host nscrub -i eth1 -o eth2\n```\n\nNote: you can configure the application license sharing the license file with the container,\nyou can do this using the -v|--volume option. This applies to all the applications.\n\n```bash\ndocker run -it --net=host -v $(pwd)/nscrub.license:/etc/nscrub.license nscrub -i eth1 -o eth2\n```\n\n# `NTOP_CONFIG` environment variable\n\nYou can pass configuration options also via the `NTOP_CONFIG` environment variable, using the `-e` option. This applies to all the applications.\n\n```bash\ndocker run -it -e NTOP_CONFIG=\"-i eno1\" --net=host ntopng\n```\n\n## ARM\nWhenever the verion of the OS changes, please make sure the docker file for ARM64 is updated\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fntop%2Fdocker-ntop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fntop%2Fdocker-ntop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fntop%2Fdocker-ntop/lists"}