confkeeper文档

    快速开始

    Warning

    dev-0.0.x为内部版本，0.1.x后为开源版本, 开源版本会覆盖latest

    注意: 从内部版本dev-0.0.26开始,后端框架从Hertz重构为Gin

    启动命令

    docker
    docker-compose
    #!/bin/bash

docker rm -f confkeeper

docker run -id \
--name=confkeeper \
--restart=always \
--network=host \
--health-cmd="wget --no-verbose --tries=1 --spider http://localhost:8888/api/ping || exit 1" \
--health-interval=30s \
--health-timeout=10s \
--health-retries=3 \
-v /etc/localtime:/etc/localtime:ro \
-v /etc/timezone:/etc/timezone:ro \
-v $(pwd)/config/config.yaml:/app/config/config.yaml:ro \
buyfakett/confkeeper \
-p=8888 \
-c=/app/config/config.yaml

    配置

    Tip

    所有配置的优先级是命令行>环境变量>指定配置文件>默认配置文件

    环境变量需要在变量前面加上CONFKEEPER_GO,例如端口为CONFKEEPER_GO_SERVER_PORT

    以下是默认配置，可以进行修改

    server:
  port: 8888                    # 监听端口
  log_level: info               # 日志登记
  swagger: true                 # 是否开启swagger
  zone: Asia/Shanghai           # 时区
  captcha_expire_time: 5        # 验证码过期时间(分钟)
admin:
  username: admin               # 默认管理员账号
  password: admin123456         # 默认管理员密码
jwt:
  secret: 123qazwsxedc456       # 需要修改成随机数
  expire_time: 168
db:
  type: sqlite3
  database: confkeeper
captcha:
  length: 6                     # 验证码长度
  noise_count: 50               # 验证码干扰个数
ldap:
  enabled: false                # 是否启用 LDAP 认证 (true: 开启, false: 关闭)
  addr: "127.0.0.1:389"         # LDAP 服务器地址与端口 (标准端口 389, LDAPS 端口 636)
  base_dn: "dc=example,dc=com"  # 基础判别名：搜索用户的起始根节点 (通常是域名拆分)
  bind_dn: ""                   # 绑定 DN：用于登录 LDAP 进行查询的管理员账号 (如: "cn=admin,dc=example,dc=com")
  bind_pass: ""                 # 绑定密码：上述管理员账号的密码
  tls: false                    # 是否启用 TLS 加密传输 (建议在生产环境中开启以防止明文传输)
    Tip

    数据库配置可以配置多种类型

    db:
  type: postgres           # 如果要用mysql，改成mysql
  host: xxx
  port: 5432
  user: postgres
  password: xxx
  database: test