私有部署的安装

更新时间：2024-08-19

安装环境

Sugar BI的部署，对机器的软件和硬件环境要求如下：

软件环境

Docker

需要您的机器安装Docker，推荐版本为v17及以上，Sugar BI可以直接运行在单机 Docker 环境上，如果需要集群化、高可用，可以使用 Docker 自带的 swarm 或者 kubernetes；Sugar BI的安装部署过程中需要您对 Docker 的基础知识有所了解，详见Docker 官网。

Docker 的安装建议参考官方文档，可以安装在Centos、Ubuntu、Docker Desktop on Windows、Mac等系统上。Windows 上的 Docker 启动需要使用「以管理员身份运行」。

如果 Docker 官网访问比较慢，可以试试百度网盘（提取码: 8ym5）。

MySQL

推荐使用MySQL 5.7版本（如果用 MySQL 8 需要 --default-authentication-plugin=mysql_native_password），该 MySQL 数据库用来存储Sugar BI的系统数据，MySQL 需要您自己安装和运维，并且需要给Sugar BI创建一个空的数据库如sugarbi（排序规则使用utf8_general_ci）；当然，您可以使用 Docker 来快速安装 MySQL，详见Docker MySQL，现提供单机 Docker 情况下安装启动 MySQL 并创建sugarbi数据库流程：

上图中主要的命令行（其中lovesugar123即数据库 root 账户的密码，您可以改成自己想要的密码）：

mkdir ~/mysqlData
docker run --ulimit nofile=65100:65100 --restart unless-stopped --name sugar-mysql -p 3306:3306 -v ~/mysqlData:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=lovesugar123 -d mysql:5.7 --max_allowed_packet=100M --max_connections=1000
docker run -it --link sugar-mysql:mysql --rm mysql:5.7 sh -c 'exec mysql -h"$MYSQL_PORT_3306_TCP_ADDR" -P"$MYSQL_PORT_3306_TCP_PORT" -uroot -p"$MYSQL_ENV_MYSQL_ROOT_PASSWORD"'
CREATE DATABASE IF NOT EXISTS `sugarbi` DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;

对于 MySQL，我们建议您进行每天定时备份，防止机器故障导致数据丢失，使用上图的方式，我们已经将 MySQL 的数据挂载到了~/mysqlData文件夹下。

硬件环境

如果用户数不多（如：不超过 100 人、均匀的日访问量不超过 2000 次页面）且不严格要求高可用，单机运行即可，否则视具体情况推荐使用 kubernetes 集群方式部署（建议最少 3 台机器）；每台机器的配置建议：内存（最低 32G）、CPU（16 核或以上）、硬盘（256GB SSD 或以上）。集群部署时，如果在一台机器上启动多个Sugar BI实例，平均到每个Sugar BI实例的内存建议不小于 8GB。

下载

我们提供了两种获取Sugar BI安装包镜像的方式：

1、百度智能云的 docker 镜像服务

Sugar BI的镜像已经上传到百度智能云 docker 镜像服务，您可以使用以下命令获取Sugar BI镜像：

docker pull registry.baidubce.com/sugarbi/sugar:6.0.1
docker tag registry.baidubce.com/sugarbi/sugar:6.0.1 sugarbi/sugar:6.0.1
// 查看刚刚拉取的镜像
docker images

6.0.1是目前Sugar BI的最新版本，其他的版本可参考更新日志。此种方式要求您的部署机器能够连接互联网；如果您的部署机器不能直接连接到互联网，可以使用下面的方式。

2、直接在线下载

如果您的部署机器不能连接互联网，您可以在联网的机器上点击这里下载: https://sugar-docker-image.cdn.bcebos.com/sugarbi-6.0.1.tar.gz（如果鼠标点击下载不了，可以复制该地址在浏览器中打开），然后将下载的安装包拷贝到部署机器上，注意：如果您使用 swarm 来同时部署到多台机器上，需要将下载的安装包文件拷贝到所有部署机器上，并且以下的操作也需要在所有部署机器上执行。

在部署的机器上，进入到您拷贝的安装包的同目录下，

docker load -i ./sugarbi-6.0.1.tar.gz
// 上面的命令会执行数十秒，然后执行以下命令查看刚刚load的镜像
docker images

使用上面的两种方式下载Sugar BI的安装镜像，在最后执行docker images都能看到如下展示即证明下载成功：

另外，如果您的服务器 CPU、操作系统是国产化的，那么你可能需要 ARM 架构的镜像，详见ARM 架构镜像。

运行 Sugar BI

Sugar BI是基于 Docker 容器化的运行模式，所以安装也会比较简单，主要是提供相应的配置文件（MySQL 连接配置、License 配置等），其他基本就是一键启动。Sugar BI的启动有两种方式，分别对应 Docker 单机模式和多机集群模式：

一、Docker 单机运行

在 Docker 单机环境下运行Sugar BI很简单，分两步：

1、新建一个名为env的文件（文件名没有后缀，就是 env），并用文本编辑器打开，复制以下的内容并填写相应部分：

love_sugar=true
sugar_can_connect_local_ip=true

# MySQL数据库相关
sugar_db_username=root
sugar_db_password=lovesugar123
sugar_db_database=sugarbi
sugar_db_host=填写您安装MySQL机器的IP，即使是本机也不能使用localhost和127.0.0.1
sugar_db_port=3306

# license相关
sugar_company=license的组织代码
sugar_license=具体license

# redis配置
# 如果您需要「数据缓存」或者「定时推送」或者「数据预警」功能，需要配置这块，否侧不需要配置
# 如果您私有部署只是单机运行（即只运行一个sugar的实例），sugar已经内置，这块不需要配置
# 否则需要您自己搭建redis（2.6版本以上，最好是5的版本，可以使用类似上面mysql的docker方式来启动一个redis）
sugar_redis_host=
sugar_redis_port=
sugar_redis_password=

# 如果您搭建的 redis 是集群模式（Cluster）则需要将 sugar_redis_enable_cluster 设置为 1
# 此时，host 和 port 可以配置多个，用英文逗号分割并且host和port的个数要相同并一一对应，
# 如host配置为：1.1.1.1,2.2.2.2  port配置为：6379,6388
# redis 的集群模式（Cluster），需要在 3.3.4 及以上版本中才支持
sugar_redis_enable_cluster=

# 如果您搭建的 redis 是哨兵模式（Sentinel）则需要将 sugar_redis_enable_sentinel 设置为 1
# 并配置 sugar_redis_sentinel_name
# 此时，host 和 port 可以配置多个，用英文逗号分割并且host和port的个数要相同并一一对应，
# 如host配置为：1.1.1.1,2.2.2.2  port配置为：6379,6388
# redis 的哨兵模式（Sentinel），需要在 3.5.1 及以上版本中才支持
sugar_redis_enable_sentinel=
# 哨兵的名称
sugar_redis_sentinel_name=
# 哨兵节点的密码（如果只给 Redis 主节点配置了密码，则只需要配置sugar_redis_password即可）
sugar_redis_sentinel_password=

# 登录形式，支持 demo、email、password、oauth、token、ldap
# 如果是最初步的测试，可以使用demo方式，后面的其他登录方式的配置都可以不用填写
sugar_login_type=demo

# 登录类型为password时，配置为1即可开启密码复杂度判断（要求密码中至少需要包含大写字母、小写字母、数字、特殊符号中的三种，并且密码长度大于8；密码错误三次会锁定15分钟）
sugar_password_secure_check=
# 登录类型为password时，可以开启密码过期提醒，过期后要求用户必须修改密码
# 格式为数字加日期标识符。天：d，月：m，季：q，年：y。如2个月可表示为2m，3天为3d
sugar_password_expire=

# email登录模式的配置，以及「定时推送」「数据预警」功能也需要这块的配置，host 是 smtp 服务器
sugar_email_host=
# port 一般是 25 或 465
sugar_email_port=
sugar_email_username=
sugar_email_password=
sugar_email_from=
# 如果 smtp 端口是 465 则需要去掉下面的注释
# sugar_email_tls=true

# oauth登录模式的配置
sugar_oauth_authorize_url=
sugar_oauth_token_url=
sugar_oauth_client_id=
sugar_oauth_client_secret=
sugar_oauth_scope=
sugar_oauth_info_url=
sugar_oauth_data_username=
sugar_oauth_data_useremail=
sugar_oauth_email_suffix=
sugar_oauth_logout_url=
sugar_oauth_token_get=

