adrianmusante/sonarqube

docker-sonarqube

SonarQube™是一个开源质量管理平台，用于分析和度量代码的技术质量。它使开发人员能够在早期阶段检测代码问题、漏洞和缺陷。

本打包的SonarQube Docker镜像基于官方SonarQube社区版二进制文件，但包含一些额外功能和插件，以增强其功能和可用性。

SonarQube™概述

附加组件

预安装插件：

• https://github.com/mc1arke/sonarqube-community-branch-plugin%EF%BC%9A%E6%94%AF%E6%8C%81GitHub%E3%80%81GitLab%E7%AD%89%E5%B9%B3%E5%8F%B0%E7%9A%84%E5%88%86%E6%94%AF%E5%92%8C%E6%8B%89%E5%8F%96%E8%AF%B7%E6%B1%82%E5%88%86%E6%9E%90%E3%80%82

额外功能：

• 无人值守迁移
• 健康检查命令行工具
• 默认启用Gravatar
• 启动时从环境变量刷新配置（注意：管理员用户仅在首次启动时加载）

Docker仓库

获取SonarQube Docker镜像的推荐方式是从https://hub.docker.com/r/adrianmusante/sonarqube%E6%8B%89%E5%8F%96%E9%A2%84%E6%9E%84%E5%BB%BA%E9%95%9C%E5%83%8F%E3%80%82

要使用特定版本，可以拉取带版本标签的镜像。您可以在Docker Hub仓库中查看https://hub.docker.com/r/adrianmusante/sonarqube/tags/%E3%80%82

• https://github.com/adrianmusante/docker-sonarqube/blob/main/sonarqube/Dockerfile

支持的架构：

• x86-64: linux/amd64
• ARM64: linux/arm64

配置

如何使用此镜像

SonarQube™需要访问PostgreSQL数据库来存储信息。您可以使用任何PostgreSQL数据库服务器，无论是在单独的容器中运行还是在远程主机上。

该仓库包含一个示例https://github.com/adrianmusante/docker-sonarqube/blob/main/docker-compose.example.yml%E6%96%87%E4%BB%B6%EF%BC%8C%E5%B1%95%E7%A4%BA%E4%BA%86%E5%A6%82%E4%BD%95%E9%80%9A%E8%BF%87Docker Compose使用官方https://hub.docker.com/_/postgres%E8%BF%90%E8%A1%8CSonarQube%E3%80%82

SonarQube实例将可通过http://localhost:9000访问（如果不是在本地运行Docker，则为http://<your-docker-host-ip>:9000）。可以通过修改docker-compose.yml文件的ports部分更改端口。此外，您可以通过设置SONARQUBE_PORT_NUMBER环境变量更改容器内的端口。

环境变量

启动SonarQube镜像时，您可以通过在docker-compose文件或docker run命令行中传递一个或多个环境变量来调整实例配置。

以下部分描述了用于配置SonarQube实例的可用环境变量。

可自定义环境变量

[!NOTE] 可以使用_FILE后缀提供环境变量。值将从环境变量指定的文件中读取，遵循标准Docker密钥处理机制。 这允许您将敏感数据（如密码）安全地注入容器，而无需直接在环境变量中公开它们。

只读环境变量

持久化应用数据

如果删除容器，所有数据都将丢失，下次运行镜像时数据库将重新初始化。为避免数据丢失，应挂载一个在容器删除后仍能持久化的卷。

为实现持久化，应在/sonarqube路径挂载目录。如果挂载的目录为空，将在首次运行时初始化。此外，还应挂载PostgreSQL数据卷以实现持久化。

若要避免意外删除卷，可以将主机目录挂载为数据卷。或者，您可以使用卷插件托管卷数据。

