{"id":31527830,"url":"https://github.com/theelephantcoder/znail-docker","last_synced_at":"2026-02-16T17:33:52.883Z","repository":{"id":315938021,"uuid":"1061000359","full_name":"TheElephantCoder/Znail-Docker","owner":"TheElephantCoder","description":"This repository contains the source code for the unofficial Docker Image for Znail, a network emulator that is intended to run on a Raspberry Pi. ","archived":false,"fork":false,"pushed_at":"2025-10-20T19:26:11.000Z","size":48,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-20T21:25:39.187Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","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/TheElephantCoder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"custom":"btc:bc1qt5rwjpmf9fawpssfegrp7chnwud3rt9vct4vwg"}},"created_at":"2025-09-21T03:07:47.000Z","updated_at":"2025-10-20T19:25:52.000Z","dependencies_parsed_at":"2025-10-03T22:48:13.027Z","dependency_job_id":"8650f6fa-e823-428e-a32f-7f79c35941b6","html_url":"https://github.com/TheElephantCoder/Znail-Docker","commit_stats":null,"previous_names":["theelephantcoder/znail-dockerized","theelephantcoder/znail-docker"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/TheElephantCoder/Znail-Docker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheElephantCoder%2FZnail-Docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheElephantCoder%2FZnail-Docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheElephantCoder%2FZnail-Docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheElephantCoder%2FZnail-Docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheElephantCoder","download_url":"https://codeload.github.com/TheElephantCoder/Znail-Docker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheElephantCoder%2FZnail-Docker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29513989,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-16T09:05:14.864Z","status":"ssl_error","status_checked_at":"2026-02-16T08:55:59.364Z","response_time":115,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":"2025-10-03T22:47:46.688Z","updated_at":"2026-02-16T17:33:52.860Z","avatar_url":"https://github.com/TheElephantCoder.png","language":"Dockerfile","readme":"# 🌐 Znail Network Emulator - Dockerized 🚀\n\n![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge\u0026logo=github\u0026logoColor=white) ![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge\u0026logo=python\u0026logoColor=ffdd54) ![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge\u0026logo=linux\u0026logoColor=black) ![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge\u0026logo=docker\u0026logoColor=white) ![YAML](https://img.shields.io/badge/yaml-%23ffffff.svg?style=for-the-badge\u0026logo=yaml\u0026logoColor=151515) ![Raspberry Pi](https://img.shields.io/badge/-Raspberry_Pi-C51A4A?style=for-the-badge\u0026logo=Raspberry-Pi) ![Gunicorn](https://img.shields.io/badge/gunicorn-%298729.svg?style=for-the-badge\u0026logo=gunicorn\u0026logoColor=white) ![Flask](https://img.shields.io/badge/flask-%23000.svg?style=for-the-badge\u0026logo=flask\u0026logoColor=white)\n\n\n\n\n\nWelcome to the **Dockerized Znail Network Emulator**! 🎉\\\nZnail lets you emulate real-world network conditions (latency, bandwidth\nlimits, packet loss, etc.) using Linux **tc/netem**.\\\nThis Docker image makes it easy to run Znail on your favorite device,\nincluding **Raspberry Pi** 🥧.\n\n------------------------------------------------------------------------\n\n## ✨ Features\n\n-   🐳 Fully containerized Znail (no extra setup required)\n-   ⚡ Runs on **amd64**, **arm64**, and **arm/v7** (works on Raspberry\n    Pi)\n-   🛠️ Traffic shaping using `tc/netem`\n-   📊 Web UI served via Flask + Gunicorn\n-   ❤️ Includes `/healthz` endpoint for monitoring\n\n------------------------------------------------------------------------\n\n## 📥 How to Run\n\n### 🔹 Quick Start\n\n``` bash\ndocker run -d --name znail   --net=host   --privileged   --restart unless-stopped   ghcr.io/TheElephantCoder/znail-docker:latest\n```\n\n👉 Open your browser: \u003chttp://localhost:5000\u003e\\\n(or replace `localhost` with your Raspberry Pi's IP).\n\n### 🔹 With Docker Compose\n\n`docker-compose.yml`:\n\n``` yaml\nservices:\n  znail:\n    image: ghcr.io/TheElephantCoder/znail-docker:latest\n    container_name: znail-docker\n    network_mode: host\n    privileged: true\n    restart: unless-stopped\n```\n\nRun:\n\n``` bash\ndocker compose up -d\n```\n\n---------------------------------\n\n## 🛠️ Build Instructions\n\nBuild locally if you want to customize or develop Znail:\n\n``` bash\ngit clone https://github.com/znailnetem/znail.git\ncd znail\n\n# Build the Docker image\ndocker build -t znail-local .\n\n# Run it\ndocker run -d --name znail   --net=host   --privileged   znail-local\n```\n\nMulti-arch build (e.g., amd64, arm64, arm/v7):\n\n``` bash\ndocker buildx create --use --name znailbuilder\ndocker run --privileged --rm tonistiigi/binfmt --install all\n\ndocker buildx build   --platform linux/amd64,linux/arm64,linux/arm/v7   -t ghcr.io/znailnetem/znail:latest   --push .\n```\n\n------------------------------------------------------------------------\n\n## 🔍 Health Check\n\nCheck if Znail is alive:\n\n``` bash\ncurl -sf http://localhost:5000/healthz\n# -\u003e ok\n```\n\n------------------------------------------------------------------------\n\n## ⚠️ Notes\n\n-   🖧 Znail is designed to be placed **in-line between two network\n    interfaces** (for example, Ethernet + USB NIC) to actually intercept\n    and shape traffic.\n-   🛡️ Requires `--privileged` for `tc/netem` access.\n-   🌍 No license file currently provided.\n\n------------------------------------------------------------------------\n\n## 🙏 Credits\n\nZnail-Docker is **not a fork of Znail itself**, but a containerization project to make it easier to run Znail in Docker.\n\n- **Znail Network Emulator**  \n  Created and maintained by the [Znail team](https://github.com/znailnetem/znail).  \n  This project would not exist without their excellent work on the emulator.\n\n- **Dockerization \u0026 Multi-Arch Build**  \n  Packaged and maintained by [TheElephantCoder](https://github.com/TheElephantCoder).\n\n- **Libraries / Tools**  \n  - [Flask](https://palletsprojects.com/p/flask/) – web framework  \n  - [Flask-RESTX](https://github.com/python-restx/flask-restx) – API toolkit (used as replacement for flask-restplus)  \n  - [Gunicorn](https://gunicorn.org/) – WSGI server for production  \n  - [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) – multi-arch image builds\n\nIf you use or build on this image, please consider ⭐ starring the [original Znail repository](https://github.com/znailnetem/znail) to support the upstream project. All proceeds from Sponsorships for this repo will go to the original Znail Repository.\n\n------------------------------------------------------------------------\n\n🎯 Now you're ready to emulate networks with **Znail in Docker**! 🎯\n","funding_links":["btc:bc1qt5rwjpmf9fawpssfegrp7chnwud3rt9vct4vwg"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheelephantcoder%2Fznail-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheelephantcoder%2Fznail-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheelephantcoder%2Fznail-docker/lists"}