Quickstart guide
A checklist for administrators setting up their initial installation of SonarQube Server.
Last updated
Was this helpful?
A checklist for administrators setting up their initial installation of SonarQube Server.
By completing this guide you will:
Review pull/merge request analysis for failed quality gates.
Configure pull request decoration on your DevOps platform.
Review the Server host requirements and Pre-installation steps. This will help you establish a deployment plan (Zip, Docker, or Helm on Kubernetes) and then before you start Installing database.
Now you are ready to download SonarQube Server.
We recommend installing SonarQube Server from a Docker image or Helm chart (Kubernetes/OpenShift). These methods make it easier to update to newer versions and to operate your instance. Install from the ZIP file only if neither of those options is feasible for your environment.
Choose your installation target:
Next you will integrate SonarQube with your DevOps platforms:
You can import projects from your DevOps platform or manually add local projects, see Creating your project for more details including how to automate both methods using the Web API.
Read the Project analysis setup page for guidance on setting up analysis for your imported projects:
Have your developers install SonarQube for IDE to leverage the power ofConnected mode in their IDE.
The purpose of quality gates is to tell you whether your code is good enough to be pushed to the next step:
For the main branch and other long-lived branches, the quality gate answers the question: "Can I release my code today?"
For pull requests (and short-lived branches), the quality gate answers the question: "Can I merge this pull request?"
A pull request analysis occurs when a pull request is opened and every time a change is pushed to the pull request branch. You can also configure pull request decoration to allow your developers to view the analysis from SonarQube server directly on the PRs they submit.
By keeping an eye on the quality gates, the decision makers can quickly judge the status of code and decide what to do next.
Check the DevOps pages to ensure the PR decoration is visible for your developers.
Pull request decoration in GitHub
Pull request decoration in GitLab
Pull request decoration in Bitbucket
Pull request decoration in Azure DevOps
Now that you have installed SonarQube Server with your DevOps platforms or CI pipeline, managers and tech leads can check out the Security reports and Portfolios features to begin monitoring the security and releasability of projects.
Last updated
Was this helpful?
Was this helpful?