amd64/sonarqube

SonarQube Docker镜像文档

注意： 这是https://hub.docker.com/_/sonarqube%E7%9A%84%60amd64%60%E6%9E%B6%E6%9E%84%E6%9E%84%E5%BB%BA%E7%89%88%E6%9C%AC%E5%BA%93%E2%80%94%E2%80%94%E6%9B%B4%E5%A4%9A%E4%BF%A1%E6%81%AF%E8%AF%B7%E5%8F%82%E8%A7%81%E5%AE%98%E6%96%B9%E9%95%9C%E5%83%8F%E6%96%87%E6%A1%A3%E4%B8%AD%E7%9A%84%E2%80%9Chttps://github.com/docker-library/official-images#architectures-other-than-amd64%E2%80%9D%E5%92%8C%E5%AE%98%E6%96%B9%E9%95%9C%E5%83%8FFAQ%E4%B8%AD%E7%9A%84%E2%80%9Chttps://github.com/docker-library/faq#an-images-source-changed-in-git-now-what%E2%80%9D%E3%80%82

快速参考

• 维护者：
  https://github.com/SonarSource/docker-sonarqube

• 获取帮助：
  SonarSource社区论坛、Docker社区论坛、Docker社区Slack或Stack Overflow

支持的标签及对应的Dockerfile链接

• https://github.com/SonarSource/docker-sonarqube/blob/4f77dc7067a3ed7761c56361e40ad7dda3cd9d6c/commercial-editions/developer/Dockerfile

• https://github.com/SonarSource/docker-sonarqube/blob/4f77dc7067a3ed7761c56361e40ad7dda3cd9d6c/commercial-editions/enterprise/Dockerfile

• https://github.com/SonarSource/docker-sonarqube/blob/4f77dc7067a3ed7761c56361e40ad7dda3cd9d6c/commercial-editions/datacenter/app/Dockerfile

• https://github.com/SonarSource/docker-sonarqube/blob/4f77dc7067a3ed7761c56361e40ad7dda3cd9d6c/commercial-editions/datacenter/search/Dockerfile

• https://github.com/SonarSource/docker-sonarqube/blob/52f6f8a3a79daf2f4ed53b9f6313df16dcbb710a/commercial-editions/developer/Dockerfile

• https://github.com/SonarSource/docker-sonarqube/blob/52f6f8a3a79daf2f4ed53b9f6313df16dcbb710a/commercial-editions/enterprise/Dockerfile

• https://github.com/SonarSource/docker-sonarqube/blob/52f6f8a3a79daf2f4ed53b9f6313df16dcbb710a/commercial-editions/datacenter/app/Dockerfile

• https://github.com/SonarSource/docker-sonarqube/blob/52f6f8a3a79daf2f4ed53b9f6313df16dcbb710a/commercial-editions/datacenter/search/Dockerfile

• https://github.com/SonarSource/docker-sonarqube/blob/***a6b668d26878ea8d063d66677247272f38/commercial-editions/developer/Dockerfile

• https://github.com/SonarSource/docker-sonarqube/blob/***a6b668d26878ea8d063d66677247272f38/commercial-editions/enterprise/Dockerfile

• https://github.com/SonarSource/docker-sonarqube/blob/***a6b668d26878ea8d063d66677247272f38/commercial-editions/datacenter/app/Dockerfile

• https://github.com/SonarSource/docker-sonarqube/blob/***a6b668d26878ea8d063d66677247272f38/commercial-editions/datacenter/search/Dockerfile

• https://github.com/SonarSource/docker-sonarqube/blob/a5d28439b45d0a6002290fd28bf1b481c0182bb6/community-build/Dockerfile

快速参考（续）

• 问题反馈地址：
  https://github.com/SonarSource/docker-sonarqube/issues?q=

