url: /
---
-<!-- sonarcloud -->
-
-SonarCloud is the leading product for Continuous Code Quality online, totally free for open-source projects. It supports all major programming languages, including Java, C#, JavaScript, TypeScript, C/C++ and many more. If your code is closed source, SonarCloud also offers [a paid plan](/sonarcloud-pricing/) to run private analyses.
-
-SonarCloud offers end-to-end integrations for teams leveraging the following solutions in their development processes:
-
-* [GitHub.com](/integrations/github/)
-* [Bitbucket Cloud](/integrations/bitbucketcloud/)
-* [Azure DevOps Services](/integrations/vsts/)
-
-Are you ready to eliminate bugs and vulnerabilities? Will you champion quality code in your projects?
-
-<!-- /sonarcloud -->
-<!-- static -->
-
[[info]]
| **Welcome to the new SonarQube documentation**
-| If you already have a SonarQube instance, you should be aware that we've made this documentation available within SonarQube itself (from v7.4). Just look under the "?" in the top menu to be sure you're always looking at the right documentation for _your_ version!
-<!-- /static -->
-<!-- sonarqube -->
+| If you're already running a SonarQube instance, this documentation is also available within SonarQube itself (from v7.4). Just look under the "?" in the top menu to be sure you're always looking at the right documentation for _your_ version!
-[SonarQube](http://www.sonarqube.org/)® is an automatic code review tool to detect bugs, vulnerabilities and code smells in your code. It can integrate with your existing workflow to enable continuous code inspection across your project branches and pull requests.
+[SonarQube](http://www.sonarqube.org/)® is an automatic code review tool to detect bugs, vulnerabilities, and code smells in your code. It can integrate with your existing workflow to enable continuous code inspection across your project branches and pull requests.
-Below are a few key pointers, otherwise head over to the left pane for full documentation content and search capabilities.
+Below are a few common scenarios. You can also navigate through and search the full documentation in the left pane.
### I'm new to SonarQube
-* Installing a [quick demo version](/setup/get-started-2-minutes/).
-* Installing a [production instance](/setup/install-server/).
+* [Try out SonarQube ](/setup/get-started-2-minutes/).
+* Installing [the Server](/setup/install-server/).
### I need to set up analysis
* [Analyzing Source Code](/analysis/overview/)
### Stay in touch!
* [Get help in the community](https://www.sonarqube.org/community/)
* [Source code](https://github.com/SonarSource)
-* [Issue tracker](https://jira.sonarsource.com/)
-
-<!-- /sonarqube -->
+* [Issue tracker](https://jira.sonarsource.com/)
\ No newline at end of file
---
-title: Get Started in Two Minutes Guide
+title: Try Out SonarQube
url: /setup/get-started-2-minutes/
---
+You've heard about how [SonarQube](https://www.sonarqube.org/) can help you write cleaner and safer code, and now you're ready to try it out for yourself. This guide shows you how to install a local instance of SonarQube and analyze a project. Installing a local instance gets you up and running quickly, so you can experience SonarQube first hand.
-[[info]]
-| This guides shows you how to install a demo instance. When you are ready to move to production, take some time to read the [Install the Server](/setup/install-server/) documentation.
+Once you're ready to set up a production instance, take a look at the [Install SonarQube](/setup/install-server/) documentation.
-## Installing from a zip file
+## Installing a local instance of SonarQube
+You can install SonarQube from either the [zip file](https://www.sonarqube.org/downloads/) or the [Docker image](https://hub.docker.com/_/sonarqube/). Click the method you prefer below to expand the installation instructions:
-1. [Download](https://www.sonarqube.org/downloads/) the SonarQube Community Edition.
+[[collapse]]
+| ## From a zip file
+|
+| 1. [Download](https://www.sonarqube.org/downloads/) the SonarQube Community Edition zip file.
+|
+| 2. As a **non-`root` user**, unzip it, let's say in _C:\sonarqube_ or _/opt/sonarqube_.
+|
+| 3. As a **non-`root` user**, start the SonarQube Server:
+|
+| ```
+| # On Windows, execute:
+| C:\sonarqube\bin\windows-x86-64\StartSonar.bat
+|
+| # On other operating systems, as a non-root user execute:
+| /opt/sonarqube/bin/[OS]/sonar.sh console
+| ```
+|
+|  If your instance fails to start, check your [logs](/setup/troubleshooting/) to find the cause.
+|
+| 4. Log in to [http://localhost:9000](http://localhost:9000) using System Administrator credentials (login=admin, password=admin).
-2. As a **non-`root` user**, unzip it, let's say in _C:\sonarqube_ or _/opt/sonarqube_.
+[[collapse]]
+| ## From a Docker image
+| Find the Community Edition Docker image on [Docker Hub](https://hub.docker.com/_/sonarqube/).
+|
+| 1. Start the server by running:
+|
+| ```console
+| $ docker run -d --name sonarqube -p 9000:9000 <image_name>
+| ```
+|
+| 2. Log in to [http://localhost:9000](http://localhost:9000) with System Administrator credentials (login=admin, password=admin).
-3. As a **non-`root` user**, start the SonarQube Server:
+## Analyzing a Project
+Now that you're logged in to your local SonarQube instance, let's analyze a project:
- ```
- # On Windows, execute:
- C:\sonarqube\bin\windows-x86-xx\StartSonar.bat
+1. Click the **Create new project** button.
- # On other operating systems, as a non-root user execute:
- /opt/sonarqube/bin/[OS]/sonar.sh console
- ```
+1. When asked **How do you want to create your project**, select **Manually**.
-  If your instance fails to start, check your [logs](/setup/troubleshooting/) to find the cause.
+1. Give your project a **Project key** and a **Display name** and click the **Set Up** button.
-4. Log in to [http://localhost:9000](http://localhost:9000) with System Administrator credentials (login=admin, password=admin).
+1. Under **Provide a token**, select **Generate a token**. Give your token a name, click the **Generate** button, and click **Continue**.
-5. Click the **Create new project** button to analyze your first project.
+1. Select your project's main language under **Run analysis on your project**, and follow the instructions to analyze your project. Here you'll download and execute a Scanner on your code (if you're using Maven or Gradle, the Scanner is automatically downloaded).
-## Using Docker
-Images of the Community, Developer, and Enterprise Editions are available on [Docker Hub](https://hub.docker.com/_/sonarqube/).
+After successfully analyzing your code, you'll see your first analysis on SonarQube:
-1. Start the server by running:
+
-```console
-$ docker run -d --name sonarqube -p 9000:9000 <image_name>
-```
-2. Log in to [http://localhost:9000](http://localhost:9000) with System Administrator credentials (login=admin, password=admin).
-
-3. Click the **Create new project** button to analyze your first project.
\ No newline at end of file
url: /setup/install-cluster/
---
-<!-- sonarqube -->
-
_Running SonarQube as a Cluster is only possible with a [Data Center Edition](https://www.sonarsource.com/plans-and-pricing/data-center/)_.
The Data Center Edition allows SonarQube to run in a clustered configuration to make it resilient to failures.
4. After all search nodes are running, start all application nodes.
5. Configure the load balancer to proxy with both application nodes.
-Congratulations, you have a fully-functional SonarQube cluster. Once these steps are complete, take a break and a coffee, then you can [Operate your Cluster](/setup/operate-cluster/).
-
-<!-- /sonarqube -->
+Congratulations, you have a fully-functional SonarQube cluster. Once these steps are complete, take a break and a coffee, then you can [Operate your Cluster](/setup/operate-cluster/).
\ No newline at end of file
## Installing the Database
-Several [database engines](/requirements/requirements/) are supported. Be sure to follow the requirements listed for your database, they are real requirements not recommendations.
+Several [database engines](/requirements/requirements/) are supported. Be sure to follow the requirements listed for your database. They are real requirements not recommendations.
Create an empty schema and a `sonarqube` user. Grant this `sonarqube` user permissions to `create`, `update`, and `delete` objects for this schema.
|ALTER USER mySonarUser SET search_path to mySonarQubeSchema
|```
-## Installing the Server from the ZIP file
+## Installing SonarQube from the ZIP file
First, check the [requirements](/requirements/requirements/). Then download and unzip the [distribution](http://www.sonarqube.org/downloads/) (do not unzip into a directory starting with a digit).
-SonarQube cannot be run as `root` on Unix-based systems, so create a dedicated user account to use for SonarQube if necessary.
+SonarQube cannot be run as `root` on Unix-based systems, so create a dedicated user account for SonarQube if necessary.
_$SONARQUBE-HOME_ (below) refers to the path to the directory where the SonarQube distribution has been unzipped.
- Running SonarQube [behind a Proxy](/setup/operate-server/)
- Monitoring and adjusting [Java Process Memory](/instance-administration/monitoring/)
-## Installing the Server from the Docker Image
+## Installing SonarQube from the Docker Image
See your SonarQube version below for instructions on installing the server from a Docker image.
[
+ "/setup/get-started-2-minutes/",
"/architecture/architecture-integration/",
{
"title": "Requirements",
"title": "Setup and Upgrade",
"children": [
"/setup/overview/",
- "/setup/get-started-2-minutes/",
"/setup/install-server/",
{
"title": "Configure and Operate a Server",
projects / sonarqube.git / commitdiff
