Crest 文档
安装部署

单机在线安装

使用 installer/install.sh 在线安装 Crest,并理解关键配置和安装结果。

单机在线安装适合有网络访问能力的服务器。安装脚本会自动准备运行目录、配置文件、Docker Compose、系统服务和初始密码。

这种方式适合演示环境、内部小规模使用或单节点部署。Crest v1.5.7 单机安装会启动前端网关 crest、后端服务 crest-service 和元数据库 mysql-crest;需要监控时,还可以同时启用 crest-prometheuscrest-grafana。正式使用前仍然要按生产标准准备域名、HTTPS、备份、密码和运维责任人。

安装目录

在源码仓库中进入安装目录:

cd installer

主要文件:

文件说明
install.sh安装或升级入口
install.conf安装配置模板
uninstall.sh卸载脚本
crestctl安装后的运维命令
crest/docker-compose.ymlDocker Compose 模板
crest/templates/application.yml后端配置模板
crest/observabilityPrometheus 规则、Grafana 数据源和看板模板

安装目录建议固定,升级时不应频繁变更。后续备份、日志排查、服务重启和故障恢复都依赖该目录。生产环境可以把数据目录放在独立磁盘,并将挂载关系写入运维文档。

修改安装配置

安装前先打开 install.conf,至少确认以下配置:

CREST_BASE=/opt
CREST_PORT=8100
CREST_CONTEXT_PATH=
CREST_LOGIN_TIMEOUT=960
CREST_BACKEND_IMAGE=ghcr.io/sevoniva/crest-service:v1.5.7
CREST_FRONTEND_IMAGE=ghcr.io/sevoniva/crest-web:v1.5.7
CREST_MYSQL_IMAGE=mysql:8.0.43
CREST_ORIGIN_LIST=http://localhost:8100
CREST_CRYPTO_MODE=standard

生产环境建议显式配置:

CREST_PORT=8100
CREST_ORIGIN_LIST=https://bi.example.com
CREST_INITIAL_PASSWORD='替换为高强度初始密码'
CREST_DB_PASSWORD='替换为高强度数据库密码'
CREST_AES_KEY='32位加密Key'
CREST_AES_IV='16位加密IV'
CREST_CRYPTO_MODE=standard

如果留空,安装脚本会自动生成密码和加密参数,并在安装日志中输出。

生产环境不建议完全依赖安装过程中的临时输出。管理员应在安装前生成高强度密码和 AES 参数,并将其保存到企业密码库或受控台账中。后续迁移、恢复和升级时,这些值必须可追溯。

需要启用国密时,在首次安装前明确改为:

CREST_CRYPTO_MODE=sm-suite
CREST_SM4_KEY='0123456789abcdef'

sm-suite 模式用于需要 SM2、SM3、SM4 的环境。启用后,用户创建数据源、数据集、仪表盘和数据大屏的方式不变;运维侧需要把 CREST_SM4_KEY 和 AES Key、AES IV 一起纳入密钥管理,升级和恢复时不要更换。

需要启用监控时,在同一份 install.conf 中打开:

CREST_PROMETHEUS_ENABLED=true
CREST_GRAFANA_ENABLED=true
CREST_GRAFANA_PORT=3000

Prometheus token 和 Grafana 管理员密码留空时,安装脚本会自动生成。生产环境建议提前生成并保存到企业密码库。详细说明见 监控与可观测性

执行安装

bash install.sh

安装脚本会依次完成:

读取配置

加载 install.conf,确定安装目录、端口、镜像和密码策略。

初始化目录

创建 /opt/crest 或你在 CREST_BASE 中指定的运行目录。

准备容器

安装或复用 Docker 与 Docker Compose,拉取或加载应用和 MySQL 镜像。

生成运行配置

写入数据库连接、加密模式、AES 参数、国密 SM4 Key、初始密码、允许来源等配置。

启动服务

启动 MySQL、后端服务、前端网关和可选监控组件,并注册系统服务。

输出登录信息

输出访问地址、管理员账号和初始密码。

登录验证

浏览器访问安装输出的地址:

http://服务器IP:8100

登录页

默认账号:

用户名:admin
密码:安装完成后终端输出的初始密码

登录后进入工作台:

工作台

工作台可访问后,系统只完成基础可用验证,仍不能直接交付。继续进入系统管理检查站点名称、管理员密码、分享配置和导出中心;再创建一个测试数据源和数据集,确认数据库连接、文件目录和后台任务均正常工作。

安装失败排查入口

现象先检查
Docker 安装失败服务器是否能访问软件源,或是否需要使用离线包
镜像拉取失败镜像仓库网络、代理、镜像名称
端口占用`ss -lntp
数据库启动失败MySQL 容器日志、磁盘空间、数据目录权限
前端网关启动失败docker compose logs -f crest
后端服务启动失败docker compose logs -f crest-service
监控组件启动失败docker compose logs -f crest-prometheusdocker compose logs -f crest-grafana

安装脚本日志应保留,便于后续定位初始密码、安装目录和错误原因。

安装后立即处理

修改管理员密码

使用安装输出的初始密码登录后,立即进入个人菜单修改密码。

检查站点设置

修改系统名称、Logo、浏览器标题等信息,确保交付页面不是临时名称。

创建验证资源

创建一个测试数据源、数据集和仪表盘,确认完整链路可用。

配置备份

至少备份数据库、运行配置、上传目录和安装脚本输出信息。

记录交付信息

记录访问地址、安装目录、端口、版本、管理员负责人和维护命令。