Install SonarQube Using Docker Compose
This article is for those looking for a detailed and straightforward guide on installing SonarQube using Docker Compose.
SonarQube is an open-source platform developed by SonarSource. It offers continuous inspection of code quality, using static analysis to detect bugs and code smells. Currently, it supports 29 programming languages.
💾 You can find the repository used in this guide on GitHub.
We’ll use Traefik as our reverse proxy. It’ll handle obtaining cryptographic certificates from Let’s Encrypt for your domain names and route requests to the corresponding services based on those domains.
❗ To obtain cryptographic certificates, you will need A-type records in the external DNS zone, which point to the IP address of your server where Traefik is installed. If you have created these records recently, you should wait before starting the installation of the services. Full replication of these records between DNS servers can take from a few minutes to 48 hours or even longer in rare cases.
In this guide, we will consider the case where you already have a server with Ubuntu Server 22.04 LTS installed on it.
You can find detailed information on how to install Ubuntu Server 22.04 LTS in my guide “Install Ubuntu Server 22.04 LTS”.
Docker Engine and Docker Compose must also be installed on the server.
You can learn how to install Docker Engine on Ubuntu Server by reading Install Docker Engine and Docker Compose on Ubuntu Server”.
In addition, OpenSSH must be installed on the server, and port 22 must be open in order to be able to connect to the server using the SSH protocol.
To install OpenSSH on the server you can use the command:
sudo apt install openssh-serverIf you plan to connect to the server using the Windows operating system, you can use PuTTY or MobaXterm.
This guide covers connecting to the server using the terminal emulator iTerm2, installed on the macOS operating system.
💡 Please note, you will need to open the following TCP ports for access to the services:
- TCP port 80 - to obtain a free cryptographic certificate through the Let’s Encrypt certification center.
- TCP port 443 - to access the SonarQube web interface.
We connect to the server on which SonarQube is planned to be installed.
Now it is necessary to create networks for your services.
We create a network for Traefik using the command:
docker network create traefik-network
We create a network for SonarQube using the command:
docker network create sonarqube-network
Adjust the vm.max_map_count using the commands:
sudo sysctl -w vm.max_map_count=262144
Next, you need to clone the repository that contains the configuration files, which include all the necessary conditions for SonarQube to work.
You can clone the repository using the command:
git clone https://github.com/heyValdemar/sonarqube-traefik-letsencrypt-docker-compose.git
Navigate to the directory with the repository using the command:
cd sonarqube-traefik-letsencrypt-docker-compose
Next, you need to change the variables in the .env file according to your requirements.
💡 Note that the .env file should be in the same directory as sonarqube-traefik-letsencrypt-docker-compose.yml.
Now let’s start SonarQube with the command:
docker compose -f sonarqube-traefik-letsencrypt-docker-compose.yml -p sonarqube up -d
To access the SonarQube management panel, go to https://sonarqube.heyvaldemar.net from your workstation, where sonarqube.heyvaldemar.net is the domain name of my service. Accordingly, you need to specify your domain name that points to the IP address of your server with the installed Traefik service, which will redirect the request to SonarQube.
💡 Note that you need to specify the domain name of the service, previously defined in the .env file.
Enter the username and password that you previously set in the .env file, and click the “Log In” button.
Welcome to the SonarQube control panel.
To access the Traefik control panel, go to https://traefik.sonarqube.heyvaldemar.net from your workstation, where traefik.sonarqube.heyvaldemar.net is the domain name of my service. Accordingly, you need to specify your domain name that points to the IP address of your server with the installed Traefik.
💡 Note that you need to specify the domain name of the service, previously defined in the .env file.
Enter the username and password previously set in the .env file, and click the “OK” button.
Welcome to the Traefik control panel.
My Services
💼 Take a look at my service catalog and find out how we can make your technological life better. Whether it’s increasing the efficiency of your IT infrastructure, advancing your career, or expanding your technological horizons — I’m here to help you achieve your goals. From DevOps transformations to building gaming computers — let’s make your technology unparalleled!
Refill the Author’s Coffee Supplies
💖 PayPal
🏆 Patreon
💎 GitHub
🥤 BuyMeaCoffee
🍪 Ko-fi
