IntelHub/examples/intelhub.env.example at main · rootazero/IntelHub · 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
# examples/intelhub.env.example — template for INTELHUB_ENV_FILE.
#
# Copy this file, uncomment the keys you have, fill in real values, then run:
#
#   curl -fsSL https://raw.githubusercontent.com/rootazero/IntelHub/main/scripts/install.sh \
#     | INTELHUB_ENV_FILE=$PWD/intelhub.env bash
#
#   # or for in-place updates:
#   curl -fsSL https://raw.githubusercontent.com/rootazero/IntelHub/main/scripts/install.sh \
#     | INTELHUB_ENV_FILE=$PWD/intelhub.env bash -s -- update
#
# Every key is OPTIONAL — leave commented or empty to skip. Skipping a key
# never aborts install/update; the corresponding feature degrades gracefully
# (e.g., empty EMBEDDING_API_KEY → semantic search falls back to keyword-only).
#
# This file is safe to commit. NEVER commit a file with real keys filled in.

# ------------------------------------------------------------ install-time --
# Affect install.sh / update.sh behavior. Read at script start.
#
# INTELHUB_HOME=/opt/intelhub          # install root (default ~/IntelHub)
# INTELHUB_LAN=10.10.10.0/24           # LAN CIDR for nftables
# INTELHUB_NONINTERACTIVE=1            # skip every interactive key prompt
# INTELHUB_TARBALL=https://example/intelhub.tar.gz  # install from tarball

# ----------------------------------------------------------- core/hub.env --
# Generated by install.sh step_secrets on first install. Manually
# pre-populating these rarely makes sense (LAN_IP etc. are auto-detected).

# HUB_LISTEN_ADDR=10.10.10.41:8800
# HUB_ADMIN_TOKEN=                   # 24-byte hex; install.sh generates one if empty

# --------------------------------------------- core/secrets.env (optional) --
# Each empty value degrades the named feature; nothing aborts install.
# See scripts/install.sh step_keys for the canonical prompt text + skip
# consequence for each key.

# EMBEDDING_API_KEY=sk-...            # T8star embedding relay; skip → keyword-only search
# FIRMS_MAP_KEY=                      # NASA FIRMS fire hotspots layer; skip → no fire layer
# ACLED_EMAIL=                        # ACLED conflict events email
# ACLED_PASSWORD=                     # ACLED conflict events password (OAuth password grant)
# RELIEFWEB_APPNAME=                  # ReliefWeb free appname (apidoc.reliefweb.int)
# FRED_API_KEY=                       # FRED macro series
# COMTRADE_API_KEY=                   # UN Comtrade trade flows
# BLS_API_KEY=                        # BLS labor/stats (US-residential-IP registration only)
# X_BEARER_TOKEN=                     # X/Twitter Basic ($200/mo, no free read)
# FMP_API_KEY=                        # Financial Modeling Prep quotes
# FINNHUB_API_KEY=                    # Finnhub news / insiders / earnings
# FINANCIALDATASETS_API_KEY=          # financialdatasets.ai financials_fetch
# EIA_API_KEY=                        # EIA energy data

# Alerts (Telegram push; leave empty for console-only alerts)
# HUB_ALERT_TELEGRAM_BOT_TOKEN=
# HUB_ALERT_TELEGRAM_CHAT_ID=

# CCTV (GEV P11)
# HUB_GOOGLE_MAPS_SERVER_API_KEY=AIza...  # Google Street View Static API for CCTV frame
                                         # fallback. Skip → CCTV popout falls back to
                                         # synthetic SVG when upstream frame is broken.
                                         # Free tier: 28,500 requests/month at
                                         # developers.google.com/maps/documentation/maps-static

# ------------------------------------------- core/console-build.env (CARTO) --
# Console build-time only (Vite inlines at build). Never enters the repo tree.
#
# VITE_CARTO_KEY=                     # CARTO basemap key (carto.com/basemaps/apikey free)
                                      # skip → console falls back to Esri primary basemap

# ----------------------------------------- runtime feature flags (optional) --
# These get written into core/hub.env by install.sh but you can pre-set them
# here to flip defaults without editing the generated file later.
#
# HUB_RERANK_ENABLED=false            # cross-encoder rerank stage (T8star /v1/rerank)
# HUB_LLM_ENABLED=false               # LLM planner fallback for investigate()
# HUB_QUERY_CACHE_ENABLED=true        # Redis-backed query result cache (default on)
# HUB_QUERY_CACHE_TTL_SECS=300        # cache TTL in seconds
# HUB_EMBED_MIN_WORDS=50              # min words for embed eligibility (50 default)