Summary

安装

作为系统管理员，我们假定您具备了一定的专业背景知识，否则以下安装过程可能无法顺利进行。如果您不具备相关的专业知识，可以考虑 购买 我们的商业服务

系统环境准备

RB 使用 Java 开发，因此可运行在几乎所有操作系统上，如 Windows/Linux/Unix 等。 同时 RB 还依赖以下软件环境，建议在安装前准备好。如果您使用 集成安装包 并仅用于测试评估，那么它们都不是必须的。

  • MySQL 5.6+
  • JDK 1.8+（可选，“集成安装包”自带）
  • Redis 3.2+（可选，可使用自带 Ehcache 缓存）

? MySQL 5.7 及以上请移除 SQL_MODE 中的 ONLY_FULL_GROUP_BY 项。详见 https://www.cnblogs.com/easilyai/p/11729882.html
MySQL 8 及以上需要启用 mysql_native_password 即密码认证模式。详见 https://blog.csdn.net/beyond_yanbo/article/details/82458494

您可以下载我们配置好的 MySQL 绿色安装包，解压即可使用。请注意此安装包仅支持 Windows 64 位平台，同时建议您阅读安装包内的 README.txt 文件

! 请勿与其他系统共用 Redis，因为在某些情况下 RB 可能会刷新/清空缓存

若您使用宝塔面板，请 参考此文档 进行安装

硬件要求

对于硬件方面的需求，主要取决于系统的并发量和数据量。按照一般情况，我们建议的硬件如下：

  • 最低配置：2 核 CPU + 4G 内存 + 200G 硬盘
  • 推荐配置：4 核 CPU + 8G 内存 + 500G 硬盘

下载安装包

您可以到 RB 官网 下载最新版安装包，也可以至 RB 的 GitHub 项目 页下载。每个发行版本我们都会提供编译好的安装包，安装包分为两种：

  • 集成安装包 rebuild-standalone.zip 除了 REBUILD 程序外还自带了运行环境，包括：
    • Apache Tomcat
    • OpenJDK（此 JDK 不适用 macOS 系统，macOS 系统请先自行安装 JDK）
    • 启动/停止脚本
  • Boot 安装包 rebuild-boot.jar 只包含 REBUILD 程序自身

如果您对 Spring Boot 了解，可以使用 Boot 安装包，否则建议您使用集成安装包，两种安装包在功能上没有差异。

开始安装

启动

集成安装包启动

解压安装包并进入主目录，运行 start-rebuild.bat（Windows）或 start-rebuild.sh（Linux/Unix）即可启动。

? Linux/Unix 执行 .sh 脚本时若提示没有执行权限，请在 RB 安装目录执行命令 chmod +x chmodx.sh && ./chmodx.sh 添加执行权限

? 如遇启动异常，您可以在命令行窗口为启动脚本添加 run 参数前端启动，以便查看启动过程中遇到的问题。如 start-rebuild.sh run

Boot 安装包启动

可以通过以下命令启动 Boot 安装包：

java -jar rebuild-boot.jar

通常情况下您还需要指定一些额外的启动参数，并以后台模式运行，因此以下（Shell）命令可能更为适合。

// https://github.com/getrebuild/rebuild/tree/master/.deploy/restart-rebuild.sh
nohup java -Xms2G -Xmx2G -XX:+UseG1GC -Djava.awt.headless=true -jar rebuild-boot.jar >/dev/null 2>&1 &

进入安装页

启动后，请打开浏览器并输入 http://localhost:18080/ 访问，RB 会自动进入安装页并引导您完成安装。

? 如未自动进入安装页，可能是之前已经安装过。请将 RB 数据目录 删除后重新启动即可。如果需要在一台服务器上运行多个 RB 服务，请参考 在一台服务器上运行多个实例

安装模式

进入安装页后，有两种安装模式可供选择。其中 [快速安装] 将使用内置的 H2 数据库进行安装，此模式非常简单，可以快速安装体验 RB 功能。但请注意，此模式仅供测试使用，不支持升级，且部分功能可能无法使用。

使用 [快速安装] 模式步骤较为简单，因此本文主要介绍 [标准安装]（[标准安装] 步骤中已包括了 [快速安装] 步骤）。

标准安装

设置数据库 (1/5)

