玄道智控平台

# 知识库部署手册

⽂档版本 内容修订 修订⼈ 修订⽇期
V1 初稿 郭程豪 2022-11-23

# 目录

# 一：前提

已正常启动 CCS PRO 服务

# 二：数据库

以 root 身份进入 _system 页面：http://127.0.0.1:8529

创建知识库数据库【knowledge-base】

image-20221123142908644

# 三：运行知识库后端服务

# 1. 获取软件

下载地址：

image-20221207102211562

解压下载的zip包，文件结构如下

image-20221207102254549

文件含义

程序名称 平台
kkfileview 文档预览插件
knowledge-base-server.zip ⽀持在 Ubuntu、CentOS、中标麒麟、UOS 等 Linux 系统上运⾏

# 2. 运行

# 启动Kkfileview

进入Kkfileview文件夹，双击start-win.bat运行Kkfileview，正常启动后，docker会启动1个容器:

image-20221207102712476

# 启动知识库

# 方式1：hulk启动

进入hulk配置页面，点击右上角的【新增按钮】

image-20221213112826935

选择【asset-management-server.zip】文件

image-20221213113343762

开启服务

image-20221213112928780

# 方式2: 手动启动

解压【work-order-server.zip】

image-20221207103059913

文件含义

文件名称 平台
config 配置文件
public 静态文件
ccs-knowledge-base-server-win-x64.exe 程序可执行文件
process.json hulk描述文件

软件默认携带 x86_64 的可执⾏软件, 如需⽀持国产操作系统、国产芯⽚, 请联系研发团队获取定制版本.

双击 ccs-knowledge-base-server-win-x64.exe可执行文件

  • 修改配置文件，配置文件位置【⽤户⽬录】下的 Sansi/knowledge-base/config/server.json ⽂件

    修改host，改为本机ip

    修改数据库地址，账号密码

    修改知识库地址

    修改文档预览插件地址

  • 双击对应的图标即可启动该软件

例如: 在 Window 操作系统上, 直 接双击 ccs-knowledge-base-server-win.exe 即可启动应⽤，应⽤正常启动后会显示类似于下图的命令弹窗:

image-20221207104021916

注意事项

  1. 命令窗口闪退，是因为数据库账号密码不对
  2. 修改配置文件时，不要使⽤ Window 系统⾃带的记事本, 可以使⽤Nodepad++, SulimeText 等⽂本编辑器, 记事本可能会损坏配置⽂件的数据结构

# 四：安装知识库页面插件

进入 CCS 页面：http://172.20.10.2:3436/#/editor，编辑目标项目

# 1. 安装组件

点击右上角【插件】按钮

image-20221031160439551

  1. 在插件仓库中找到知识库插件；2. 本地上传知识库插件；安装成功后，如下显示

image-20221123144128595

自动刷新页面后，左侧元素列表中会显示知识库插件

image-20221123144223292

拖动知识库组建至编辑区，并设置约束为【填满屏幕】

img.png

# 2. 配置服务地址

点击【配置】按钮

image-20221123144426106

修改知识库的服务地址并保存（一般为 http://127.0.0.1:3469）

image-20221123144520082

选中组件，更新服务器地址

image-20221123144557799

然后点击运行按钮

image-20221123144629901

# 五：重要数据位置

# 1. 应⽤数据⽬录

应⽤启动后, 会在⽤户⽬录下⽣成相关⽂件, 如下:

在window系统中, 该⽂件夹路径可能为: C:\Users\CCC\Sansi\knowledge-base , 其中 CCC 为当前⽤户名.

在 Linux系统中, 该⽂件夹的路径可能为: /home/CCC/Sansi/knowledge-base, 其中 CCC 为当前⽤户名.

image-20221031162616431

  • 如果后续需要调整应⽤启动端⼝, 请调整此⽬录下的 config/server.json ⽂件.
  • 如果现场程序出现⽆法解决的故障, 请将 logs ⽬录压缩打包后发送给研发团队, ⽤于分析故障原因.

# 2. 数据备份

  1. 将⽤户数据⽬录，例如： C:\Users\CCC\Sansi\knowledge-base全部压缩后另存备份
  2. 将项⽬数据导出为 export.project.1666941704113.zip ⽂件后进⾏备份

使用手册 →