Repository navigation
Update license key docs to match the Product license page #2073
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
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,25 +7,29 @@ | |
|
|
||
| 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) | ||
| <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 [[email protected]](mailto:[email protected]). | ||
| </Callout> | ||
|
|
||
| These settings live in the JSON object, and you will need to navigate to the _licenseKey_ section of that object. | ||
| 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. | ||
|
|
||
| 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": "<your_key_here>", | ||
| ``` | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 [[email protected]](mailto:[email protected]). 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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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) | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| --- | ||||||
|
|
||||||
|
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.