# token登录模式的配置
sugar_token_login_url=
sugar_token_login_getTokenPath=
sugar_token_login_getUserInfoURL=
sugar_token_login_getUserInfoMethod=
sugar_token_login_getUserInfoExtraParam=
sugar_token_login_getUserInfoPostType=
sugar_token_login_getUserInfoSendTokenPath=token
sugar_token_login_goToURLPath=
sugar_token_login_getUserInfoGetUserEmailPath=
sugar_token_login_getUserInfoGetUserNamePath=
sugar_token_login_email_suffix=
sugar_token_login_sync_user_attr_path=
sugar_token_logout_url=
# 用户信息的唯一标识字段名，类似id
sugar_user_id_field=

# ldap登录模式的配置
sugar_ldap_login_url=
sugar_ldap_login_base=
sugar_ldap_login_key=
sugar_ldap_login_admin=
sugar_ldap_login_admin_password=
sugar_ldap_email_suffix=
sugar_ldap_password_type=

# 企业微信、钉钉和飞书的集成
sugar_companywx_oauth_appid=
sugar_companywx_oauth_secret=
sugar_companywx_oauth_agentid=
sugar_dd_oauth_appid=
sugar_dd_oauth_appkey=
sugar_dd_oauth_secret=
sugar_dd_oauth_agentid=
sugar_lark_oauth_appid=
sugar_lark_oauth_secret=
sugar_lark_use_private=
sugar_lark_origin=

# 企业角色相关的配置
sugar_enterprise_role_enable=
sugar_enterprise_role_name=
sugar_enterprise_role_enter_tip=
sugar_enterprise_role_url=
sugar_enterprise_role_syncUserMethod=
sugar_enterprise_role_syncUserSendIDPath=
sugar_enterprise_role_syncUserArrayPath=
sugar_enterprise_role_syncUserEmailPath=
sugar_enterprise_role_syncUserNamePath=
sugar_enterprise_role_userEmailSuffix=

# session强制过期天数（默认是7，表示登录账号后7天后强制失效。支持小数，如0.5表示12小时）
sugar_session_maxAge_days=
# 用户连续多少小时无操作后自动退出登录（默认是0，表示不受限制。支持小数，如0.5表示用户30分钟无操作后自动退出登录），5.1.0及之后版本才支持
sugar_session_expire_no_operation=
# SQL查询行数和大小以及格式化时间限制
# 查询结果的最大行数限制，云上默认是2万行、私有部署中默认10万行
sugar_query_result_max_rows=
# 查询结果的大小限制(单位是MB)，云上默认是15MB、私有部署中默认30MB
sugar_query_result_max_size=
# 查询之后的数据格式化时间限制（单位是秒，即worker的计算时间限制），默认是40秒
sugar_worker_timeout=

# 是否HTTPS，只有您部署的sugar并且设置了HTTPS证书时才需要配置
sugar_is_https=
# 是否忽略SQL语句的安全检查（准许SQL中出现drop、delete等关键词），默认是都检查，填写true时将不检查，1.9.1版本之后才支持
sugar_ignore_sql_security_check=0
# 私有部署下是否不显示home首页，直接跳到login登录页面
sugar_home_redirect_login=0
# 私有部署下是否不显示文档页面，直接跳转到login登录页面
sugar_docs_redirect_login=0
# 私有部署下是否不展示顶部导航中的文档相关入口
sugar_hide_docs_link=0
# 私有部署下是否隐藏空间广场右侧的官方示例和整个公告栏
sugar_hide_demo_and_news=0
# 私有部署下是否隐藏空间广场右下脚的产品动态
sugar_disable_product_news=0
# 私有部署下是否隐藏空间广场右下脚的快速入门
sugar_disable_entry=0
# 私有部署下想为某些固定 path 返回固定文字内容，多个时使用!S|U|G|A|R!进行分割（针对百度/微信等要求在服务器指定path下放置指定文件的情况）
sugar_fix_path=
# 私有部署下固定 path 返回的固定文字内容，多个时使用!S|U|G|A|R!进行分割
sugar_fix_path_content=
# 自动分析相关配置，默认开启
sugar_enable_analyze=
# 是否禁用openAPI
sugar_disable_openapi=
# 是否禁用「组织管理」的「用户管理」中添加新用户，在单点登录的一些场景下，一般是不让组织管理员主动添加新用户的
sugar_disable_add_new_user=0
# 使用 HTTP 时可不配置本项、使用 HTTP 轮询则配置为 polling、使用 WebSocket 则配置为 websocket
# 启用 WebSocket 方式时，需确认服务所在网络环境支持 WebSocket 连接。在集群部署中使用轮询和 WebSocket 方式时，建议前置反向代理支持 sticky-session。
sugar_analyze_link_type=
# 波动分析相关配置，默认开启
sugar_enable_undulate=
# 是否允许使用「数据源启用备用地址」功能，默认不使用
sugar_enable_alternative_db=

# 历史版本相关配置，默认开启
sugar_enable_snapshot=
# 历史版本数量上限
sugar_snapshot_limit=50
# 历史版本锁定的数量上限
sugar_snapshot_locked_limit=10

# 如果要禁用报表和大屏的公开分享功能，此项配置为1
sugar_disable_public_share=
# 如果要禁用报表和大屏的加密分享功能，此项配置为1
sugar_disable_encrypted_share=

上面每项配置的具体含义详见下一章节运行配置说明

2、在env文件的目录下执行以下命令来启动Sugar BI

为了能让您方便的看到Sugar BI的日志，所以我们使用 Docker 的 Volume 将日志挂载到宿主机，新建文件夹~/sugar-log（Sugar BI的运行日志将存贮在这个目录下，当然目录名称您可以随意修改，同步替换下面命令中的即可）：

docker run --ulimit nofile=65100:65100 --shm-size=4g --restart unless-stopped -d -p 8000:8580 --name sugar -v ~/sugar-log:/sugar-app/log --env-file env sugarbi/sugar:6.0.1

有时您的 docker 网络环境可能配置有问题，会导致 MySQL 数据库连接不上，Sugar BI 还有另外一种方式 link 的方式启动。如果您的 MySQL 和 Sugar BI 运行在同一台机器上，并且 MySQL 是使用上面的 docker 方式启动的，您可以在env文件中将sugar_db_host填写为sugar-mysql，然后使用下面的命令来启动：

docker run --link sugar-mysql --ulimit nofile=65100:65100 --shm-size=4g --restart unless-stopped -d -p 8000:8580 --name sugar -v ~/sugar-log:/sugar-app/log --env-file env sugarbi/sugar:6.0.1

其中 8000 是本地端口，可以修改成自己想要的端口，比如 80，最后在浏览器上访问 http://部署的机器 ip:8000 如果是本机部署，即访问 http://127.0.0.1:8000 ，浏览器成功访问Sugar BI的首页之后，您还必须进行下面的「同步数据库结构」步骤。

同步数据库结构

前面已经描述了Sugar BI需要您提供一个 MySQL 数据库，这个数据库用来存储Sugar BI的系统数据。在您第一次安装Sugar BI、或者每次升级Sugar BI时，都需要进行数据库结构的升级和同步。升级数据库结构非常简单，只需要您使用浏览器访问 http://部署的机器 ip:8000/migration 如果是本机部署，即访问 http://127.0.0.1:8000/migration , 首次访问该页面大约需要数十秒，请不要刷新浏览器耐心等待一会，如果同步成功将会看到类似下面的结果：

之后如果您多次访问该页面，将会看到这样的成功提示：

如果运行失败，您会看到类似下面的错误提示：

安装出现问题，可以试试参看私有部署安装常见问题。

二、swarm 集群部署

Sugar BI本身是无状态的，支持多机部署来提升产品可用性，Sugar BI 可以部署到任意多台服务器上，然后使用类似 nginx 来做一个代理和负载均衡。

需要注意，多机模式除了需要自行搭建 MySQL 数据库，还需要再搭建一个 redis 服务，或者使用下面的方法直接内置进去。

Docker 多机集群模式，我们推荐使用 Docker 自带的 swarm，关于如何使用 swarm 请参考 Docker 官方文档。使用 swarm 部署Sugar BI分两步：

1、新建一个sugar-compose.yml文件，并用文本编辑器打开，复制以下的内容并填写相应部分：

下面已经将Sugar BI运行日志挂载到了宿主机的/sugar-log目录下，需要您手动在所有机器上新建该目录，当然您可以使用其他的目录来存储日志。

version: '3.6'

services:
  web:
    # 如果机器没有外网，请参考「直接在线下载」章节，将镜像下载至集群内的每个机器，并将这里的镜像地址配置为 tag 后的地址，如：sugarbi/sugar:6.0.1
    image: registry.baidubce.com/sugarbi/sugar:6.0.1
    deploy:
      mode: replicated
      # 部署的份数，可多份来提高系统的高可用性
      replicas: 3
      restart_policy:
        condition: on-failure
    ports:
      - '8000:8580'
    volumes:
      - '/sugar-log:/sugar-app/log'
      - type: tmpfs
        target: /dev/shm
        tmpfs:
          size: 4096000000
    networks:
      - overlay
    environment:
      sugar_can_connect_local_ip: 'true'

      # MySQL数据库相关
      sugar_db_username: root
      sugar_db_password: lovesugar123
      sugar_db_database: sugarbi
      sugar_db_host: 填写您安装MySQL机器的IP，即使是本机也不能使用localhost和127.0.0.1
      sugar_db_port: 3306

      # license相关
      sugar_company:
      sugar_license:

      # redis 配置，用于「数据缓存」或者「定时推送」「数据预警」等功能
      sugar_redis_host: internal_redis
      # sugar_redis_port: 如果自己搭建可能需要
      # sugar_redis_password: 如果自己搭建可能需要

      # 如果您搭建的 redis 是集群模式（Cluster）则需要将 sugar_redis_enable_cluster 设置为 1
      # 此时，host 和 port 可以配置多个，用英文逗号分割并且host和port的个数要相同并一一对应，
      # 如host配置为：1.1.1.1,2.2.2.2  port配置为：6379,6388
      # redis 的集群模式（Cluster），需要在 3.3.4 及以上版本中才支持
      sugar_redis_enable_cluster:

      # 如果您搭建的 redis 是哨兵模式（Sentinel）则需要将 sugar_redis_enable_sentinel 设置为 1
      # 并配置 sugar_redis_sentinel_name
      # 此时，host 和 port 可以配置多个，用英文逗号分割并且host和port的个数要相同并一一对应，
      # 如host配置为：1.1.1.1,2.2.2.2  port配置为：6379,6388
      # redis 的哨兵模式（Sentinel），需要在 3.5.1 及以上版本中才支持
      sugar_redis_enable_sentinel:
      # 哨兵的名称
      sugar_redis_sentinel_name:
      # 哨兵节点的密码（如果只给 Redis 主节点配置了密码，则只需要配置sugar_redis_password即可）
      sugar_redis_sentinel_password:

      # 登录形式，支持 demo、email、password、oauth、token、ldap
      # 如果是最初步的测试，可以使用demo方式，后面的其他登录方式的配置都可以不用填写
      sugar_login_type: demo

      # 登录类型为password时，配置为1即可开启密码复杂度判断（要求密码中至少需要包含大写字母、小写字母、数字、特殊符号中的三种，并且密码长度大于8；密码错误三次会锁定15分钟）
      sugar_password_secure_check:
      # 登录类型为password时，可以开启密码过期提醒，过期后要求用户必须修改密码
      # 格式为数字加日期标识符。天：d，月：m，季：q，年：y。如2个月可表示为2m，3天为3d
      sugar_password_expire:

      # email登录模式的配置，以及「定时推送」「数据预警」功能也需要这块的配置
      sugar_email_host:
      sugar_email_port:
      sugar_email_username:
      sugar_email_password:
      sugar_email_from:
      # 如果邮箱端口是465， 则需要去掉下面的#号
      # sugar_email_tls: true

      # oauth登录模式的配置
      sugar_oauth_authorize_url:
      sugar_oauth_token_url:
      sugar_oauth_client_id:
      sugar_oauth_client_secret:
      sugar_oauth_scope:
      sugar_oauth_info_url:
      sugar_oauth_data_username:
      sugar_oauth_data_useremail:
      sugar_oauth_email_suffix:
      sugar_oauth_logout_url:
      sugar_oauth_token_get:
      # 用户信息的唯一标识字段名，类似id
      sugar_user_id_field:

      # token登录模式的配置
      sugar_token_login_url:
      sugar_token_login_getTokenPath:
      sugar_token_login_getUserInfoURL:
      sugar_token_login_getUserInfoMethod:
      sugar_token_login_getUserInfoExtraParam:
      sugar_token_login_getUserInfoPostType:
      sugar_token_login_getUserInfoSendTokenPath: token
      sugar_token_login_goToURLPath:
      sugar_token_login_getUserInfoGetUserEmailPath:
      sugar_token_login_getUserInfoGetUserNamePath:
      sugar_token_login_email_suffix:
      sugar_token_login_sync_user_attr_path:
      sugar_token_logout_url:

      # ldap登录模式的配置
      sugar_ldap_login_url:
      sugar_ldap_login_base:
      sugar_ldap_login_key:
      sugar_ldap_login_admin:
      sugar_ldap_login_admin_password:
      sugar_ldap_email_suffix:
      sugar_ldap_password_type:

      # 企业微信、钉钉和飞书的集成
      sugar_companywx_oauth_appid:
      sugar_companywx_oauth_secret:
      sugar_companywx_oauth_agentid:
      sugar_dd_oauth_appid:
      sugar_dd_oauth_appkey:
      sugar_dd_oauth_secret:
      sugar_dd_oauth_agentid:
      sugar_lark_oauth_appid:
      sugar_lark_oauth_secret:
      sugar_lark_use_private:
      sugar_lark_origin:

      # 企业角色相关的配置
      sugar_enterprise_role_enable:
      sugar_enterprise_role_name:
      sugar_enterprise_role_enter_tip:
      sugar_enterprise_role_url:
      sugar_enterprise_role_syncUserMethod:
      sugar_enterprise_role_syncUserSendIDPath:
      sugar_enterprise_role_syncUserArrayPath:
      sugar_enterprise_role_syncUserEmailPath:
      sugar_enterprise_role_syncUserNamePath:
      sugar_enterprise_role_userEmailSuffix:

      # session强制过期天数（默认是7，表示登录账号后7天后强制失效。支持小数，如0.5表示12小时）
      sugar_session_maxAge_days:
      # 用户连续多少小时无操作后自动退出登录（默认是0，表示不受限制。支持小数，如0.5表示用户30分钟无操作后自动退出登录），5.1.0及之后版本才支持
      sugar_session_expire_no_operation:
      # SQL查询行数和大小以及格式化时间限制
      # 查询结果的最大行数限制，云上默认是2万行、私有部署中默认10万行
      sugar_query_result_max_rows:
      # 查询结果的大小限制(单位是MB)，云上默认是15MB、私有部署中默认30MB
      sugar_query_result_max_size:
      # 查询之后的数据格式化时间限制（单位是秒，即worker的计算时间限制），默认是40秒
      sugar_worker_timeout:

      # 是否HTTPS，只有您部署的sugar并且设置了HTTPS证书时才需要配置
      sugar_is_https:
      # 是否忽略SQL语句的安全检查（准许SQL中出现drop、delete等关键词），默认是都检查，填写true时将不检查，1.9.1版本之后才支持
      sugar_ignore_sql_security_check: '0'
      # 私有部署下是否不显示home首页，直接跳到login登录页面
      sugar_home_redirect_login: '0'
      # 私有部署下是否不显示文档页面，直接跳转到login登录页面
      sugar_docs_redirect_login: '0'
      # 私有部署下是否不展示顶部导航中的文档相关入口
      sugar_hide_docs_link: '0'
      # 私有部署下是否隐藏空间广场右侧的官方示例和公告栏
      sugar_hide_demo_and_news: '0'
      # 私有部署下是否隐藏空间广场右下脚的产品动态
      sugar_disable_product_news: '0'
      # 私有部署下是否隐藏空间广场右下脚的快速入门
      sugar_disable_entry: '0'
      # 私有部署下想为某些固定 path 返回固定文字内容，多个时使用!S|U|G|A|R!进行分割（针对百度/微信等要求在服务器指定path下放置指定文件的情况）
      sugar_fix_path:
      # 私有部署下固定 path 返回的固定文字内容，多个时使用!S|U|G|A|R!进行分割
      sugar_fix_path_content:
      # 自动分析相关配置，默认开启
      sugar_enable_analyze:
      # 是否禁用openAPI
      sugar_disable_openapi:
      # 是否禁用「组织管理」的「用户管理」中添加新用户，在单点登录的一些场景下，一般是不让组织管理员主动添加新用户的
      sugar_disable_add_new_user:
      # 使用 HTTP 时可不配置本项、使用 HTTP 轮询则配置为 polling、使用 WebSocket 则配置为 websocket
      # 启用 WebSocket 方式时，需确认服务所在网络环境支持 WebSocket 连接。在集群部署中使用轮询和 WebSocket 方式时，建议前置反向代理支持 sticky-session。
      sugar_analyze_link_type:
      # 波动分析相关配置，默认开启
      sugar_enable_undulate:
      # 是否允许使用「数据源启用备用地址」功能，默认不使用
      sugar_enable_alternative_db:

      # 历史版本相关配置，默认开启
      sugar_enable_snapshot:
      # 历史版本数量上限
      sugar_snapshot_limit: 50
      # 历史版本锁定的数量上限
      sugar_snapshot_locked_limit: 10

      # 如果要禁用报表和大屏的公开分享功能，此项配置为1
      sugar_disable_public_share:
      # 如果要禁用报表和大屏的加密分享功能，此项配置为1
      sugar_disable_encrypted_share:

  internal_redis:
    # 如果机器没有外网，请先将 redis 镜像拷贝至机器，并将这里的镜像地址配置为 tag 后的地址
    image: redis:5
    deploy:
      replicas: 1
    networks:
      - overlay

