Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dustin-decker committed May 28, 2024
1 parent 97a9a2a commit 4a94d8b
Show file tree
Hide file tree
Showing 2 changed files with 114 additions and 100 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

---

# :mag_right: *Now Scanning*
# :mag_right: _Now Scanning_

<div align="center">

Expand Down Expand Up @@ -267,6 +267,12 @@ Use the `--workspace-id`, `--collection-id`, `--environment` flags multiple time
trufflehog postman --token=<postman api token> --workspace-id=<workspace id>
```

## 13: Scan a Jenkins server

```bash
trufflehog jenkins --url https://jenkins.example.com --username admin --password admin
```

# :question: FAQ

- All I see is `πŸ·πŸ”‘πŸ· TruffleHog. Unearth your secrets. πŸ·πŸ”‘πŸ·` and the program exits, what gives?
Expand Down Expand Up @@ -307,6 +313,8 @@ TruffleHog has a sub-command for each source of data that you may want to scan:
- travisci
- gcs (Google Cloud Storage)
- postman
- jenkins
- elasticsearch

Each subcommand can have options that you can see with the `--help` flag provided to the sub command:

Expand Down Expand Up @@ -672,4 +680,3 @@ the stability of the public APIs at this time.
# License Change

Since v3.0, TruffleHog is released under a AGPL 3 license, included in [`LICENSE`](LICENSE). TruffleHog v3.0 uses none of the previous codebase, but care was taken to preserve backwards compatibility on the command line interface. The work previous to this release is still available licensed under GPL 2.0 in the history of this repository and the previous package releases and tags. A completed CLA is required for us to accept contributions going forward.

Loading

0 comments on commit 4a94d8b

Please sign in to comment.