Commit 527a55c9 authored by Amy Qualls's avatar Amy Qualls Committed by Evan Read

Refine page language, remove unneeded image

Continue getting closer to GitLab tone and style. Strip out a
screenshot of indeterminate age that can be replaced with a SVG icon,
which is automagically kept up to date.
parent ed32becc
...@@ -8,130 +8,126 @@ type: howto ...@@ -8,130 +8,126 @@ type: howto
# Activate GitLab EE with a license **(STARTER ONLY)** # Activate GitLab EE with a license **(STARTER ONLY)**
To activate all GitLab Enterprise Edition (EE) functionality, you need to upload 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 a license. After you've received your license from GitLab Inc., you can upload it
by **signing into your GitLab instance as an admin** or add it at by **signing into your GitLab instance as an admin** or adding it at
installation time. installation time.
The license has the form of a base64 encoded ASCII text with a `.gitlab-license` The license is a base64-encoded ASCII text file with a `.gitlab-license`
extension and can be obtained when you [purchase one](https://about.gitlab.com/pricing/) or when you sign extension. You can obtain the file by [purchasing a license](https://about.gitlab.com/pricing/)
up for a [free trial](https://about.gitlab.com/free-trial/). or by signing up for a [free trial](https://about.gitlab.com/free-trial/).
NOTE: **Note:**
As of GitLab Enterprise Edition 9.4.0, a newly-installed instance without an 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 uploaded license only has the Core features active. A trial license
activate all Ultimate features, but after activates all Ultimate features, but after
[the trial expires](#what-happens-when-your-license-expires), some functionality [the trial expires](#what-happens-when-your-license-expires), some functionality
will be locked. is locked.
## Uploading your license ## Uploading your license
The very first time you visit your GitLab EE installation signed in as an admin, 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 you should see a note urging you to upload a license with a link that takes you
straight to **Admin Area > License**. to **Admin Area > License**.
Otherwise, you can: Otherwise, you can:
1. Navigate manually to the **Admin Area** by clicking the wrench icon in the menu bar. 1. Navigate manually to the **Admin Area** by clicking the wrench (**{admin}**) icon in the menu bar.
![Admin Area icon](img/admin_wrench.png) 1. Navigate to the **License** tab, and click **Upload New License**.
1. And then going to the **License** tab and click on **Upload New License**.
![License Admin Area](img/license_admin_area.png) ![License Admin Area](img/license_admin_area.png)
1. If you've received a `.gitlab-license` file, you should have already downloaded - *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 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, 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`. 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 - *If you've received your license as plain text,* select the
"Enter license key" option, copy the license, paste it into the "License key" **Enter license key** option, copy the license, paste it into the **License key**
field and click **Upload license**. field, and click **Upload license**.
## Add your license at install time ## Add your license at install time
A license can be automatically imported at install time, by placing a file named A license can be automatically imported at install time by placing a file named
`Gitlab.gitlab-license` in `/etc/gitlab/` for Omnibus, or `config/` for source installations. `Gitlab.gitlab-license` in `/etc/gitlab/` for Omnibus GitLab, or `config/` for source installations.
It is also possible to specify a custom location and filename for the license. You can also specify a custom location and filename for the license:
Source installations should set the `GITLAB_LICENSE_FILE` environment - Source installations should set the `GITLAB_LICENSE_FILE` environment
variable with the path to a valid GitLab Enterprise Edition license. variable with the path to a valid GitLab Enterprise Edition license.
```shell ```shell
export GITLAB_LICENSE_FILE="/path/to/license/file" export GITLAB_LICENSE_FILE="/path/to/license/file"
``` ```
Omnibus installations should add this entry to `gitlab.rb`: - Omnibus GitLab installations should add this entry to `gitlab.rb`:
```ruby ```ruby
gitlab_rails['initial_license_file'] = "/path/to/license/file" gitlab_rails['initial_license_file'] = "/path/to/license/file"
``` ```
CAUTION: **Caution:** CAUTION: **Caution:**
These methods will only add a license at the time of installation. Use the These methods only add a license at the time of installation. Use the
Admin Area in the web user interface to renew or upgrade licenses. **{admin}** **Admin Area** in the web user interface to renew or upgrade licenses.
--- ---
Once the license is uploaded, all GitLab Enterprise Edition functionality After the license is uploaded, all GitLab Enterprise Edition functionality
will be active until the end of the license period. When that period ends, the is 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 instance will [fall back](#what-happens-when-your-license-expires) to Core-only
functionality. functionality.
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**.
![License details](img/license_details.png) ![License details](img/license_details.png)
## Notification before the license expires ## Notification before the license expires
One month before the license expires, a message informing when the expiration One month before the license expires, a message informing about the expiration
is due to, will start appearing to GitLab admins. Make sure that you update your date is displayed to GitLab admins. Make sure that you update your
license, otherwise you will miss all the paid features if it expires. license, otherwise you miss all the paid features if your license expires.
## What happens when your license expires ## What happens when your license expires
In case your license expires, GitLab will lock down some features like Git pushes, In case your license expires, GitLab locks down some features like Git pushes,
issue creation, etc., and a message to inform of the expired license will be and issue creation, and displays a message to all admins to inform of the expired license.
presented to all admins.
In order to get back all the previous functionality, a new license must be uploaded. To get back all the previous functionality, you must upload a new license.
To fall back to having only the Core features active, you'll need to delete the To fall back to having only the Core features active, you must delete the
expired license(s). expired license(s).
### Remove a license ### Remove a license
To remove a license from a self-managed instance: To remove a license from a self-managed instance:
1. Go to the [Admin Area](index.md) (click the wrench in the top navigation bar). 1. In the top navigation bar, click the **{admin}** wrench icon to navigate to the [Admin Area](index.md).
1. Click **License** in the left sidebar. 1. Click **License** in the left sidebar.
1. Click **Remove License**. 1. Click **Remove License**.
## License history ## License history
It's possible to upload and view more than one license, You can upload and view more than one license,
but only the latest license will be used as the active license. but only the latest license is used as the active license.
## Troubleshooting ## Troubleshooting
### There is no License tab in the Admin Area ### There is no License tab in the Admin Area
If you originally installed Community Edition rather than Enterprise Edition you will need to If you originally installed Community Edition rather than Enterprise Edition you must
[upgrade to Enterprise Edition](../../update/README.md#community-to-enterprise-edition) [upgrade to Enterprise Edition](../../update/README.md#community-to-enterprise-edition)
before uploading your license. before uploading your license.
GitLab.com users cannot upload and use a self-managed license. If you GitLab.com users can't upload and use a self-managed license. If you
wish to use paid features on GitLab.com, a separate subscription may be want to use paid features on GitLab.com, you can
[purchased](../../subscriptions/gitlab_com/index.md). [purchase a separate subscription](../../subscriptions/gitlab_com/index.md).
### Users exceed license limit upon renewal ### Users exceed license limit upon renewal
If you've added new users to your GitLab instance prior to renewal you may need to If you've added new users to your GitLab instance prior to renewal, you may need to
purchase additional seats to cover those users. If this is the case and a license purchase additional seats to cover those users. If this is the case, and a license
without enough users is uploaded a message is displayed prompting you to purchase without enough users is uploaded, GitLab displays a message prompting you to purchase
additional users. More information on how to determine the required number of users additional users. More information on how to determine the required number of users
and how to add additional seats can be found in the and how to add additional seats can be found in the
[licensing FAQ](https://about.gitlab.com/pricing/licensing-faq/). [licensing FAQ](https://about.gitlab.com/pricing/licensing-faq/).
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