Licensing
Crowd licenses are based on the number of end-users who will log in to the applications that are integrated with Crowd.
You can obtain an evaluation license from the Atlassian website. When you obtain an evaluation license — or purchase, renew or upgrade your license — you will receive a license key via email or on the Atlassian website.
You will need to enter your license key into your Crowd server as described below.On this page:
Entering your License Key
To enter your license key,
- Log in to the Crowd Administration Console.
- Click the 'Administration' tab in the top navigation bar.
- Click 'Licensing' in the left-hand menu.
- Type (or paste) your license key into the 'License Key' field.
- Click the 'Update' button.
Screenshot: 'Licensing'
Warning when Number of Users approaches License Limit
Whenever the number of users reaches 90% of the number allowed by the license, Crowd will send an email informing the administrator about the license limit and the current number of users. The email is sent to the email notification address, as defined on the 'Mail Configuration' screen in the Crowd Administration Console. (See Configuring your Mail Server.)
It is important to avoid exceeding the license limit, because once the user limit has been exceeded, no one can log in (including administrators).
What to Do if the Number of Users Exceeds your License Limit
If the number of users who are allowed to log in to the Crowd console exceeds the user license limit, no one will be able to log in to any applications. When you try to access Crowd, you'll be redirected to a page where you can update your license key. On this page, you can either:
- Enter a new license key for a higher user count. (Purchase one here.)
- Enter a 30-day evaluation license key. (Create one here.) The 30-day evaluation key lets an unlimited number of users sign in during the trial period. You can use the 30 days to clean up the users in the system or purchase a license key for a higher user count.
Minimizing your Licensing Cost
If you have more than one directory, ensure that the same user does not exist in multiple directories.
We recommend that you allow only particular groups to log in to each application, rather than entire directories.
Note that a mapped application can 'see' all users in a directory, even if not all of them can log in to the application. For example, a Human Resources application might be mapped to your entire Active Directory server, but only the HR group is allowed to log in to the application.
Recalculating your User Total
The Licensing screen shows the number of users who currently count towards your license. This total is updated automatically at regular intervals. If you have recently added or removed users, the total may not be up to date when you view the screen. You can update the count immediately, as described below.
To recalculate your user total:
- Log in to the Crowd Administration Console.
- In the top navigation bar, select the Administration tab.
- In the left-hand menu, click Licensing.
- Click the link labeled Recalculate your user total.
The recalculation may take a while, depending on the size of your user base.
List all users who count toward the Crowd license
To list users who consume license in Crowd:
- Enable com.atlassian.crowd.manager.license in the DEBUG level
- Recalculate your User Total.
Once the calculation is ready, you will be able to see the license count, list of users (and the directories those users are from) in log files.
Example:
2018-03-28 07:12:15,789 Caesium-2-2 DEBUG [crowd.manager.license.CrowdLicenseManagerImpl] Finished counting licensed users, 9 total
2018-03-28 07:12:15,790 Caesium-2-2 DEBUG [crowd.manager.license.CrowdLicenseManagerImpl] Licensed users are: [leela (131074), professor (131074), test (753665), zoidberg (131074), admin (131073), hermes (131074), bender (131074), amy (131074), fry (131074)]Server ID and Support Entitlement Number
Your License Server ID is generated automatically, based on your license key.
The Support Entitlement Number will appear only on newer licenses. If your License Server ID starts with a 'B', you should also have a Support Entitlement Number. This number is not currently used, but will be used by Atlassian Support in the future.