aboutsummaryrefslogtreecommitdiffstats
path: root/server
diff options
context:
space:
mode:
authorcolin-mueller-sonarsource <44168128+colin-mueller-sonarsource@users.noreply.github.com>2019-06-27 03:51:01 -0700
committersonartech <sonartech@sonarsource.com>2019-06-28 08:45:57 +0200
commitab644c260ca81e0c7af7620d2ea427ea5c2083b5 (patch)
treeec2eb6154412d5b34ca192be9522467b2f24f5b6 /server
parentb70e58ce8571985543ac44c3590a0d9132e9c09e (diff)
downloadsonarqube-ab644c260ca81e0c7af7620d2ea427ea5c2083b5.tar.gz
sonarqube-ab644c260ca81e0c7af7620d2ea427ea5c2083b5.zip
DOCS: Ported License Manger Docs
* Created license-manager.md * Added support-information-file.png * Added License Managemer to ToC * Added License Manager to static docs index * Update SonarQubeNavigationTree.json * Update StaticNavigationTree.json * Update license-manager.md * Update license-manager.md * Update max size of distribution * Update license-manager.md
Diffstat (limited to 'server')
-rw-r--r--server/sonar-docs/src/images/support-information-file.pngbin0 -> 244247 bytes
-rw-r--r--server/sonar-docs/src/pages/instance-administration/license-manager.md43
-rw-r--r--server/sonar-docs/static/SonarQubeNavigationTree.json1
-rw-r--r--server/sonar-docs/static/StaticNavigationTree.json1
4 files changed, 45 insertions, 0 deletions
diff --git a/server/sonar-docs/src/images/support-information-file.png b/server/sonar-docs/src/images/support-information-file.png
new file mode 100644
index 00000000000..99965b2e00a
--- /dev/null
+++ b/server/sonar-docs/src/images/support-information-file.png
Binary files differ
diff --git a/server/sonar-docs/src/pages/instance-administration/license-manager.md b/server/sonar-docs/src/pages/instance-administration/license-manager.md
new file mode 100644
index 00000000000..e28eac7e75b
--- /dev/null
+++ b/server/sonar-docs/src/pages/instance-administration/license-manager.md
@@ -0,0 +1,43 @@
+---
+title: License Manager
+url: /instance-administration/license-manager/
+---
+
+_The License Manager is accessible from **[Administration > Configuration> License Manager](/#sonarqube-admin#/admin/extension/license/app)** as part of [Developer Edition](https://redirect.sonarsource.com/editions/developer.html) and [above](https://www.sonarsource.com/plans-and-pricing/)._
+
+## License Manager
+
+The License Manager enables retrieval of your Server ID (required for obtaining a License Key) and configuration of your SonarSource-provided License key.
+
+### Retrieving Server ID
+The Server ID is always available on the License Manager page, as well as in the System section of the System Info .
+
+Note that if the database connection string is updated, the server ID will be re-generated and a new license will be needed. When it is generated, the Server ID is unique. The same Server ID will never be generated twice, even on the same SonarQube instance.
+
+### Setting a License
+Using the "Set new license" button, you can set a new License to enable or disable features in SonarQube, or simply to update your license.
+
+### LOCs Consumption
+The gauge indicates the quantity of LOCs you are currently scanning and allows you to check if you are near the limit and if you need to purchase additional LOCs.
+
+### Global admin notifications
+The License Manager comes with two notification mechanisms built-in (notifications are sent to Global Admins):
+
+- when the license is about to expire–sent two months before expiration, with a reminder one month before
+- when the configurable LOC threshold is exceeded–this threshold can be modified via the indicator present on the LOC gauge
+- the background job, that checks threshold and decide if a notification should be sent, runs at server startup, then every 24 hours
+- the background job does not check validity of smtp server settings and if the emails addresses are set up for global administrators, 
+therefore for notifications to be received, these settings needs to be correctly configured before the LOC threshold is reached or exceeded
+
+### Features Included section
+
+This sections of the License Manager page lists the commercial features that are enabled by the license currently set.
+
+## Support
+
+### Access to SonarSource Support
+If your License entitles you to SonarSource Support, A **Support** tab will appear at **[Administration > Support](/#sonarqube-admin#/admin/extension/license/support)** to guide you through interactions with SonarSource Support.
+
+This page also allows you to collect the Support Information File of your instance. Make sure to provide this file for any interaction with SonarSource Support.
+
+![Support Information File.](/images/support-information-file.png)
diff --git a/server/sonar-docs/static/SonarQubeNavigationTree.json b/server/sonar-docs/static/SonarQubeNavigationTree.json
index 5a25fc22b69..548751e7a95 100644
--- a/server/sonar-docs/static/SonarQubeNavigationTree.json
+++ b/server/sonar-docs/static/SonarQubeNavigationTree.json
@@ -121,6 +121,7 @@
"/instance-administration/housekeeping/",
"/instance-administration/notifications/",
"/instance-administration/system-info/",
+ "/instance-administration/license-manager/",
"/instance-administration/monitoring/",
"/instance-administration/project-move/",
"/instance-administration/custom-measures/",
diff --git a/server/sonar-docs/static/StaticNavigationTree.json b/server/sonar-docs/static/StaticNavigationTree.json
index 11b801f3a2d..1870da441c1 100644
--- a/server/sonar-docs/static/StaticNavigationTree.json
+++ b/server/sonar-docs/static/StaticNavigationTree.json
@@ -138,6 +138,7 @@
"/instance-administration/housekeeping/",
"/instance-administration/notifications/",
"/instance-administration/system-info/",
+ "/instance-administration/license-manager/",
"/instance-administration/monitoring/",
"/instance-administration/project-move/",
"/instance-administration/custom-measures/",