i/Aether
1
0
Fork 0
mirror of https://github.com/fawney19/Aether.git synced 2026-09-02 01:10:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: 更新 README 部署说明与默认配置

Browse Source 
- 调整 Docker Compose 部署方式的标题描述
- 恢复预构建镜像部署的正常命令流程
- 移除 deploy.sh 的 --hub-tag 选项说明
- Aether Proxy 标注为可选组件
- GUNICORN_WORKERS 默认值调整为 2
This commit is contained in:
fawney19
2026-03-03 16:38:22 +08:00
parent dba99455a7
commit dcba7c62a2
1 changed files with 7 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -34,7 +34,7 @@ Aether 是一个自托管的 AI API 网关，为团队和个人提供多租户
## 部署 ## 部署
### Docker Compose（预构建镜像，已废弃） ### Docker Compose（推荐：本地构建镜像）
```bash ```bash
# 1. 克隆代码 # 1. 克隆代码
@@ -45,14 +45,14 @@ cd Aether
cp .env.example .env cp .env.example .env
python generate_keys.py # 生成密钥, 并将生成的密钥填入 .env python generate_keys.py # 生成密钥, 并将生成的密钥填入 .env
# 3. 该模式已废弃，不再作为推荐部署方式 # 3. 部署 / 更新（自动执行数据库迁移）
# 现在统一使用下面的“本地构建部署”方式 docker compose pull && docker compose up -d
# 4. 升级前备份 # 4. 升级前备份 (可选)
docker compose exec postgres pg_dump -U postgres aether | gzip > backup_$(date +%Y%m%d_%H%M%S).sql.gz docker compose exec postgres pg_dump -U postgres aether | gzip > backup_$(date +%Y%m%d_%H%M%S).sql.gz
``` ```
### Docker Compose（推荐：本地构建镜像） ### Docker Compose（本地构建镜像）
```bash ```bash
# 1. 克隆代码 # 1. 克隆代码
@@ -65,9 +65,6 @@ python generate_keys.py # 生成密钥, 并将生成的密钥填入 .env
# 3. 部署 / 更新（自动构建、启动、迁移） # 3. 部署 / 更新（自动构建、启动、迁移）
./deploy.sh ./deploy.sh
# 可选：固定 Hub release 版本
./deploy.sh --hub-tag hub-v0.1.0
``` ```
### 本地开发 ### 本地开发
@@ -84,7 +81,7 @@ uv sync
cd frontend && npm install && npm run dev cd frontend && npm install && npm run dev
``` ```
## Aether Proxy ## Aether Proxy (可选)
Aether Proxy 是配套的正向代理节点，部署在海外 VPS 上，为墙内的 Aether 实例中转 API 流量。或者部署在其他服务器为指定的提供商、账号、Key使用不同的节点访问。支持 TUI 向导一键配置、systemd 服务管理、TLS 加密、DNS 缓存及连接池调优。 Aether Proxy 是配套的正向代理节点，部署在海外 VPS 上，为墙内的 Aether 实例中转 API 流量。或者部署在其他服务器为指定的提供商、账号、Key使用不同的节点访问。支持 TUI 向导一键配置、systemd 服务管理、TLS 加密、DNS 缓存及连接池调优。
@@ -113,7 +110,7 @@ Aether Proxy 是配套的正向代理节点，部署在海外 VPS 上，为墙
| `APP_PORT` | 8084 | 应用端口 | | `APP_PORT` | 8084 | 应用端口 |
| `API_KEY_PREFIX` | sk | API Key 前缀 | | `API_KEY_PREFIX` | sk | API Key 前缀 |
| `LOG_LEVEL` | INFO | 日志级别 (DEBUG/INFO/WARNING/ERROR) | | `LOG_LEVEL` | INFO | 日志级别 (DEBUG/INFO/WARNING/ERROR) |
| `GUNICORN_WORKERS` | 4 | Gunicorn 工作进程数 | | `GUNICORN_WORKERS` | 2 | Gunicorn 工作进程数 |
| `DB_PORT` | 5432 | PostgreSQL 端口 | | `DB_PORT` | 5432 | PostgreSQL 端口 |
| `REDIS_PORT` | 6379 | Redis 端口 | | `REDIS_PORT` | 6379 | Redis 端口 |