Files
iotlcm/admin-svr/server/config/config.example.yaml
T

271 lines
12 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# config.yaml 配置文件
# @Link https://github.com/xiujiecn/xiu-admin
# @Copyright Copyright (c) 2025 LiXiujie
# @Author Lxj <xxx@example.com>
# @License https://github.com/xiujiecn/xiu-admin/blob/master/LICENSE
# 系统配置
system:
name: "IotLCM"
version: "1.0"
description: "IotLCM Server"
gfmode: "dev"
upload:
local:
path: "resource/upload"
workerDiagnostic:
enabled: true
batch:
allocate:
chunkSize: 5000
maxFileSize: 52428800
# 服务配置
server:
# 基本配置
address: ":8008"
# 接口文档
openapiPath: "/api.json" # OpenAPI接口文档地址
swaggerPath: "/swagger" # 内置SwaggerUI展示地址
# 静态服务配置
indexFiles: ["index.html","index.htm"] # 自动首页静态文件检索。默认为["index.html", "index.htm"]
indexFolder: false # 当访问静态文件目录时,是否展示目录下的文件列表。默认关闭,那么请求将返回403
serverRoot: "resource/public" # 静态文件服务的目录根路径,配置时自动开启静态文件服务。默认关闭
searchPaths: ["/resource/public"] # 提供静态文件服务时额外的文件搜索路径,当根路径找不到时则按照顺序在搜索目录查找。默认关闭
fileServerEnabled: true
initLoadMemoryDB: false # 是否初始化内存数据库,默认关闭
# 文件上传配置
maxHeaderBytes: "20KB"
clientMaxBodySize: "200MB"
readTimeout: "20m"
writeTimeout: "20m"
# 日志配置
logger:
path: "/app/logs" # 日志文件路径。默认为空,表示关闭,仅输出到终端
file: "{Y-m-d-H}.log" # 日志文件格式。默认为"{Y-m-d}.log"
prefix: "" # 日志内容输出前缀。默认为空
level: "dev" # 日志输出级别
timeFormat: "2006-01-02T15:04:05" # 自定义日志输出的时间格式,使用Golang标准的时间格式配置
ctxKeys: [] # 自定义Context上下文变量名称,自动打印Context的变量到日志中。默认为空
header: true # 是否打印日志的头信息。默认true
stdout: true # 日志是否同时输出到终端。默认true
rotateSize: 0 # 按照日志文件大小对文件进行滚动切分。默认为0,表示关闭滚动切分特性
rotateExpire: 0 # 按照日志文件时间间隔对文件滚动切分。默认为0,表示关闭滚动切分特性
rotateBackupLimit: 0 # 按照切分的文件数量清理切分文件,当滚动切分特性开启时有效。默认为0,表示不备份,切分则删除
rotateBackupExpire: 0 # 按照切分的文件有效期清理切分文件,当滚动切分特性开启时有效。默认为0,表示不备份,切分则删除
rotateBackupCompress: 0 # 滚动切分文件的压缩比(0-9)。默认为0,表示不压缩
rotateCheckInterval: "1h" # 滚动切分的时间检测间隔,一般不需要设置。默认为1小时
stdoutColorDisabled: false # 关闭终端的颜色打印。默认开启
writerColorEnable: false # 日志文件是否带上颜色。默认false,表示不带颜色
# JWT配置
jwt:
signingKey: "${JWT_SIGNING_KEY}"
expiresTime: 7d
bufferTime: 1d
issuer: iotlcm # 发行人
# 验证码配置
captcha:
keyLong: 6
imgWidth: 240
imgHeight: 80
openCaptcha: 0
openCaptchaTimeout: 3600
# 注册验证码配置。短信 bodyTemplate、邮件 bodyTemplate 支持 {contact}/{code} 或 ${contact}/${code}
register:
sms:
url: ""
method: "POST"
headers: {}
bodyTemplate: '{"phone":"{contact}","code":"{code}"}'
successStatus: 200
email:
host: "smtp.exmail.qq.com"
port: 465
username: "${SMTP_USERNAME}"
password: "${SMTP_PASSWORD}"
from: "xxx@example.com"
fromName: "物联卡管理平台"
subject: "注册验证码"
bodyTemplate: "您的注册验证码是:{code},6小时内有效。"
ssl: true
# 预警通知配置。短信服务使用 iotlcm-sms,配置完整并 enabled=true 后才会真实发送。
warning:
expire:
# 系统默认套餐到期预警天数;必须满足 firstWarnDays > secondWarnDays > thirdWarnDays。
firstWarnDays: 30
secondWarnDays: 15
thirdWarnDays: 7
sms:
enabled: true
# HTTP 接口地址;如果配置 grpcAddr,则优先走 gRPC。
url: "http://127.0.0.1:11190/api/v1/sms/send"
grpcAddr: "127.0.0.1:11200"
timeout: "5s"
routerId: 0
# 兼容当前 iotlcm-sms 协议:如果短信微服务没有内置供应商配置,可在这里透传。
# 阿里云 serviceType=1,腾讯云 serviceType=2。
serviceType: ""
regionId: ""
accessKeyId: "${ACCESS_KEY_ID}"
accessKeySecret: "${ACCESS_KEY_SECRET}"
sdkAppId: "${SDK_APP_ID}"
signName: "${SMS_SIGN_NAME}"
templateId: "${TEMPLATE_ID}"
# 阿里云模板参数通常需要 JSON;如果预警模板变量名是 content,可配置为 '{"content":{contentJson}}'。
# 腾讯云多参数模板可按实际顺序配置,例如 '{firstItem}|{count}'。
msgContentTemplate: ""
# 长期建议:短信平台签名、模板和密钥由短信微服务自行处理,lcm 只传手机号和聚合内容。
wechat:
enabled: false
appId: "${APP_ID}"
appSecret: "${APP_SECRET}"
templateId: "${TEMPLATE_ID}"
page: "pages/message/index"
timeout: "5s"
database:
logger:
path: "/app/logs/sql"
level: "all"
stdout: true
default: # 分组名称,可自定义,默认为default
link: "${DB_DSN}"
debug: true #开启调试模式
charset: "utf8mb4" # (可选)数据库编码(如: utf8mb4/utf8/gbk/gb2312),一般设置为utf8mb4。默认为utf8。
dryRun: false #ORM空跑(只读不写)
maxIdle: 30 #连接池最大闲置的连接数
maxOpen: 100 #连接池最大打开的连接数
maxLifetime: 120 #(单位秒)连接对象可重复使用的时间长度
memorydb:
# SQLite 内存库供本地启动及测试使用,无需外部凭据。
link: "sqlite::@file(:memory:)"
debug: true
maxIdle: 1
maxOpen: 1
maxLifetime: 30
# 缓存配置
cache:
adapter: "redis" # 缓存适配器,支持:file|redis
fileDir: "resource/cache" # 缓存文件目录
# Redis 配置示例
redis:
# 单实例配置
default:
mode: "single" #redis模式,支持:single|cluster|sentinel
sentinelMasterName: "iotlcm-master" #哨兵模式主节点名称
address: 127.0.0.1:6379
db: 0
pass: "${REDIS_PASSWORD}"
minIdle: 5 #最小空闲连接数
maxIdle: 30 #允许闲置的最大连接数
maxActive: 5000 #最大活跃连接数
idleTimeout: "60s" #连接最大空闲时间,使用时间字符串例如30s/2m/2d
ClientName: "SystemCache"
rabbitmq:
enabled: true
# 示例:amqp://guest:${RABBITMQ_PASSWORD}@127.0.0.1:5672/
dsn: "${RABBITMQ_DSN}"
tsdb:
database: "TdEngine" #可选择 TdEngine、Influxdb
tdengine:
# type: "taosRestful" #http连接方式,端口是6041
# dsn: "${TDENGINE_DSN}"
type: "taosWS" #websocket连接方式,端口是6041
# dsn: "${TDENGINE_DSN}"
dsn: "${TDENGINE_DSN}"
dbName: "iotlcm"
maxOpenConns: 100
maxIdleConns: 10
batchSize: 200
# 路由配置
router:
# 不需要验证登录的路由地址
exceptLogin:
- /api/v1/system/auth/login
- /api/v1/system/auth/refresh
- /api/v1/system/captcha
- /api/v1/system/auth/getTenantList
- /api/v1/pay/alipay/notify
- /api/v1/pay/alipay/return
# 生成代码
alipay:
appId: "${APP_ID}"
privateKey: "${PRIVATE_KEY}"
alipayPublicKey: "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8Df1EPFkA2xy8NgF0UdRYxsshslUi2XSGTG01oQKsrYNB+rhAw9MJdMlunVQxSrBZsw5N7htXGdiTceaLo/n8Wuibp0cRHdErJSp9GhP4pW2IR3FoCCPYlJlyiCUR/NInI3XMai0UdjgiPX03bvYLRAKE8lLiOSgxNagQmOFLmQYRYfFhGbxDe98XMg83YdSWvZKrlM+vzgk8/aPgq7BFLpbRKqLvd8OXXBHDCaWMSSGwCN0whhdEiwbIhSVgwTgkhWXUuNDmT741/+7D46djp8wX/84SDts0fWb63/in9ATTGtNivJX7HPDyqrmcN2iUi5xFHS9XwYBdT4yu/xFQwIDAQAB"
notifyUrl: "https://evolution-starless-municipal.ngrok-free.dev/api/v1/pay/alipay/notify"
returnUrl: "http://localhost:5666/enterpriseManagement/tBalanceDetail/tAgentBalance"
isProduction: false
pay:
expireTime: 3 # 支付过期时间,方便测试先改为3分钟
balanceRecharge:
timeoutDelay: "3m" # 余额充值支付宝支付与 RabbitMQ 延时检查时间,方便测试先改为3分钟,后续改为真正时间
xgen:
allowedIPs: [ "127.0.0.1", "*" ] # 白名单,*代表所有,只有允许的IP后台才能使用生成代码功能
selectDbs: [ "default" ] # 可选生成表的数据库配置名称,支持多库
disableTables: [ ] # 禁用的表,禁用以后将不会在选择表中看到
delimiters: [ "@{", "}" ] # 模板引擎变量分隔符号
# 生成应用模型,所有生成模板允许自定义,可以参考default模板进行改造
application:
# CRUD和关系树列表模板
crud:
templates:
# 默认的主包模板
- group: "default" # 分组名称
isAddon: false # 是否为插件模板 false|true
masterPackage: "gen" # 主包名称,需和controllerPath、logicPath、inputPath保持关联
templatePath: "./resource/generate/default/curd" # 模板路径
apiPath: "./api/gen" # goApi生成路径
controllerPath: "./internal/controller/gen" # 控制器生成路径
logicPath: "./internal/logic/gen" # 主要业务生成路径
inputPath: "./internal/model/genin" # 表单过滤器生成路径
routerPath: "./internal/router/genrouter" # 生成路由表路径
sqlPath: "./manifest/generate" # 生成sql语句路径
webApiPath: "../vue/apps/web-antd/src/api/gen" # webApi生成路径
webViewsPath: "../vue/apps/web-antd/src/views/gen" # web页面生成路径
# 默认的插件包模板,{$name}会自动替换成实际的插件名称
- group: "addon" # 分组名称
isAddon: true # 是否为插件模板 false|true
masterPackage: "sys" # 主包名称,需和controllerPath、logicPath、inputPath保持关联
templatePath: "./resource/generate/default/curd" # 模板路径
apiPath: "./addons/{$name}/api/admin" # goApi生成路径
controllerPath: "./addons/{$name}/controller/admin/sys" # 控制器生成路径
logicPath: "./addons/{$name}/logic/sys" # 主要业务生成路径
inputPath: "./addons/{$name}/model/input/sysin" # 表单过滤器生成路径
routerPath: "./addons/{$name}/router/genrouter" # 生成路由表路径
sqlPath: "./storage/data/generate/addons" # 生成sql语句路径
webApiPath: "../web/src/api/addons/{$name}" # webApi生成路径
webViewsPath: "../web/src/views/addons/{$name}" # web页面生成路径
upstream:
proxy:
# address: "yzupstreamproxy-http-svc"
address: "localhost:8510"
timeout: 10s
gateway:
# address: "iotlcmupstreamchan-http-svc"
address: "localhost:8110"
timeout: 10s
diagnose:
clientName: "iotlcm.example.com:8110"
timeout: 10s
inboundBasicInfo:
clientName: "iotlcm.example.com:8110"
timeout: 10s