networks:
  overlay:

上面每项配置的具体含义详见下一章节运行配置说明

2、在sugar-compose.yml文件的目录下执行以下命令来启动Sugar BI

docker stack deploy --compose-file sugar-compose.yml sugar

最后在浏览器上访问 http://部署的机器-ip:8000 即可看到Sugar BI的运行页面。并且也需要执行上面的同步数据库结构

使用 swarm 时，我们建议使用管理工具：portainer.io

三、kubernetes 集群部署

Sugar BI本身是无状态的，支持使用 kubernetes 集群方式来进行部署。

需要注意，kubernetes 集群部署方式除了需要自行搭建 MySQL 数据库，还需要再提供一个 redis 服务。

1、新建一个sugar.yaml文件，并用文本编辑器打开，复制以下的内容并填写相应部分：

kind: Deployment
apiVersion: apps/v1
metadata:
  labels:
    app: sugar
  name: sugar-deployment
spec:
  selector:
    matchLabels:
      app: sugar
  replicas: 2 # 部署两份Pod实例，可根据实际情况修改
  template:
    metadata:
      labels:
        app: sugar
    spec:
      volumes:
        - name: sugar-log
          emptyDir: {} # 日志挂载的volume，可以根据实际情况修改
      containers:
        - name: sugar
          image: registry.baidubce.com/sugarbi/sugar:6.0.1 # sugar的镜像地址，根据实际情况修改
          ports:
            - containerPort: 8580
          volumeMounts:
            - name: sugar-log
              mountPath: /sugar-app/log
          livenessProbe:
            httpGet:
              path: /static/user.png
              port: 8580
            initialDelaySeconds: 30
            timeoutSeconds: 5
          env:
            - name: sugar_can_connect_local_ip
              value: '1'

            # MySQL数据库相关配置，必填
            - name: sugar_db_host
              value: 填写您安装MySQL机器的IP，即使是本机也不能使用localhost和127.0.0.1
            - name: sugar_db_port
              value: '3306'
            - name: sugar_db_database
              value: sugarbi
            - name: sugar_db_username
              value: root
            - name: sugar_db_password
              value: lovesugar123

            # license相关，必填
            - name: sugar_company
              value:
            - name: sugar_license
              value:

            # redis配置，必填，需要给sugar提供一个外部的redis服务，用于「数据缓存」或者「定时推送」「数据预警」等功能
            - name: sugar_redis_host
              value:
            - name: sugar_redis_port
              value:
            - name: sugar_redis_password # 根据实际情况，一般不需要
              value:
            # 如果您搭建的 redis 是集群模式（Cluster）则需要将 sugar_redis_enable_cluster 设置为 1
            # 此时，host 和 port 可以配置多个，用英文逗号分割并且host和port的个数要相同并一一对应，
            # 如host配置为：1.1.1.1,2.2.2.2  port配置为：6379,6388
            # redis 的集群模式（Cluster），需要在 3.3.4 及以上版本中才支持
            - name: sugar_redis_enable_cluster # 根据实际情况，一般不需要
              value:

            # 如果您搭建的 redis 是哨兵模式（Sentinel）则需要将 sugar_redis_enable_sentinel 设置为 1
            # 并配置 sugar_redis_sentinel_name
            # 此时，host 和 port 可以配置多个，用英文逗号分割并且host和port的个数要相同并一一对应，
            # 如host配置为：1.1.1.1,2.2.2.2  port配置为：6379,6388
            # redis 的哨兵模式（Sentinel），需要在 3.5.1 及以上版本中才支持
            - name: sugar_redis_enable_sentinel # 根据实际情况，一般不需要
              value:
            # 哨兵的名称
            - name: sugar_redis_sentinel_name # 根据实际情况，一般不需要
              value:
            # 哨兵节点的密码（如果只给 Redis 主节点配置了密码，则只需要配置sugar_redis_password即可）
            - name: sugar_redis_sentinel_password # 根据实际情况，一般不需要
              value:

            # 登录形式，必填，支持 demo、email、password、oauth、token、ldap
            - name: sugar_login_type
              value: demo

            # 登录类型为password时，配置为1即可开启密码复杂度判断（要求密码中至少需要包含大写字母、小写字母、数字、特殊符号中的三种，并且密码长度大于8；密码错误三次会锁定15分钟）
            - name: sugar_password_secure_check
              value:
            # 登录类型为password时，可以开启密码过期提醒，过期后要求用户必须修改密码
            # 格式为数字加日期标识符。天：d，月：m，季：q，年：y。如2个月可表示为2m，3天为3d
            - name: sugar_password_expire
              value:

            # email登录模式的配置，以及「定时推送」「数据预警」功能也需要这块的配置
            - name: sugar_email_host
              value:
            - name: sugar_email_port
              value:
            - name: sugar_email_username
              value:
            - name: sugar_email_password
              value:
            - name: sugar_email_from
              value:
            - name: sugar_email_tls # 如果邮箱端口是465，则需要配置为true
              value:

            # oauth登录模式的配置
            - name: sugar_oauth_authorize_url
              value:
            - name: sugar_oauth_token_url
              value:
            - name: sugar_oauth_client_id
              value:
            - name: sugar_oauth_client_secret
              value:
            - name: sugar_oauth_scope
              value:
            - name: sugar_oauth_info_url
              value:
            - name: sugar_oauth_data_username
              value:
            - name: sugar_oauth_data_useremail
              value:
            - name: sugar_oauth_email_suffix
              value:
            - name: sugar_oauth_logout_url
              value:
            - name: sugar_oauth_token_get
              value:
            # 用户信息的唯一标识字段名，类似id
            - name: sugar_user_id_field
              value:

            # token登录模式的配置
            - name: sugar_token_login_url
              value:
            - name: sugar_token_login_getTokenPath
              value:
            - name: sugar_token_login_getUserInfoURL
              value:
            - name: sugar_token_login_getUserInfoMethod
              value:
            - name: sugar_token_login_getUserInfoExtraParam
              value:
            - name: sugar_token_login_getUserInfoPostType
              value:
            - name: sugar_token_login_getUserInfoSendTokenPath
              value: token
            - name: sugar_token_login_goToURLPath
              value:
            - name: sugar_token_login_getUserInfoGetUserEmailPath
              value:
            - name: sugar_token_login_getUserInfoGetUserNamePath
              value:
            - name: sugar_token_login_email_suffix
              value:
            - name: sugar_token_login_sync_user_attr_path
              value:
            - name: sugar_token_logout_url
              value:

            # ldap登录模式的配置
            - name: sugar_ldap_login_url
              value:
            - name: sugar_ldap_login_base
              value:
            - name: sugar_ldap_login_key
              value:
            - name: sugar_ldap_login_admin
              value:
            - name: sugar_ldap_login_admin_password
              value:
            - name: sugar_ldap_email_suffix
              value:
            - name: sugar_ldap_password_type
              value:

            # 企业微信、钉钉和飞书集成
            - name: sugar_companywx_oauth_appid
              value:
            - name: sugar_companywx_oauth_secret
              value:
            - name: sugar_companywx_oauth_agentid
              value:
            - name: sugar_dd_oauth_appkey
              value:
            - name: sugar_dd_oauth_appid
              value:
            - name: sugar_dd_oauth_secret
              value:
            - name: sugar_dd_oauth_agentid
              value:
            - name: sugar_lark_oauth_appid
              value:
            - name: sugar_lark_oauth_secret
              value:
            - name: sugar_lark_use_private
              value:
            - name: sugar_lark_origin
              value:

            # 企业角色相关的配置
            - name: sugar_enterprise_role_enable
              value:
            - name: sugar_enterprise_role_name
              value:
            - name: sugar_enterprise_role_enter_tip
              value:
            - name: sugar_enterprise_role_url
              value:
            - name: sugar_enterprise_role_syncUserMethod
              value:
            - name: sugar_enterprise_role_syncUserSendIDPath
              value:
            - name: sugar_enterprise_role_syncUserArrayPath
              value:
            - name: sugar_enterprise_role_syncUserEmailPath
              value:
            - name: sugar_enterprise_role_syncUserNamePath
              value:
            - name: sugar_enterprise_role_userEmailSuffix
              value:

            # session强制过期天数（默认是7，表示登录账号后7天后强制失效。支持小数，如0.5表示12小时）
            - name: sugar_session_maxAge_days
              value:
            # 用户连续多少小时无操作后自动退出登录（默认是0，表示不受限制。支持小数，如0.5表示用户30分钟无操作后自动退出登录），5.1.0及之后版本才支持
            - name: sugar_session_expire_no_operation
              value:
            # SQL查询行数和大小以及格式化时间限制
            # 查询结果的最大行数限制，云上默认是2万行、私有部署中默认10万行
            - name: sugar_query_result_max_rows
              value:
            # 查询结果的大小限制(单位是MB)，云上默认是15MB、私有部署中默认30MB
            - name: sugar_query_result_max_size
              value:
            # 查询之后的数据格式化时间限制（单位是秒，即worker的计算时间限制），默认是40秒
            - name: sugar_worker_timeout
              value:

            # 是否HTTPS，只有您部署的sugar并且设置了HTTPS证书时才需要配置
            - name: sugar_is_https
              value:
            # 是否忽略SQL语句的安全检查（准许SQL中出现drop、delete等关键词），默认是都检查，填写true时将不检查，1.9.1版本之后才支持
            - name: sugar_ignore_sql_security_check
              value: '0'
            # 私有部署下是否不显示home首页，直接跳到login登录页面
            - name: sugar_home_redirect_login
              value: '0'
            # 私有部署下是否不显示文档页面，直接跳转到login登录页面
            - name: sugar_docs_redirect_login
              value: '0'
            # 私有部署下是否不展示顶部导航中的文档相关入口
            - name: sugar_hide_docs_link
              value: '0'
            # 私有部署下是否隐藏空间广场右侧的官方示例和公告栏
            - name: sugar_hide_demo_and_news
              value: '0'
            # 私有部署下是否隐藏空间广场右下角的产品动态
            - name: sugar_disable_product_news
              value: '0'
            # 私有部署下是否隐藏空间广场右下角的快速入门
            - name: sugar_disable_entry
              value: '0'
            # 私有部署下想为某些固定 path 返回固定文字内容，多个时使用!S|U|G|A|R!进行分割（针对百度/微信等要求在服务器指定path下放置指定文件的情况）
            - name: sugar_fix_path
              value:
            # 私有部署下固定 path 返回的固定文字内容，多个时使用!S|U|G|A|R!进行分割
            - name: sugar_fix_path_content
              value:
            # 自动分析相关配置，默认开启
            - name: sugar_enable_analyze
              value:
            # 是否禁用openAPI
            - name: sugar_disable_openapi
              value:
            # 是否禁用「组织管理」的「用户管理」中添加新用户，在单点登录的一些场景下，一般是不让组织管理员主动添加新用户的
            - name: sugar_disable_add_new_user
              value:
            # 使用 HTTP 时可不配置本项、使用 HTTP 轮询则配置为 polling、使用 WebSocket 则配置为 websocket
            # 启用 WebSocket 方式时，需确认服务所在网络环境支持 WebSocket 连接。在集群部署中使用轮询和 WebSocket 方式时，建议前置反向代理支持 sticky-session。
            - name: sugar_analyze_link_type
              value:
            # 波动分析相关配置，默认开启
            - name: sugar_enable_undulate
              value:
            # 是否允许使用「数据源启用备用地址」功能，默认不使用
            - name: sugar_enable_alternative_db
              value:

            # 历史版本相关配置，默认开启
            - name: sugar_enable_snapshot
              value:
            # 历史版本数量上限
            - name: sugar_snapshot_limit
              value: '50'
            # 历史版本锁定的数量上限
            - name: sugar_snapshot_locked_limit
              value: '10'

            # 如果要禁用报表和大屏的公开分享功能，此项配置为1
            - name: sugar_disable_public_share
            - value:
            # 如果要禁用报表和大屏的加密分享功能，此项配置为1
            - name: sugar_disable_encrypted_share
            - value:
