锦中统一消息平台安装部署手册

## 1.安装环境要求
### 服务器端硬件最低配置（性能低，不推荐）
至少需要一台服务器（数据库、中间件、应用安装在同一台服务器上）
CPU：2.40GHz或以上，至少需要2核
内存：4G
硬盘：可用空间 80G以上
其它方面无特殊要求
最低要求仅供演示使用

### 服务器端硬件建议配置
建议三台服务器，数据库、中间件、应用各一台服务器。

应用服务器建议配置如下：
CPU：2.40GHz或以上，建议8核
内存：16G
硬盘：可用空间 200G以上

应用服务器建议配置如下：
CPU：2.40GHz或以上，建议8核
内存：8G
硬盘：可用空间 30G以上

数据库服务器建议配置如下：
CPU：2.40GHz或以上，建议8核
内存：16G
硬盘：可用空间 500G以上
其它方面无特殊要求，建议根据使用用户数量酌情增减

### 服务器端软件配置要求
**操作系统**：Ubuntu 20.04.1（或以上版本）、openEuler 24.03（或以上版本）、统信 V20（或以上版本）、银河麒麟 V10（或以上版本）。
**Java**：jdk17 (或以上版本)、 openjdk17 (或以上版本)
**Nginx**： 1.18 （或以上版本）
**数据库**： MySQL 8.0（或以上版本）、达梦 V8、openGauss数据库 6.0.1、海量数据库 8.24875
**其它**：Redis 6.0 （或以上版本）

**用户端软件配置要求**
浏览器：Chrome、Firefox、Safari、Edge 等 chrome 内核的浏览器常规版本均可

## 2.安装步骤（数据库和应用各一台服务器）
**基础环境安装**