点击 [标准安装] 首先进入数据库设置，请按照字段要求填写您的数据库连接参数，或使用默认值。设置完毕后点击下一步，系统会自动测试连接，如测试失败将提示失败原因，请根据错误做相应调整。

? 请赋予 MySQL 用户足够的权限，否则数据库可能会初始化失败

? 若您填写的数据库已经存在，系统会自动检测是否为 RB 数据库后执行挂载，请确保数据库完整

设置缓存服务 (2/5)

缓存有助于提高系统访问速度，RB 支持以下两种缓存：

  • Ehcache（内置）
  • Redis（需要额外安装）

其中 Redis 具有更好的访问性能，与之相对的是更为复杂的配置，非高并发情况下使用内置的 Ehcache 即可。

设置超级管理员 (3/5)

在超级管理员设置页面，您可以为超级管理员指定新的密码和邮箱，默认密码为 admin。需要注意的是，超级管理员的登录名不能修改，固定为 admin。

选择初始业务实体 (4/5)

您可以选择由 RB 仓库 提供的已经配置好的业务实体直接使用。此步骤不是必须的，您也可以在安装完成后至管理中心 - 实体管理 - [添加实体] 进行安装，所提供的实体与此步骤是一致的。

RB 的 业务模块 需由用户自行搭建后使用，因此您完全可以根据自身需求进行搭建

选择完毕后点击 [完成安装] 即可进入安装过程。

完成安装 (5/5)

按照设置好的参数，RB 将自动完成安装过程，此过程一般需要 30-60 秒左右，完成后即可登录使用。如果安装失败，系统会提示错误原因，请根据错误提示进行相应调整后重新安装。

安装过程如遇问题，请向我们 提交 或购买我们的 商业服务 支持。

以上安装过程适用于 V2.0 及更高版本，之前的版本请 参考此处

常见问题

无法连接到 MySQL，请确认 MySQL 是否启动且运行正常，以及您填写“主机”“端口”是否有误。

Access denied for user 'xxx'@'xxx' (using password: YES)

MySQL 用户名或密码错误。请确认 MySQL 用户名、密码是否正确，以及您填写的（MySQL）“用户名”“密码”是否有误。

Specified key was too long; max key length is xxx bytes

此问题常见于 MySQL 5.6 版本，原因为索引长度超限，建议升级 MySQL 5.7 或更高版本（MySQL 官方对 5.6 版本已 停止维护）。

Invalid ID for region-based ZoneId, invalid format: xxx

RB 无法获取正确的系统时区。请添加 JVM 启动参数手动指定时区，如 -Duser.timezone=Asia/Shanghai。

Public Key Retrieval is not allowed

此问题常见于 MySQL 8 版本，为 SSL/TLS 协议传输问题，建议使用 mysql_native_password 模式 或 添加 allowPublicKeyRetrieval=true 参数。问题参考 https://www.cnblogs.com/lusaisai/p/13372763.html

Table xxx doesn't exist

此问题常见于迁移 MySQL，在数据导出-导入时未保持表名大小写，导致无法找到表。请配置 MySQL 忽略大小写即可。详情参见 https://blog.csdn.net/guoliwei2010/article/details/78452691

数据备份

RB 默认开启数据备份，备份时间为每日凌晨 0 点，备份文件位于 数据目录 下的 _backups 目录，包括 backup_database.YMD.zip 数据库备份和 backup_datafile.YMD.zip 数据目录文件备份（从 V2.7 开始支持）。

如您使用 Windows 操作系统，请将 mysqldump.exe 加入到环境变量，RB 会调用此工具进行数据库备份。您可以在命令行窗口输入 mysqldump.exe 验证环境变量配置是否正确。Linux/Unix 在您安装 MySQL 时已自动将 mysqldump 加入到环境变量，通常无需手动设置

另请参见 mysqldump 数据备份失败

高级主题

集成安装包

从 V2.6.1 版本开始，集成安装包具备更全面的平台支持，包括：

  • jre-11.win64 Windows 平台 JDK 环境
  • jre-11.linux64 Linux/Unix 平台 JDK 环境（此 JDK 不适用 macOS 系统，macOS 系统请自行安装 JDK）
  • start-rebuild.bat stop-rebuild.bat Windows 平台启动/停止脚本
  • start-rebuild.sh stop-rebuild.sh Linux/Unix 平台启动/停止脚本

添加/修改 JVM 启动参数

