You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sonarqube/content.md
+18-18Lines changed: 18 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
# What is SonarQube?
2
2
3
-
[SonarQube](https://www.sonarqube.org/) is an open source product for continuous inspection of code quality.
3
+
[SonarQube](https://www.sonarqube.org/) is the leading tool for continuously inspecting the Code Quality and Security of your codebases, and guiding development teams during Code Reviews. Covering 27 programming languages, while pairing-up with your existing software pipeline, SonarQube provides clear remediation guidance for developers to understand and fix issues, and for teams overall to deliver better and safer software. With over 225,000 deployments helping small development teams as well as global organizations, SonarQube provides the means for all teams and companies around the world to own and impact their Code Quality and Security.
4
4
5
5
%%LOGO%%
6
6
7
7
# How to use this image
8
8
9
-
Here you'll find the Docker images for the Community Edition, Developer Edition, Enterprise Edition, and DataCenter Edition of SonarQube.
9
+
Here you'll find the Docker images for the Community Edition, Developer Edition, Enterprise Edition, and Data Center Edition of SonarQube.
10
10
11
11
## Docker Host Requirements
12
12
@@ -15,42 +15,42 @@ Because SonarQube uses an embedded Elasticsearch, make sure that your Docker hos
15
15
For example, on Linux, you can set the recommended values for the current session by running the following commands as root on the host:
16
16
17
17
```console
18
-
sysctl -w vm.max_map_count=262144
19
-
sysctl -w fs.file-max=65536
20
-
ulimit -n 65536
21
-
ulimit -u 4096
18
+
sysctl -w vm.max_map_count=524288
19
+
sysctl -w fs.file-max=131072
20
+
ulimit -n 131072
21
+
ulimit -u 8192
22
22
```
23
23
24
-
## Get Started in Two Minutes Guide
24
+
## Try Out SonarQube
25
25
26
-
To quickly run a demo instance, see Using Docker on the [Get Started in Two Minutes Guide](https://docs.sonarqube.org/latest/setup/get-started-2-minutes/) page. When you are ready to move to a more sustainable setup, take some time to read the **Configuration** section below.
26
+
To quickly run a demo instance, see Using Docker on the [Try Out SonarQube](https://docs.sonarqube.org/latest/setup/get-started-2-minutes/) page. When you are ready to move to a more sustainable setup, take some time to read the **Installation** and **Configuration** sections below.
27
+
28
+
## Installation
29
+
30
+
For installation instructions, see Installing the Server from the Docker Image on the [Install the Server](https://docs.sonarqube.org/latest/setup/install-server/) page.
31
+
32
+
To run a cluster with the Data Center Edition, please refer to Installing SonarQube from the Docker Image on the [Install the Server as a Cluster](https://docs.sonarqube.org/latest/setup/install-cluster/) page.
27
33
28
34
## Configuration
29
35
30
36
### Database
31
37
32
38
By default, the image will use an embedded H2 database that is not suited for production.
33
39
34
-
> **Warning:** Only a single instance of SonarQube can connect to a database schema. If you're using a Docker Swarm or Kubernetes, make sure that multiple SonarQube instances are never running on the same database schema simultaneously. This will cause SonarQube to behave unpredictably and data will be corrupted. There is no safeguard until [SONAR-10362](https://jira.sonarsource.com/browse/SONAR-10362). The Datacenter Edition has the same limitation in that only one cluster can connect to one database schema at the same time.
40
+
> **Warning:** Only a single instance of SonarQube can connect to a database schema. If you're using a Docker Swarm or Kubernetes, make sure that multiple SonarQube instances are never running on the same database schema simultaneously. This will cause SonarQube to behave unpredictably and data will be corrupted. There is no safeguard until [SONAR-10362](https://jira.sonarsource.com/browse/SONAR-10362). The Data Center Edition has the same limitation in that only one cluster can connect to one database schema at the same time.
35
41
36
42
Set up a database by following the "Installing the Database" section of https://docs.sonarqube.org/latest/setup/install-server/.
37
43
38
44
### Use volumes
39
45
40
46
We recommend creating volumes for the following directories:
41
47
42
-
-`/opt/sonarqube/conf`: **for Version 7.9.x only**, configuration files, such as `sonar.properties`.
43
48
-`/opt/sonarqube/data`: data files, such as the embedded H2 database and Elasticsearch indexes
44
49
-`/opt/sonarqube/logs`: contains SonarQube logs about access, web process, CE process, Elasticsearch logs
45
50
-`/opt/sonarqube/extensions`: for 3rd party plugins
46
51
47
52
> **Warning:** You cannot use the same volumes on multiple instances of SonarQube.
48
53
49
-
## First Installation
50
-
51
-
For installation instructions, see Installing the Server from the Docker Image on the [Install the Server](https://docs.sonarqube.org/latest/setup/install-server/) page.
52
-
53
-
To run a cluster with the DataCenter Edition, please refer to Installing SonarQube from the Docker Image on the [Install the Server as a Cluster](https://docs.sonarqube.org/latest/setup/install-cluster/) page.
54
54
55
55
## Upgrading
56
56
@@ -63,8 +63,8 @@ For upgrade instructions, see Upgrading from the Docker Image on the [Upgrade th
63
63
In some environments, it may make more sense to prepare a custom image containing your configuration. A `Dockerfile` to achieve this may be as simple as:
You could then build and try the image with something like:
@@ -76,7 +76,7 @@ $ docker run -ti sonarqube-custom
76
76
77
77
### Avoid hard termination of SonarQube
78
78
79
-
Starting from SonarQube 7.8, SonarQube stops gracefully, waiting for any tasks in progress to finish. Waiting for in-progress tasks to finish can take a large amount of time which the docker does not expect by default when stopping. To avoid having the SonarQube instance killed by the Docker daemon after 10 seconds, it is best to configure a timeout to stop the container with `--stop-timeout`. For example:
79
+
A SonarQube instance will stop gracefully, waiting for any tasks in progress to finish. Waiting for in-progress tasks to finish can take a large amount of time which the docker does not expect by default when stopping. To avoid having the SonarQube instance killed by the Docker daemon after 10 seconds, it is best to configure a timeout to stop the container with `--stop-timeout`. For example:
0 commit comments