Commit 9f80c5e4 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Refactor license documentation

parent 361b3a43
...@@ -26,6 +26,7 @@ ...@@ -26,6 +26,7 @@
## Administrator documentation ## Administrator documentation
- [Upload your GitLab License](license/README.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. - [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 - [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 - [Authentication/Authorization](administration/auth/README.md) Configure
...@@ -36,7 +37,6 @@ ...@@ -36,7 +37,6 @@
- [Push Rules](push_rules/push_rules.md) Advanced push rules for your project. - [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. - [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. - [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. - [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. - [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. - [Issue closing](customization/issue_closing.md) Customize how to close an issue from commit messages.
......
# Installing your license # Activate all GitLab Enterprise Edition functionality with a license
To activate all GitLab Enterprise Edition functionality, you need to upload a To activate all GitLab Enterprise Edition (EE) functionality, you need to upload
license. Once you've received your license from GitLab Inc., you can upload it a license. The license has the form of a base64 encoded ASCII text with a
by signing into your GitLab instance as an admin, and navigating to `.gitlab-license` extension and can be obtained when you [purchase one][pricing]
**Admin Area > License**. 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.
If you've received a `.gitlab-license` file, you can upload it directly. ## Uploading your license
![upload.png](img/upload.png) 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/upload.png)
---
If you've received your license as plain text, you need to select the 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" "Enter license key" option, copy the license, paste it into the "License key"
field. field and click **Upload license**.
![enter.png](img/enter.png) ![Enter license](img/enter.png)
Once you've uploaded your license, all GitLab Enterprise Edition functionality Once you've uploaded your license, all GitLab Enterprise Edition functionality
will be active until the end of the license period. 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 You can review the license details at any time in the License section of the
Admin Area. Admin Area.
![details.png](img/details.png) ![License details](img/details.png)
## Notification before the license expires ## Notification before the license expires
...@@ -31,12 +48,15 @@ beforehand otherwise you will miss important features if it expires. ...@@ -31,12 +48,15 @@ beforehand otherwise you will miss important features if it expires.
![License expiration](img/expire_message.png) ![License expiration](img/expire_message.png)
## What happens when my license expires? ## What happens when your license expires
In case your license expires, you will not be able to push any commits to 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. 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 A message to inform of the locked state of GitLab will be presented to all
admins only. users and admins will be able to see a link to upload a license.
![No license message](img/no_license_message.png) ![No license message](img/no_license_message.png)
[free trial]: https://about.gitlab.com/free-trial/
[pricing]: https://about.gitlab.com/pricing/
doc/license/img/details.png

296 KB | W: | H:

doc/license/img/details.png

96.1 KB | W: | H:

doc/license/img/details.png
doc/license/img/details.png
doc/license/img/details.png
doc/license/img/details.png
  • 2-up
  • Swipe
  • Onion skin
doc/license/img/enter.png

127 KB | W: | H:

doc/license/img/enter.png

149 KB | W: | H:

doc/license/img/enter.png
doc/license/img/enter.png
doc/license/img/enter.png
doc/license/img/enter.png
  • 2-up
  • Swipe
  • Onion skin
doc/license/img/upload.png

97.3 KB | W: | H:

doc/license/img/upload.png

30.9 KB | W: | H:

doc/license/img/upload.png
doc/license/img/upload.png
doc/license/img/upload.png
doc/license/img/upload.png
  • 2-up
  • Swipe
  • Onion skin
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment