Skip to content

Update license key docs to match the Product license page - #2073

Merged
enriquegh merged 2 commits into
mainfrom
enrique/update-license-key-docs
Oct 8, 2026
Merged

enriquegh merged 2 commits into
mainfrom
enrique/update-license-key-docs

Conversation

@enriquegh

@enriquegh enriquegh commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

Customer feedback: the license key docs were out of date. They said to edit licenseKey under Site admin > Configuration > Site configuration, which no longer exists. On Sourcegraph Cloud, the Product license page has no way to update the key, so the customer ended up editing Advanced configuration by hand.

Changes:

  • admin/licensing: replace the old steps with a pointer to the Product license page, and drop the "takes 10-15 minutes, restart the frontend" note: the change applies on save. Correct the FAQ on expired licenses: only users who are not site admins are blocked. Note that on Cloud, Sourcegraph manages the license key (the form is hidden on Cloud), and point Cloud customers to their account team or support@sourcegraph.com. Note that the form is disabled when SITE_CONFIG or SITE_CONFIG_FILE is set.
  • admin/subscriptions: link to the licensing FAQ instead of repeating the outdated steps.
  • cloud: add an FAQ entry on license keys for Cloud.
  • self-hosted/deploy/kubernetes/configure: point "Add license key" to the Product license page.

Checks: pnpm run check links --check-anchors --check-self-links reports no new findings (266 before and after), and CSpell found no issues in the changed pages.

Amp thread: https://ampcode.com/threads/T-2198952b-2156-4c41-95b8-3d5b5c963010

@vercel

vercel Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sourcegraph-docs Ready Ready Preview Oct 8, 2026 10:41pm UTC

Request Review

@github-actions

github-actions Bot commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

Direct preview links to pages changed in this PR:

Comment thread docs/admin/licensing.mdx Outdated
Comment on lines +28 to +31
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**.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like out of these 4 steps, only the first one is really needed right? Once you get to the page the rest should be self-explanatory

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about:

 1. Go to **Administration → Configuration → Product license** (`/admin/license`).
2. Under **Update license key**, paste the new key into the **License key** field. You will be taken through a series of steps to validate and confirm the new license before applying to the instance

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mainly that I want it to be clear there are some steps after you input the license key and that these should be checked. Open to suggestions though

@bobheadxi bobheadxi Oct 8, 2026 •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My suggestion would be something like:

Go to Administration → Configuration → Product license (/admin/license). Here, you can update your license key, view details of your current license, and more.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you land on that page and can't figure out how to update the key we probably have a problem 😆

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair, shortened things here.

Comment thread docs/admin/licensing.mdx

Any current Administrator can update your license key by going to Administration -> [Advanced configuration](/admin/config/site-config)
<Callout type="note">
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).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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 [Sourcegraph Cloud](/cloud/#how-do-we-update-our-license-key), Sourcegraph manages your license key. To apply a new or renewed license, contact your Sourcegraph account team or [support@sourcegraph.com](mailto:support@sourcegraph.com).

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)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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)
Once you have a license key, configure it in **Administration → Configuration → Product license** (`/admin/license`). See [How can we update our license key?](/admin/licensing#how-can-we-update-our-license-key)

@bobheadxi bobheadxi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you!

enriquegh and others added 2 commits October 8, 2026 15:39
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@ampcode.com>
Amp-Thread-ID: https://ampcode.com/threads/T-2198952b-2156-4c41-95b8-3d5b5c963010
@enriquegh
enriquegh enabled auto-merge (squash) October 8, 2026 22:40
@enriquegh
enriquegh force-pushed the enrique/update-license-key-docs branch from c18de6c to b286a1f Compare October 8, 2026 22:40
@enriquegh
enriquegh merged commit 296a696 into main Oct 8, 2026
8 checks passed
@enriquegh
enriquegh deleted the enrique/update-license-key-docs branch October 8, 2026 22:41
@enriquegh
enriquegh restored the enrique/update-license-key-docs branch October 8, 2026 22:46
enriquegh added a commit that referenced this pull request Oct 8, 2026
Applies two review suggestions from @bobheadxi on #2073 that came in
after it merged:

- `admin/licensing`: shorten the Sourcegraph Cloud note to say
Sourcegraph manages the license key, without describing the hidden form
([comment](#2073 (comment))).
- `self-hosted/deploy/kubernetes/configure`: name the exact page,
**Administration → Configuration → Product license** (`/admin/license`)
([comment](#2073 (comment))).

Amp thread:
https://ampcode.com/threads/T-2198952b-2156-4c41-95b8-3d5b5c963010

Co-authored-by: Amp <amp@ampcode.com>

This branch was successfully deployed

1 active deployment
Preview — b286a1ff Deployed Oct 8, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants