跳到主要内容
版本：v3

配置文件说明

提示

SQLE的配置文件采用yaml的格式，默认情况下位于SQLE安装目录下，路径为./etc/config.yaml

默认文件参考​

dms:
  id: 1
  api:
    addr: "0.0.0.0"
    port: 10000
    enable_https: false
    cert_file_path: './etc/cert.pem'
    key_file_path: './etc/key.pem'
  secret_key: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
  service:
    database:
      host: "127.0.0.1"  # 请修改为实际监听的IP
      port: 3306   # 请修改为实际监听的端口
      username: "root"   # 请修改为实际连接信息
      password: "123456"   # 请修改为实际连接信息
      database: "dms"  
      debug: true
      auto_migrate: true
    log:
      level: DEBUG
      path: logs
      max_size_mb: 100
      max_backup_number: 10
  cloudbeaver:
    enable_https: false
    host: "127.0.0.1"  
    port: 8978
    admin_user: "cbadmin"
    admin_password: "123456"
  database_driver_options:
    - db_type: MySQL
      logo_path: "/logo/mysql.png"
      params:  
    - db_type: PostgreSQL
      logo_path: "/static/logo/pg.png"
      params:   
    - db_type: Oracle
      logo_path: "/static/logo/oracle.png"
      params: [
       {
        "key":"service_name",
        "value":"XE",
        "desc":"service name",
        "type":"string"
       },    
      ]   
sqle:
  id: 1
  dms_server_address: "http://127.0.0.1:10000"
  api:
    addr: "127.0.0.1"
    port: 10001
    enable_https: false
    cert_file_path: './etc/cert.pem'
    key_file_path: './etc/key.pem'
  secret_key: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
  service:
    auto_migrate_table: true
    debug_log: false
    log_path: './logs'
    log_max_size_mb: 1024
    log_max_backup_number: 2
    plugin_path: './plugins'
    database:
      mysql_host: '127.0.0.1'  # 请修改为实际监听的IP
      mysql_port: 3306   # 请修改为实际监听的端口
      mysql_user: 'root'  # 请修改为实际连接信息
      mysql_password: '123456'   # 请修改为实际连接信息
      mysql_schema: 'sqle'

配置说明​

通用配置​

参数说明
idserver id，辨识集群节点，集群内不重复即可
api当前服务的web接口参数
secret_key全局AES加密秘钥，影响登录和用户密码等的存储；生产环境建议配置该值替换掉程序默认值，不然会存在安全风险；格式是32位随机字符串

通用配置.api​

参数说明
addr访问服务器时需要的网络地址
port当前服务的web接口参数
enable_https是否开启https，默认不开启
cert_file_pathhttps 证书路径
key_file_pathhttps 私钥路径

DMS 配置​

参数说明
id通用配置
api通用配置
secret_key通用配置
service服务
cloudbeaverSQL工作台

DMS.service.database​

参数说明
hostDMS 后端数据库地址
portDMS 后端数据库地址
usernameDMS 后端数据库用户
passwordDMS 后端数据库密码
databaseDMS 后端数据库 schema
debug

DMS.service.log​

参数说明
levelDMS日志级别
pathDMS日志存在路径
max_size_mbDMS日志文件大小
max_backup_numberDMS保留日志文件数

DMS.cloudbeaver​

SQL工作台的配置，配置则代表开启SQL工作台。

参数说明
enable_https是否是https连接
hostcloudbeaver 地址
portcloudbeaver 端口
admin_usercloudbeaver 超级管理员名称
admin_passwordcloudbeaver 超级管理员密码

SQLE 配置​

参数说明
id通用配置
api通用配置
secret_key通用配置
service服务

SQLE.service​

参数说明
auto_migrate_table自动创建表结构，初始化数据
debug_log开启debug模式，打印更多日志，会打印业务SQL，开发环境可开启
log_path日志目录
log_max_size_mb单个日志文件最大大小，单位MB
log_max_backup_number日志文件最大备份数量
plugin_pathSQL审核插件的加载地址

SQLE.service.database​

参数说明
mysql_hostSQLE存储库的地址
mysql_portSQLE存储库的端口
mysql_userSQLE存储库的数据库用户
mysql_passwordSQLE存储库的数据库密码
mysql_schemaSQLE存储库的数据库 schema

数据库插件配置请参考：如何配置数据库审核插件