部署和维护 / 配置文件

本文主要介绍 DataFlux Func 的配置文件以及调整方式。

1. 配置文件位置

请参考部署和维护 / 配置和数据文件 / DataFlux Func 配置

2. 配置项

下方未列出的配置项请勿随意修改

DataFlux Func 具有非常多的可配置项

以下仅列出一些常用的，用户可以直接修改的配置项

其他未列出的配置项请勿随意修改

修改配置后需要重启

在修改配置后，需要重启整个 DataFlux Func 才能使新配置生效

请勿单独启动部分服务，避免服务之间因配置不同而导致冲突

配置项	默认值	版本要求	说明
`SECRET`	部署时随机生成		私钥。用于登录令牌、连接器配置加密等注意：一旦配置后请勿修改，否则会导致系统无法正常运行
`LOG_LEVEL`	`"WARNING"`		日志等级，可选：　`"ALL"`: 全部输出　`"DEBUG"`: 输出调试、信息、警告和错误日志　`"INFO"`: 输出信息、警告和错误日志　`"WARNING"`: 输出警告和错误日志　`"ERROR"`: 仅输出错误日志　`"NONE"`: 不输出
`LOG_FILE_PATH`	`"data/logs/dataflux-func.log"`		日志文件输出地址必须使用绝对路径
`TIMEZONE`	`"Asia/Shanghai"`		时区
`LOG_FILE_FORMAT`	`"text"`		日志输出格式，可选：　`"text"`: 纯文本格式　`"json"`: JSON 格式
`LOG_CONSOLE_COLOR`	`false`		终端日志是否着色
`WEB_BASE_URL`	`""`		Web 服务访问 URL 即用户在访问时，浏览器地址栏中需要输入的地址留空表示跟随浏览器
`WEB_BIND`	`"0.0.0.0"`		Web 服务绑定 IP，如：　`"0.0.0.0"`: 为公开访问　`"127.0.0.1"`: 为仅本地访问
`WEB_PORT`	`8088`		Web 服务绑定端口
`WEB_FIXED_RESPONSE_HEADERS_MAP`	见配置细节	6.3.0	Web 服务固定响应头配置细节
`WEB_CORS_ORIGIN_LIST`	见配置细节	6.3.0	Web 服务跨域 Origin 列表配置细节
`MYSQL_HOST`	部署时自动填入		MySQL 主机地址
`MYSQL_PORT`	`3306`		MySQL 端口
`MYSQL_USER`	`"root"`		MySQL 用户
`MYSQL_PASSWORD`	部署时随机生成		MySQL 密码
`MYSQL_DATABASE`	`"dataflux_func"`		MySQL 数据库
`REDIS_HOST`	部署时自动填入		Redis 主机地址
`REDIS_PORT`	`6379`		Redis 端口
`REDIS_DATABASE`	`5`		Redis 数据库
`REDIS_USER`	`""`		Redis 用户
`REDIS_PASSWORD`	部署时随机生成		Redis 密码
`REDIS_USE_TLS`	`false`	1.1.9	Redis 是否开启 TLS
`REDIS_AUTH_TYPE`	`"default"`	2.8.1	Redis 认证方式，可选：　`"default"`: 默认（即 Redis 原版）　`"aliyun"`：阿里云数据库认证
`REDIS_MODE`	`"auto"`	6.2.12	Redis 模式，可选：　`"auto"`：自动判断　`"singleton"`：单机版　`"cluster"`：集群版
`BAD_SIGNIN_TEMP_LOCK_ACTIVE_COUNT`	`10`		因登录失败而启用临时锁定用户的次数

3. 配置细节

部分配置项目的细节如下：

`WEB_FIXED_RESPONSE_HEADERS_MAP`

此配置项为字典结构

Web 服务固定响应头

配置后，DataFlux Func 所有 HTTP 响应头都会包含指定的内容

示例
WEB_FIXED_RESPONSE_HEADERS_MAP:
  X-Custom-Header: some-value

默认配置如下：

7.2.7 及以后版本7.2.6 及以前版本

默认值
WEB_FIXED_RESPONSE_HEADERS_MAP:
  X-Content-Type-Options: nosniff

默认值
WEB_FIXED_RESPONSE_HEADERS_MAP: null

`WEB_CORS_ORIGIN_LIST`

此配置项为列表结构

Web 服务跨域 Origin 列表

列表每一项均为一条规则，Web 服务在接到请求后会依次匹配，按照第一个命中的规则进行处理

可用规则及其写法如下：

规则	示例	说明
任意	`"*"`	总是能命中的规则，可写在最后一条作为默认规则
Origin 匹配	`"http://other.site.domain"`	针对特定来源 Origin 进行控制
URL 匹配	`"http://other.site.domain/api/v1"` `"http://other.site.domain/api/"` `"http://other.site.domain/api/v"` `"http://other.site.domain/api/**"`	针对特定来源 Origin，并只针对请求特定路径时进行控制路径支持 `*` 通配
Path 匹配	`"/api/v1"` `"/api/"` `"/api/v"` `"/api/**"`	只针对请求特定路径时进行 CORS 控制路径支持 `*` 通配
Host 匹配	`"other.site.domain"`	只针对来源 Origin 中 Host 部分匹配时进行控制即忽略 HTTP 协议类型
Host + Path 匹配	`"other.site.domain/api/v1"` `"other.site.domain/api/"` `"other.site.domain/api/v"` `"other.site.domain/api/**"`	只针对来源 Origin 中 Host 部分匹配，并只针对请求特定路径时进行控制路径支持 `*` 通配

默认命中后为允许跨域，规则开头添加 "!" 表示命中后不允许跨域，如果没有命中的，则默认为禁止跨域，如：

允许 /api/v1/func-api/** 跨域，其他不允许跨域
WEB_CORS_ORIGIN_LIST:
  - '/api/v1/func-api/**'
  - '!*

当前默认配置如下：

默认值
WEB_CORS_ORIGIN_LIST:
  - '/api/v1/func-api/**'              # 函数 API 接口
  - '/api/v1/cron/*'                   # 手动触发定时任务接口
  - '/api/v1/func-api-list'            # 函数 API 列表接口
  - '/api/v1/func/integration/sign-in' # 集成登录接口
  - '/api/v1/fs/**'                    # 文件服务接口
  - '/api/v1/sync/**'                  # 同步 API 接口（旧版）
  - '/api/v1/async/**'                 # 异步 API 接口（旧版）
  - '/api/v1/al/**'                    # 授权链接接口（旧版）
  - '/api/v1/bat/**'                   # 批处理接口（旧版）