From 9739c9845cd771e9902aa1c992c8d82c909e32d2 Mon Sep 17 00:00:00 2001 From: htrgouvea Date: Mon, 8 Jul 2024 20:59:19 -0300 Subject: [PATCH] documentation about nipe container --- Dockerfile | 8 +------- README.md | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/Dockerfile b/Dockerfile index 5d261af..cc4a5f3 100644 --- a/Dockerfile +++ b/Dockerfile @@ -18,10 +18,4 @@ RUN cpanm --installdeps . RUN chmod +x nipe.pl -# docker run -d -it --privileged --cap-add=NET_ADMIN nipe -# OR -# docker run -d -it --name nipe-container --privileged --cap-add=NET_ADMIN nipe -# THEN -# docker exec -it ./nipe.pl - -ENTRYPOINT ["/bin/bash"] +ENTRYPOINT ["/bin/bash"] \ No newline at end of file diff --git a/README.md b/README.md index f4c6d26..4e11104 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,22 @@ All non-local UDP/ICMP traffic is also blocked by the Tor project. --- +### Docker container + +```bash +# Building the container +$ docker build -t nipe . + +# Setup the Nipe container +$ docker run -d -it --name nipe-container --privileged --cap-add=NET_ADMIN nipe + +# Running commands +$ docker exec -it nipe-container ./nipe.pl + +``` + +--- + ### Contribution Your contributions and suggestions are heartily ♥ welcome. [See here the contribution guidelines.](/.github/CONTRIBUTING.md) Please, report bugs via [issues page](https://github.com/htrgouvea/nipe/issues) and for security issues, see here the [security policy.](/SECURITY.md) (✿ ◕‿◕)