Skip to content

Commit

Permalink
docs: small fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
yanivagman committed Sep 21, 2022
1 parent 4f2d828 commit c0d24c7
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 26 deletions.
44 changes: 22 additions & 22 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,25 +36,25 @@ Before you proceed, make sure you follow the [minimum requirements for running T
1. Running **tracee:latest**

```text
$ docker run \
--name tracee --rm -it \
--pid=host --cgroupns=host --privileged \
-v /etc/os-release:/etc/os-release-host:ro \
-e LIBBPFGO_OSRELEASE_FILE=/etc/os-release-host \
aquasec/tracee:latest
docker run \
--name tracee --rm -it \
--pid=host --cgroupns=host --privileged \
-v /etc/os-release:/etc/os-release-host:ro \
-e LIBBPFGO_OSRELEASE_FILE=/etc/os-release-host \
aquasec/tracee:latest
```
2. Running **tracee:full**
```text
$ docker run --name tracee --rm -it \
--pid=host --cgroupns=host --privileged \
-v /etc/os-release:/etc/os-release-host:ro \
-e LIBBPFGO_OSRELEASE_FILE=/etc/os-release-host \
-v /usr/src:/usr/src:ro \
-v /lib/modules:/lib/modules:ro \
-v /tmp/tracee:/tmp/tracee:rw \
aquasec/tracee:full
docker run --name tracee --rm -it \
--pid=host --cgroupns=host --privileged \
-v /etc/os-release:/etc/os-release-host:ro \
-e LIBBPFGO_OSRELEASE_FILE=/etc/os-release-host \
-v /usr/src:/usr/src:ro \
-v /lib/modules:/lib/modules:ro \
-v /tmp/tracee:/tmp/tracee:rw \
aquasec/tracee:full
```

> 1. The default (latest) image is **lightweight** and **portable**. It is
Expand All @@ -77,7 +77,7 @@ These docker commands run Tracee with **default settings** and start
suspicious behavior, you can simply run:

```
$ strace ls
strace ls
```

in another terminal. This will trigger the **Anti-Debugging** signature, which
Expand Down Expand Up @@ -111,13 +111,13 @@ Execute docker container with the word `trace` as an initial argument, and
**tracee-ebpf** will be executed, instead of the full tracee detection engine.

```text
$ docker run \
--name tracee --rm -it \
--pid=host --cgroupns=host --privileged \
-v /etc/os-release:/etc/os-release-host:ro \
-e LIBBPFGO_OSRELEASE_FILE=/etc/os-release-host \
aquasec/tracee:{{ git.tag[1:] }}
trace
docker run \
--name tracee --rm -it \
--pid=host --cgroupns=host --privileged \
-v /etc/os-release:/etc/os-release-host:ro \
-e LIBBPFGO_OSRELEASE_FILE=/etc/os-release-host \
aquasec/tracee:latest \
trace
```

> See documentation or add the `--help` flag for more.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ $ docker run \
--pid=host --cgroupns=host --privileged \
-v /etc/os-release:/etc/os-release-host:ro \
-e LIBBPFGO_OSRELEASE_FILE=/etc/os-release-host \
aquasec/tracee:{{ git.tag[1:] }}
aquasec/tracee:{{ git.tag[1:] }} \
trace
```

Expand Down
6 changes: 3 additions & 3 deletions docs/tracing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ $ docker run \
--pid=host --cgroupns=host --privileged \
-v /etc/os-release:/etc/os-release-host:ro \
-e LIBBPFGO_OSRELEASE_FILE=/etc/os-release-host \
-e TRACEE_EBPF_ONLY=1 \
aquasec/tracee:{{ git.tag[1:] }}
aquasec/tracee:{{ git.tag[1:] }} \
trace
```

Here, we are running the `aquasec/tracee` container, but with the
`TRACEE_EBPF_ONLY=1` environment variable set, which will start just a raw
`trace` sub-command, which will start just a raw
trace (Tracee-eBPF), without the detection engine **tracee-rules**. Here's a
sample output of running with no additional arguments:

Expand Down

0 comments on commit c0d24c7

Please sign in to comment.