From 15d55634236e34404e05bad9c713dad9fc8b2a46 Mon Sep 17 00:00:00 2001 From: Edward Angert Date: Fri, 7 Feb 2025 10:49:49 -0500 Subject: [PATCH] docs: update licensing steps in faq (#16484)
this would be a good candidate for an expand component but I don't think they work in our docs yet
[preview](https://coder.com/docs/@licensing-faq/tutorials/faqs#how-do-i-add-a-premium-trial-license) --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> --- docs/admin/licensing/index.md | 14 ++++++-- docs/tutorials/faqs.md | 61 +++++++++++++++++++++++++++-------- 2 files changed, 58 insertions(+), 17 deletions(-) diff --git a/docs/admin/licensing/index.md b/docs/admin/licensing/index.md index 94dd15f1db..6d2abda948 100644 --- a/docs/admin/licensing/index.md +++ b/docs/admin/licensing/index.md @@ -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 - ``` + - For a `.jwt` license file: + + ```shell + coder licenses add -f + ``` + + - For a text string: + + ```sh + coder licenses add -l 1f5...765 + ``` diff --git a/docs/tutorials/faqs.md b/docs/tutorials/faqs.md index 06cc76adbe..184e6dedb2 100644 --- a/docs/tutorials/faqs.md +++ b/docs/tutorials/faqs.md @@ -11,28 +11,61 @@ For other community resources, see our ## How do I add a Premium trial license? Visit 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. +
-In the UI, click the Deployment tab -> Licenses and upload the `jwt` license -file. +You can add a license through the UI or CLI -> To add the license with the CLI, first -> [install the Coder CLI](../install/cli.md) and server to the latest release. + -If the license is a text string: +
-```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 -``` +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 + ``` + +1. Run `coder licenses add`: + + - For a `.jwt` license file: + + ```shell + coder licenses add -f + ``` + + - For a text string: + + ```sh + coder licenses add -l 1f5...765 + ``` + +
+ +
+ +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