按照本仓库中包含的Docker Compose示例，您可以修改https://github.com/adrianmusante/docker-sonarqube/blob/main/docker-compose.example.yml%E6%96%87%E4%BB%B6%EF%BC%8C%E4%BD%BF%E7%94%A8%E4%B8%BB%E6%9C%BA%E7%9B%AE%E5%BD%95%E8%80%8C%E9%9D%9EDocker%E5%91%BD%E5%90%8D%E5%8D%B7%E3%80%82%E4%BB%A5%E4%B8%8B%E6%98%AF%E4%BF%AE%E6%94%B9%E7%A4%BA%E4%BE%8B%EF%BC%9A

diff
   sonarqube-db:
     ...
     volumes:
-      - sonarqube_db:/var/lib/postgresql
+      - /path/to/sonarqube/db:/var/lib/postgresql
   ...
   sonarqube:
     ...
     volumes:
-      - sonarqube:/sonarqube
+      - /path/to/sonarqube/data:/sonarqube
   ...
-volumes:
-  sonarqube_db:
-    driver: local
-  sonarqube:
-    driver: local

使用主机目录进行持久化时，请注意此容器以非root用户运行。因此，任何挂载的文件和目录必须具有UID 1001的正确权限。建议在首次运行Docker之前创建目录并设置正确的权限或所有权，以确保Docker不会以不兼容的权限创建它。

如果权限设置不正确，您可能会在容器日志中看到如下错误消息：mkdir: cannot create directory ‘/sonarqube/data’: Permission denied

您可以使用以下命令将所有权设置为1001:1001：

console
$ mkdir -p /path/to/sonarqube
$ chown -R 1001:1001 /path/to/sonarqube

或者，您可以将权限设置为777（所有人可读、可写、可执行）：

console
$ mkdir -p /path/to/sonarqube
$ chmod -R 777 /path/to/sonarqube

健康检查

SonarQube镜像包含健康检查命令，用于验证SonarQube Web应用程序是否正常运行。健康检查尝试连接到SonarQube，并通过查询/api/system/status端点分析应用程序状态。当应用程序状态为UP或通过health-check命令行工具的-s选项提供的任何其他状态时，健康检查将成功。

console
$ health-check -h
用于检查SonarQube是否健康的工具。

用法: health-check [选项] ...
部分选项包括:
    -u <HEALTH_CHECK_URL>       用于检查SonarQube状态的URL。（可选）

    -s <STATUS>                 重复此选项可添加更多有效状态。可能的状态:
                                  - STARTING: 服务器初始化进行中
                                  - UP: SonarQube实例正常运行（始终作为有效状态添加）
                                  - DOWN: 实例已启动但未运行（例如，由于迁移失败）
                                  - RESTARTING: 已请求重启
                                  - DB_MIGRATION_NEEDED: 需要数据库迁移
                                  - DB_MIGRATION_RUNNING: 数据库迁移进行中

    -h                          显示此帮助并退出

示例:
    - health-check
    - health-check -u http://my-host:9000/api/system/status
    - health-check -s STARTING -s RESTARTING
    - health-check -s DB_MIGRATION_NEEDED -s DB_MIGRATION_RUNNING

此命令默认不运行。您可以在容器内手动运行它，或添加到编排工具（如Docker Compose、Kubernetes等）中监控SonarQube实例的健康状态。

例如，要将健康检查添加到docker-compose.yml文件，可以使用以下配置：

yaml
services:
  sonarqube:
    # ...
    healthcheck:
      test: health-check
      start_period: 3m
      start_interval: 10s
      interval: 1m
      timeout: 10s
      retries: 3

[!IMPORTANT] 如果SonarQube实例未完全启动（包括需要数据库迁移或迁移进行中），健康检查将失败。如果将SONARQUBE_SKIP_MIGRATION环境变量设置为yes，建议使用-s DB_MIGRATION_NEEDED -s DB_MIGRATION_RUNNING选项将这些状态视为健康。

问题反馈

如果您对此镜像有任何问题或疑问，请通过https://github.com/adrianmusante/docker-sonarqube/issues%E4%B8%8E%E6%88%91%E8%81%94%E7%B3%BB%E3%80%82