mbopm/sonarqube

SonarQube Docker镜像文档

镜像概述和主要用途

本镜像基于SonarQube官方社区版镜像构建，预安装多种实用插件，并内置默认健康检查机制。通过优化插件管理方式，支持将扩展目录挂载为卷时保持插件配置持久化，避免每次启动重置插件状态。适用于需要快速部署具备增强功能的代码质量分析平台的场景。

核心功能和特性

预安装插件

• sonar-apple-plugin：支持Swift和Objective-C语言代码分析
• sonar-dependency-check-plugin：检查项目依赖中的安全漏洞
• sonar-shellcheck-plugin：提供Shell脚本代码质量检查
• sonar-yaml-plugin：支持YAML文件的语法和质量分析
• sonarqube-community-branch-plugin：添加分支分析功能

插件持久化机制

首次启动时，容器会将/opt/sonarqube/docker/plugins/*.jar路径下的插件复制到/opt/sonarqube/extensions/plugins/目录，并创建/opt/sonarqube/extensions/plugins/initialised文件标记完成。后续启动将跳过此步骤，确保通过卷挂载/opt/sonarqube/extensions时插件配置不会丢失。

默认健康检查

内置健康检查配置，可直接用于容器状态监控。

使用场景和适用范围

• 需要多语言（包括Swift、Objective-C、Shell、YAML）代码质量分析的开发团队
• 需对项目依赖进行安全漏洞扫描的场景
• 使用分支开发模式，需要分支级代码质量分析的项目
• 希望快速部署并持久化插件配置的SonarQube环境

使用方法和配置说明

前置要求

• Docker Engine 19.03+
• Docker Compose 2.0+（推荐使用）
• 至少2GB内存（SonarQube运行要求）

Docker Compose部署示例

以下是完整的docker-compose.yml配置，包含SonarQube和PostgreSQL数据库（推荐搭配使用）：

yaml
services:
  sonarqube:
    image: mbopm/sonarqube:latest
    ports:
      - "127.0.0.1:9000:9000"  # 映射Web界面端口到本地
    volumes:
      - sonarqube_data:/opt/sonarqube/data:rw        # 数据持久化卷
      - sonarqube_logs:/opt/sonarqube/logs:rw        # 日志持久化卷
      - sonarqube_extensions:/opt/sonarqube/extensions:rw  # 扩展（含插件）持久化卷
      - sonarqube_temp:/opt/sonarqube/temp:rw        # 临时文件卷
    environment:
      SONAR_JDBC_URL: jdbc:postgresql://postgres:5432/sonar  # PostgreSQL连接URL
      SONAR_JDBC_USERNAME: sonar                          # 数据库用户名
      SONAR_JDBC_PASSWORD: sonar_pass                     # 数据库密码
    depends_on:
      postgres:
        condition: service_healthy  # 等待PostgreSQL健康后启动

  postgres:
    image: postgres:17-alpine  # PostgreSQL数据库镜像
    environment:
      POSTGRES_DB: sonar        # 数据库名称
      POSTGRES_USER: sonar      # 数据库用户
      POSTGRES_PASSWORD: sonar_pass  # 数据库密码
      PGDATA: /var/lib/postgresql/data/pgdata  # 数据库数据存储路径
    volumes:
      - postgres_data:/var/lib/postgresql/data:rw  # 数据库数据持久化卷
    healthcheck:
      test: [ "CMD-SHELL", "sh -c 'pg_isready -U sonar -d sonar'" ]  # 健康检查命令
      interval: 5s        # 检查间隔
      timeout: 5s         # 超时时间
      retries: 10         # 重试次数

volumes:
  sonarqube_data:
  sonarqube_logs:
  sonarqube_extensions:
  sonarqube_temp:
  postgres_data:

关键配置说明

环境变量

• SONAR_JDBC_URL：数据库连接URL，需指向PostgreSQL实例（推荐）
• SONAR_JDBC_USERNAME：数据库访问用户名
• SONAR_JDBC_PASSWORD：数据库访问密码

卷挂载

• sonarqube_extensions：必须挂载以确保插件持久化，避免重启后插件丢失
• sonarqube_data：存储分析数据、配置等核心信息
• sonarqube_logs：存储应用日志
• sonarqube_temp：临时文件存储

启动步骤

1. 保存上述docker-compose.yml文件到本地
2. 执行命令docker-compose up -d启动服务
3. 等待约1-2分钟，访问http://127.0.0.1:9000
4. 使用默认账号（admin/admin）登录，首次登录需修改密码

验证插件

登录后，进入Administration > Marketplace，可查看已安装的插件列表，确认预安装插件已正确加载。