Skip to content

Commit 1c949b1

Browse files
committed
Update docs
1 parent b842ad9 commit 1c949b1

9 files changed

Lines changed: 16 additions & 19 deletions

File tree

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ SecretScanner: vendor $(PWD)/**/*.go $(PWD)/agent-plugins-grpc/**/*.go
1717

1818
.PHONY: docker
1919
docker:
20-
docker build -t quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0 .
20+
docker build -t quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0 .

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@
88
[![Slack](https://img.shields.io/badge/slack-@deepfence-blue.svg?logo=slack)](https://join.slack.com/t/deepfence-community/shared_invite/zt-podmzle9-5X~qYx8wMaLt9bGWwkSdgQ)
99
[![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)
1010

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

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

4744
* Or, pull the latest build from docker hub by doing:
4845
```shell
49-
docker pull quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0
46+
docker pull quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0
5047
```
5148

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

5754
* Scan the container image:
5855
```shell
59-
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
56+
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
6057
```
6158

6259
# Credits

docs/docs/secretscanner/configure/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Command-Line Options
77
Display the command line options:
88

99
```bash
10-
docker run -it --rm quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0 --help
10+
docker run -it --rm quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0 --help
1111
```
1212

1313
or, with a standalone build:

docs/docs/secretscanner/configure/output.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ SecretScanner can writes output to `stdout` it can redirected to a file for furt
1111

1212
docker run -it --rm --name=deepfence_secret_scanner \
1313
-v /var/run/docker.sock:/var/run/docker.sock \
14-
quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0 \
14+
quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0 \
1515
--image-name node:latest \
1616
# highlight-next-line
1717
--output json > ./tmp/node-secret-scan.json

docs/docs/secretscanner/img/secretscanner.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/docs/secretscanner/quickstart.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Pull the latest SecretScanner image, and use it to scan a `node:latest` containe
99
## Pull the latest SecretScanner image
1010

1111
```bash
12-
docker pull quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0
12+
docker pull quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0
1313
```
1414

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

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

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

docs/docs/secretscanner/using/build.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ SecretScanner is a self-contained docker-based tool. Clone the [SecretScanner re
88

99
```bash
1010
./bootstrap.sh
11-
docker build --rm=true --tag=quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0 -f Dockerfile .
11+
docker build --rm=true --tag=quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0 -f Dockerfile .
1212
```
1313

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

1616
```bash
17-
docker pull quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0
17+
docker pull quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0
1818
```

docs/docs/secretscanner/using/grpc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ docker run -it --rm --name=deepfence-secretscanner \
2727
-v $(pwd):/home/deepfence/output \
2828
-v /var/run/docker.sock:/var/run/docker.sock \
2929
-v /tmp/sock:/tmp/sock \
30-
quay.io/deepfenceio/deepfence_secret_scanner_ce:2.2.0 \
30+
quay.io/deepfenceio/deepfence_secret_scanner_ce:2.3.0 \
3131
-socket-path /tmp/sock/s.sock
3232
```
3333

docs/docs/secretscanner/using/scan.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ docker pull node:latest
1515

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

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

0 commit comments

Comments
 (0)