diff options
| author | G. Ann Campbell <ann.campbell@sonarsource.com> | 2019-02-15 06:00:56 -0500 |
|---|---|---|
| committer | SonarTech <sonartech@sonarsource.com> | 2019-02-15 20:20:55 +0100 |
| commit | 209aa0bbb113c96096c94dadc104bc91f4683392 (patch) | |
| tree | 147fe0a6d013173d6940f1f4366c696e54cdfc53 /server/sonar-docs | |
| parent | 63b96ef59940c4cbe03e275ed5947b154cc0b4dd (diff) | |
| download | sonarqube-209aa0bbb113c96096c94dadc104bc91f4683392.tar.gz sonarqube-209aa0bbb113c96096c94dadc104bc91f4683392.zip | |
DOCS make "don't run as root" more explicit
Diffstat (limited to 'server/sonar-docs')
| -rw-r--r-- | server/sonar-docs/src/pages/setup/get-started-2-minutes.md | 2 | ||||
| -rw-r--r-- | server/sonar-docs/src/pages/setup/install-server.md | 8 | ||||
| -rw-r--r-- | server/sonar-docs/src/pages/setup/operate-server.md | 2 |
3 files changed, 8 insertions, 4 deletions
diff --git a/server/sonar-docs/src/pages/setup/get-started-2-minutes.md b/server/sonar-docs/src/pages/setup/get-started-2-minutes.md index 73593071a5d..5d64402bea9 100644 --- a/server/sonar-docs/src/pages/setup/get-started-2-minutes.md +++ b/server/sonar-docs/src/pages/setup/get-started-2-minutes.md @@ -15,7 +15,7 @@ url: /setup/get-started-2-minutes/ # On Windows, execute: C:\sonarqube\bin\windows-x86-xx\StartSonar.bat -# On other operating systems, execute: +# On other operating systems, as a non-root user execute: /opt/sonarqube/bin/[OS]/sonar.sh console ``` diff --git a/server/sonar-docs/src/pages/setup/install-server.md b/server/sonar-docs/src/pages/setup/install-server.md index 39d00ab3a3f..8a6c18a971d 100644 --- a/server/sonar-docs/src/pages/setup/install-server.md +++ b/server/sonar-docs/src/pages/setup/install-server.md @@ -70,9 +70,9 @@ Once all SonarQube tables are using the InnoDB engine, the first thing to do is ## Installing the Web Server -First, check the [requirements](/requirements/requirements/). Note that you cannot run the SonarQube server as `root` on Unix-based systems. +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). -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-HOME_ (below) refers to the path to the directory where the SonarQube distribution has been unzipped. @@ -197,3 +197,7 @@ http.proxyUser=domain\\user ``` For some proxies, the exception "java.net.ProtocolException: Server redirected too many times" might mean an incorrect username or password has been configured. + +### Exception java.lang.RuntimeException: can not run elasticsearch as root + +SonarQube starts an Elasticsearch process, and the same account that is running SonarQube itself will be used for the Elasticsearch process. Since Elasticsearch cannot be run as `root`, that means SonarQube can't be either. You must choose some other, non-`root` account with which to run SonarQube, preferably an account dedicated to the purpose. diff --git a/server/sonar-docs/src/pages/setup/operate-server.md b/server/sonar-docs/src/pages/setup/operate-server.md index 6a1ccb8dbc5..c7a560ba541 100644 --- a/server/sonar-docs/src/pages/setup/operate-server.md +++ b/server/sonar-docs/src/pages/setup/operate-server.md @@ -23,7 +23,7 @@ url: /setup/operate-server/ ## Running SonarQube as a Service on Linux with SystemD -On Unix system using SystemD, you can install SonarQube as a service. +On Unix system using SystemD, you can install SonarQube as a service. You cannot run SonarQube as `root` in 'nix systems. Ideally, you will created a new account dedicated to the purpose of running SonarQube. Let's suppose: * The user used to start the service is `sonarqube` |