---
kind: Service
apiVersion: v1
metadata:
  labels:
    app: sugar
  name: sugar-service
spec:
  ports:
    - port: 8580
      targetPort: 8580
      nodePort: 32580
  type: NodePort # 这块使用NodePort方式，并且配置了nodePort为32580端口，可以根据实际情况修改
  selector:
    app: sugar

上面每项配置的具体含义详见下一章节运行配置说明

2、在sugar.yaml文件的目录下执行以下命令来启动Sugar BI

kubectl apply -f sugar.yaml

最后在浏览器上访问 http://部署的机器-ip:32580 即可看到Sugar BI的运行页面。并且也需要执行上面的同步数据库结构

运行配置说明

无论是 Docker 单机还是 Docker 集群模式运行Sugar BI，基本都是配置一些 env 环境变量，下面对这些环境变量配置进行说明：

sugar_can_connect_local_ip：用来控制Sugar BI的数据源中是否能够连接局域网的 ip，一般私有部署情况下，配置为true即可，配置false可以让Sugar BI只能连接公网域名和 ip
MySQL 数据库相关，这块是用来配置Sugar BI所依赖的 MySQL 数据库，详见Sugar BI 所需的软件环境
- sugar_db_username: 用户名
- sugar_db_password: 密码
- sugar_db_database: 数据库名称
- sugar_db_host: 填写您安装 MySQL 机器的 IP，即使是本机也不能使用 localhost 和 127.0.0.1
- sugar_db_port: 端口号
License 配置，详见申请试用 License
- sugar_company: 组织代码
- sugar_license: 详细的 License 内容（长串字符）

登录账号相关配置说明

sugar_login_type: 登录账号的类型，支持 demo、password、email、oauth、token、ldap，下面对这六种登录形式分别说明：

1、demo

sugar_login_type配置为demo表示测试环境，登录时必须使用企业邮箱，但是验证码不会通过邮件发送，而是直接展示在页面上，用户直接复制页面上展示的验证码即可登录，如下图：

2、password

sugar_login_type配置为password表示使用Sugar BI平台自带的账号体系，用户通过用户名、密码来登录Sugar BI，账号可由组织的管理员统一录入。

如果您之前已经使用其他的登录方式进行了部署并登录过了Sugar BI私有版（例如：之前使用demo方式部署并且登录使用了，即您私有部署的Sugar BI中已经有账户了），那么直接使用之前登录的企业邮箱以及默认密码sugar12345即可直接登录。如果是初次部署，之前还没有任何用户登录过Sugar BI私有版，在登录之前我们需要创建一个默认账户（此账户将会成为组织的管理员），使用浏览器访问 http://部署的机器-ip:8000/openapi/createUser?name=XXX 即可创建一个默认的组织管理员账户，其中的XXX需要按照实际情况替换成您的企业邮箱如zhangsan@baidu.com。

创建完默认账户后，在登录时直接使用默认密码sugar12345即可登录：

默认的组织管理员账户登录之后，可以在「组织管理」的「用户管理」中来添加其他的用户（添加的其他用户，登录密码同样是默认的sugar12345）：

所有的用户在登录之后，可点击页面顶部的「个人中心」，然后进入「个人信息管理」来修改登录密码：

