origam/server

ORIGAM server runtime 镜像文档

1. 镜像概述

ORIGAM server runtime 是 ORIGAM 低代码平台的核心服务器运行时组件，专为部署和运行 ORIGAM 开发工具创建的应用程序而设计。作为 ORIGAM 应用部署的基础环境，该镜像集成了应用运行所需的依赖库、服务框架和配置管理能力，确保 ORIGAM 应用在容器化环境中稳定、高效地提供服务。

2. 核心功能与特性

• 应用运行支持：提供 ORIGAM 应用程序完整的运行时环境，兼容 ORIGAM 开发工具生成的各类应用包，确保应用功能正常执行。
• 环境一致性：通过容器化封装，消除环境差异，保证 ORIGAM 应用在开发、测试和生产环境中的运行行为一致。
• 简化部署流程：集成应用启动所需的基础配置，减少手动环境配置步骤，支持快速部署和版本更新。
• 灵活配置扩展：支持通过环境变量、配置文件挂载等方式自定义应用参数，适应不同业务场景的部署需求。

3. 使用场景与适用范围

• 企业级应用部署：用于企业内部部署 ORIGAM 开发的业务系统（如 CRM、ERP、流程管理平台等），提供稳定的生产级运行环境。
• 开发测试验证：在开发或测试阶段，快速搭建与生产环境一致的运行时，验证应用功能和兼容性。
• 容器化架构集成：适用于基于 Docker 或 Kubernetes 的容器化架构，作为 ORIGAM 应用的核心运行节点。

4. 使用方法与配置说明

4.1 基本部署（docker run 命令）

通过 docker run 命令可直接启动 ORIGAM server runtime 容器，基础示例如下：

bash
docker run -d \
  --name origam-server \
  -p 8080:8080 \
  -v /host/path/to/app:/app \
  -v /host/path/to/config:/config \
  origam/server-runtime:latest

参数说明：

• -d：后台运行容器
• --name origam-server：指定容器名称（可自定义）
• -p 8080:8080：端口映射，将容器内应用服务端口（默认 8080）映射到主机端口
• -v /host/path/to/app:/app：挂载主机应用目录到容器内 /app 路径（需包含 ORIGAM 应用包）
• -v /host/path/to/config:/config：挂载主机配置目录到容器内 /config 路径（存放应用配置文件）

4.2 环境变量配置

通过环境变量可自定义应用运行参数，常用配置如下表：

示例（自定义端口与日志级别）：

bash
docker run -d \
  --name origam-server \
  -p 9000:9000 \
  -e ORIGAM_PORT=9000 \
  -e LOG_LEVEL=WARN \
  -v /host/path/to/app:/app \
  -v /host/path/to/config:/config \
  origam/server-runtime:latest

4.3 docker-compose 配置示例

使用 docker-compose.yml 管理多容器部署或复杂配置，示例如下：

yaml
version: '3.8'
services:
  origam-server:
    image: origam/server-runtime:latest
    container_name: origam-server
    restart: unless-stopped
    ports:
      - "8080:8080"  # 应用访问端口
    environment:
      - ORIGAM_PORT=8080
      - LOG_LEVEL=INFO
      - ORIGAM_CONFIG_PATH=/config  # 配置文件路径
    volumes:
      - ./origam/app:/app  # 本地应用包目录挂载
      - ./origam/config:/config  # 本地配置文件目录挂载
      - origam-data:/app/data  # 持久化应用数据（如数据库文件、日志等）
volumes:
  origam-data:  # 数据卷用于持久化应用运行数据

5. 注意事项

• 应用包要求：挂载的 /app 目录需包含 ORIGAM 应用部署包（通常为 .origam 格式或解压后的应用目录），否则应用可能无法启动。
• 配置文件兼容性：配置文件需符合 ORIGAM 应用规范，关键配置（如数据库连接、服务端口）需与环境变量设置一致，避免冲突。
• 数据持久化：生产环境建议使用数据卷（Volume）而非绑定挂载（Bind Mount）持久化应用数据，防止容器重建导致数据丢失。
• 资源配置：根据应用规模调整容器 CPU/内存资源限制（如 --cpus、-m 参数），避免资源不足影响应用性能。