Commit a023c18f authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'license' into 'master'

Refactor the license documentaiton

Closes https://gitlab.com/gitlab-org/gitlab-ee/issues/1000

See merge request !730
parents 5bef86b9 002dd63c
...@@ -26,6 +26,7 @@ ...@@ -26,6 +26,7 @@
## Administrator documentation ## 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. - [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 This document was moved to [user/admin_area/license](../user/admin_area/license.md).
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)
# 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/
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