**JDK 安装**
[JDK安装教程](https://blog.csdn.net/qq_42557044/article/details/124935468 "JDK安装教程")

MySql 8 安装
[MySql 8 安装教程](https://blog.csdn.net/weixin_48088839/article/details/143756554 "MySql 8 安装教程")

**Redis 安装**
[Redis 安装教程](https://www.cnblogs.com/xiaobug/p/16007895.html "Redis 安装教程")

**Nginx 安装**
[Nginx 安装教程](https://blog.csdn.net/weixin_41302755/article/details/123175079 "Nginx 安装教程")

**国产数据库安装**
[国产数据库安装](https://doc.jzkg.cn/doc/1263/ "国产数据库安装")

License 申请( http://app.jzkg.cn )
锦中统一消息平台，是收费软件系统，需要有License才能正常部署。在您部署之前，应从官方获得正版的License。如果您还没有License，想先部署、测试的话，那么可以在部署之前，先到官方在线申请免费使用3天的License，在线申请url为：http://app.jzkg.cn 。

在申请License之前，需要先获得统一消息平台后端所在服务器的Ipv4地址（即Ip地址）、Ipv6地址和Mac物理地址。方法为在控制台中输入：ip a 命令即可看到。

## 后端部署

（1）将打包好的 jar 包上传至服务器指定文件夹中
（2）以后台运行方式启动即可
`nohup java -jar xiaoxi.jar >/dev/null 2>&1 &`

也可以引用外部配置文件，在默认配置文件位置的基础上，额外添加配置文件位置。Spring Boot 会先加载默认配置，再加载这些额外配置，额外配置会覆盖默认配置中的相同属性。假设配置文件的路径是"/data/application.yml"
`nohup  java -jar -Dfile.encoding=UTF-8 -Duser.timezone=GMT+8 /data/xiaoxi.jar  --spring.profiles.active=prod --spring.config.additional-location=/data/application.yml`

（3）假设您的服务器Ip为：192.168.1.118 ，部署端口为8088 , 后端部署好之后，通过URL： http&#058;//192.168.1.118:8088/blade-auth/oauth/captcha 如果看到”key” 相关字样，则后端部署成功

## 配置文件注意事项
```yaml
#服务器配置
server:
  port: 8088
## license配置
license:
  license-xml-address: /data/jzconfig/license.xml
## 数据库配置
spring:
  data:
    redis:
      ##redis 单机环境配置
      host: 127.0.0.1
      port: 6379
      password:
      database: 0
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://127.0.0.1:3306/xiaoxi?useSSL=false&useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&transformedBitIsBoolean=true&serverTimezone=GMT%2B8&nullCatalogMeansCurrent=true&allowPublicKeyRetrieval=true
    username: xiaoxi
    password: Xiaoxi
```

## 后端自动启动service文件
```
[Unit]
Description=JinZhong XiaoXi service
After=syslog.target
[Service]
Type=simple
User=root
WorkingDirectory=/data/
ExecStart=/usr/local/bin/jdk-17/bin/java --add-opens java.base/java.lang=ALL-UNNAMED -jar -Dfile.encoding=UTF-8 -Duser.timezone=GMT+8 /data/xiaoxi.jar --spring.profiles.active=prod --spring.config.additional-location=/data/application.yml

SuccessExitStatus=143
Restart=no
```
其中的 WorkingDirectory为程序工作目录；ExecStart为启动命令

## 前端部署
假设您的前端访问域名为： http&#058;//xiaoxi.jzkg.cn 。
（1）可使用Nginx、Apache等任何静态文件服务器部署前端，确保可以在公网访问前端。
（2）在Linux系统上解压前端文件时，如果使用unzip命令的话，可采用 sudo unzip  yourfrontfile.zip 命令。

## 其他部署
（1）前端http&#058;//xiaoxi.jzkg.cn，访问后端api的路径默认前缀为：http&#058;//xiaoxi.jzkg.cn/api/ ，比如上文中的
http&#058;//192.168.1.118:8088/blade-auth/oauth/captcha ，应当能通过 http&#058;//xiaoxi.jzkg.cn/api/blade-auth/oauth/captcha 路径访问，以下为在Nginx上配置后端的相关代码：

```shell
server {
    listen       80;
    server_name  xiaoxi.jzkg.cn;
    location ^~/api {
    proxy_pass http://192.168.1.118:8088;
    rewrite "^/api/(.*)$" /$1 break;
    }
}
```
**注意**：由于统一消息平台中有邮件发送相关功能，邮件模板中有背景图片，在第三方邮件系统（如163邮箱，QQ邮箱）收取并显示邮件时要求引用的外部附件（如邮件背景图）需开启https(ssl)功能。因此，我们建议您使用https方式部署本系统，采用https时，上述80端口需改为443，同时应配置ssl证书。

## 对象存储配置
1. 配置完成前端、后端之后，应立刻通过admin账号前往 **资源管理->对象存储->本地存储->点击编辑** 做以下配置：
**资源地址**：示例：http&#058;//xiaoxi.jzkg.cn/  (其中的xiaoxi.jzkg.cn改为你的实际域名，如果启用了ssl，请将http改为https)
**外网地址**：示例：http&#058;//xiaoxi.jzkg.cn/api/blade-resource/oss/endpoint/view-file/ (其中的xiaoxi.jzkg.cn改为你的实际域名，如果启用了ssl，请将http改为https)
**空间名**：示例：xiaoxi
**accessKey**: 附件的保存在应用服务器上的路径，示例：/data/xiaoxi/atts
**secretKey**：默认值：000000

然后，依次点击：修改、启用
2. 点击调试按钮并上传一个图片测试，若看到图片显示成功则说明对象存储的本地模式配置成功了

做完以上配置之后，需清空Redis中所有的数据，并重启jar包（或重启服务器）。清空Redis的命令为：
```
select 0  # 选择你的Redis库，这里为第0个库
flushdb   # 清空当前Redis库
```

## 邮箱模板文件存放
***在进行此步骤之前，务必先进行==对象存储配置==***
我们准备了4张Email邮件背景附件放在安装包中。Email邮件在“渠道管理”-“邮件模板”，4张背景分别对应于此处的4个邮件模板，对应关系如下：

| 邮件模板名称 | 对应背景图名称 | 页边距 |
| --- | --- | --- |
| 迎新活动通知 | 1.jpg | 100px 100px |
| 校庆通知 | 2.jpg | 100px 100px |
| 表彰性通报 | 3.jpg | 100px 100px |
| 放假通知 | 4.jpg | 100px 100px |

按以上对应关系上传背景图及设置页边距能较大程度保证Email展示效果。 Email背景图存放在服务器上的上述“对象存储配置”中设定的地址上。由于Email邮件提供商大部分开启了ssl安全，应尽量保证您的服务器配置了ssl安全证书（https），否则可能导致背景图不显示。

## 操作系统时区配置
由于本系统用到定时任务、夜间屏蔽，因此务必正确设置时区，否则可能会导致出错。
以Ubuntu 为例

一、修改时区 使用 timedatectl 命令（推荐）
- 查看当前时区命令： ```timedatectl```

- 输出如下
```shell
Local time: Tue 2025-06-16 14:30:00 CST
Universal time: Tue 2025-06-16 06:30:00 UTC
RTC time: Tue 2025-06-16 06:30:00
Time zone: Asia/Shanghai (CST, +0800)
System clock synchronized: yes
NTP service: active
RTC in local TZ: no
```

- 切换时区
```bash
sudo timedatectl set-timezone Asia/Shanghai
```
二、 修改时间
```bash
sudo timedatectl set-time "2025-06-16 14:30:00"
```

## 其它说明
1. 系统默认登录账号为：admin，默认密码为：www&#046;jzkg.cn，如遇密码错误，可将数据库中blade_user表的password列改为10688ef64e1d14f0e86facaa220212cb8cedb2b0，则密码自动重置为www&#046;jzkg.cn。
2. 安装包中准备有模拟数据，如有需要，可登录系统中在相应模块中导入模拟数据。