若您想添加/修改 JVM 启动参数，可以编辑 start-rebuild.bat 或 start-rebuild.sh 文件，找到 JAVA_OPTS 关键词所在行并进行添加/修改。

数据目录

数据目录是指 RB 存放数据的地方，包括上传的附件（文件）、数据备份、系统日志等。默认位于用户目录下的 .rebuild 目录（可以直接搜索 .rebuild 查找其所在位置，请注意某些系统可能会将 . 开头的文件视为隐藏文件）。

如需修改默认数据目录，请通过 JVM 启动参数 DataDirectory 指定，如 -DDataDirectory=/data/rebuilddata（其中 /data/rebuilddata 为目录路径）。请注意原数据目录文件需要您自行迁移到新目录中。

另请参见 在一台服务器上运行多个 REBUILD 实例

使用 Nginx

Nginx 是一个高性能的 HTTP 和反向代理 Web 服务器，对 HTTPS 也有较好的支持。RB 提供了一个 Nginx 配置，您可以稍作修改并将其 include 到主配置文件中使用。

Boot 安装包启动脚本

若您使用 Boot 安装包并在 Linux/Unix 环境运行，可以直接使用 RB 提供的 启动脚本。

修改默认端口

集成安装包

集成安装包默认使用 18080/18005 两个端口，若出现端口冲突可修改 conf/server.xml 文件，找到 18080 和 18005 并修改为其他的（如 18180 18105）。此修改本质是修改 Tomcat 端口号，因此您也可以自行查阅如何修改 Tomcat 端口号。

Boot 安装包

Boot 安装包默认使用 18080 端口，可在启动时通过启动参数 server.port 指定使用其他端口，例如 java -jar rebuild-boot.jar --server.port=18180。

Redis 缓存冲突

如您使用 Redis 作为缓存系统，且与其他系统共享使用，可能出现缓存冲突，此类情况需要在启动参数中通过 RedisDatabase 指定 Redis 数据库号。

Redis 默认有 16 个数据库（0-15），RB 默认使用 0，您可以指定为其他的，只要不与其他系统冲突即可。

系统监控

在生产环境中，系统可用性是关键的质量指标，RB 会定期检测系统健康并实时反应在服务状态页面。

同时，RB 还提供了一个供第三方监控系统使用的接口 http://YOUR-RB-SERVER/error/server-status.json。您可以使用任意监控系统对此地址进行监控，并对返回结果进行验证即可。

腾讯云配置示例

进入腾讯云控制台 - 云拔测 - 站点质量监控，点击 [新建任务] 添加一个新的监测，并参考如下配置。

授权码

在安装完成后，系统将为您生成一个唯一授权码（或称 SN），授权码是重要的授权凭证，请勿随意泄漏！在您购买 RB 商业版本时，我们将对您的授权码进行授权，授权后即可获得相应权利。

如何查看我的授权码

登录 RB 后点击右上角 ⚙️ 进入管理中心 - 通用配置，在页面右侧“关于 REBUILD”区域，点击“授权类型”即可查看您的专属授权码。

关于 REBUILD

授权码

获取技术支持编号

当您的系统出现问题无法通过描述或页面提示获取有效解决方案时，您需要向我们提供技术支持编号以便我们获取更加全面的信息为您排除问题。

登录 RB 后点击右上角 ⚙️ 进入管理中心 - 通用配置，在右侧点击 [系统状态]，在打开的系统状态页面底部找到 [请求技术支持] 并点击，您将获得一个技术支持编号，请发送给 RB 服务人员。

域名白名单

如您的服务器运行在受限网络环境中，需要开通以下域名白名单，否则相关功能将不可用。

域名 说明 必须
getrebuild.com REBUILD 基础服务和授权 是
uc.qbox.me *.qiniup.com 七牛云存储接口 使用 七牛云存储 时必须
api-v4.mysubmail.com 短信、邮件接口 使用 短信/邮件 时必须（如使用 SMTP 邮件则需开通相应 SMTP 服务商发送域名）
qyapi.weixin.qq.com 企业微信接口 使用 企业微信集成 时必须
oapi.dingtalk.com 钉钉接口 使用 钉钉集成 时必须
该文档内容对您是否有帮助？有没有
如有任何疑问，请与我们的 社区 或 QQ 群 联系
Updated 11/15/2023, 4:13:37 PM
Edit
目录