docs: add new licensing visibility to documentation (#16362)

closes https://github.com/coder/coder/issues/16260

[preview](https://coder.com/docs/@16260-licensing-ui/admin/licensing)

---------

Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
This commit is contained in:
Edward Angert
2025-02-03 11:18:44 -06:00
committed by GitHub
co-authored by EdwardAngert
parent cab1f375ec
commit 951a8ed98d
5 changed files with 32 additions and 16 deletions
+32 -16
View File
@@ -12,6 +12,8 @@ features, you can [request a trial](https://coder.com/trial) or
<!-- markdown-link-check-enable -->
![Licenses screen shows license information and seat consumption](../../images/admin/licenses/licenses-screen.png)
## Adding your license key
There are two ways to add a license to a Coder deployment:
@@ -20,33 +22,40 @@ There are two ways to add a license to a Coder deployment:
### Coder UI
First, ensure you have a license key
([request a trial](https://coder.com/trial)).
1. With an `Owner` account, go to **Admin settings** > **Deployment**.
With an `Owner` account, navigate to `Deployment -> Licenses`, `Add a license`
then drag or select the license file with the `jwt` extension.
1. Select **Licenses** from the sidebar, then **Add a license**:
![Add License UI](../../images/add-license-ui.png)
![Add a license from the licenses screen](../../images/admin/licenses/licenses-nolicense.png)
1. On the **Add a license** screen, drag your `.jwt` license file into the
**Upload Your License** section, or paste your license in the
**Paste Your License** text box, then select **Upload License**:
![Add a license screen](../../images/admin/licenses/add-license-ui.png)
### Coder CLI
First, ensure you have a license key
([request a trial](https://coder.com/trial)) and the
[Coder CLI](../../install/cli.md) installed.
1. Ensure you have the [Coder CLI](../../install/cli.md) installed.
1. Save your license key to disk and make note of the path.
1. Open a terminal.
1. Log in to your Coder deployment:
1. Save your license key to disk and make note of the path
2. Open a terminal
3. Ensure you are logged into your Coder deployment
```shell
coder login <access url>
```
`coder login <access url>`
1. Run `coder licenses add`:
4. Run
`coder licenses add -f <path to your license key>`
```shell
coder licenses add -f <path to your license key>
```
</div>
## Find your deployment ID
## FAQ
### Find your deployment ID
You'll need your deployment ID to request a trial or license key.
@@ -54,3 +63,10 @@ From your Coder dashboard, select your user avatar, then select the **Copy to
clipboard** icon at the bottom:
![Copy the deployment ID from the bottom of the user avatar dropdown](../../images/admin/deployment-id-copy-clipboard.png)
### How we calculate license seat consumption
Licenses are consumed based on the status of user accounts.
Only users who have been active in the last 90 days consume license seats.
Consult the [user status documentation](../users/index.md#user-status) for more information about active, dormant, and suspended user statuses.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 207 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 131 KiB