如果有用户忘记了密码，组织的管理员也可以将用户的密码重置为sugar12345，可以在「组织管理」的「用户管理」中进行密码重置操作：

如果配置了密码复杂度判断, 那么在设置密码时就会进行密码强度判断，并且密码需要包含大写字母、小写字母、数字、特殊符号的任意三种。

除此之外，还可以设置密码的有效期，格式为数字加上日期标识符。日期标识符包括：d, m, q, y, 其中 d 表示天，m 表示月，q 表示季，y 表示年。如 2 个月可表示为 2m，3 天为 3d。

当密码还有不到十天就要过期时，登录时会给出尽快更改密码的提示。

如果密码已经过期，那么您将无法进入 Sugar BI，必须修改密码过后才能继续。

3、email

sugar_login_type配置为email表示使用邮箱发送验证码的方式来登录。这种方式要求您的组织有企业邮箱服务，需要您给Sugar BI平台配置一个企业邮箱账号，该邮箱账号用来给您的组织员工发送登录验证码邮件，所以需要您填写配置文件中的这些配置：

sugar_email_host: 您的企业邮箱服务器的域名或 ip
sugar_email_port: 企业邮箱服务器的端口号
sugar_email_username: 给Sugar BI使用的邮箱账户用户名，如 zhangsan
sugar_email_password: 给Sugar BI使用的邮箱账户密码
sugar_email_from: Sugar BI发送邮件时的发件人邮箱，一般和邮箱用户名强相关，如 zhangsan@baidu.com
sugar_email_tls: 如果这个端口是 tls 的（比如 465 端口很可能是）则需要加这个配置，值是 true，如果不是就不需要加

4、oauth

sugar_login_type配置为oauth，Sugar BI支持使用 OAuth 2.0 的方式对接企业内部账号的单点登录系统，需要您对配置文件中的以下配置进行填写：

sugar_oauth_authorize_url: Sugar BI向您的 Oauth 服务端申请认证的 URI，如 https://your-authorization-server-host/auth
sugar_oauth_token_get: 默认情况下请求 sugar_oauth_authorize_url 的方式是 POST，如果需要使用 GET 方式，将该配置设置为1即可
sugar_oauth_token_url: Sugar BI向您的 Oauth 服务端获取 Access Token 的 URI，如 https://your-authorization-server-host/token
sugar_oauth_client_id: 您的 Oauth 服务端给Sugar BI分配的 client_id
sugar_oauth_client_secret: 您的 Oauth 服务端给Sugar BI分配的 client_secret
sugar_oauth_scope: 授权的范围 scope，依赖您的 Oauth 服务端，目前必填
sugar_oauth_info_url: 通过认证后，Sugar BI向您的 Oauth 服务端获取当前登录用户详细信息的 API，如 https://your-authorization-server-host/userinfo
sugar_oauth_data_username: 用户详细信息的 API 返回数据中用来表示用户名的字段名，如 name
sugar_oauth_data_useremail: 用户详细信息的 API 返回数据中用来表示用户邮箱的字段名，如 email
sugar_oauth_email_suffix: 如果用户详细信息的 API 返回数据中没有邮箱字段，那么我们将默认使用用户名@${sugar_oauth_email_suffix} 方式来拼凑成邮箱，所以需要您配置您组织的企业邮箱后缀，如 baidu.com
sugar_oauth_logout_url: 当用户在Sugar BI上 logout 登出之后，跳转到 OAuth 服务端的登出 url，如果不配置将会默认跳转到Sugar BI的首页
sugar_user_id_field: 用户信息中的唯一标识字段名，类似 id，具体用法参考SQL 中嵌入用户信息

Sugar BI使用的是 OAuth 2.0 的授权码模式，可参考这里了解 Oauth 2.0 的授权码模式。

上面的 OAuth 2.0 的配置，前五项都是标准的 Oauth 配置，有些 OAuth 的 server 端需要明确配置应用的redirect_uri（即登录回调 url），Sugar BI的redirect_uri是 http://部署 Sugar BI 的机器-ip:8000/login/oauthCallback

上面sugar_oauth_info_url以及后面的三行是用来配置Sugar BI通过您的 Oauth 服务端认证后，获取当前登录用户的详细信息的 API 以及该 API 返回的数据字段信息。访问该 API 时，我们在请求的 header 头文件中加上了Authorization: Bearer ${access_token}这样的 access_token 信息，并且在 API 的参数中也加上了，如：https://your-authorization-server-host/userinfo?access_token=${access_token} 该 API 的返回必须是 JSON 格式数据，对于最后三项配置我们根据返回 JSON 的不同格式来做简单的示例：

返回 JSON 如：{userid:10, usermail: 'zhangsan@baidu.com', username: 'zhangsan'} 那么最后几项配置为：
- sugar_oauth_data_username: username
- sugar_oauth_data_useremail: usermail
- sugar_oauth_email_suffix:
- sugar_user_id_field: userid

此时返回的 JSON 数据中用户的邮箱，所以不需要配置sugar_oauth_email_suffix

返回 JSON 如：{name: 'zhangsan'} 那么最后三项配置为：
- sugar_oauth_data_username: name
- sugar_oauth_data_useremail:
- sugar_oauth_email_suffix: baidu.com

此时返回的 JSON 数据中没有用户的邮箱，所以不需要配置sugar_oauth_data_useremail，但是必须要配置sugar_oauth_email_suffix（注意并不是固定的 baidu.com，需要根据实际情况替换成您的企业邮箱后缀）

返回 JSON 如：{email: 'zhangsan@baidu.com'} 那么最后三项配置为：
- sugar_oauth_data_username:
- sugar_oauth_data_useremail: email
- sugar_oauth_email_suffix:

此时返回的 JSON 数据中只有用户的邮箱，只需要配置邮箱字段名sugar_oauth_data_useremail即可

5、token

sugar_login_type配置为token，Sugar BI 的 token 登录方式是一种便于业务方对接的登录方式，登录流程如下：

a、Sugar BI 检测到用户未登录，跳转到业务方指定页面 URL1 进行登录操作
b、用户登录成功后，业务方带上一个 token 回调 Sugar BI 的指定 URL2：http://部署 Sugar BI 的机器 ip:8000/login/tokenLoginCallback?token=${token}
c、我们会使用这个 token 调用业务方的 URL3 获取登录用户的信息并在 Sugar BI 中进行登录

需要您对配置文件中的以下配置进行填写：

sugar_login_type: token
sugar_token_login_url: 未登录时要跳转到的业务方登录页 url，对应流程中的 URL1
sugar_token_login_getTokenPath: 用户在登录页登录后，业务方访问 Sugar BI 回调 URL2 时，携带 token 信息的字段的名称，默认为 token ，如果是其他名称可以在这里配置
sugar_token_login_goToURLPath: 用户在登录页登录后，业务方访问 Sugar BI 回调 URL2 时，可以指定一个地址字段，在用户完成登录过程后会跳转到这个地址。地址字段的名称可以使用这个环境变量配置，默认为 url 。一般场景不需要配置这个环境变量。
sugar_token_login_getUserInfoURL: 业务方提供的使用 token 获取用户信息的接口地址，对应流程中 URL3
sugar_token_login_getUserInfoMethod: 访问 URL3 的 http 方法，默认为 post，请求体为 json 格式；如果是 get 可以配置这里为：get
sugar_token_login_getUserInfoExtraParam: post 方式访问 URL3 时可以附加额外的参数，格式如：abc=haha&def=heihei，如果没有额外参数，这个可不填
sugar_token_login_getUserInfoPostType: post 方式访问 URL3 时发送数据的方式，默认是 application/json，如果要使用 application/x-www-form-urlencoded 方式，本参数请设置为 x 即可
sugar_token_login_getUserInfoSendTokenPath: 访问 URL3 时，token 信息在请求中放置的位置。如果使用 POST 方法，配置 token 的放置路径，路径的起点为请求的 body，格式如：data.token；如果是 get 方法，直接配置在 url params 中的字段名即可。
sugar_token_login_getUserInfoGetUserEmailPath: 在获取到 URL3 的返回信息后，用户邮箱字段在返回体中的路径，路径格式例如：data.userEmail。这个字段用来在 Sugar BI 中唯一标识一个用户，最好是企业内的用户邮箱，如果没有，可以使用户名等字段，保证唯一即可
sugar_token_login_email_suffix: 如果业务方系统中没有使用用户邮箱作为用户标识，我们会在用户标识后添加一个 @example.com 作为邮箱后缀，您也可以通过这个环境变量自己配置这个邮箱后缀
sugar_token_login_getUserInfoGetUserNamePath: 在获取到 URL3 的返回信息后，用户名称字段在返回体中的路径，是用户真正看到的名字，路径格式例如：data.realName
sugar_token_logout_url: 如果您需要在 Sugar BI 登出的同时登出您的单点登录系统，可以配置一个登出的跳转 url，如：https://www.xxx.com/logout。 Sugar BI 会在登出后重定向到这个 URL。还有一种场景是用户在单点登录系统中登出了，需要也能自动登出 Sugar BI ，我们开放了一个 API，您在用户登出时在后端使用 Get 方式调用我们的这个 API 即可让用户也登出 Sugar BI ，API 地址为：http://部署 Sugar BI 的机器 ip:8000/login/tokenLogout?token=${token} ，这个token就是用户登录时的 URL2 中 token，因此如果您要使用这个登出功能，token 必须是唯一确定一个会话（这个 API 方式登出，在 3.4.1 版本才开始支持）。
sugar_user_id_field: 用户信息中的唯一标识字段名，类似 id，具体用法参考SQL 中嵌入用户信息

