diff --git a/doc/README.md b/doc/README.md index af957a39e5b5547def1e11484c05dae54cf7ff75..7499a486ddeb8995701a5754bacc3de5b49069d2 100644 --- a/doc/README.md +++ b/doc/README.md @@ -26,6 +26,7 @@ ## Administrator documentation +- [Upload your GitLab License](user/admin_area/license.md) Upload the license you purchased for GitLab Enterprise Edition to unlock its features. - [Audit Events](administration/audit_events.md) Check how user access changed in projects and groups. - [Access restrictions](user/admin_area/settings/visibility_and_access_controls.md#enabled-git-access-protocols) Define which Git access protocols can be used to talk to GitLab - [Authentication/Authorization](administration/auth/README.md) Configure @@ -36,7 +37,6 @@ - [Push Rules](push_rules/push_rules.md) Advanced push rules for your project. - [Help message](customization/help_message.md) Set information about administrators of your GitLab instance. - [Install](install/README.md) Requirements, directory structures and installation from source. -- [Installing your license](license/README.md) - [Integration](integration/README.md) How to integrate with systems such as JIRA, Redmine, LDAP and Twitter. - [Restart GitLab](administration/restart_gitlab.md) Learn how to restart GitLab and its components. - [Issue closing](customization/issue_closing.md) Customize how to close an issue from commit messages. diff --git a/doc/license/README.md b/doc/license/README.md index 73e5527146aead4f8a5f6643b572e81d2c55e3d8..7a0cba214fe21fa170948c7a0c1a35b4ab5f60cb 100644 --- a/doc/license/README.md +++ b/doc/license/README.md @@ -1,42 +1 @@ -# Installing your license - -To activate all GitLab Enterprise Edition functionality, you need to upload a -license. Once you've received your license from GitLab Inc., you can upload it -by signing into your GitLab instance as an admin, and navigating to -**Admin Area > License**. - -If you've received a `.gitlab-license` file, you can upload it directly. - -![upload.png](img/upload.png) - -If you've received your license as plain text, you need to select the -"Enter license key" option, copy the license and paste it into the "License key" -field. - -![enter.png](img/enter.png) - -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. - -![details.png](img/details.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/expire_message.png) - -## What happens when my 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. - -A message to inform of the locked state of GitLab will be presented to -admins only. - -![No license message](img/no_license_message.png) +This document was moved to [user/admin_area/license](../user/admin_area/license.md). diff --git a/doc/license/img/details.png b/doc/license/img/details.png deleted file mode 100644 index 9ecf6812ff15f7defea92ca712d76b4d5dacd432..0000000000000000000000000000000000000000 Binary files a/doc/license/img/details.png and /dev/null differ diff --git a/doc/license/img/enter.png b/doc/license/img/enter.png deleted file mode 100644 index 414e2d8b14f0acf3e7cea7e4e311aa61899d52e5..0000000000000000000000000000000000000000 Binary files a/doc/license/img/enter.png and /dev/null differ diff --git a/doc/license/img/no_license_message.png b/doc/license/img/no_license_message.png deleted file mode 100644 index 051b0d85eb1e1e26cb1e98f7dfa201c80a50911e..0000000000000000000000000000000000000000 Binary files a/doc/license/img/no_license_message.png and /dev/null differ diff --git a/doc/license/img/upload.png b/doc/license/img/upload.png deleted file mode 100644 index dabcb2b8d94e7c17c14bdee1b3a041f7374e03ca..0000000000000000000000000000000000000000 Binary files a/doc/license/img/upload.png and /dev/null differ diff --git a/doc/user/admin_area/img/admin_wrench.png b/doc/user/admin_area/img/admin_wrench.png new file mode 100644 index 0000000000000000000000000000000000000000..8c7193174145e4f04dac69b1e67ea8912a0f2d49 Binary files /dev/null and b/doc/user/admin_area/img/admin_wrench.png differ diff --git a/doc/user/admin_area/img/license_admin_area.png b/doc/user/admin_area/img/license_admin_area.png new file mode 100644 index 0000000000000000000000000000000000000000..f46f075374efb4fa6edaec7057cbc3ed2991c4d0 Binary files /dev/null and b/doc/user/admin_area/img/license_admin_area.png differ diff --git a/doc/user/admin_area/img/license_details.png b/doc/user/admin_area/img/license_details.png new file mode 100644 index 0000000000000000000000000000000000000000..2919fa72a9a884063e5860f3af9cb9b022224109 Binary files /dev/null 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 new file mode 100644 index 0000000000000000000000000000000000000000..1f51f0879555f00eacc6dfaa7b575d6df61d6f4d Binary files /dev/null and b/doc/user/admin_area/img/license_enter.png differ diff --git a/doc/license/img/expire_message.png b/doc/user/admin_area/img/license_expire_message.png similarity index 100% rename from doc/license/img/expire_message.png rename to doc/user/admin_area/img/license_expire_message.png diff --git a/doc/user/admin_area/img/license_history.png b/doc/user/admin_area/img/license_history.png new file mode 100644 index 0000000000000000000000000000000000000000..3129eb407ce952420bcb52254e8b4202396c6459 Binary files /dev/null and b/doc/user/admin_area/img/license_history.png differ diff --git a/doc/user/admin_area/img/license_no_license_message.png b/doc/user/admin_area/img/license_no_license_message.png new file mode 100644 index 0000000000000000000000000000000000000000..d41eebfdc11f7b8d2d980fee32d305b255490c27 Binary files /dev/null and b/doc/user/admin_area/img/license_no_license_message.png differ diff --git a/doc/user/admin_area/img/license_upload.png b/doc/user/admin_area/img/license_upload.png new file mode 100644 index 0000000000000000000000000000000000000000..c675f36f920bdb7f35408fc64dcc1a84ebfc84de Binary files /dev/null and b/doc/user/admin_area/img/license_upload.png differ diff --git a/doc/user/admin_area/license.md b/doc/user/admin_area/license.md new file mode 100644 index 0000000000000000000000000000000000000000..9ed5fc314b0b3442847c91bb2fc04ee09bdd3cb6 --- /dev/null +++ b/doc/user/admin_area/license.md @@ -0,0 +1,71 @@ +# Activate all GitLab Enterprise Edition functionality with a license + +To activate all GitLab Enterprise Edition (EE) functionality, you need to upload +a license. 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]. Once you've received your license from +GitLab Inc., you can upload it by signing into your GitLab instance as an admin. + +## 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. Otherwise, you can navigate manually to the **Admin Area** +by clicking the wrench icon in the upper right corner and the going to the +**License** tab. + +![License admin area](img/license_admin_area.png) + +--- + +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) + +--- + +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 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) + +## 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. + +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. + +![No license message](img/license_no_license_message.png) + +[free trial]: https://about.gitlab.com/free-trial/ +[pricing]: https://about.gitlab.com/pricing/