-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Expand file tree
/
Copy path.env.example
More file actions
108 lines (92 loc) · 6.89 KB
/
Copy path.env.example
File metadata and controls
108 lines (92 loc) · 6.89 KB
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
104
105
106
107
108
# ═══════════════════════════════════════════════════════════════════════════
# OSIRIS — Environment Template
# Copy this file to `.env` (or `.env.local`) and fill in values as needed.
#
# IMPORTANT — read before filling anything in:
# OSIRIS works fully WITHOUT any third-party API keys. Aviation, maritime,
# satellites, fires, earthquakes, weather, news, CVEs, etc. all use public
# keyless feeds (adsb.lol, celestrak.org, NASA FIRMS open CSV, USGS, …).
#
# As of this revision the application code only actually reads SCANNER_URL
# and SCANNER_KEY. The other keys below are OPTIONAL and reserved for higher
# rate limits / future data sources — set them only if you extend the code or
# hit rate limits on the public feeds.
# ═══════════════════════════════════════════════════════════════════════════
# ─────────────────────────────────────────────────────────────────────────
# RECON SCANNER BACKEND ── the ONLY keys the current code consumes ──
# Powers the RECON toolkit (quick/ssl/headers/rdns/subdomains/tech/whois/
# geoloc/vuln scans). Requires running the separate OSIRIS scanner backend.
# SCANNER_KEY here MUST equal the backend's OSIRIS_KEY. Generate one with:
# openssl rand -hex 32
# Leave both empty to simply disable the RECON features (UI returns 503).
# ─────────────────────────────────────────────────────────────────────────
SCANNER_URL=
SCANNER_KEY=
# ─────────────────────────────────────────────────────────────────────────
# CLOUDFLARE RADAR ── read by the code; enables two map layers ──
# Powers the "Internet Outages" and "Attack Origins" layers under
# NET & EVENT INTEL (https://radar.cloudflare.com/).
# Free: any Cloudflare account → My Profile → API Tokens → Create Token →
# Custom token with permission "Account · Radar · Read".
# Leave empty to disable — /api/cloudflare-radar returns 503 and both layer
# toggles stay hidden in the UI. The GDELT Events layer is unaffected and
# needs no key.
# ─────────────────────────────────────────────────────────────────────────
CLOUDFLARE_API_TOKEN=
# ─────────────────────────────────────────────────────────────────────────
# CHAIN INTEL ── optional; the RECON "CHAIN INTEL" tab works without these ──
# Baseline wallet forensics (BTC/ETH/SOL balance, transaction history,
# counterparties, OFAC SDN screening, risk scoring) is fully keyless via
# mempool.space, Blockscout and the public Solana RPC.
#
# These only deepen it; /api/osint/crypto?probe=1 reports which are active:
# ETHERSCAN_API_KEY https://etherscan.io/apis — internal txs, richer ETH
# HELIUS_API_KEY https://helius.dev — parsed Solana transfers.
# Without it, SOL transfer amounts and counterparties
# stay blank: the public RPC lists signatures only.
# ─────────────────────────────────────────────────────────────────────────
ETHERSCAN_API_KEY=
HELIUS_API_KEY=
# ─────────────────────────────────────────────────────────────────────────
# OPTIONAL DATA-SOURCE KEYS (not read by current code — future / upgrades)
# ─────────────────────────────────────────────────────────────────────────
# NASA FIRMS — active wildfire hotspots.
# Free, instant. Enter an email at the page below and the MAP_KEY is emailed
# to you (looks like 'abcdef1234567890abcdef1234567890'). Limit: 5000 req /
# 10 min. The app already uses the keyless FIRMS CSV; a key only matters if
# you switch to the per-area FIRMS API.
# Get it: https://firms.modaps.eosdis.nasa.gov/api/map_key/
FIRMS_API_KEY=
# OpenSky Network — aviation (higher rate limits than the keyless feed).
# Free account. Since March 2025 OpenSky uses OAuth2 (username/password auth
# is dropped). Create an account, open the Account page, create a new API
# client, and copy the client_id / client_secret.
# Get it: https://opensky-network.org/ (Account → API client)
OPENSKY_CLIENT_ID=
OPENSKY_CLIENT_SECRET=
# N2YO — satellite tracking / pass predictions.
# Free. Register, then Profile page → scroll down → "generate API key".
# The key cannot be changed once issued. Limit: 1000 req / hour.
# Get it: https://www.n2yo.com/login/register/ (then Profile)
N2YO_API_KEY=
# aisstream.io — live maritime AIS vessel positions via WebSocket.
# Free. Register, then create a key on the API Keys page. Used in the
# subscription message to wss://stream.aisstream.io/v0/stream.
# Get it: https://aisstream.io/ (sign up → API Keys)
AIS_API_KEY=
# ─────────────────────────────────────────────────────────────────────────
# RUNTIME
# ─────────────────────────────────────────────────────────────────────────
# Host port the web UI is published on (container always listens on 3000).
# Change this if 3000 is already taken on your host.
OSIRIS_PORT=3000
# Comma-separated list of public Telegram channel usernames (no @) to scrape
# for the "Telegram OSINT" map layer. Overrides the curated default set.
# Channels must have web preview enabled (most well-known OSINT channels do).
# Default if unset:
# osintdefender,insiderpaper,aljazeeraenglish,nexta_live,war_monitor
# OSIRIS_TELEGRAM_CHANNELS=
# Set by the Docker image already — override only if needed.
# NODE_ENV=production
# PORT=3000
# HOSTNAME=0.0.0.0