跳转到内容
Prevu3D

在本地服务器上部署集成服务

前提条件

Section titled “前提条件”

  • 运行与 Docker 兼容的操作系统的服务器

    • 该部署已在 Windows 机器上测试

  • 集成服务 Web 服务的 DNS 记录和适当的 SSL 证书

  • 用于从 Prevu3d 私有 Gitlab 存储库拉取 docker 镜像的 Project Access Token，具有以下权限：

    • Read Registry

    • Developer Role

  • 已安装 Docker CLI

  • Docker-Desktop - 可选

部署步骤

Section titled “部署步骤”

  1. 使用提供的 Project Access Token 登录 Gitlab docker 镜像存储库。

    docker login registry.gitlab.com -u <ANY_USERNAME> -p <PROJECT_ACCESS_TOKEN>

  2. 拉取开发版集成服务 docker 镜像。

    docker pull registry.gitlab.com/prevu3d/product/integration-service:develop

  3. 在主机上，创建一个 “Assets” 文件夹和一个 “Config” 文件夹。这些文件夹将用作 docker 容器内的挂载。Assets 将包含集成可能需要的文件，例如 HTTP 集成的 JSON Schema。Config 将包含配置文件并确保其持久化。

  4. 使用 docker CLI 启动容器。确保挂载 asset 和 config 文件夹并绑定集成服务的端口。默认值为 3000。

    docker run registry.gitlab.com/prevu3d/product/integration-service:develop -v path\to\assets\folder\on\host:/usr/app/assets -v path\to\config\folder\on\host:/usr/app/config -p 3000:3000

    1. 在运行阶段还可以使用以下环境变量：

      1. PORT：集成服务将在容器内绑定的端口。默认为 3000。

      2. DEBUG_MODE：设置为 “1” 以启用调试日志。

      3. CONFIG_FILE：配置文件的名称和路径。默认为 “/config/config.json”。如果配置文件托管在 S3 上，则必须提供 S3 URI（以 s3:// 开头）。

      4. CONFIG_FILE_TYPE：配置文件的类型。设置为 “s3” 以使用托管在 AWS S3 中的文件，或 local 以使用托管在容器内的文件。默认为 “local”。

  5. 导航到 http://localhost:3000/health 以确认集成服务正在运行。

  6. 配置 DNS 条目以指向集成服务，并添加 SSL 证书以启用 HTTPS 流量。

  7. 按照步骤在平台内注册集成服务器，以获取 assetServicePublicKey 并将其复制到 config.json 文件中。