Docs Menu

Introduction

Getting started

Add a Scanner
Configuring the Scanners
Run the Scanner
- CLI Flags

Terminology

Sources
Notifiers
Workflows
Scanners (Agents)
Scanner Group (Agent Group)
Secrets
- Secret States
- Triage States

Resource requirements

Minimum recommended requirements
Resource Calculator
- Instructions:
Dependencies
- Installing Dependencies on Ubuntu

Onprem vs Cloud Support

Configuration

Custom Verifiers

Custom Verifiers
Example config
Custom verifiers via command line

Locally-configured sources

Adding a Source configuration
Example config
Artifactory (Alpha)
Azure Repos (Alpha)
BitBucket
Buildkite (Beta)
Confluence
- Confluence with basic authentication
- Confluence with personal access token (PAT)
Docker
Filesystem
File and Stdin
- Help
- Example
GCS (Google Cloud Storage)
Gerrit
Git
GitHub
GitLab
- Token Auth
- Basic Auth
Google Drive (Beta)
Jenkins
JIRA
- JIRA with basic authentication
- JIRA with personal access token (PAT)
Microsoft Teams
Microsoft SharePoint (Alpha)
Slack
- Single Workspace App
S3

Secrets management

Config with URI to a secret manager
Config with a file
Environment variables

Advanced usage

Downloading the binary
Running as a Systemd daemon
Deploying to Kubernetes via manifest
Deploying to Kubernetes via Helm
Detectors Which Accept Configuration Options
- JDBC

Detector-specific verification

Detector-specific verification
- Configuration on the command line
- Detector identifiers

Locally-configured detectors

Adding a Detector configuration
Example config
Custom Regex
- Verification

Locally-configured notifiers

Adding a Notifier configuration
Example config
Stdout
Slack
Webhook
Email
Splunk
JIRA
- Token-based Authentication
- Basic Authentication

TruffleHog authentication

Default
SAML SSO

Scanning Git

Scanning in CI

GitHub Actions
CircleCI
General Usage
With Docker

Using TruffleHog with Git hooks

Using pre-commit hooks
- Pre-commit config for TruffleHog in Docker
- Pre-commit config for TruffleHog in your PATH
Using pre-receive hooks
- Pre-receive config for TruffleHog

Scanning Git

© 2024 Truffle Security Co.