10分钟上手Docker-Sonarqube：从安装到首次代码扫描的完整教程

【免费下载链接】docker-sonarqube :whale: SonarQube in Docker 项目地址: https://gitcode.com/gh_mirrors/do/docker-sonarqube

Docker-Sonarqube是一款强大的代码质量和安全性分析工具，通过Docker容器化部署，让开发者能够快速搭建代码检测环境。本教程将带你在10分钟内完成从安装到首次代码扫描的全过程，帮助你轻松掌握代码质量检测的基本方法。

一、准备工作：环境要求与前置条件

在开始之前，请确保你的系统满足以下条件：

• 已安装Docker和Docker Compose
• 至少2GB内存和20GB可用磁盘空间
• 网络连接正常（用于拉取Docker镜像）

如果你还没有安装Docker，可以参考Docker官方文档进行安装。本项目提供了多种部署方案，适用于不同场景需求。

二、快速部署：使用Docker Compose一键启动

项目中提供了多个预配置的Docker Compose文件，位于example-compose-files目录下。对于新手用户，推荐使用PostgreSQL数据库的配置方案，步骤如下：

1. 克隆项目仓库：

git clone https://gitcode.com/gh_mirrors/do/docker-sonarqube
cd docker-sonarqube

2. 进入PostgreSQL配置目录：

cd example-compose-files/sq-with-postgres

3. 启动服务：

docker-compose up -d

这个配置会自动创建两个容器：SonarQube服务和PostgreSQL数据库。关键配置包括：

• SonarQube使用社区版镜像
• 映射9000端口用于Web访问
• 使用命名卷持久化数据
• 配置数据库连接参数

三、访问SonarQube：首次登录与基本配置

服务启动后，通过浏览器访问http://localhost:9000即可打开SonarQube界面。首次登录使用默认 credentials：

• 用户名：admin
• 密码：admin

登录后系统会提示你修改密码，建议设置一个安全的新密码。之后你可以：

• 配置默认语言和质量配置文件
• 设置通知偏好
• 管理用户和权限

四、执行首次代码扫描：三种常用方法

4.1 使用Sonar Scanner命令行工具

1. 安装Sonar Scanner（参考SonarQube官方文档）

2. 在你的项目根目录执行：

sonar-scanner \
  -Dsonar.projectKey=my-project \
  -Dsonar.sources=. \
  -Dsonar.host.url=http://localhost:9000 \
  -Dsonar.login=你的令牌

4.2 使用项目中的脚本（适用于商业版）

项目的商业版提供了便捷的运行脚本，例如commercial-editions/datacenter/app/run.sh，可以通过以下方式使用：

chmod +x commercial-editions/datacenter/app/run.sh
./commercial-editions/datacenter/app/run.sh

这个脚本会自动处理环境变量配置、日志目录创建和集群节点设置等工作。

4.3 集成到CI/CD流程

对于持续集成，你可以将SonarQube扫描集成到你的CI/CD管道中。项目提供的run-public-image-tests.sh和run-tests.sh脚本展示了如何在测试环境中自动化执行代码扫描。

五、分析扫描结果：理解SonarQube报告

扫描完成后，你可以在SonarQube界面查看详细的分析报告，包括：

• 代码覆盖率统计
• bug和漏洞数量
• 代码规范违规情况
• 安全热点和代码异味

通过这些信息，你可以有针对性地改进代码质量。建议定期执行扫描，将代码质量检测融入日常开发流程。

六、进阶配置：自定义与优化

6.1 调整Docker Compose配置

你可以根据需要修改docker-compose.yml文件，例如：

• 调整资源限制
• 配置HTTPS
• 添加自定义插件
• 修改数据库连接参数

6.2 多环境部署

项目提供了多种部署方案：

• sq-with-h2：使用H2内存数据库，适合快速测试
• sq-dce-postgres：数据中心版配置
• sq-dce-custom-zip-postgres：支持自定义插件的配置

七、常见问题与解决方案

7.1 服务启动失败

如果SonarQube无法启动，检查：

• 内存是否足够（至少需要2GB）
• 端口是否被占用
• 数据库连接是否正常

7.2 扫描速度慢

可以通过以下方式优化：

• 排除不必要的目录（在sonar-project.properties中配置）
• 增加SonarQube服务的CPU和内存资源
• 使用增量扫描模式

八、总结与下一步

通过本教程，你已经掌握了Docker-Sonarqube的基本使用方法。接下来你可以：

• 探索项目中的更多配置示例：example-compose-files/
• 学习高级扫描配置：官方文档
• 参与项目贡献：参考CONTRIBUTING.md文件

SonarQube是提升代码质量的强大工具，建议在团队中推广使用，建立持续的代码质量监控机制。

【免费下载链接】docker-sonarqube :whale: SonarQube in Docker 项目地址: https://gitcode.com/gh_mirrors/do/docker-sonarqube