SonarQube 是一个非常好用的代码质量管理插件，能够分析静态代码的质量，并给出修复意见。
部署配置 SonarQube 前需要在部署机器做如下准备:
- 安装了数据库
- 拥有 Java 环境或者下载了 Java jdk
- 非 root 用户
- SonarQube 安装包
各个不同版本的 SonarQube 对数据库和Java 版本有不同的要求。
本文以在 Centos 上部署 SonarQube 7.9.1 为例, 需要 Java 11 以及部署 PostgreSql 数据库。
本文命名中以 your_ 开头的字符串，均可任意替换成你自己设定的值
下载
下载jdk
下载安装 Java 11, 可通过官网下载，或者本人此处提供 Linux jdk-11 版本下载
下载 SonarQube
官网 下载, 或者本人此处提供 SoanrQube 7.9.1 下载.
注意：因 sonarQube 需要非 root 用户启动，建议下载 sonarQube 到 /usr/loacl 下，否则需要给予用户相关文件以及文件夹的访问权限
Java 环境配置
解压
tar -xf your_jdk_path/jdk-11_linux-x64_bin.tar.gz
记住路径，留着备用即可
PostgreSql 数据库安装与配置
PostgreSql 可直接通过 yum 安装， 不过 Centos 下直接安装网速奇慢，且很容易失败。故需做些修改。
修改 yum 配置
sudo vi /etc/yum.repos.d/CentOS-Base.repo
找到 [base] 和 [updates]
添加 exclude=postgresql* ，如下:
[base]
name=CentOS-$releasever - Base - mirrors.aliyun.com
.........
exclude=postgresql*
#released updates
[updates]
name=CentOS-$releasever - Updates - mirrors.aliyun.com
........
#additional packages that may be useful
exclude=postgresql*
安装 yum 包配置
sudo yum install https://download.postgresql.org/pub/repos/yum/reporpms/EL-7-x86_64/pgdg-redhat-repo-latest.noarch.rpm
若出现提示询问，输入 y 允许即可
安装 postgreSql
yum list postgresql*
sudo yum install postgresql11-server
注: postgresql11-server 也可替换成其他版本，支持版本建议参考 postgreSql官网
配置数据库
初始化数据库:
sudo /usr/pgsql-11/bin/postgresql-11-setup initdb
修改配置文件以支持 md5 授权方式:
vi /var/lib/pgsql/11/data/pg_hba.conf
找到下述部分
# TYPE DATABASE USER ADDRESS METHOD
# "local" is for Unix domain socket connections only
local all all peer
# IPv4 local connections:
host all all 127.0.0.1/32 ident
# IPv6 local connections:
host all all ::1/128 ident
将 peer 修改成 trust , idnet 修改成 md5 修改后如下:
# TYPE DATABASE USER ADDRESS METHOD
# "local" is for Unix domain socket connections only
local all all trust
# IPv4 local connections:
host all all 127.0.0.1/32 md5
# IPv6 local connections:
host all all ::1/128 md5
开启数据库
sudo systemctl start postgresql-11
sudo systemctl enable postgresql-11
创建 Centos 非 root 用户
因 SonarQube 使用到了 ElasticSearch, 所以必须使用非 root 用户启动，同样数据库访问权限也需要赋予给该非 root 用户。
创建 centos sonar 用户:
sudo useradd your_sonar_user_name
创建 postgresql 用户
给 postgresql 默认用户配置密码, 执行如下命令，再输入密码， 输入的密码建议小本本记好
sudo passwd postgres
切换到 postgresql 默认用户：
su - postgres
创建新用户:
createuser your_sonar_psql
进入 PostgreSql shell 命令行：
psql
给sonar_psql 设置密码, 注意切勿忘记命令末尾的 ; 号
ALTER USER your_sonar_psql WITH ENCRYPTED password 'your_password';
创建专用数据库：
CREATE DATABASE your_sonar_database OWNER your_sonar_psql;
至此，可退出 postgreSql：
\q
再回到 centos root 用户:
exit
SonarQube 配置
解压
unzip your_path/sonarqube-7.9.1.zip
配置 SonarQube Java 环境
此处可直接将上面下载的 jdk 配置为 Java 环境, 也可仅仅配置 SonarQube Java 环境，此处仅仅配置 SonarQube Java 环境
找到你下载解压 jdk 和 sonarQube 的路径，并执行
vi your_sonarqube_path/sonarQube/conf/wrapper.conf
找到 # wrapper.java.command 这行并修改成:
wrapper.java.command=your_jdk_path/jdk-11/bin/java
配置 SonarQube 运行环境
vi your_sonarqube_path/sonarQube/conf/sonar.properties
找到如下两行
#sonar.jdbc.username=
#sonar.jdbc.password=
修改成:
sonar.jdbc.username=your_sonar_psql
sonar.jdbc.password=your_password
找到此行:
#sonar.jdbc.url=jdbc:postgresql://localhost/xxxxxx
去除 # , 修改成:
sonar.jdbc.url=jdbc:postgresql://localhost/your_sonar_database?your_sonar_database
除上述配置外，sonar.properties 文件下还能修改 SonarQube 监听的 host #sonar.web.host=0.0.0.0 (默认全部), 以及端口 #sonar.web.port=9000 (默认9000), 不过均非必须，可按照自己需要修改。
机器限制配置
至此 SonarQube 已经配置完毕。
不过 SonarQube 运行需要打开65536文件描述符，以及 2048个线程， Centos 默认可能不够，直接运行可能出错，故需配置
vi /etc/sysctl.conf
增加一行, 若已经存在``vm.max_map_count` 值，修改其数字即可
vm.max_map_count=262144
另外需修改:
vi /etc/security/limits.conf
在 #End of file 之前增加如下两行
* soft nofile 65536
* hard nofile 65536
启动 SonarQube
至此可直接启动 SoanrQube, 切换到非 root 用户:
su your_sonar_user_name
启动 SonarQube:
your_sonar_path/sonarqube/bin/linux-x86-64/sonar.sh start
可使用如下命令查看是否启动成功:
your_sonar_path/sonarqube/bin/linux-x86-64/sonar.sh status
若看到：
SonarQube is running (xxx).
则表示成功, 若启动失败则会显示:
SonarQube is not running.
日志路径
因 sonarQube 启动后可能出现错误，故建议启动后隔一段时间再查看启动状态, 也可在如下路径查看运行日志, 排查错误： your_sonar_path/sonarqube/logs
给予权限
若 your_sonar_path 是在 /root 或其他高权限目录下，则需要给予创建的 sonar 用户相关权限
在 root 用户下，执行:
chown -R your_sonar_user_name: /your_sonar_path
配置 Httpd 和 firewall
至此 SonarQube 已经成功运行，可在本地 9000 端口访问，但通常我们部署到服务器上，需要外网或者局域网访问，此处我们使用 httpd
安装 httpd
切换到 root 用户，执行:
yum -y install httpd
配置 httpd
touch /etc/httpd/conf.d/your_sonar.yourdomain.com.conf
vi /etc/httpd/conf.d/your_sonar.yourdomain.com.conf
在文件中增加以下内容:
<VirtualHost *:80>
ServerName your_sonar.yourdomain.com
ServerAdmin your_whatever_email.com
ProxyPreserveHost On
ProxyPass / http://localhost:9000/
ProxyPassReverse / http://localhost:9000/
TransferLog /var/log/httpd/sonar.yourdomain.com_access.log
ErrorLog /var/log/httpd/sonar.yourdomain.com_error.log
</VirtualHost>
如果你修改了端口，则上述 9000 需要替换成你修改的端口。
启动 httpd
sudo systemctl start httpd
sudo systemctl enable httpd
打开防火墙
sudo firewall-cmd --add-service=http --permanent
sudo firewall-cmd --reload
重启 sonarQube
su your_sonar_user_name
your_sonar_path/sonarqube/bin/linux-x86-64/sonar.sh stop
your_sonar_path/sonarqube/bin/linux-x86-64/sonar.sh start
客户端配置 Host
若部署 SonarQube 的机器并非在公网，则建议其配置局域网固定 ip， 再在需要访问 soanr 的客户端设备上配置 host
mac 是:
vi /etc/hosts
增加一行:
your.dev.wlan.ip your_sonar.yourdomain.com
your.dev.wlan.ip 是你部署 soanr 机器的 ip
windows 配置 host 方法可自行搜索，作为程序员，hosts 配置还是非常简单的。
总结
至此，你可以通过 your_sonar.yourdomain.com 在你的机器上访问 SonarQube 了。 如果能够正常访问成功，恭喜你。
如果看到无法正常访问，不要慌，使用 your_sonar_path/sonarqube/bin/linux-x86-64/sonar.sh start 查看 sonarQube 是否正常运行，再到 your_sonar_path/sonarqube/logs 路径下去查看运行日志，逐个解决错误。
若有错误也欢迎留言联系探讨
参考文章:
<How To Install and Use PostgreSQL on CentOS 7>
<How to Install SonarQube on CentOS 7>
网友评论