]> source.dussan.org Git - sonarqube.git/commitdiff
DOCS: Ported License Manger Docs
authorcolin-mueller-sonarsource <44168128+colin-mueller-sonarsource@users.noreply.github.com>
Thu, 27 Jun 2019 10:51:01 +0000 (03:51 -0700)
committersonartech <sonartech@sonarsource.com>
Fri, 28 Jun 2019 06:45:57 +0000 (08:45 +0200)
* 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

server/sonar-docs/src/images/support-information-file.png [new file with mode: 0644]
server/sonar-docs/src/pages/instance-administration/license-manager.md [new file with mode: 0644]
server/sonar-docs/static/SonarQubeNavigationTree.json
server/sonar-docs/static/StaticNavigationTree.json
sonar-application/build.gradle

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 (file)
index 0000000..99965b2
Binary files /dev/null and b/server/sonar-docs/src/images/support-information-file.png 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 (file)
index 0000000..e28eac7
--- /dev/null
@@ -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)
index 5a25fc22b697e8594f245b7d8bee55ffb2e44e3e..548751e7a950a6f7caeca485e1adc346152eda4e 100644 (file)
       "/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/",
index 11b801f3a2db8d4e2ad0915eaef8854affd45c19..1870da441c111b21d8467c09d805081070df7056 100644 (file)
       "/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/",
index b7ebc064f18cc86d1b268a9fca17bc28acb73ed7..6db87116f7be7f5ee4b3e506b6fecc7653713cfb 100644 (file)
@@ -211,7 +211,7 @@ zip.doFirst {
 // Check the size of the archive
 zip.doLast {
   def minLength = 198000000
-  def maxLength = 206000000
+  def maxLength = 207000000
   def length = archiveFile.get().asFile.length()
   if (length < minLength)
     throw new GradleException("$archiveName size ($length) too small. Min is $minLength")