Skip to content

Commit 951a8ed

Browse files
authored
docs: add new licensing visibility to documentation (#16362)
closes #16260 [preview](https://coder.com/docs/@16260-licensing-ui/admin/licensing) --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
1 parent cab1f37 commit 951a8ed

File tree

5 files changed

+32
-16
lines changed

5 files changed

+32
-16
lines changed

docs/admin/licensing/index.md

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ features, you can [request a trial](https://coder.com/trial) or
1212
1313
<!-- markdown-link-check-enable -->
1414

15+
![Licenses screen shows license information and seat consumption](../../images/admin/licenses/licenses-screen.png)
16+
1517
## Adding your license key
1618

1719
There are two ways to add a license to a Coder deployment:
@@ -20,37 +22,51 @@ There are two ways to add a license to a Coder deployment:
2022

2123
### Coder UI
2224

23-
First, ensure you have a license key
24-
([request a trial](https://coder.com/trial)).
25+
1. With an `Owner` account, go to **Admin settings** > **Deployment**.
2526

26-
With an `Owner` account, navigate to `Deployment -> Licenses`, `Add a license`
27-
then drag or select the license file with the `jwt` extension.
27+
1. Select **Licenses** from the sidebar, then **Add a license**:
2828

29-
![Add License UI](../../images/add-license-ui.png)
29+
![Add a license from the licenses screen](../../images/admin/licenses/licenses-nolicense.png)
3030

31-
### Coder CLI
31+
1. On the **Add a license** screen, drag your `.jwt` license file into the
32+
**Upload Your License** section, or paste your license in the
33+
**Paste Your License** text box, then select **Upload License**:
3234

33-
First, ensure you have a license key
34-
([request a trial](https://coder.com/trial)) and the
35-
[Coder CLI](../../install/cli.md) installed.
35+
![Add a license screen](../../images/admin/licenses/add-license-ui.png)
36+
37+
### Coder CLI
3638

37-
1. Save your license key to disk and make note of the path
38-
2. Open a terminal
39-
3. Ensure you are logged into your Coder deployment
39+
1. Ensure you have the [Coder CLI](../../install/cli.md) installed.
40+
1. Save your license key to disk and make note of the path.
41+
1. Open a terminal.
42+
1. Log in to your Coder deployment:
4043

41-
`coder login <access url>`
44+
```shell
45+
coder login <access url>
46+
```
4247

43-
4. Run
48+
1. Run `coder licenses add`:
4449

45-
`coder licenses add -f <path to your license key>`
50+
```shell
51+
coder licenses add -f <path to your license key>
52+
```
4653

4754
</div>
4855

49-
## Find your deployment ID
56+
## FAQ
57+
58+
### Find your deployment ID
5059

5160
You'll need your deployment ID to request a trial or license key.
5261

5362
From your Coder dashboard, select your user avatar, then select the **Copy to
5463
clipboard** icon at the bottom:
5564

5665
![Copy the deployment ID from the bottom of the user avatar dropdown](../../images/admin/deployment-id-copy-clipboard.png)
66+
67+
### How we calculate license seat consumption
68+
69+
Licenses are consumed based on the status of user accounts.
70+
Only users who have been active in the last 90 days consume license seats.
71+
72+
Consult the [user status documentation](../users/index.md#user-status) for more information about active, dormant, and suspended user statuses.

docs/images/add-license-ui.png

-207 KB
Binary file not shown.
83.5 KB
Loading
57.8 KB
Loading
131 KB
Loading

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy