Skip to content

docs: update licensing steps in faq #16484

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 3 commits into from
Feb 7, 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
14 changes: 11 additions & 3 deletions docs/admin/licensing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,17 @@ There are two ways to add a license to a Coder deployment:

1. Run `coder licenses add`:

```shell
coder licenses add -f <path to your license key>
```
- For a `.jwt` license file:

```shell
coder licenses add -f <path to your license key>
```

- For a text string:

```sh
coder licenses add -l 1f5...765
```

</div>

Expand Down
61 changes: 47 additions & 14 deletions docs/tutorials/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,28 +11,61 @@ For other community resources, see our
## How do I add a Premium trial license?

Visit <https://coder.com/trial> or contact

[sales@coder.com](mailto:sales@coder.com?subject=License) to get a trial key.

You can add a license through the UI or CLI.
<details>

In the UI, click the Deployment tab -> Licenses and upload the `jwt` license
file.
<summary>You can add a license through the UI or CLI</summary>

> To add the license with the CLI, first
> [install the Coder CLI](../install/cli.md) and server to the latest release.
<!-- copied from docs/admin/licensing/index.md -->

If the license is a text string:
<div class="tabs">

```sh
coder licenses add -l 1f5...765
```
### Coder UI

If the license is in a file:
1. With an `Owner` account, go to **Admin settings** > **Deployment**.

```sh
coder licenses add -f <path/filename>
```
1. Select **Licenses** from the sidebar, then **Add a license**:

![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

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:

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

1. Run `coder licenses add`:

- For a `.jwt` license file:

```shell
coder licenses add -f <path to your license key>
```

- For a text string:

```sh
coder licenses add -l 1f5...765
```

</div>

</details>

Visit the [licensing documentation](../admin/licensing/index.md) for more
information about licenses.

## I'm experiencing networking issues, so want to disable Tailscale, STUN, Direct connections and force use of websocket

Expand Down