blhackbox/.env.example at main · valITino/blhackbox · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# ╔══════════════════════════════════════════════════════════════════════╗
# ║  blhackbox v2.0 — Environment Configuration                        ║
# ║  Copy to .env and fill in the REQUIRED section:                     ║
# ║    cp .env.example .env                                             ║
# ║  Or use the setup wizard:                                           ║
# ║    ./setup.sh                                                       ║
# ╚══════════════════════════════════════════════════════════════════════╝

# ══════════════════════════════════════════════════════════════════════
# ██ AGENT API KEYS — needed only for the in-Docker agent you run ██
# ══════════════════════════════════════════════════════════════════════
# Pick the agent you want to run inside Docker and set its key. Neither is
# needed for Claude Code on the host / Claude Code Web.
#
# Claude Code container (--profile claude-code / `make claude-code`):
#   Get your key at: https://console.anthropic.com/settings/keys
# ANTHROPIC_API_KEY=sk-ant-...
#
# DeepSeek container (--profile deepseek / `make deepseek`):
#   Runs the Claude Code image pointed at DeepSeek's Anthropic-compatible API.
#   The key is passed to Claude Code as ANTHROPIC_AUTH_TOKEN at runtime.
#   Get your key at: https://platform.deepseek.com/api_keys
# DEEPSEEK_API_KEY=sk-...
#
# Z.ai / GLM 5.2 container (--profile zai / `make zai`):
#   Runs the Claude Code image pointed at Z.ai's Anthropic-compatible API.
#   The key is passed to Claude Code as ANTHROPIC_AUTH_TOKEN at runtime.
#   Get your key at: https://z.ai/manage-apikey/apikey-list
# ZAI_API_KEY=

# ══════════════════════════════════════════════════════════════════════
# OPTIONAL — Defaults work out of the box
# ══════════════════════════════════════════════════════════════════════

# ── Kali MCP Server ──────────────────────────────────────────────
# Port exposed on the host for direct Streamable HTTP connections
# (http://localhost:9001/mcp). Claude Code (Docker) uses the internal URL
# http://kali-mcp:9001/mcp instead.
KALI_MCP_PORT=9001
# Max timeout (seconds) for long-running Kali tool scans.
KALI_MAX_TIMEOUT=600

# ── Optional recon / OSINT API keys ───────────────────────────────
# IMPORTANT: every recon tool runs WITHOUT any of these keys. Keys only
# widen passive-source coverage (more subdomains, vuln data, OSINT hits).
# Add only the ones you have; leave the rest commented out. See the
# "Optional API keys" section of the README for the full picture.
#
# WPScan — adds the WordPress vulnerability database. wpscan auto-loads
# this variable (no CLI flag needed). Free tier: https://wpscan.com/api (25 req/day)
# WPSCAN_API_TOKEN=your_token_here
#
# subfinder passive sources — read from these env vars (or from
# ~/.config/subfinder/provider-config.yaml). Add the providers you use:
# VIRUSTOTAL_API_KEY=
# SHODAN_API_KEY=
# SECURITYTRAILS_API_KEY=
#
# theHarvester and amass read keys from their OWN config files, not env
# vars (see the README "Optional API keys" section to mount them):
#   theHarvester → ~/.theHarvester/api-keys.yaml  (or /etc/theHarvester/)
#   amass        → ~/.config/amass/datasources.yaml

# ── Screenshot MCP Server ─────────────────────────────────────────
# Port exposed on the host for direct Streamable HTTP connections
# (http://localhost:9004/mcp). Claude Code (Docker) uses the internal URL
# http://screenshot-mcp:9004/mcp instead.
SCREENSHOT_MCP_PORT=9004

# ── Metasploit (integrated in Kali MCP) ───────────────────────────
# Metasploit is bundled inside the kali-mcp container.
# Tools use `msfconsole -qx` (CLI) — no msfrpcd daemon needed.
# Timeout (seconds) for msfconsole commands. Cold start takes 10-30s.
MSF_TIMEOUT=300

# ── MCP Gateway (optional — only for Claude Desktop / ChatGPT) ─────
# Enable the gateway with: docker compose --profile gateway up -d
# Claude Code in Docker does NOT need the gateway — it connects
# directly to each MCP server via Streamable HTTP over the Docker network.
MCP_GATEWAY_PORT=8080

# ── Neo4j (optional — for cross-session memory) ────────────────────
# Enable with: docker compose --profile neo4j up -d
NEO4J_URI=bolt://neo4j:7687
NEO4J_USER=neo4j
NEO4J_PASSWORD=changeme-min-8-chars

# Neo4j Aura alternative (cloud):
# NEO4J_URI=neo4j+s://xxxxxxxx.databases.neo4j.io

# ── Vector Memory System (optional — planned feature) ──────────────
# Enable with: docker compose --profile memory up -d
# Provides cross-session learning via pgvector semantic search.
# See docs/vector-memory-design.md for architecture details.
# MEMORY_MCP_PORT=9005
# MEMORY_DB_PASSWORD=blhackbox
# MEMORY_EMBEDDING_MODEL=text-embedding-3-small

# ── OpenAI (optional — for ChatGPT MCP clients or embeddings) ─────
# Required for ChatGPT / OpenAI MCP clients (host-based only).
# Also used for vector memory embeddings if memory-mcp is enabled.
# Get your key at platform.openai.com
# OPENAI_API_KEY=sk-...