diff --git a/docs/unraid-account/redeem-activation-code.mdx b/docs/unraid-account/redeem-activation-code.mdx index a626c5c50fe..fbbe003a257 100644 --- a/docs/unraid-account/redeem-activation-code.mdx +++ b/docs/unraid-account/redeem-activation-code.mdx @@ -13,59 +13,68 @@ A minimum of Unraid OS v6.10 or later, or access to your Unraid account dashboar First, follow our [Getting Started guide](../unraid-os/getting-started/what-is-unraid.mdx) to set up an Unraid server. -When your server is up and running, instructions to activate your license are as follows: +When your server is up and running, start from that server so your license is applied to the right server. ### For Unraid 6.10 and later -1. Login to your Unraid server's webgui ([http://tower](http://tower) or [http://tower.local](http://tower.local) on Mac by default). +You can start in either place: -2. Sign in to your Unraid.net account (or create one) from the top-right of the webgui and select "Redeem Activation Code". +1. Log in to your Unraid server's %%WebGUI|web-gui%% ([http://tower](http://tower) or [http://tower.local](http://tower.local) on Mac by default). -3. Enter the activation code from your email or purchase confirmation and complete the activation process. +2. Use one of these entry points: -### For Upgrade Activation Codes + - Navigate to **Tools > Registration**, then select **Redeem Activation Code** in **Actions**. -1. Login to your Unraid server's webgui. + ![Tools Registration page showing the Redeem Activation Code action](/img/unraid-account/tools-registration-ui.png) -2. Choose "Upgrade Key" from the dropdown in the top-right of the webgui. + - Open the top-right Unraid.net or Connect menu and select **Manage License**. -3. Scroll down to find the "Redeem an upgrade activation code" input. + ![Unraid.net account menu showing the Manage License action](/img/unraid-account/upc-ui.png) -4. Enter the activation code to activate your license. +3. If you see a **Missing key file** message, use the same entry points: -### For Unraid 6.9 and older + - From **Tools > Registration**, select **Redeem Activation Code** in **Actions**. -1. Navigate to the **Tools → Registration** page in the webgui. + ![Tools Registration page with a Missing key file warning and the Redeem Activation Code action](/img/unraid-account/missing-key-tools-registration-ui.png) -2. Click "Purchase Key." + - From the top-right Connect panel, select **Manage License**. -3. Enter the activation code listed on your order invoice and complete the activation process. + ![Connect panel showing a Missing key file warning and the Manage License action](/img/unraid-account/missing-key-upc-ui.png) -## Alternative: Redeem via Account Dashboard +4. Sign in to your Unraid.net account or create one if prompted. -You can also redeem your activation code through your Unraid account dashboard: +5. In the account app, choose **Redeem Activation Code** if it is not already selected. -1. Navigate to your Unraid server's webgui and ensure you're signed in to your Unraid.net account from the top-right corner. + ![Account app overview showing Redeem Activation Code as an available action](/img/unraid-account/account-ui-landing-page-no-code.png) -2. Click on the top-right corner of the webgui and select **"Redeem Activation Code"** or **"Upgrade License"** to open the account dashboard with your server context loaded. +6. Enter your activation code, or choose one from your account if one is shown, then click **Redeem Code**. -3. In the account application, you'll see the "Redeem Activation Code" page. Here you have two options: - - **Select from your codes**: If you have eligible activation codes for this server, you can choose one from the dropdown menu. Eligible codes are automatically filtered based on your server's compatibility. - - **Enter code manually**: Click "Enter code instead" (or use manual entry if no eligible codes are available) and type your activation code exactly as it appears in your email or purchase confirmation. + ![Account app Redeem Activation Code page with the activation code input and Redeem Code button](/img/unraid-account/redeem-code-account-ui.png) -4. Click **"Redeem Code"** to complete the activation process. Once successful, your license will be installed on the server. +7. Click **Click To Finalize Your License Install (Required)** to finish installing the license on your server. -:::note[Server Context Required] + ![Account app button to finalize the license install](/img/unraid-account/finalize-install-button.png) -If you don't see the redemption form, you may need to load your server context first. Click **"Manage Server"** to connect your server to the account application. +Once the install is finalized, the license is applied to your server. -::: +### For Upgrade Activation Codes + +Use the same **Redeem Activation Code** page for upgrade activation codes. The account app will show or accept codes that can be used with your current license. + +### For Unraid 6.9 and older + +1. Navigate to the **Tools > Registration** page in the %%WebGUI|web-gui%%. + +2. Select **Redeem Activation Code** or **Purchase Key**. + +3. Enter the activation code listed on your order invoice and complete the activation process. ## Important Notes -- Activation codes are one-time use only to generate the license keyfile for your server. +- Activation codes can only be used once. - Make sure you're logged in with the same account that purchased the license. -- The activation code must match the server you're trying to activate. +- The activation code must work with the server you're trying to activate. +- If the account app does not show your server or the redemption form, open it again from **Tools > Registration** or **Manage License** in the %%WebGUI|web-gui%%. ## Need Help? @@ -74,5 +83,5 @@ If you're having trouble redeeming your activation code: - Make sure you're entering the code exactly as it appears in your email - Check that the activation code hasn't been used already - Ensure you're logged in with the same account that purchased the license -- Verify that your server context is correctly detected +- Open the account app from your server again if it does not show the correct server - See our [Licensing FAQ](../unraid-os/troubleshooting/licensing-faq.mdx) for more information diff --git a/static/img/unraid-account/account-ui-landing-page-no-code.png b/static/img/unraid-account/account-ui-landing-page-no-code.png new file mode 100644 index 00000000000..536ce08c075 Binary files /dev/null and b/static/img/unraid-account/account-ui-landing-page-no-code.png differ diff --git a/static/img/unraid-account/finalize-install-button.png b/static/img/unraid-account/finalize-install-button.png new file mode 100644 index 00000000000..4f33976eaed Binary files /dev/null and b/static/img/unraid-account/finalize-install-button.png differ diff --git a/static/img/unraid-account/missing-key-tools-registration-ui.png b/static/img/unraid-account/missing-key-tools-registration-ui.png new file mode 100644 index 00000000000..c0c57807406 Binary files /dev/null and b/static/img/unraid-account/missing-key-tools-registration-ui.png differ diff --git a/static/img/unraid-account/missing-key-upc-ui.png b/static/img/unraid-account/missing-key-upc-ui.png new file mode 100644 index 00000000000..adeba3ddcca Binary files /dev/null and b/static/img/unraid-account/missing-key-upc-ui.png differ diff --git a/static/img/unraid-account/redeem-code-account-ui.png b/static/img/unraid-account/redeem-code-account-ui.png new file mode 100644 index 00000000000..6add0535268 Binary files /dev/null and b/static/img/unraid-account/redeem-code-account-ui.png differ diff --git a/static/img/unraid-account/tools-registration-ui.png b/static/img/unraid-account/tools-registration-ui.png new file mode 100644 index 00000000000..0c7488151b7 Binary files /dev/null and b/static/img/unraid-account/tools-registration-ui.png differ diff --git a/static/img/unraid-account/upc-ui.png b/static/img/unraid-account/upc-ui.png new file mode 100644 index 00000000000..ba72e954016 Binary files /dev/null and b/static/img/unraid-account/upc-ui.png differ