# 部署手册

文档版本 内容修订 修订人 修订日期
V1.0 通用中控部署手册基本内容 王垚、王家乐 2021-01-12
V1.1 添加用户权限认证, 添加自启注意事项 王垚 2021-01-21
V1.2 添加 SSL 证书配置方式 王垚 2021-02-04
V1.3 添加 Frist Login 模式 王垚 2021-02-22
V1.4 添加 ArangoDB 数据库安装配置说明 王垚 2021-03-23
V1.5 添加 ccs-web 组件部署说明 王家乐 2021-07-09
V1.6 更新中标麒麟部署说明 王垚 2021-08-08
V1.7 更新操作系统要求 王垚 2022-10-16
V1.8 添加使用 nedb 数据库使用方式 王垚 2022-11-23

# 硬件和操作系统要求

硬件要求 推荐规格
处理器(CPU) >= i5-10500,arm 或 x84-64
内存(RAM) >= 16G
硬盘(DISK) >= 512G,推荐 SSD
操作系统 推荐版本
Windows >= Win10
Macos >= 12.1
Ubuntu >= 20.04

# 安装通用中控平台

# 获取软件

下载地址: 上海三思通用中控 (opens new window)

通过上面的链接可以下载到 x86_64 和 arm 的二进制版本, 适用于在 x86 和 arm 架构下的 64 位通用操作系统上运行, 如果需要 MIPS/LoongArch 架构等特殊版本或者特殊操作系统适配, 请联系研发团队获取.

# 安装软件

通过上面地址下载后, 会得到一个 zip 压缩包, 通过解压工具进行解压后可以看到类似于下图的文件结构.

img_001

程序名称 架构 适用操作系统
ccs_pro-win-x64.exe x64 Window10
ccs_pro-macos-x64 x64 MacOS(Intel 版本)
ccs_pro-macos-arm64 arm64 MacOS(M1、M2版本)
ccs_pro-linux-x64 x64 Ubuntu、CentOS、中标麒麟、UOS 等
ccs_pro-linux-arm64 arm64 Ubuntu、CentOS、中标麒麟、UOS 等

软件默认携带 x86_64 和 arm64 的可执行软件, 如需支持特定国产操作系统、国产芯片, 请联系研发团队获取定制版本。

# 启动软件

# x86平台启动(Win\Mac\Linux)

软件为绿色版本, 无需特殊配置和安装过程, 直接双击对应的图标即可启动该软件, 例如: 在 Window 操作系统上, 直接双击 ccs-platform-server-win.exe 即可启动应用, 应用正常启动后会显示类似于下图的命令弹窗:

img_002

注意事项:

软件的默认启动端口为 3436, 如果该端口被占用, 会随机选择一个端口启动, 如果想要固定端口启动, 则需要修改【用户目录】下的 Sansi/CCS-Platform/config/ccs-server.json 文件中的 port 字段.

# 非x86平台启动

非 x86 和 ARM 平台的主要包括芯片架构(ARM、MIPS、LoongArch等),运行在这些平台上的系统包括(中标麒麟、银河麒麟、统信UOS等)。在这些操作系统上启动需要先安装 nodejs,要求版本在 16 以上, 使用命令 node ccs_pro.js 来启动软件。

# 配置数据库

在使用默认配置的情况下,软件启动后在浏览器中输入http://localhost:3436 即可打开软件,如果修改可以配置,可以根据控制台输出的信息在浏览器中打开对应的地址即可。

数据库可以选择 NeDB 和 ArangoDB,使用 NeDB 直接保存确定即可,如果选择 ArangoDB,则需输入数据库的连接信息。

⚠️注意:数据库是二选一的,默认选择为 NeDB,可以通过选择框更改为 ArangoDB。

# NeDB

NeDB 直接保存确定即可。

img_010

# ArangoDB

ArangoDB 数据库部署参考安装ArangoDB数据库

数据库部署完成后在数据库配置页面输入数据库连接相关信息, 分别为数据库的 url 地址,数据库名称,账户和密码。

注意:

  • 数据库的 url 地址需要写全称 http://<ip>:<port>https://<ip>:<port>
  • 数据库名称是前面教程中新建的数据库名称,用户名密码为与之对应的用户名密码,不建议直接使用 root 账户连接数据库。

img_010

# 配置管理员

# 1. 配置管理员账户

在首次登录系统时,需要设置管理员账户,如下图所示,账号密码强度需要满足如下需求:

1. 3-32 位
2. 密码和账号不一致

img_006

# 2. 登录账号

