yaoapp/yao

Yao Docker镜像技术文档

一、镜像概述与主要用途

Yao 是一款低代码引擎 Docker 镜像，旨在帮助开发者通过流程快速创建 Web 服务。该镜像基于 Yao 低代码平台构建，支持通过 JSON 配置文件完成数据库模型定义、API 服务编写及仪表板界面描述，无需编写代码即可实现 Web 应用及硬件集成需求，显著提升开发效率（官方宣称可达 10 倍生产力提升）。

二、核心功能与特性

1. 低代码开发模式

无需编写传统代码，全程通过 JSON 配置文件驱动开发流程，降低技术门槛。

2. 全流程 JSON 配置

支持通过 JSON 定义数据库模型、编写 API 接口、描述前端仪表板界面，覆盖应用开发全生命周期核心环节。

3. 多场景适配

适用于 Web 应用开发与硬件集成场景，具备跨领域开发能力。

4. 高效生产力

简化开发流程，减少重复工作，帮助团队快速交付产品。

三、使用场景与适用范围

适用场景

• 快速原型开发：需快速验证业务逻辑或演示功能的场景。
• 小型 Web 应用：轻量级内部系统、管理后台等小型项目开发。
• 硬件集成项目：需与硬件设备交互的物联网（IoT）应用开发。
• 低代码团队协作：非专业开发人员参与的开发流程，降低协作成本。

适用人群/团队

• 快速迭代需求的创业团队
• 需快速交付原型的产品经理
• 硬件集成开发者
• 低代码开发爱好者

四、使用方法与配置说明

1. 查看镜像版本

通过以下命令验证镜像是否正常运行并查看 Yao 版本：

bash
docker run --rm yaoapp/yao:0.9.1-amd64-dev yao version

参数说明：

• --rm：容器退出后自动删除，避免残留临时容器。
• yaoapp/yao:0.9.1-amd64-dev：指定 Yao 镜像及标签（dev 为开发版本）。
• yao version：容器内执行的命令，用于输出 Yao 版本信息。

2. 开发环境部署

在开发阶段，需挂载本地项目目录至容器，实现代码实时更新与调试：

bash
docker run -d --name yao-dev \
  -v <本地项目根目录>:/data/app \
  -p 5099:5099 \
  yaoapp/yao:0.9.1-amd64-dev

参数说明：

• -d：后台运行容器。
• --name yao-dev：指定容器名称为 yao-dev，便于管理。
• -v <本地项目根目录>:/data/app：将本地项目目录挂载至容器内 /data/app（Yao 项目工作目录），实现文件双向同步。
• -p 5099:5099：端口映射，将容器内默认端口 5099 映射至宿主机 5099，用于访问应用。
• 镜像标签 0.9.1-amd64-dev：开发版本，包含调试工具与热重载功能。

3. 生产环境部署

生产环境建议使用稳定版镜像，关闭调试功能以提升安全性与性能：

bash
docker run -d --name yao-server \
  -v <本地项目根目录>:/data/app \
  -p 5099:5099 \
  yaoapp/yao:0.9.1-amd64

参数说明：

• 与开发环境相比，主要区别为镜像标签使用 0.9.1-amd64（稳定版），不含开发调试组件。

4. Docker Compose 部署示例

创建 docker-compose.yml 文件，简化多环境管理：

yaml
version: '3.8'

services:
  yao:
    image: yaoapp/yao:0.9.1-amd64  # 生产环境使用稳定版，开发环境可替换为 0.9.1-amd64-dev
    container_name: yao-server
    restart: always  # 容器异常退出后自动重启
    ports:
      - "5099:5099"  # 端口映射
    volumes:
      - ./project:/data/app  # 挂载本地项目目录（当前目录下的 project 文件夹）
    # 如需自定义环境变量，可添加 environment 配置，具体变量参考官方文档
    # environment:
    #   - YAO_ENV=production

启动命令：

bash
docker-compose up -d

五、配置参数说明

1. 核心挂载目录

• /data/app：Yao 项目工作目录，需挂载本地项目根目录（包含 JSON 配置文件、模型定义等），容器将读取该目录下的配置文件运行应用。

2. 默认端口

• 5099：Yao 应用默认监听端口，需通过 -p 参数映射至宿主机，以便外部访问。

3. 镜像标签说明

• 0.9.1-amd64-dev：开发版本，包含热重载、调试工具，适用于开发环境。
• 0.9.1-amd64：稳定版本，去除调试组件，性能与安全性更优，适用于生产环境。
• 其他版本可通过 https://hub.docker.com/r/yaoapp/yao 查看最新标签。

六、补充信息

• 官方网站：[***]
• GitHub 仓库：https://github.com/yaoapp
• 详细配置文档：建议参考官方文档获取更多环境变量、高级配置及最佳实践。