clivern/rabbit

Rabbit Docker镜像文档

镜像概述和主要用途

Rabbit是一个轻量级服务，专注于Go项目的二进制文件构建与存储。它能够接收来自GitHub、GitLab、Bitbucket或Bitbucket Server等版本控制系统(VCS)的新版本通知，自动克隆项目代码，构建多平台二进制文件，并将构建结果进行存储。适用于需要自动化管理Go项目发布流程的场景。

核心功能和特性

• 多VCS集成：支持GitHub、GitLab、Bitbucket及Bitbucket Server的Webhook通知
• 自动化构建：接收新版本通知后自动克隆代码并执行构建
• 多平台支持：可生成不同平台的二进制文件（通过goreleaser实现）
• 灵活配置：支持通过配置文件和环境变量自定义服务行为
• 存储管理：指定构建文件和发布文件的存储路径
• 任务队列：支持原生队列和Redis队列两种任务处理模式
• 日志管理：可配置日志级别、输出方式和格式（支持JSON格式）

使用场景和适用范围

• Go项目自动化发布：替代手动构建流程，实现新版本自动构建
• CI/CD流程集成：作为Go项目持续集成/持续部署的构建环节
• 多平台二进制分发：集中管理不同操作系统和架构的二进制文件
• 团队协作开发：确保团队成员使用统一版本的构建产物
• 开源项目维护：自动处理开源Go项目的发布构建需求

详细使用方法和配置说明

环境要求

• Docker环境
• （可选）Redis服务（用于队列和数据存储）
• （可选）SSH密钥配置（用于克隆需要SSH权限的代码仓库）

Docker部署示例

使用docker run命令

bash
docker run -d \
  --name rabbit \
  -p 8080:8080 \
  -v ~/.ssh:/root/.ssh \
  -v /path/to/releases:/app/var/releases \
  -v /path/to/build:/app/var/build \
  -e RABBIT_APP_MODE=prod \
  -e RABBIT_REDIS_ADDR=redis:6379 \
  -e RABBIT_INTEGRATION_GITHUB_WEBHOOK_SECRET=your_github_secret \
  clivern/rabbit

使用docker-compose配置

1. 克隆项目并进入Docker部署目录：

bash
git clone https://github.com/Clivern/Rabbit.git
cd Rabbit/deployments/docker

2. 创建docker-compose.yml配置（或使用项目自带配置）：

yaml
version: '3'

services:
  rabbit:
    build: ../../
    ports:
      - "8080:8080"
    volumes:
      - ~/.ssh:/root/.ssh
      - ./releases:/app/var/releases
      - ./build:/app/var/build
    environment:
      - RABBIT_APP_MODE=prod
      - RABBIT_APP_PORT=8080
      - RABBIT_REDIS_ADDR=redis:6379
      - RABBIT_BROKER_DRIVER=redis
      - RABBIT_LOG_LEVEL=info
      - RABBIT_INTEGRATION_GITHUB_WEBHOOK_SECRET=your_github_webhook_secret
    depends_on:
      - redis

  redis:
    image: redis:alpine
    ports:
      - "6379:6379"
    volumes:
      - redis_data:/data

volumes:
  redis_data:

3. 启动服务：

bash
docker-compose build
docker-compose up -d

配置参数说明

Rabbit的配置可通过环境变量或配置文件进行设置，环境变量优先级高于配置文件。以下是主要配置项说明：

应用基本配置

Redis配置

任务队列配置

构建和发布配置

VCS集成配置

以GitHub为例：

GitLab、Bitbucket等配置类似，只需将环境变量前缀中的GITHUB替换为对应平台名称（如GITLAB、BITBUCKET等）。

注意事项

1. SSH密钥配置：当需要克隆私有仓库时，需确保容器内的~/.ssh目录包含正确的SSH密钥，且远程VCS已添加到known_hosts。
2. 资源需求：构建过程依赖goreleaser，建议根据项目复杂度调整资源配置，初始可将build.parallelism设为1。
3. 日志管理：生产环境建议将日志输出到文件（设置RABBIT_LOG_OUTPUT为文件路径）并配置日志轮转。
4. 安全配置：务必设置Webhook密钥（如RABBIT_INTEGRATION_GITHUB_WEBHOOK_SECRET）以验证Webhook请求合法性。