Skip to content

Commit de7a955

Browse files
adding docker README bits
1 parent 1a81d89 commit de7a955

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ This project provides a set of scanners that use regular expressions to try and
4343
information, such as API keys, passwords, and personal information. It includes a set of regular expressions by
4444
default, but also accepts a JSON object containing your custom regular expressions.
4545

46-
## How to install
46+
## How to install using downloaded binaries
4747
Download and unzip the [latest ZIP](https://github.com/newrelic/rusty-hog/releases/)
4848
on the releases tab. Then, run each binary with `-h` to see the usage.
4949

@@ -53,6 +53,15 @@ unzip rustyhogs-musl_darwin_1.0.7.zip
5353
darwin_releases/choctaw_hog -h
5454
```
5555

56+
## How to run using DockerHub
57+
Rusty Hog Docker images can be found at the authors personal DockerHub page [here](https://hub.docker.com/u/wetfeet2000)
58+
A Docker Image is built for each Hog and for each release. So to use choctaw_hog you would run the following commands:
59+
60+
```shell script
61+
docker pull wetfeet2000/choctaw_hog:1.0.7
62+
docker run -it --rm wetfeet2000/choctaw_hog:1.0.7 --help
63+
```
64+
5665
## How to build
5766
- Ensure you have [Rust](https://www.rust-lang.org/learn/get-started) installed and on your path.
5867
- Clone this repo, and then run `cargo build --release`. The binaries are located in `target/release`.

build_docker.sh

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
docker system prune -a
2+
cargo clean
13
docker build --tag wetfeet2000/ankamali_hog:$1 --build-arg HOG=ankamali .
24
docker push wetfeet2000/ankamali_hog:$1
35
docker build --tag wetfeet2000/berkshire_hog:$1 --build-arg HOG=berkshire .

0 commit comments

Comments
 (0)