Skip to content

启动配置文件

洛梧藤 edited this page May 17, 2024 · 9 revisions

配置内容

Sql 数据库连接配置

所属分组 名称 必须 类型 说明 补充
database/db scheme String 数据库的 scheme,如 mysql
database/db username String 数据库的 用户名
database/db password String 数据库的 密码
database/db host String 数据库的 host 默认为 localhost
database/db port u16 数据库的 port 默认为3306
database/db name String 使用的数据库名称
database/db max_conn u32 数据库的最大连接数
database/db min_conn u32 数据库的最小连接数
database/db logger bool 是否开始数据库操作日志 默认关闭

MongoDb 数据库连接配置

所属分组 名称 必须 类型 说明 补充
mongodb/ mongo username String Mongodb 进行数据库连接使用的用户 该用户需要完整 Admin 权限
mongodb/ mongo password String Mongodb 进行数据库连接使用的用户密码
mongodb/ mongo host String Mongodb 进行数据库连接使用的 host 默认为localhost
mongodb/ mongo port String Mongodb 进行数据库连接使用的端口 默认为27017
mongodb/ mongo db_name String Mongodb 进行数据库连接使用的数据库

Redis 数据库连接配置

所属分组 名称 必须 类型 说明 补充
redis password String Redis 进行数据库连接使用的用户密码
redis host String Redis 进行数据库连接使用的 host 默认为localhost
redis port u16 Redis 进行数据库连接使用的端口 默认为6379
redis db u8 Redis 进行数据库连接使用的数据库 默认为0

日志配置

所属分组 名称 必须 类型 说明 补充
logger/log to_stdout bool 同时将日志输出到 Stdout 默认为 true
logger/log to_file String 同时将日志输出的文件 有值将会同时将日志输出到指定文件
logger/log level off 或者error或者warm 或者info 或者debug 或者trace 日志输出过滤等级

Resp-Result 响应结构配置

所属分组 名称 必须 类型 说明 补充
resp_result/ rresult body String 响应成功时的响应体字段名称
resp_result/ rresult err-msg String 响应失败时异常字段名称
resp_result/ rresult fix-field bool 响应体固定字段 如果无需该字段值将为null
resp_result/ rresult bool-status Option<String> 使用一个 bool 类型标记响应成功与否 该字段缺省表示不使用
resp_result/ rresult body-extra-err Option<String> 额外的异常信息在响应体中字段 该字段缺省表示不使用
resp_result/ rresult header-extra-err Option<String> 额外的异常信息在响应头中的字段名称 该字段缺省表示不使用

用户鉴权支持配置

所属分组 名称 必须 类型 说明 补充
user_auth/ auth jwt/jwt-key String 用户鉴权使用的Jwt密钥 最大长度不超过 32 位。过长部分将会被截断,过短部分将会被随机数填充
user_auth/ auth header/header_name String 获取 token 的 Header 默认为Token

初始用户配置

所属分组 名称 必须 类型 说明 补充
admin_user/ user username String 默认后台第一个最高权限用户名
admin_user/ user password String 默认后台第一个最高权限密码

服务器监听配置

所属分组 名称 必须 类型 说明 补充
http_listen/ http host IpAddr http 监听的 host 默认为127.0.0.1
http_listen/ http port u16 http 监听的 port 默认为8000

七牛云上传配置

所属分组 名称 必须 类型 说明 补充
qiniu/ qiniu_secret access_key String 七牛云的 Access Key
qiniu/ qiniu_secret secret_key String 七牛云的 Secret Key
qiniu/ qiniu_secret bucket String 所有要使用的 Bucket(篮子) 必填
qiniu/ qiniu_secret base_url/url Url Bucket映射域名的domain 域名后的 / 可选,即http://example.com/http://exapmple.com 均可

调度器接口配置

所属分组 名称 必须 类型 说明 补充
schedule_manage/schedule base_url/url Url 调度器的base_url 该base_url 的 path 会被抛弃

MobPush 推送配置

所属分组 名称 必须 类型 说明 补充
mob_push/mob app_key String Mob推送使用的应用Key
mob_push/mob app_secret String Mob推送使用的应用Secret

调度器接口配置

所属分组 名称 必须 类型 说明 补充
qq/qq_channel uri Url qq频道grpc的url

调度器接口配置

所属分组 名称 必须 类型 说明 补充
cors origins Vec<http::HeaderValue> CORS配置的允许的域 默认为空
cors methods Vec<Method> CORS配置的允许的请求方法 默认为空

配置示例

toml

[db]
scheme = "mysql"
username = "<database-user>"
password = "<database-password>"
name = "<database-name>"

[mongo]
username = "<database-user>"
password = "<database-password>"
db_name = "<database-name>"
host = "localhost"

[redis]

[rresult]
body = "data"
err-msg = "message"
fix-field = true
bool-status = { key = "is-ok" }
body-extra-err = "code"

[auth]
jwt = "<JWT-secret-token>"

[user]
username = "<root-user-name>"
password = "<root-user-password>"

[log]
level = "info"
to_stdout = true

[qiniu]
access_key = "<qiniu-access-key>"
secret_key = "<qiniu-secret-key>"
bucket = "<qiniu-bucket>"
url = "http://example.com"

[schedule]
url = "http://192.168.181.127/"

[mob]
app_key="abcdefg"
app_secret = "1234567"

[qq]
uri = "http://127.0.0.1:8003"

[cors]
allow_origins= ["http://localhost:500"]
allow_methods = ["GET","POST"]

json

{
  "db": {
    "scheme": "mysql",
    "username": "<database-user>",
    "password": "<database-password>",
    "name": "<database-name>"
  },
  "mongo": {
    "username": "<database-user>",
    "password": "<database-password>",
    "db_name": "<database-name>",
    "host": "localhost"
  },
  "redis": {},
  "rresult": {
    "body": "data",
    "err-msg": "message",
    "fix-field": true,
    "bool-status": { "key": "is-ok" },
    "body-extra-err": "code"
  },
  "auth": {
    "jwt": "<JWT-secret-token>"
  },
  "user": {
    "username": "<root-user-name>",
    "password": "<root-user-password>"
  },
  "log": {
    "level": "info",
    "to_stdout": true
  },
  "qiniu": {
    "access_key": "<qiniu-access-key>",
    "secret_key": "<qiniu-secret-key>",
    "bucket": "<qiniu-bucket>",
    "base_url":"http://example.com"
  },
  "schedule": {
    "url": "http://192.168.181.127/"
  }
}

yml

db:
  scheme: "mysql"
  username: "<database-user>"
  password: "<database-password>"
  name: "<database-name>"

mongo:
  username: "<database-user>"
  password: "<database-password>"
  db_name: "<database-name>"
  host: "localhost"

redis:

rresult:
  body: "data"
  err-msg: "message"
  fix-field: true
  bool-status:
    key: "is-ok"
  body-extra-err: "code"

auth:
  jwt: "<JWT-secret-token>"

user:
  username: "<root-user-name>"
  password: "<root-user-password>"

log:
  level: "info"
  to_stdout: true

qiniu:
  access_key: "<qiniu-access-key>"
  secret_key: "<qiniu-secret-key>"
  bucket: "<qiniu-bucket>"
  url: "https://baseurl.url"
schedule:
  url: "http://192.168.181.127/"

.env