beacon/.env.example at main · brianonai/beacon · 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
# Beacon Configuration
# Copy this file to .env and fill in your values:
#   PowerShell: Copy-Item .env.example .env
#   Mac/Linux:  cp .env.example .env

# ============================================================
# REQUIRED: Google OAuth Credentials
# ============================================================
# Get these from Google Cloud Console after creating an OAuth Client ID.
# Full walkthrough: see README "Google OAuth Setup" section.
# Format example: 1234567890-abcdefg.apps.googleusercontent.com
GOOGLE_CLIENT_ID=

# Format example: GOCSPX-abcdefghijklmnopqrstuvwxyz
GOOGLE_CLIENT_SECRET=

# ============================================================
# REQUIRED: Session Secret
# ============================================================
# A random string of 32+ characters, used to sign session cookies.
# Generate one with:
#   PowerShell: -join ((48..57) + (65..90) + (97..122) | Get-Random -Count 48 | % {[char]$_})
#   Mac/Linux:  openssl rand -base64 36
SESSION_SECRET=

# ============================================================
# REQUIRED FOR LOCAL: OAuth over HTTP
# ============================================================
# Google's OAuth library refuses to authenticate over plain HTTP by default.
# Beacon runs on localhost (which Google itself exempts from HTTPS),
# so this flag tells the library to allow it.
# IMPORTANT: Set to 1 ONLY for localhost. NEVER on a public-facing server.
OAUTHLIB_INSECURE_TRANSPORT=1

# ============================================================
# Docker Compose defaults (this repo)
# ============================================================
# Host ports 13000 (web) and 18080 (API) avoid Windows reserved ranges on :8000.
# Authorized redirect URI in Google Cloud must match OAUTH_REDIRECT_URI exactly.
OAUTH_REDIRECT_URI=http://localhost:18080/auth/google/callback
POST_LOGIN_REDIRECT=http://localhost:13000/
ALLOWED_ORIGIN=http://localhost:13000

# ============================================================
# OPTIONAL: Performance Tuning
# ============================================================
# Concurrent requests to Google's URL Inspection API.
# Default 10 stays well under Google's per-second rate limits.
INSPECT_CONCURRENCY=10

# Milliseconds of jitter between inspection batches (optional).
# INSPECT_JITTER_MS=100

# Days before a URL is flagged "stale" in the UI (optional).
# STALE_DAYS=180

# Concurrent HTTP page fetches when checking URLs.
PAGE_CHECK_CONCURRENCY=5

# User agent string sent when checking pages with HTTP.
USER_AGENT=BeaconBot/0.1 (+https://github.com/brianonai/beacon)

# Maximum redirect chain length per URL.
MAX_REDIRECTS=5

# ============================================================
# OPTIONAL: Site preview (Microlink)
# ============================================================
# MICROLINK_API_KEY=

# ============================================================
# OPTIONAL: Anonymous Telemetry
# ============================================================
# Single ping on first launch with version + OS only (not wired in app yet).
# No URL data, no scan data, no IP storage.
# Default: off.
BEACON_TELEMETRY=false