shiyue/upage-git
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add upage usage instructions document

Browse Source
This commit is contained in:
LIlGG
2025-09-28 18:01:20 +08:00
parent cf35ba7399
commit 1d944e54e8
11 changed files with 130 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.env.example
View File

@@ -40,10 +40,10 @@ PROVIDER_BASE_URL=
# {"region": "us-east-1", "accessKeyId": "yourAccessKeyId", "secretAccessKey": "yourSecretAccessKey", "sessionToken": "yourSessionToken"} # {"region": "us-east-1", "accessKeyId": "yourAccessKeyId", "secretAccessKey": "yourSecretAccessKey", "sessionToken": "yourSessionToken"}
PROVIDER_API_KEY= PROVIDER_API_KEY=
# MODEL used for page generation (should correspond to LLM_DEFAULT_PROVIDER) # MODEL used for page generation (should correspond to LLM_PROVIDER)
LLM_DEFAULT_MODEL= LLM_DEFAULT_MODEL=
# MODEL used for auxiliary page generation, such as summarization and pre-analysis. (should correspond to LLM_DEFAULT_PROVIDER) # MODEL used for auxiliary page generation, such as summarization and pre-analysis. (should correspond to LLM_PROVIDER)
LLM_MINOR_MODEL= LLM_MINOR_MODEL=
# Get your Serper API Key https://serper.dev/ # Get your Serper API Key https://serper.dev/

5
app/lib/modules/llm/providers/together.ts
View File

