1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
---
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.
Once you're ready to set up a production instance, take a look at the [Install SonarQube](/setup/install-server/) documentation.
## 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:
[[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).
[[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).
## Analyzing a Project
Now that you're logged in to your local SonarQube instance, let's analyze a project:
1. Click the **Create new project** button.
1. When asked **How do you want to create your project**, select **Manually**.
1. Give your project a **Project key** and a **Display name** and click the **Set Up** button.
1. Under **Provide a token**, select **Generate a token**. Give your token a name, click the **Generate** button, and click **Continue**.
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).
After successfully analyzing your code, you'll see your first analysis on SonarQube:
|
