ElasticView

Appearance

配置文件 ​

ElasticView 的配置文件用于自定义系统的各项设置，如数据库连接、端口号、插件设置等。本文档详细介绍了配置文件的各个选项。

配置文件示例 ​

以下是一个完整的配置文件示例：

yaml
log:
  storageDays: 4          # 日志保留天数
  logDir: "logs"          # 日志保留文件夹
port: 8090                # 启动端口
pluginRpcPort: 8091       # 插件内网访问端口
rootUrl: http:/www.xxxx.com/  # 项目访问域名 用于oauth第三方登录认证时的回调
dbType: "sqlite3"         # 数据保留类型 分为 sqlite3 和 mysql
enableLogEs: false        # 是否记录es请求记录
enableLogEsRes: false     # 是否记录es请求记录中返回的响应体
sqlite:                   # dbType为sqlite3时填 dbPath为数据保存文件地址
  dbName: "es_view.db"
mysql:                    # dbType为mysql时填
  username: "root"
  pwd: ""
  ip: "localhost"
  port: "3306"
  dbName: "test"
  maxOpenConns: 10
  maxIdleConns: 10
esPwdSecret: "concat_mail!!->1340691923@qq.com"     # 数据源加密密钥 加密方式为 AES
version: "0.0.3"          # EV 版本号
deBug: false              # 是否为测试模式 如果为 false则打开默认浏览器直接访问地址
checkForevUpdates: true   # 是否自动检测ev更新
checkForPluginUpdates: true  # 是否自动检测ev插件更新
evKey:                    # evKey 需要到插件者后台注册获取
storeFileDir:             # 临时文件存放目录 例如下载的excel
plugin:
  loadPath: plugins       # 插件存放目录
  storePath: plugins_store # 插件临时文件存放目录
watermarkContent: ElasticView # 水印
translation:
  lang: zh-cn             # zh-cn or en
  cfgDir: config/i18n     # i18n文件存放目录
ai:
  bigModeKey: ""          # 阿里百炼大模型appkey

配置项说明 ​

日志配置 ​

  • log.storageDays: 日志保留天数，超过这个天数的日志将被自动删除
  • log.logDir: 日志文件存放的目录

系统配置 ​

  • port: ElasticView 服务启动的端口
  • pluginRpcPort: 插件内网访问的端口

数据库配置 ​

  • dbType: 数据库类型，支持 sqlite3 和 mysql
  • sqlite.dbName: 当使用 SQLite 时，数据库文件名
  • mysql: 当使用 MySQL 时的相关配置
    • username: MySQL 用户名
    • pwd: MySQL 密码
    • ip: MySQL 服务器地址
    • port: MySQL 服务器端口
    • dbName: 数据库名称
    • maxOpenConns: 最大打开连接数
    • maxIdleConns: 最大空闲连接数

安全配置 ​

  • esPwdSecret: 数据源密码加密密钥，使用 AES 加密

插件配置 ​

  • plugin.loadPath: 插件加载路径
  • plugin.storePath: 插件临时文件存储路径

功能开关 ​

  • enableLogEs: 是否记录 ElasticSearch 请求
  • enableLogEsRes: 是否记录 ElasticSearch 请求的响应体
  • deBug: 调试模式开关
  • checkForevUpdates: 是否自动检测 ElasticView 更新
  • checkForPluginUpdates: 是否自动检测插件更新

国际化 ​

  • translation.lang: 语言设置，支持 zh-cn 和 en
  • translation.cfgDir: 国际化配置文件目录

AI 功能 ​

  • ai.bigModeKey: 阿里百炼大模型 AppKey

配置文件位置 ​

  • 在二进制部署中，配置文件默认位于程序同级目录下的 config/config.yml

配置文件修改 ​

修改配置文件后，需要重启 ElasticView 服务使配置生效。