Draft operator wiki overhaul

This commit is contained in:
NotoriousRebel
2026-07-21 01:05:01 -04:00
parent 56a13708eb
commit 031df90032
16 changed files with 760 additions and 4 deletions
+68
View File
@@ -0,0 +1,68 @@
# Configuration and API keys
theHarvester reads `api-keys.yaml` and `proxies.yaml` from the first matching directory:
1. `~/.theHarvester/`
2. `/etc/theHarvester/`
3. `/usr/local/etc/theHarvester/`
If no file exists, theHarvester creates the default template under `~/.theHarvester/`.
## Provider credentials
Run theHarvester once to create the user configuration, then edit:
```bash
${EDITOR:-vi} ~/.theHarvester/api-keys.yaml
chmod 600 ~/.theHarvester/api-keys.yaml
```
Keep the complete generated template and fill only the providers you intend to use. Some providers require more than one field:
```yaml
apikeys:
censys:
id: your-censys-id
secret: your-censys-secret
github:
key: your-github-token
tomba:
key: your-tomba-key
secret: your-tomba-secret
```
Do not commit populated configuration files. Prefer provider credentials scoped to the minimum access the provider supports.
The [README source matrix](https://github.com/laramies/theHarvester/blob/dev/README.md#discovery-sources) is the canonical list of current sources and whether a key is required, optional, or unused. Provider pricing, quotas, and terms change frequently; use each provider's documentation rather than copying those values into this wiki.
## Proxies
Edit `~/.theHarvester/proxies.yaml` using `host:port` entries:
```yaml
http:
- 127.0.0.1:8080
socks5:
- 127.0.0.1:9050
```
Enable configured proxies with `-p`:
```bash
uv run theHarvester -d example.com -b crtsh -p
```
A proxy does not make an assessment anonymous and does not change the authorization boundary.
## REST API protection
The `/additional/*` routes require a server-side key:
```bash
export THEHARVESTER_API_KEY='replace-with-a-long-random-value'
uv run restfulHarvest
```
Clients send the same value in the `X-API-Key` header. This key protects only `/additional/*`; the core query routes remain unauthenticated.