安装配置

1. 概述

CSGHub 提供 Docker 一键部署方式，通过 Docker Compose 快速启动 All-in-One 完整服务栈，无需复杂的依赖配置，可快速完成服务部署与启动。

适用场景：

• 快速体验 CSGHub 全量基础功能，完成功能验证；
• 开发、测试环境快速部署，降低环境搭建成本；
• 中小企业级生产环境部署，满足日常使用需求。

2. 优势

• 简化管理：通过 Docker Compose 统一编排所有服务依赖，无需单独部署、配置各组件，降低运维复杂度；
• 快速部署：一键启动完整 CSGHub 服务栈，无需手动配置依赖关系，部署效率大幅提升；
• 灵活扩展：支持横向扩展和多机部署，可根据业务需求灵活调整资源配置；
• 生产就绪：经过优化适配，可直接用于中小企业级生产环境，保障服务稳定运行。

3. 启动说明

CSGHub Docker 部署支持两种运行模式，可根据实际需求选择，具体说明如下：

模式	功能范围	依赖环境
基本功能	除模型评测、推理、微调、应用空间、MCP 外的所有基础功能	无需 Kubernetes 集群，仅需 Docker 及 Docker Compose
完整功能	包含全部 CE/EE 版本功能，支持模型相关高级操作	需提前准备 Kubernetes 集群，满足高级功能运行需求

⚠️ 注意：

• 使用 IP 地址访问时，MCP 功能受限（强烈建议使用域名）。
• Docker方式不包含 Dataflow / Runner 服务，对应服务需要通过 Chart 进行部署。

4. 快速启动

Docker 部署方式虽然是单容器启动，但是因为配置较多，这里建议使用 Docker Compose 启动。以下是docker-compose.yaml示例文件：

1. 创建docker-compose.yaml

   创建配置文件，复制以下内容（可根据实际需求调整端口、挂载路径等配置）：

   services:
     csghub:
       container_name: csghub-omnibus
       # `latest` defaults to the latest release version of ee.
       image: opencsg-registry.cn-beijing.cr.aliyuncs.com/opencsghq/omnibus-csghub:latest
       restart: always
       
       # Use block scalar style for better readability of complex configs
       environment:
         CSGHUB_OMNIBUS_CONFIG: |
           csghub:
             external_url: "http://csghub.example.com"
       
       # Ports mapping for accessing
       ports:
         - '80:80'
         - '2222:2222'
         - '8000:8000'
         - '9000:9000'
         
       # Restored original volume paths with explicit consistency
       volumes:
         - ./csghub/etc:/etc/csghub
         - ./csghub/logs:/var/log/csghub
         - ./csghub/data:/var/opt/csghub
         - ./csghub/.kube:/etc/csghub/.kube:ro
       
       # Operational hardening
       healthcheck:
         test: ["CMD", "curl", "-f", "http://localhost:8080/healthz"]
         interval: 30s
         timeout: 10s
         retries: 3
         start_period: 30s
   
       # Resource allocation and constraints
       deploy:
         resources:
           limits:
             cpus: 4
             memory: 8G
   
   networks:
     default:
       name: csghub_network

   更多参考：

   • 版本：可获取所有可用的 CE/EE 版本标签，按需指定镜像版本；
   • 配置：获取更多详细配置项参考；
   • 修改端口号映射：若默认端口冲突，可参考此链接调整端口配置。

2. 启动服务

   在 docker-compose.yaml 文件所在目录，执行以下命令启动服务：

   docker compose up -d && docker compose ps

3. 查看服务状态

   执行以下命令，查看 CSGHub 所有服务的运行状态，确认服务正常启动：

   docker exec -it csghub-omnibus csghub-ctl status

4. 实例访问

   访问地址：external_url

   访问凭据： docker exec -it csghub-omnibus cat /etc/csghub/init_root_password

5. 服务管理

CSGHub 提供csghub-ctl 和 csghub-psql 两个核心命令工具，用于服务日常管理与维护，详细说明如下：

5.1 csghub-ctl

该工具用于管理 CSGHub 所有服务，支持多种操作命令。

核心命令说明：

• reconfigure

  如果在容器中通过配置文件/etc/csghub/csghub.yaml文件修改配置后，可以通过此命令刷新所有服务的配置，对应服务配置变化会自动重启服务。

• praefect

  继承 GitLab Gitaly Praefect 所有子命令，用于操作 Praefect Gitaly 集群。

• consul

  继承 HashiCorp Consul 所有子命令，用于操作 Consul 集群。

• psql

  继承 PostgreSQL PSQL 所有组命令，用于操作 PostgreSQL 数据库。

• patroni

  继承 Patroni Patroni-CTL 命令，用于操作 PostgreSQL Patroni 集群。

• mc

  继承 HashiCorp Minio mc 命令，用于操作 Minio。

• kyml

  用于验证 Kubernetes YAML 资源清单，包含创建，更新，重建等操作。

• creds

  用于获取常用的服务组件的凭据。

• tail

  实时查看某个服务或者所有服务日志。

• status

  查看某个或所有服务状态。

• start/stop/restart/enable/disable

  略

5.2 csghub-psql

通过该命令可快速登录到 CSGHub 内置的 PostgreSQL 数据库，无需手动输入数据库地址、用户名等信息，简化数据库操作流程，直接执行以下命令即可登录：

---

6. 更多反馈

若在安装配置过程中遇到问题，或有功能建议，可通过以下链接提交反馈，获取技术支持：

• 提交反馈