我们还支持在 Token 登录时同步用户的用户属性，用户属性用于对数据进行「行级别权限管理」。用户可以在自己的平台上对用户属性进行管理，在用户进行登录操作时，会将该用户的属性同步到Sugar BI。

如果要进行用户属性同步，则需要在 URL3 的返回中同时返回该用户的属性数据，包含属性名称及取值，并配置环境变量告诉Sugar BI属性数据在返回体中的路径：

sugar_token_login_sync_user_attr_path: 在 URL3 的返回体中，属性数据在返回体中的路径，路径格式例如：data.userAttr

属性数据为一个 key-value 对象，key 和 value 都是字符串类型，key 代表属性名称，value 代表属性取值。返回体示例如下：

{
  data: {
    userAttr: {
      '地区': '华北',
      '性别': '男'
    },
    ...
  }
}

6、ldap

sugar_login_type配置为ldap表示使用 Ldap 统一账号密码管理的方式来登录。这种方式要求您的企业内部部署了 Ldap 服务，并使用 Ldap 协议来进行企业内部的账号密码统一认证管理，采用这种方式，您可以直接使用 Ldap 域账号和密码来登录 Sugar BI ，即单点登录。需要您填写配置文件中的这些配置（Sugar BI 的 4.3.1 及之后版本才支持）：

sugar_ldap_login_url: 您的 ldap 服务器入口，由域名或 IP 与端口号组成，一般端口号默认为 389。如：ldap://127.0.0.1:389
sugar_ldap_login_base: 您的 ldap 域名，如：dc=baidu,dc=com
sugar_ldap_login_key: 用户登录属性名，一般为 cn 或 uid
sugar_ldap_login_admin: 管理员名称，对 Ldap 服务器具有检索权限的用户即可，如：admin
sugar_ldap_login_admin_password: 管理员密码
sugar_ldap_email_suffix: 如果您的 Ldap 中用户邮箱属性 mail 不全或不唯一，您可以配置一个邮箱后缀如：@baidu.com，Sugar BI 将自动将您的用户登录属性名以及该邮箱后缀拼凑成邮箱如：zhangsan@baidu.com；也可不配置该变量，若不配置此变量， Sugar BI 将读取您的 Ldap 目录中的用户邮箱属性 mail 作为用户的邮箱在用户登录时自动添加到 Sugar BI 中，这时，应注意您的 Ldap 目录中的用户邮箱属性 mail 应该保持唯一性。
sugar_ldap_password_type: 如果您在 Ldap 账号管理工具中进行用户录入时，提前对用户密码进行了自加密，并以 Ldap 默认的存储方式（即 plainText 类型）存储，这时，需要对此变量进行配置，在这里指定密码类型，此变量支持的取值有六个：MD5、SHA、SHA256、SHA384、SHA512、plainText，其中 plainText 为不加密的明文密码，例如：123456，其余为使用 MD5 或哈希算法加密后的密文密码，例如：fEqNCco3Yq9h5ZUglD3CZJT4lBs=

ldap 中创建完账户后，在登录时直接使用登录名（一般为 uid 或 cn）和密码即可登录：

日志说明以及自动清理

如上面的部署示例配置中，无论是单机 docker 部署、还是 swarm 集群部署，我们都将 Sugar BI 的日志挂载到了宿主机的某个目录下，在该目录下会有两个子目录：

access：该目录下存储了所有访问的 access 日志，日志文件按照小时进行切分，例如 2021 年 01 月 01 日 08 时的 access 日志文件为：access.log.2021010108
sugar：该目录下存储了所有的 Sugar BI 业务日志，包括正常的系统日志以及异常时的错误日志，日志文件也是按照小时进行切分，正常的系统日志文件名如：sugar.log.2021010108，异常时的错误日志文件名如：sugar.log.wf.2021010108，当您的私有部署中遇到问题时，可以尝试在错误日志中查看详细的日志记录。

从 3.0.1 版本及之后， Sugar BI 中支持了日志文件的自动清理，默认情况下，系统将保留最近90天的日志文件，其余日志文件将会被自动清理。当然，你也可以配置日志文件保留的天数，可以在env文件中添加以下配置（下面的配置表示日志文件保留120天，如果你不想要自动清理日志文件，想要永久保留日志文件，将下面的配置填写为0即可。同理，swarm、kubernetes 部署方式也是同样的添加相应的环境变量配置即可）：

sugar_log_lifetime_day=120

Nginx 代理和 HTTPS 设置

如果您需要对私有部署的Sugar BI使用域名访问并且使用Nginx 来做转发代理，需要在 Nginx 代理配置中加上proxy_set_header Host $http_host;，这样能把域名信息透传到Sugar BI中以保证登录回调等各种功能运行正常。

如果您需要使用HTTPS来访问Sugar BI，你必须要使用上面描述的 Nginx 代理方式，需要您自己在 Nginx 层来配置 HTTPS 的证书（可以自行百度搜索配置方式），并且需要对Sugar BI运行配置env文件中sugar_is_https进行填写，填写为：sugar_is_https=1。（swarm 运行方式下即对sugar-compose.yml文件中填写sugar_is_https: 1，kubernetes 部署方式也是同样的添加相应的环境变量配置即可）

开启定时推送、数据预警功能

如果私有部署中您需要使用定时推送、数据预警功能，需要配置上面 env 中的 sugar_email_host 、sugar_redis_host 等（同理，swarm、kubernetes 部署方式也是同样的添加相应的环境变量配置即可），下面详细说明：

1、redis 相关配置，如果您私有部署只是单机运行（即只运行一个 sugar 的实例），sugar 已经内置，就不需要配置 redis 相关内容；如果是集群方式，需要您自己搭建 redis（2.6 版本以上，可以使用类似上面 mysql 的 docker 方式来启动一个 redis），然后需要您在 env 配置中填写 sugar_redis_host(redis 的 host)、sugar_redis_port(redis 的端口，默认是 6379)、sugar_redis_password(redis 的密码，只有 redis 中设置了才需要填写，否则可以不填)。

如果您搭建的 redis 是集群模式（Cluster）则需要将 sugar_redis_enable_cluster 设置为 1，此时 host 和 port 可以配置多个，用英文逗号分割。

如果您搭建的 redis 是哨兵模式（Sentinel）模式则需要将 sugar_redis_enable_sentinel 设置为 1，并配置 sugar_redis_sentinel_name，此时 host 和 port 可以配置多个，用英文逗号分割。如果为哨兵节点配置了密码，则需要配置sugar_redis_sentinel_password（如果只给 Redis 主节点配置了密码，则只需要配置sugar_redis_password即可）

2、发送的邮箱： Sugar BI中已经内置了邮件发送器，但是，如果您需要固定发件人邮箱（如：sugar@yourCompany.com)，那就需要您在 env 配置中填写 sugar_email_host、sugar_email_port、 sugar_email_username、sugar_email_password、sugar_email_from 邮箱相关的设置。（注意：目前很多邮箱服务器都会将系统内置的邮件发送器的邮件当成垃圾邮件，因此强烈建议您进行以上的邮箱相关配置）。

开启 Excel/CSV 文件上传功能

