AYON Server 技术文档

镜像概述和主要用途

AYON Server 是一款强大的开源管线平台，专为动画、视觉效果（VFX）和游戏工作室设计，用于管理和自动化工作流。作为核心工具，它能够高效协调项目流程、整合团队协作，并支持从小型项目到大型剧集、电影的复杂制作场景。

核心功能和特性

• 开源架构：基于开源模式开发，支持定制化扩展，满足不同工作室的独特需求。
• 工作流管理与自动化：提供全面的工作流管理功能，支持任务自动化执行，简化项目流程。
• 多项目支持：可同时管理多个独立项目，如演示项目中的 demo_Commercial、demo_Big_Episodic 和 demo_Big_Feature。
• 前后端分离：采用前后端分离架构，便于独立开发、测试和维护。
• 便捷部署：通过 Docker Compose 实现快速部署，支持生产、评估和开发多种环境。
• 开发友好：支持本地代码挂载、热重载，便于开发者对后端和前端进行迭代优化。

使用场景和适用范围

• 动画工作室：管理动画项目的资产、镜头、任务分配与进度跟踪。
• VFX 工作室：协调视觉效果制作流程，整合渲染、合成等环节。
• 游戏工作室：支持游戏开发中的资源管理、版本控制和协作流程。
• 生产环境：推荐部署在 Linux 系统，保障稳定性和性能。
• 评估环境：可在 Windows（配合 WSL）系统中快速搭建，用于功能评估。
• 开发环境：支持本地代码挂载和热重载，便于前后端功能开发与调试。

详细使用方法和配置说明

环境要求

• Docker 环境：需安装 Docker 及 Compose 插件。推荐使用***脚本安装最新版 Docker：
  [***]
  若使用独立的 docker-compose 脚本而非 Compose 插件，需将教程中的 docker compose 命令替换为 docker-compose。
• 系统要求：生产环境推荐使用 Linux；评估环境可使用 Windows（需配合 WSL）。

安装步骤

1. 克隆仓库：将 AYON Server 仓库克隆至本地机器。

2. 调整配置文件：根据需求修改 docker-compose.yml 文件。

3. 设置环境变量：可通过 .env 文件配置环境变量（如 SSO 相关设置）。

4. Windows 系统注意事项：在 docker-compose.yml 中，注释或删除 - "/etc/localtime:/etc/localtime:ro" 行。

5. 启动服务栈：执行以下命令启动服务：

   bash
   docker compose up -d
   

6. 完成引导设置：在浏览器中访问 http://localhost:5000/，按照页面引导完成初始化步骤。

演示项目

可通过以下命令创建演示项目，包含 demo_Commercial、demo_Big_Episodic 和 demo_Big_Feature 三个项目：

• Unix 系统：

  bash
  make demo
  

• Windows 系统：

  powershell
  manage.ps1 demo
  

注意：演示项目创建过程可能耗时较长，请耐心等待。

开发环境配置

后端开发

1. 获取代码：执行以下命令下载后端和前端代码：

   bash
   make backend && make frontend
   

2. 挂载本地代码：在 docker-compose.yml 中，取消 - "./backend:/backend" 行的注释，将本地后端代码挂载至容器。

3. 重启服务栈：执行以下命令重启服务以应用挂载配置：

   bash
   docker compose down && docker compose up -d
   

4. 应用代码变更：修改后端代码后，执行 make reload 使变更生效。

前端开发

1. 环境准备：本地需安装 Node.js（18+ 版本）和 yarn。

2. 安装依赖：进入 frontend 目录，执行：

   bash
   yarn install
   

3. 启动开发服务器：执行以下命令启动前端开发服务器（默认端口 3000），所有 API 请求将代理至 localhost:5000：

   bash
   yarn dev
   

Docker 部署方案示例

docker-compose 启动命令

bash
# 启动服务栈
docker compose up -d

# 停止服务栈
docker compose down

# 重启服务栈（修改配置后）
docker compose down && docker compose up -d

docker-compose.yml 关键配置说明

• 本地时间挂载（Linux 系统）：

  yaml
  volumes:
    - "/etc/localtime:/etc/localtime:ro"  # 保持容器与主机时间同步
  

  Windows 系统需注释或删除此行。

• 后端代码挂载（开发环境）：

  yaml
  volumes:
    - "./backend:/backend"  # 取消注释以挂载本地后端代码
  

.env 文件使用示例

创建 .env 文件配置环境变量（具体变量需根据项目需求定义）：

env
# SSO 配置示例
SSO_ENABLED=true
SSO_CLIENT_ID=your_client_id
SSO_CLIENT_SECRET=your_client_secret

配置参数与环境变量

• 环境变量文件：通过 .env 文件可配置各类环境变量，如 SSO 设置、端口映射、数据库连接等。具体支持的变量请参考项目***文档或示例配置。
• docker-compose.yml 调整：可根据部署需求修改端口映射、数据卷挂载、服务依赖等配置。