TruffleHog Docs
⌘
K
🐽
Choose your adventure
🌱
Getting started
🔧
Creating a scanner
📝
Configuring a scanner
👟
Running the scanner
📖
Terminology
🐽
Scan data for secrets
Artifactory
AWS S3
Azure Repos
BitBucket
Buildkite
CircleCI
Confluence
Docker
Filesystem
Gerrit
Git
GitLab
GitHub
Google Cloud Storage (GCS)
Google Drive
Jenkins
Jira
Microsoft Sharepoint
Microsoft Teams
Slack
Vector
🔔
Notify results
Email
JIRA
Splunk
Slack
Stdout
Webhook
✋
Block secrets from leaking
Scanning in CI
Pre-commit hooks
Pre-receive hooks
🚢
Deployment
Systemd
Docker
Helm Chart
Kubernetes manifest
🔧
Customizing TruffleHog
Custom detectors
Customizing detection
On-premise verification
🔒
Security and Compliance
Authentication
Architecture
Compliance
Docs powered by
Archbee
Notify results
Email
3min
Configuration
Local configuration
Local configuration requires an AWS key with access to configured AWS SES.
config.yaml
notifiers
:
-
connection
:
'@type'
:
type.googleapis.com/notifiers.Email
ses
:
creds
:
key
:
AKIAXXXXXXXXXXXXXXXX
region
:
us
-
west1
secret
:
XXXXXXXXXXXXXXXXXXXXXXXXXX
recipients
:
-
[email protected]
sender
:
<trufflehog
>
[email protected]
name
:
email secrets notifications
type
:
NOTIFIER_TYPE_EMAIL
notifiers: - connection: '@type': type.googleapis.com/notifiers.Email ses: creds: key: AKIAXXXXXXXXXXXXXXXX region: us-west1 secret: XXXXXXXXXXXXXXXXXXXXXXXXXX recipients: - security@ourbusiness.org sender: <trufflehog> trufflehog@ourbusiness.org name: email secrets notifications type: NOTIFIER_TYPE_EMAIL
Updated 16 May 2024
Did this page help you?
PREVIOUS
Notify results
NEXT
JIRA
Docs powered by
Archbee
TABLE OF CONTENTS
Configuration
Web configuration
Local configuration
Docs powered by
Archbee