gorules/brms

GoRules BRMS

官网 | 文档

概述和主要用途

GoRules BRMS是一款业务规则管理系统，用于定义、部署、执行和维护组织或企业内各类复杂的决策逻辑。该系统优先考虑业务用户体验、性能和可靠性，能够帮助用户快速创建可扩展的决策（规则），并跨多个工作区管理多个版本。

核心功能和特性

• 直观决策构建：快速创建简单直观的业务决策规则
• 安全部署变更：支持跨多环境安全部署规则变更
• 高效组织管理：通过类文件系统及多内部项目更好地组织决策
• 全面变更追踪：利用审计日志跟踪系统内的所有变更操作

使用场景和适用范围

适用于需要管理复杂业务规则的各类组织和企业，尤其适合***风控、保险理赔规则、电商促销策略、供应链管理等需要频繁调整决策逻辑的场景，帮助业务团队独立于IT团队快速响应规则变更需求。

使用方法和配置说明

快速开始

使用Docker Compose本地部署

将以下内容复制到docker-compose.yml文件，执行docker-compose up启动服务，然后访问http://localhost:9080。

yaml
version: '3.8'

services:
  admin:
    image: 'gorules/brms'
    ports:
      - '9080:80'
    depends_on:
      - pg-database
    environment:
      DB_HOST: pg-database
      DB_PORT: 5432
      DB_USER: my-user
      DB_PASSWORD: my-password
      DB_NAME: test-db
      DB_SSL_DISABLED: true
      LICENSE_KEY: 'my-license-key' # 从https://portal.gorules.io获取

  pg-database:
    image: 'postgres'
    environment:
      POSTGRES_USER: my-user
      POSTGRES_PASSWORD: my-password
      POSTGRES_DB: test-db
    ports:
      - '5432:5432'

使用Docker本地部署

与上述类似，需先启动PostgreSQL数据库，可通过docker run --env-file db.env postgres命令启动。之后创建包含最小集环境变量的文件，执行docker run --env-file app.env启动应用。

环境变量配置

最小集

部署GoRules BRMS需配置以下最小集环境变量：

bash
DB_HOST=        # 数据库主机地址
DB_USER=        # 数据库用户名
DB_PASSWORD=    # 数据库密码
DB_NAME=        # 数据库名称

LICENSE_KEY=    # 许可证密钥，从https://portal.gorules.io获取

高级选项

bash
# 通用配置
APP_NAME=GoRules                  # 应用名称（可选）
APP_URL=http://localhost:4200     # 应用URL（可选）
HOME_URI=/                        # 首页URI（可选）

# 数据库配置
DB_PORT=5432                     # 数据库端口（可选，默认5432）
DB_LOGGING=false                 # 数据库日志开关（可选，默认false）
DB_SYNCHRONIZE=false             # 启用模型自动同步（可选，默认false）
DB_MIGRATE=true                  # 启用数据库迁移（可选，默认true）
DB_REJECT_UNAUTHORIZED=false      # 拒绝数据库未授权访问（可选，作为SSL绕过）
DB_SSL_DISABLED=false            # 禁用数据库SSL（可选，默认false）
DB_SSL_CA=                       # 数据库SSL证书颁发机构（CA），base64编码（可使用[***]
DB_SSL_CERT=                     # 数据库SSL证书
DB_SSL_KEY=                      # 数据库SSL密钥
DB_SSL_ADVANCED                  # JSON格式的高级SSL设置，覆盖所有DB SSL配置，详情见https://microsoft.github.io/PowerBI-JavaScript/interfaces/_node_modules__types_node_tls_d_._tls_.tlsoptions.html

# 认证与安全
SESSION_DURATION_MINUTES=1440   # 登录会话时长（分钟，可选，默认1440）
COOKIE_SECRET=cookie-secret     # Cookie密钥（可选，建议修改）

# 邮件配置（用户邀请、认证等）- 留空则使用GoRules邮件服务
EMAIL_ENABLED=true               # 启用邮件认证（可选，默认true）
EMAIL_URL=[***]   # 邮件URL（可选）
EMAIL_FROM=***    # 发件人***（可选）
EMAIL_HOST=                      # SMTP主机（可选）
EMAIL_PORT=                      # SMTP端口（可选）
EMAIL_SECURE=false               # SMTP安全连接标志（可选，默认false）
EMAIL_TLS_REJECT_UNAUTHORIZED=   # SMTP TLS拒绝未授权（可选）
EMAIL_AUTH_USER=                 # SMTP认证用户名（可选）
EMAIL_AUTH_PASS=                 # SMTP认证密码（可选）

# Microsoft Azure AD OpenID Connect（Business计划+）- v1.6.0及以上版本支持
SSO_OAUTH2_PROVIDER=azure
SSO_OAUTH2_CLIENT_ID=
SSO_OAUTH2_CLIENT_SECRET=
SSO_OAUTH2_SCOPES=openid email profile
SSO_OAUTH2_AUTH_URL=             # 示例：[***]<tenant_uuid>/oauth2/v2.0/authorize
SSO_OAUTH2_TOKEN_URL=            # 示例：[***]<tenant_uuid>/oauth2/v2.0/token
SSO_OAUTH2_AUTHORITY_URL=        # 示例：[***]<tenant_uuid> - 单租户设置必填

# 或

# Okta OpenID Connect（Business计划+）- v1.6.0及以上版本支持
SSO_OAUTH2_PROVIDER=okta
SSO_OAUTH2_CLIENT_ID=
SSO_OAUTH2_CLIENT_SECRET=
SSO_OAUTH2_SCOPES=openid email profile groups
SSO_OAUTH2_AUTH_URL=           # 示例：https://<domain>.okta.com/oauth2/v1/authorize
SSO_OAUTH2_TOKEN_URL=          # 示例：https://<domain>.okta.com/oauth2/v1/token
SSO_OAUTH2_GROUPS_MAPPING=     # 示例：brms_admin->admin,brms_author->author