This commit is contained in:
55
README.md
55
README.md
@@ -226,30 +226,57 @@ model_configs = {
|
||||
|
||||
## ⚙️ 环境配置
|
||||
|
||||
### 配置文件说明
|
||||
|
||||
项目使用两个环境配置文件:
|
||||
|
||||
| 文件 | 用途 | 是否提交 Git |
|
||||
|------|------|------------|
|
||||
| `.env` | 实际使用的配置 | ❌ 否(已忽略) |
|
||||
| `.env.docker` | Docker 部署模板 | ✅ 是 |
|
||||
|
||||
**使用方法:**
|
||||
|
||||
- **本地开发**:手动创建 `.env`,配置 `localhost` 相关地址
|
||||
- **Docker 部署**:`cp .env.docker .env`,然后修改 API Key
|
||||
|
||||
### 必需的环境变量
|
||||
|
||||
在 `.env` 文件中配置:
|
||||
代码中所有使用 `os.getenv()` 的地方都必须在 `.env` 文件中定义:
|
||||
|
||||
```
|
||||
# 智谱 AI API Key(必需)
|
||||
| 变量名 | 说明 | 本地开发示例 | Docker 部署示例 |
|
||||
|--------|------|------------|----------------|
|
||||
| `ZHIPUAI_API_KEY` | 智谱 AI API 密钥 | `your_key_here` | `your_key_here` |
|
||||
| `VLLM_LOCAL_KEY` | vLLM 认证 Token | `token-abc123` | `token-abc123` |
|
||||
| `VLLM_BASE_URL` | vLLM 服务地址 | `http://localhost:8000/v1` | `http://115.190.121.151:18000/v1` |
|
||||
| `DB_URI` | PostgreSQL 连接字符串 | `postgresql://...@localhost:5432/...` | `postgresql://...@postgres:5432/...` |
|
||||
| `API_URL` | 后端 API 地址 | `http://localhost:8001/chat` | (由 docker-compose.yml 注入) |
|
||||
|
||||
### 配置示例
|
||||
|
||||
#### 本地开发 (.env)
|
||||
```bash
|
||||
ZHIPUAI_API_KEY=your_api_key_here
|
||||
|
||||
# vLLM 本地模型 Token(可选)
|
||||
VLLM_LOCAL_KEY=token-abc123
|
||||
VLLM_BASE_URL=http://localhost:8000/v1
|
||||
DB_URI=postgresql://postgres:mysecretpassword@localhost:5432/langgraph_db?sslmode=disable
|
||||
API_URL=http://localhost:8001/chat
|
||||
```
|
||||
|
||||
### 数据库配置
|
||||
|
||||
默认使用 PostgreSQL,连接字符串:
|
||||
```
|
||||
postgresql://postgres:mysecretpassword@localhost:5432/langgraph_db
|
||||
#### Docker 部署 (.env.docker)
|
||||
```bash
|
||||
ZHIPUAI_API_KEY=your_api_key_here
|
||||
VLLM_LOCAL_KEY=token-abc123
|
||||
VLLM_BASE_URL=http://115.190.121.151:18000/v1
|
||||
DB_URI=postgresql://postgres:mysecretpassword@postgres:5432/langgraph_db?sslmode=disable
|
||||
# API_URL 在 docker-compose.yml 中配置为 http://backend:8001/chat
|
||||
```
|
||||
|
||||
**注意**:
|
||||
- **本地开发模式**:使用 `localhost` 或 `127.0.0.1`
|
||||
- **Docker Compose 部署**:后端容器内应使用服务名 `postgres`(通过环境变量 `DB_URI` 自动配置)
|
||||
### 注意事项
|
||||
|
||||
如使用 Docker Compose,数据库会在内部网络中自动配置。
|
||||
- ⚠️ **不要硬编码敏感信息**:所有 API Key 必须通过环境变量配置
|
||||
- ⚠️ **Docker 网络差异**:容器内使用服务名(如 `postgres`、`backend`),本地使用 `localhost`
|
||||
- ⚠️ **修改后重启**:修改 `.env` 后,Docker 部署需要执行 `docker compose down && docker compose up -d --build`
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user