2019-05-26 19:31:04 -04:00
---
2020-06-09 11:08:05 -04:00
stage: Growth
group: Conversion
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
2019-05-26 19:31:04 -04:00
type: howto
---
2020-07-07 02:09:06 -04:00
# Activate GitLab EE with a license **(STARTER ONLY)**
2019-05-05 10:17:38 -04:00
To activate all GitLab Enterprise Edition (EE) functionality, you need to upload
2020-11-03 04:09:07 -05:00
a license. It's only possible to activate GitLab Enterprise Edition, so first verify which edition
you are running. To verify, sign in to GitLab and browse to `/help` . The GitLab edition and version
are listed at the top of the **Help** page.
If you are running GitLab Community Edition (CE), upgrade your installation to
GitLab Enterprise Edition (EE). For more details, see [Upgrading between editions ](../../update/README.md#upgrading-between-editions ).
If you have questions or need assistance upgrading from GitLab CE to EE please [contact GitLab Support ](https://about.gitlab.com/support/#contact-support ).
2019-05-05 10:17:38 -04:00
2020-10-13 23:08:32 -04:00
The license is a base64-encoded ASCII text file with a `.gitlab-license`
extension. You can obtain the file by [purchasing a license ](https://about.gitlab.com/pricing/ )
or by signing up for a [free trial ](https://about.gitlab.com/free-trial/ ).
2019-05-05 10:17:38 -04:00
2020-11-03 04:09:07 -05:00
After you've received your license from GitLab Inc., you can upload it
by **signing into your GitLab instance as an admin** or adding it at
installation time.
2019-05-05 10:17:38 -04:00
As of GitLab Enterprise Edition 9.4.0, a newly-installed instance without an
2020-10-13 23:08:32 -04:00
uploaded license only has the Core features active. A trial license
activates all Ultimate features, but after
2019-05-05 10:17:38 -04:00
[the trial expires ](#what-happens-when-your-license-expires ), some functionality
2020-10-13 23:08:32 -04:00
is locked.
2019-05-05 10:17:38 -04:00
## Uploading your license
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
2020-10-13 23:08:32 -04:00
to **Admin Area > License** .
2019-05-05 10:17:38 -04:00
Otherwise, you can:
2020-10-13 23:08:32 -04:00
1. Navigate manually to the **Admin Area** by clicking the wrench (**{admin}**) icon in the menu bar.
2019-05-05 10:17:38 -04:00
2020-10-13 23:08:32 -04:00
1. Navigate to the **License** tab, and click **Upload New License** .
2019-05-05 10:17:38 -04:00
2020-01-08 19:07:40 -05:00
![License Admin Area ](img/license_admin_area.png )
2019-05-05 10:17:38 -04:00
2020-10-13 23:08:32 -04:00
- *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,
the selected license file is named `GitLab.gitlab-license` .
2019-05-05 10:17:38 -04:00
2020-10-13 23:08:32 -04:00
![Upload license ](img/license_upload.png )
2019-05-05 10:17:38 -04:00
2020-10-13 23:08:32 -04:00
- *If you've received your license as plain text,* select the
**Enter license key** option, copy the license, paste it into the **License key**
field, and click **Upload license** .
2019-05-05 10:17:38 -04:00
2019-05-07 14:53:25 -04:00
## Add your license at install time
2020-10-13 23:08:32 -04:00
A license can be automatically imported at install time by placing a file named
`Gitlab.gitlab-license` in `/etc/gitlab/` for Omnibus GitLab, or `config/` for source installations.
2019-05-07 14:53:25 -04:00
2020-10-13 23:08:32 -04:00
You can also specify a custom location and filename for the license:
2019-05-07 14:53:25 -04:00
2020-10-13 23:08:32 -04:00
- Source installations should set the `GITLAB_LICENSE_FILE` environment
variable with the path to a valid GitLab Enterprise Edition license.
2019-05-07 14:53:25 -04:00
2020-10-13 23:08:32 -04:00
```shell
export GITLAB_LICENSE_FILE="/path/to/license/file"
```
2019-05-07 14:53:25 -04:00
2020-10-13 23:08:32 -04:00
- Omnibus GitLab installations should add this entry to `gitlab.rb` :
2019-05-07 14:53:25 -04:00
2020-10-13 23:08:32 -04:00
```ruby
gitlab_rails['initial_license_file'] = "/path/to/license/file"
```
2019-05-07 14:53:25 -04:00
2019-12-03 13:06:49 -05:00
CAUTION: **Caution:**
2020-10-13 23:08:32 -04:00
These methods only add a license at the time of installation. Use the
**{admin}** **Admin Area** in the web user interface to renew or upgrade licenses.
2019-05-07 14:53:25 -04:00
2019-05-05 10:17:38 -04:00
---
2020-10-13 23:08:32 -04:00
After the license is uploaded, all GitLab Enterprise Edition functionality
is active until the end of the license period. When that period ends, the
2019-05-05 10:17:38 -04:00
instance will [fall back ](#what-happens-when-your-license-expires ) to Core-only
functionality.
2020-10-13 23:08:32 -04:00
You can review the license details at any time in the **License** section of the
**Admin Area**.
2019-05-05 10:17:38 -04:00
![License details ](img/license_details.png )
## Notification before the license expires
2020-10-13 23:08:32 -04:00
One month before the license expires, a message informing about the expiration
date is displayed to GitLab admins. Make sure that you update your
license, otherwise you miss all the paid features if your license expires.
2019-05-05 10:17:38 -04:00
## What happens when your license expires
2020-10-13 23:08:32 -04:00
In case your license expires, GitLab locks down some features like Git pushes,
and issue creation, and displays a message to all admins to inform of the expired license.
2019-05-05 10:17:38 -04:00
2020-10-13 23:08:32 -04:00
To get back all the previous functionality, you must upload a new license.
To fall back to having only the Core features active, you must delete the
2019-05-05 10:17:38 -04:00
expired license(s).
2020-08-18 23:09:59 -04:00
### Remove a license
To remove a license from a self-managed instance:
2020-10-13 23:08:32 -04:00
1. In the top navigation bar, click the ** {admin}** wrench icon to navigate to the [Admin Area ](index.md ).
2020-08-18 23:09:59 -04:00
1. Click **License** in the left sidebar.
1. Click **Remove License** .
2019-05-05 10:17:38 -04:00
## License history
2020-11-03 04:09:07 -05:00
You can upload and view more than one license, but only the latest license in the current date
range is used as the active license. When you upload a future-dated license, it
doesn't take effect until its applicable date.
2019-05-05 10:17:38 -04:00
2020-06-22 23:09:26 -04:00
## Troubleshooting
2019-05-26 19:31:04 -04:00
2020-06-22 23:09:26 -04:00
### There is no License tab in the Admin Area
2019-05-26 19:31:04 -04:00
2020-10-13 23:08:32 -04:00
If you originally installed Community Edition rather than Enterprise Edition you must
2020-06-22 23:09:26 -04:00
[upgrade to Enterprise Edition ](../../update/README.md#community-to-enterprise-edition )
before uploading your license.
2020-10-13 23:08:32 -04:00
GitLab.com users can't upload and use a self-managed license. If you
want to use paid features on GitLab.com, you can
[purchase a separate subscription ](../../subscriptions/gitlab_com/index.md ).
2020-06-22 23:09:26 -04:00
### Users exceed license limit upon renewal
2020-10-13 23:08:32 -04:00
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
without enough users is uploaded, GitLab displays a message prompting you to purchase
2020-06-22 23:09:26 -04:00
additional users. More information on how to determine the required number of users
and how to add additional seats can be found in the
[licensing FAQ ](https://about.gitlab.com/pricing/licensing-faq/ ).