操作 | 时间 | 修改人 | 审核人 |
新增 | 2022/05/01 | 谢金林 |
|
1.SonarQube架构
Sonarqube主要包括前端后端和搜索引擎三部分组成。
具体内容为:
功能 | 组件 | 分组 |
登陆 | 用户登陆 | 前端 |
接口 | openAPI | 前端 |
管理 | 管理界面 | 前端 |
漏洞修复 | 漏洞汇总修复 | 前端 |
扫描引擎 | SonarQube扫描 | 后端 |
存储 | 数据库存储 | 后端 |
搜索 | ElasticSearch | 后端 |
2.部署要求
2.1 数据库:
一般的SonarQube要跑起来需要一个数据库,但是如果是试用的话其自带了一个h2内存数据库可以进行测试或是验证试用。本文档使用的内嵌h2数据库但是有条件推荐更换使用postgresql数据库。重新配置数据库参考:Install the Server | SonarQube Docs
2.2 Jdk:
本文档使用的SonarQube为8.0版本其要求Jdk11以上支持。本文档提供的整合包包含了jdk11,详见sonarqube-8.9.8.54436\jdk目录下。
2.3 机器要求:
官方推荐的配置要求较高详见。Prerequisites and Overview | SonarQube Docs
本文档部署的SonarQube用户少量分析和验证使用。可以参考如下配置。
Cpu | 四核i5 | 说明 |
内存 | 16G |
|
存储 | 500g机械/固态250g | 推荐使用固态,机械也没有问题但慢 |
数据库 | H2/postgresql/mysql/oracle/mssqlserver | H2只在验证或是测试使用,长期使用请换用postgresql |
3.如何使用
说明:
文档使用整合包,里面已经整合了Jdk和H2数据库可以直接启动即可使用。
3.1 解压缩到磁盘
将sonarqube-8.9.8.54436.zip压缩包解压缩到磁盘上。
3.2 启动服务
进入到sonarqube-8.9.8.54436\bin目录下找到对应的操作系统目录如windows对应windows-x86-64,执行StartSonar.bat即可启动服务。
等服务启动完毕。
登陆SonarQube 初始化用户名和密码都为admin。
3.3 配置以服务方式启动
如果需要以后台服务方式启动或者每次电脑重启后自动运行可以配置以服务方式启动。
首先关闭已经启动的SonarQube,然后进去对应的启动脚本目录执行如:windows对应windows-x86-64执行StartNTService.bat等待SonarQube启动完毕。
随后可以登陆SonarQube 。
3.4 停止
如果使用StartSonar.bat启动程序请在控制台上按ctrl+c或StopNTService.bat停止服务,如果强行关闭控制台并不会结束服务。如果使用StartNTService.bat启动请使用StopNTService.bat停止服务。
3.5 错误排查
如果无法启动可以查看logs目录下的sonar.xxx.log查看原因。常见问题:
1. 端口被占用,使用netstat -a 查看开放的端口或者重启服务器。。
2. 数据库连接配置错误检查sonarqube-8.9.8.54436\conf\ sonar.properties配置是否正确。
4.资料
1.sonarQube官方文档SonarQube Documentation | SonarQube Docs