Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: add new licensing visibility to documentation #16362

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 32 additions & 16 deletions docs/admin/licensing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -20,37 +22,51 @@ 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)

### Coder CLI
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**:

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

### Coder CLI

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
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:

`coder login <access url>`
```shell
coder login <access url>
```

4. Run
1. Run `coder licenses add`:

`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.

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 removed docs/images/add-license-ui.png
Binary file not shown.
Binary file added docs/images/admin/licenses/add-license-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/admin/licenses/licenses-nolicense.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/admin/licenses/licenses-screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading