From b5bc0516d4a88777b144a5493fb09994e0a8cc23 Mon Sep 17 00:00:00 2001 From: Enrique Gonzalez Date: Tue, 6 Oct 2026 21:00:03 +0000 Subject: [PATCH 1/2] Update license key docs to match the Product license page Replace the outdated Site configuration steps with the Product license page flow, correct what happens when a license expires, and explain that Sourcegraph manages license keys on Sourcegraph Cloud. Co-authored-by: Amp Amp-Thread-ID: https://ampcode.com/threads/T-2198952b-2156-4c41-95b8-3d5b5c963010 --- docs/admin/licensing.mdx | 23 +++++++++++++------ docs/admin/subscriptions.mdx | 3 +-- docs/cloud/index.mdx | 4 ++++ .../deploy/kubernetes/configure.mdx | 2 +- 4 files changed, 22 insertions(+), 10 deletions(-) diff --git a/docs/admin/licensing.mdx b/docs/admin/licensing.mdx index 338058f75..691a5b6b6 100644 --- a/docs/admin/licensing.mdx +++ b/docs/admin/licensing.mdx @@ -7,25 +7,34 @@ Sourcegraph requires a valid license key to enable many of its more prominent features. -License keys should not be shared across instances of Sourcegraph. If an additional license key is required for something like a dev environment, please [contact customer support](https://about.sourcegraph.com/contact) for an additional license key. +License keys should not be shared across instances of Sourcegraph. If an additional license key is required for something like a dev environment, please contact [support@sourcegraph.com](mailto:support@sourcegraph.com) for an additional license key. ## FAQ ### What happens if our Sourcegraph license expires? -Sourcegraph will continue to function as normal, but all users will be signed out of Sourcegraph. Only administrators will be able to sign into Sourcegraph so that they can enter a new license key. +Users who are not administrators see a **Sourcegraph subscription invalid** page and can't use Sourcegraph. Administrators can still sign in, so that they can [enter a new license key](#how-can-we-update-our-license-key). + +Starting 7 days before the license expires, Sourcegraph shows a banner with a link to the **Product license** page. ### How can we update our license key? -Any current Administrator can update your license key by going to Administration -> [Advanced configuration](/admin/config/site-config) + + On [Sourcegraph Cloud](/cloud/#how-do-we-update-our-license-key), Sourcegraph manages your license key and the **Product license** page doesn't show the **Update license key** form. To apply a new or renewed license, contact your Sourcegraph account team or [support@sourcegraph.com](mailto:support@sourcegraph.com). + + +On a self-hosted instance, an administrator can update the license key on the **Product license** page: -These settings live in the JSON object, and you will need to navigate to the _licenseKey_ section of that object. +1. Go to **Administration → Configuration → Product license** (`/admin/license`). +2. Under **Update license key**, paste the new key into the **License key** field. +3. Click **Validate & apply license key**. Sourcegraph checks the key and rejects one that is invalid or expired. +4. In the **Confirm license update** dialog, compare the current license with the new one (customer, plan, seat count, and expiry date), then click **Confirm & apply license**. -Update the value of this with your new license key and click Save to apply your changes. +The new license takes effect as soon as it's applied. You don't need to restart Sourcegraph. -Example: +If your advanced configuration is loaded from the `SITE_CONFIG` or `SITE_CONFIG_FILE` environment variable, the form is disabled. Set `licenseKey` in that configuration instead, as described in [Loading configuration via the file system](/self-hosted/advanced-config-file#advanced-configuration): -```bash +```json "licenseKey": "", ``` diff --git a/docs/admin/subscriptions.mdx b/docs/admin/subscriptions.mdx index 4a3ed2018..ac3d1fd5b 100644 --- a/docs/admin/subscriptions.mdx +++ b/docs/admin/subscriptions.mdx @@ -30,5 +30,4 @@ Sourcegraph administrators can view the lines of code count for each repository ## Updating your license key -- Navigate to **Administration > Configuration > Advanced configuration**, update the `licenseKey` field with the new value, and then click **Save changes**. -- Note: once you apply the license it may take 10-15 minutes for the change to take effect. You can always restart the front-end service to apply the change faster, if needed. +See [Licensing: How can we update our license key?](/admin/licensing#how-can-we-update-our-license-key) diff --git a/docs/cloud/index.mdx b/docs/cloud/index.mdx index 21ff21888..13b6fd35f 100644 --- a/docs/cloud/index.mdx +++ b/docs/cloud/index.mdx @@ -291,6 +291,10 @@ Sourcegraph Cloud can securely connect to customer-owned resources on cloud prov The exact cadence depends on the product release schedule. Sourcegraph Cloud instances receive timely upgrades whenever a new release is available, and there is a need for emergency security patches. Learn more about our [release schedule](https://handbook.sourcegraph.com/departments/cloud/technical-docs/#release-process). The schedule is for information only, and it is subject to change anytime. +### How do we update our license key? + +Sourcegraph manages the license key of Sourcegraph Cloud instances. When you renew or change your subscription, your Sourcegraph account team applies the new license key for you. If your license needs updating, contact your account team or [support@sourcegraph.com](mailto:support@sourcegraph.com). The **Product license** page in **Administration** shows your current license, but has no form to update it. + ### What audit logs are available? Sourcegraph Cloud instances retain critical audit logs for 30 days by default. Logs are available upon request. For enterprise customers, we can also accommodate for extended retention periods. diff --git a/docs/self-hosted/deploy/kubernetes/configure.mdx b/docs/self-hosted/deploy/kubernetes/configure.mdx index b4aeab407..cd5f67421 100644 --- a/docs/self-hosted/deploy/kubernetes/configure.mdx +++ b/docs/self-hosted/deploy/kubernetes/configure.mdx @@ -1177,7 +1177,7 @@ components: Sourcegraph's Kubernetes deployment [requires an Enterprise license key](https://about.sourcegraph.com/pricing). -Once you have a license key, add it to your [advanced configuration](/admin/config/site-config). +Once you have a license key, add it on the **Product license** page. See [How can we update our license key?](/admin/licensing#how-can-we-update-our-license-key) --- From b286a1ff6fb74ff38b6d402fc9577fce8ad3f0a9 Mon Sep 17 00:00:00 2001 From: Enrique Gonzalez Date: Thu, 8 Oct 2026 21:11:20 +0000 Subject: [PATCH 2/2] Shorten license key update steps to point at the Product license page Amp-Thread-ID: https://ampcode.com/threads/T-2198952b-2156-4c41-95b8-3d5b5c963010 Co-authored-by: Amp --- docs/admin/licensing.mdx | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/docs/admin/licensing.mdx b/docs/admin/licensing.mdx index 691a5b6b6..e7487c60e 100644 --- a/docs/admin/licensing.mdx +++ b/docs/admin/licensing.mdx @@ -23,12 +23,7 @@ Starting 7 days before the license expires, Sourcegraph shows a banner with a li On [Sourcegraph Cloud](/cloud/#how-do-we-update-our-license-key), Sourcegraph manages your license key and the **Product license** page doesn't show the **Update license key** form. To apply a new or renewed license, contact your Sourcegraph account team or [support@sourcegraph.com](mailto:support@sourcegraph.com). -On a self-hosted instance, an administrator can update the license key on the **Product license** page: - -1. Go to **Administration → Configuration → Product license** (`/admin/license`). -2. Under **Update license key**, paste the new key into the **License key** field. -3. Click **Validate & apply license key**. Sourcegraph checks the key and rejects one that is invalid or expired. -4. In the **Confirm license update** dialog, compare the current license with the new one (customer, plan, seat count, and expiry date), then click **Confirm & apply license**. +On a self-hosted instance, go to **Administration → Configuration → Product license** (`/admin/license`). Here, you can update your license key, view details of your current license, and more. The new license takes effect as soon as it's applied. You don't need to restart Sourcegraph.