PrizmDoc Viewer Eval Docker 镜像使用指南

概述

PrizmDoc Viewer Eval Docker 镜像可帮助您在单台机器上快速评估 PrizmDoc Viewer。运行此镜像后，将实现以下功能：

1. 在 `[***] 启动演示 Web 应用，您可通过上传自己的文档体验查看器及各项功能。
2. 启动完整的 PrizmDoc Viewer 后端服务，支持本地应用开发调试。

注意：accusoft/prizmdoc-viewer-eval 镜像仅适用于评估和本地开发，不可用于生产环境。生产环境需使用 accusoft/prizmdoc-application-services 和 accusoft/prizmdoc-server 镜像。详情参见 管理指南。

硬件资源要求

运行前必须确保 Docker 已配置以下最低硬件资源：

• CPU：2 核
• 内存：8 GB

若资源不足，镜像可能无法正常运行。

注意：自 v14.1 版本起，PrizmDoc Viewer 需依赖数据库运行。

启动方式

推荐：使用 docker-compose

以下是启动演示环境的标准 docker-compose 配置，包含基础服务及数据库依赖：

version: '2.1'
services:
    prizm-demo:
        image: accusoft/prizmdoc-viewer-eval:latest
        environment: 
            ACCEPT_EULA: 'YES'  # 必须同意许可协议
            LICENSE_SOLUTION_NAME: '${LICENSE_SOLUTION_NAME:-}'  # 可选：许可名称
            LICENSE_KEY: '${LICENSE_KEY:-}'  # 可选：许可密钥
            DATABASE_CONNECTION_STRING: 'mysql://pruser:prpass@prizm-db:3306/prdb'  # 数据库连接串
            PROCESS_MANAGER_URL: '[***]'  # 若使用 AI 功能需配置
        depends_on:
            prizm-db:
                condition: service_healthy  # 等待数据库就绪
        ports:
            - '18681:18681'  # PrizmDoc Server 端口
            - '3000:3000'    # PAS 服务端口
            - '8888:8888'    # 演示应用端口
        healthcheck:
            test: ['CMD', '/demo/node_modules/.bin/node', '/demo/testUrl.js','[***]']
            start_period: 90s
            interval: 10s
            timeout: 10s
            retries: 30
            
    prizm-db:
        image: mysql:8.4  # 依赖 MySQL 数据库
        environment:
            MYSQL_ROOT_PASSWORD: 'root'
            MYSQL_DATABASE: 'prdb'
            MYSQL_USER: 'pruser'
            MYSQL_PASSWORD: 'prpass'
        ports: 
            - '3306:3306'  # MySQL 端口
        healthcheck:
            test: mysqladmin ping -h 127.0.0.1 -u pruser --password=prpass
            start_period: 5s
            interval: 5s
            timeout: 5s
            retries: 10

可选：启用 AI 功能

若需使用 v14.4 及以上版本的 AI 功能，需额外添加 process-manager 和 ai-hub 服务。需注意：

• 需获取包含 AI 插件的许可密钥。
• 需配置 IBM watsonx 凭证（API 密钥、项目 ID 等）。

在上述 docker-compose 配置中追加以下服务：

    process-manager:
        image: accusoft/process-manager:latest
        environment:
            ACCEPT_EULA: 'YES'
            DATABASE_CONNECTION_STRING: 'mysql://pruser:prpass@prizm-db:3306/prdb'
            PRIZMDOC_SERVER_URL: '[***]'
        depends_on:
            prizm-demo:
                condition: service_healthy  # 等待 PrizmDoc 就绪
        ports:
            - '3005:3000'
            - '3006:3001'
        healthcheck:
            test: ['CMD', 'wget', '--spider','[***]']
            start_period: 5s
            interval: 5s
            timeout: 5s
            retries: 10

    ai-hub:
        image: accusoft/ai-hub:latest
        environment:
            ACCEPT_EULA: 'YES'
            PROCESS_MANAGER_INTERNAL_URL: '[***]'
            WORKFILE_SERVICE_URL: '[***]'
            WATSONX_API_KEY: '${WATSONX_API_KEY:-}'  # watsonx API 密钥
            WATSONX_PROJECT_ID: '${WATSONX_PROJECT_ID:-}'  # watsonx 项目 ID
            WATSONX_API_ENDPOINT: '${WATSONX_API_ENDPOINT:-}'  # watsonx API 端点
            WATSONX_IAM_TOKEN_SERVICE: '${WATSONX_IAM_TOKEN_SERVICE:-}'  # watsonx 令牌服务地址
        depends_on:
            process-manager:
                condition: service_healthy  # 等待 Process Manager 就绪
        ports: 
            - '4100:4100'
        restart: on-failure

启动步骤

1. 将上述 docker-compose 配置保存为 docker-compose.yml 文件。
2. 在文件所在目录执行命令启动服务：

   docker-compose up
   

不使用 docker-compose 的启动方式

若未安装 docker-compose，可直接通过 docker run 命令启动。

方式 1：带数据库（推荐）

需先通过 MySQL 镜像启动数据库（或使用现有数据库），再启动 PrizmDoc：

# 拉取镜像
docker pull accusoft/prizmdoc-viewer-eval:latest

# 启动容器（替换数据库连接串为实际值）
docker run --rm \
  -p 8888:8888 -p 3000:3000 -p 18681:18681 \
  -e ACCEPT_EULA=YES \
  -e DATABASE_CONNECTION_STRING='mysql://user:[邮箱已删除]:3306/database_name' \
  --name prizmdoc-viewer-eval \
  accusoft/prizmdoc-viewer-eval:latest

方式 2：不带数据库（仅基础功能）

PrizmDoc 可无数据库运行（但 AI 功能需依赖数据库）：

docker pull accusoft/prizmdoc-viewer-eval:latest

docker run --rm \
  -p 8888:8888 -p 3000:3000 -p 18681:18681 \
  -e ACCEPT_EULA=YES \
  --name prizmdoc-viewer-eval \
  accusoft/prizmdoc-viewer-eval:latest

配置许可密钥（可选）

默认启动为限制功能的评估模式。若需完整功能，需联系获取许可密钥，并通过环境变量传入：

• 使用 docker-compose：

  LICENSE_SOLUTION_NAME=您的许可名称 LICENSE_KEY=您的许可密钥 docker-compose up
  

• 不使用 docker-compose：

  docker run --rm \
    -p 8888:8888 -p 3000:3000 -p 18681:18681 \
    -e ACCEPT_EULA=YES \
    -e LICENSE_SOLUTION_NAME=您的许可名称 \
    -e LICENSE_KEY=您的许可密钥 \
    -e DATABASE_CONNECTION_STRING='mysql://user:[邮箱已删除]:3306/database_name' \
    --name prizmdoc-viewer-eval \
    accusoft/prizmdoc-viewer-eval:latest
  

等待启动完成

服务启动需 1-2 分钟，当终端输出以下信息时，表示启动成功：

============================================================
 PrizmDoc Server is running at:
 [***] PAS (PrizmDoc Application Services) is running at:
 [***] Demo application will be started at:
 [***] the demo application...

> prizmdoc-viewer-eval-demo@1.0.0 start /demo
> NODE_ENV=production node main.js

Application running at [***]  


## 使用演示应用  
启动成功后，访问 `[***] 打开演示应用，上传本地文档即可体验查看器功能（如批注、搜索、格式转换等）。  


## 下一步：集成到自己的应用  
演示应用仅用于功能体验，若需集成到自有系统，可参考官方 示例项目（支持 React、Angular、传统 HTML 等技术栈）。  

配置示例项目连接本地后端服务：  
- PAS 基础 URL：`[***]  
- PAS 密钥：`mysecretkey`  

具体配置方法见各示例项目的 README。  


## 停止服务  
- 若通过 `docker-compose up` 启动，在终端按 `Ctrl+C` 停止。  
- 或通过容器名称停止：  
  ```sh
  docker stop prizmdoc-viewer-eval

寻求帮助

若有疑问，可通过 Accusoft 联系页面 获取支持。

法律信息

• 版权信息
• 软件许可协议
• 第三方归因