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

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

@@ -48,9 +48,9 @@ services:
ports:
- "${PORT:-3000}:3000"
environment:
- OPENAI_LIKE_API_BASE_URL=${OPENAI_LIKE_API_BASE_URL}
- OPENAI_LIKE_API_KEY=${OPENAI_LIKE_API_KEY}
- LLM_DEFAULT_PROVIDER=${LLM_DEFAULT_PROVIDER}
- LLM_PROVIDER=${LLM_PROVIDER}
- PROVIDER_BASE_URL=${PROVIDER_BASE_URL}
- PROVIDER_API_KEY=${PROVIDER_API_KEY}
- LLM_DEFAULT_MODEL=${LLM_DEFAULT_MODEL}
- LLM_MINOR_MODEL=${LLM_MINOR_MODEL}
volumes:
@@ -116,9 +116,9 @@ UPage 支持通过环境变量进行配置。以下是一些比较重要的环
| 环境变量 | 描述 | 必填 | 示例 |
| --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | 默认 LLM 提供商 | 是 | `OpenAILike` |
| `OPENAI_LIKE_API_BASE_URL` | OpenAI 兼容 API 基础 URL | 是 | `https://your-api-base-url` |
| `OPENAI_LIKE_API_KEY` | OpenAI 兼容 API 密钥 | 是 | `your-openai-like-api-key` |
| `LLM_PROVIDER` | 默认 LLM 提供商 | 是 | `OpenAILike` |
| `PROVIDER_BASE_URL` | OpenAI 兼容 API 基础 URL | 是 | `https://your-api-base-url` |
| `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 \
--restart unless-stopped \
-p 3000:3000 \
-e LLM_DEFAULT_PROVIDER=OpenAILike \
-e OPENAI_LIKE_API_BASE_URL=your-openai-like-api-base-url \
-e OPENAI_LIKE_API_KEY=your-openai-like-api-key \
-e LLM_PROVIDER=OpenAILike \
-e PROVIDER_BASE_URL=your-openai-like-api-base-url \
-e PROVIDER_API_KEY=your-openai-like-api-key \
-e LLM_DEFAULT_MODEL=your-default-model \
-e LLM_MINOR_MODEL=your-minor-model \
-v ~/upage/data:/app/data \
@@ -113,9 +113,9 @@ UPage 支持通过环境变量进行配置。以下是一些比较重要的环
| 环境变量 | 描述 | 必填 | 示例 |
| --- | --- | --- | --- |
| `LLM_DEFAULT_PROVIDER` | 默认 LLM 提供商 | 是 | `OpenAILike` |
| `OPENAI_LIKE_API_BASE_URL` | OpenAI 兼容 API 基础 URL | 是 | `https://your-api-base-url` |
| `OPENAI_LIKE_API_KEY` | OpenAI 兼容 API 密钥 | 是 | `your-openai-like-api-key` |
| `LLM_PROVIDER` | 默认 LLM 提供商 | 是 | `OpenAILike` |
| `PROVIDER_BASE_URL` | OpenAI 兼容 API 基础 URL | 是 | `https://your-api-base-url` |
| `PROVIDER_API_KEY` | OpenAI 兼容 API 密钥 | 是 | `your-openai-like-api-key` |
### 大模型配置
@@ -141,9 +141,9 @@ docker run -d \
--name upage \
--restart unless-stopped \
-p 3000:3000 \
-e LLM_DEFAULT_PROVIDER=OpenAILike \
-e OPENAI_LIKE_API_BASE_URL=your-openai-like-api-base-url \
-e OPENAI_LIKE_API_KEY=your-openai-like-api-key \
-e LLM_PROVIDER=OpenAILike \
-e PROVIDER_BASE_URL=your-openai-like-api-base-url \
-e PROVIDER_API_KEY=your-openai-like-api-key \
-e LLM_DEFAULT_MODEL=your-default-model \
-e LLM_MINOR_MODEL=your-minor-model \
-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
# AI 提供商配置
LLM_DEFAULT_PROVIDER=OpenAILike
OPENAI_LIKE_API_BASE_URL=your-openai-like-api-base-url
OPENAI_LIKE_API_KEY=your-openai-like-api-key
LLM_PROVIDER=OpenAILike
PROVIDER_BASE_URL=your-openai-like-api-base-url
PROVIDER_API_KEY=your-openai-like-api-key
LLM_DEFAULT_MODEL=your-default-model
LLM_MINOR_MODEL=your-minor-model
```
@@ -135,9 +135,9 @@ module.exports = {
NODE_ENV: 'production',
OPERATING_ENV: 'production',
PORT: 3000,
LLM_DEFAULT_PROVIDER: 'OpenAILike',
OPENAI_LIKE_API_BASE_URL: 'your-openai-like-api-base-url',
OPENAI_LIKE_API_KEY: 'your-openai-like-api-key',
LLM_PROVIDER: 'OpenAILike',
PROVIDER_BASE_URL: 'your-openai-like-api-base-url',
PROVIDER_API_KEY: 'your-openai-like-api-key',
LLM_DEFAULT_MODEL: 'your-default-model',
LLM_MINOR_MODEL: 'your-minor-model',
}