Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ramanan-ravi committed Sep 11, 2024
1 parent f20ce45 commit 403b8ba
Show file tree
Hide file tree
Showing 10 changed files with 17 additions and 17 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Images may be compromised with the installation of a cryptominer such as XMRig.
Pull the official **yarahunter** image:

```
docker pull quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.0
docker pull quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.1
```

or Build it from source clone this repo and run below command
Expand All @@ -53,7 +53,7 @@ docker pull metal3d/xmrig
docker run -i --rm --name=deepfence-yarahunter \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /tmp:/home/deepfence/output \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.0 \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.1 \
--image-name metal3d/xmrig:latest \
--output=json > xmrig-scan.json
```
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/yarahunter/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_malware_scanner_ce:2.3.0 --help
$ docker run -it --rm quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.1 --help
```

Note that all files and directories used in YaraHunter configuration are local to the container, not the host filesystem. The examples given illustrate how to map host directories to the container when needed.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/yarahunter/configure/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ YaraHunter can writes output to `stdout` it can redirected to a file for further
```bash
docker run -i --rm --name=yara-hunter \
-v /var/run/docker.sock:/var/run/docker.sock \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.0 \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.1 \
--image-name node:latest \
# highlight-next-line
--output=json > xmrig-scan.json
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/yarahunter/configure/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ docker run -it --rm --name=yara-hunter \
-v /var/run/docker.sock:/var/run/docker.sock \
# highlight-next-line
-v $(pwd)/my-rules:/tmp/my-rules \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.0 --image-name node:latest \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.1 --image-name node:latest \
# highlight-next-line
--rules-path /tmp/my-rules
```
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/yarahunter/img/yarahunter.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/docs/yarahunter/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ docker pull metal3d/xmrig
docker run -i --rm --name=deepfence-yarahunter \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /tmp:/home/deepfence/output \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.0 \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.1 \
--image-name metal3d/xmrig:latest \
--output=json > xmrig-scan.json
```
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/yarahunter/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Pull the latest YaraHunter image, and use it to scan a `node:latest` container.
## Pull the latest YaraHunter image

```bash
docker pull quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.0
docker pull quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.1
```

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

docker run -i --rm --name=yara-hunter \
-v /var/run/docker.sock:/var/run/docker.sock \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.0 \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.1 \
--image-name node:latest

docker rmi node:latest
Expand All @@ -35,7 +35,7 @@ You can summarise the results by processing the JSON output, e.g. using `jq`:
docker run -i --rm --name=yara-hunter \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /tmp:/home/deepfence/output \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.0 \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.1 \
--image-name node:latest \
--output=json > node-latest.json

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/yarahunter/using/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ title: Build YaraHunter
YaraHunter is a self-contained docker-based tool. Clone the [YaraHunter repository](https://github.com/deepfence/YaraHunter), then build:

```bash
docker build --rm=true --tag=quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.0 -f Dockerfile .
docker build --rm=true --tag=quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.1 -f Dockerfile .
```

Alternatively, you can pull the official deepfence image at `quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.0`.
Alternatively, you can pull the official deepfence image at `quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.1`.

```bash
docker pull quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.0
docker pull quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.1
```
2 changes: 1 addition & 1 deletion docs/docs/yarahunter/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-malwarescanner \
-v $(pwd):/home/deepfence/output \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /tmp/sock:/tmp/sock \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.0 \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.1 \
-socket-path /tmp/sock/s.sock
```

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/yarahunter/using/scan.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ docker pull node:latest

docker run -it --rm --name=yara-hunter \
-v /var/run/docker.sock:/var/run/docker.sock \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.0 \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.1 \
# highlight-next-line
--image-name node:latest

Expand All @@ -32,7 +32,7 @@ docker run -it --rm --name=yara-hunter \
-v /var/run/docker.sock:/var/run/docker.sock \
# highlight-next-line
-v /:/deepfence/mnt \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.0 \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.1 \
# highlight-next-line
--host-mount-path /deepfence/mnt --container-id 69221b948a73
```
Expand All @@ -45,7 +45,7 @@ Mount the filesystem within the YaraHunter container and scan it:
docker run -it --rm --name=yara-hunter \
# highlight-next-line
-v ~/src/YARA-RULES:/tmp/YARA-RULES \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.0 \
quay.io/deepfenceio/deepfence_malware_scanner_ce:2.3.1 \
# highlight-next-line
--local /tmp/YARA-RULES --host-mount-path /tmp/YARA-RULES
```
Expand Down

0 comments on commit 403b8ba

Please sign in to comment.