在用户登录页面需要输入用户的账号密码,即刚刚设置好的账号和密码。

img_011

# 进入软件

软件成功运行后, 在浏览器中输入软件所在电脑的 IP+端口号 即可看到软件, 首次进入显示可能如下图所示:

img_004

当连接状态显示为成功时, 点击左下角的打开编辑器即可, 进入应用.

注意: 在大部分的情况下服务器地址栏留空即可, 不需要输入任何内容, 该输入框为预留接口, 用于后续在平板版本使用.

# 打开项目

点击打开编辑器后, 显示页面如下:

img_005

在已经有项目数据包(项目名称_v1.0.0_202101010808.sccs)的情况下, 点击导入项目, 选择数据包导入即可, 如果没有数据包, 则需要点击新建项目来创建一个新项目.

项目编辑器的使用教程不在此文档范畴内, 如需学习使用通用中控软件的编辑器, 请参考《通用中控编辑器使用手册》

# 运行项目

在项目导入完成, 或者编辑结束后, 点击编辑器右上角的运行按钮即可运行该项目.

img_006

后续进入系统, 还可以直接从首页运行项目.

img_007

# 用户管理

# 1. 修改密码

img_012

在进入修改密码页面后, 请先输入旧密码, 之后再输入两次新密码, 再点击确定修改即可更新密码.

img_013

# 2. 创建用户

管理员账户可以通过右上角账户菜单中的管理账户功能, 新添加或者删除账户, 新添加的账户有两种模式, 管理员和普通用户, 管理员账户可以对其他账户进行管理, 进行数据库配置, 但普通账户只能访问系统, 无法对账户、数据库等配置信息进行修改.

img_014

# 使用软件

在创建完用户后,基本配置就已经完成了,具体使用方法参考使用手册

# 安装ArangoDB数据库(可选)

下载地址:ArangoDB 36 (opens new window)

建议下载 3.6.9 版本,不同平台安装教程安装请参考:https://www.arangodb.com/download-major/

# CentOS 安装

CentOS 安装 3.6.9 版本

# 服务安装指令
cd /etc/yum.repos.d/
curl -OL https://download.arangodb.com/arangodb36/RPM/arangodb.repo
yum -y install arangodb3-3.6.9-1.0

# 服务控制指令
systemctl start arangodb3.service				# 启动服务
systemctl enable arangodb3.service			# 启动开机自启
systemctl disable arangodb3.service			# 关闭开机自启
systemctl restart arangodb3.service			# 重启服务
systemctl stop arangodb3.service				# 停止服务
systemctl status arangodb3.service			# 查看状态

正常安装日志如下,当出现 Complete! 后即表明安装成功。

[root@ss ~]# cd /etc/yum.repos.d/
[root@ss yum.repos.d]# curl -OL https://download.arangodb.com/arangodb36/RPM/arangodb.repo
......
[root@ss yum.repos.d]# yum -y install arangodb3-3.6.9-1.0
......
SECURITY HINT:
run 'arango-secure-installation' to set a root password
the current password is 'a7a776a4eca1f4e7064c0e4398d2de21'
......
Installed:
  arangodb3.x86_64 0:3.6.9-1.0
Complete!

[root@ss yum.repos.d]# systemctl start arangodb3.service
[root@ss yum.repos.d]# systemctl enable arangodb3.service

在CentOS 安装后会自动生成 root 用户的密码,该密码可以后续在网页控制端进行修改,Arangodb 默认的启动端口为 8529。

在数据库服务启动后,通过 http://IP:8529 即可访问到数据库管理页面,如果无法访问,请检查防火墙和服务供应商的安全策略配置。

# 银河麒麟安装

# 下载软件

到官方网站下载安装包: https://www.arangodb.com/download-major/

如下图,选择 debian 或者 ubuntu 版本,推荐优先选择 ubnntu 版本。

arangodb_025

下载后会是一个 .deb 后缀的安装包,双击打开,点击一键安装即可。

arangodb_026

在银河麒麟安装后会自动启动并生成 root 用户,默认密码为空,该密码可以后续在网页控制端进行修改。在数据库服务启动后,通过 http://127.0.0.1:8529 即可访问到数据库管理页面,如果无法访问,请检查防火墙和服务供应商的安全策略配置。

注意:首次进入数据库请立即修改 root 用户的密码!

进入网页后的配置逻辑和下方 window 配置逻辑一致。

# Windows 安装

# 下载软件

Windows下载 3.6.9 版本:ArangoDB3-3.6.9_win64.exe (opens new window)

