diff --git a/doc/administration/index.md b/doc/administration/index.md index 69011f6b34ce17a72819547ebadf0dd5b7b9592b..6595f21588ae342190b25b04a67a39e30d2d923c 100644 --- a/doc/administration/index.md +++ b/doc/administration/index.md @@ -51,12 +51,13 @@ Learn how to install, configure, update, and maintain your GitLab instance. [source installations](../install/installation.md#installation-from-source). - [Environment variables](environment_variables.md): Supported environment variables that can be used to override their defaults values in order to configure GitLab. - [Plugins](plugins.md): With custom plugins, GitLab administrators can introduce custom integrations without modifying GitLab's source code. -- [Elasticsearch](../integration/elasticsearch.md): Enable Elasticsearch to empower GitLab's Advanced Global Search. Useful when you deal with a huge amount of data. **[STARTER ONLY]** -- [External Classification Policy Authorization](../user/admin_area/settings/external_authorization.md) **[PREMIUM ONLY]** - [Enforcing Terms of Service](../user/admin_area/settings/terms.md) - [Third party offers](../user/admin_area/settings/third_party_offers.md) - [Compliance](compliance.md): A collection of features from across the application that you may configure to help ensure that your GitLab instance and DevOps workflow meet compliance standards. - [Diff limits](../user/admin_area/diff_limits.md): Configure the diff rendering size limits of branch comparison pages. +- [Elasticsearch](../integration/elasticsearch.md): Enable Elasticsearch to empower GitLab's Advanced Global Search. Useful when you deal with a huge amount of data. **[STARTER ONLY]** +- [External Classification Policy Authorization](../user/admin_area/settings/external_authorization.md) **[PREMIUM ONLY]** +- [Upload a license](../user/admin_area/license.md): Upload a license to unlock features that are in paid tiers of GitLab. **[STARTER ONLY]** #### Customizing GitLab's appearance diff --git a/doc/user/admin_area/img/license_details.png b/doc/user/admin_area/img/license_details.png index e84c256f8052e9b89b30e99f309f118c4018e25a..570505b453b202fba47da0f52ef7d13db1da8475 100644 Binary files a/doc/user/admin_area/img/license_details.png and b/doc/user/admin_area/img/license_details.png differ diff --git a/doc/user/admin_area/img/license_enter.png b/doc/user/admin_area/img/license_enter.png deleted file mode 100644 index 6f85ccead975cbda3bbfe61209e3e88785241bb7..0000000000000000000000000000000000000000 Binary files a/doc/user/admin_area/img/license_enter.png and /dev/null differ diff --git a/doc/user/admin_area/img/license_expire_message.png b/doc/user/admin_area/img/license_expire_message.png deleted file mode 100644 index ab5f4216c8b5b323977948b4a04060cd62dfec67..0000000000000000000000000000000000000000 Binary files a/doc/user/admin_area/img/license_expire_message.png and /dev/null differ diff --git a/doc/user/admin_area/license.md b/doc/user/admin_area/license.md index ef5eeb5afffc8a2c45ce72da23062750793e91e3..b81d016aa3f7de84381734a8cb690193dfc57ccc 100644 --- a/doc/user/admin_area/license.md +++ b/doc/user/admin_area/license.md @@ -1,4 +1,4 @@ -# Activate all GitLab Enterprise Edition functionality with a license +# Activate all GitLab Enterprise Edition functionality with a license **[STARTER ONLY]** To activate all GitLab Enterprise Edition (EE) functionality, you need to upload a license. Once you've received your license from GitLab Inc., you can upload it @@ -8,15 +8,18 @@ The license has the form of a base64 encoded ASCII text with a `.gitlab-license` extension and can be obtained when you [purchase one][pricing] or when you sign up for a [free trial]. -> **Note:** As of GitLab Enterprise Edition 9.4.0, a new instance without a valid license -will only have Core features active. A trial license will activate all Ultimate features, -but the instance will fall back to Core only functionality after the trial expires. +NOTE: **Note:** +As of GitLab Enterprise Edition 9.4.0, a newly-installed instance without an +uploaded license will only have the Core features active. A trial license will +activate all Ultimate features, but after +[the trial expires](#what-happens-when-your-license-expires), some functionality +will be locked. ## Uploading your license -The very first time you visit your GitLab EE installation, you should see a -notice urging you to upload a license with a link that takes you straight to the -License admin area. +The very first time you visit your GitLab EE installation signed in as an admin, +you should see a note urging you to upload a license with a link that takes you +straight to the License admin area. Otherwise, you can: @@ -28,56 +31,53 @@ Otherwise, you can: ![License admin area](img/license_admin_area.png) ---- +1. If you've received a `.gitlab-license` file, you should have already downloaded + it in your local machine. You can then upload it directly by choosing the + license file and clicking the **Upload license** button. In the image below, + you can see that the selected license file is named `GitLab.gitlab-license`. -If you've received a `.gitlab-license` file, you should have already downloaded -it in your local machine. You can then upload it directly by choosing the -license file and clicking the **Upload license** button. In the image below, -you can see that the selected license file is named `GitLab.gitlab-license`. + ![Upload license](img/license_upload.png) -![Upload license](img/license_upload.png) + If you've received your license as plain text, you need to select the + "Enter license key" option, copy the license, paste it into the "License key" + field and click **Upload license**. --- -If you've received your license as plain text, you need to select the -"Enter license key" option, copy the license, paste it into the "License key" -field and click **Upload license**. - -![Enter license](img/license_enter.png) +Once the license is uploaded, all GitLab Enterprise Edition functionality +will be active until the end of the license period. When that period ends, the +instance will [fall back](#what-happens-when-your-license-expires) to Core-only +functionality. -Once you've uploaded your license, all GitLab Enterprise Edition functionality -will be active until the end of the license period. You can review the license details at any time in the License section of the Admin Area. ![License details](img/license_details.png) -## License history - -It's possible to upload more than one license, but only the last one will be -taken into account. - -You can see your previous licenses' history at the bottom of the License page. - -![License history](img/license_history.png) - ## Notification before the license expires One month before the license expires, a message informing when the expiration -is due to will be shown to GitLab admins. Make sure that you update your license -beforehand otherwise you will miss important features if it expires. - -![License expiration](img/license_expire_message.png) +is due to, will start appearing to GitLab admins. Make sure that you update your +license, otherwise you will miss all the paid features if it expires. ## What happens when your license expires -In case your license expires, you will not be able to push any commits to -GitLab and creation of new issues and merge requests will be disabled. +In case your license expires, GitLab will lock down some features like Git pushes, +issue creation, etc., and a message to inform of the expired license will be +presented to all admins. + +In order to get back all the previous functionality, a new license must be uploaded. +To fall back to having only the Core features active, you'll need to delete the +expired license(s). + +## License history + +It's possible to upload more than one license, but only the last one will be +taken into account. -A message to inform of the locked state of GitLab will be presented to all -users and admins will be able to see a link to upload a license. +You can see your previous licenses' history at the bottom of the License page. -![No license message](img/license_no_license_message.png) +![License history](img/license_history.png) [free trial]: https://about.gitlab.com/free-trial/ [pricing]: https://about.gitlab.com/pricing/