ATKONVIEWER

主题

安装步骤 ​

环境准备 ​

硬件配置 ​

  • cpu: amd/x86/arm 推荐4c

  • 内存：推荐8G

  • 如果预览量较大，推荐配置SSD硬盘

系统环境 ​

  • 系统：Linux：推荐 ubuntu20.04 或者其他Linux发行版本（包括国产化系统）

  • 软件：预装 docker、docker-compose、unzip

  • 网络：无要求

软件安装包清单 ​

请找技术支持获取完整安装包文件（请提前提供部署服务器CPU型号、操作系统）

正常情况下，您将获取到软件安装包

安装包一：dist-amd64-1.0.0-1.0.0-online.tar

TIP

命名规则：

amd64: 支持的服务器架构

1.0.0-1.0.0：软件版本

online: 在线安装版本

offline: 离线安装版本，离线包中包含所有离线镜像

软件安装包明细 ​

名称：dist-amd64-1.0.0-1.0.0-online.zip

服务离线镜像 ./*.tar.gz

服务启动文件： ./docker-compose-service.yml

索引服务启动文件： ./docker-compose-index.yml

服务器配置文件： ./mnt/be/application-pord.properties

客户端配置文件： ./mnt/be/static/config.js

网络配置文件: ./mnt/nginx/nginx.config

数据库初始化配置文件 ./mnt/mongodb/init

服务授权码 ./mnt/be/license

一键安装脚本 ./oneKey.sh

服务安装 ​

安装准备 ​

  1. 准备服务器以及软件环境： 环境准备

  2. 获取软件安装包：软件安装包清单

  3. 确定服务的安装目录，如使用 /app 文件夹

  4. 将软件安装包(dist-amd64-1.0.0-1.0.0-online.tar) 放入/app文件夹中并解压，得到dist-amd64-1.0.0-1.0.0-online文件夹

  5. 获取license，并填入/app/dist-amd64-1.0.0-1.0.0-online/mnt/be/license文件中

  6. 确认部署服务器IP或域名指向，并填入 /app/dist-amd64-1.0.0-1.0.0-online/mnt/fe/static/config/js，如服务器IP：127.0.0.1，config.js文件中填入 http://127.0.0.1:8001/api，其中8001为后端服务默认端口，（留空则前端默认请求同域名的后端接口）

自动安装 ​

执行在线安装脚本（离线安装脚本）

bash
cd /app/dist-amd64-1.0.0-1.0.0-online

chmod +x ./oneKey.sh && ./oneKey.sh install $fe_version_$be_version online  # 在线安装命令

chmod +x ./oneKey.sh && ./oneKey.sh install $fe_version_$be_version offline  # 离线安装命令

TIP

上述说明中，请根据实际的安装包名称自行替换 dist-amd64-1.0.0-1.0.0-online 文件夹名称

需要将 $fe_version、$be_version 替换成具体版本号，例如：./oneKey.sh install 1.0_1.0 online

离线安装与在线安装一致，仅是命令后使用的是offline模式，这种模式下，会自动将安装包内的镜像文件导入，再启动服务。无需连接网络

验证服务 ​

步骤一：查看服务启动状态，校验服务状态均为 UP

docker-compose -f docker-compose-service.yml ps -a

在线预览服务由5个服务组成，所有服务必须保证正常启动，分别是：

  1. 网络服务 yhcm-document-online-nginx
  2. 客户端 yhcm-document-online-fe
  3. 服务端 yhcm-document-online-be
  4. 数据库 yhcm-document-online-mongodb
  5. 缓存层 yhcm-document-online-redis

步骤二：访问服务端健康检查接口

bash
curl http://127.0.0.1:8001/api/health

正常返回

json
{"code":0,"data":"UP","msg":"success","rid":null,"ts":1711515214,"success":true}

步骤三：访问后台地址，并成功登录，默认访问地址http://ip:8001/user/login

TIP

检查所有步骤全部正常后，即表示服务运行正常

必要配置 ​

在服务安装完成后，确认如下配置必须完成，客户端才能正常运行

  1. 安装路径下 ./mnt/be/license 授权信息正确

  2. 安装路径下 mnt/fe/static/config/js 配置正确的后端服务域名

  3. 后台配置正确打开 服务配置

附录 ​

oneKey 脚本命令 ​

bash
./oneKey.sh install $fe_version_$be_version online      # 在线安装/更新服务
./oneKey.sh install $fe_version_$be_version offline     # 离线安装/更新服务
./oneKey.sh restart                                     # 重启所有服务
./oneKey.sh remove                                      # 移除所有服务