From 9136c8e90d0c41fe7e528a3f47c4ac8bffd65cce Mon Sep 17 00:00:00 2001 From: Marc LeBlanc <7050295+marcleblanc2@users.noreply.github.com> Date: Mon, 7 Sep 2026 17:21:44 -0600 Subject: [PATCH] Point links at the page the content moved to --- docs/admin/auth/builtin.mdx | 2 +- docs/admin/auth/index.mdx | 10 +++++----- docs/admin/auth/login-form.mdx | 2 +- docs/admin/auth/saml/azure-ad.mdx | 2 +- docs/admin/auth/saml/index.mdx | 2 +- docs/admin/code-hosts/aws-codecommit.mdx | 2 +- docs/admin/code-hosts/gitlab.mdx | 2 +- docs/admin/config/authorization-and-authentication.mdx | 2 +- docs/admin/faq.mdx | 2 +- docs/admin/how-to/monorepo-issues.mdx | 2 +- docs/admin/index.mdx | 2 +- docs/admin/migration/opengrok.mdx | 6 +++--- docs/admin/permissions/syncing.mdx | 2 +- docs/admin/repo/auth.mdx | 2 +- docs/admin/repo/git-config.mdx | 2 +- docs/admin/repo/update-frequency.mdx | 2 +- docs/admin/telemetry/protocol.mdx | 4 ++-- docs/batch-changes/rebasing-changesets.mdx | 2 +- docs/batch-changes/tracking-existing-changesets.mdx | 2 +- docs/cloud/index.mdx | 2 +- docs/code-insights/language-insight-quickstart.mdx | 2 +- docs/code-insights/quickstart.mdx | 2 +- docs/getting-started/github-vs-sourcegraph.mdx | 2 +- docs/self-hosted/deploy/docker-compose/operations.mdx | 4 ++-- docs/self-hosted/deploy/kubernetes/configure.mdx | 2 +- docs/self-hosted/deploy/kubernetes/kustomize.mdx | 2 +- .../deploy/kubernetes/kustomize/migrate.mdx | 4 ++-- docs/self-hosted/deployment-best-practices.mdx | 4 ++-- docs/self-hosted/email.mdx | 6 +++--- docs/self-hosted/how-to/dirty-database.mdx | 2 +- docs/self-hosted/how-to/monitoring-guide.mdx | 2 +- .../self-hosted/how-to/postgres14-index-corruption.mdx | 2 +- .../how-to/rebuild-corrupt-postgres-indexes.mdx | 2 +- docs/self-hosted/http-https-configuration.mdx | 2 +- docs/self-hosted/observability/logs.mdx | 2 +- docs/self-hosted/observability/metrics.mdx | 2 +- docs/self-hosted/observability/troubleshooting.mdx | 2 +- docs/self-hosted/pprof.mdx | 2 +- 38 files changed, 50 insertions(+), 50 deletions(-) diff --git a/docs/admin/auth/builtin.mdx b/docs/admin/auth/builtin.mdx index 521d0f0f5..7f188ae20 100644 --- a/docs/admin/auth/builtin.mdx +++ b/docs/admin/auth/builtin.mdx @@ -1,6 +1,6 @@ # Builtin password authentication -The [`builtin` auth provider](/admin/config/site-config#builtin-password-authentication) manages user accounts inside Sourcegraph. It supports user signup, login, and password reset. This is the simplest provider type to set up, and is the default auth provider on a fresh installation for the first user so they can create an account and become site admin. +The [`builtin` auth provider](/admin/auth/builtin) manages user accounts inside Sourcegraph. It supports user signup, login, and password reset. This is the simplest provider type to set up, and is the default auth provider on a fresh installation for the first user so they can create an account and become site admin. Use this auth provider, if you have no organizational requirements to use a SSO provider. diff --git a/docs/admin/auth/index.mdx b/docs/admin/auth/index.mdx index a60f00e10..aafcb4c3f 100644 --- a/docs/admin/auth/index.mdx +++ b/docs/admin/auth/index.mdx @@ -50,7 +50,7 @@ If you are unsure which auth provider is right for you, we recommend applying th order: - If you have no external identity providers (i.e., not SSO) or are just trying to spin Sourcegraph - up as quickly as possible to try, use [`builtin`](#builtin-password-authentication) authentication. You can + up as quickly as possible to try, use [`builtin`](/admin/auth/builtin) authentication. You can always change the auth configuration later, and user identities from external providers will be linked automatically to existing Sourcegraph accounts using verified email addresses. - If you are deploying Sourcegraph behind a HTTP authentication proxy service, use the @@ -405,7 +405,7 @@ Users can then add Gerrit credentials by visiting their **Settings** > **Account ## OpenID Connect -The [`openidconnect` auth provider](/admin/config/site-config#openid-connect-including-google-workspace) authenticates users via OpenID Connect, which is supported by many external services, including: +The [`openidconnect` auth provider](/admin/auth#openid-connect) authenticates users via OpenID Connect, which is supported by many external services, including: - [Google Workspace (Google accounts)](#google-workspace-google-accounts) - [Okta](https://developer.okta.com/docs/api/resources/oidc.html) @@ -427,7 +427,7 @@ To configure Sourcegraph to authenticate users via OpenID Connect: 1. Provide the OpenID Connect client's issuer, client ID, and client secret in the Sourcegraph site configuration shown below. 1. (Optional) Require users to have a specific email domain name to authenticate (e.g., to limit users to only those from your organization). -Example [`openidconnect` auth provider](/admin/config/site-config#openid-connect-including-google-workspace) configuration: +Example [`openidconnect` auth provider](/admin/auth#openid-connect) configuration: ```json { @@ -449,7 +449,7 @@ Example [`openidconnect` auth provider](/admin/config/site-config#openid-connect Sourcegraph supports the OpenID Connect Discovery standard for configuring the auth provider (using the values provided in the document at, e.g., `https://oidc.example.com/.well-known/openid-configuration`). -See the [`openid` auth provider documentation](/admin/config/site-config#openid-connect-including-google-workspace) for the full set of configuration options. +See the [`openid` auth provider documentation](/admin/auth#openid-connect) for the full set of configuration options. ### How to control user sign-up with OpenID auth provider @@ -478,7 +478,7 @@ Google's Workspace (formerly known as G Suite) supports OpenID Connect, which is 1. Use the **client ID** and **client secret** values in Sourcegraph site configuration (as shown in the example below). 1. Set your Google Workspace domain in `requireEmailDomain` to prevent users outside your organization from signing in. -Example [`openidconnect` auth provider](/admin/config/site-config#openid-connect-including-google-workspace) configuration for Google Workspace: +Example [`openidconnect` auth provider](/admin/auth#openid-connect) configuration for Google Workspace: ```json { diff --git a/docs/admin/auth/login-form.mdx b/docs/admin/auth/login-form.mdx index 38576c8a9..dd922af96 100644 --- a/docs/admin/auth/login-form.mdx +++ b/docs/admin/auth/login-form.mdx @@ -8,7 +8,7 @@ The login form allows users to sign in to Sourcegraph using [configured auth pro Supported for Sourcegraph versions 5.1 or more. -These options do not apply to [`builtin`](/admin/auth/#builtin-password-authentication) and +These options do not apply to [`builtin`](/admin/auth/builtin) and [`http-header`](/admin/auth/#http-authentication-proxies) auth providers. - The builtin auth provider has its own login form. diff --git a/docs/admin/auth/saml/azure-ad.mdx b/docs/admin/auth/saml/azure-ad.mdx index 58c67b6e5..3bb3ae4f5 100644 --- a/docs/admin/auth/saml/azure-ad.mdx +++ b/docs/admin/auth/saml/azure-ad.mdx @@ -21,7 +21,7 @@ ## 2. Add the SAML auth provider to Sourcegraph site config -[Add a SAML auth provider](/admin/auth/#add-a-saml-provider) with `identityProviderMetadataURL` set to the "App Federation Metadata Url" you recorded in the previous section. Here is an example of what your site configuration should look like: +[Add a SAML auth provider](/admin/auth/saml#add-a-saml-provider) with `identityProviderMetadataURL` set to the "App Federation Metadata Url" you recorded in the previous section. Here is an example of what your site configuration should look like: ```json { diff --git a/docs/admin/auth/saml/index.mdx b/docs/admin/auth/saml/index.mdx index 94fcfd602..7b374dd31 100644 --- a/docs/admin/auth/saml/index.mdx +++ b/docs/admin/auth/saml/index.mdx @@ -16,7 +16,7 @@ Select your SAML identity provider for setup instructions: - [JumpCloud](/admin/auth/saml/jump-cloud) - [Other](/admin/auth/saml/generic) -For advanced SAML configuration options, see the [`saml` auth provider documentation](/admin/config/site-config#saml). +For advanced SAML configuration options, see the [`saml` auth provider documentation](/admin/auth/saml). > NOTE: Sourcegraph currently supports at most 1 SAML auth provider at a time (but you can configure additional auth providers of other types). This should not be an issue for 99% of customers. diff --git a/docs/admin/code-hosts/aws-codecommit.mdx b/docs/admin/code-hosts/aws-codecommit.mdx index 54b70f895..1a1c638c2 100644 --- a/docs/admin/code-hosts/aws-codecommit.mdx +++ b/docs/admin/code-hosts/aws-codecommit.mdx @@ -137,7 +137,7 @@ To add CodeCommit repositories in Docker Container: ### Mounting SSH keys into the container 1. Copy all the files at your `$HOME/.ssh directory` to `$HOME/.sourcegraph/config/ssh` directory. - 1. Read our [guide here](/self-hosted/deploy/docker-compose/#git-ssh-configuration) for Docker Compose deployments + 1. Read our [guide here](/self-hosted/deploy/docker-compose/configuration#git-ssh-configuration) for Docker Compose deployments 1. Read our [guide here](/self-hosted/deploy/kubernetes/configure#ssh-for-cloning) for Kubernetes deployments 1. Start (or restart) the container. 1. Connect Sourcegraph to AWS CodeCommit by going to **Sourcegraph > Site Admin > Manage code hosts > Generic Git host** and add the following: diff --git a/docs/admin/code-hosts/gitlab.mdx b/docs/admin/code-hosts/gitlab.mdx index 0522c4c83..6d580a8e0 100644 --- a/docs/admin/code-hosts/gitlab.mdx +++ b/docs/admin/code-hosts/gitlab.mdx @@ -104,7 +104,7 @@ In this case, a user's OAuth token will be used to get a list of repositories th This method requires administrator access to GitLab so that Sourcegraph can access the [admin GitLab Users API endpoint](https://docs.gitlab.com/ee/api/users.html#for-admins). For each GitLab user, this endpoint provides the user ID that comes from the authentication provider, so Sourcegraph can associate a user in its system to a user in GitLab. -Prerequisite: Add the [SAML](/admin/auth/#saml) or [OpenID Connect](/admin/auth/#openid-connect) +Prerequisite: Add the [SAML](/admin/auth/saml) or [OpenID Connect](/admin/auth/#openid-connect) authentication provider you use to sign into GitLab. Then, [add or edit a GitLab connection](#repository-syncing) using an administrator (sudo-level) personal access token, and include the `authorization` field: diff --git a/docs/admin/config/authorization-and-authentication.mdx b/docs/admin/config/authorization-and-authentication.mdx index e2976070e..26f680b49 100644 --- a/docs/admin/config/authorization-and-authentication.mdx +++ b/docs/admin/config/authorization-and-authentication.mdx @@ -51,7 +51,7 @@ Built-in username/password authentication is Sourcegraph’s default authenticat Set `allowSignup` to `false` if you want to create user accounts instead of allowing the user to create their own. -Learn more about [built-in password authentication](/admin/auth/#builtin-password-authentication). +Learn more about [built-in password authentication](/admin/auth/builtin). ### GitHub Enterprise or GitHub Cloud authentication and authorization diff --git a/docs/admin/faq.mdx b/docs/admin/faq.mdx index 826766af3..38c7baf1d 100644 --- a/docs/admin/faq.mdx +++ b/docs/admin/faq.mdx @@ -3,7 +3,7 @@ ## Does Sourcegraph support SVN? For Subversion and other non-Git code hosts, the recommended way to make these accessible in -Sourcegraph is through [`src-expose`](/admin/code-hosts/other#experimental-src-expose). +Sourcegraph is through [`src-expose`](/admin/code-hosts/non-git#installing-src-expose). Alternatively, you can use [`git-svn`](https://git-scm.com/docs/git-svn) or [`svg2git`](https://github.com/svn-all-fast-export/svn2git) to convert Subversion repositories to diff --git a/docs/admin/how-to/monorepo-issues.mdx b/docs/admin/how-to/monorepo-issues.mdx index 1c7872122..aa1f92a77 100644 --- a/docs/admin/how-to/monorepo-issues.mdx +++ b/docs/admin/how-to/monorepo-issues.mdx @@ -43,7 +43,7 @@ Here's an example of a diff to improve symbols performance in a k8s deployment: + memory: 8G ``` -_Learn more about managing resources in [docker-compose](/self-hosted/deploy/docker-compose/#operations) and [kubernetes](/self-hosted/deploy/kubernetes/operations)_ +_Learn more about managing resources in [docker-compose](/self-hosted/deploy/docker-compose/configuration#adjust-resources) and [kubernetes](/self-hosted/deploy/kubernetes/operations)_ ## Slow hover tooltip results diff --git a/docs/admin/index.mdx b/docs/admin/index.mdx index 0ff10c2f8..c2d38668d 100644 --- a/docs/admin/index.mdx +++ b/docs/admin/index.mdx @@ -33,7 +33,7 @@ Sourcegraph administration is primarily managed by site administrators, who are - [Global and user settings](/admin/config/settings) - [Configuring Authorization and Authentication](/admin/config/authorization-and-authentication) - [User authentication](/admin/auth/) - - [Built-in password authentication](/admin/auth/#builtin-password-authentication) + - [Built-in password authentication](/admin/auth/builtin) - [GitHub authentication](/admin/auth/#github) - [GitLab authentication](/admin/auth/#gitlab) - [OpenID connect](/admin/auth/#openid-connect) diff --git a/docs/admin/migration/opengrok.mdx b/docs/admin/migration/opengrok.mdx index 5822b2c4d..992a8952a 100644 --- a/docs/admin/migration/opengrok.mdx +++ b/docs/admin/migration/opengrok.mdx @@ -46,7 +46,7 @@ The following sections guide you through the migration process. ### Deploying Sourcegraph -We offer several methods for deploying Sourcegraph for various requirements—see [Getting started](/#getting-started) to learn more about how to get started with Sourcegraph. +We offer several methods for deploying Sourcegraph for various requirements—see [Getting started](/getting-started) to learn more about how to get started with Sourcegraph. Choose a deployment option and follow the instructions. When you've signed into your Sourcegraph instance as a site admin, continue to the next section. @@ -74,9 +74,9 @@ When you've added repositories and confirmed that you can search and browse them Like Oracle OpenGrok, Sourcegraph is self-hosted. You control who can access it. Sourcegraph supports many user authentication and security options: -- [OpenID Connect user authentication](/admin/auth/#openid-connect) and [SAML user authentication](/admin/auth/#saml) (for Google/Google Workspace accounts, Okta, OneLogin, etc.) +- [OpenID Connect user authentication](/admin/auth/#openid-connect) and [SAML user authentication](/admin/auth/saml) (for Google/Google Workspace accounts, Okta, OneLogin, etc.) - [HTTP user authentication proxies](/admin/auth/#http-authentication-proxies) -- [Builtin username-password authentication](/admin/auth/#builtin-authentication) +- [Builtin username-password authentication](/admin/auth/builtin) - [TLS/SSL and other HTTP/HTTPS configuration](/self-hosted/http-https-configuration) ### Rolling out Sourcegraph organization-wide diff --git a/docs/admin/permissions/syncing.mdx b/docs/admin/permissions/syncing.mdx index a4134af5c..f65868900 100644 --- a/docs/admin/permissions/syncing.mdx +++ b/docs/admin/permissions/syncing.mdx @@ -9,7 +9,7 @@ permissions. Both are on by default, resulting in double polling: Sourcegraph collects this information and stores it in internal database. -To see which code hosts support permission syncing, please refer to [Supported code hosts table](/admin/#supported-code-hosts). +To see which code hosts support permission syncing, please refer to [Supported code hosts table](/admin/code-hosts). ## How it works diff --git a/docs/admin/repo/auth.mdx b/docs/admin/repo/auth.mdx index 495585d9e..30ee35558 100644 --- a/docs/admin/repo/auth.mdx +++ b/docs/admin/repo/auth.mdx @@ -31,7 +31,7 @@ Some providers may require additional configuration, consult the [code host spec ## Mounting SSH keys into the container -- [Sourcegraph with Docker Compose](/self-hosted/deploy/docker-compose/): See [the Docker Compose git configuration guide](/self-hosted/deploy/docker-compose/#git-configuration). +- [Sourcegraph with Docker Compose](/self-hosted/deploy/docker-compose/): See [the Docker Compose git configuration guide](/self-hosted/deploy/docker-compose/configuration#git-configuration). - [Sourcegraph with Kubernetes](/self-hosted/deploy/kubernetes/): See [Configure repository cloning via SSH](/self-hosted/deploy/kubernetes/configure#ssh-for-cloning). ## Troubleshooting diff --git a/docs/admin/repo/git-config.mdx b/docs/admin/repo/git-config.mdx index 19f070df3..8e9f63c97 100644 --- a/docs/admin/repo/git-config.mdx +++ b/docs/admin/repo/git-config.mdx @@ -4,7 +4,7 @@ Sourcegraph supports customising [git-config](https://git-scm.com/docs/git-confi This guide documents how to configure git-config. To set up SSH and authentication for repositories, see [Repository authentication](/admin/repo/auth). -- [Sourcegraph with Docker Compose](/self-hosted/deploy/docker-compose/): See [the Docker Compose git configuration guide](/self-hosted/deploy/docker-compose/#git-configuration). +- [Sourcegraph with Docker Compose](/self-hosted/deploy/docker-compose/): See [the Docker Compose git configuration guide](/self-hosted/deploy/docker-compose/configuration#git-configuration). - [Sourcegraph with Kubernetes](/self-hosted/deploy/kubernetes/): See [Configure repository cloning via SSH](/self-hosted/deploy/kubernetes/configure#ssh-for-cloning). ## Example: alternate clone URL for repos diff --git a/docs/admin/repo/update-frequency.mdx b/docs/admin/repo/update-frequency.mdx index e839f8af3..9a38c6f24 100644 --- a/docs/admin/repo/update-frequency.mdx +++ b/docs/admin/repo/update-frequency.mdx @@ -29,7 +29,7 @@ You may also choose to disable automatic Git updates entirely and instead [confi ## Repo Updater State -> NOTE: [Instrumentation](/admin/faq#i-am-getting-error-cluster-information-not-available-in-the-instrumentation-page-what-should-i-do) (where Repo Updater State resides) is only available for Kubernetes instances. +> NOTE: [Instrumentation](/self-hosted/faq#i-am-getting-error-cluster-information-not-available-in-the-instrumentation-page-what-should-i-do) (where Repo Updater State resides) is only available for Kubernetes instances. **Repo Updater State** is a useful debugging tool for site admins to monitor: diff --git a/docs/admin/telemetry/protocol.mdx b/docs/admin/telemetry/protocol.mdx index 131280be0..7d28248a2 100644 --- a/docs/admin/telemetry/protocol.mdx +++ b/docs/admin/telemetry/protocol.mdx @@ -56,7 +56,7 @@ To learn more, refer to our [telemetry documentation](https://sourcegraph.com/do | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | id | [string](#string) | |

