openvibers/openvibe.sources .env.example

.env.example

main 4.4 KB · 96 lines · plaintext

1# ═══════════════════════════════════════════════════════════════
2# OpenVibe.Sources — Environment Configuration
3# Copy to .env and fill in values.
4# In production this lives at /etc/openvibe/sources.env (0600); the systemd unit sets
5# NODE_ENV and PORT itself.
6# ═══════════════════════════════════════════════════════════════
7
8# Server
9PORT=4720
10HOST=127.0.0.1
11NODE_ENV=development
12#BASE_URL=https://sources.openvibe.network
13
14# Identity — OpenVibe.Network signs the service tokens (audience openvibe.sources) callers present.
15OV_NETWORK_URL=https://openvibe.network
16OV_NETWORK_INTERNAL_URL=http://127.0.0.1:4000
17#OV_NETWORK_ISSUER=https://openvibe.network
18# The JWKS the service verifies tokens against; by default Network's internal JWKS
19# (OV_NETWORK_INTERNAL_URL/api/.well-known/jwks). openvibe-sdk/auth caches it and keeps it fresh.
20#OV_NETWORK_JWKS_URL=https://openvibe.network/api/.well-known/jwks
21
22# Per-actor limits (server/api/actor-limits.js): API reads one app or module (app:…, mod:…) may make per
23# minute and per hour; past them 429 rate_limited with Retry-After. First-party services (svc:…) are not
24# counted on reads; writes (sources.source.manage) have their own numbers (README).
25#SOURCES_LIMITS_MINUTE=120
26#SOURCES_LIMITS_HOUR=3000
27
28# This service's own principal (svc:sources) — publishes sources.* events (events.event.publish).
29OV_OAUTH_CLIENT_ID=sources
30OV_OAUTH_CLIENT_SECRET=
31
32# Merchant opt-in pages: the Network OAuth client must be registered with the redirect URI below. BASE_URL decides the
33# default; set OV_OAUTH_REDIRECT_URI explicitly if the public host differs. The session cookie is Secure in production.
34#OV_OAUTH_REDIRECT_URI=https://sources.openvibe.network/merchant/callback
35#OV_OAUTH_SCOPE=profile
36#SOURCES_SESSION_SECRET=
37#SOURCES_COOKIE_SECURE=1
38# Pending proofs: recheck cadence (0 disables the worker pass), expiry, meta page cap, optional DNS servers.
39#SOURCES_MERCHANT_RECHECK_MS=600000
40#SOURCES_MERCHANT_PENDING_DAYS=14
41#SOURCES_MERCHANT_META_MAX_BYTES=1048576
42#SOURCES_MERCHANT_META_TIMEOUT_MS=10000
43#SOURCES_MERCHANT_DNS_SERVERS=
44# The source created after verification: crawl/feed spacing, polling, staleness and crawl limits.
45#SOURCES_MERCHANT_CRAWL_MIN_INTERVAL_MS=1000
46#SOURCES_MERCHANT_FEED_MIN_INTERVAL_MS=60000
47#SOURCES_MERCHANT_POLL_INTERVAL_SEC=3600
48#SOURCES_MERCHANT_CRAWL_STALE_AFTER_SEC=86400
49#SOURCES_MERCHANT_FEED_STALE_AFTER_SEC=10800
50#SOURCES_MERCHANT_MAX_ITEMS=1000
51#SOURCES_MERCHANT_MAX_PAGES=5000
52#SOURCES_MERCHANT_PAGES_PER_RUN=100
53#SOURCES_MERCHANT_RECRAWL_SEC=86400
54
55# Store (PostgreSQL, ADR-035), written by OpenVibe.Host roles/data/add-service.sh sources: the runtime role through
56# PgBouncer, the owner on a direct connection (migrations), and Valkey (shared limit counters).
57# Without DATABASE_URL, development uses an embedded PGlite database in data/pglite.
58DATABASE_URL=
59DATABASE_DIRECT_URL=
60VALKEY_URL=
61VALKEY_PREFIX=
62
63# OpenVibe.Events. The outbox relay runs only when EVENTS_URL is set.
64#EVENTS_URL=http://127.0.0.1:4300
65#EVENTS_RELAY_INTERVAL_MS=2000
66
67# Ingestion worker (in-process scheduler)
68#SOURCES_WORKER=on
69#SOURCES_TICK_MS=5000
70#SOURCES_MAX_CONCURRENT=4
71#SOURCES_MAX_BACKOFF_MS=21600000
72
73# Fetching
74#SOURCES_USER_AGENT=Mozilla/5.0 (compatible; OpenVibeBot/1.0; +https://openvibe.network/bot)
75#SOURCES_ROBOTS_AGENT=OpenVibeBot,OpenVibeSources
76#SOURCES_FETCH_TIMEOUT_MS=20000
77#SOURCES_MAX_BYTES=5242880
78#SOURCES_MAX_REDIRECTS=5
79#SOURCES_ROBOTS_TTL_MS=86400000
80# Least time between two requests to one host, whatever a source says.
81#SOURCES_HOST_MIN_INTERVAL_MS=1000
82#SOURCES_ALLOWED_PORTS=80,443
83# Exact hosts/IPs allowed to resolve to private/loopback addresses. Leave EMPTY in production.
84#SOURCES_ALLOW_PRIVATE_HOSTS=
85#SOURCES_MAX_ITEMS_PER_FETCH=12000
86
87# Data-source keys (D11 owner settings): the admin panel's sources.data_sources namespace wins; this
88# is the fallback when no value was entered there. GITHUB_TOKEN is the last fallback (a read-only token:
89# 30 search requests a minute instead of 10; the name only, never the value).
90#SOURCES_GITHUB_TOKEN=
91#GITHUB_TOKEN=
92
93# Source credentials: a registry entry names the variable (auth.env), never the value. Names
94# must start with SOURCES_CRED_. Example (none of the seeds needs one):
95#SOURCES_CRED_EXAMPLE_API_KEY=
96