Skip to content

Commit

Permalink
adding docker README bits
Browse files Browse the repository at this point in the history
  • Loading branch information
cutler-scott-newrelic committed Jul 23, 2020
1 parent 1a81d89 commit de7a955
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ This project provides a set of scanners that use regular expressions to try and
information, such as API keys, passwords, and personal information. It includes a set of regular expressions by
default, but also accepts a JSON object containing your custom regular expressions.

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

Expand All @@ -53,6 +53,15 @@ unzip rustyhogs-musl_darwin_1.0.7.zip
darwin_releases/choctaw_hog -h
```

## How to run using DockerHub
Rusty Hog Docker images can be found at the authors personal DockerHub page [here](https://hub.docker.com/u/wetfeet2000)
A Docker Image is built for each Hog and for each release. So to use choctaw_hog you would run the following commands:

```shell script
docker pull wetfeet2000/choctaw_hog:1.0.7
docker run -it --rm wetfeet2000/choctaw_hog:1.0.7 --help
```

## How to build
- Ensure you have [Rust](https://www.rust-lang.org/learn/get-started) installed and on your path.
- Clone this repo, and then run `cargo build --release`. The binaries are located in `target/release`.
Expand Down
2 changes: 2 additions & 0 deletions build_docker.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
docker system prune -a
cargo clean
docker build --tag wetfeet2000/ankamali_hog:$1 --build-arg HOG=ankamali .
docker push wetfeet2000/ankamali_hog:$1
docker build --tag wetfeet2000/berkshire_hog:$1 --build-arg HOG=berkshire .
Expand Down

0 comments on commit de7a955

Please sign in to comment.