Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ramanan-ravi committed Jul 25, 2024
1 parent b842ad9 commit 1c949b1
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 19 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ SecretScanner: vendor $(PWD)/**/*.go $(PWD)/agent-plugins-grpc/**/*.go

.PHONY: docker
docker:
docker build -t quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0 .
docker build -t quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0 .
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@
[![Slack](https://img.shields.io/badge/[email protected]?logo=slack)](https://join.slack.com/t/deepfence-community/shared_invite/zt-podmzle9-5X~qYx8wMaLt9bGWwkSdgQ)
[![Twitter](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fdeepfence%2FSecretScanner)](https://twitter.com/intent/tweet?text=Check%20this%20out%3A&url=https%3A%2F%2Fgithub.com%2Fdeepfence%2FSecretScanner)


> SecretScanner has been integrated into [ThreatMapper 1.3.0](https://github.com/deepfence/ThreatMapper), and also remains as this standalone project.
# SecretScanner

Deepfence SecretScanner can find unprotected secrets in container images or file systems.
Expand Down Expand Up @@ -41,12 +38,12 @@ Install docker and run SecretScanner on a container image using the following in
* Build SecretScanner:
```shell
./bootstrap.sh
docker build --rm=true --tag=quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0 -f Dockerfile .
docker build --rm=true --tag=quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0 -f Dockerfile .
```

* Or, pull the latest build from docker hub by doing:
```shell
docker pull quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0
docker pull quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0
```

* Pull a container image for scanning:
Expand All @@ -56,7 +53,7 @@ docker pull node:8.11

* Scan the container image:
```shell
docker run -i --rm --name=deepfence-secretscanner -v /var/run/docker.sock:/var/run/docker.sock quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0 -image-name node:8.11 --output json > node.json
docker run -i --rm --name=deepfence-secretscanner -v /var/run/docker.sock:/var/run/docker.sock quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0 -image-name node:8.11 --output json > node.json
```

# Credits
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/secretscanner/configure/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: Command-Line Options
Display the command line options:

```bash
docker run -it --rm quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0 --help
docker run -it --rm quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0 --help
```

or, with a standalone build:
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/secretscanner/configure/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ SecretScanner can writes output to `stdout` it can redirected to a file for furt

docker run -it --rm --name=deepfence_secret_scanner \
-v /var/run/docker.sock:/var/run/docker.sock \
quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0 \
quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0 \
--image-name node:latest \
# highlight-next-line
--output json > ./tmp/node-secret-scan.json
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/secretscanner/img/secretscanner.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/docs/secretscanner/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Pull the latest SecretScanner image, and use it to scan a `node:latest` containe
## Pull the latest SecretScanner image

```bash
docker pull quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0
docker pull quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0
```

## Scan a Container Image
Expand All @@ -21,7 +21,7 @@ docker pull node:latest

docker run -i --rm --name=deepfence-secretscanner \
-v /var/run/docker.sock:/var/run/docker.sock \
quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0 \
quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0 \
-image-name node:latest

docker rmi node:latest
Expand All @@ -34,7 +34,7 @@ You can summarise the results by processing the JSON output, e.g. using `jq`:
```bash
docker run -i --rm --name=deepfence-secretscanner \
-v /var/run/docker.sock:/var/run/docker.sock \
quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0 \
quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0 \
--image-name node:latest \
--output json > /tmp/node-secret-scan.json

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/secretscanner/using/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ SecretScanner is a self-contained docker-based tool. Clone the [SecretScanner re

```bash
./bootstrap.sh
docker build --rm=true --tag=quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0 -f Dockerfile .
docker build --rm=true --tag=quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0 -f Dockerfile .
```

Alternatively, you can pull the official Deepfence image at `quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0`:
Alternatively, you can pull the official Deepfence image at `quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0`:

```bash
docker pull quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0
docker pull quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0
```
2 changes: 1 addition & 1 deletion docs/docs/secretscanner/using/grpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ docker run -it --rm --name=deepfence-secretscanner \
-v $(pwd):/home/deepfence/output \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /tmp/sock:/tmp/sock \
quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0 \
quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0 \
-socket-path /tmp/sock/s.sock
```

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/secretscanner/using/scan.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ docker pull node:latest

docker run -it --rm --name=deepfence-secretscanner \
-v /var/run/docker.sock:/var/run/docker.sock \
quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0 \
quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0 \
# highlight-next-line
--image-name node:latest

Expand All @@ -30,7 +30,7 @@ Mount the filesystem within the SecretScanner container and scan it. Here, we s
docker run -it --rm --name=deepfence-secretscanner \
# highlight-next-line
-v /tmp:/deepfence/mnt \
quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0 \
quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0 \
# highlight-next-line
--host-mount-path /deepfence/mnt --local /deepfence/mnt
```
Expand Down

0 comments on commit 1c949b1

Please sign in to comment.