下载后可以看到 ArangoDB 的安装文件,如下图所示:

img_001

####安装软件

双击执行该软件,只需要普通用户权限即可,不需要使用管理员权限执行,之后按照步骤提示进行操作。

在此处设置管理员的密码,建议密码强度:

  1. 口令长度至少8个字符;
  2. 口令必须包含如下至少两种字符的组合:
  • -至少一个小写字母;
  • -至少一个大写字母;
  • -至少一个数字;
  • -至少一个特殊字符:`~!@#$%^&*()-_=+|[{}];:'",<.>/? 和空格;
  1. 口令不能和账号一样;

# 登录管理页面

安装完成后会自动打开浏览器,如果没有自动打开,就手动在浏览器中输入 http://127.0.0.1:8529 ,可以看到如下的登录页面,登录的账号为 root,密码为之前设置的密码。

# 创建新用户

此处选择刚刚新建的用户。

# 数据库开启 HTTPS(SSL) (可选)

如果需要开启 HTTPS 访问,请先去申请或者自签名一个证书,自签名证书教程:

https://www.arangodb.com/docs/stable/programs-arangod-ssl.html

最终需要得到如下格式的证书,文件名为 *.pem

-----BEGIN CERTIFICATE-----
(base64 encoded certificate)
-----END CERTIFICATE-----
-----BEGIN RSA PRIVATE KEY-----
(base64 encoded private key)
-----END RSA PRIVATE KEY-----

将该证书放到如下 arangodb 的安装目录下。例如:C:\Program Files\ArangoDB3 3.6.9\etc\cert

打开 ArangoDB 的配置文件,位置在C:\Program Files\ArangoDB3 3.6.9\etc\arangodb3\arangod.conf, 如下:

使用文本编辑软件打开,请尽量不要使用记事本软件,推荐使用 Notepad++ 或者 SublimeText,打开后将配置信息修改为如下内容,注意红框部分:

到任务管理器里面重启服务,任务管理器可以通过 Ctrl + Shift + Esc 快捷键打开,也可以任务栏右键 -> 任务管理器进行打开。找到 ArangoDB,右键选择重新启动即可。

等服务重启结束后在浏览器输入: https://127.0.0.1:8529 ,如果使用了自签名证书,可能会提示警告,请按照下面步骤操作即可。

# 开启 HTTPS(SSL) (可选)

在本软件中,HTTPS 会根据是否有证书自动进行判断。

# 1. 获取签名证书

该证书可以自签名,也可以使用机构进行签名,最后获得两个签名文件,其格式如下:

img_015

*.key

-----BEGIN RSA PRIVATE KEY-----
MIIEowIBAAKCAQEAhTnuPoSu1GkWFynAuWqbLWDc0jD4wTLmngZyVgKsF2jvtb4D
qGhswfzWN2Mp+5kgKqjz4Nig2sw7oPZshV7G66r+GjrI3q1L/CbyxTDoGxYb/c0X
...... // 省略部分内容
-----END RSA PRIVATE KEY-----

*.pem 或者 *.crt

-----BEGIN CERTIFICATE-----
MIIFmzCCBIOgAwIBAgIQDSY0l2Smd6KUbeRuLUYc0DANBgkqhkiG9w0BAQsFADBu
MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3
...... // 省略部分内容
-----END CERTIFICATE-----

如果格式不是这种的,请使用 SSL 工具进行转化,或者重新生成该格式的证书。

# 2. 复制证书指定位置

将签名证书复制到 {用户目录}/Sansi/CCS-Platform/cert 目录下,如果该文件夹不存在,就新建一个文件夹,确保其中一个文件后缀为 *.key,另一个文件为 *.pem 或者 *.crt 。文件格式见上面的描述。

注意:请保留原始证书文件并存储到安全的位置,放到 cert 目录下的证书私钥会自动进行加密,为了保障安全性,密钥与系统绑定,无法在外部解密还原,所有请自己另行存储证书原始文档。

iShot2021-02-04 16.39.05

# 3. 重启服务

当启动的终端日志输出如下图所示,显示为 https 时,表明已经成功开启了 HTTPS 服务。

=======================================================
  Data File on: /Users/gcssloop/Sansi/CCS-Platform
  Listening at: https://localhost:3436/
  Listening at: https://192.169.100.101:3436/
  CCS  Web  on: https://192.169.100.101:3436/ccs-web/
  CCS  BR   on: https://192.169.100.101:3436/ccs-br/
  API  Doc  on: https://localhost:3436/docs/api
=======================================================

# 4. 信任证书

如果使用了自签名证书,在浏览器访问时会提示警告,请按照下图操作。


img_017


img_018


如果点击后没有继续前往的链接,请检查证书格式是否正确,调整证书后,重启服务,再进行访问。

也可以将证书添加到用户系统,选择始终信任该证书后进行访问。

# CCS-Web组件部署说明

# 通用中控中拖拽ccs-web组件

  • 打开服务地址如http://192.168.1.100:3436/#/editor
  • 将ccsweb服务拖入页面内
  • 设置/ccs-web/#/index的地址
  • 点击运行即可查看 ccweb 配置

ccsweb_01

ccsweb_01

# 开启ccsweb代理防止跨域问题

# 1.找到当前用户下Sansi目录,路径/config/ccs-server.js

# 2.用编辑器打开

ccweb13

# 3.设置代理,如下图所示,保存后重启ccs-platform软件

ccweb13

# 4.进入项目登录页

ccs-platform即通用中控项目

ccsweb3

# 5.ccs-web 配置

在ccs-platform目录下,找到如下图路径

ccsweb4

ccsweb5

# 开启 ccs-web 反控功能

# 1.设置配置文件 REVERSE_CONTROL值为true

# 2.设置 REVERSE_URL 地址,值为控制端 ip+端口号

# 3.配置文件设置完成,保存

# 4.安装控制端,如下图软件点击运行对应平台安装文件即可,默认地址为本机IP+3437的端口,如http://192.168.1.100:3437

ccsweb5

# 5.安装被控制端

  • 在windows系统安装被控制端VNC软件,tigervnc64-winvnc-1.11.0 .exe
  • 按照指示完成后,创建桌面快捷方式,并启动程序
  • 测试VNC是否正常使用http://128.0.0.19:3437?path=ws/host/128.0.0.64:5900 其中128.0.0.19位控制端IP,128.0.0.64为被控制端IP

# 6.设置对应信号真实IP

ccsweb5

点击反控设置,到如下界面为对应信号源设置对应电脑IP

ccsweb5

1 设置对应信号IP
2 选中是否启用反控功能
3 点击确定完成反控设置

# 7.信号源反控操作

ccsweb5

点击信号源或者鼠标右键点击反控,即可进入控制界面

# 8.窗口信号反控,右键点击反控

ccsweb5

# 9.点击反控后进入反控页面

ccsweb5

反控页面可对被控制电脑进行操作,页面最上方 退出反控 按钮,返回到主页

# 重要数据位置

# 更新拼接器

  • 如果使用VP分布式拼接器,将项目包下载后放入软件所在的www目录下的ccs-web中即可

  • 使用集中式拼接器下载后放入软件所在的www目录下的ccs-br目录中即可

# 应用数据目录

应用启动后, 会在用户目录下生成相关文件, 如下:

在window系统中, 该文件夹路径可能为: C:\Users\CCC\Sansi\CCS-Platform, 其中 CCC 为当前用户名.

在 Linux系统中, 该文件夹的路径可能为: /home/CCC/Sansi/CCS-Platform, 其中 CCC 为当前用户名.

img_008

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

# 数据备份

  1. 将用户数据目录,例如: C:\Users\CCC\Sansi\CCS-Platform 全部压缩后另存备份。
  2. 将项目数据导出为 .sccs 文件后进行备份。

# 附录

# 附录1: 项目配置文件属性

# 注意事项

  • 部分路由器没有明确的 LAN口和 WAN 口,当检测到外网被识别的口,被定义为 WAN 口,大多数项目是不接外网的,会导致无法正确识别 WAN 口, 导致连接 Wi-Fi 的设备之间 ping 不通, 需要登录到路由器配置页面手动指定 WAN 口.
  • Pad 上使用 Chrome 访问, 地址栏占用空间过大, 将页面添加到桌面即可, 如果无法添加到桌面, 参考下一条.
  • Pad 在将应用也添加到桌面不生效,应在Pad设置 -> 权限管理 -> 找到 Google Chrome -> 发送到桌面 开启发送到桌面权限
  • 所有可控设备在控制界面发出对应指令不生效时,应检测通信是否正常,使用电脑 ping 目标设备,检测是否可以 ping 通.
  • 当前软件仅支持 Chrome 80 以上的版本, 如果运行过程中发现问题, 请检查 Chrome 版本是否为最新版本.
  • 设置自动启动策略时, 一定要注意启动账户和账户名是否和当前配置的账户一致.