Skip to content

Commit

Permalink
documentation about nipe container
Browse files Browse the repository at this point in the history
  • Loading branch information
htrgouvea committed Jul 8, 2024
1 parent 5c1feff commit 9739c98
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 7 deletions.
8 changes: 1 addition & 7 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -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 <container_id> ./nipe.pl <command>

ENTRYPOINT ["/bin/bash"]
ENTRYPOINT ["/bin/bash"]
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <your command>

```

---

### 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) (✿ ◕‿◕)
Expand Down

0 comments on commit 9739c98

Please sign in to comment.