如果要开启 Excel/CSV 文件上传功能（部署的 Sugar BI 版本需要是 1.9.5 及以上），需要在上面的 env 配置中增加以下配置（同理，swarm、kubernetes 部署方式也是同样的添加相应的环境变量配置即可）：

sugar_enable_mpp=1
sugar_mpp_use_cluster=m1
sugar_mpp_hashids=sugar
sugar_mpp_cluster_m1_type=mysql
sugar_mpp_cluster_m1_host=数据库地址
sugar_mpp_cluster_m1_port=数据库端口
sugar_mpp_cluster_m1_user=数据库用户名，最好是root账户，需要有创建账户、创建数据库、创建数据表的权限
sugar_mpp_cluster_m1_password=数据库密码

对于数据填报功能，如果需要使用内置数据源，也需要开启 Excel/CSV 文件上传功能。

Excel 上传的实现原理是将文件导入数据库中，后续就能类似普通的数据源一样进行处理，您需要修改上面尖括号中的内容为您自己启动的服务器，目前数据库类型只支持 mysql，可以使用 MySQL 或 TiDB。

这个功能依赖 MySQL 的 LOAD DATA LOCAL INFILE，所以如果有类似 Error Code 1148: The used command is not allowed with this MYSQL version 的报错，请在 MySQL 配置里开启 local_infile

开启企业角色功能

在私有部署版本中，可以通过外部 API 自动同步角色中的用户，可以将外部系统中管理的各种「用户组」中的用户同步到 Sugar BI 的角色中，从而实现更方便的角色和权限管理。使用方式可参照角色管理。环境变量的配置说明如下：

  # 开启企业角色功能
  sugar_enterprise_role_enable=1

「用户组」的名称和输入提示也可以通过环境变量配置，这里以「邮件组」为例，在您的系统中可能是「用户组」等：

  # 企业角色名称
  sugar_enterprise_role_name=邮件组
  # 企业角色标识输入提示
  sugar_enterprise_role_enter_tip=完整邮件组

同步需要您的用户系统开放一个 API 供 Sugar BI 拉取用户列表，这个 API 接收一个「用户组标识」，返回相应用户组下的用户信息，需要配置如下环境变量：

  # API 地址
  sugar_enterprise_role_url=
  # 访问 API 的 http 方法，默认为 get ；可以配置这里为 post，请求体为 json 格式；
  sugar_enterprise_role_syncUserMethod=
  # 访问 API 时，「用户组标识」信息在请求中放置的位置。如果是 get 方法，直接配置在 url params 中的字段名即可；如果使用 POST 方法，配置 「用户组标识」 的放置路径，路径的起点为请求的 body，格式如：data.key；
  sugar_enterprise_role_syncUserSendIDPath=

  # 在获取到 API 的返回信息后，用户信息数组在 API 返回体中的路径，如直接返回数组可不配置
  sugar_enterprise_role_syncUserArrayPath=
  # 用户邮箱字段在每项用户信息中的路径，路径格式例如：data.userEmail。这个字段用来在 Sugar BI 中唯一标识一个用户，最好是企业内的用户邮箱，如果没有，可以使用户名等字段，保证唯一即可
  sugar_enterprise_role_syncUserEmailPath=
  # 如果您的用户系统中没有使用用户邮箱作为用户标识，我们会在用户标识后添加一个 @example.com 作为邮箱后缀，您也可以通过这个环境变量自己配置这个邮箱后缀
  sugar_enterprise_role_userEmailSuffix=
  # 用户名称字段在返回体中的路径，是用户真正看到的名字，路径格式例如：data.realName
  sugar_enterprise_role_syncUserNamePath=

假如您的系统开放的 API 是：https://sugar.bce.baidu.com/openapi/test/getUsers?key=sugar@baidu.com

API 返回如：

{
  "status": 0,
  "msg": "",
  "data": [
    {
      "userEmail": "sugar1",
      "userName":"sugar11"
    },
    {
      "userEmail": "sugar2",
      "userName": "sugar21"
    }
  ]
}

则环境变配置如下：

  sugar_enterprise_role_url=http://{sugarHost}/openapi/test/getUsers
  sugar_enterprise_role_syncUserMethod=
  sugar_enterprise_role_syncUserSendIDPath=key

  sugar_enterprise_role_syncUserArrayPath=data
  sugar_enterprise_role_syncUserEmailPath=userEmail
  sugar_enterprise_role_syncUserNamePath=userName
  sugar_enterprise_role_userEmailSuffix=@baidusugar.com

开启自助取数功能

在私有部署的 Sugar BI 中，如果要使用自助取数功能，需要部署取数的存储系统，并进行相应的配置，详见开启自助取数功能。

开启跨源查询功能

在私有部署的 Sugar BI 中，如果要使用跨源查询功能，需要部署跨源查询引擎集群，并进行相应的配置，详见开启跨源查询功能。

开启自定义消息通知

在私有部署的 Sugar BI 中，Sugar BI的定时推送和数据预警，消息通知方式除了邮箱、群机器人和 APP 通知外，还支持一种额外的自定义通知方式，用于企业内的其他通知方式，详见开启自定义消息通知（部署的 Sugar BI 版本需要是 5.1.0 及以上）。

外部依赖模块部署验证

在 Sugar BI 运行起来后，您可以进入「组织管理」->「外部模块部署验证」来验证 Sugar BI 的外部依赖是否部署成功。目前可验证的模块为邮件、Redis、Excel/CSV 上传、自助取数、跨源查询，部署成功时页面如下：

有模块报错时可根据报错信息参看各模块的部署文档。

自定义产品 Logo

你可以自定义 Sugar BI 的产品 Logo，在env中增加配置即可（2.2.3 版本及以上才支持。同理，swarm、kubernetes 部署方式也是同样的添加相应的环境变量配置即可），如：

sugar_logo=填写Logo的网络图片地址，如：https://www.baidu.com/favicon.ico

自定义 JDBC 驱动

如果您使用的数据库不在我们支持的列表中，但有对应的 JDBC 驱动，可以通过如下方式来添加这个：

首先创建某个目录，比如 /home/work/jdbc/libs，将 jar 文件放到这个目录里
在 docker 镜像启动时用 -v 将这个目录映射为 /sugar-app/javakit/libs，参考如下写法

docker run --link sugar-mysql --ulimit nofile=65100:65100 --shm-size=4g --restart unless-stopped -d -p 8000:8580 --name sugar -v /home/work/jdbc/libs:/sugar-app/javakit/libs -v ~/sugar-log:/sugar-app/log --env-file env registry.baidubce.com/sugarbi/sugar:6.0.1

然后在创建数据源时选择「JDBC 通用数据库」。

需要注意自定义 JDBC 驱动的数据库在「测试连接」时有可能报错（但不影响正常使用），而且很可能无法使用「数据预览」功能，如果发现有问题请联系我们。

自定义内置第三方 JS、CSS 库

如果内置的第三方库不能满足需求，又无法使用外联的方式，可以用如下方式来添加：

创建一个目录，比如 /home/work/library，然后将第三方库放置到这里，比如 echarts.js
在 docker 镜像启动时用 -v 将这个目录映射为 /sugar-app/static/library，参考如下写法

docker run --link sugar-mysql --ulimit nofile=65100:65100 --shm-size=4g --restart unless-stopped -d -p 8000:8580 --name sugar -v /home/work/library:/sugar-app/static/library -v ~/sugar-log:/sugar-app/log --env-file env registry.baidubce.com/sugarbi/sugar:6.0.1

前端引用的路径就将是 <script src="/static/library/echarts.js"></script>

私有部署的试用与购买

License升级

百度智能云

百度数据可视化 Sugar BI

百度数据可视化 Sugar BI

私有部署的安装

安装环境

软件环境

硬件环境

下载

1、百度智能云的 docker 镜像服务

2、直接在线下载

运行 Sugar BI

一、Docker 单机运行

同步数据库结构

二、swarm 集群部署

三、kubernetes 集群部署

运行配置说明

登录账号相关配置说明

1、demo

2、password

3、email

4、oauth

5、token

6、ldap

日志说明以及自动清理

Nginx 代理和 HTTPS 设置

开启定时推送、数据预警功能

开启 Excel/CSV 文件上传功能

开启企业角色功能

开启自助取数功能

开启跨源查询功能

开启自定义消息通知

外部依赖模块部署验证

自定义产品 Logo

自定义 JDBC 驱动

自定义内置第三方 JS、CSS 库