• 支持的架构： (https://github.com/docker-library/official-images#architectures-other-than-amd64)
  https://hub.docker.com/r/amd64/sonarqube/, https://hub.docker.com/r/arm64v8/sonarqube/

• 镜像 artifact 详情：
  https://github.com/docker-library/repo-info/blob/master/repos/sonarqube (https://github.com/docker-library/repo-info/commits/master/repos/sonarqube)
  （镜像元数据、传输大小等）

• 镜像更新：
  https://github.com/docker-library/official-images/issues?q=label%3Alibrary%2Fsonarqube
  https://github.com/docker-library/official-images/blob/master/library/sonarqube (https://github.com/docker-library/official-images/commits/master/library/sonarqube)

• 本文档来源：
  https://github.com/docker-library/docs/tree/master/sonarqube (https://github.com/docker-library/docs/commits/master/sonarqube)

什么是 sonarqube？

sonarqube Docker 仓库存储 SonarQube Server 和 SonarQube Community Build 的官方 Sonar 镜像。

SonarQube Server（前身为 SonarQube）是一款本地部署的分析工具，旨在检测 30 多种语言、框架和 IaC 平台的质量和安全问题。该解决方案还通过 Sonar 的 AI CodeFix 功能提供基于 AI 的修复建议。通过直接与 CI 流水线或支持的 DevOps 平台集成，代码在每次合并/拉取请求时都会根据涵盖代码可维护性、可靠性和安全问题等多个属性的广泛规则集进行检查。

SonarQube Community Build（前身为 SonarQube Community）是 Sonar 的免费自管理版本，按月发布。它包含开源版本中的最新核心功能，提供基本功能，如错误检测、代码异味识别以及对 21 种编程语言和框架的基本安全问题分析。对于高级安全分析、企业级集成和可扩展性功能，可使用商业版本 SonarQube Server。

如何使用此镜像

此处提供 SonarQube Server（开发者版、企业版和数据中心版）以及 SonarQube Community Build 的 Docker 镜像。

Docker 主机要求

由于 SonarQube 使用嵌入式 Elasticsearch，请确保 Docker 主机配置符合 Elasticsearch 生产模式要求 和 文件描述符配置。

例如，在 Linux 上，可通过以 root 用户在主机上运行以下命令为当前会话设置推荐值：

console
sysctl -w vm.max_map_count=524288
sysctl -w fs.file-max=131072
ulimit -n 131072
ulimit -u 8192

演示

要快速运行演示实例，请参见 试用 SonarQube 页面上的“使用 Docker”部分。准备好进行更可持续的设置时，请花时间阅读下面的“安装”和“配置”部分。

安装

多平台支持： 从 SonarQube 9.9 LTS 开始，Docker 镜像支持在 amd64 架构和基于 arm64 的 Apple Silicon (M1) 上运行。

有关安装说明，请参见 安装服务器 页面上的“从 Docker 镜像安装服务器”。

要使用 SonarQube Server 数据中心版运行集群，请参见 集群安装服务器 页面上的“从 Docker 镜像安装 SonarQube Server”。

Docker 镜像上的 lts 标签会随每个新的 LTS 版本更新。如果要避免自动重大升级，建议使用对应的 9.9-<edition> 标签而非 lts-<edition>。

配置

端口绑定

默认情况下，容器内运行的服务器将监听 9000 端口。可通过在 docker run 命令中添加 -p 9000:9000 参数将容器端口 9000 映射到主机端口 9000，如下所示：

console
docker run --name sonarqube-custom -p 9000:9000 amd64/sonarqube:community

然后可在 Web 浏览器中访问 http://localhost:9000 或 http://host-ip:9000 打开 Web 界面。

数据库

默认情况下，镜像使用嵌入式 H2 数据库，不适用于生产环境。

警告： 只有一个 SonarQube Server 或 SonarQube Community Build 实例可以连接到一个数据库模式。如果使用 Docker Swarm 或 Kubernetes，请确保多个实例不会同时运行在同一个数据库模式上。这将导致 SonarQube 行为不可预测，并可能损坏数据。如 SONAR-*** 中所述，目前没有相关保护措施。SonarQube Server 数据中心版也有同样的限制，即同一时间只能有一个集群连接到一个数据库模式。

按照 "安装数据库" 部分设置数据库。

使用卷

建议为以下目录创建卷：

• /opt/sonarqube/data：数据文件，如嵌入式 H2 数据库和 Elasticsearch 索引
• /opt/sonarqube/logs：包含 SonarQube 访问日志、Web 进程日志、CE 进程日志、Elasticsearch 日志
• /opt/sonarqube/extensions：用于第三方插件

警告： 不要在多个 SonarQube 实例上使用相同的卷。

升级

有关升级说明，请参见 升级服务器 页面上的“从 Docker 镜像升级”。

高级配置

自定义镜像

在某些环境中，准备包含自定义配置的镜像可能更合理。实现此目的的 Dockerfile 可简化为：

dockerfile
FROM amd64/sonarqube:community
COPY sonar-custom-plugin-1.0.jar /opt/sonarqube/extensions/

然后可通过以下命令构建并试用镜像：

console
$ docker build --tag=sonarqube-custom .
$ docker run -ti sonarqube-custom

避免强制终止

实例将优雅停止，等待所有进行中的任务完成。等待进行中的任务完成可能需要较长时间，而 Docker 默认在停止时不会预期此情况。为避免实例在 10 秒后被 Docker 守护进程终止，最好使用 --stop-timeout 配置容器停止超时时间。例如：

console
docker run --stop-timeout 3600 amd64/sonarqube

管理

有关 SonarQube Server 实例管理的信息，请从 此处 开始。

许可证

SonarQube Community Build 根据 GNU Lesser General Public License, Version 3.0 许可。SonarQube Server 开发者版、企业版和数据中心版根据 SonarSource 条款和条件 许可。

与所有 Docker 镜像一样，这些镜像可能还包含其他软件，这些软件可能受其他许可证（如基础发行版中的 Bash 等，以及主要软件的任何直接或间接依赖项）约束。

可在 https://github.com/docker-library/repo-info/tree/master/repos/sonarqube 中找到一些能够自动检测到的额外许可证信息。

对于任何预构建镜像的使用，镜像用户有责任确保对该镜像的任何使用符合其中包含的所有软件的相关许可证。