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

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

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