Skip to content

Find, verify, and analyze leaked credentials

Update Adding_Detectors_external.md (#957)

Pulkit Aggarwald96b7f84688d
diff --git a/hack/docs/Adding_Detectors_external.md b/hack/docs/Adding_Detectors_external.md
index c1782efb8..8457463da 100644
--- a/hack/docs/Adding_Detectors_external.md
+++ b/hack/docs/Adding_Detectors_external.md
@@ -49,8 +49,12 @@ If you think that something should be included outside of these guidelines, plea
```bash
go run hack/generate/generate.go detector <DetectorType enum name>
```
+3. Add Secret Scanner
-3. Complete the secret detector.
+ Add the secret scanner to the `pkg/engine/defaults.go` file like `github.com/trufflesecurity/trufflehog/v3/pkg/detectors/<detector_name>` and
+ `<detector_name>.Scanner{},`
+
+4. Complete the secret detector.
The previous step templated a boilerplate + some example code as a package in the `pkg/detectors` folder for you to work on.
The secret detector can be completed with these general steps:
@@ -104,4 +108,4 @@ Now, the detector test should attempt to load the given env key from that file.
### Testing a detector
```bash
go test ./pkg/detectors/<detector> -tags=detectors
- ```
\ No newline at end of file
+ ```