developer-docs/.env.example at main · scalekit-inc/developer-docs · 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
# ==============================================================================
# GitHub Integration
# Powers: SDK reference docs, release changelogs, remote file trees
# ==============================================================================

# Time-limited GitHub token (90-day expiry) for Starlight changelog fetching
# Status: NOT CURRENTLY USED in the codebase — kept for future changelog features
STARLIGHT_CHANGELOG_90DAY_ACCESS=

# GitHub personal access token for public repository access
# Used by: src/loaders/github-files-loader.ts, src/content.config.ts, src/components/RemoteFileTree.astro
# Features: Fetches SDK reference docs, release data, and renders repo directory trees
# Without token: 60 requests/hour (GitHub anonymous rate limit)
# With token: 5,000 requests/hour
# Create one at: https://github.com/settings/tokens?type=beta (Repository > Contents > Read-only)
GITHUB_TOKEN=

# ==============================================================================
# Sample App & Chat Widget
# ==============================================================================

# API key for external sample application
# Status: NOT CURRENTLY USED in the codebase
PUBLIC_SAMPLEAPP_API_KEY=

# Pylon chat widget application ID
# Status: Currently HARDCODED in public/js/pylon-widget.js — this env var is not read at runtime
PUBLIC_PYLON_APP_ID=

# ==============================================================================
# Authentication (Scalekit OAuth / OIDC)
# Powers: Documentation site login flow
# Used by: src/utils/auth/auth-config.ts, src/pages/api/v1/users/support-hash.ts
# ==============================================================================

# OAuth 2.0 authorization endpoint — initiates the login flow
SCALEKIT_AUTHORIZE_URL=https://auth.scalekit.cloud/oauth/authorize

# OAuth 2.0 token endpoint — exchanges authorization code for access token
SCALEKIT_TOKEN_URL=https://auth.scalekit.cloud/oauth/token

# OIDC userinfo endpoint — fetches authenticated user profile (optional)
SCALEKIT_USERINFO_URL=https://auth.scalekit.cloud/userinfo

# OAuth client ID — identifies the docs app to Scalekit (required)
SCALEKIT_CLIENT_ID=spac_110244937148137760

# OAuth client secret — not needed when using PKCE flow (which the docs site uses)
# SCALEKIT_CLIENT_SECRET=

# OAuth redirect URI — where Scalekit redirects after authentication
# In production, this is derived from the request URL automatically
SCALEKIT_REDIRECT_URI=http://localhost:4321/auth/callback

# ==============================================================================
# Agent Connectors Sync Script (scripts/sync-agent-connectors.js)
# Powers: Regenerates MDX docs under src/content/docs/reference/agent-connectors/
# These use production Scalekit credentials, separate from the auth flow above
# ==============================================================================

PROD_SCALEKIT_CLIENT_ID=
PROD_SCALEKIT_CLIENT_SECRET=
PROD_SCALEKIT_ENVIRONMENT_URL=

# ==============================================================================
# Sapient Agent Tracker
# Powers: Tracks AI coding agents visiting the documentation site
# Used by: src/middleware.ts
# ==============================================================================

# Sapient API key (starts with sap_) for agent tracking
SAPIENT_API_KEY=