docs: 更新部署文档和配置,支持预构建镜像和本地构建两种方式

This commit is contained in:
fawney19
2025-12-11 18:16:19 +08:00
parent 7de1926fc8
commit 3b8a55adea
5 changed files with 234 additions and 15 deletions

135
.github/workflows/docker-publish.yml vendored Normal file
View File

@@ -0,0 +1,135 @@
name: Build and Publish Docker Image
on:
push:
branches: [master, main]
tags: ['v*']
pull_request:
branches: [master, main]
workflow_dispatch:
inputs:
build_base:
description: 'Rebuild base image'
required: false
default: false
type: boolean
env:
REGISTRY: ghcr.io
BASE_IMAGE_NAME: ${{ github.repository }}-base
APP_IMAGE_NAME: ${{ github.repository }}
jobs:
check-base-changes:
runs-on: ubuntu-latest
outputs:
base_changed: ${{ steps.check.outputs.base_changed }}
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 2
- name: Check if base image needs rebuild
id: check
run: |
if [ "${{ github.event.inputs.build_base }}" == "true" ]; then
echo "base_changed=true" >> $GITHUB_OUTPUT
exit 0
fi
# Check if base-related files changed
if git diff --name-only HEAD~1 HEAD | grep -qE '^(Dockerfile\.base|pyproject\.toml|frontend/package.*\.json)$'; then
echo "base_changed=true" >> $GITHUB_OUTPUT
else
echo "base_changed=false" >> $GITHUB_OUTPUT
fi
build-base:
needs: check-base-changes
if: needs.check-base-changes.outputs.base_changed == 'true'
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- uses: actions/checkout@v4
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Log in to Container Registry
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract metadata for base image
id: meta
uses: docker/metadata-action@v5
with:
images: ${{ env.REGISTRY }}/${{ env.BASE_IMAGE_NAME }}
tags: |
type=raw,value=latest
type=sha,prefix=
- name: Build and push base image
uses: docker/build-push-action@v5
with:
context: .
file: ./Dockerfile.base
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
cache-from: type=gha
cache-to: type=gha,mode=max
platforms: linux/amd64,linux/arm64
build-app:
needs: [check-base-changes, build-base]
if: always() && (needs.build-base.result == 'success' || needs.build-base.result == 'skipped')
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- uses: actions/checkout@v4
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Log in to Container Registry
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract metadata for app image
id: meta
uses: docker/metadata-action@v5
with:
images: ${{ env.REGISTRY }}/${{ env.APP_IMAGE_NAME }}
tags: |
type=raw,value=latest,enable={{is_default_branch}}
type=ref,event=branch
type=ref,event=pr
type=semver,pattern={{version}}
type=semver,pattern={{major}}.{{minor}}
type=sha,prefix=
- name: Update Dockerfile.app to use registry base image
run: |
sed -i "s|FROM aether-base:latest|FROM ${{ env.REGISTRY }}/${{ env.BASE_IMAGE_NAME }}:latest|g" Dockerfile.app
- name: Build and push app image
uses: docker/build-push-action@v5
with:
context: .
file: ./Dockerfile.app
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
cache-from: type=gha
cache-to: type=gha,mode=max
platforms: linux/amd64,linux/arm64

View File

@@ -46,7 +46,7 @@ Aether 是一个自托管的 AI API 网关,为团队和个人提供多租户
## 部署 ## 部署
### Docker Compose推荐 ### Docker Compose推荐:预构建镜像
```bash ```bash
# 1. 克隆代码 # 1. 克隆代码
@@ -58,16 +58,24 @@ cp .env.example .env
python generate_keys.py # 生成密钥, 并将生成的密钥填入 .env python generate_keys.py # 生成密钥, 并将生成的密钥填入 .env
# 3. 部署 # 3. 部署
./deploy.sh # 自动构建、启动、迁移 docker-compose up -d
# 4. 更新
docker-compose pull && docker-compose up -d
``` ```
### 更新 ### Docker Compose本地构建镜像
```bash ```bash
# 拉取最新代码 # 1. 克隆代码
git pull git clone https://github.com/fawney19/Aether.git
cd aether
# 自动部署脚本 # 2. 配置环境变量
cp .env.example .env
python generate_keys.py # 生成密钥, 并将生成的密钥填入 .env
# 3. 部署 / 更新(自动构建、启动、迁移)
./deploy.sh ./deploy.sh
``` ```
@@ -75,7 +83,7 @@ git pull
```bash ```bash
# 启动依赖 # 启动依赖
docker-compose up -d postgres redis docker-compose -f docker-compose.build.yml up -d postgres redis
# 后端 # 后端
uv sync uv sync

