Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/traceroute #113

Merged
merged 21 commits into from
Mar 1, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: capabilities
Signed-off-by: Niklas Treml <treml.niklas@gmail.com>
  • Loading branch information
niklastreml committed Mar 1, 2024
commit 2fb07cf30de0db9e23c17e1a39e8aff42131e351
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,14 @@ dns:
port: 80
```

#### Required Capabilities
To use this check, sparrow needs to be run with the `CAP_NET_RAW` capability or elevated privileges to be able to send raw packets.
Using the `CAP_NET_RAW` capability is recommended over running sparrow as sudo

```bash
sudo setcap 'cap_net_raw=ep' sparrow
```

## API

The `sparrow` exposes an API for accessing the results of various checks. Each check registers its own endpoint
Expand Down