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.

Sign up for GitHub

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

included telemetry documentation #264

Merged
merged 1 commit into from
Jan 30, 2025
Merged

included telemetry documentation #264

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions docs/docs/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,16 @@ cargo scout-audit
💡 Scout supports Cargo Workspaces. When run on a workspace, Scout will be executed on all packages specified as members of the workspace.

⚠️ Make sure that your smart contracts compile properly. Scout won't run if any compilation errors exist.

## Privacy

Scout Audit includes telemetry to track usage, but your data remains completely secure.

All reports sent to Scout are stored locally and can be viewed at:
`$HOME/.scout-audit/telemetry/reports`

To disable telemetry, navigate to:
`$HOME/.scout-audit/telemetry`, open `user_id.txt`, and replace its content with DONOTTRACK.

If you want to permanently delete your data from Scout's database, visit:
`https://scout-api.coinfabrik.com/user/delete/<your-user-id>`.