概览
Crest 文档中心入口,覆盖安装部署、配置管理、用户指南、管理员指南、运维维护、开发扩展和常见问题。
Crest 是面向私有化部署场景的开源 BI 平台,适用于企业内部数据分析、经营看板、项目交付和可视化大屏建设。平台覆盖数据源接入、数据集建模、图表制作、仪表盘搭建、数据大屏、数据门户、分享发布、导出中心、数据血缘、用户权限和系统管理等完整流程。
本文档按实际使用场景组织。首次部署人员可从快速开始进入,运维人员可直接阅读安装部署和运维维护,业务用户可按用户指南完成数据分析页面,管理员可按管理员指南完成账号、权限、SSO 和审计治理。

产品能力
| 能力 | 说明 |
|---|---|
| 数据接入 | 支持数据库、Excel、API 等数据源,提供连接测试、表结构读取和数据预览 |
| 数据建模 | 通过数据集管理字段、指标、维度、权限、缓存和参数 |
| 可视化分析 | 支持图表、仪表盘和数据大屏,覆盖日常分析和展示大屏 |
| 数据门户 | v1.5.5 起提供独立门户,普通用户可在授权范围内查看已发布资源、收藏和最近使用 |
| 发布协作 | 支持已发布资源访问、资源分享、导出中心、预览和外部访问治理 |
| 数据治理 | 提供数据血缘、权限控制、审计日志和平台级管理能力 |
| 私有化部署 | 支持单机、离线、Docker、Kubernetes、外部 MySQL、应用镜像升级包和前后端分离运行方式 |
| 国密支持 | 支持 standard 和 sm-suite 两种加密模式,满足需要 SM2、SM3、SM4 的部署场景 |
| 可观测性 | v1.5.4 起支持按需启用 Prometheus 指标、Grafana 看板和告警规则 |
文档导航
快速开始
用最短路径完成部署、登录和第一个分析页面。
版本发布
自动展示 GitHub Releases 中的版本记录、发布说明、离线包和校验文件。
安装部署
说明服务器要求、在线安装、离线安装、Docker、Kubernetes、外部 MySQL 和部署后检查。
配置管理
说明端口、域名、HTTPS、数据库、站点标题、日志、SSO 和分享安全配置的修改方法。
用户指南
面向业务用户和数据分析人员,讲解数据门户、工作台、数据源、数据集、图表、仪表盘、大屏、分享、导出和血缘。
管理员指南
面向平台管理员,讲解用户、组织、角色、权限、SSO、系统参数、审计日志和字体管理。
运维维护
说明备份、升级、回滚、日志清理、健康检查、监控告警和日常维护。
安全说明
说明账号、密码、密钥、权限、分享、数据源、SSO 和审计方面的安全要求。
开发指南
面向开发者,讲解源码结构、本地启动、构建、菜单页面、接口和常见构建问题。
常见问题
收录安装、登录、权限、数据源、数据集、可视化、分享、导出和 SSO 的处理方法。
推荐阅读路径
先部署
尚无可访问的 Crest 环境时,先从“快速开始”进入,再按“安装部署”完成安装。
再配置
生产环境部署完成后,先确认访问端口、系统地址、HTTPS、数据库连接、备份目录和管理员账号。
开始使用
业务用户从工作台进入,按“数据源、数据集、图表、仪表盘或大屏”的顺序完成分析页面。
做好治理
管理员应尽早配置组织、角色、资源权限、分享安全、SSO 和审计日志,避免后期权限边界不清。
核心业务流程
适用对象
| 对象 | 主要阅读内容 |
|---|---|
| 初次部署者 | 快速开始、安装部署、配置管理、常见问题 |
| 业务用户 | 用户指南、常见问题 |
| 数据分析人员 | 数据接入、数据集、图表、仪表盘、数据大屏、数据血缘 |
| 平台管理员 | 管理员指南、安全说明、运维维护 |
| 开发者 | 开发指南、源码结构、构建说明 |
版本说明
本文档面向 Crest v1.5.7。v1.5.7 延续前后端分离运行形态,支持默认 standard 加密模式和可选 sm-suite 国密模式,可按需启用 Prometheus 和 Grafana,并提供数据门户、应用镜像升级包、数据大屏导出按钮、表格表头说明、账号安全参数和 MySQL 数据集缓存。启用国密或监控后,数据源、数据集、图表、仪表盘、数据大屏、分享、导出和数据血缘的用户操作流程保持一致;数据门户、升级 SQL、应用镜像升级包、账号安全参数、公开分享链路和缓存同步任务应按版本说明进行配置和验证。
不同部署方式、账号权限和现场配置会影响菜单展示、演示数据和默认参数。若页面中没有出现某个入口,优先检查当前账号角色、菜单权限、资源权限和部署版本。