Skip to content

Commit 07246b2

Browse files
Refresh SonarQube Docs (#13)
1 parent f231323 commit 07246b2

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

sonarqube/content.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# What is SonarQube?
22

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.
44

55
%%LOGO%%
66

77
# How to use this image
88

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.
1010

1111
## Docker Host Requirements
1212

@@ -15,42 +15,42 @@ Because SonarQube uses an embedded Elasticsearch, make sure that your Docker hos
1515
For example, on Linux, you can set the recommended values for the current session by running the following commands as root on the host:
1616

1717
```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
2222
```
2323

24-
## Get Started in Two Minutes Guide
24+
## Try Out SonarQube
2525

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.
2733

2834
## Configuration
2935

3036
### Database
3137

3238
By default, the image will use an embedded H2 database that is not suited for production.
3339

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.
3541
3642
Set up a database by following the "Installing the Database" section of https://docs.sonarqube.org/latest/setup/install-server/.
3743

3844
### Use volumes
3945

4046
We recommend creating volumes for the following directories:
4147

42-
- `/opt/sonarqube/conf`: **for Version 7.9.x only**, configuration files, such as `sonar.properties`.
4348
- `/opt/sonarqube/data`: data files, such as the embedded H2 database and Elasticsearch indexes
4449
- `/opt/sonarqube/logs`: contains SonarQube logs about access, web process, CE process, Elasticsearch logs
4550
- `/opt/sonarqube/extensions`: for 3rd party plugins
4651

4752
> **Warning:** You cannot use the same volumes on multiple instances of SonarQube.
4853
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.
5454

5555
## Upgrading
5656

@@ -63,8 +63,8 @@ For upgrade instructions, see Upgrading from the Docker Image on the [Upgrade th
6363
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:
6464

6565
```dockerfile
66-
FROM sonarqube:8.2-community
67-
COPY sonar.properties /opt/sonarqube/conf/
66+
FROM sonarqube:8.9-community
67+
COPY sonar-custom-plugin-1.0.jar /opt/sonarqube/extensions/
6868
```
6969

7070
You could then build and try the image with something like:
@@ -76,7 +76,7 @@ $ docker run -ti sonarqube-custom
7676

7777
### Avoid hard termination of SonarQube
7878

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:
8080

8181
```console
8282
docker run --stop-timeout 3600 %%IMAGE%%

0 commit comments

Comments
 (0)