View File

@@ -11,9 +11,9 @@ cd "$(dirname "$0")"
# 兼容 docker-compose 和 docker compose # 兼容 docker-compose 和 docker compose
if command -v docker-compose &> /dev/null; then if command -v docker-compose &> /dev/null; then
DC="docker-compose" DC="docker-compose -f docker-compose.build.yml"
else else
DC="docker compose" DC="docker compose -f docker-compose.build.yml"
fi fi
# 缓存文件 # 缓存文件

78
docker-compose.build.yml Normal file
View File

@@ -0,0 +1,78 @@
# Aether 部署配置 - 本地构建
# 使用方法:
# 首次构建 base: docker build -f Dockerfile.base -t aether-base:latest .
# 启动服务: docker-compose -f docker-compose.build.yml up -d --build
services:
postgres:
image: postgres:15
container_name: aether-postgres
environment:
POSTGRES_DB: aether
POSTGRES_USER: postgres
POSTGRES_PASSWORD: ${DB_PASSWORD}
TZ: Asia/Shanghai
volumes:
- postgres_data:/var/lib/postgresql/data
ports:
- "${DB_PORT:-5432}:5432"
healthcheck:
test: ["CMD-SHELL", "pg_isready -U postgres"]
interval: 5s
timeout: 5s
retries: 5
restart: unless-stopped
redis:
image: redis:7-alpine
container_name: aether-redis
command: redis-server --appendonly yes --requirepass ${REDIS_PASSWORD}
volumes:
- redis_data:/data
ports:
- "${REDIS_PORT:-6379}:6379"
healthcheck:
test: ["CMD", "redis-cli", "--raw", "incr", "ping"]
interval: 5s
timeout: 3s
retries: 5
restart: unless-stopped
app:
build:
context: .
dockerfile: Dockerfile.app
image: aether-app:latest
container_name: aether-app
environment:
DATABASE_URL: postgresql://postgres:${DB_PASSWORD}@postgres:5432/aether
REDIS_URL: redis://:${REDIS_PASSWORD}@redis:6379/0
PORT: 8084
JWT_SECRET_KEY: ${JWT_SECRET_KEY}
ENCRYPTION_KEY: ${ENCRYPTION_KEY}
JWT_ALGORITHM: HS256
JWT_EXPIRATION_DELTA: 86400
LOG_LEVEL: ${LOG_LEVEL:-INFO}
ADMIN_EMAIL: ${ADMIN_EMAIL}
ADMIN_USERNAME: ${ADMIN_USERNAME}
ADMIN_PASSWORD: ${ADMIN_PASSWORD}
API_KEY_PREFIX: ${API_KEY_PREFIX:-sk}
GUNICORN_WORKERS: ${GUNICORN_WORKERS:-4}
TZ: Asia/Shanghai
PYTHONIOENCODING: utf-8
LANG: C.UTF-8
LC_ALL: C.UTF-8
depends_on:
postgres:
condition: service_healthy
redis:
condition: service_healthy
ports:
- "${APP_PORT:-8084}:80"
volumes:
- ./logs:/app/logs
restart: unless-stopped
volumes:
postgres_data:
redis_data:

View File

@@ -1,5 +1,5 @@
# Aether 部署配置 # Aether 部署配置 - 使用预构建镜像
# 使用 ./deploy.sh 自动部署 # 使用方法: docker-compose up -d
services: services:
postgres: postgres:
@@ -37,7 +37,7 @@ services:
restart: unless-stopped restart: unless-stopped
app: app:
image: aether-app:latest image: ghcr.io/fawney19/aether:latest
container_name: aether-app container_name: aether-app
environment: environment:
DATABASE_URL: postgresql://postgres:${DB_PASSWORD}@postgres:5432/aether DATABASE_URL: postgresql://postgres:${DB_PASSWORD}@postgres:5432/aether
@@ -65,11 +65,9 @@ services:
ports: ports:
- "${APP_PORT:-8084}:80" - "${APP_PORT:-8084}:80"
volumes: volumes:
# 挂载日志目录到主机,便于调试和持久化
- ./logs:/app/logs - ./logs:/app/logs
restart: unless-stopped restart: unless-stopped
volumes: volumes:
postgres_data: postgres_data:
redis_data: redis_data: