summaryrefslogtreecommitdiffstats
path: root/server
diff options
context:
space:
mode:
authorOlivier Korach <olivier.korach@gmail.com>2021-01-04 15:59:10 +0100
committersonartech <sonartech@sonarsource.com>2021-03-17 20:08:34 +0000
commitbd1f5a9348146f88b3bd250817c3302b935f9a34 (patch)
tree0d98686c2d33b653c901ca0412793184d96d17da /server
parentda368da20e07d3073497c3a279a01d0c0bfdfac8 (diff)
downloadsonarqube-bd1f5a9348146f88b3bd250817c3302b935f9a34.tar.gz
sonarqube-bd1f5a9348146f88b3bd250817c3302b935f9a34.zip
DOCS Fix docs on starting SQ as a service on windows
Diffstat (limited to 'server')
-rw-r--r--server/sonar-docs/src/pages/setup/operate-server.md8
-rw-r--r--server/sonar-docs/src/pages/setup/upgrading.md15
2 files changed, 13 insertions, 10 deletions
diff --git a/server/sonar-docs/src/pages/setup/operate-server.md b/server/sonar-docs/src/pages/setup/operate-server.md
index ddecfc349b4..5c4e49f8f1a 100644
--- a/server/sonar-docs/src/pages/setup/operate-server.md
+++ b/server/sonar-docs/src/pages/setup/operate-server.md
@@ -11,16 +11,16 @@ url: /setup/operate-server/
| When installing SonarQube as a service on Windows, the path to the executable should be quoted to prevent unquoted service path attacks.
```
-> sc create SonarQube binPath= "\"%SONARQUBE_HOME%\bin\windows-x86-64\wrapper.exe\" -s %SONARQUBE_HOME%\conf\wrapper.conf"
+> sc create SonarQube binPath= "\"%SONAR_HOME%\bin\windows-x86-64\wrapper.exe\" -s \"%SONAR_HOME%\conf\wrapper.conf\""
```
### Start or Stop the Service
```
-> SONARQUBE_HOME%/bin/windows-x86-64/StartNTService.bat
-> SONARQUBE_HOME%/bin/windows-x86-64/StopNTService.bat
+> "%SONAR_HOME%\bin\windows-x86-64\StartNTService.bat"
+> "%SONAR_HOME%\bin\windows-x86-64\StopNTService.bat"
```
-**Note:** `> %SONARQUBE_HOME%/bin/windows-x86-64/StopNTService.bat` does a graceful shutdown where no new analysis report processing can start, but the tasks in progress are allowed to finish. The time a stop will take depends on the processing time of the tasks in progress. You'll need to kill all SonarQube processes manually to force a stop.
+**Note:** `> "%SONAR_HOME%\bin\windows-x86-64\StopNTService.bat"` does a graceful shutdown where no new analysis report processing can start, but the tasks in progress are allowed to finish. The time a stop will take depends on the processing time of the tasks in progress. You'll need to kill all SonarQube processes manually to force a stop.
## Running SonarQube Manually on Linux
diff --git a/server/sonar-docs/src/pages/setup/upgrading.md b/server/sonar-docs/src/pages/setup/upgrading.md
index e49cb31d30a..622fd89d403 100644
--- a/server/sonar-docs/src/pages/setup/upgrading.md
+++ b/server/sonar-docs/src/pages/setup/upgrading.md
@@ -38,10 +38,10 @@ This is a generic guide for upgrading across versions of SonarQube. Carefully re
### Upgrading from the ZIP file
-1. Download and unzip the SonarQube distribution of your edition in a fresh directory, let's say `$NEW_SONARQUBE_HOME`
+1. Download and unzip the SonarQube distribution of your edition in a fresh directory, let's say `$NEW_SONAR_HOME`
2. Manually install additional plugins that are compatible with your version of SonarQube. Use the [Compatibility Matrix](https://docs.sonarqube.org/display/PLUG/Plugin+Version+Matrix) to ensure that the versions you install are compatible with your server version. Simply copying plugins from the old server to the new is not recommended; incompatible or duplicate plugins could cause startup errors. Analysis of all languages provided by your edition is available by default without plugins.
-3. Update the contents of `sonar.properties` and `wrapper.conf` files (in `$NEW_SONARQUBE_HOME/conf`) with the settings of the related files in the `$OLD_SONARQUBE_HOME/conf` directory (web server URL, database, ldap settings, etc.). Do not copy-paste the old files.
-If you are using the Oracle DB, copy its JDBC driver into `$NEW_SONARQUBE_HOME/extensions/jdbc-driver/oracle`
+3. Update the contents of `sonar.properties` and `wrapper.conf` files (in `$NEW_SONAR_HOME/conf`) with the settings of the related files in the `$OLD_SONAR_HOME/conf` directory (web server URL, database, ldap settings, etc.). Do not copy-paste the old files.
+If you are using the Oracle DB, copy its JDBC driver into `$NEW_SONAR_HOME/extensions/jdbc-driver/oracle`
4. Stop your old SonarQube Server
5. Start your new SonarQube Server
6. Browse to `http://yourSonarQubeServerURL/setup` and follow the setup instructions
@@ -108,9 +108,12 @@ When upgrading SonarQube, you should also make sure you’re using the latest ve
### SonarQube as a Linux or Windows Service
-If you use external configuration, such as a script or Windows Service to control your server, you'll need to update it to point to `$NEW_SONARQUBE_HOME`.
-
-In case you used the InstallNTService.bat to install SonarQube as a Windows Service, run the $OLD_SONARQUBE_HOME/bin/.../UninstallNTService.bat before running the InstallNTService.bat of the $NEW_SONARQUBE_HOME.
+If you use external configuration, such as a script or Windows Service to control your server, you'll need to update it to point to `$NEW_SONAR_HOME`.
+- For Linux it depends how you implemented the service
+- For Windows you can update your service by running:
+```
+sc config SonarQube binPath= "\"$NEW_SONAR_HOME\bin\windows-x86-64\wrapper.exe\" -s \"$NEW_SONAR_HOME\conf\wrapper.conf\""
+```
### Rebuilding Indexes
If your upgrade requires the rebuild of Elasticsearch indexes, your projects and Applications will become available as they are reindexed. Portfolios won't be available until all projects are indexed.