配置说明

提示：

所有配置的修改都应该通过环境变量或者默认的配置文件，否则服务重新配置会覆盖其他配置参数。

1. 配置介绍

Docker 启动方式有两种方式可以传入配置：

1. 通过变量 CSGHUB_OMNIBUS_CONFIG
2. 通过配置文件/etc/csghub/csghub.yaml

优先级依次由高到低，并且遵循同样的配置格式。

2. 环境变量

CSGHUB_OMNIBUS_CONFIG 环境变量主要用于 Docker Compose 启动时方便的注入配置，变量格式为 YAML 格式（严格遵循 YAML 格式规范），此变量的参数定义可以参考：

• OpenCSGs/csghub-omnibus/csghub.yaml.sample

3. 配置文件

/etc/csghub/csghub.yaml 配置文件是默认的持久化参数文件。文件中绝大部分参数默认注释，注释值为默认值。文件中依然严格遵循 YAML 格式，否则会导致服务配置报错。

4. 常用参数

• csghub

  • external_url

    默认值 http://csghub.example.com。

    定义访问 CSGHub 实例的 URL 地址。强烈建议使用域名。虽然可以配置使用 IP 地址进行访问，但是可能会导致部分功能不可用。

• nginx

  • ssl_certificate/ssl_certificate_key

    默认未配置。

    启用 TLS 访问需要的域名证书。

  • rate_limit

    默认未配置。

    设置访问的速率限制。

• server

  • postgresql

    默认未配置，即使用内置的 PostgreSQL 数据库。

    配置后即使用外置的数据，但是这并不会自动禁用内置的数据库，需要通过如下方式禁用：

    postgresql:
      enable: false

    注意：实例中存在多个服务依赖此数据库，例如 portal，casdoor，temporal 等。

  • redis

    默认未配置，即使用内置的 Redis 数据库。

    控制行为同 PostgreSQL。

  • gitaly

    默认未配置，即使用内置的 Gitaly 存储服务。

    如果需要使用外置 Gitaly 集群，可以联系工程师咨询部署方式。

  • s3

    默认未配置，即使用内置的 Minio 对象存储。

    控制行为同 PostgreSQL。

  • dataflow

    默认未启用。

    通过此参数对接到通过 Dataflow Chart 部署的 Dataflow 服务。

    更多参考 Dataflow 配置。

• notifier

  • smtp

    默认未配置。

    启用邮件通知服务。

• gitaly

  • storage

    默认 /var/opt/csghub/gitaly/repositories。

    指定 Git 存储服务的数据目录。如果是非全新安装情况下修改，需要手动拷贝目录下已经创建的数据。

• gitlab_shell

  • ssh_port

    默认 2222。

    指定通过 Git SSH 拉取代码的服务端口。

• minio

  • auth

    默认未配置，自动生成。

    指定默认的管理员账户。

• postgresql

  • data_dir

    默认 /var/opt/csghub/postgresql/data。

    指定数据库的默认数据文件目录。

  • 其他运行参数

    部分参数会根据硬件环境进行计算，部分参数在列表中可配置，例如：

    • max_connections
    • shared_buffers
    • checkpoint_timeout
    • ...

5. 更多参考

完整参数列表请查看：

• OpenCSGs/csghub-omnibus/csghub.yaml.sample