new-api-docs-v1/env.example at main · QuantumNous/new-api-docs-v1 · 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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# Environment Variables Configuration
# Copy this file to .env.local for local development

# ============================================
# GitHub API (for prebuild scripts)
# ============================================
# Optional: GitHub Personal Access Token to avoid rate limits
# GITHUB_TOKEN=your_github_token_here

# Source repository for fetching changelog and contributors
SOURCE_REPO=QuantumNous/new-api

# ============================================
# GitHub App (for Docs Feedback feature)
# ============================================
# Required for feedback feature: GitHub App ID and Private Key
# Create a GitHub App at: https://github.com/settings/apps
# The app needs these permissions:
#   - Discussions: Read and write
#   - Metadata: Read-only
# Install the app to your repository
#
# GITHUB_APP_ID=your_github_app_id
# GITHUB_APP_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----"
#
# Note: For GITHUB_APP_PRIVATE_KEY, replace newlines with \n or use a .pem file

# ============================================
# Afdian API (for Special Thanks page)
# ============================================
# Optional: If not configured, Special Thanks page will use cached data
# AFDIAN_USER_ID=your_afdian_user_id
# AFDIAN_TOKEN=your_afdian_token

# ============================================
# OpenAI API (for document translation)
# ============================================
# Required: OpenAI API Key for automatic translation
OPENAI_API_KEY=your_openai_api_key_here

# Optional: Custom OpenAI API endpoint (default: https://api.openai.com/v1)
# OPENAI_BASE_URL=https://api.openai.com/v1

# Optional: Model to use for translation (default: gpt-4o-mini)
# OPENAI_MODEL=gpt-4o-mini

# Optional: Maximum retry attempts on failure (default: 3)
# MAX_RETRIES=3

# Optional: Initial retry delay in seconds (default: 2)
# RETRY_DELAY=2

# Optional: Retry backoff multiplier (default: 2.0)
# RETRY_BACKOFF=2.0

# Optional: Maximum concurrent translation workers (default: 3)
# MAX_WORKERS=3

# Optional: Force re-translate existing files (default: false)
# FORCE_TRANSLATE=false

# ============================================
# Google Analytics
# ============================================
# Optional: Google Analytics Measurement ID (starts with G-)
# Get it from: https://analytics.google.com/ -> Admin -> Data Streams -> Your Stream -> Measurement ID
# NEXT_PUBLIC_GA_ID=G-XXXXXXXXXX

# ============================================
# AI Search Configuration (Inkeep AI)
# ============================================
# Required: Inkeep API Key for AI search functionality
INKEEP_API_KEY=your_inkeep_api_key_here

# Optional: AI Model name (default: inkeep-qa-sonnet-4)
# AI_MODEL=inkeep-qa-sonnet-4

# Optional: AI API Base URL (default: https://api.inkeep.com/v1)
# AI_BASE_URL=https://api.inkeep.com/v1

# ============================================
# Alternative AI Provider Examples
# ============================================
# Example 1: Using OpenAI directly
# INKEEP_API_KEY=sk-your_openai_api_key
# AI_MODEL=gpt-4
# AI_BASE_URL=https://api.openai.com/v1

# Example 2: Using custom New API instance
# INKEEP_API_KEY=sk-your_newapi_key
# AI_MODEL=gpt-4
# AI_BASE_URL=https://your-newapi-instance.com/v1

# Example 3: Using other OpenAI-compatible APIs
# INKEEP_API_KEY=your_api_key
# AI_MODEL=claude-3-5-sonnet-20241022
# AI_BASE_URL=https://api.anthropic.com/v1