openvibers/openvibe.help .env.example
.env.example
| 1 | # OpenVibe.Help — environment (production: /etc/openvibe/help.env). Names only; never commit values. |
| 2 | |
| 3 | NODE_ENV=production |
| 4 | PORT=5020 |
| 5 | HOST=127.0.0.1 |
| 6 | BASE_URL=https://openvibe.help |
| 7 | TRUST_PROXY=2 |
| 8 | # PostgreSQL (ADR-035), written by OpenVibe.Host roles/data/add-service.sh help: the runtime role through PgBouncer, |
| 9 | # the owner on a direct connection (migrations), and Valkey (shared limit counters). |
| 10 | # Without DATABASE_URL, development uses an embedded PGlite database in data/pglite. |
| 11 | DATABASE_URL= |
| 12 | DATABASE_DIRECT_URL= |
| 13 | VALKEY_URL= |
| 14 | VALKEY_PREFIX=ov:help: |
| 15 | # Per-caller limits (server/http/caller-limits.js): requests one caller may make to the API per minute and per hour. |
| 16 | #HELP_LIMITS_MINUTE=120 |
| 17 | #HELP_LIMITS_HOUR=3000 |
| 18 | |
| 19 | # OpenVibe.Network: SSO (OAuth client `help`, PKCE S256) and its JWKS; app tokens for audience openvibe.help. |
| 20 | OV_NETWORK_URL=https://openvibe.network |
| 21 | OV_NETWORK_INTERNAL_URL=http://127.0.0.1:4000 |
| 22 | # The network's public status page a site that is not serving links to (defaults to OV_NETWORK_URL/status). |
| 23 | #HELP_STATUS_URL=https://openvibe.network/status |
| 24 | OV_OAUTH_CLIENT_ID=help |
| 25 | OV_OAUTH_CLIENT_SECRET= |
| 26 | # OV_OAUTH_REDIRECT_URI=https://openvibe.help/auth/callback |
| 27 | # HELP_AUDIENCE=openvibe.help |
| 28 | |
| 29 | # OpenVibe.Search: the public query API /search asks for the "From across OpenVibe" half of a search. This is the |
| 30 | # only host /search ever calls; a person's query is a parameter, never a URL. Answers are cached in this process |
| 31 | # for HELP_SEARCH_CACHE_MS, and a failure degrades the page to the help articles alone. |
| 32 | #HELP_SEARCH_URL=https://search.openvibe.network |
| 33 | #HELP_SEARCH_LIMIT=8 |
| 34 | #HELP_SEARCH_TIMEOUT_MS=2500 |
| 35 | #HELP_SEARCH_CACHE_MS=300000 |
| 36 | |
| 37 | # OpenVibe.Events → Help (ADR-033 account export and deletion): the secret signs a delivery (comma-separated for |
| 38 | # rotation, 32+ characters each; unset makes POST /internal/events answer 503); the url is where the two subscriptions |
| 39 | # are created at boot (off when unset); HELP_EVENTS_SUBSCRIBE=0 turns that off. |
| 40 | HELP_EVENTS_SECRET= |
| 41 | HELP_EVENTS_URL= |
| 42 | #HELP_EVENTS_ENDPOINT=http://127.0.0.1:5020/internal/events |
| 43 | |
| 44 | # optional: defaults to true in production |
| 45 | # COOKIE_SECURE=true |
| 46 |