Getting started

Creating a scanner

1min

1
Navigate to Settings -> Scanners and then click on the Add Scanner button in the upper right
﻿
2
Give the scanner a unique name
3
Download the scanner configuration.
Keep it in a safe place because it contains the credentials used to access TruffleHog and your data! For security and convenience, we recommend storing it in a secrets manager and using the built-in schemas for loading it.
4
Download the scanner.
Download the appropriate binary for your operating system and architecture. It will automatically run the latest version from your instance, don't worry about updating it! 
Alternatively, run the Docker image we publish with:
Shell
docker run --net=host -v $(pwd)/config.yaml:/tmp/config.yaml -it --rm us-docker.pkg.dev/thog-artifacts/public/scanner:latest scan --config=/tmp/config.yaml
docker run --net=host -v $(pwd)/config.yaml:/tmp/config.yaml -it --rm us-docker.pkg.dev/thog-artifacts/public/scanner:latest scan --config=/tmp/config.yaml
﻿
﻿
﻿
﻿

Updated 14 May 2024

Did this page help you?

Getting started

Configuring a scanner