clickvisual 配置说明

本文主要对 clickvisual 启动的配置项做详细说明。

app 段配置说明：

  1. [app]
  2. # OAuth 签发 hashStatecode 所需的 secretKey
  3. secretKey = "secretKey"
  4. # 如果配置了 clickvisual 域名，需要将 rootURL 配置为 clickvisual 域名　　　　　　　
  5. rootURL = "https://dev.clickvisual.com/"
  6. # 登录后默认访问的 URL　
  7. baseURL = "/api/admin/login/"
  8. # 日志查询中需要隐藏的元数据字段　　　　
  9. hiddenFields = ["_cluster_", "_log_agent_", "_node_ip_", "_node_name_", "_time_second_", "_time_nanosecond_", "_source_"]
  10. # 日志查询中需要显示的元数据字段
  11. defaultFields = ["_namespace_","_container_name_","_pod_name_","_time_second_"]
  12. # 菜单配置文件，酌情调整菜单权限文件路径
  13. permissionFile = "./config/resource.yaml"

logger 段配置说明：

  1. [logger]
  2. # 日志等级，可选 debug|info|warn|error|panic|fatal，建议测试环境选择 debug，生产环境选择 error
  3. level = "debug"
  4. # 日志输出 writer，可选 file|stderr
  5. writer = "stderr"
  6. # 如果 writer 是 file，dir 配置有效，表示输出日志文件目录
  7. dir = "./logs"
  8. # 如果 writer 是 file，name 配置有效，表示日志文件名
  9. name = "default.log"

server 段配置说明：

  1. # clickvisual API Server 配置
  2. [server.http]
  3. # 启动的 HTTP API Server Host
  4. host = "0.0.0.0"
  5. # 启动的 HTTP API Server Port
  6. port = 9001
  8. # clickvisual governor Server 配置，governor 用户提供 metrics 采集、profling 调试、日志级别调整等。
  9. [server.governor]
  10. # 启动的 HTTP Governor Server Host
  11. host = "0.0.0.0"
  12. # 启动的 HTTP Governor Server Port
  13. port = 9003

mysql 段配置说明

  1. [mysql]
  2. # 连接的最大存活时间，默认300s
  3. connMaxLifetime = "300s"
  4. # 是否开启 debug 模式，debug 模式下会打印 plain sql
  5. debug = true
  6. # MySQL 实例的 DSN 连接串
  7. dsn = "root:root@tcp(127.0.0.1:3306)/clickvisual?charset=utf8mb4&collation=utf8mb4_general_ci&parseTime=True&loc=Local&readTimeout=1s&timeout=1s&writeTimeout=3s"
  8. # 日志级别
  9. level = "error"
  10. # 最大空闲连接数
  11. maxIdleConns = 5
  12. # 最大活动连接数
  13. maxOpenConns = 50

auth 段配置说明

  1. [auth]
  2. # 使用 redis 存储用户 session
  3. mode = "redis"
  4. # 组件名，默认 clickvisual-session
  5. name = "clickvisual-session"
  6. keypairs = "secret"
  7. redisSize = 10
  8. redisNetwork = "tcp"
  9. # redis 实例地址，默认使用 127.0.0.1:6379，你可以修改为自己的 redis 地址
  10. redisAddr = "127.0.0.1:6379"
  11. # redis 实例密码，默认为空
  12. redisPassword = "
  14. # 匿名访问配置
  15. [auth.anonymous]
  16. # 是否允许匿名访问
  17. enabled = false
  19. # auth 代理配置
  20. [auth.proxy]
  21. # 是否允许开启代理模式
  22. enabled = true
  23. # 代理模式下默认使用 'X-clickvisual-USER' 读取 username
  24. headerName = "X-clickvisual-USER"
  26. # 第三方登录配置
  27. [[auth.tps]]
  28. # 第三方登录类型，此处设置为 'github'
  29. typ = "github"
  30. # 是否启用
  31. enable = true
  32. # 是否静默注册
  33. allowSignUp = true
  34. # 应用 Client ID
  35. clientId = ""
  36. # 应用 Client Secret
  37. clientSecret = ""
  38. # 授权范围
  39. scopes = ["user:email", "read:org"]
  40. # 第三方授权地址
  41. authUrl = "https://github.com/login/oauth/authorize"
  42. # 第三方获取 access_token 地址
  43. tokenUrl = "https://github.com/login/oauth/access_token"
  44. # 第三方 api 地址
  45. apiUrl = "https://api.github.com/user"
  46. allowedDomains = []
  47. teamIds = []
  48. allowedOrganizations = []
  50. # 第三方登录配置
  51. [[auth.tps]]
  52. typ = "gitlab"
  53. enable = true
  54. allowSignUp = true
  55. clientId = ""
  56. clientSecret = ""
  57. scopes = ["api"]
  58. authUrl = "https://mygitlab.com/oauth/authorize"
  59. tokenUrl = "https://mygitlab.com/oauth/token"
  60. apiUrl = "https://mygitlab.com/api/v4"
  61. allowedDomains = []
  62. teamIds = []
  63. allowedOrganizations = []