Generated ID of the event, currently expected to be UUID v4.

| -| timestamp | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | |

Timestamp of when the original event was recorded.

| +| timestamp | [google.protobuf.Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp) | |

Timestamp of when the original event was recorded.

| | feature | [string](#string) | |

Feature associated with the event in camelCase, e.g. 'myFeature'.

| | action | [string](#string) | |

Action associated with the event in camelCase, e.g. 'pageView'.

| | source | [EventSource](#telemetrygateway-v1-EventSource) | |

Source of the event.

| @@ -194,7 +194,7 @@ callsites, and is the primary means of recording product interaction metadata. | version | [int32](#int32) | |

Version of the event parameters, used for indicating the "shape" of this

event's metadata, beginning at 0. Useful for denoting if the shape of

metadata has changed in any way.

| | legacy_metadata | [EventParameters.LegacyMetadataEntry](#telemetrygateway-v1-EventParameters-LegacyMetadataEntry) | repeated | **Deprecated.**

DEPRECATED, legacy metadata format that only accepted int64 - use the new

'metadata' field instead, which accepts float values. Values sent through

this proto field will be merged into the new metadata attributes.

| | metadata | [EventParameters.MetadataEntry](#telemetrygateway-v1-EventParameters-MetadataEntry) | repeated |

Strictly typed exported-by-default metadata, restricted to numeric values

to ensure no sensitive attributes are exported. Sourcegraph telemetry SDKs

must use programming language type-checking to ensure metadata keys are

statically known.

| -| private_metadata | [google.protobuf.Struct](#google-protobuf-Struct) | optional |

Additional potentially sensitive metadata - i.e. not restricted to numeric

values.

🚨 SECURITY: This metadata is NOT exported from instances by default, as it

can contain arbitrarily-shaped data that may accidentally contain sensitive

or private contents.

This metadata is only exported on an allowlist basis based on terms of

use agreements and combinations of event feature and action, alongside

careful audit of callsites. For the list of allowlisted properties, refer

to this generated page:

https://sourcegraph.com/docs/admin/telemetry/private-metadata-allowlist

| +| private_metadata | [google.protobuf.Struct](https://protobuf.dev/reference/protobuf/google.protobuf/#struct) | optional |

Additional potentially sensitive metadata - i.e. not restricted to numeric

values.

🚨 SECURITY: This metadata is NOT exported from instances by default, as it

can contain arbitrarily-shaped data that may accidentally contain sensitive

or private contents.

This metadata is only exported on an allowlist basis based on terms of

use agreements and combinations of event feature and action, alongside

careful audit of callsites. For the list of allowlisted properties, refer

to this generated page:

https://sourcegraph.com/docs/admin/telemetry/private-metadata-allowlist

| | billing_metadata | [EventBillingMetadata](#telemetrygateway-v1-EventBillingMetadata) | optional |

Optional billing-related metadata.

| diff --git a/docs/batch-changes/rebasing-changesets.mdx b/docs/batch-changes/rebasing-changesets.mdx index 6ddd991f6..3cf00dafb 100644 --- a/docs/batch-changes/rebasing-changesets.mdx +++ b/docs/batch-changes/rebasing-changesets.mdx @@ -12,7 +12,7 @@ If your codehost requires changesets to be up to date with the main branch, you ## Requirements -- Sourcegraph instance with repositories in it. See the [Quickstart](/#quick-install) guide on how to set up a Sourcegraph instance +- Sourcegraph instance with repositories in it. See the [Quickstart](/self-hosted/deploy) guide on how to set up a Sourcegraph instance - A [global service account token](/batch-changes/configuring-credentials#global-service-account-tokens) for Batch Changes (**a personal access token cannot currently be used for importing changesets**) ## Select changesets to rebase diff --git a/docs/batch-changes/tracking-existing-changesets.mdx b/docs/batch-changes/tracking-existing-changesets.mdx index cfad94d92..2b18c09e9 100644 --- a/docs/batch-changes/tracking-existing-changesets.mdx +++ b/docs/batch-changes/tracking-existing-changesets.mdx @@ -12,7 +12,7 @@ Batch Changes allow you not only to [publish changesets](/batch-changes/publishi ## Requirements -- Sourcegraph instance with repositories in it. See the [Quickstart](/#quick-install) guide on how to set up a Sourcegraph instance +- Sourcegraph instance with repositories in it. See the [Quickstart](/self-hosted/deploy) guide on how to set up a Sourcegraph instance - A [global service account token](/batch-changes/configuring-credentials#global-service-account-tokens) for Batch Changes (**a personal access token cannot currently be used for importing changesets**) ## Importing changesets into a batch change diff --git a/docs/cloud/index.mdx b/docs/cloud/index.mdx index 04864de2c..11fe73cd3 100644 --- a/docs/cloud/index.mdx +++ b/docs/cloud/index.mdx @@ -152,7 +152,7 @@ All Sourcegraph Cloud instances are provisioned with a Sourcegraph-managed SMTP - [Code Monitoring](/code-monitoring/) notifications - Inviting other users to a Sourcegraph instance, or to an organization/team on a Sourcegraph instance - Important updates to user accounts (for example, creation of API keys) -- For [`builtin` authentication](/admin/auth/#builtin-password-authentication), password resets and email verification +- For [`builtin` authentication](/admin/auth/builtin), password resets and email verification By default, emails will be sent from an `@cloud.sourcegraph.com` email address. To test email delivery, refer to [sending a test email](/self-hosted/email#sending-a-test-email). diff --git a/docs/code-insights/language-insight-quickstart.mdx b/docs/code-insights/language-insight-quickstart.mdx index 2723c24f9..193f5c352 100644 --- a/docs/code-insights/language-insight-quickstart.mdx +++ b/docs/code-insights/language-insight-quickstart.mdx @@ -14,7 +14,7 @@ For more information about Code Insights see the [Code Insights](/code-insights/ ### 1. Visit your Sourcegraph instance /Insights page and select "+ Create new insight" -If you don't see the /Insights page you need to [enable code insights](quickstart#1-enable-the-experimental-feature-flag). +If you don't see the /Insights page you need to [enable code insights](/code-insights/quickstart#1-if-need-be-enable-the-experimental-feature-flag). ### 2. On the insight type selection page, select "Create language usage insight" diff --git a/docs/code-insights/quickstart.mdx b/docs/code-insights/quickstart.mdx index 2f2533c09..2ad382d01 100644 --- a/docs/code-insights/quickstart.mdx +++ b/docs/code-insights/quickstart.mdx @@ -13,7 +13,7 @@ For more information about Code Insights see the [Code Insights](/code-insights/ ## Requirements - You are a Sourcegraph enterprise customer. (Want code insights but aren't enterprise? [Let us know](mailto:feedback@sourcegraph.com).) -- Your Sourcegraph instance has at least 1 repository. (See "[Quickstart](/#quick-install)" on how to setup a Sourcegraph instance.) +- Your Sourcegraph instance has at least 1 repository. (See "[Quickstart](/self-hosted/deploy)" on how to setup a Sourcegraph instance.) - Your Sourcegraph instance is deployed via [Docker Compose](/self-hosted/deploy/docker-compose/) or [Kubernetes](/self-hosted/deploy/kubernetes/). - You are running Sourcegraph version 3.31.1 (August 2021 release) or later. - Note: If you're on Sourcegraph version 3.24 to 3.28, you can instead follow [this gist](https://gist.github.com/Joelkw/f0582b164578aabc3ac936dee43f23e0) to create an insight. Due to the early stage of the product, it's more likely you'll run into trouble, though, so we recommend that you either upgrade your Sourcegraph or reach out to your Sourcegraph reps for help. diff --git a/docs/getting-started/github-vs-sourcegraph.mdx b/docs/getting-started/github-vs-sourcegraph.mdx index f8d45c2f9..865f448f0 100644 --- a/docs/getting-started/github-vs-sourcegraph.mdx +++ b/docs/getting-started/github-vs-sourcegraph.mdx @@ -149,7 +149,7 @@ Symbol search makes it easier to find specific functions, variables, and more by Both GitHub code search and Sourcegraph support symbol searching. GitHub supports symbol search in 10 languages, including C#, Python, Go, Java, JavaScript, TypeScript, PHP, Protocol Buffers, Ruby, and Rust. -Sourcegraph’s [symbol search](/code-navigation/features#symbol-search) is available for more than 75 languages. +Sourcegraph’s [symbol search](/code-search/features#symbol-search) is available for more than 75 languages. | **Features** | **GitHub** | **Sourcegraph** | | --------------------------------------- | -------------------------------------------------------------------------------------------------- | --------------- | diff --git a/docs/self-hosted/deploy/docker-compose/operations.mdx b/docs/self-hosted/deploy/docker-compose/operations.mdx index 1e93ce31f..5e44101cb 100644 --- a/docs/self-hosted/deploy/docker-compose/operations.mdx +++ b/docs/self-hosted/deploy/docker-compose/operations.mdx @@ -8,8 +8,8 @@ The Sourcegraph Docker Compose yaml file uses [Docker volumes](https://docs.dock Guides for managing cloud storage and backups are available in our cloud-specific installation guides: -- [Storage and backups for Amazon Web Services](/self-hosted/deploy/docker-compose/aws#storage-and-backups) -- [Storage and backups for Azure](/self-hosted/deploy/docker-compose/aws#storage-and-backups) +- [Storage and backups for Amazon Web Services](/self-hosted/deploy/docker-compose/aws) +- [Storage and backups for Azure](/self-hosted/deploy/docker-compose/azure#storage-and-backups) - [Storage and backups for Google Cloud](/self-hosted/deploy/docker-compose/google-cloud#storage-and-backups) - [Storage and backups for Digital Ocean](/self-hosted/deploy/docker-compose/digitalocean#storage-and-backups) diff --git a/docs/self-hosted/deploy/kubernetes/configure.mdx b/docs/self-hosted/deploy/kubernetes/configure.mdx index 40ddd61be..149698893 100644 --- a/docs/self-hosted/deploy/kubernetes/configure.mdx +++ b/docs/self-hosted/deploy/kubernetes/configure.mdx @@ -49,7 +49,7 @@ Sourcegraph has removed Role-Based Access Control (RBAC) resources from the defa ### Non-Privileged -By default, all Sourcegraph services are deployed in a non-root and non-privileged mode, as defined in the [base](/self-hosted/deploy/kubernetes/kustomize/#base) cluster. +By default, all Sourcegraph services are deployed in a non-root and non-privileged mode, as defined in the [base](https://github.com/sourcegraph/deploy-sourcegraph-k8s/tree/master/base) cluster. ### Privileged diff --git a/docs/self-hosted/deploy/kubernetes/kustomize.mdx b/docs/self-hosted/deploy/kubernetes/kustomize.mdx index cfa8f9457..f7fe1fc81 100644 --- a/docs/self-hosted/deploy/kubernetes/kustomize.mdx +++ b/docs/self-hosted/deploy/kubernetes/kustomize.mdx @@ -53,7 +53,7 @@ See the [docs on reference repository](/self-hosted/deploy/repositories) for det ### **Step 2**: Set up a directory for your instance -Create a copy of the [instances/template](/self-hosted/deploy/kubernetes/kustomize/#template) directory and rename it to `instances/my-sourcegraph`: +Create a copy of the [instances/template](https://github.com/sourcegraph/deploy-sourcegraph-k8s/tree/master/instances/template) directory and rename it to `instances/my-sourcegraph`: ```bash $ cp -R instances/template instances/my-sourcegraph diff --git a/docs/self-hosted/deploy/kubernetes/kustomize/migrate.mdx b/docs/self-hosted/deploy/kubernetes/kustomize/migrate.mdx index ed328c5c5..10a4e8e6d 100644 --- a/docs/self-hosted/deploy/kubernetes/kustomize/migrate.mdx +++ b/docs/self-hosted/deploy/kubernetes/kustomize/migrate.mdx @@ -61,7 +61,7 @@ Set up a release branch from the latest version branch in your local fork of the ## Step 3: Set up a directory for your instance -Create a copy of the [instances/template](/self-hosted/deploy/kubernetes/kustomize/#template) directory and rename it to `instances/my-sourcegraph`: +Create a copy of the [instances/template](https://github.com/sourcegraph/deploy-sourcegraph-k8s/tree/master/instances/template) directory and rename it to `instances/my-sourcegraph`: ```bash $ cp -R instances/template instances/my-sourcegraph @@ -218,7 +218,7 @@ If your instance was deployed using the non-privileged overlay, you can follow t **2.** Review the changes to ensure that the manifests generated by your new overlay are similar to the ones currently being used by your active cluster. -[Compare the manifests](/self-hosted/deploy/kubernetes/kustomize/#between-an-overlay-and-a-running-cluster) generated by your new overlay with the ones in your running cluster using the command below: +[Compare the manifests](/self-hosted/deploy/kubernetes/operations#between-an-overlay-and-a-running-cluster) generated by your new overlay with the ones in your running cluster using the command below: ```bash $ kubectl diff -l deploy=sourcegraph -f cluster.yaml diff --git a/docs/self-hosted/deployment-best-practices.mdx b/docs/self-hosted/deployment-best-practices.mdx index d978adfb0..4a52e76c3 100644 --- a/docs/self-hosted/deployment-best-practices.mdx +++ b/docs/self-hosted/deployment-best-practices.mdx @@ -32,8 +32,8 @@ _Unless scale, resiliency, or some other legitimate need exists that necessitate ### Docker Compose -- Be sure your deployment meets our [Docker Compose requirements](/self-hosted/deploy/docker-compose/#requirements). -- Review the [configuration section](/self-hosted/deploy/docker-compose/#configuration) of our [Docker Compose deployment docs](/self-hosted/deploy/docker-compose/). +- Be sure your deployment meets our [Docker Compose requirements](/self-hosted/deploy/docker-compose#prerequisites). +- Review the [configuration section](/self-hosted/deploy/docker-compose/configuration) of our [Docker Compose deployment docs](/self-hosted/deploy/docker-compose/). ### Sourcegraph Server (single Docker container) diff --git a/docs/self-hosted/email.mdx b/docs/self-hosted/email.mdx index f8b28259f..b58744281 100644 --- a/docs/self-hosted/email.mdx +++ b/docs/self-hosted/email.mdx @@ -5,7 +5,7 @@ Sourcegraph uses an SMTP server of your choosing to send emails for: - [Code Monitoring](/code-monitoring/) notifications - Inviting other users to a Sourcegraph instance, or to an organization/team on a Sourcegraph instance - Important updates to a user accounts (for example, creation of API keys) -- For [`builtin` authentication](/admin/auth/#builtin-password-authentication), password resets and email verification +- For [`builtin` authentication](/admin/auth/builtin), password resets and email verification Sourcegraph Cloud customers can take advantage of managed SMTP servers - @@ -19,14 +19,14 @@ This helps prevent Sourcegraph from sending product emails to invalid or inactiv Users that create accounts through an external [authentication provider](/admin/auth/), such as GitHub or SAML, will automatically have verified email addresses from the external provider. -When SMTP is configured, users that sign up through [`builtin` authentication](/admin/auth/#builtin-password-authentication) will have the emails they sign up with marked as unverified. +When SMTP is configured, users that sign up through [`builtin` authentication](/admin/auth/builtin) will have the emails they sign up with marked as unverified. To verify their email address, the user can do one of the following: - Click the "set password" link they receive in their email - In the "Emails" tab of their account, click "Send verification email" - Ask a site admin to verify their email manually through the "Emails" tab of their account, or through the `setUserEmailVerified` GraphQL mutation -Users with emails [created by the site admin](/admin/auth/#creating-builtin-authentication-users) through the `/site-admin/users/new` UI will have the same behaviour as the above. Users created directly through GraphQL or the `src` CLI assume that the email provided is verified. +Users with emails [created by the site admin](/admin/auth/builtin#creating-builtin-authentication-users) through the `/site-admin/users/new` UI will have the same behaviour as the above. Users created directly through GraphQL or the `src` CLI assume that the email provided is verified. For SSO (Single Sign-On) enabled instances, it is important to remove the diff --git a/docs/self-hosted/how-to/dirty-database.mdx b/docs/self-hosted/how-to/dirty-database.mdx index c71f02939..8fe358831 100644 --- a/docs/self-hosted/how-to/dirty-database.mdx +++ b/docs/self-hosted/how-to/dirty-database.mdx @@ -25,7 +25,7 @@ The target schema is marked as dirty and no other migration operation is seen ru - This document assumes that you are installing Sourcegraph or were attempting an upgrade when an error occurred. - **NOTE: If you encountered this error during an upgrade, ensure you followed the [proper step upgrade process documented here.](/self-hosted/updates) If you skipped a minor version during an upgrade, you will need to revert back to the last minor version your instance was on before following the steps in this document.** -The following procedure requires that you are able to execute commands from inside the database container. Learn more about shelling into [kubernetes](/self-hosted/deploy/kubernetes/operations#access-the-database) and [docker-compose](/self-hosted/deploy/docker-compose/#access-the-database) instances at these links. +The following procedure requires that you are able to execute commands from inside the database container. Learn more about shelling into [kubernetes](/self-hosted/deploy/kubernetes/operations#access-the-database) and [docker-compose](/self-hosted/deploy/docker-compose/operations#access-the-database) instances at these links. ## Steps to resolve diff --git a/docs/self-hosted/how-to/monitoring-guide.mdx b/docs/self-hosted/how-to/monitoring-guide.mdx index e4bf57f59..0e983129d 100644 --- a/docs/self-hosted/how-to/monitoring-guide.mdx +++ b/docs/self-hosted/how-to/monitoring-guide.mdx @@ -15,4 +15,4 @@ This document assumes that you are a [site admin](/admin/). ## FAQs -See the [monitoring section of our FAQ](/admin/faq#monitoring). +See the [monitoring section of our FAQ](/self-hosted/faq#monitoring). diff --git a/docs/self-hosted/how-to/postgres14-index-corruption.mdx b/docs/self-hosted/how-to/postgres14-index-corruption.mdx index 027867f81..67cada69f 100644 --- a/docs/self-hosted/how-to/postgres14-index-corruption.mdx +++ b/docs/self-hosted/how-to/postgres14-index-corruption.mdx @@ -12,7 +12,7 @@ To identify which version of Sourcegraph you are running in a default Sourcegrap SELECT version(); ``` -> NOTE: You can refer to the following instructions for accessing databases on your deployment type: [Docker Compose](/self-hosted/deploy/docker-compose/#access-the-database), [Kubernetes](/self-hosted/deploy/kubernetes/operations#access-the-database). +> NOTE: You can refer to the following instructions for accessing databases on your deployment type: [Docker Compose](/self-hosted/deploy/docker-compose/operations#access-the-database), [Kubernetes](/self-hosted/deploy/kubernetes/operations#access-the-database). You may also check for index corruption in your database using the `amcheck` by running the following query in your database diff --git a/docs/self-hosted/how-to/rebuild-corrupt-postgres-indexes.mdx b/docs/self-hosted/how-to/rebuild-corrupt-postgres-indexes.mdx index 2742b4c1b..ac6c635fe 100644 --- a/docs/self-hosted/how-to/rebuild-corrupt-postgres-indexes.mdx +++ b/docs/self-hosted/how-to/rebuild-corrupt-postgres-indexes.mdx @@ -21,7 +21,7 @@ psql -U sg -d sg -h localhost -p 3333 In docker compose, you will need to scale down all the other services to prevent new connections from being established. You must run these commands from the machine where sourcegraph is running. -> NOTE: You can refer to the following instructions for accessing databases on your deployment type: [Docker Compose](/self-hosted/deploy/docker-compose/#access-the-database), [Kubernetes](/self-hosted/deploy/kubernetes/operations#access-the-database). +> NOTE: You can refer to the following instructions for accessing databases on your deployment type: [Docker Compose](/self-hosted/deploy/docker-compose/operations#access-the-database), [Kubernetes](/self-hosted/deploy/kubernetes/operations#access-the-database). ```shell export DB=pgsql # change for other databases diff --git a/docs/self-hosted/http-https-configuration.mdx b/docs/self-hosted/http-https-configuration.mdx index 8c954c2af..1c9ca4da6 100644 --- a/docs/self-hosted/http-https-configuration.mdx +++ b/docs/self-hosted/http-https-configuration.mdx @@ -18,7 +18,7 @@ Sourcegraph's single Docker image and Kubernetes deployments use [NGINX](https:/ The first time Sourcegraph is run, it will create an [`nginx.conf`](https://github.com/sourcegraph/sourcegraph-public-snapshot/blob/main/cmd/server/shared/assets/nginx.conf) file at: -- `~/.sourcegraph/config/nginx.conf` on the Docker/Sourcegraph host (presuming you're using the [quickstart `docker run` command](/#quick-install)) +- `~/.sourcegraph/config/nginx.conf` on the Docker/Sourcegraph host (presuming you're using the [quickstart `docker run` command](/self-hosted/deploy)) - `/etc/sourcegraph/nginx.conf` inside the container SSL support requires two things: diff --git a/docs/self-hosted/observability/logs.mdx b/docs/self-hosted/observability/logs.mdx index 810075df5..2c1268544 100644 --- a/docs/self-hosted/observability/logs.mdx +++ b/docs/self-hosted/observability/logs.mdx @@ -14,7 +14,7 @@ A Sourcegraph service's log level is configured via the environment variable `SR - `eror`: Error. - `crit`: Critical. -Learn more about how to apply these environment variables in [docker-compose](/self-hosted/deploy/docker-compose/#set-environment-variables) deployments. +Learn more about how to apply these environment variables in [docker-compose](/self-hosted/deploy/docker-compose/configuration#set-environment-variables) deployments. ## Log format diff --git a/docs/self-hosted/observability/metrics.mdx b/docs/self-hosted/observability/metrics.mdx index 84889df0e..d74c696ba 100644 --- a/docs/self-hosted/observability/metrics.mdx +++ b/docs/self-hosted/observability/metrics.mdx @@ -203,4 +203,4 @@ Prometheus will be available http://localhost:9090. ## Using a custom monitoring system -Please refer to our FAQ item, ["Can I consume Sourcegraph's metrics in my own monitoring system (Datadog, New Relic, etc.)"](/admin/faq#can-i-consume-sourcegraph-s-metrics-in-my-own-monitoring-system-datadog-new-relic-etc). +Please refer to our FAQ item, ["Can I consume Sourcegraph's metrics in my own monitoring system (Datadog, New Relic, etc.)"](/self-hosted/faq#can-i-consume-sourcegraphs-metrics-in-my-own-monitoring-system-datadog-new-relic-etc). diff --git a/docs/self-hosted/observability/troubleshooting.mdx b/docs/self-hosted/observability/troubleshooting.mdx index 4b0fa957b..ae54463c7 100644 --- a/docs/self-hosted/observability/troubleshooting.mdx +++ b/docs/self-hosted/observability/troubleshooting.mdx @@ -178,7 +178,7 @@ If your users are experiencing search timeouts or search performance issues, ple 1. Select the **+** icon on the left-hand side, then choose **Import**. 1. Paste [this JSON](https://gist.githubusercontent.com/slimsag/3fcc134f5ce09728188b94b463131527/raw/f8b545f4ce14b0c30a93f05cd1ee469594957a2c/sourcegraph-debug-search-timeouts.json) into the input and click **Load**. 1. Once the dashboard appears, include screenshots of **the entire** dashboard in the issue report. -1. Include the logs of `zoekt-webserver` container in the `indexed-search` pods. If you are using single Docker container enable [debug logs](/self-hosted/observability/#Logs) first. +1. Include the logs of `zoekt-webserver` container in the `indexed-search` pods. If you are using single Docker container enable [debug logs](/self-hosted/observability/logs) first. #### Scenario: zoekt-webserver is in a `CrashloopBackOff` and `err cannot allocate memory` diff --git a/docs/self-hosted/pprof.mdx b/docs/self-hosted/pprof.mdx index 116329ff5..5f5b6f2f2 100644 --- a/docs/self-hosted/pprof.mdx +++ b/docs/self-hosted/pprof.mdx @@ -10,7 +10,7 @@ Follow the instructions below to generate profiling data. We will use the Source ### Sourcegraph with Docker Compose -See [expose debug port in Docker Compose](/self-hosted/deploy/docker-compose/#operations). +See [expose debug port in Docker Compose](/self-hosted/deploy/docker-compose/configuration#expose-debug-port). ### Sourcegraph with Kubernetes