hotgo/server/manifest/config/config.example.yaml

149 lines
6.2 KiB
Go
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.

# hotgo配置
hotgo:
debug: true # debug开关开启后接口出现错误时会输出堆栈信息默认为true
ipMethod: "cz88" # IP归属地解析方法可选cz88|whois默认为cz88
wsAddr: "ws://填你的公网IP或本地IP:8000/socket" # 客户端websocket连接地址如果项目在公网请填写公网IP:运行端口
isDemo: false # 是否為演示系統 false | true
ssl: # https
switch: false # 是否开启https访问需要配置sslCrtPathsslKeyPath证书夹
crtPath: "resource/ssl/server.crt"
keyPath: "resource/ssl/server.key"
log: # 全局请求日志
switch: true # 日志开关默认为true
queue: true # 是否启用队列启用时需要配置队列信息默认为true
module: [ "admin", "api", "default" ] # 需要记录的模块
skipCode: [ ] # 不记录的状态码 ["0", "-1"]
admin:
superIds: [ 1,2 ] # 后台超管账号ID通过ID验证超管
superRoleKey: "super" # 超管角色唯一标识符通过角色验证超管
defaultPage: 10 # 列表分页默认加载数量
defaultPageSize: 1 # 列表分页默认加载页码
# gf配置
server:
address: ":8000"
openapiPath: "/api.json"
swaggerPath: "/swagger"
serverRoot: "resource/public"
DumpRouterMap: false
logPath: "logs/server"
ErrorStack: true # 当Server捕获到异常时是否记录堆栈信息到日志中默认为true
ErrorLogEnabled: true # 是否记录异常日志信息到日志中默认为true
errorLogPattern: "error/{Y-m-d}.log" # 异常错误日志文件格式默认为"error-{Ymd}.log"
accessLogEnabled: true # 是否记录访问日志默认为false
accessLogPattern: "access/{Y-m-d}.log" # 访问日志文件格式默认为"access-{Ymd}.log"
serverAgent: "HG HTTP Server"
# Global logging.
logger:
level: "all"
stdout: true
headerPrint: false
ctxKeys: [ ]
path: "logs/logger" # 日志文件路径默认为空表示关闭仅输出到终端
file: "{Y-m-d}.log" # 日志文件格式默认为"{Y-m-d}.log"
stdoutColorDisabled: true # 关闭终端的颜色打印默认开启
writerColorEnable: true # 日志文件是否带上颜色默认false表示不带颜色
# PProf配置
pprofEnabled: true # 是否开启PProf性能调试特性默认为false
pprofPattern: "/pprof" # 开启PProf时有效表示PProf特性的页面访问路径对当前Server绑定的所有域名有效
viewer:
paths: "resource/template"
defaultFile: "index.html"
delimiters: ["@{", "}"]
homeLayout: "home/index.html"
# 内容设置
setting:
title: "HotGo"
keywords: "中后台解决方案,gf框架,vue3"
description: "hotgo 是一个基于 goframe2vue3vite2TypeScriptuinapp 的中后台解决方案,它可以帮助你快速搭建企业级中后台项目,相信不管是从新技术使用还是其他方面,都能帮助到你,持续更新中。"
# 路由配置
router:
# 后台
admin:
# 前缀
prefix: "/admin"
# 不需要验证登录的路由地址
exceptLogin: [
"/site/captcha", # 登录验证码
"/site/login", # 登录
"/site/ping", # ping
]
# 不需要验证权限的路由地址
exceptAuth: [
"/member/info", # 登录用户信息
"/role/dynamic", # 获取动态路由
"/site/config", # 获取后台配置
]
# 接口
api:
# 前缀
prefix: "/api"
# 不需要验证登录的路由地址
exceptPath: [ ]
# ws
ws:
# 前缀
prefix: "/socket"
# 不需要验证登录的路由地址
exceptLogin: [
]
# 前台页面
home:
# 前缀
prefix: "/home"
# 不需要验证登录的路由地址
exceptPath: [ ]
#JWT
jwt:
version: "1.0" # 版本号
expires: "864000" # 有效期单位
sign: "hotgo" # 秘钥考虑安全问题请修改默认值
multiPort: true # 是否允许多端登录默认为true
#消息队列
queue:
switch: true # 队列开关默认为false
driver: "redis" # 队列驱动可选redis|rocketmq|kafka
retry: 2 # 重试次数
multiComsumer: true # 是否支持创建多个消费者
groupName: "hotgo" # mq群组名称
redis:
address: "127.0.0.1:6379" # redis服务地址默认为127.0.0.1:6379
db: 0 # 指定redis库
pass: "" # redis密码
timeout: 0 # 队列超时时间(s) 0为永不超时当队列一直没有被消费到达超时时间则队列会被销毁
rocketmq:
address: "127.0.0.1:9876" # brocker地址+端口
logLevel: "all" # 系统日志级别可选all|close|debug|info|warn|error|fatal
kafka:
address: "127.0.0.1:9092" # kafka地址+端口
version: "2.0.0.0" # kafka专属配置默认2.0.0.0
randClient: true # 开启随机生成clientID可以实现启动多实例同时一起消费相同topic加速消费能力的特性默认为true
# Redis
redis:
default:
address: "127.0.0.1:6379"
db: "1"
pass: ""
idleTimeout: "20"
# Database.
database:
logger:
level: "all"
stdout: true
default:
link: "mysql:hotgo:hg123456.@tcp(127.0.0.1:3306)/hotgo?loc=Local&parseTime=true"
debug: true
Prefix: "hg_"