@@ -58,9 +58,10 @@ export default class TogetherProvider extends BaseProvider {
getModelInstance(options: { model: string; providerSettings?: Record<string, IProviderSetting> }): LanguageModel { getModelInstance(options: { model: string; providerSettings?: Record<string, IProviderSetting> }): LanguageModel {
const { model, providerSettings } = options; const { model, providerSettings } = options;
const { baseUrl, apiKey } = this.getProviderBaseUrlAndKey(providerSettings?.[this.name]); const { baseUrl: fetchBaseUrl, apiKey } = this.getProviderBaseUrlAndKey(providerSettings?.[this.name]);
const baseUrl = fetchBaseUrl || 'https://api.together.xyz/v1';
if (!baseUrl || !apiKey) { if (!apiKey) {
throw new Error(`Missing configuration for ${this.name} provider`); throw new Error(`Missing configuration for ${this.name} provider`);
} }

2
docker-compose-dev.yaml
View File

@@ -10,7 +10,7 @@ services:
- NODE_ENV=${NODE_ENV:-production} - NODE_ENV=${NODE_ENV:-production}
- LOG_LEVEL=${LOG_LEVEL:-debug} - LOG_LEVEL=${LOG_LEVEL:-debug}
- DEFAULT_NUM_CTX=${DEFAULT_NUM_CTX:-32768} - DEFAULT_NUM_CTX=${DEFAULT_NUM_CTX:-32768}
- LLM_PROVIDER=${LLM_DEFAULT_PROVIDER} - LLM_PROVIDER=${LLM_PROVIDER}
- PROVIDER_BASE_URL=${PROVIDER_BASE_URL} - PROVIDER_BASE_URL=${PROVIDER_BASE_URL}
- PROVIDER_API_KEY=${PROVIDER_API_KEY} - PROVIDER_API_KEY=${PROVIDER_API_KEY}
- LLM_DEFAULT_MODEL=${LLM_DEFAULT_MODEL} - LLM_DEFAULT_MODEL=${LLM_DEFAULT_MODEL}

2
docker-compose-prod.yaml
View File

@@ -10,7 +10,7 @@ services:
- NODE_ENV=${NODE_ENV:-production} - NODE_ENV=${NODE_ENV:-production}
- LOG_LEVEL=${LOG_LEVEL:-debug} - LOG_LEVEL=${LOG_LEVEL:-debug}
- DEFAULT_NUM_CTX=${DEFAULT_NUM_CTX:-32768} - DEFAULT_NUM_CTX=${DEFAULT_NUM_CTX:-32768}
- LLM_PROVIDER=${LLM_DEFAULT_PROVIDER} - LLM_PROVIDER=${LLM_PROVIDER}
- PROVIDER_BASE_URL=${PROVIDER_BASE_URL} - PROVIDER_BASE_URL=${PROVIDER_BASE_URL}
- PROVIDER_API_KEY=${PROVIDER_API_KEY} - PROVIDER_API_KEY=${PROVIDER_API_KEY}
- LLM_DEFAULT_MODEL=${LLM_DEFAULT_MODEL} - LLM_DEFAULT_MODEL=${LLM_DEFAULT_MODEL}

107
docs/content/configuration.md
View File

@@ -29,25 +29,31 @@ UPage 使用环境变量进行配置。您可以通过以下方式设置环境
UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用页面生成功能。 UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用页面生成功能。
### AI 基础配置 :::tip 配置参数颜色说明
为了帮助您区分不同提供商所需的配置参数，我们使用了不同的颜色标记：
- <span className="base-url-highlight">API 基础 URL</span>: 用蓝色标记，通常是服务的访问地址
- <span className="api-key-highlight">API 密钥</span>: 用红色标记，通常是敏感信息，需要从提供商处获取
:::
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | LLM 提供商，根据需要配置一个 | - | 是 | | `LLM_PROVIDER` | LLM 提供商，按照下述配置项配置一个 | - | 是 |
| <span className="base-url-highlight">`PROVIDER_BASE_URL`</span> | LLM 提供商的 API 基础 URL，部分提供商需要设置此项，例如 OpenAILike, Ollama, LMStudio | - | 否，部分提供商不需要设置此项 |
| <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | LLM 提供商的 API 密钥，大部分提供商需要设置此项 | - | 否，部分提供商不需要设置此项 |
| `LLM_DEFAULT_MODEL` | 生成页面所使用的模型 | - | 是 | | `LLM_DEFAULT_MODEL` | 生成页面所使用的模型 | - | 是 |
| `LLM_MINOR_MODEL` | 辅助页面生成所使用的模型 | - | 是 | | `LLM_MINOR_MODEL` | 辅助页面生成所使用的模型 | - | 是 |
| `LLM_ENABLED_PROVIDERS` | 启用的 LLM 提供商列表（逗号分隔） | 所有支持的提供商 | 否 |
以下是常见的 AI 提供商配置：
### Amazon Bedrock ### Amazon Bedrock
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | Amazon Bedrock 提供商名称 | AmazonBedrock | 是 | | `LLM_PROVIDER` | Amazon Bedrock 提供商名称 | AmazonBedrock | 是 |
| `AWS_BEDROCK_CONFIG` | Amazon Bedrock 配置 | - | 是（如果使用 Amazon Bedrock） | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | Amazon Bedrock 配置 | - | 是（如果使用 Amazon Bedrock） |
:::info :::info
前往 [Amazon Bedrock](https://console.aws.amazon.com/iam/home) 中获取配置。 在 Amazon Bedrock 提供商中，`PROVIDER_API_KEY` 应为 JSON 格式。例如：
`AWS_BEDROCK_CONFIG` 应为 JSON 格式，例如：
```json ```json
{ {
// Bedrock 可用的 AWS 区域 // Bedrock 可用的 AWS 区域
@@ -60,14 +66,15 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
"sessionToken": "your-session-token" "sessionToken": "your-session-token"
} }
``` ```
前往 [Amazon Bedrock](https://console.aws.amazon.com/iam/home) 中获取配置。
::: :::
### Anthropic Claude ### Anthropic Claude
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | Anthropic 提供商 | Anthropic | 是 | | `LLM_PROVIDER` | Anthropic 提供商 | Anthropic | 是 |
| `ANTHROPIC_API_KEY` | Anthropic API 密钥 | - | 是（如果使用 Anthropic） | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | Anthropic API 密钥 | - | 是（如果使用 Anthropic） |
:::info :::info
前往 [Anthropic](https://console.anthropic.com/settings/keys) 获取 API 密钥。 前往 [Anthropic](https://console.anthropic.com/settings/keys) 获取 API 密钥。
@@ -77,8 +84,8 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | Cohere 提供商名称 | Cohere | 是 | | `LLM_PROVIDER` | Cohere 提供商名称 | Cohere | 是 |
| `COHERE_API_KEY` | Cohere API 密钥 | - | 是（如果使用 Cohere） | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | Cohere API 密钥 | - | 是（如果使用 Cohere） |
:::info :::info
前往 [Cohere](https://dashboard.cohere.com/api-keys) 获取 API 密钥。 前往 [Cohere](https://dashboard.cohere.com/api-keys) 获取 API 密钥。
@@ -88,8 +95,8 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | DeepSeek 提供商名称 | Deepseek | 是 | | `LLM_PROVIDER` | DeepSeek 提供商名称 | Deepseek | 是 |
| `DEEPSEEK_API_KEY` | DeepSeek API 密钥 | - | 是（如果使用 DeepSeek） | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | DeepSeek API 密钥 | - | 是（如果使用 DeepSeek） |
:::info :::info
前往 [DeepSeek](https://platform.deepseek.com/api_keys) 获取 API 密钥。 前往 [DeepSeek](https://platform.deepseek.com/api_keys) 获取 API 密钥。
@@ -99,8 +106,8 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | Github 提供商名称 | Github | 是 | | `LLM_PROVIDER` | Github 提供商名称 | Github | 是 |
| `GITHUB_API_KEY` | Github API 密钥 | - | 是（如果使用 Github） | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | Github API 密钥 | - | 是（如果使用 Github） |
:::info :::info
前往 [Github](https://github.com/settings/personal-access-tokens) 获取 API 密钥。 前往 [Github](https://github.com/settings/personal-access-tokens) 获取 API 密钥。
@@ -110,8 +117,8 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | Google 提供商名称 | Google | 是 | | `LLM_PROVIDER` | Google 提供商名称 | Google | 是 |
| `GOOGLE_GENERATIVE_AI_API_KEY` | Google 生成式 AI API 密钥 | - | 是（如果使用 Google） | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | Google 生成式 AI API 密钥 | - | 是（如果使用 Google） |
:::info :::info
前往 [Google](https://console.cloud.google.com/apis/credentials) 获取 API 密钥。 前往 [Google](https://console.cloud.google.com/apis/credentials) 获取 API 密钥。
@@ -121,8 +128,8 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | Groq 提供商名称 | Groq | 是 | | `LLM_PROVIDER` | Groq 提供商名称 | Groq | 是 |
| `GROQ_API_KEY` | Groq API 密钥 | - | 是（如果使用 Groq） | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | Groq API 密钥 | - | 是（如果使用 Groq） |
:::info :::info
前往 [Groq](https://console.groq.com/keys) 获取 API 密钥。 前往 [Groq](https://console.groq.com/keys) 获取 API 密钥。
@@ -132,8 +139,8 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | HuggingFace 提供商名称 | HuggingFace | 是 | | `LLM_PROVIDER` | HuggingFace 提供商名称 | HuggingFace | 是 |
| `HuggingFace_API_KEY` | HuggingFace API 密钥 | - | 是（如果使用 HuggingFace） | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | HuggingFace API 密钥 | - | 是（如果使用 HuggingFace） |
:::info :::info
前往 [HuggingFace](https://huggingface.co/settings/tokens) 获取 API 密钥。 前往 [HuggingFace](https://huggingface.co/settings/tokens) 获取 API 密钥。
@@ -143,8 +150,8 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | Hyperbolic 提供商名称 | Hyperbolic | 是 | | `LLM_PROVIDER` | Hyperbolic 提供商名称 | Hyperbolic | 是 |
| `HYPERBOLIC_API_KEY` | Hyperbolic API 密钥 | - | 是（如果使用 Hyperbolic） | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | Hyperbolic API 密钥 | - | 是（如果使用 Hyperbolic） |
:::info :::info
前往 [Hyperbolic](https://hyperbolic.ai/dashboard/api-keys) 获取 API 密钥。 前往 [Hyperbolic](https://hyperbolic.ai/dashboard/api-keys) 获取 API 密钥。
@@ -154,8 +161,8 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | LMStudio 提供商名称 | LMStudio | 是 | | `LLM_PROVIDER` | LMStudio 提供商名称 | LMStudio | 是 |
| `LMSTUDIO_API_BASE_URL` | LMStudio API URL | `http://127.0.0.1:1234` | 是（如果使用 LMStudio） | | <span className="base-url-highlight">`PROVIDER_BASE_URL`</span> | LMStudio API URL | `http://127.0.0.1:1234` | 是（如果使用 LMStudio） |
:::warning :::warning
由于可能存在的 IPV6 的问题，所以不要使用 http://localhost:1234 而应该使用类似于 http://127.0.0.1:1234 的地址 由于可能存在的 IPV6 的问题，所以不要使用 http://localhost:1234 而应该使用类似于 http://127.0.0.1:1234 的地址
@@ -165,8 +172,8 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | Mistral 提供商名称 | Mistral | 是 | | `LLM_PROVIDER` | Mistral 提供商名称 | Mistral | 是 |
| `MISTRAL_API_KEY` | Mistral API 密钥 | - | 是（如果使用 Mistral） | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | Mistral API 密钥 | - | 是（如果使用 Mistral） |
:::info :::info
前往 [Mistral](https://console.mistral.ai/api-keys/) 获取 API 密钥。 前往 [Mistral](https://console.mistral.ai/api-keys/) 获取 API 密钥。
@@ -176,8 +183,8 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | Ollama 提供商名称 | Ollama | 是 | | `LLM_PROVIDER` | Ollama 提供商名称 | Ollama | 是 |
| `OLLAMA_API_BASE_URL` | Ollama API URL | `http://127.0.0.1:11434` | 是（如果使用 Ollama） | | <span className="base-url-highlight">`PROVIDER_BASE_URL`</span> | Ollama API URL | `http://127.0.0.1:11434` | 是（如果使用 Ollama） |
:::warning :::warning
由于可能存在的 IPV6 的问题，所以不要使用 http://localhost:11434 而应该使用类似于 http://127.0.0.1:11434 的地址 由于可能存在的 IPV6 的问题，所以不要使用 http://localhost:11434 而应该使用类似于 http://127.0.0.1:11434 的地址
@@ -187,8 +194,8 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | OpenRouter 提供商名称 | OpenRouter | 是 | | `LLM_PROVIDER` | OpenRouter 提供商名称 | OpenRouter | 是 |
| `OPEN_ROUTER_API_KEY` | OpenRouter API 密钥 | - | 是（如果使用 OpenRouter） | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | OpenRouter API 密钥 | - | 是（如果使用 OpenRouter） |
:::info :::info
前往 [OpenRouter](https://openrouter.ai/settings/keys) 获取 API 密钥。 前往 [OpenRouter](https://openrouter.ai/settings/keys) 获取 API 密钥。
@@ -198,16 +205,16 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | OpenAILike 提供商名称 | OpenAILike | 是 | | `LLM_PROVIDER` | OpenAILike 提供商名称 | OpenAILike | 是 |
| `OPENAI_LIKE_API_BASE_URL` | API 基础 URL | - | 是（如果使用 OpenAILike） | | <span className="base-url-highlight">`PROVIDER_BASE_URL`</span> | API 基础 URL | - | 是（如果使用 OpenAILike） |
| `OPENAI_LIKE_API_KEY` | API 密钥 | - | 是（如果使用 OpenAILike） | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | API 密钥 | - | 是（如果使用 OpenAILike） |
### OpenAI ### OpenAI
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | OpenAI 提供商名称 | OpenAI | 是 | | `LLM_PROVIDER` | OpenAI 提供商名称 | OpenAI | 是 |
| `OPENAI_API_KEY` | OpenAI API 密钥 | - | 是（如果使用 OpenAI） | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | OpenAI API 密钥 | - | 是（如果使用 OpenAI） |
:::info :::info
前往 [OpenAI](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key) 获取 API 密钥。 前往 [OpenAI](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key) 获取 API 密钥。
@@ -217,8 +224,8 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | Perplexity 提供商名称 | Perplexity | 是 | | `LLM_PROVIDER` | Perplexity 提供商名称 | Perplexity | 是 |
| `PERPLEXITY_API_KEY` | Perplexity API 密钥 | - | 是（如果使用 Perplexity） | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | Perplexity API 密钥 | - | 是（如果使用 Perplexity） |
:::info :::info
前往 [Perplexity](https://www.perplexity.ai/settings/api) 获取 API 密钥。 前往 [Perplexity](https://www.perplexity.ai/settings/api) 获取 API 密钥。
@@ -228,9 +235,8 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | Together 提供商名称 | Together | 是 | | `LLM_PROVIDER` | Together 提供商名称 | Together | 是 |
| `TOGETHER_API_BASE_URL` | Together API 基础 URL | - | 是（如果使用 Together） | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | Together API 密钥 | - | 是（如果使用 Together） |
| `TOGETHER_API_KEY` | Together API 密钥 | - | 是（如果使用 Together） |
:::info :::info
前往 [Together](https://api.together.xyz/settings/api-keys) 获取 API 密钥。 前往 [Together](https://api.together.xyz/settings/api-keys) 获取 API 密钥。
@@ -240,8 +246,8 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | xAI 提供商名称 | xAI | 是 | | `LLM_PROVIDER` | xAI 提供商名称 | xAI | 是 |
| `XAI_API_KEY` | xAI API 密钥 | - | 是（如果使用 xAI） | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | xAI API 密钥 | - | 是（如果使用 xAI） |
:::info :::info
前往 [xAI](https://x.ai/api) 获取 API 密钥。 前往 [xAI](https://x.ai/api) 获取 API 密钥。
@@ -318,9 +324,8 @@ services:
- STORAGE_DIR=/app/storage - STORAGE_DIR=/app/storage
# 使用 DeepSeek 提供商配置 # 使用 DeepSeek 提供商配置
- LLM_DEFAULT_PROVIDER=DeepSeek - LLM_PROVIDER=DeepSeek
# 这里使用 DEEPSEEK_API_KEY - PROVIDER_API_KEY=your-deepseek-api-key
- DEEPSEEK_API_KEY=your-deepseek-api-key
- LLM_DEFAULT_MODEL=deepseek-chat - LLM_DEFAULT_MODEL=deepseek-chat
- LLM_MINOR_MODEL=deepseek-chat - LLM_MINOR_MODEL=deepseek-chat
@@ -341,7 +346,7 @@ services:
- ./storage:/app/storage - ./storage:/app/storage
``` ```
如果你要切换使用其他 AI 提供商，则只需要修改 `LLM_DEFAULT_PROVIDER` 和相应的 API 密钥、Model 即可，例如： 如果你要切换使用其他 AI 提供商，则只需要修改 `LLM_PROVIDER` 和相应的 API 密钥、Model 即可，例如：
```yaml ```yaml
version: "3.9" version: "3.9"
@@ -353,10 +358,10 @@ services:
ports: ports:
- "3000:3000" - "3000:3000"
environment: environment:
# 使用 OpenAI 提供商配置 # 使用 OpenAI 兼容接口的提供商配置
- LLM_DEFAULT_PROVIDER=OpenAI - LLM_PROVIDER=OpenAILike
# 这里注意需要改为 OPENAI_API_KEY - PROVIDER_BASE_URL=your-openai-api-base-url
- OPENAI_API_KEY=your-openai-api-key - PROVIDER_API_KEY=your-openai-api-key
- LLM_DEFAULT_MODEL=gpt-4.1 - LLM_DEFAULT_MODEL=gpt-4.1
- LLM_MINOR_MODEL=gpt-4.1-mini - LLM_MINOR_MODEL=gpt-4.1-mini

12
docs/content/deployment/docker-compose.md
View File

@@ -48,9 +48,9 @@ services:
ports: ports:
- "${PORT:-3000}:3000" - "${PORT:-3000}:3000"
environment: environment:
- OPENAI_LIKE_API_BASE_URL=${OPENAI_LIKE_API_BASE_URL} - LLM_PROVIDER=${LLM_PROVIDER}
- OPENAI_LIKE_API_KEY=${OPENAI_LIKE_API_KEY} - PROVIDER_BASE_URL=${PROVIDER_BASE_URL}
- LLM_DEFAULT_PROVIDER=${LLM_DEFAULT_PROVIDER} - PROVIDER_API_KEY=${PROVIDER_API_KEY}
- LLM_DEFAULT_MODEL=${LLM_DEFAULT_MODEL} - LLM_DEFAULT_MODEL=${LLM_DEFAULT_MODEL}
- LLM_MINOR_MODEL=${LLM_MINOR_MODEL} - LLM_MINOR_MODEL=${LLM_MINOR_MODEL}
volumes: volumes:
@@ -116,9 +116,9 @@ UPage 支持通过环境变量进行配置。以下是一些比较重要的环
| 环境变量 | 描述 | 必填 | 示例 | | 环境变量 | 描述 | 必填 | 示例 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | 默认 LLM 提供商 | 是 | `OpenAILike` | | `LLM_PROVIDER` | 默认 LLM 提供商 | 是 | `OpenAILike` |
| `OPENAI_LIKE_API_BASE_URL` | OpenAI 兼容 API 基础 URL | 是 | `https://your-api-base-url` | | `PROVIDER_BASE_URL` | OpenAI 兼容 API 基础 URL | 是 | `https://your-api-base-url` |
| `OPENAI_LIKE_API_KEY` | OpenAI 兼容 API 密钥 | 是 | `your-openai-like-api-key` | | `PROVIDER_API_KEY` | OpenAI 兼容 API 密钥 | 是 | `your-openai-like-api-key` |
### 大模型配置 ### 大模型配置

18
docs/content/deployment/docker.md
View File

@@ -56,9 +56,9 @@ docker run -d \
--name upage \ --name upage \
--restart unless-stopped \ --restart unless-stopped \
-p 3000:3000 \ -p 3000:3000 \
-e LLM_DEFAULT_PROVIDER=OpenAILike \ -e LLM_PROVIDER=OpenAILike \
-e OPENAI_LIKE_API_BASE_URL=your-openai-like-api-base-url \ -e PROVIDER_BASE_URL=your-openai-like-api-base-url \
-e OPENAI_LIKE_API_KEY=your-openai-like-api-key \ -e PROVIDER_API_KEY=your-openai-like-api-key \
-e LLM_DEFAULT_MODEL=your-default-model \ -e LLM_DEFAULT_MODEL=your-default-model \
-e LLM_MINOR_MODEL=your-minor-model \ -e LLM_MINOR_MODEL=your-minor-model \
-v ~/upage/data:/app/data \ -v ~/upage/data:/app/data \
@@ -113,9 +113,9 @@ UPage 支持通过环境变量进行配置。以下是一些比较重要的环
| 环境变量 | 描述 | 必填 | 示例 | | 环境变量 | 描述 | 必填 | 示例 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | 默认 LLM 提供商 | 是 | `OpenAILike` | | `LLM_PROVIDER` | 默认 LLM 提供商 | 是 | `OpenAILike` |
| `OPENAI_LIKE_API_BASE_URL` | OpenAI 兼容 API 基础 URL | 是 | `https://your-api-base-url` | | `PROVIDER_BASE_URL` | OpenAI 兼容 API 基础 URL | 是 | `https://your-api-base-url` |
| `OPENAI_LIKE_API_KEY` | OpenAI 兼容 API 密钥 | 是 | `your-openai-like-api-key` | | `PROVIDER_API_KEY` | OpenAI 兼容 API 密钥 | 是 | `your-openai-like-api-key` |
### 大模型配置 ### 大模型配置
@@ -141,9 +141,9 @@ docker run -d \
--name upage \ --name upage \
--restart unless-stopped \ --restart unless-stopped \
-p 3000:3000 \ -p 3000:3000 \
-e LLM_DEFAULT_PROVIDER=OpenAILike \ -e LLM_PROVIDER=OpenAILike \
-e OPENAI_LIKE_API_BASE_URL=your-openai-like-api-base-url \ -e PROVIDER_BASE_URL=your-openai-like-api-base-url \
-e OPENAI_LIKE_API_KEY=your-openai-like-api-key \ -e PROVIDER_API_KEY=your-openai-like-api-key \
-e LLM_DEFAULT_MODEL=your-default-model \ -e LLM_DEFAULT_MODEL=your-default-model \
-e LLM_MINOR_MODEL=your-minor-model \ -e LLM_MINOR_MODEL=your-minor-model \
-v ~/upage/data:/app/data \ -v ~/upage/data:/app/data \

12
docs/content/deployment/source.md
View File

@@ -55,9 +55,9 @@ MAX_UPLOAD_SIZE_MB=5
STORAGE_DIR=./storage STORAGE_DIR=./storage
# AI 提供商配置 # AI 提供商配置
LLM_DEFAULT_PROVIDER=OpenAILike LLM_PROVIDER=OpenAILike
OPENAI_LIKE_API_BASE_URL=your-openai-like-api-base-url PROVIDER_BASE_URL=your-openai-like-api-base-url
OPENAI_LIKE_API_KEY=your-openai-like-api-key PROVIDER_API_KEY=your-openai-like-api-key
LLM_DEFAULT_MODEL=your-default-model LLM_DEFAULT_MODEL=your-default-model
LLM_MINOR_MODEL=your-minor-model LLM_MINOR_MODEL=your-minor-model
``` ```
@@ -135,9 +135,9 @@ module.exports = {
NODE_ENV: 'production', NODE_ENV: 'production',
OPERATING_ENV: 'production', OPERATING_ENV: 'production',
PORT: 3000, PORT: 3000,
LLM_DEFAULT_PROVIDER: 'OpenAILike', LLM_PROVIDER: 'OpenAILike',
OPENAI_LIKE_API_BASE_URL: 'your-openai-like-api-base-url', PROVIDER_BASE_URL: 'your-openai-like-api-base-url',
OPENAI_LIKE_API_KEY: 'your-openai-like-api-key', PROVIDER_API_KEY: 'your-openai-like-api-key',
LLM_DEFAULT_MODEL: 'your-default-model', LLM_DEFAULT_MODEL: 'your-default-model',
LLM_MINOR_MODEL: 'your-minor-model', LLM_MINOR_MODEL: 'your-minor-model',
} }

14
docs/content/faq.md
View File

@@ -39,9 +39,9 @@ docker run -d \
--name upage \ --name upage \
--restart unless-stopped \ --restart unless-stopped \
-p 3000:3000 \ -p 3000:3000 \
-e LLM_DEFAULT_PROVIDER=OpenAILike \ -e LLM_PROVIDER=OpenAILike \
-e OPENAI_LIKE_API_BASE_URL=your-openai-like-api-base-url \ -e PROVIDER_BASE_URL=your-openai-like-api-base-url \
-e OPENAI_LIKE_API_KEY=your-openai-like-api-key \ -e PROVIDER_API_KEY=your-openai-like-api-key \
-e LLM_DEFAULT_MODEL=your-default-model \ -e LLM_DEFAULT_MODEL=your-default-model \
-e LLM_MINOR_MODEL=your-minor-model \ -e LLM_MINOR_MODEL=your-minor-model \
-v ./data:/app/data \ -v ./data:/app/data \
@@ -112,14 +112,14 @@ UPage 支持多种 AI 提供商，包括：
```bash ```bash
# OpenAI # OpenAI
-e LLM_DEFAULT_PROVIDER=OpenAI \ -e LLM_PROVIDER=OpenAI \
-e OPENAI_API_KEY=your-openai-api-key \ -e PROVIDER_API_KEY=your-openai-api-key \
-e LLM_DEFAULT_MODEL=gpt-4-turbo \ -e LLM_DEFAULT_MODEL=gpt-4-turbo \
-e LLM_MINOR_MODEL=gpt-3.5-turbo -e LLM_MINOR_MODEL=gpt-3.5-turbo
# Anthropic Claude # Anthropic Claude
-e LLM_DEFAULT_PROVIDER=Anthropic \ -e LLM_PROVIDER=Anthropic \
-e ANTHROPIC_API_KEY=your-anthropic-api-key \ -e PROVIDER_API_KEY=your-anthropic-api-key \
-e LLM_DEFAULT_MODEL=claude-3-opus-20240229 \ -e LLM_DEFAULT_MODEL=claude-3-opus-20240229 \
-e LLM_MINOR_MODEL=claude-3-haiku-20240307 -e LLM_MINOR_MODEL=claude-3-haiku-20240307
``` ```

34
docs/content/quick-start.md
View File

@@ -29,9 +29,9 @@ docker run -d \
--name upage \ --name upage \
--restart unless-stopped \ --restart unless-stopped \
-p 3000:3000 \ -p 3000:3000 \
-e LLM_DEFAULT_PROVIDER=OpenAILike \ -e LLM_PROVIDER=OpenAILike \
-e OPENAI_LIKE_API_BASE_URL=your-openai-like-api-base-url \ -e PROVIDER_BASE_URL=your-openai-like-api-base-url \
-e OPENAI_LIKE_API_KEY=your-openai-like-api-key \ -e PROVIDER_API_KEY=your-openai-like-api-key \
-e LLM_DEFAULT_MODEL=your-default-model \ -e LLM_DEFAULT_MODEL=your-default-model \
-e LLM_MINOR_MODEL=your-minor-model \ -e LLM_MINOR_MODEL=your-minor-model \
-v ./data:/app/data \ -v ./data:/app/data \
@@ -42,9 +42,9 @@ docker run -d \
### 参数说明 ### 参数说明
- `-e LLM_DEFAULT_PROVIDER=OpenAILike`：设置默认的 LLM 提供商 - `-e LLM_PROVIDER=OpenAILike`：设置默认的 LLM 提供商
- `-e OPENAI_LIKE_API_BASE_URL=your-openai-like-api-base-url`：设置 API 基础 URL - `-e PROVIDER_BASE_URL=your-openai-like-api-base-url`：设置 API 基础 URL
- `-e OPENAI_LIKE_API_KEY=your-openai-like-api-key`：设置 API 密钥 - `-e PROVIDER_API_KEY=your-openai-like-api-key`：设置 API 密钥
- `-e LLM_DEFAULT_MODEL=your-default-model`：设置用于页面生成的默认 AI 模型 - `-e LLM_DEFAULT_MODEL=your-default-model`：设置用于页面生成的默认 AI 模型
- `-e LLM_MINOR_MODEL=your-minor-model`：设置用于辅助任务的 AI 模型 - `-e LLM_MINOR_MODEL=your-minor-model`：设置用于辅助任务的 AI 模型
- `-v ./data:/app/data`：挂载数据目录，用于存储数据库文件 - `-v ./data:/app/data`：挂载数据目录，用于存储数据库文件
@@ -67,8 +67,8 @@ UPage 支持多种 AI 提供商，您需要至少配置一个 AI 提供商才能
### DeepSeek ### DeepSeek
```bash ```bash
-e LLM_DEFAULT_PROVIDER=Deepseek \ -e LLM_PROVIDER=Deepseek \
-e DEEPSEEK_API_KEY=your-deepseek-api-key \ -e PROVIDER_API_KEY=your-deepseek-api-key \
-e LLM_DEFAULT_MODEL=deepseek-chat \ -e LLM_DEFAULT_MODEL=deepseek-chat \
-e LLM_MINOR_MODEL=deepseek-reasoner -e LLM_MINOR_MODEL=deepseek-reasoner
``` ```
@@ -76,9 +76,9 @@ UPage 支持多种 AI 提供商，您需要至少配置一个 AI 提供商才能
### 兼容 OpenAI 接口的服务 ### 兼容 OpenAI 接口的服务
```bash ```bash
-e LLM_DEFAULT_PROVIDER=OpenAILike \ -e LLM_PROVIDER=OpenAILike \
-e OPENAI_LIKE_API_BASE_URL=https://your-api-base-url \ -e PROVIDER_BASE_URL=https://your-api-base-url \
-e OPENAI_LIKE_API_KEY=your-api-key \ -e PROVIDER_API_KEY=your-api-key \
-e LLM_DEFAULT_MODEL=your-model-name \ -e LLM_DEFAULT_MODEL=your-model-name \
-e LLM_MINOR_MODEL=your-minor-model-name -e LLM_MINOR_MODEL=your-minor-model-name
``` ```
@@ -86,8 +86,8 @@ UPage 支持多种 AI 提供商，您需要至少配置一个 AI 提供商才能
### OpenAI ### OpenAI
```bash ```bash
-e LLM_DEFAULT_PROVIDER=OpenAI \ -e LLM_PROVIDER=OpenAI \
-e OPENAI_API_KEY=your-openai-api-key \ -e PROVIDER_API_KEY=your-openai-api-key \
-e LLM_DEFAULT_MODEL=gpt-4-turbo \ -e LLM_DEFAULT_MODEL=gpt-4-turbo \
-e LLM_MINOR_MODEL=gpt-3.5-turbo -e LLM_MINOR_MODEL=gpt-3.5-turbo
``` ```
@@ -95,8 +95,8 @@ UPage 支持多种 AI 提供商，您需要至少配置一个 AI 提供商才能
### Anthropic Claude ### Anthropic Claude
```bash ```bash
-e LLM_DEFAULT_PROVIDER=Anthropic \ -e LLM_PROVIDER=Anthropic \
-e ANTHROPIC_API_KEY=your-anthropic-api-key \ -e PROVIDER_API_KEY=your-anthropic-api-key \
-e LLM_DEFAULT_MODEL=claude-3-opus-20240229 \ -e LLM_DEFAULT_MODEL=claude-3-opus-20240229 \
-e LLM_MINOR_MODEL=claude-3-haiku-20240307 -e LLM_MINOR_MODEL=claude-3-haiku-20240307
``` ```
@@ -104,8 +104,8 @@ UPage 支持多种 AI 提供商，您需要至少配置一个 AI 提供商才能
### Ollama ### Ollama
```bash ```bash
-e LLM_DEFAULT_PROVIDER=Ollama \ -e LLM_PROVIDER=Ollama \
-e OLLAMA_API_BASE_URL=http://127.0.0.1:11434 \ -e PROVIDER_BASE_URL=http://127.0.0.1:11434 \
-e LLM_DEFAULT_MODEL=llama3 \ -e LLM_DEFAULT_MODEL=llama3 \
-e LLM_MINOR_MODEL=llama3 -e LLM_MINOR_MODEL=llama3
``` ```

22
docs/src/css/custom.css
View File

@@ -28,3 +28,25 @@
--ifm-color-primary-lightest: #bcc2e5; --ifm-color-primary-lightest: #bcc2e5;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
} }
/* 为 API KEY 和 BASE URL 添加不同的颜色样式 */
/* 红色，表示 API KEY */
.api-key-highlight {
color: #e53935;
font-weight: bold;
}
/* 蓝色，表示 BASE URL */
.base-url-highlight {
color: #2196f3;
font-weight: bold;
}
/* 暗色模式下的颜色调整 */
[data-theme="dark"] .api-key-highlight {
color: #ff7961;
}
[data-theme="dark"] .base-url-highlight {
color: #64b5f6;
}