From c116e98134ce9ccee85c12ba6a25146b96037bab Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 20:01:00 +0100 Subject: [PATCH 01/21] Clean up some documentation Minor things to make docs a bit less repetitive and remove some irrelevant information. --- docs/admin/config/advanced_config_file.mdx | 4 ---- docs/admin/config/settings.schema.json | 1 - docs/admin/config/site.schema.json | 1 - docs/admin/config/webhooks/outgoing.mdx | 5 ----- docs/code-search/faq.mdx | 4 ---- docs/code-search/index.mdx | 18 +----------------- docs/own/index.mdx | 11 ----------- docs/sourcegraph-accounts/index.mdx | 2 +- 8 files changed, 2 insertions(+), 44 deletions(-) delete mode 120000 docs/admin/config/settings.schema.json delete mode 120000 docs/admin/config/site.schema.json diff --git a/docs/admin/config/advanced_config_file.mdx b/docs/admin/config/advanced_config_file.mdx index d334ebd16..6ae75271c 100644 --- a/docs/admin/config/advanced_config_file.mdx +++ b/docs/admin/config/advanced_config_file.mdx @@ -3,10 +3,6 @@ Some teams require Sourcegraph configuration to be stored in version control as opposed to editing via the Site admin UI. -As of Sourcegraph v3.4+, this is possible for [site configuration](/admin/config/site_config) -, [code host configuration](/admin/code_hosts/), and [global settings](/admin/config/settings). As of Sourcegraph v3.34+, Sourcegraph -supports merging multiple site config files. - ## Benefits 1. Configuration can be checked into version control (e.g., Git). diff --git a/docs/admin/config/settings.schema.json b/docs/admin/config/settings.schema.json deleted file mode 120000 index 276fb26bd..000000000 --- a/docs/admin/config/settings.schema.json +++ /dev/null @@ -1 +0,0 @@ -../../../schema/settings.schema.json \ No newline at end of file diff --git a/docs/admin/config/site.schema.json b/docs/admin/config/site.schema.json deleted file mode 120000 index e9be0d6b0..000000000 --- a/docs/admin/config/site.schema.json +++ /dev/null @@ -1 +0,0 @@ -../../../schema/site.schema.json \ No newline at end of file diff --git a/docs/admin/config/webhooks/outgoing.mdx b/docs/admin/config/webhooks/outgoing.mdx index 42a425c5d..6a742d3c2 100644 --- a/docs/admin/config/webhooks/outgoing.mdx +++ b/docs/admin/config/webhooks/outgoing.mdx @@ -1,10 +1,5 @@ # Outgoing webhooks - - {' '} - This feature is supported on Sourcegraph versions 5.0 or more. - - Outgoing webhooks can be configured on a Sourcegraph instance in order to send Sourcegraph events to external tools and services. This allows for deeper integrations between Sourcegraph and other applications. Currently, webhooks are only implemented for events related to [Batch Changes](/batch-changes/). They also cannot yet be scoped to specific entities, meaning that they will be triggered for all events of the specified type across Sourcegraph. Expanded support for more event types and scoped events is planned for the future. Please [let us know](mailto:feedback@sourcegraph.com) what types of events you would like to see implemented next, or if you have any other feedback! diff --git a/docs/code-search/faq.mdx b/docs/code-search/faq.mdx index 3f0b11597..449346bff 100644 --- a/docs/code-search/faq.mdx +++ b/docs/code-search/faq.mdx @@ -26,10 +26,6 @@ By default, files larger than **1 MB** are excluded from search results. Code Search supports almost all programming languages: Java, Python, Go, JavaScript, TypeScript, C#/C/C++, Swift, Objective-C, Kotlin, Ruby, Scala, Rust, Perl, Dart, Erlang, COBOL, Clojure, Lisp, Shell, Terraform, Lua, GraphQL, Thrift, Protobuf, YAML, JSON, Jsonnet, R, PHP, Elixir, Haskell, PowerShell, OCaml, CUDA, Pascal, Verilog, VHDL, Groovy, and Tcl. -### What deployment options are available with Code Search? - -Code Search supports the following deployment options: Kubernetes cluster, Amazon EKS or EC2, Google GKE, Microsoft, Azure AKS, Docker Compose, and Docker Compose in GCP. Read more about our [deployment docs here](/admin/deploy). - ## Code Navigation ## Why are my results sometimes incorrect? diff --git a/docs/code-search/index.mdx b/docs/code-search/index.mdx index 9ec23f29a..b5839c178 100644 --- a/docs/code-search/index.mdx +++ b/docs/code-search/index.mdx @@ -38,7 +38,6 @@ Sourcegraph's Code Search empowers you to: -{' '} -## FAQs - -### Does Code Search work with my repositories? - -Code Search works with all your repositories. Likewise, you can also [search through our public code](https://sourcegraph.com/search) that has a 2 million+ open source codebase. - -### Do I need to enable Code Navigation? - -No, the default search-based code navigation works out of the box without any configuration. However, for an advanced and customized navigation experience your site admin will set up precise code navigation. - -### What is the max file size limit for Code Search? - -By default, files larger than **1 MB** are excluded from search results. - - {' '} - Read more in detail about other [Code Search FAQs here →](/code-search/faq) + Check out the [Code Search FAQs here →](/code-search/faq) diff --git a/docs/own/index.mdx b/docs/own/index.mdx index 2481d8a50..baa77e9a7 100644 --- a/docs/own/index.mdx +++ b/docs/own/index.mdx @@ -4,17 +4,6 @@ Code ownership is aimed at helping find the right person and team to contact, for any question, at any time. We are starting out with code ownership, ownership inference and assignments and are exploring ways to help you find someone to answer _every_ question. -## Enabling code ownership - -Code ownership is enabled by default. If you like to disable it from being shown in the UI, you can create the feature flag `enable-ownership-panels` and set it to `false`: - -- Go to **Site-admin > Feature flags** -- If the feature flag `enable-ownership-panels` doesn't yet exist, click **Create feature flag** -- Under **Name**, put `enable-ownership-panels` -- For **Type** select **Boolean** -- And set **Value** to **False** -- Click **Create flag** - ## Concepts **Owner**: An owner is defined as a person or a team in Sourcegraph. diff --git a/docs/sourcegraph-accounts/index.mdx b/docs/sourcegraph-accounts/index.mdx index 6c9d8fd4f..1e1b058dd 100644 --- a/docs/sourcegraph-accounts/index.mdx +++ b/docs/sourcegraph-accounts/index.mdx @@ -8,7 +8,7 @@ The system is designed to be and operated with high-security standards to protec ### Do Sourcegraph Enterprise users use Sourcegraph Accounts? -No, Sourcegraph Enterprise users (both on Cloud and on-prem) **do not** use Sourcegraph Accounts. They continue using the SSO capability built into the Sourcegraph application. +No, Sourcegraph Enterprise users **do not** use Sourcegraph Accounts. They continue using the SSO capability built into the Sourcegraph application. ### How to change, set or reset passwords? From 0bad30a39748a9b825aa74edcda17832bac7a340 Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 20:05:31 +0100 Subject: [PATCH 02/21] Move Code Navigation to top level in navigation This is a whole product suite, it should not be lost somewhere under code search. --- .../code-navigation/auto_indexing.mdx | 0 .../auto_indexing_configuration.mdx | 0 .../code-navigation/envvars.mdx | 77 ++++-------- .../explanations/auto_indexing_inference.mdx | 0 .../code-navigation/explanations/uploads.mdx | 0 .../code-navigation/features.mdx | 0 .../how-to/adding_scip_to_workflows.mdx | 0 ...p_uploads_from_ci_cd_and_auto_indexing.mdx | 0 .../code-navigation/how-to/index.mdx | 0 .../how-to/index_a_go_repository.mdx | 0 ...a_typescript_and_javascript_repository.mdx | 0 .../how-to/index_other_languages.mdx | 0 ...policies_resource_usage_best_practices.mdx | 0 .../code-navigation/index.mdx | 0 .../inference_configuration.mdx | 0 .../precise_code_navigation.mdx | 0 ...private-maven-repository-configuration.mdx | 0 .../code-navigation/rockskip.mdx | 2 +- .../search_based_code_navigation.mdx | 0 .../syntactic_code_navigation.mdx | 0 .../code-navigation/troubleshooting.mdx | 0 .../code-navigation/writing_an_indexer.mdx | 0 src/data/navigation.ts | 68 +++++------ src/data/redirects.ts | 113 ++++++++++++++++++ 24 files changed, 174 insertions(+), 86 deletions(-) rename docs/{code-search => }/code-navigation/auto_indexing.mdx (100%) rename docs/{code-search => }/code-navigation/auto_indexing_configuration.mdx (100%) rename docs/{code-search => }/code-navigation/envvars.mdx (53%) rename docs/{code-search => }/code-navigation/explanations/auto_indexing_inference.mdx (100%) rename docs/{code-search => }/code-navigation/explanations/uploads.mdx (100%) rename docs/{code-search => }/code-navigation/features.mdx (100%) rename docs/{code-search => }/code-navigation/how-to/adding_scip_to_workflows.mdx (100%) rename docs/{code-search => }/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing.mdx (100%) rename docs/{code-search => }/code-navigation/how-to/index.mdx (100%) rename docs/{code-search => }/code-navigation/how-to/index_a_go_repository.mdx (100%) rename docs/{code-search => }/code-navigation/how-to/index_a_typescript_and_javascript_repository.mdx (100%) rename docs/{code-search => }/code-navigation/how-to/index_other_languages.mdx (100%) rename docs/{code-search => }/code-navigation/how-to/policies_resource_usage_best_practices.mdx (100%) rename docs/{code-search => }/code-navigation/index.mdx (100%) rename docs/{code-search => }/code-navigation/inference_configuration.mdx (100%) rename docs/{code-search => }/code-navigation/precise_code_navigation.mdx (100%) rename docs/{code-search => }/code-navigation/private-maven-repository-configuration.mdx (100%) rename docs/{code-search => }/code-navigation/rockskip.mdx (98%) rename docs/{code-search => }/code-navigation/search_based_code_navigation.mdx (100%) rename docs/{code-search => }/code-navigation/syntactic_code_navigation.mdx (100%) rename docs/{code-search => }/code-navigation/troubleshooting.mdx (100%) rename docs/{code-search => }/code-navigation/writing_an_indexer.mdx (100%) diff --git a/docs/code-search/code-navigation/auto_indexing.mdx b/docs/code-navigation/auto_indexing.mdx similarity index 100% rename from docs/code-search/code-navigation/auto_indexing.mdx rename to docs/code-navigation/auto_indexing.mdx diff --git a/docs/code-search/code-navigation/auto_indexing_configuration.mdx b/docs/code-navigation/auto_indexing_configuration.mdx similarity index 100% rename from docs/code-search/code-navigation/auto_indexing_configuration.mdx rename to docs/code-navigation/auto_indexing_configuration.mdx diff --git a/docs/code-search/code-navigation/envvars.mdx b/docs/code-navigation/envvars.mdx similarity index 53% rename from docs/code-search/code-navigation/envvars.mdx rename to docs/code-navigation/envvars.mdx index 0df390f57..8823e8a1a 100644 --- a/docs/code-search/code-navigation/envvars.mdx +++ b/docs/code-navigation/envvars.mdx @@ -8,23 +8,6 @@ The following are variables are read from the `frontend` service to control code navigation behavior exposed via the GraphQL API. -| **Name** | **Default** | **Description** | -| ------------------------------------------------------------------- | ----------- | ------------------------------------------------------------- | -| `PRECISE_CODE_INTEL_DIAGNOSTICS_COUNT_MIGRATION_BATCH_SIZE` | `1000` | The max no. of document records to migrate at a time. | -| `PRECISE_CODE_INTEL_DIAGNOSTICS_COUNT_MIGRATION_BATCH_INTERVAL` | `1s` | The timeout between processing migration batches. | -| `PRECISE_CODE_INTEL_DEFINITIONS_COUNT_MIGRATION_BATCH_SIZE` | `1000` | The maximum number of definition records to migrate at once. | -| `PRECISE_CODE_INTEL_DEFINITIONS_COUNT_MIGRATION_BATCH_INTERVAL` | `1s` | The timeout between processing migration batches. | -| `PRECISE_CODE_INTEL_REFERENCES_COUNT_MIGRATION_BATCH_SIZE` | `1000` | The maximum number of reference records to migrate at a time. | -| `PRECISE_CODE_INTEL_REFERENCES_COUNT_MIGRATION_BATCH_INTERVAL` | `1s` | The timeout between processing migration batches. | -| `PRECISE_CODE_INTEL_DOCUMENT_COLUMN_SPLIT_MIGRATION_BATCH_SIZE` | `100` | The maximum number of document records to migrate at a time. | -| `PRECISE_CODE_INTEL_DOCUMENT_COLUMN_SPLIT_MIGRATION_BATCH_INTERVAL` | `1s` | The timeout between processing migration batches. | -| `PRECISE_CODE_INTEL_API_DOCS_SEARCH_MIGRATION_BATCH_SIZE` | `1` | The maximum number of bundles to migrate at a time. | -| `PRECISE_CODE_INTEL_API_DOCS_SEARCH_MIGRATION_BATCH_INTERVAL` | `1s` | The timeout between processing migration batches. | -| `PRECISE_CODE_INTEL_COMMITTED_AT_MIGRATION_BATCH_SIZE` | `100` | The maximum number of upload records to migrate at a time. | -| `PRECISE_CODE_INTEL_COMMITTED_AT_MIGRATION_BATCH_INTERVAL` | `1s` | The timeout between processing migration batches. | -| `PRECISE_CODE_INTEL_REFERENCE_COUNT_MIGRATION_BATCH_SIZE` | `100` | The maximum number of upload records to migrate at a time. | -| `PRECISE_CODE_INTEL_REFERENCE_COUNT_MIGRATION_BATCH_INTERVAL` | `1s` | The timeout between processing migration batches. | - The following settings should be the same for the [`precise-code-intel-worker`](#precise-code-intel-worker) service as well. | **Name** | **Default** | **Description** | @@ -71,50 +54,42 @@ The following variables influence the behavior of the [`codeintel-auto-indexing` The following settings should be the same for the [`frontend`](#frontend) service as well. -| **Name** | **Default** | **Description** | -| ----------------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------- | -| `PRECISE_CODE_INTEL_AUTO_INDEX_MAXIMUM_REPOSITORIES_INSPECTED_PER_SECOND` | `0` | The maximum number of repositories inspected for auto-indexing per second. Set to zero to disable limit. | -| `PRECISE_CODE_INTEL_AUTO_INDEX_MAXIMUM_REPOSITORIES_UPDATED_PER_SECOND` | `0` | The maximum number of repositories cloned or fetched for auto-indexing per second. Set to zero to disable limit. | -| `PRECISE_CODE_INTEL_AUTO_INDEX_MAXIMUM_INDEX_JOBS_PER_INFERRED_CONFIGURATION` | `25` | Repositories with a number of inferred auto-index jobs exceeding this threshold will be auto-indexed | +| **Name** | **Default** | **Description** | +| ----------------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------- | +| `PRECISE_CODE_INTEL_AUTO_INDEX_MAXIMUM_INDEX_JOBS_PER_INFERRED_CONFIGURATION` | `25` | Repositories with a number of inferred auto-index jobs exceeding this threshold will be auto-indexed | ### `codeintel-janitor` The following variables influence the behavior of the [`codeintel-janitor` worker task](/admin/workers#codeintel-janitor). -| **Name** | **Default** | **Description** | | -| ------------------------------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --- | -| `PRECISE_CODE_INTEL_UPLOAD_TIMEOUT` | `24h` | The maximum time an upload can be in the 'uploading' state. | -| `PRECISE_CODE_INTEL_CLEANUP_TASK_INTERVAL` | `1m` | The frequency with which to run periodic codeintel cleanup tasks. | -| `PRECISE_CODE_INTEL_COMMIT_RESOLVER_TASK_INTERVAL` | `10s` | The frequency with which to run the periodic commit resolver task. | -| `PRECISE_CODE_INTEL_COMMIT_RESOLVER_MINIMUM_TIME_SINCE_LAST_CHECK` | `24h` | The minimum time the commit resolver will re-check an upload or index record. | -| `PRECISE_CODE_INTEL_COMMIT_RESOLVER_BATCH_SIZE` | `100` | The maximum number of unique commits to resolve at a time. | -| `PRECISE_CODE_INTEL_COMMIT_RESOLVER_MAXIMUM_COMMIT_LAG` | `0s` | The maximum acceptable delay between accepting an upload and its commit becoming resolvable. Be cautious about setting this to a large value, as uploads for unresolvable commits will be retried periodically during this interval. | -| `PRECISE_CODE_INTEL_RETENTION_REPOSITORY_PROCESS_DELAY` | `24h` | The minimum frequency that the same repository's uploads can be considered for expiration. | -| `PRECISE_CODE_INTEL_RETENTION_REPOSITORY_BATCH_SIZE` | `100` | The number of repositories to consider for expiration at a time. | -| `PRECISE_CODE_INTEL_RETENTION_UPLOAD_PROCESS_DELAY` | `24h` | The minimum frequency that the same upload record can be considered for expiration. | -| `PRECISE_CODE_INTEL_RETENTION_UPLOAD_BATCH_SIZE` | `100` | The number of uploads to consider for expiration at a time. | -| `PRECISE_CODE_INTEL_RETENTION_POLICY_BATCH_SIZE` | `100` | The number of policies to consider for expiration at a time. | -| `PRECISE_CODE_INTEL_RETENTION_COMMIT_BATCH_SIZE` | `100` | The number of commits to process per upload at a time. | -| `PRECISE_CODE_INTEL_RETENTION_BRANCHES_CACHE_MAX_KEYS` | `10000` | The number of maximum keys used to cache the set of branches visible from a commit. | -| `PRECISE_CODE_INTEL_CONFIGURATION_POLICY_MEMBERSHIP_BATCH_SIZE` | `100` | The maximum number of policy configurations to update repository membership for at a time. | -| `PRECISE_CODE_INTEL_DOCUMENTATION_SEARCH_CURRENT_MINIMUM_TIME_SINCE_LAST_CHECK` | `24h` | The minimum time the documentation search current janitor will re-check records for a unique search key. | -| `PRECISE_CODE_INTEL_DOCUMENTATION_SEARCH_CURRENT_BATCH_SIZE` | `100` | The maximum number of unique search keys to clean up at a time. | +| **Name** | **Default** | **Description** | | +| ------------------------------------------------------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --- | +| `PRECISE_CODE_INTEL_UPLOAD_TIMEOUT` | `24h` | The maximum time an upload can be in the 'uploading' state. | +| `PRECISE_CODE_INTEL_COMMIT_RESOLVER_MINIMUM_TIME_SINCE_LAST_CHECK` | `24h` | The minimum time the commit resolver will re-check an upload or index record. | +| `PRECISE_CODE_INTEL_COMMIT_RESOLVER_BATCH_SIZE` | `100` | The maximum number of unique commits to resolve at a time. | +| `PRECISE_CODE_INTEL_COMMIT_RESOLVER_MAXIMUM_COMMIT_LAG` | `0s` | The maximum acceptable delay between accepting an upload and its commit becoming resolvable. Be cautious about setting this to a large value, as uploads for unresolvable commits will be retried periodically during this interval. | +| `PRECISE_CODE_INTEL_RETENTION_REPOSITORY_PROCESS_DELAY` | `24h` | The minimum frequency that the same repository's uploads can be considered for expiration. | +| `PRECISE_CODE_INTEL_RETENTION_REPOSITORY_BATCH_SIZE` | `100` | The number of repositories to consider for expiration at a time. | +| `PRECISE_CODE_INTEL_RETENTION_UPLOAD_PROCESS_DELAY` | `24h` | The minimum frequency that the same upload record can be considered for expiration. | +| `PRECISE_CODE_INTEL_RETENTION_UPLOAD_BATCH_SIZE` | `100` | The number of uploads to consider for expiration at a time. | +| `PRECISE_CODE_INTEL_RETENTION_POLICY_BATCH_SIZE` | `100` | The number of policies to consider for expiration at a time. | +| `PRECISE_CODE_INTEL_RETENTION_COMMIT_BATCH_SIZE` | `100` | The number of commits to process per upload at a time. | +| `PRECISE_CODE_INTEL_CONFIGURATION_POLICY_MEMBERSHIP_BATCH_SIZE` | `100` | The maximum number of policy configurations to update repository membership for at a time. | ## precise-code-intel-worker The following are variables are read from the `precise-code-intel-worker` service to control code graph data upload processing behavior. -| **Name** | **Default** | **Description** | -| ----------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------ | -| `PRECISE_CODE_INTEL_WORKER_POLL_INTERVAL` | `1s` | Interval between queries to the upload queue. | -| `PRECISE_CODE_INTEL_WORKER_CONCURRENCY` | `1` | The maximum number of indexes that can be processed concurrently. | -| `PRECISE_CODE_INTEL_WORKER_BUDGET` | `0` | The amount of compressed input data (in bytes) a worker can process concurrently. Zero acts as an infinite budget. | +| **Name** | **Default** | **Description** | +| ----------------------------------------- | ----------- | ----------------------------------------------------------------- | +| `PRECISE_CODE_INTEL_WORKER_POLL_INTERVAL` | `1s` | Interval between queries to the upload queue. | +| `PRECISE_CODE_INTEL_WORKER_CONCURRENCY` | `1` | The maximum number of indexes that can be processed concurrently. | The following settings should be the same for the [`frontend`](#frontend) service as well. -| **Name** | **Default** | **Description** | -| ----------------------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `PRECISE_CODE_INTEL_UPLOAD_BACKEND` | `Blobstore` | The target file service for code graph data uploads. S3, GCS, and Blobstore are supported. In older versions of Sourcegraph (before v3.4.2) `Minio` was also a valid value. | -| `PRECISE_CODE_INTEL_UPLOAD_MANAGE_BUCKET` | `false` | Whether or not the client should manage the target bucket configuration | -| `PRECISE_CODE_INTEL_UPLOAD_BUCKET` | `lsif-uploads` | The name of the bucket to store LSIF uploads in | -| `PRECISE_CODE_INTEL_UPLOAD_TTL` | `168h` | The maximum age of an upload before deletion | +| **Name** | **Default** | **Description** | +| ----------------------------------------- | -------------- | ------------------------------------------------------------------------------------------ | +| `PRECISE_CODE_INTEL_UPLOAD_BACKEND` | `blobstore` | The target file service for code graph data uploads. S3, GCS, and Blobstore are supported. | +| `PRECISE_CODE_INTEL_UPLOAD_MANAGE_BUCKET` | `false` | Whether or not the client should manage the target bucket configuration | +| `PRECISE_CODE_INTEL_UPLOAD_BUCKET` | `lsif-uploads` | The name of the bucket to store LSIF uploads in | +| `PRECISE_CODE_INTEL_UPLOAD_TTL` | `168h` | The maximum age of an upload before deletion | diff --git a/docs/code-search/code-navigation/explanations/auto_indexing_inference.mdx b/docs/code-navigation/explanations/auto_indexing_inference.mdx similarity index 100% rename from docs/code-search/code-navigation/explanations/auto_indexing_inference.mdx rename to docs/code-navigation/explanations/auto_indexing_inference.mdx diff --git a/docs/code-search/code-navigation/explanations/uploads.mdx b/docs/code-navigation/explanations/uploads.mdx similarity index 100% rename from docs/code-search/code-navigation/explanations/uploads.mdx rename to docs/code-navigation/explanations/uploads.mdx diff --git a/docs/code-search/code-navigation/features.mdx b/docs/code-navigation/features.mdx similarity index 100% rename from docs/code-search/code-navigation/features.mdx rename to docs/code-navigation/features.mdx diff --git a/docs/code-search/code-navigation/how-to/adding_scip_to_workflows.mdx b/docs/code-navigation/how-to/adding_scip_to_workflows.mdx similarity index 100% rename from docs/code-search/code-navigation/how-to/adding_scip_to_workflows.mdx rename to docs/code-navigation/how-to/adding_scip_to_workflows.mdx diff --git a/docs/code-search/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing.mdx b/docs/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing.mdx similarity index 100% rename from docs/code-search/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing.mdx rename to docs/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing.mdx diff --git a/docs/code-search/code-navigation/how-to/index.mdx b/docs/code-navigation/how-to/index.mdx similarity index 100% rename from docs/code-search/code-navigation/how-to/index.mdx rename to docs/code-navigation/how-to/index.mdx diff --git a/docs/code-search/code-navigation/how-to/index_a_go_repository.mdx b/docs/code-navigation/how-to/index_a_go_repository.mdx similarity index 100% rename from docs/code-search/code-navigation/how-to/index_a_go_repository.mdx rename to docs/code-navigation/how-to/index_a_go_repository.mdx diff --git a/docs/code-search/code-navigation/how-to/index_a_typescript_and_javascript_repository.mdx b/docs/code-navigation/how-to/index_a_typescript_and_javascript_repository.mdx similarity index 100% rename from docs/code-search/code-navigation/how-to/index_a_typescript_and_javascript_repository.mdx rename to docs/code-navigation/how-to/index_a_typescript_and_javascript_repository.mdx diff --git a/docs/code-search/code-navigation/how-to/index_other_languages.mdx b/docs/code-navigation/how-to/index_other_languages.mdx similarity index 100% rename from docs/code-search/code-navigation/how-to/index_other_languages.mdx rename to docs/code-navigation/how-to/index_other_languages.mdx diff --git a/docs/code-search/code-navigation/how-to/policies_resource_usage_best_practices.mdx b/docs/code-navigation/how-to/policies_resource_usage_best_practices.mdx similarity index 100% rename from docs/code-search/code-navigation/how-to/policies_resource_usage_best_practices.mdx rename to docs/code-navigation/how-to/policies_resource_usage_best_practices.mdx diff --git a/docs/code-search/code-navigation/index.mdx b/docs/code-navigation/index.mdx similarity index 100% rename from docs/code-search/code-navigation/index.mdx rename to docs/code-navigation/index.mdx diff --git a/docs/code-search/code-navigation/inference_configuration.mdx b/docs/code-navigation/inference_configuration.mdx similarity index 100% rename from docs/code-search/code-navigation/inference_configuration.mdx rename to docs/code-navigation/inference_configuration.mdx diff --git a/docs/code-search/code-navigation/precise_code_navigation.mdx b/docs/code-navigation/precise_code_navigation.mdx similarity index 100% rename from docs/code-search/code-navigation/precise_code_navigation.mdx rename to docs/code-navigation/precise_code_navigation.mdx diff --git a/docs/code-search/code-navigation/private-maven-repository-configuration.mdx b/docs/code-navigation/private-maven-repository-configuration.mdx similarity index 100% rename from docs/code-search/code-navigation/private-maven-repository-configuration.mdx rename to docs/code-navigation/private-maven-repository-configuration.mdx diff --git a/docs/code-search/code-navigation/rockskip.mdx b/docs/code-navigation/rockskip.mdx similarity index 98% rename from docs/code-search/code-navigation/rockskip.mdx rename to docs/code-navigation/rockskip.mdx index 0a3d66a2f..8c4d1c7eb 100644 --- a/docs/code-search/code-navigation/rockskip.mdx +++ b/docs/code-navigation/rockskip.mdx @@ -2,7 +2,7 @@ This feature is in Beta stage. -Rockskip is an alternative symbol indexing and query engine for the symbol service intended to improve performance of the symbol sidebar and search-based code navigation on big monorepos. It was added in Sourcegraph 3.38. +Rockskip is an alternative symbol indexing and query engine for the symbol service intended to improve performance of the symbol sidebar and search-based code navigation on big monorepos. ## When should I use Rockskip? diff --git a/docs/code-search/code-navigation/search_based_code_navigation.mdx b/docs/code-navigation/search_based_code_navigation.mdx similarity index 100% rename from docs/code-search/code-navigation/search_based_code_navigation.mdx rename to docs/code-navigation/search_based_code_navigation.mdx diff --git a/docs/code-search/code-navigation/syntactic_code_navigation.mdx b/docs/code-navigation/syntactic_code_navigation.mdx similarity index 100% rename from docs/code-search/code-navigation/syntactic_code_navigation.mdx rename to docs/code-navigation/syntactic_code_navigation.mdx diff --git a/docs/code-search/code-navigation/troubleshooting.mdx b/docs/code-navigation/troubleshooting.mdx similarity index 100% rename from docs/code-search/code-navigation/troubleshooting.mdx rename to docs/code-navigation/troubleshooting.mdx diff --git a/docs/code-search/code-navigation/writing_an_indexer.mdx b/docs/code-navigation/writing_an_indexer.mdx similarity index 100% rename from docs/code-search/code-navigation/writing_an_indexer.mdx rename to docs/code-navigation/writing_an_indexer.mdx diff --git a/src/data/navigation.ts b/src/data/navigation.ts index 36e2802b8..627e7c5d7 100644 --- a/src/data/navigation.ts +++ b/src/data/navigation.ts @@ -53,40 +53,6 @@ export const navigation: NavigationItem[] = [ } ] }, - { - title: 'Code Navigation', - href: '/code-search/code-navigation', - subsections: [ - { - title: 'Features', - href: '/code-search/code-navigation/features' - }, - { - title: 'Search-based code navigation', - href: '/code-search/code-navigation/search_based_code_navigation' - }, - { - title: 'Precise code navigation', - href: '/code-search/code-navigation/precise_code_navigation' - }, - { - title: 'Syntactic code navigation', - href: '/code-search/code-navigation/syntactic_code_navigation' - }, - { - title: 'Auto-indexing', - href: '/code-search/code-navigation/auto_indexing' - }, - { - title: 'Environment Variables', - href: '/code-search/code-navigation/envvars' - }, - { - title: 'Troubleshooting', - href: '/code-search/code-navigation/troubleshooting' - } - ] - }, { title: 'Advanced Features', href: '/code-search/working/saved_searches', @@ -132,6 +98,40 @@ export const navigation: NavigationItem[] = [ href: '/deep-search', sections: [{title: 'Deep Search API', href: '/deep-search/api'}] }, + { + title: 'Code Navigation', + href: '/code-navigation', + sections: [ + { + title: 'Features', + href: '/code-navigation/features' + }, + { + title: 'Search-based code navigation', + href: '/code-navigation/search_based_code_navigation' + }, + { + title: 'Precise code navigation', + href: '/code-navigation/precise_code_navigation' + }, + { + title: 'Syntactic code navigation', + href: '/code-navigation/syntactic_code_navigation' + }, + { + title: 'Auto-indexing', + href: '/code-navigation/auto_indexing' + }, + { + title: 'Environment Variables', + href: '/code-navigation/envvars' + }, + { + title: 'Troubleshooting', + href: '/code-navigation/troubleshooting' + } + ] + }, { title: 'Cody', href: '/cody', diff --git a/src/data/redirects.ts b/src/data/redirects.ts index aa776db9a..cb6389188 100644 --- a/src/data/redirects.ts +++ b/src/data/redirects.ts @@ -5668,6 +5668,119 @@ const redirectsData = [ source: '/how-to-videos/cody', destination: '/tutorials#cody', permanent: true + }, + { + source: '/code-search/code-navigation/auto_indexing', + destination: '/code-navigation/auto_indexing', + permanent: true + }, + { + source: '/code-search/code-navigation/auto_indexing_configuration', + destination: '/code-navigation/auto_indexing_configuration', + permanent: true + }, + { + source: '/code-search/code-navigation/envvars', + destination: '/code-navigation/envvars', + permanent: true + }, + { + source: '/code-search/code-navigation/explanations/auto_indexing_inference', + destination: '/code-navigation/explanations/auto_indexing_inference', + permanent: true + }, + { + source: '/code-search/code-navigation/explanations/uploads', + destination: '/code-navigation/explanations/uploads', + permanent: true + }, + { + source: '/code-search/code-navigation/features', + destination: '/code-navigation/features', + permanent: true + }, + { + source: '/code-search/code-navigation/how-to/adding_scip_to_workflows', + destination: '/code-navigation/how-to/adding_scip_to_workflows', + permanent: true + }, + { + source: '/code-search/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing', + destination: + '/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing', + permanent: true + }, + { + source: '/code-search/code-navigation/how-to', + destination: '/code-navigation/how-to', + permanent: true + }, + { + source: '/code-search/code-navigation/how-to/index_a_go_repository', + destination: '/code-navigation/how-to/index_a_go_repository', + permanent: true + }, + { + source: '/code-search/code-navigation/how-to/index_a_typescript_and_javascript_repository', + destination: + '/code-navigation/how-to/index_a_typescript_and_javascript_repository', + permanent: true + }, + { + source: '/code-search/code-navigation/how-to/index_other_languages', + destination: '/code-navigation/how-to/index_other_languages', + permanent: true + }, + { + source: '/code-search/code-navigation/how-to/policies_resource_usage_best_practices', + destination: + '/code-navigation/how-to/policies_resource_usage_best_practices', + permanent: true + }, + { + source: '/code-search/code-navigation', + destination: '/code-navigation', + permanent: true + }, + { + source: '/code-search/code-navigation/inference_configuration', + destination: '/code-navigation/inference_configuration', + permanent: true + }, + { + source: '/code-search/code-navigation/precise_code_navigation', + destination: '/code-navigation/precise_code_navigation', + permanent: true + }, + { + source: '/code-search/code-navigation/private-maven-repository-configuration', + destination: '/code-navigation/private-maven-repository-configuration', + permanent: true + }, + { + source: '/code-search/code-navigation/rockskip', + destination: '/code-navigation/rockskip', + permanent: true + }, + { + source: '/code-search/code-navigation/search_based_code_navigation', + destination: '/code-navigation/search_based_code_navigation', + permanent: true + }, + { + source: '/code-search/code-navigation/syntactic_code_navigation', + destination: '/code-navigation/syntactic_code_navigation', + permanent: true + }, + { + source: '/code-search/code-navigation/troubleshooting', + destination: '/code-navigation/troubleshooting', + permanent: true + }, + { + source: '/code-search/code-navigation/writing_an_indexer', + destination: '/code-navigation/writing_an_indexer', + permanent: true } ]; From 822e508dc4a2a278e16945109d070b94c4a10678 Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 20:07:34 +0100 Subject: [PATCH 03/21] Fixup all links to code navigation --- docs/admin/architecture.mdx | 4 +- .../deploy/docker-compose/operations.mdx | 2 +- docs/admin/deploy/kubernetes/operations.mdx | 2 +- docs/admin/deploy/machine-images/aws-ami.mdx | 2 +- .../deploy/machine-images/aws-oneclick.mdx | 2 +- docs/admin/deploy/machine-images/gce.mdx | 2 +- docs/admin/deploy/migrate-backup.mdx | 16 +++---- docs/admin/deploy/scale.mdx | 2 +- docs/admin/deployment_best_practices.mdx | 2 +- .../executors/deploy_executors_kubernetes.mdx | 2 +- .../executors/deploy_executors_terraform.mdx | 22 +++++----- docs/admin/executors/firecracker.mdx | 2 +- docs/admin/executors/index.mdx | 4 +- .../external_services/object_storage.mdx | 4 +- docs/admin/index.mdx | 2 +- docs/admin/migration/opengrok.mdx | 2 +- docs/admin/self-hosted.mdx | 2 +- docs/admin/workers.mdx | 4 +- docs/batch-changes/server-side.mdx | 2 +- docs/cloud/index.mdx | 2 +- docs/cloud/private_connectivity_aws.mdx | 4 +- docs/cloud/private_connectivity_gcp.mdx | 4 +- docs/cloud/private_connectivity_public_lb.mdx | 2 +- docs/code-navigation/auto_indexing.mdx | 42 +++++++++---------- .../auto_indexing_configuration.mdx | 2 +- .../explanations/auto_indexing_inference.mdx | 6 +-- docs/code-navigation/explanations/uploads.mdx | 2 +- docs/code-navigation/features.mdx | 6 +-- .../how-to/adding_scip_to_workflows.mdx | 8 ++-- ...p_uploads_from_ci_cd_and_auto_indexing.mdx | 8 ++-- docs/code-navigation/how-to/index.mdx | 12 +++--- .../how-to/index_other_languages.mdx | 6 +-- ...policies_resource_usage_best_practices.mdx | 2 +- docs/code-navigation/index.mdx | 12 +++--- .../inference_configuration.mdx | 12 +++--- .../precise_code_navigation.mdx | 22 +++++----- .../search_based_code_navigation.mdx | 36 ++++++++-------- docs/code-navigation/troubleshooting.mdx | 2 +- docs/code-navigation/writing_an_indexer.mdx | 10 ++--- docs/code-search/faq.mdx | 2 +- docs/code-search/types/symbol.mdx | 6 +-- docs/getting-started/index.mdx | 2 +- docs/tutorials/index.mdx | 4 +- 43 files changed, 147 insertions(+), 147 deletions(-) diff --git a/docs/admin/architecture.mdx b/docs/admin/architecture.mdx index ee42e81a0..f271ec469 100644 --- a/docs/admin/architecture.mdx +++ b/docs/admin/architecture.mdx @@ -50,11 +50,11 @@ Sourcegraph also has a fast search path for code that isn't indexed yet or will Unlike Search (which is completely text-based), Code Navigation surfaces data such as doc comments for a symbol and actions such as the "go to definition" or "find references" features based on our semantic understanding of code. -By default, Sourcegraph provides [search-based code navigation](/code-search/code-navigation/search_based_code_navigation). This reuses all the architecture that makes search fast, but it can result in false positives (for example, finding two definitions for a symbol or references that aren't actually references) or false negatives (for example, not being able to find the definition or all references). +By default, Sourcegraph provides [search-based code navigation](/code-navigation/search_based_code_navigation). This reuses all the architecture that makes search fast, but it can result in false positives (for example, finding two definitions for a symbol or references that aren't actually references) or false negatives (for example, not being able to find the definition or all references). This is the default because it works with no extra configuration and is good for many use cases and languages. We support many languages this way because it only requires writing a few regular expressions. -With some setup, customers can enable [precise code navigation](/code-search/code-navigation/precise_code_navigation). Repositories add a step to their build pipeline that computes the index for that code revision and uploads it to Sourcegraph. We must write language-specific indexers, so adding precise code navigation support for new languages is a non-trivial task. +With some setup, customers can enable [precise code navigation](/code-navigation/precise_code_navigation). Repositories add a step to their build pipeline that computes the index for that code revision and uploads it to Sourcegraph. We must write language-specific indexers, so adding precise code navigation support for new languages is a non-trivial task. Learn more in the [Code Navigation docs](/code-search/code-navigation) diff --git a/docs/admin/deploy/docker-compose/operations.mdx b/docs/admin/deploy/docker-compose/operations.mdx index 1026b4343..fe4f36486 100644 --- a/docs/admin/deploy/docker-compose/operations.mdx +++ b/docs/admin/deploy/docker-compose/operations.mdx @@ -44,7 +44,7 @@ The following instructions are specific to backing up and restoring the Sourcegr ### Back up Sourcegraph databases -These instructions will back up the primary `sourcegraph` database, the [codeintel](/code-search/code-navigation/) database, and the [codeinsights](/code_insights/) database. +These instructions will back up the primary `sourcegraph` database, the [codeintel](/code-navigation/) database, and the [codeinsights](/code_insights/) database. 1\. `ssh` from your local machine into the machine hosting the `sourcegraph` deployment diff --git a/docs/admin/deploy/kubernetes/operations.mdx b/docs/admin/deploy/kubernetes/operations.mdx index c897df020..97a1645e0 100644 --- a/docs/admin/deploy/kubernetes/operations.mdx +++ b/docs/admin/deploy/kubernetes/operations.mdx @@ -234,7 +234,7 @@ The following instructions are specific to backing up and restoring the sourcegr ### Back up Sourcegraph databases -These instructions will back up the primary `sourcegraph` database, the [codeintel](/code-search/code-navigation/) database, and the [codeinsights](/code_insights/) database. +These instructions will back up the primary `sourcegraph` database, the [codeintel](/code-navigation/) database, and the [codeinsights](/code_insights/) database. A. Verify deployment running diff --git a/docs/admin/deploy/machine-images/aws-ami.mdx b/docs/admin/deploy/machine-images/aws-ami.mdx index 363cdacb1..5f0c66016 100644 --- a/docs/admin/deploy/machine-images/aws-ami.mdx +++ b/docs/admin/deploy/machine-images/aws-ami.mdx @@ -64,7 +64,7 @@ To configure SSL, and lock down the instance from the public internet, see the [ Executors are supported using [native kubernetes executors](/admin/executors/deploy_executors_kubernetes). -Executors support [auto-indexing](/code-search/code-navigation/auto_indexing) and [server-side batch changes](/batch-changes/server-side). +Executors support [auto-indexing](/code-navigation/auto_indexing) and [server-side batch changes](/batch-changes/server-side). To enable executors you must do the following: diff --git a/docs/admin/deploy/machine-images/aws-oneclick.mdx b/docs/admin/deploy/machine-images/aws-oneclick.mdx index 1dae26ef4..af074403b 100644 --- a/docs/admin/deploy/machine-images/aws-oneclick.mdx +++ b/docs/admin/deploy/machine-images/aws-oneclick.mdx @@ -72,7 +72,7 @@ Find the URL of your Sourcegraph instance in the **Outputs** section of the AWS Executors are supported using [native kubernetes executors](/admin/executors/deploy_executors_kubernetes). -Executors support [auto-indexing](/code-search/code-navigation/auto_indexing) and [server-side batch changes](/batch-changes/server-side). +Executors support [auto-indexing](/code-navigation/auto_indexing) and [server-side batch changes](/batch-changes/server-side). To enable executors you must do the following: diff --git a/docs/admin/deploy/machine-images/gce.mdx b/docs/admin/deploy/machine-images/gce.mdx index 23c2fafb1..6af61ce6c 100644 --- a/docs/admin/deploy/machine-images/gce.mdx +++ b/docs/admin/deploy/machine-images/gce.mdx @@ -121,7 +121,7 @@ $ sudo su sourcegraph Executors are supported using [native kubernetes executors](/admin/executors/deploy_executors_kubernetes). -Executors support [auto-indexing](/code-search/code-navigation/auto_indexing) and [server-side batch changes](/batch-changes/server-side). +Executors support [auto-indexing](/code-navigation/auto_indexing) and [server-side batch changes](/batch-changes/server-side). To enable executors you must do the following: diff --git a/docs/admin/deploy/migrate-backup.mdx b/docs/admin/deploy/migrate-backup.mdx index cc67fa5de..55e789fc3 100644 --- a/docs/admin/deploy/migrate-backup.mdx +++ b/docs/admin/deploy/migrate-backup.mdx @@ -40,7 +40,7 @@ This list is not guaranteed to be complete, but rather representative of the typ | [Saved searches](/code-search/working/saved_searches) | No | | | User-generated access tokens | No | | | [Batch Changes](/batch-changes/) | No | | -| [Code graph metadata](/code-search/code-navigation/precise_code_navigation) | Yes (if manually regenerated) | This can be regenerated by re-running the indexing and upload process for affected repositories and revisions, but will not be regenerated by default. | +| [Code graph metadata](/code-navigation/precise_code_navigation) | Yes (if manually regenerated) | This can be regenerated by re-running the indexing and upload process for affected repositories and revisions, but will not be regenerated by default. | | [User survey responses](/admin/user_surveys) | No | | ### Data stored on disk @@ -49,13 +49,13 @@ Git data, search indexes, precise code-intel data, Prometheus metrics, and some This list is not guaranteed to be complete, but rather representative of the types of data stored here. -| Data | Can it be recreated without a backup? | Notes | -| ----------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Repository (git) data | Yes | | -| Search indexes | Yes | | -| [Code graph data](/code-search/code-navigation/precise_code_navigation) | No | This can be regenerated by re-running the indexing and upload process for affected repositories and revisions, but will not be regenerated by default. | -| [Prometheus metrics](/admin/observability/metrics) | No | | -| blobstore | Yes | This is where unprocessed uploads are stored. | +| Data | Can it be recreated without a backup? | Notes | +| ----------------------------------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Repository (git) data | Yes | | +| Search indexes | Yes | | +| [Code graph data](/code-navigation/precise_code_navigation) | No | This can be regenerated by re-running the indexing and upload process for affected repositories and revisions, but will not be regenerated by default. | +| [Prometheus metrics](/admin/observability/metrics) | No | | +| blobstore | Yes | This is where unprocessed uploads are stored. | ### Ephemeral data (Redis) diff --git a/docs/admin/deploy/scale.mdx b/docs/admin/deploy/scale.mdx index 51842c34c..d3d74925c 100644 --- a/docs/admin/deploy/scale.mdx +++ b/docs/admin/deploy/scale.mdx @@ -558,7 +558,7 @@ Also the backend for symbols operations, indexing symbols in repositories using {' '} - If Rockskip is enabled, the symbols for repositories indexed by [Rockskip](/code-search/code-navigation/rockskip) + If Rockskip is enabled, the symbols for repositories indexed by [Rockskip](/code-navigation/rockskip) are stored in codeintel-db instead. diff --git a/docs/admin/deployment_best_practices.mdx b/docs/admin/deployment_best_practices.mdx index bc0b2818c..43d9b3d33 100644 --- a/docs/admin/deployment_best_practices.mdx +++ b/docs/admin/deployment_best_practices.mdx @@ -51,7 +51,7 @@ _It is possible to migrate your data to a Docker-Compose or Kubernetes deploymen ### Precise code navigation and Batch Changes -- The list of languages currently supported for precise code navigation can be found [here](/code-search/code-navigation/auto_indexing) +- The list of languages currently supported for precise code navigation can be found [here](/code-navigation/auto_indexing) - Requirements to set-up Batch Changes can be found [here](/batch-changes/requirements) ### Browser extensions diff --git a/docs/admin/executors/deploy_executors_kubernetes.mdx b/docs/admin/executors/deploy_executors_kubernetes.mdx index 02a3b2265..956a3909b 100644 --- a/docs/admin/executors/deploy_executors_kubernetes.mdx +++ b/docs/admin/executors/deploy_executors_kubernetes.mdx @@ -4,7 +4,7 @@ This feature is in beta and is available in Sourcegraph 5.1.0 and later. -The native Kubernetes Executors have a master Executor pod that schedules worker pods via the Kubernetes API. The master Executor pod manages the lifecycle of jobs, while the worker pods process the actual [batch change](/batch_changes/explanations/server_side) or [precise auto indexing](/code-search/code-navigation/auto_indexing) job specs. For more details, see [how it works](/admin/executors#native-kubernetes). +The native Kubernetes Executors have a master Executor pod that schedules worker pods via the Kubernetes API. The master Executor pod manages the lifecycle of jobs, while the worker pods process the actual [batch change](/batch_changes/explanations/server_side) or [precise auto indexing](/code-navigation/auto_indexing) job specs. For more details, see [how it works](/admin/executors#native-kubernetes). ## Requirements diff --git a/docs/admin/executors/deploy_executors_terraform.mdx b/docs/admin/executors/deploy_executors_terraform.mdx index 1922e61ca..39c9dc780 100644 --- a/docs/admin/executors/deploy_executors_terraform.mdx +++ b/docs/admin/executors/deploy_executors_terraform.mdx @@ -36,17 +36,17 @@ module "executors" { } ``` -| Variable | Description | -| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `availability_zone` | The **AWS** availability zone to create the instance in | -| `region` | The **Google** region to provision the executor resources in. | -| `zone` | The **Google** zone to provision the executor resources in. | -| `executor_sourcegraph_external_url` | The public URL of your Sourcegraph instance. This corresponds to the `externalURL` value in your Sourcegraph instance’s site configuration and must be resolvable from the provisioned executor compute resources. | -| `executor_sourcegraph_executor_proxy_password` | The access token corresponding to the `executors.accessToken` in your Sourcegraph instance's site configuration. | -| `executor_queue_name` | The single queue from which the executor should pull jobs - [`codeintel`](/code-search/code-navigation/auto_indexing) or [`batches`](/batch-changes/server-side). Either this or `executor_queue_names` must be set. | -| `executor_queue_names` | The multiple queues from which the executor should pull jobs - one or more of [`codeintel`](/code-search/code-navigation/auto_indexing) and [`batches`](/batch-changes/server-side). Either this or `executor_queue_name` must be set. | -| `executor_instance_tag` | A label tag to add to all the executors; can be used for filtering out the right instances in stackdriver monitoring | -| `executor_metrics_environment_label` | The value for environment by which to filter the custom metrics. | +| Variable | Description | +| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `availability_zone` | The **AWS** availability zone to create the instance in | +| `region` | The **Google** region to provision the executor resources in. | +| `zone` | The **Google** zone to provision the executor resources in. | +| `executor_sourcegraph_external_url` | The public URL of your Sourcegraph instance. This corresponds to the `externalURL` value in your Sourcegraph instance’s site configuration and must be resolvable from the provisioned executor compute resources. | +| `executor_sourcegraph_executor_proxy_password` | The access token corresponding to the `executors.accessToken` in your Sourcegraph instance's site configuration. | +| `executor_queue_name` | The single queue from which the executor should pull jobs - [`codeintel`](/code-navigation/auto_indexing) or [`batches`](/batch-changes/server-side). Either this or `executor_queue_names` must be set. | +| `executor_queue_names` | The multiple queues from which the executor should pull jobs - one or more of [`codeintel`](/code-navigation/auto_indexing) and [`batches`](/batch-changes/server-side). Either this or `executor_queue_name` must be set. | +| `executor_instance_tag` | A label tag to add to all the executors; can be used for filtering out the right instances in stackdriver monitoring | +| `executor_metrics_environment_label` | The value for environment by which to filter the custom metrics. | See the Terraform Modules for additional configurations. diff --git a/docs/admin/executors/firecracker.mdx b/docs/admin/executors/firecracker.mdx index 23c0ef808..bde3c1cb8 100644 --- a/docs/admin/executors/firecracker.mdx +++ b/docs/admin/executors/firecracker.mdx @@ -1,6 +1,6 @@ # Firecracker -[Executors](/admin/executors/), by design, are services that run arbitrary code supplied by a user. The executor jobs produced by precise code intelligence [auto-indexing](/code-search/code-navigation/auto_indexing) and [server-side batch changes](/batch-changes/server-side) are built to invoke _templated_ execution plans, where some parts of execution may invoke code configured by a Sourcegraph administrator or user. Generating a precise index requires invoking an indexer for that language. Batch changes are configured to run arbitrary tooling over the contents of a repository. +[Executors](/admin/executors/), by design, are services that run arbitrary code supplied by a user. The executor jobs produced by precise code intelligence [auto-indexing](/code-navigation/auto_indexing) and [server-side batch changes](/batch-changes/server-side) are built to invoke _templated_ execution plans, where some parts of execution may invoke code configured by a Sourcegraph administrator or user. Generating a precise index requires invoking an indexer for that language. Batch changes are configured to run arbitrary tooling over the contents of a repository. Because Sourcegraph has access to your code and credentials to external tools, we've designed executors to be able to run separately from the Sourcegraph instance (on a raw compute node) with the minimum API surface area and user code exposed to the job required to meet its objective. This effectively reduces the blast radius of a misconfiguration or insecure configuration. diff --git a/docs/admin/executors/index.mdx b/docs/admin/executors/index.mdx index 039b8ff6e..5f4032705 100644 --- a/docs/admin/executors/index.mdx +++ b/docs/admin/executors/index.mdx @@ -7,7 +7,7 @@ Executors are Sourcegraph's solution for running untrusted code in a secure and controllable way. Executors provide a sandbox that can run resource-intensive or untrusted tasks on behalf of the Sourcegraph instance, such as: -- [Automatically indexing a repository for precise code navigation](/code-search/code-navigation/auto_indexing) +- [Automatically indexing a repository for precise code navigation](/code-navigation/auto_indexing) - [Running batch changes](/batch-changes/server-side) ## Installation @@ -16,7 +16,7 @@ To deploy executors for your Sourcegraph instance, follow our [executor deployme ## Why use executors? -Running untrusted code is a core requirement of features such as precise code navigation [auto-indexing](/code-search/code-navigation/auto_indexing), and [running batch changes server-side](/batch-changes/server-side). +Running untrusted code is a core requirement of features such as precise code navigation [auto-indexing](/code-navigation/auto_indexing), and [running batch changes server-side](/batch-changes/server-side). Auto-indexing jobs, in particular, require the invocation of arbitrary and untrusted code to support the resolution of project dependencies. Invocation of post-install hooks, use of insecure [package management tools](https://github.com/golang/go/issues/29230), and package manager proxy attacks can create opportunities in which an adversary can gain unlimited use of compute or exfiltrate data. The latter outcome is particularly dangerous for on-premise installations of Sourcegraph, which is the chosen option for companies wanting to maintain strict privacy of their code property. diff --git a/docs/admin/external_services/object_storage.mdx b/docs/admin/external_services/object_storage.mdx index ee818c658..db24d144a 100644 --- a/docs/admin/external_services/object_storage.mdx +++ b/docs/admin/external_services/object_storage.mdx @@ -1,12 +1,12 @@ # Using a managed object storage service (S3 or GCS) -By default, Sourcegraph will use a `sourcegraph/blobstore` server bundled with the instance to temporarily store [code graph indexes](../../code-search/code-navigation/precise_code_navigation) uploaded by users as well as the results of [search jobs](../../code-search/types/search-jobs). +By default, Sourcegraph will use a `sourcegraph/blobstore` server bundled with the instance to temporarily store [code graph indexes](../../code-navigation/precise_code_navigation) uploaded by users as well as the results of [search jobs](../../code-search/types/search-jobs). You can alternatively configure your instance to instead store this data in an S3 or GCS bucket. Doing so may decrease your hosting costs as persistent volumes are often more expensive than the same storage space in an object store service. ## Code Graph Indexes -To target a managed object storage service for storing [code graph index uploads](../../code-search/code-navigation/precise_code_navigation), you will need to set a handful of environment variables for configuration and authentication to the target service. +To target a managed object storage service for storing [code graph index uploads](../../code-navigation/precise_code_navigation), you will need to set a handful of environment variables for configuration and authentication to the target service. - If you are running a `sourcegraph/server` deployment, set the environment variables on the server container - If you are running via Docker-compose or Kubernetes, set the environment variables on the `frontend`, `worker`, and `precise-code-intel-worker` containers diff --git a/docs/admin/index.mdx b/docs/admin/index.mdx index f59017bd9..6e8f2ba7e 100644 --- a/docs/admin/index.mdx +++ b/docs/admin/index.mdx @@ -26,7 +26,7 @@ Sourcegraph administration is primarily managed by site administrators, who are - [Batch Changes](/batch-changes/) - [Beta and experimental features](/admin/beta_and_experimental_features) -- [Code navigation](/code-search/code-navigation/) +- [Code navigation](/code-navigation/) - [Pings](/admin/pings) - [Telemetry](/admin/telemetry) - [Enterprise pricing and licenses](/admin/subscriptions/) diff --git a/docs/admin/migration/opengrok.mdx b/docs/admin/migration/opengrok.mdx index b0bc468cd..ffcd0fa4a 100644 --- a/docs/admin/migration/opengrok.mdx +++ b/docs/admin/migration/opengrok.mdx @@ -17,7 +17,7 @@ Sourcegraph is a self-hosted code search and intelligence tool that helps develo - Sourcegraph supports [searching any revision](/code-search/features) (not just specific branches) and does not require waiting for periodic reindexing. - Sourcegraph's [query syntax](/code-search/queries), user interface, and [integrations](/integration/) are superior and easier to use. -- Sourcegraph's [code navigation](/code-search/code-navigation/), has better language support (hover tooltips, definitions, references, implementations, etc.) and is based on the Language Server Protocol standard. +- Sourcegraph's [code navigation](/code-navigation/), has better language support (hover tooltips, definitions, references, implementations, etc.) and is based on the Language Server Protocol standard. - The [Sourcegraph API](/api/graphql/) is more powerful, better documented, and easier to use than OpenGrok's API. - Sourcegraph scales to more repositories/users and supports Kubernetes-based clustered/high-availability deployments better (with the [cluster deployment option](/admin/deploy/kubernetes/)). diff --git a/docs/admin/self-hosted.mdx b/docs/admin/self-hosted.mdx index 8224d7c16..63f3e5578 100644 --- a/docs/admin/self-hosted.mdx +++ b/docs/admin/self-hosted.mdx @@ -57,7 +57,7 @@ Get started running Sourcegraph on-prem. - [Batch Changes](/batch-changes/) - [Beta and experimental features](/admin/beta_and_experimental_features) -- [Code navigation](/code-search/code-navigation/) +- [Code navigation](/code-navigation/) - [Pings](/admin/pings) - [Enterprise pricing and licenses](/admin/subscriptions/) - [Search](/admin/search) diff --git a/docs/admin/workers.mdx b/docs/admin/workers.mdx index 21398cb61..0b0de6be3 100644 --- a/docs/admin/workers.mdx +++ b/docs/admin/workers.mdx @@ -30,7 +30,7 @@ This job periodically updates the set of code graph data indexes that are visibl #### `codeintel-autoindexing-scheduler` -This job periodically checks for repositories that can be auto-indexed and queues indexing jobs for a remote executor instance to perform. Read how to [enable](/code-search/code-navigation/auto_indexing#enable-auto-indexing) and [configure](/code-search/code-navigation/auto_indexing#configure-auto-indexing) auto-indexing. +This job periodically checks for repositories that can be auto-indexed and queues indexing jobs for a remote executor instance to perform. Read how to [enable](/code-navigation/auto_indexing#enable-auto-indexing) and [configure](/code-navigation/auto_indexing#configure-auto-indexing) auto-indexing. #### `codeintel-autoindexing-summary-builder` @@ -38,7 +38,7 @@ This job periodically checks for auto-indexability on repositories in the backgr #### `codeintel-autoindexing-dependency-scheduler` -This job periodically checks for dependency packages that can be auto-indexed and queues indexing jobs for a remote executor instance to perform. Read how to [enable](/code-search/code-navigation/auto_indexing#enable-auto-indexing) and [configure](/code-search/code-navigation/auto_indexing#configure-auto-indexing) auto-indexing. +This job periodically checks for dependency packages that can be auto-indexed and queues indexing jobs for a remote executor instance to perform. Read how to [enable](/code-navigation/auto_indexing#enable-auto-indexing) and [configure](/code-navigation/auto_indexing#configure-auto-indexing) auto-indexing. #### `codeintel-metrics-reporter` diff --git a/docs/batch-changes/server-side.mdx b/docs/batch-changes/server-side.mdx index 0f89ec624..59b1bb5e0 100644 --- a/docs/batch-changes/server-side.mdx +++ b/docs/batch-changes/server-side.mdx @@ -11,7 +11,7 @@ By default, Batch Changes uses a command line interface in your local environment to [compute diffs](/batch-changes/how-src-executes-a-batch-spec) and create changesets. This can be impractical for creating batch changes affecting hundreds or thousands of repositories, with large numbers of workspaces, or if the batch change steps require CPU, memory, or disk resources that are unavailable locally. -Instead of computing Batch Changes locally using `src-cli`, you can offload this task to one or many remote server called an [executor](/admin/executors/deploy_executors). Executors are also required to enable code navigation [auto-indexing](/code-search/code-navigation/auto_indexing). +Instead of computing Batch Changes locally using `src-cli`, you can offload this task to one or many remote server called an [executor](/admin/executors/deploy_executors). Executors are also required to enable code navigation [auto-indexing](/code-navigation/auto_indexing). This allows to: diff --git a/docs/cloud/index.mdx b/docs/cloud/index.mdx index 5b28c879f..8c7bda1df 100644 --- a/docs/cloud/index.mdx +++ b/docs/cloud/index.mdx @@ -41,7 +41,7 @@ All of Sourcegraph's features are available on Sourcegraph Cloud instances out-o - [Cody](/cody) - [Deep Search](/deep-search) - [Server-side Batch Changes](/batch-changes/server-side) -- [Precise code navigation powered by auto-indexing](/code-search/code-navigation/auto_indexing) +- [Precise code navigation powered by auto-indexing](/code-navigation/auto_indexing) - [Code Monitoring](/code_monitoring/) - [Code Insights](/code_insights/) diff --git a/docs/cloud/private_connectivity_aws.mdx b/docs/cloud/private_connectivity_aws.mdx index 64908ba6d..33c0bd9aa 100644 --- a/docs/cloud/private_connectivity_aws.mdx +++ b/docs/cloud/private_connectivity_aws.mdx @@ -49,7 +49,7 @@ Once the connection to private code host is established, the customer can create ### Verify artifact registries are working -Once the connection to private artifact registry is established, customer might then verify that auto-indexing is working with the private artifact registry by [configuring auto-indexing](/code-search/code-navigation/auto_indexing#configure-auto-indexing) +Once the connection to private artifact registry is established, customer might then verify that auto-indexing is working with the private artifact registry by [configuring auto-indexing](/code-navigation/auto_indexing#configure-auto-indexing) ## FAQ @@ -77,7 +77,7 @@ The customer has full control over the exposed service and they may terminate th Only if the private artifact registry is protected by authentication, the customer will need to: - create executor secrets containing credentials for Sourcegraph to access the private artifact registry - [how to configure executor secrets](/admin/executors/executor_secrets#executor-secrets) -- update auto-indexing inference configuration to create additional files from executor secrets for given programming language - [how to configure auto-indexing](/code-search/code-navigation/inference_configuration) +- update auto-indexing inference configuration to create additional files from executor secrets for given programming language - [how to configure auto-indexing](/code-navigation/inference_configuration) ### Can I use self-signed TLS certificate for my private resources? diff --git a/docs/cloud/private_connectivity_gcp.mdx b/docs/cloud/private_connectivity_gcp.mdx index 66dc62afc..b7f8f64db 100644 --- a/docs/cloud/private_connectivity_gcp.mdx +++ b/docs/cloud/private_connectivity_gcp.mdx @@ -56,7 +56,7 @@ Once the connection is established, the customer can create the [code host conne ### Verify artifact registries are working -Once the connection to private artifact registry is established, customer might then verify that auto-indexing is working with private registry dependencies by [configuring auto-indexing](/code-search/code-navigation/auto_indexing#configure-auto-indexing) +Once the connection to private artifact registry is established, customer might then verify that auto-indexing is working with private registry dependencies by [configuring auto-indexing](/code-navigation/auto_indexing#configure-auto-indexing) ## FAQ @@ -81,7 +81,7 @@ All traffic between the producer and consumer is encrypted in transit. You may l Only if the private artifact registry is protected by authentication, the customer will need to: - Create executor secrets containing credentials for Sourcegraph to access the private artifact registry - [how to configure executor secrets](/admin/executors/executor_secrets#executor-secrets) -- Update auto-indexing inference configuration to create additional files from executor secrets for the given programming language - [how to configure auto-indexing](/code-search/code-navigation/inference_configuration) +- Update auto-indexing inference configuration to create additional files from executor secrets for the given programming language - [how to configure auto-indexing](/code-navigation/inference_configuration) ### Can I use self-signed TLS certificate for my private resources? diff --git a/docs/cloud/private_connectivity_public_lb.mdx b/docs/cloud/private_connectivity_public_lb.mdx index 85321e1dd..f10efaf2a 100644 --- a/docs/cloud/private_connectivity_public_lb.mdx +++ b/docs/cloud/private_connectivity_public_lb.mdx @@ -68,7 +68,7 @@ Once the connection is established, the customer can create the [code host conne If private artifact registry is protected by authentication, the customer will need to: - Create executor secrets containing credentials for Sourcegraph to access the private artifact registry - [how to configure executor secrets](/admin/executors/executor_secrets#executor-secrets) -- Update auto-indexing inference configuration to create additional files from executor secrets for given programming language - [how to configure auto-indexing](/code-search/code-navigation/inference_configuration) +- Update auto-indexing inference configuration to create additional files from executor secrets for given programming language - [how to configure auto-indexing](/code-navigation/inference_configuration) ### Can I use self-signed TLS certificate for my private resources? diff --git a/docs/code-navigation/auto_indexing.mdx b/docs/code-navigation/auto_indexing.mdx index 9d340c210..ca0a5ac6b 100644 --- a/docs/code-navigation/auto_indexing.mdx +++ b/docs/code-navigation/auto_indexing.mdx @@ -7,13 +7,13 @@

Learn and understand how auto-indexing works.

-With Sourcegraph deployments supporting [executors](/admin/executors/), your repository contents can be automatically analyzed to produce a code graph index file. Once [auto-indexing is enabled](/code-search/code-navigation/auto_indexing#enable-auto-indexing) and [auto-indexing policies are configured](/code-search/code-navigation/auto_indexing#configure-auto-indexing), repositories will be periodically cloned into an executor sandbox, analyzed, and the resulting index file will be uploaded back to the Sourcegraph instance. +With Sourcegraph deployments supporting [executors](/admin/executors/), your repository contents can be automatically analyzed to produce a code graph index file. Once [auto-indexing is enabled](/code-navigation/auto_indexing#enable-auto-indexing) and [auto-indexing policies are configured](/code-navigation/auto_indexing#configure-auto-indexing), repositories will be periodically cloned into an executor sandbox, analyzed, and the resulting index file will be uploaded back to the Sourcegraph instance. -Auto-indexing is currently available for Go, TypeScript, JavaScript, Python, Ruby and JVM repositories. See also [dependency navigation](/code-search/code-navigation/features#dependency-navigation) for instructions on how to setup cross-dependency navigation depending on what language ecosystem you use. +Auto-indexing is currently available for Go, TypeScript, JavaScript, Python, Ruby and JVM repositories. See also [dependency navigation](/code-navigation/features#dependency-navigation) for instructions on how to setup cross-dependency navigation depending on what language ecosystem you use. ## Enable auto-indexing -The following docs explains how to turn on [auto-indexing](/code-search/code-navigation/auto_indexing) on your Sourcegraph instance to enable [precise code navigation](/code-search/code-navigation/precise_code_navigation). +The following docs explains how to turn on [auto-indexing](/code-navigation/auto_indexing) on your Sourcegraph instance to enable [precise code navigation](/code-navigation/precise_code_navigation). ### Deploy executors @@ -48,22 +48,22 @@ The frequency of index job scheduling can be tuned via the following environment This feature is in beta for self-hosted customers. -Precise code navigation [auto-indexing](/code-search/code-navigation/auto_indexing) jobs are scheduled based on two fronts of configuration. +Precise code navigation [auto-indexing](/code-navigation/auto_indexing) jobs are scheduled based on two fronts of configuration. The first front selects the set of repositories and commits within those repositories that are candidates for auto-indexing. These candidates are controlled by [configuring auto-indexing policies](#configure-auto-indexing-policies). -The second front determines the set of index jobs that can run over candidate commits. By default, index jobs are [inferred](/code-search/code-navigation/inference_configuration) from the repository structure's on disk. Index job inference uses heuristics such as the presence or contents of particular files to determine the paths and commands required to index a repository. +The second front determines the set of index jobs that can run over candidate commits. By default, index jobs are [inferred](/code-navigation/inference_configuration) from the repository structure's on disk. Index job inference uses heuristics such as the presence or contents of particular files to determine the paths and commands required to index a repository. Alternatively, index job configuration [can be supplied explicitly](#explicit-index-job-configuration) for a repository when the inference heuristics are not powerful enough to create an index job that produces the correct results. This might be necessary for projects that have non-standard or complex dependency resolution or pre-compilation steps, for example. ### Configure auto-indexing policies -Let's learn how to configure policies to control the scheduling of precise code navigation indexing jobs. An indexing jobs [produces a code graph data index](/code-search/code-navigation/precise_code_navigation) and uploads it to your Sourcegraph instance for use with code navigation. +Let's learn how to configure policies to control the scheduling of precise code navigation indexing jobs. An indexing jobs [produces a code graph data index](/code-navigation/precise_code_navigation) and uploads it to your Sourcegraph instance for use with code navigation. See the [best practices - guide](/code-search/code-navigation/how-to/policies_resource_usage_best_practices) - for additional details on how policies affect resource usage. + guide](/code-navigation/how-to/policies_resource_usage_best_practices) for + additional details on how policies affect resource usage. Each policy has a number of configurable options, including: @@ -112,7 +112,7 @@ In this example, we create an indexing policy that applies to all _versioned_ ta ### Explicit index job configuration -For projects that have non-standard or complex dependency resolution or pre-compilation steps, inference heuristics might not be powerful enough to create an index job that produces the correct results. In these cases, explicit index job configuration can be supplied to a repository in two ways (listed below in order of decreasing precedence). Both methods of configuration share a common expected schema. See the [reference documentation](/code-search/code-navigation/auto_indexing_configuration) for additional information on the shape and content of the configuration. +For projects that have non-standard or complex dependency resolution or pre-compilation steps, inference heuristics might not be powerful enough to create an index job that produces the correct results. In these cases, explicit index job configuration can be supplied to a repository in two ways (listed below in order of decreasing precedence). Both methods of configuration share a common expected schema. See the [reference documentation](/code-navigation/auto_indexing_configuration) for additional information on the shape and content of the configuration. 1. Configure index jobs by committing a `sourcegraph.yaml` file to the root of the target repository. If you're new to YAML and want a short introduction, see [Learn YAML in five minutes](https://learnxinyminutes.com/docs/yaml/). Note that YAML is a strict superset of JSON, therefore the file contents can also be encoded as valid JSON (despite the file extension). @@ -120,7 +120,7 @@ For projects that have non-standard or complex dependency resolution or pre-comp ![Repository index page](https://storage.googleapis.com/sourcegraph-assets/docs/images/code-intelligence/sg-3.33/repository-page.png) -From there you can view or edit the repository's configuration. We use a superset of JSON that allows for comments and trailing commas. The set of index jobs that would be [inferred](/code-search/code-navigation/explanations/auto_indexing_inference) from the content of the repository (at the current tip of the default branch) can be viewed and may often be useful as a starting point to define more elaborate indexing jobs. +From there you can view or edit the repository's configuration. We use a superset of JSON that allows for comments and trailing commas. The set of index jobs that would be [inferred](/code-navigation/explanations/auto_indexing_inference) from the content of the repository (at the current tip of the default branch) can be viewed and may often be useful as a starting point to define more elaborate indexing jobs. ![Auto-indexing configuration editor](https://storage.googleapis.com/sourcegraph-assets/docs/images/code-intelligence/renamed/configuration.png) @@ -144,7 +144,7 @@ For **NPM**, you can create a [secret named `NPM_TOKEN`](https://docs.npmjs.com/ ## Language support -Auto-indexing is currently available for Go, TypeScript, JavaScript, Python, Ruby and JVM repositories. See also [dependency navigation](/code-search/code-navigation/features#dependency-navigation) for instructions on how to setup cross-dependency navigation depending on what language ecosystem you use. +Auto-indexing is currently available for Go, TypeScript, JavaScript, Python, Ruby and JVM repositories. See also [dependency navigation](/code-navigation/features#dependency-navigation) for instructions on how to setup cross-dependency navigation depending on what language ecosystem you use. ## Lifecycle of an indexing job @@ -152,7 +152,7 @@ Index jobs are run asynchronously from a queue. Each index job has an attached * ![Index job state diagram](https://storage.googleapis.com/sourcegraph-assets/Docs/index-states.svg) -The general happy-path for an index job is: `QUEUED_FOR_INDEXING`, `INDEXING`, then `INDEXING_COMPLETED`. Once uploaded, the remaining lifecycle is described in [lifecycle of an upload](/code-search/code-navigation/explanations/uploads#lifecycle-of-an-upload). +The general happy-path for an index job is: `QUEUED_FOR_INDEXING`, `INDEXING`, then `INDEXING_COMPLETED`. Once uploaded, the remaining lifecycle is described in [lifecycle of an upload](/code-navigation/explanations/uploads#lifecycle-of-an-upload). Index jobs may fail to complete due to the job configuration not aligning with the repository contents or due to transient errors related to the network (for example). An index job will enter the `INDEXING_ERRORED` state on such conditions. Errored index jobs may be retried a number of times before moving into a permanently errored state. @@ -172,7 +172,7 @@ The detail page of an index job will show its current state as well as detailed ![Upload in processing state](https://storage.googleapis.com/sourcegraph-assets/docs/images/code-intelligence/renamed/indexes-processing.png) -The stdout and stderr of each command run during pre-indexing and indexing steps are viewable as the index job is processed. This information is valuable when troubleshooting a [custom index configuration](/code-search/code-navigation/auto_indexing_configuration) for your repository. +The stdout and stderr of each command run during pre-indexing and indexing steps are viewable as the index job is processed. This information is valuable when troubleshooting a [custom index configuration](/code-navigation/auto_indexing_configuration) for your repository. ![Detailed look at index job logs](https://storage.googleapis.com/sourcegraph-assets/docs/images/code-intelligence/renamed/indexes-processing-detail.png) @@ -186,13 +186,13 @@ Once the index job completes, a code graph data file has been uploaded to the So This feature is in beta for self-hosted customers. -When a commit of a repository is selected as a candidate for [auto-indexing](/code-search/code-navigation/auto_indexing) but does not have an explicitly supplied index job configuration, index jobs are inferred from the content of the repository at that commit. +When a commit of a repository is selected as a candidate for [auto-indexing](/code-navigation/auto_indexing) but does not have an explicitly supplied index job configuration, index jobs are inferred from the content of the repository at that commit. The site-config setting `codeIntelAutoIndexing.indexerMap` can be used to update the indexer image that is (globally) used on inferred jobs. For example, `"codeIntelAutoIndexing.indexerMap": {"go": "lsif-go:alternative-tag"}` will cause inferred jobs indexing Go code to use the specified container (with an alternative tag). This can also be useful for specifying alternative Docker registries. -This document describes the heuristics used to determine the set of index jobs to schedule. See [configuration reference](/code-search/code-navigation/auto_indexing_configuration) for additional documentation on how index jobs are configured. +This document describes the heuristics used to determine the set of index jobs to schedule. See [configuration reference](/code-navigation/auto_indexing_configuration) for additional documentation on how index jobs are configured. -As a general rule of thumb, an indexer can be invoked successfully if the source code to index can be compiled successfully. The heuristics below attempt to cover the common cases of dependency resolution, but may not be sufficient if the target code requires additional steps such as code generation, header file linking, or installation of system dependencies to compile from a fresh clone of the repository. For such cases, we recommend using the inferred job as a starting point to [explicitly supply index job configuration](/code-search/code-navigation/auto_indexing#explicit-index-job-configuration). +As a general rule of thumb, an indexer can be invoked successfully if the source code to index can be compiled successfully. The heuristics below attempt to cover the common cases of dependency resolution, but may not be sufficient if the target code requires additional steps such as code generation, header file linking, or installation of system dependencies to compile from a fresh clone of the repository. For such cases, we recommend using the inferred job as a starting point to [explicitly supply index job configuration](/code-navigation/auto_indexing#explicit-index-job-configuration). ### Go @@ -291,35 +291,35 @@ If the repository contains both a `lsif-java.json` file as well as `*.java`, `*. -This document details the expected contents of [explicit index job configuration](/code-search/code-navigation/auto_indexing#explicit-index-job-configuration) for a particular repository. Depending on how this configuration is supplied, it may be encoded as JSON. +This document details the expected contents of [explicit index job configuration](/code-navigation/auto_indexing#explicit-index-job-configuration) for a particular repository. Depending on how this configuration is supplied, it may be encoded as JSON. ## Keys diff --git a/docs/code-navigation/explanations/auto_indexing_inference.mdx b/docs/code-navigation/explanations/auto_indexing_inference.mdx index 854ed84a5..e988d989a 100644 --- a/docs/code-navigation/explanations/auto_indexing_inference.mdx +++ b/docs/code-navigation/explanations/auto_indexing_inference.mdx @@ -4,13 +4,13 @@ This feature is in beta for self-hosted customers. -When a commit of a repository is selected as a candidate for [auto-indexing](/code-search/code-navigation/auto_indexing) but does not have an explicitly supplied index job configuration, index jobs are inferred from the content of the repository at that commit. +When a commit of a repository is selected as a candidate for [auto-indexing](/code-navigation/auto_indexing) but does not have an explicitly supplied index job configuration, index jobs are inferred from the content of the repository at that commit. The site-config setting `codeIntelAutoIndexing.indexerMap` can be used to update the indexer image that is (globally) used on inferred jobs. For example, `"codeIntelAutoIndexing.indexerMap": {"go": "scip-go:alternative-tag"}` will cause inferred jobs indexing Go code to use the specified container (with an alternative tag). This can also be useful for specifying alternative Docker registries. -This document describes the heuristics used to determine the set of index jobs to schedule. See [configuration reference](/code-search/code-navigation/auto_indexing_configuration) for additional documentation on how index jobs are configured. +This document describes the heuristics used to determine the set of index jobs to schedule. See [configuration reference](/code-navigation/auto_indexing_configuration) for additional documentation on how index jobs are configured. -As a general rule of thumb, an indexer can be invoked successfully if the source code to index can be compiled successfully. The heuristics below attempt to cover the common cases of dependency resolution, but may not be sufficient if the target code requires additional steps such as code generation, header file linking, or installation of system dependencies to compile from a fresh clone of the repository. For such cases, we recommend using the inferred job as a starting point to [explicitly supply index job configuration](/code-search/code-navigation/auto_indexing#explicit-index-job-configuration). +As a general rule of thumb, an indexer can be invoked successfully if the source code to index can be compiled successfully. The heuristics below attempt to cover the common cases of dependency resolution, but may not be sufficient if the target code requires additional steps such as code generation, header file linking, or installation of system dependencies to compile from a fresh clone of the repository. For such cases, we recommend using the inferred job as a starting point to [explicitly supply index job configuration](/code-navigation/auto_indexing#explicit-index-job-configuration). ## Go diff --git a/docs/code-navigation/explanations/uploads.mdx b/docs/code-navigation/explanations/uploads.mdx index 338f00a04..141edb01c 100644 --- a/docs/code-navigation/explanations/uploads.mdx +++ b/docs/code-navigation/explanations/uploads.mdx @@ -4,7 +4,7 @@ How Code Graph indexers analyze code and generate and index file.

-[Code graph indexers](/code-search/code-navigation/writing_an_indexer) analyze source code and generate an index file, which is subsequently [uploaded to a Sourcegraph instance](/code-search/code-navigation/how-to/index_other_languages#upload-scip-data) using [Sourcegraph CLI](/cli/) for processing. Once processed, this data becomes available for [precise code navigation queries](/code-search/code-navigation/precise_code_navigation). +[Code graph indexers](/code-navigation/writing_an_indexer) analyze source code and generate an index file, which is subsequently [uploaded to a Sourcegraph instance](/code-navigation/how-to/index_other_languages#upload-scip-data) using [Sourcegraph CLI](/cli/) for processing. Once processed, this data becomes available for [precise code navigation queries](/code-navigation/precise_code_navigation). ## Lifecycle of an upload diff --git a/docs/code-navigation/features.mdx b/docs/code-navigation/features.mdx index a17633139..96f069949 100644 --- a/docs/code-navigation/features.mdx +++ b/docs/code-navigation/features.mdx @@ -42,7 +42,7 @@ For example, the animation below demonstrates how to trigger **Find references** ![dependency-navigation](https://storage.googleapis.com/sourcegraph-assets/docs/images/code-intelligence/dependency-nav.gif) -The instructions to set up dependency navigation require you to set up auto-indexing. For more information on how to set up auto-indexing, please refer to our [auto-indexing documentation](/code-search/code-navigation/auto_indexing). +The instructions to set up dependency navigation require you to set up auto-indexing. For more information on how to set up auto-indexing, please refer to our [auto-indexing documentation](/code-navigation/auto_indexing). ## Find implementations @@ -51,8 +51,8 @@ If precise code navigation is enabled for your repositories, you can click **Fin ![find-implementations](https://storage.googleapis.com/sourcegraph-assets/docs/images/code-intelligence/find-impl.gif) - Read [here](/code-search/code-navigation/writing_an_indexer#quick-reference) - for an overview of which languages support this feature. + Read [here](/code-navigation/writing_an_indexer#quick-reference) for an + overview of which languages support this feature. ## Perform an Action diff --git a/docs/code-navigation/how-to/adding_scip_to_workflows.mdx b/docs/code-navigation/how-to/adding_scip_to_workflows.mdx index ffeec7efe..244185a5c 100644 --- a/docs/code-navigation/how-to/adding_scip_to_workflows.mdx +++ b/docs/code-navigation/how-to/adding_scip_to_workflows.mdx @@ -10,7 +10,7 @@ Setting up a source code indexing job in your CI build provides you with fast co ## Using indexer containers -We're working on creating containers that bundle indexers and the [Sourcegraph CLI (`src`)](https://github.com/sourcegraph/src-cli). All the languages in our [language-specific guides](/code-search/code-navigation/precise_code_navigation#setting-up-code-navigation-for-your-codebase) are supported, and this section provides a general guide to using those containers. We've pinned the containers to the `latest` tag in these samples so they stay up to date, but make sure you pin them before going live to ensure reproducibility. +We're working on creating containers that bundle indexers and the [Sourcegraph CLI (`src`)](https://github.com/sourcegraph/src-cli). All the languages in our [language-specific guides](/code-navigation/precise_code_navigation#setting-up-code-navigation-for-your-codebase) are supported, and this section provides a general guide to using those containers. We've pinned the containers to the `latest` tag in these samples so they stay up to date, but make sure you pin them before going live to ensure reproducibility. ### Basic usage @@ -175,19 +175,19 @@ The following projects have example Travis CI configurations to generate and upl ## CI from scratch -If you're indexing a language we haven't documented yet in our [language-specific guides](/code-search/code-navigation/precise_code_navigation#setting-up-code-navigation-for-your-codebase), follow the instructions in this section. We want to have containers available for every language with a robust indexer, so please [contact](https://help.sourcegraph.com/hc/en-us/requests/new) to let us know we're missing one. +If you're indexing a language we haven't documented yet in our [language-specific guides](/code-navigation/precise_code_navigation#setting-up-code-navigation-for-your-codebase), follow the instructions in this section. We want to have containers available for every language with a robust indexer, so please [contact](https://help.sourcegraph.com/hc/en-us/requests/new) to let us know we're missing one. ### Set up your CI machines Your CI machines will need two command-line tools installed. Depending on your build system setup, you can do this as part of the CI step, or you can add it directly to your CI machines for use by the build. 1. The [Sourcegraph CLI (`src`)](https://github.com/sourcegraph/src-cli). -2. The [indexer](/code-search/code-navigation/writing_an_indexer) for your language. +2. The [indexer](/code-navigation/writing_an_indexer) for your language. ### Add steps to your CI 1. **Generate an index** for a project within your repository by running the indexer in the project directory (consult your indexer's docs). -1. **[Upload that generated index](/code-search/code-navigation/precise_code_navigation#setting-up-code-navigation-for-your-codebase)** to your Sourcegraph instance. +1. **[Upload that generated index](/code-navigation/precise_code_navigation#setting-up-code-navigation-for-your-codebase)** to your Sourcegraph instance. ## Recommended upload frequency diff --git a/docs/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing.mdx b/docs/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing.mdx index eb907965d..dd2148cf4 100644 --- a/docs/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing.mdx +++ b/docs/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing.mdx @@ -2,13 +2,13 @@ Sourcegraph Enterprise instances can serve many profiles of repository size and build complexity, and therefore provides multiple methods precise SCIP index data for your team's repositories. We currently support: -1. Uploading [SCIP data yourself](/code-search/code-navigation/how-to/index_other_languages#upload-scip-data) directly from an already-configured build or continuous integration server, as well as -2. [Auto-indexing](/code-search/code-navigation/auto_indexing), which schedules index creation within the Sourcegraph instance. +1. Uploading [SCIP data yourself](/code-navigation/how-to/index_other_languages#upload-scip-data) directly from an already-configured build or continuous integration server, as well as +2. [Auto-indexing](/code-navigation/auto_indexing), which schedules index creation within the Sourcegraph instance. There is nothing preventing users from mix-and-matching these methods (we do it ourselves), but we do have some tips for doing so successfully. -First and foremost, try to that auto-indexing is disabled on repositories that will receive manually configured uploads. This can be done by ensuring that no [auto-indexing policies](/code-search/code-navigation/auto_indexing#configure-auto-indexing-policies) exist for the target repo. Even if one is not created explicitly for this repo, it may still be covered under a global policy with a matching repository pattern. +First and foremost, try to that auto-indexing is disabled on repositories that will receive manually configured uploads. This can be done by ensuring that no [auto-indexing policies](/code-navigation/auto_indexing#configure-auto-indexing-policies) exist for the target repo. Even if one is not created explicitly for this repo, it may still be covered under a global policy with a matching repository pattern. -If covering policies can't be changed to exclude a repo (or if you want _partially_ auto-indexed coverage), then the repository can be [explicitly configured](/code-search/code-navigation/auto_indexing#explicit-index-job-configuration) with a set of auto-indexing jobs to schedule. Simply delete the job configuration that conflicts the explicitly configured project (the directory and indexer's target language should match). +If covering policies can't be changed to exclude a repo (or if you want _partially_ auto-indexed coverage), then the repository can be [explicitly configured](/code-navigation/auto_indexing#explicit-index-job-configuration) with a set of auto-indexing jobs to schedule. Simply delete the job configuration that conflicts the explicitly configured project (the directory and indexer's target language should match). Once an explicit set of jobs are configured, auto-inference will not update it. If the repository shape changes frequently (new index targets are added or removed). Therefore, this configuration should be manually refreshed as necessary. diff --git a/docs/code-navigation/how-to/index.mdx b/docs/code-navigation/how-to/index.mdx index d445f284d..a92e3dc22 100644 --- a/docs/code-navigation/how-to/index.mdx +++ b/docs/code-navigation/how-to/index.mdx @@ -1,8 +1,8 @@ # How-to guides -- [Adding precise code navigation to CI/CD workflows](/code-search/code-navigation/how-to/adding_lsif_to_workflows) -- [Combining SCIP uploads from CI/CD and auto-indexing](/code-search/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing) -- [Go SCIP indexing](/code-search/code-navigation/how-to/index_a_go_repository) -- [Index a TypeScript or JavaScript repository](/code-search/code-navigation/how-to/index_a_typescript_and_javascript_repository) -- [Index other languages](/code-search/code-navigation/how-to/index_other_languages) -- [Code intelligence policies resource usage best practices](/code-search/code-navigation/how-to/policies_resource_usage_best_practices) +- [Adding precise code navigation to CI/CD workflows](/code-navigation/how-to/adding_lsif_to_workflows) +- [Combining SCIP uploads from CI/CD and auto-indexing](/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing) +- [Go SCIP indexing](/code-navigation/how-to/index_a_go_repository) +- [Index a TypeScript or JavaScript repository](/code-navigation/how-to/index_a_typescript_and_javascript_repository) +- [Index other languages](/code-navigation/how-to/index_other_languages) +- [Code intelligence policies resource usage best practices](/code-navigation/how-to/policies_resource_usage_best_practices) diff --git a/docs/code-navigation/how-to/index_other_languages.mdx b/docs/code-navigation/how-to/index_other_languages.mdx index 77655ae43..ad72c4eb2 100644 --- a/docs/code-navigation/how-to/index_other_languages.mdx +++ b/docs/code-navigation/how-to/index_other_languages.mdx @@ -20,7 +20,7 @@ chmod +x /usr/local/bin/src An SCIP indexer is a command line tool that performs code analysis of source code and outputs a file with metadata containing all the definitions, references, and hover documentation in a project in SCIP. The SCIP file is then uploaded to Sourcegraph to power code navigation features. -Install the [indexer](/code-search/code-navigation/writing_an_indexer) for the required programming language of your repository by following the instructions in the indexer's README +Install the [indexer](/code-navigation/writing_an_indexer) for the required programming language of your repository by following the instructions in the indexer's README ## Generate SCIP data @@ -57,7 +57,7 @@ Successful output will appear similar to the following example. ## Automate code indexing -Now that you have successfully enabled code navigation for your repository, you can automate source code indexing to ensure precise code navigation stays up to date with the most recent code changes in the repository. See our [continuous integration guide](/code-search/code-navigation/how-to/adding_lsif_to_workflows) to setup automation. +Now that you have successfully enabled code navigation for your repository, you can automate source code indexing to ensure precise code navigation stays up to date with the most recent code changes in the repository. See our [continuous integration guide](/code-navigation/how-to/adding_lsif_to_workflows) to setup automation. ## Troubleshooting @@ -66,7 +66,7 @@ Now that you have successfully enabled code navigation for your repository, you Make sure you have configured your Sourcegraph instance and [enabled precise code - navigation](/code-search/code-navigation/precise_code_navigation#setting-up-code-navigation-for-your-codebase). + navigation](/code-navigation/precise_code_navigation#setting-up-code-navigation-for-your-codebase). Once LSIF data has uploaded, open the Sourcegraph UI or your code host (i.e. GitHub) and navigate to any code file that was part of the repository that was analyzed by the LSIF indexer. Hover over a symbol, variable or function name in the file, you should now see rich LSIF metadata as the source for hover-tooltips, definitions, and references. diff --git a/docs/code-navigation/how-to/policies_resource_usage_best_practices.mdx b/docs/code-navigation/how-to/policies_resource_usage_best_practices.mdx index 6c1200fc0..034190630 100644 --- a/docs/code-navigation/how-to/policies_resource_usage_best_practices.mdx +++ b/docs/code-navigation/how-to/policies_resource_usage_best_practices.mdx @@ -1,6 +1,6 @@ # Code intelligence policies resource usage best practices -This guide gives an overview of best practices when defining [auto-index scheduling](/code-search/code-navigation/auto_indexing#configure-auto-indexing) and data retention policies as it relates to resource usage (particular the disk requirement for Postgres). +This guide gives an overview of best practices when defining [auto-index scheduling](/code-navigation/auto_indexing#configure-auto-indexing) and data retention policies as it relates to resource usage (particular the disk requirement for Postgres). **Auto-index scheduling policies** define the _cadence_ at which particular repositories will be subject to have indexing jobs scheduled (depending on the repository's configuration and contents). These policies define when a commit of a repository should be marked as an auto-index job candidate. diff --git a/docs/code-navigation/index.mdx b/docs/code-navigation/index.mdx index ead8e783c..1cddaca89 100644 --- a/docs/code-navigation/index.mdx +++ b/docs/code-navigation/index.mdx @@ -7,7 +7,7 @@ Code Navigation helps you quickly understand your code, its dependencies, and symbols within the Sourcegraph file view while making it easier to move through your codebase via: -- Onboarding to codebases faster with cross-repository code navigation features like [Go to definition](/code-search/code-navigation/features#go-to-definition) and [Find references](/code-search/code-navigation/features#find-references) +- Onboarding to codebases faster with cross-repository code navigation features like [Go to definition](/code-navigation/features#go-to-definition) and [Find references](/code-navigation/features#find-references) - Providing complete precise reviews, getting up to speed on unfamiliar code, and determining the impact of code changes with the confidence of compiler-accurate code navigation - Determining the root causes quickly with precise code navigation that tracks references across repositories and package dependencies @@ -36,21 +36,21 @@ Code Navigation helps you quickly understand your code, its dependencies, and sy description="See how Code Navigation works on public code." /> Read and learn more about [Code Navigation features here - →](/code-search/code-navigation/features) + →](/code-navigation/features) ## Code Navigation types diff --git a/docs/code-navigation/inference_configuration.mdx b/docs/code-navigation/inference_configuration.mdx index 011e36488..1f71f3fce 100644 --- a/docs/code-navigation/inference_configuration.mdx +++ b/docs/code-navigation/inference_configuration.mdx @@ -4,16 +4,16 @@ This feature is in beta for self-hosted customers. -This document details how a site administrator can supply a Lua script to customize the way [Sourcegraph detects precise code intelligence indexing jobs from repository contents](/code-search/code-navigation/explanations/auto_indexing_inference). +This document details how a site administrator can supply a Lua script to customize the way [Sourcegraph detects precise code intelligence indexing jobs from repository contents](/code-navigation/explanations/auto_indexing_inference). By default, Sourcegraph will attempt to infer index jobs for the following languages: -- [`Go`](/code-search/code-navigation/explanations/auto_indexing_inference#go) -- [`Java`/`Scala`/`Kotlin`](/code-search/code-navigation/explanations/auto_indexing_inference#java) +- [`Go`](/code-navigation/explanations/auto_indexing_inference#go) +- [`Java`/`Scala`/`Kotlin`](/code-navigation/explanations/auto_indexing_inference#java) - `Python` - `Ruby` -- [`Rust`](/code-search/code-navigation/explanations/auto_indexing_inference#rust) -- [`TypeScript`/`JavaScript`](/code-search/code-navigation/explanations/auto_indexing_inference#typescript) +- [`Rust`](/code-navigation/explanations/auto_indexing_inference#rust) +- [`TypeScript`/`JavaScript`](/code-navigation/explanations/auto_indexing_inference#typescript) Inference logic can be disabled or altered in the case when the target repositories do not conform to a pattern that the Sourcegraph default inference logic recognizes. Inference logic is controlled by a **Lua override script** that can be supplied in the UI under `Admin > Code graph > Inference`. @@ -44,7 +44,7 @@ return require("sg.autoindex.config").new({ To **add** additional behaviors, you can create and register a new **recognizer**. A recognizer is an interface that requests some set of files from a repository, and returns a set of auto-indexing job configurations that could produce a precise code intelligence index. -A _path recognizer_ is a concrete recognizer that advertises a set of path _globs_ it is interested in, then invokes its `generate` function with matching paths from a repository. In the following, all files matching `Snek.module` (`Snek.module`, `proj/Snek.module`, `proj/sub/Snek.module`, etc) are passed to a call to `generate` (if non-empty). The generate function will then return a list of indexing job descriptions. The [guide for auto-indexing jobs configuration](/code-search/code-navigation/auto_indexing_configuration#keys-1) gives detailed descriptions on the fields of this object. +A _path recognizer_ is a concrete recognizer that advertises a set of path _globs_ it is interested in, then invokes its `generate` function with matching paths from a repository. In the following, all files matching `Snek.module` (`Snek.module`, `proj/Snek.module`, `proj/sub/Snek.module`, etc) are passed to a call to `generate` (if non-empty). The generate function will then return a list of indexing job descriptions. The [guide for auto-indexing jobs configuration](/code-navigation/auto_indexing_configuration#keys-1) gives detailed descriptions on the fields of this object. The ordering of paths and limits are defined in the [Ordering guarantees and limits](#ordering-guarantees-and-limits) section. diff --git a/docs/code-navigation/precise_code_navigation.mdx b/docs/code-navigation/precise_code_navigation.mdx index 50075b6a6..19c47ade9 100644 --- a/docs/code-navigation/precise_code_navigation.mdx +++ b/docs/code-navigation/precise_code_navigation.mdx @@ -24,11 +24,11 @@ Precise code navigation relies on the open source [SCIP Code Intelligence Protoc There are several options for setting up precise code navigation listed below. However, we always recommend you start by manually indexing your repo locally using the [approriate - indexer](/code-search/code-navigation/writing_an_indexer#quick-reference) - for your language. Code and build systems can vary by project and ensuring - you can first succesfully run the indexer locally leads to a smoother - experience since it is vastly easier to debug and iterate on any issues - locally before trying to do so in CI/CD or in Auto-Indexing. + indexer](/code-navigation/writing_an_indexer#quick-reference) for your + language. Code and build systems can vary by project and ensuring you can + first succesfully run the indexer locally leads to a smoother experience + since it is vastly easier to debug and iterate on any issues locally before + trying to do so in CI/CD or in Auto-Indexing. 1. **Manual indexing**. Index a repository and upload it to your Sourcegraph instance: @@ -39,12 +39,12 @@ Precise code navigation relies on the open source [SCIP Code Intelligence Protoc - [Index a Python repository](https://sourcegraph.com/github.com/sourcegraph/scip-python) - [Index a Ruby repository](https://sourcegraph.com/github.com/sourcegraph/scip-ruby) -2. [**Automate indexing via CI**](/code-search/code-navigation/how-to/adding_scip_to_workflows): Add indexing and uploading to your CI setup. -3. [**Auto-indexing**](/code-search/code-navigation/auto_indexing#enable-auto-indexing): Sourcegraph will automatically index your repositories and enable precise code navigation for them. +2. [**Automate indexing via CI**](/code-navigation/how-to/adding_scip_to_workflows): Add indexing and uploading to your CI setup. +3. [**Auto-indexing**](/code-navigation/auto_indexing#enable-auto-indexing): Sourcegraph will automatically index your repositories and enable precise code navigation for them. ## Supported languages and indexers -Precise Code Navigation requires language-specific indexes to be generated and uploaded to your Sourcegraph instance. We currently have precise code navigation support for the languages below. See the [indexers page](/code-search/code-navigation/writing_an_indexer) for a detailed breakdown of each indexer's status. +Precise Code Navigation requires language-specific indexes to be generated and uploaded to your Sourcegraph instance. We currently have precise code navigation support for the languages below. See the [indexers page](/code-navigation/writing_an_indexer) for a detailed breakdown of each indexer's status. | Language | Indexer | Status | | ---------------------- | --------------------------------------------------------------------------------- | ---------------------- | @@ -57,7 +57,7 @@ Precise Code Navigation requires language-specific indexes to be generated and u | Ruby | [scip-ruby](https://sourcegraph.com/github.com/sourcegraph/scip-ruby) | 🟢 Generally available | | C#, Visual Basic | [scip-dotnet](https://github.com/sourcegraph/scip-dotnet) | 🟢 Generally available | -The easiest way to configure precise code navigation is with [auto-indexing](/code-search/code-navigation/auto_indexing). This feature uses [Sourcegraph executors](/admin/executors/) to automatically create indexes for the code, keeping precise code navigation available and up-to-date. +The easiest way to configure precise code navigation is with [auto-indexing](/code-navigation/auto_indexing). This feature uses [Sourcegraph executors](/admin/executors/) to automatically create indexes for the code, keeping precise code navigation available and up-to-date. ## Precise navigation examples @@ -79,14 +79,14 @@ The following repositories have precise code navigation enabled: To enable precise code navigation for your repository, see our [docs - here](/code-search/code-navigation/precise_code_navigation#setting-up-code-navigation-for-your-codebase). + here](/code-navigation/precise_code_navigation#setting-up-code-navigation-for-your-codebase). ## More resources Requires enabling and setting up Sourcegraph's auto-indexing feature. Read - more about [Auto-indexing](/code-search/code-navigation/auto_indexing). + more about [Auto-indexing](/code-navigation/auto_indexing). ### Status definitions @@ -196,21 +196,21 @@ We may lack the language expertise or bandwidth to implement certain features on Date: Sun, 14 Dec 2025 20:16:04 +0100 Subject: [PATCH 04/21] Remove old version callouts from notebooks --- docs/notebooks/index.mdx | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/docs/notebooks/index.mdx b/docs/notebooks/index.mdx index ab721922f..25e305cb0 100644 --- a/docs/notebooks/index.mdx +++ b/docs/notebooks/index.mdx @@ -1,6 +1,6 @@ # Notebooks -Notebooks enable powerful live–and persistent–documentation, shareable with your organization or the world. As of release 3.39, Notebooks are Generally Available (GA). If you're a Sourcegraph enterprise user and are on version 3.39 or later, you'll find Notebooks in the header navigation, or by going to `https:///notebooks`. +Notebooks enable powerful live–and persistent–documentation, shareable with your organization or the world. Inspired by Jupyter Notebooks and powered by Markdown and Sourcegraph's code search, Notebooks let you and your team create living documentation that interacts directly with your code. You can leverage Notebooks to onboard a new teammate, document known vulnerabilities, a common pattern in your codebase, or useful Sourcegraph queries. @@ -58,16 +58,6 @@ Notebooks created through the web interface are full text searchable from the `/ Searches will match on notebook titles and any text in blocks. For example any text in Markdown blocks and any of the query text in file, symbol, and search query blocks. Searching through results in symbol, file, and query block types is not supported because they are dynamic in nature. -## Enabling Notebooks in older versions of Sourcegraph - -In versions older than 3.39 (beginning in 3.36) Notebooks are behind an experimental feature flag. If you're running versions 3.36-3.38 and want to try out Notebooks, enable them in global settings: - -``` -"experimentalFeatures": { - "showSearchNotebook": true -} -``` - Date: Sun, 14 Dec 2025 20:23:23 +0100 Subject: [PATCH 05/21] Create self-hosted folder structure --- docs/admin/tls_ssl.mdx | 3 --- docs/{admin/self-hosted.mdx => self-hosted/index.mdx} | 5 +---- src/data/navigation.ts | 2 +- src/data/redirects.ts | 10 ++++++++++ 4 files changed, 12 insertions(+), 8 deletions(-) delete mode 100644 docs/admin/tls_ssl.mdx rename docs/{admin/self-hosted.mdx => self-hosted/index.mdx} (95%) diff --git a/docs/admin/tls_ssl.mdx b/docs/admin/tls_ssl.mdx deleted file mode 100644 index 746b894f0..000000000 --- a/docs/admin/tls_ssl.mdx +++ /dev/null @@ -1,3 +0,0 @@ -# Securing a Sourcegraph instance with TLS/SSL - -This documentation page has been moved to "[Sourcegraph HTTP and HTTPS/SSL configuration](/admin/http_https_configuration)". All HTTP and HTTPS configuration options are now handled by nginx or caddy, which ships with most Sourcegraph deployment types. diff --git a/docs/admin/self-hosted.mdx b/docs/self-hosted/index.mdx similarity index 95% rename from docs/admin/self-hosted.mdx rename to docs/self-hosted/index.mdx index 63f3e5578..549647e16 100644 --- a/docs/admin/self-hosted.mdx +++ b/docs/self-hosted/index.mdx @@ -1,9 +1,6 @@ # Enterprise Self-Hosted - - Supported on [Enterprise](/pricing/enterprise) plans. - Available via the Web app. - +Supported on [Enterprise](/pricing/enterprise) plans. Sourcegraph administration is primarily managed by site administrators, who are responsible for the deployment, management, and configuration of Sourcegraph instances for end users. For a comprehensive introduction to site administration, refer to our [quickstart guide](/admin/how-to/site-admin-quickstart). diff --git a/src/data/navigation.ts b/src/data/navigation.ts index 627e7c5d7..bf6ff2cbb 100644 --- a/src/data/navigation.ts +++ b/src/data/navigation.ts @@ -468,7 +468,7 @@ export const navigation: NavigationItem[] = [ }, { title: 'Enterprise Self-Hosted', - href: '/admin/self-hosted', + href: '/self-hosted', sections: [ {title: 'Deploy', href: '/admin/deploy'}, {title: 'Architecture', href: '/admin/architecture'}, diff --git a/src/data/redirects.ts b/src/data/redirects.ts index cb6389188..4b81054df 100644 --- a/src/data/redirects.ts +++ b/src/data/redirects.ts @@ -1,4 +1,9 @@ const redirectsData = [ + { + source: '/admin/tls_ssl', + destination: '/admin/http_https_configuration', + permanent: true + }, { source: '/docs/admin/deploy_executors', destination: @@ -5781,6 +5786,11 @@ const redirectsData = [ source: '/code-search/code-navigation/writing_an_indexer', destination: '/code-navigation/writing_an_indexer', permanent: true + }, + { + source: '/admin/self-hosted', + destination: '/self-hosted', + permanent: true } ]; From 3e3cf063b23128fb4df5339aa070ddd1b1d16965 Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 20:43:16 +0100 Subject: [PATCH 06/21] Remove version callouts --- docs/admin/how-to/export-search-results.mdx | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/docs/admin/how-to/export-search-results.mdx b/docs/admin/how-to/export-search-results.mdx index 908505834..458558c03 100644 --- a/docs/admin/how-to/export-search-results.mdx +++ b/docs/admin/how-to/export-search-results.mdx @@ -2,18 +2,8 @@ You can export search results to a CSV file by pressing the 'Export results' button in the `Actions` menu above the search results. - - For versions before 5.8, the 'Export Results' action is only available in - the legacy UI. For versions before 4.0, view the legacy docs at - [sourcegraph/sourcegraph-search-export](https://github.com/sourcegraph/sourcegraph-search-export#sourcegraph-search-results-csv-export-extension). - - ## FAQs -#### The exported results do not match the results page - -Before Sourcegraph 4.4.0, the search result export feature used the GraphQL API with result limits for fast resolution. Add `count:all` to your query to run an exhaustive search. - #### The number of exported results does not match the number of results displayed on Sourcegraph This is expected, as all instances that match for a single file will be listed in the same entry column under the Search matches row. From 3d7c8c92ce8b805b74f100da198b58b855300299 Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 21:21:38 +0100 Subject: [PATCH 07/21] Move most content that is self-hosted specific to self-hosted section This makes a clean /admin section that applies to all instances, and then a separate /self-hosted section that applies to self-hosted only. This drastically reduces the amount of documentation for Cloud customers. TODO: Need to fix up tooling that writes dashboards.mdx and alert_solutions.mdx. --- docs/admin/architecture.mdx | 10 +- docs/admin/auth/builtin.mdx | 2 +- docs/admin/auth/saml/index.mdx | 8 +- docs/admin/auth/saml/microsoft_adfs.mdx | 2 +- docs/admin/auth/troubleshooting.mdx | 4 +- docs/admin/code_hosts/aws_codecommit.mdx | 2 +- docs/admin/code_hosts/azuredevops.mdx | 2 +- docs/admin/code_hosts/bitbucket_cloud.mdx | 2 +- docs/admin/code_hosts/bitbucket_server.mdx | 2 +- docs/admin/code_hosts/github.mdx | 10 +- docs/admin/code_hosts/gitlab.mdx | 4 +- docs/admin/code_hosts/non-git.mdx | 2 +- docs/admin/code_hosts/rate_limits.mdx | 2 +- docs/admin/config/batch_changes.mdx | 2 +- docs/admin/config/index.mdx | 25 +- docs/admin/config/site_config.mdx | 6 +- docs/admin/config/webhooks/index.mdx | 4 - .../index.mdx => admin/enterprise-portal.mdx} | 0 ...x => enterprise_getting_started_guide.mdx} | 12 +- docs/admin/executors/executor_secrets.mdx | 2 +- docs/admin/executors/index.mdx | 152 +---- docs/admin/faq.mdx | 105 ---- docs/admin/how-to/index.mdx | 17 - docs/admin/how-to/lsif_scip_migration.mdx | 6 +- docs/admin/how-to/monitoring-guide.mdx | 18 - docs/admin/how-to/monorepo-issues.mdx | 4 +- docs/admin/how-to/repo-not-updated.mdx | 2 +- docs/admin/how-to/site-admin-quickstart.mdx | 16 +- docs/admin/how-to/unknown-error-login.mdx | 2 +- docs/admin/index.mdx | 31 +- .../{licensing/index.mdx => licensing.mdx} | 0 docs/admin/migration/index.mdx | 4 +- docs/admin/migration/opengrok.mdx | 6 +- .../outbound-request-log.mdx | 4 +- docs/admin/permissions/webhooks.mdx | 2 +- docs/admin/repo/add.mdx | 4 +- docs/admin/repo/auth.mdx | 6 +- docs/admin/repo/git_config.mdx | 6 +- docs/admin/repo/pre_load_from_local_disk.mdx | 8 +- docs/admin/repo/webhooks.mdx | 2 +- docs/admin/search.mdx | 4 +- .../index.mdx => subscriptions.mdx} | 0 docs/admin/{teams/index.mdx => teams.mdx} | 0 .../{telemetry/index.mdx => telemetry.mdx} | 0 docs/admin/updates/migrator/index.mdx | 7 - docs/admin/{config => }/webhooks/incoming.mdx | 4 +- docs/admin/webhooks/index.mdx | 4 + docs/admin/{config => }/webhooks/outgoing.mdx | 0 docs/batch-changes/faq.mdx | 2 +- docs/batch-changes/server-side.mdx | 6 +- .../site-admin-configuration.mdx | 4 +- docs/cloud/index.mdx | 10 +- docs/code-navigation/auto_indexing.mdx | 4 +- docs/code-navigation/envvars.mdx | 6 +- docs/code-navigation/explanations/uploads.mdx | 2 +- docs/code-navigation/troubleshooting.mdx | 2 +- ...stration_and_security_of_code_insights.mdx | 2 +- docs/code_insights/quickstart.mdx | 2 +- .../code_insights/references/requirements.mdx | 2 +- docs/code_monitoring/index.mdx | 2 +- docs/deep-search/index.mdx | 2 +- docs/dotcom/index.mdx | 2 +- docs/getting-started/cloud-instance.mdx | 2 +- docs/getting-started/index.mdx | 2 +- docs/getting-started/tour.mdx | 8 +- docs/how-to/aws-instance-sizing.mdx | 2 +- .../advanced_config_file.mdx | 12 +- .../deploy/docker-compose/aws.mdx | 6 +- .../deploy/docker-compose/azure.mdx | 6 +- .../deploy/docker-compose/configuration.mdx | 14 +- .../deploy/docker-compose/digitalocean.mdx | 8 +- .../deploy/docker-compose/google_cloud.mdx | 6 +- .../deploy/docker-compose/index.mdx | 12 +- .../deploy/docker-compose/migrate.mdx | 8 +- .../deploy/docker-compose/operations.mdx | 14 +- .../deploy/docker-compose/upgrade.mdx | 10 +- .../deploy/docker-single-container/aws.mdx | 8 +- .../docker-single-container/digitalocean.mdx | 6 +- .../docker-single-container/google_cloud.mdx | 6 +- .../deploy/docker-single-container/index.mdx | 26 +- docs/{admin => self-hosted}/deploy/index.mdx | 14 +- .../deploy/instance-size.mdx | 6 +- .../deploy/kubernetes/azure.mdx | 4 +- .../deploy/kubernetes/configure.mdx | 28 +- .../deploy/kubernetes/eks.mdx | 4 +- .../deploy/kubernetes/index.mdx | 30 +- .../deploy/kubernetes/kustomize.mdx | 36 +- .../deploy/kubernetes/kustomize/eks.mdx | 2 +- .../deploy/kubernetes/kustomize/gke.mdx | 4 +- .../deploy/kubernetes/kustomize/index.mdx | 10 +- .../deploy/kubernetes/kustomize/migrate.mdx | 26 +- .../deploy/kubernetes/operations.mdx | 24 +- .../deploy/kubernetes/scale.mdx | 6 +- .../deploy/kubernetes/troubleshoot.mdx | 8 +- .../deploy/kubernetes/upgrade.mdx | 28 +- .../deploy/machine-images/aws-ami.mdx | 6 +- .../deploy/machine-images/aws-oneclick.mdx | 16 +- .../deploy/machine-images/gce.mdx | 10 +- .../deploy/machine-images/index.mdx | 0 .../deploy/migrate-backup.mdx | 8 +- .../deploy/repositories.mdx | 4 +- .../deploy/resource_estimator.mdx | 4 +- docs/{admin => self-hosted}/deploy/scale.mdx | 54 +- .../deploy/single-node/index.mdx | 4 +- .../deploy/single-node/script.mdx | 8 +- .../deploy/without_service_discovery.mdx | 2 +- .../deployment_best_practices.mdx | 8 +- docs/{admin/config => self-hosted}/email.mdx | 0 .../config => self-hosted}/encryption.mdx | 0 .../executors/deploy_executors.mdx | 28 +- .../executors/deploy_executors_binary.mdx | 6 +- .../deploy_executors_binary_offline.mdx | 10 +- .../executors/deploy_executors_dind.mdx | 8 +- .../executors/deploy_executors_docker.mdx | 4 +- .../executors/deploy_executors_kubernetes.mdx | 10 +- .../executors/deploy_executors_terraform.mdx | 4 +- .../executors/executors_config.mdx | 0 .../executors/executors_troubleshooting.mdx | 8 +- .../executors/firecracker.mdx | 4 +- docs/self-hosted/executors/index.mdx | 189 ++++++ .../external_services/index.mdx | 8 +- .../external_services/object_storage.mdx | 0 .../external_services/postgres.mdx | 10 +- .../external_services/redis.mdx | 4 +- docs/self-hosted/faq.mdx | 106 ++++ .../how-to/blobstore_debugging.mdx | 4 +- .../how-to/blobstore_update_notes.mdx | 2 +- .../how-to/clear_codeintel_data.mdx | 4 +- .../how-to/dirty_database.mdx | 10 +- .../how-to/dirty_database_pre_3_37.mdx | 8 +- docs/self-hosted/how-to/index.mdx | 31 + docs/self-hosted/how-to/monitoring-guide.mdx | 18 + .../how-to/postgres14-index-corruption.mdx | 4 +- .../how-to/postgres_12_to_16_drift.mdx | 0 ...ise-code-intel-worker-crashloopbackoff.mdx | 6 +- .../how-to/privileged_migrations.mdx | 4 +- .../rebuild-corrupt-postgres-indexes.mdx | 2 +- .../how-to/redis_configmap.mdx | 4 +- .../how-to/rollback_database.mdx | 4 +- .../how-to/run-psql.mdx | 0 .../how-to/setup-https.mdx | 0 .../how-to/troubleshoot-pod-eviction.mdx | 2 +- .../how-to/unfinished_migration.mdx | 4 +- .../upgrade-postgres-12-16-builtin-dbs.mdx | 10 +- .../http_https_configuration.mdx | 8 +- docs/self-hosted/index.mdx | 73 +-- .../network-filtering.mdx | 0 .../observability/.gitattributes | 0 .../observability/alerting.mdx | 8 +- .../alerting_custom_consumption.mdx | 4 +- .../observability/alerts.mdx | 0 .../observability/dashboards.mdx | 0 .../observability/health_checks.mdx | 2 +- .../observability/index.mdx | 28 +- .../observability/logs.mdx | 2 +- .../observability/metrics.mdx | 22 +- .../observability/opentelemetry.mdx | 12 +- .../observability/tracing.mdx | 12 +- .../observability/troubleshooting.mdx | 16 +- .../config => self-hosted}/postgres-conf.mdx | 2 +- docs/{admin => self-hosted}/postgres.mdx | 10 +- .../postgres12_end_of_life_notice.mdx | 0 ..._collation_version_mismatch_resolution.mdx | 0 docs/{admin => self-hosted}/pprof.mdx | 2 +- .../private-network.mdx | 0 .../index.mdx => self-hosted/restore.mdx} | 0 .../sourcegraph-nginx-mermaid.mdx | 0 .../ssl_https_self_signed_cert_nginx.mdx | 4 +- .../updates/automatic.mdx | 4 +- .../updates/docker_compose.mdx | 28 +- docs/{admin => self-hosted}/updates/index.mdx | 42 +- .../updates/kubernetes.mdx | 38 +- .../updates/migrator/downgrading.mdx | 4 +- docs/self-hosted/updates/migrator/index.mdx | 7 + .../updates/migrator/migrator-operations.mdx | 18 +- .../updates/migrator/schema-drift.mdx | 2 +- .../migrator/troubleshooting-upgrades.mdx | 2 +- .../migrator/upgrading-early-versions.mdx | 8 +- .../updates/pure_docker.mdx | 10 +- .../{admin => self-hosted}/updates/server.mdx | 8 +- docs/{admin => self-hosted}/url.mdx | 0 docs/{admin => self-hosted}/validation.mdx | 0 docs/{admin => self-hosted}/workers.mdx | 2 +- docs/technical-changelog.mdx | 322 +++++----- src/data/navigation.ts | 15 +- src/data/redirects.ts | 592 ++++++++++++++++++ 186 files changed, 1762 insertions(+), 1136 deletions(-) delete mode 100644 docs/admin/config/webhooks/index.mdx rename docs/{enterprise-portal/index.mdx => admin/enterprise-portal.mdx} (100%) rename docs/admin/{enterprise_getting_started_guide/index.mdx => enterprise_getting_started_guide.mdx} (79%) delete mode 100644 docs/admin/how-to/monitoring-guide.mdx rename docs/admin/{licensing/index.mdx => licensing.mdx} (100%) rename docs/admin/{observability => }/outbound-request-log.mdx (95%) rename docs/admin/{subscriptions/index.mdx => subscriptions.mdx} (100%) rename docs/admin/{teams/index.mdx => teams.mdx} (100%) rename docs/admin/{telemetry/index.mdx => telemetry.mdx} (100%) delete mode 100644 docs/admin/updates/migrator/index.mdx rename docs/admin/{config => }/webhooks/incoming.mdx (97%) create mode 100644 docs/admin/webhooks/index.mdx rename docs/admin/{config => }/webhooks/outgoing.mdx (100%) rename docs/{admin/config => self-hosted}/advanced_config_file.mdx (93%) rename docs/{admin => self-hosted}/deploy/docker-compose/aws.mdx (96%) rename docs/{admin => self-hosted}/deploy/docker-compose/azure.mdx (97%) rename docs/{admin => self-hosted}/deploy/docker-compose/configuration.mdx (90%) rename docs/{admin => self-hosted}/deploy/docker-compose/digitalocean.mdx (94%) rename docs/{admin => self-hosted}/deploy/docker-compose/google_cloud.mdx (96%) rename docs/{admin => self-hosted}/deploy/docker-compose/index.mdx (93%) rename docs/{admin => self-hosted}/deploy/docker-compose/migrate.mdx (91%) rename docs/{admin => self-hosted}/deploy/docker-compose/operations.mdx (92%) rename docs/{admin => self-hosted}/deploy/docker-compose/upgrade.mdx (92%) rename docs/{admin => self-hosted}/deploy/docker-single-container/aws.mdx (83%) rename docs/{admin => self-hosted}/deploy/docker-single-container/digitalocean.mdx (81%) rename docs/{admin => self-hosted}/deploy/docker-single-container/google_cloud.mdx (78%) rename docs/{admin => self-hosted}/deploy/docker-single-container/index.mdx (89%) rename docs/{admin => self-hosted}/deploy/index.mdx (90%) rename docs/{admin => self-hosted}/deploy/instance-size.mdx (88%) rename docs/{admin => self-hosted}/deploy/kubernetes/azure.mdx (87%) rename docs/{admin => self-hosted}/deploy/kubernetes/configure.mdx (96%) rename docs/{admin => self-hosted}/deploy/kubernetes/eks.mdx (96%) rename docs/{admin => self-hosted}/deploy/kubernetes/index.mdx (96%) rename docs/{admin => self-hosted}/deploy/kubernetes/kustomize.mdx (81%) rename docs/{admin => self-hosted}/deploy/kubernetes/kustomize/eks.mdx (98%) rename docs/{admin => self-hosted}/deploy/kubernetes/kustomize/gke.mdx (96%) rename docs/{admin => self-hosted}/deploy/kubernetes/kustomize/index.mdx (92%) rename docs/{admin => self-hosted}/deploy/kubernetes/kustomize/migrate.mdx (88%) rename docs/{admin => self-hosted}/deploy/kubernetes/operations.mdx (92%) rename docs/{admin => self-hosted}/deploy/kubernetes/scale.mdx (89%) rename docs/{admin => self-hosted}/deploy/kubernetes/troubleshoot.mdx (94%) rename docs/{admin => self-hosted}/deploy/kubernetes/upgrade.mdx (86%) rename docs/{admin => self-hosted}/deploy/machine-images/aws-ami.mdx (97%) rename docs/{admin => self-hosted}/deploy/machine-images/aws-oneclick.mdx (87%) rename docs/{admin => self-hosted}/deploy/machine-images/gce.mdx (97%) rename docs/{admin => self-hosted}/deploy/machine-images/index.mdx (100%) rename docs/{admin => self-hosted}/deploy/migrate-backup.mdx (93%) rename docs/{admin => self-hosted}/deploy/repositories.mdx (90%) rename docs/{admin => self-hosted}/deploy/resource_estimator.mdx (92%) rename docs/{admin => self-hosted}/deploy/scale.mdx (90%) rename docs/{admin => self-hosted}/deploy/single-node/index.mdx (55%) rename docs/{admin => self-hosted}/deploy/single-node/script.mdx (93%) rename docs/{admin => self-hosted}/deploy/without_service_discovery.mdx (89%) rename docs/{admin => self-hosted}/deployment_best_practices.mdx (92%) rename docs/{admin/config => self-hosted}/email.mdx (100%) rename docs/{admin/config => self-hosted}/encryption.mdx (100%) rename docs/{admin => self-hosted}/executors/deploy_executors.mdx (90%) rename docs/{admin => self-hosted}/executors/deploy_executors_binary.mdx (95%) rename docs/{admin => self-hosted}/executors/deploy_executors_binary_offline.mdx (92%) rename docs/{admin => self-hosted}/executors/deploy_executors_dind.mdx (82%) rename docs/{admin => self-hosted}/executors/deploy_executors_docker.mdx (89%) rename docs/{admin => self-hosted}/executors/deploy_executors_kubernetes.mdx (92%) rename docs/{admin => self-hosted}/executors/deploy_executors_terraform.mdx (99%) rename docs/{admin => self-hosted}/executors/executors_config.mdx (100%) rename docs/{admin => self-hosted}/executors/executors_troubleshooting.mdx (95%) rename docs/{admin => self-hosted}/executors/firecracker.mdx (94%) create mode 100644 docs/self-hosted/executors/index.mdx rename docs/{admin => self-hosted}/external_services/index.mdx (81%) rename docs/{admin => self-hosted}/external_services/object_storage.mdx (100%) rename docs/{admin => self-hosted}/external_services/postgres.mdx (96%) rename docs/{admin => self-hosted}/external_services/redis.mdx (90%) create mode 100644 docs/self-hosted/faq.mdx rename docs/{admin => self-hosted}/how-to/blobstore_debugging.mdx (94%) rename docs/{admin => self-hosted}/how-to/blobstore_update_notes.mdx (85%) rename docs/{admin => self-hosted}/how-to/clear_codeintel_data.mdx (89%) rename docs/{admin => self-hosted}/how-to/dirty_database.mdx (83%) rename docs/{admin => self-hosted}/how-to/dirty_database_pre_3_37.mdx (92%) create mode 100644 docs/self-hosted/how-to/index.mdx create mode 100644 docs/self-hosted/how-to/monitoring-guide.mdx rename docs/{admin => self-hosted}/how-to/postgres14-index-corruption.mdx (94%) rename docs/{admin => self-hosted}/how-to/postgres_12_to_16_drift.mdx (100%) rename docs/{admin => self-hosted}/how-to/precise-code-intel-worker-crashloopbackoff.mdx (85%) rename docs/{admin => self-hosted}/how-to/privileged_migrations.mdx (81%) rename docs/{admin => self-hosted}/how-to/rebuild-corrupt-postgres-indexes.mdx (97%) rename docs/{admin => self-hosted}/how-to/redis_configmap.mdx (97%) rename docs/{admin => self-hosted}/how-to/rollback_database.mdx (86%) rename docs/{admin => self-hosted}/how-to/run-psql.mdx (100%) rename docs/{admin => self-hosted}/how-to/setup-https.mdx (100%) rename docs/{admin => self-hosted}/how-to/troubleshoot-pod-eviction.mdx (94%) rename docs/{admin => self-hosted}/how-to/unfinished_migration.mdx (93%) rename docs/{admin => self-hosted}/how-to/upgrade-postgres-12-16-builtin-dbs.mdx (82%) rename docs/{admin => self-hosted}/http_https_configuration.mdx (94%) rename docs/{admin/config => self-hosted}/network-filtering.mdx (100%) rename docs/{admin => self-hosted}/observability/.gitattributes (100%) rename docs/{admin => self-hosted}/observability/alerting.mdx (95%) rename docs/{admin => self-hosted}/observability/alerting_custom_consumption.mdx (92%) rename docs/{admin => self-hosted}/observability/alerts.mdx (100%) rename docs/{admin => self-hosted}/observability/dashboards.mdx (100%) rename docs/{admin => self-hosted}/observability/health_checks.mdx (63%) rename docs/{admin => self-hosted}/observability/index.mdx (56%) rename docs/{admin => self-hosted}/observability/logs.mdx (97%) rename docs/{admin => self-hosted}/observability/metrics.mdx (86%) rename docs/{admin => self-hosted}/observability/opentelemetry.mdx (93%) rename docs/{admin => self-hosted}/observability/tracing.mdx (85%) rename docs/{admin => self-hosted}/observability/troubleshooting.mdx (96%) rename docs/{admin/config => self-hosted}/postgres-conf.mdx (95%) rename docs/{admin => self-hosted}/postgres.mdx (86%) rename docs/{admin => self-hosted}/postgres12_end_of_life_notice.mdx (100%) rename docs/{admin => self-hosted}/postgresql_collation_version_mismatch_resolution.mdx (100%) rename docs/{admin => self-hosted}/pprof.mdx (97%) rename docs/{admin/config => self-hosted}/private-network.mdx (100%) rename docs/{admin/config/restore/index.mdx => self-hosted/restore.mdx} (100%) rename docs/{admin => self-hosted}/sourcegraph-nginx-mermaid.mdx (100%) rename docs/{admin => self-hosted}/ssl_https_self_signed_cert_nginx.mdx (97%) rename docs/{admin => self-hosted}/updates/automatic.mdx (88%) rename docs/{admin => self-hosted}/updates/docker_compose.mdx (91%) rename docs/{admin => self-hosted}/updates/index.mdx (76%) rename docs/{admin => self-hosted}/updates/kubernetes.mdx (87%) rename docs/{admin => self-hosted}/updates/migrator/downgrading.mdx (92%) create mode 100644 docs/self-hosted/updates/migrator/index.mdx rename docs/{admin => self-hosted}/updates/migrator/migrator-operations.mdx (95%) rename docs/{admin => self-hosted}/updates/migrator/schema-drift.mdx (93%) rename docs/{admin => self-hosted}/updates/migrator/troubleshooting-upgrades.mdx (94%) rename docs/{admin => self-hosted}/updates/migrator/upgrading-early-versions.mdx (93%) rename docs/{admin => self-hosted}/updates/pure_docker.mdx (97%) rename docs/{admin => self-hosted}/updates/server.mdx (89%) rename docs/{admin => self-hosted}/url.mdx (100%) rename docs/{admin => self-hosted}/validation.mdx (100%) rename docs/{admin => self-hosted}/workers.mdx (99%) diff --git a/docs/admin/architecture.mdx b/docs/admin/architecture.mdx index f271ec469..888eaddd0 100644 --- a/docs/admin/architecture.mdx +++ b/docs/admin/architecture.mdx @@ -183,30 +183,30 @@ Sourcegraph's recommended deployment methods are: 4. Kubernetes Kustomize: Helm is Sourcegraph's more standardized and vetted approach to deploying with Kubernetes, but if Kustomize is your preferred deployment method it is a viable and supported approach. 5. Machine Images: Sourcegraph can be deployed using dedicated Machine Images for specific Cloud providers. This can be a simple solution in specific circumstances, though has its own considerations. If you are considering this path, please discuss with your account team. -The [resource estimator](/admin/deploy/resource_estimator#sourcegraph-resource-estimator) can guide you on the requirements for each deployment type. +The [resource estimator](/self-hosted/deploy/resource_estimator#sourcegraph-resource-estimator) can guide you on the requirements for each deployment type. - Learn more in the [deployment docs](/admin/deploy) + Learn more in the [deployment docs](/self-hosted/deploy) ## Observability Observability encapsulates the monitoring and debugging of Sourcegraph deployments. Sourcegraph is designed and ships several observability tools and out-of-the-box capabilities to enable visibility into the health and state of a Sourcegraph deployment. -Monitoring includes [metrics and dashboards](/admin/observability/metrics), [alerting](/admin/observability/alerting), and [health checking](/admin/observability/health_checks) capabilities. +Monitoring includes [metrics and dashboards](/self-hosted/observability/metrics), [alerting](/self-hosted/observability/alerting), and [health checking](/self-hosted/observability/health_checks) capabilities. - `grafana` is the frontend for service metrics and ships with customized dashboards for Sourcegraph services - prometheus handles the scraping of service metrics and ships with recording rules, alert rules, and alerting capabilities - `cadvisor` provides per-container performance metrics (scraped by Prometheus) in most Sourcegraph environments - Each Sourcegraph service provides health checks -Debugging includes [tracing](/admin/observability/tracing) and [logging](/admin/observability/logs). +Debugging includes [tracing](/self-hosted/observability/tracing) and [logging](/self-hosted/observability/logs). - jaeger is the distributed tracing service used by Sourcegraph - Each Sourcegraph service provides logs - Learn more in the [Observability docs](/admin/observability). + Learn more in the [Observability docs](/self-hosted/observability). ## Cody diff --git a/docs/admin/auth/builtin.mdx b/docs/admin/auth/builtin.mdx index 81bad5a59..f6f5401a1 100644 --- a/docs/admin/auth/builtin.mdx +++ b/docs/admin/auth/builtin.mdx @@ -80,7 +80,7 @@ Users can be created for builtin password authentication in several ways: - through the `createUser` mutation in the GraphQL API - through [`src users create`](/cli/references/users/create) -When [SMTP is enabled](/admin/config/email), special behaviours apply to whether a builtin authentication user's email is marked as verified by default - refer to [email verification](/admin/config/email#user-email-verification) for more details. +When [SMTP is enabled](/self-hosted/email), special behaviours apply to whether a builtin authentication user's email is marked as verified by default - refer to [email verification](/self-hosted/email#user-email-verification) for more details. ## Account lockout diff --git a/docs/admin/auth/saml/index.mdx b/docs/admin/auth/saml/index.mdx index 15473cc3e..b03626986 100644 --- a/docs/admin/auth/saml/index.mdx +++ b/docs/admin/auth/saml/index.mdx @@ -70,8 +70,8 @@ Here are some examples of what your site config might look like: Then, confirm that there are no error messages in: -- The `sourcegraph-frontend` deployment logs for instances using [Docker Compose](/admin/deploy/docker-compose/) and [Kubernetes](/admin/deploy/kubernetes/) -- The `sourcegraph/server` container logs for instances using a [single docker container](/admin/deploy/docker-single-container/) +- The `sourcegraph-frontend` deployment logs for instances using [Docker Compose](/self-hosted/deploy/docker-compose/) and [Kubernetes](/self-hosted/deploy/kubernetes/) +- The `sourcegraph/server` container logs for instances using a [single docker container](/self-hosted/deploy/docker-single-container/) The most likely error message indicating a problem is: @@ -178,8 +178,8 @@ See [SAML troubleshooting](#troubleshooting) for more tips. Set the env var `INSECURE_SAML_LOG_TRACES=1` to log all SAML requests and responses on: -- The `sourcegraph-frontend` deployment for instances using [Docker Compose](/admin/deploy/docker-compose/) and [Kubernetes](/admin/deploy/kubernetes/) -- The `sourcegraph/server` container for instances using a [single docker container](/admin/deploy/docker-single-container/) +- The `sourcegraph-frontend` deployment for instances using [Docker Compose](/self-hosted/deploy/docker-compose/) and [Kubernetes](/self-hosted/deploy/kubernetes/) +- The `sourcegraph/server` container for instances using a [single docker container](/self-hosted/deploy/docker-single-container/) ### Debugging with your browser diff --git a/docs/admin/auth/saml/microsoft_adfs.mdx b/docs/admin/auth/saml/microsoft_adfs.mdx index 164c6ff19..d5dfc583d 100644 --- a/docs/admin/auth/saml/microsoft_adfs.mdx +++ b/docs/admin/auth/saml/microsoft_adfs.mdx @@ -12,7 +12,7 @@ These instructions guide you through configuring Sourcegraph as a relying party - Active Directory instance where all users have email and username attributes. - An instance of ADFS running on Windows Server, joined to your Active Directory domain. -- Sourcegraph should be [configured to use HTTPS](/admin/http_https_configuration#nginx-ssl-https-configuration). +- Sourcegraph should be [configured to use HTTPS](/self-hosted/http_https_configuration#nginx-ssl-https-configuration). - Ensure that `externalURL` in [site config](/admin/config/site_config) meets the following criteria: - It is the URL used by end users (no trailing slash). diff --git a/docs/admin/auth/troubleshooting.mdx b/docs/admin/auth/troubleshooting.mdx index 3712182d6..9e09b6460 100644 --- a/docs/admin/auth/troubleshooting.mdx +++ b/docs/admin/auth/troubleshooting.mdx @@ -38,8 +38,8 @@ Therefore, it makes no sense to have the central SSO redirect users directly bac Set the env var `INSECURE_OAUTH2_LOG_TRACES=1` to log all OAuth2 requests and responses on: -- [Docker Compose](/admin/deploy/docker-compose/) and [Kubernetes](/admin/deploy/kubernetes/): the `sourcegraph-frontend` deployment -- [Single-container](/admin/deploy/docker-single-container/): the `sourcegraph/server` container +- [Docker Compose](/self-hosted/deploy/docker-compose/) and [Kubernetes](/self-hosted/deploy/kubernetes/): the `sourcegraph-frontend` deployment +- [Single-container](/self-hosted/deploy/docker-single-container/): the `sourcegraph/server` container ### Make sure the client ID and client secret are actually correct diff --git a/docs/admin/code_hosts/aws_codecommit.mdx b/docs/admin/code_hosts/aws_codecommit.mdx index 198feace8..7e3902951 100644 --- a/docs/admin/code_hosts/aws_codecommit.mdx +++ b/docs/admin/code_hosts/aws_codecommit.mdx @@ -138,7 +138,7 @@ To add CodeCommit repositories in Docker Container: 1. Copy all the files at your `$HOME/.ssh directory` to `$HOME/.sourcegraph/config/ssh` directory. See [docs](/admin/deploy/docker-single-container/#ssh-authentication-config-keys-knownhosts) for more information about our ssh file system. 1. Read our [guide here](/admin/deploy/docker-compose/#git-ssh-configuration) for Docker Compose deployments - 1. Read our [guide here](/admin/deploy/kubernetes/configure#ssh-for-cloning) for Kubernetes 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/azuredevops.mdx b/docs/admin/code_hosts/azuredevops.mdx index 4814bc24d..a48386446 100644 --- a/docs/admin/code_hosts/azuredevops.mdx +++ b/docs/admin/code_hosts/azuredevops.mdx @@ -165,7 +165,7 @@ Azure DevOps connections support the following configuration options, which are ## Webhooks -Please consult [this page](/admin/config/webhooks/incoming) in order to configure webhooks. +Please consult [this page](/admin/webhooks/incoming) in order to configure webhooks. ## Permissions syncing diff --git a/docs/admin/code_hosts/bitbucket_cloud.mdx b/docs/admin/code_hosts/bitbucket_cloud.mdx index 8a842ff89..5cbd0f8d1 100644 --- a/docs/admin/code_hosts/bitbucket_cloud.mdx +++ b/docs/admin/code_hosts/bitbucket_cloud.mdx @@ -232,4 +232,4 @@ Bitbucket Cloud connections support the following configuration options, which a Using the `webhooks` property on the external service has been deprecated. -Please consult [this page](/admin/config/webhooks/incoming) in order to configure webhooks. +Please consult [this page](/admin/webhooks/incoming) in order to configure webhooks. diff --git a/docs/admin/code_hosts/bitbucket_server.mdx b/docs/admin/code_hosts/bitbucket_server.mdx index 75536898e..b0e61ea25 100644 --- a/docs/admin/code_hosts/bitbucket_server.mdx +++ b/docs/admin/code_hosts/bitbucket_server.mdx @@ -43,7 +43,7 @@ There are four fields for configuring which repositories are mirrored: Using the `webhooks` property on the external service has been deprecated. -Please consult [this page](/admin/config/webhooks/incoming) in order to configure webhooks. +Please consult [this page](/admin/webhooks/incoming) in order to configure webhooks. ## Repository permissions diff --git a/docs/admin/code_hosts/github.mdx b/docs/admin/code_hosts/github.mdx index d65d28d5a..8931ac184 100644 --- a/docs/admin/code_hosts/github.mdx +++ b/docs/admin/code_hosts/github.mdx @@ -97,7 +97,7 @@ When creating a code host connection for a GitHub App with multiple installation 3. (Optional) If you want to sync repositories from other organization or user namespaces and your GitHub App is set to public visibility, you can create additional installations with **Add installation**. -> NOTE: When you create a GitHub App, Sourcegraph automatically sets up an [incoming webhook](/admin/config/webhooks/incoming) for the app. This webhook subscribes to events for any repository or organization the app has access to, allowing Sourcegraph to keep repository and permission data in sync with GitHub. +> NOTE: When you create a GitHub App, Sourcegraph automatically sets up an [incoming webhook](/admin/webhooks/incoming) for the app. This webhook subscribes to events for any repository or organization the app has access to, allowing Sourcegraph to keep repository and permission data in sync with GitHub. > NOTE: If you are using [Batch Changes](/batch-changes/), you can create a GitHub App to perform [commit signing](/admin/config/batch_changes#commit-signing-for-github) (Beta). @@ -361,7 +361,7 @@ Repo-centric permission syncing is done by calling the [list repository collabor > IMPORTANT: We strongly recommend configuring both read and write access to associated repositories for permission syncing due to GitHub's token scope requirements. Without write access, there will be a conflict between [user-centric sync](/admin/permissions/syncing#troubleshooting) and repo-centric sync. In that case, [disable repo-centric permission sync](/admin/permissions/syncing#disable-repo-centric-permission-sync) (supported in Sourcegraph 5.0.4+). -> IMPORTANT: Optional, but strongly recommended - [continue with configuring webhooks for permissions](/admin/config/webhooks/incoming#user-permissions). +> IMPORTANT: Optional, but strongly recommended - [continue with configuring webhooks for permissions](/admin/webhooks/incoming#user-permissions). @@ -395,13 +395,13 @@ If you would like internal repositories to remain private, but you're experienci ### Trigger permissions sync from GitHub webhooks -Follow the link to [configure webhooks for permissions for Github](/admin/config/webhooks/incoming#user-permissions) +Follow the link to [configure webhooks for permissions for Github](/admin/webhooks/incoming#user-permissions) ### Teams and organizations permissions caching > NOTE: This is an experimental feature. -> WARNING: The following section is experimental and might not work properly anymore on new Sourcegraph versions (post 4.0+). Please prefer [configuring webhooks for permissions instead](/admin/config/webhooks/incoming#user-permissions) +> WARNING: The following section is experimental and might not work properly anymore on new Sourcegraph versions (post 4.0+). Please prefer [configuring webhooks for permissions instead](/admin/webhooks/incoming#user-permissions) Github code host can leverage caching mechanisms to reduce the number of API calls used when syncing permissions. This can significantly reduce the amount of time it takes to perform a full cycle of permissions sync due to reduced instances of being rate limited by the code host, and is useful for code hosts with very large numbers of users and repositories. @@ -469,7 +469,7 @@ To configure GitHub as an authentication provider (which will enable sign-in via Using the `webhooks` property on the external service has been deprecated. -Please consult [this page](/admin/config/webhooks/incoming) in order to configure webhooks. +Please consult [this page](/admin/webhooks/incoming) in order to configure webhooks. ## Configuration diff --git a/docs/admin/code_hosts/gitlab.mdx b/docs/admin/code_hosts/gitlab.mdx index 0ace33f50..a5e6b0c0d 100644 --- a/docs/admin/code_hosts/gitlab.mdx +++ b/docs/admin/code_hosts/gitlab.mdx @@ -332,7 +332,7 @@ See [Internal rate limits](/admin/code_hosts/rate_limits#internal-rate-limits). ## Native integration -To provide out-of-the-box code navigation features to your users on GitLab, you will need to [configure your GitLab instance](https://docs.gitlab.com/ee/integration/sourcegraph.html). If you are using an HTTPS connection to GitLab, you will need to [configure HTTPS](/admin/http_https_configuration) for your Sourcegraph instance. +To provide out-of-the-box code navigation features to your users on GitLab, you will need to [configure your GitLab instance](https://docs.gitlab.com/ee/integration/sourcegraph.html). If you are using an HTTPS connection to GitLab, you will need to [configure HTTPS](/self-hosted/http_https_configuration) for your Sourcegraph instance. The Sourcegraph instance's site admin must [update the `corsOrigin` site config property](/admin/config/site_config) to allow the GitLab instance to communicate with the Sourcegraph instance. For example: @@ -363,4 +363,4 @@ We are actively collaborating with GitLab to improve our integration (e.g. the [ Using the `webhooks` property on the external service has been deprecated. -Please consult [this page](/admin/config/webhooks/incoming) in order to configure webhooks. +Please consult [this page](/admin/webhooks/incoming) in order to configure webhooks. diff --git a/docs/admin/code_hosts/non-git.mdx b/docs/admin/code_hosts/non-git.mdx index 4657b5c86..c94428627 100644 --- a/docs/admin/code_hosts/non-git.mdx +++ b/docs/admin/code_hosts/non-git.mdx @@ -72,7 +72,7 @@ While this syncing functionality means that the original change history will be ## Quickstart -1. Start up a Sourcegraph instance or our [full installation documentation](/admin/deploy/). +1. Start up a Sourcegraph instance or our [full installation documentation](/self-hosted/deploy/). 1. [Install `src-expose`](#installing-src-expose) diff --git a/docs/admin/code_hosts/rate_limits.mdx b/docs/admin/code_hosts/rate_limits.mdx index 7152b824d..810189f84 100644 --- a/docs/admin/code_hosts/rate_limits.mdx +++ b/docs/admin/code_hosts/rate_limits.mdx @@ -50,7 +50,7 @@ To configure internal rate limits for a specific code host connection: Requests to the configured code host will be staggered as to not exceed `"requestsPerHour"`. This will override the default rate limit (if configured). -> NOTE: Configuring a rate limit will impact Sourcegraph's ability to stay up to date with repository changes and user permissions. To ensure that Sourcegraph stays up to date, consider configuring [webhooks](/admin/config/webhooks/incoming). +> NOTE: Configuring a rate limit will impact Sourcegraph's ability to stay up to date with repository changes and user permissions. To ensure that Sourcegraph stays up to date, consider configuring [webhooks](/admin/webhooks/incoming). - For Sourcegraph `<=3.38`, if rate limiting is configured more than once for the same code host instance, the most restrictive limit will be used. - For Sourcegraph >=3.39, rate limiting should be enabled and configured for each individual code host connection. diff --git a/docs/admin/config/batch_changes.mdx b/docs/admin/config/batch_changes.mdx index cdfa621e5..f533c5de3 100644 --- a/docs/admin/config/batch_changes.mdx +++ b/docs/admin/config/batch_changes.mdx @@ -129,7 +129,7 @@ To only allow changesets to be reconciled at 1 changeset per minute on (UTC) wee ## Incoming webhooks -Sourcegraph can track incoming webhooks from code hosts to more easily debug issues with webhook delivery. Learn [how to setup webhooks and configure logging](/admin/config/webhooks/incoming#webhook-logging). +Sourcegraph can track incoming webhooks from code hosts to more easily debug issues with webhook delivery. Learn [how to setup webhooks and configure logging](/admin/webhooks/incoming#webhook-logging). ## Forks diff --git a/docs/admin/config/index.mdx b/docs/admin/config/index.mdx index b337fc870..cadab3141 100644 --- a/docs/admin/config/index.mdx +++ b/docs/admin/config/index.mdx @@ -1,15 +1,10 @@ # Configuring Sourcegraph - - Supported on [Enterprise](/pricing/enterprise) plans. - Available via the Web app. - - -This page documents how to configure a Sourcegraph instance. For deployment configuration, please refer to the [relevant deployment docs for your deployment type](/admin/deploy/#deployment-types). +Supported on [Enterprise](/pricing/enterprise) plans. - [Site configuration](/admin/config/site_config) - [Global and user settings](/admin/config/settings) -- [Code host configuration](/admin/code_hosts/) (GitHub, GitLab, and the [Nginx HTTP server](/admin/http_https_configuration).) +- [Code host configuration](/admin/code_hosts/) - [Search configuration](/admin/search) - [Configuring Authorization and Authentication](/admin/config/authorization_and_authentication) - [Batch Changes configuration](/admin/config/batch_changes) @@ -22,20 +17,6 @@ This page documents how to configure a Sourcegraph instance. For deployment conf - [Integrate with Phabricator](/integration/phabricator) - [Add organizations](/admin/organizations) - [Add teams](/admin/teams) (Experimental) -- [Set up HTTPS](/admin/http_https_configuration) -- [Use a custom domain](/admin/url) -- [Configure email sending / SMTP server](/admin/config/email) -- [Update Sourcegraph](/admin/updates/) -- [Using external services (PostgreSQL, Redis, S3/GCS)](/admin/external_services) -- [PostgreSQL Config](/admin/config/postgres-conf) -- [Configuring webhooks](/admin/config/webhooks/) +- [Configuring webhooks](/admin/webhooks/) - [Configuring rate limits](/admin/code_hosts/rate_limits) - [Configuring command recording](/admin/repo/recording) - -## Advanced tasks - -- [Loading configuration via the file system](/admin/config/advanced_config_file) -- [Restore postgres database from snapshot](/admin/config/restore/) -- [Enabling database encryption for sensitive data](/admin/config/encryption) -- [Configuring Sourcegraph in private networks](/admin/config/private-network) -- [Restricting outgoing connections](/admin/config/network-filtering) diff --git a/docs/admin/config/site_config.mdx b/docs/admin/config/site_config.mdx index 86867836d..fc41233ae 100644 --- a/docs/admin/config/site_config.mdx +++ b/docs/admin/config/site_config.mdx @@ -1175,8 +1175,8 @@ If you are having trouble accessing the web UI, you can make edits to your site Set `FRONTEND_CONTAINER` to: -- [Docker Compose](/admin/deploy/docker-compose/): the `sourcegraph-frontend` container -- [Single-container](/admin/deploy/docker-single-container/): the `sourcegraph/server` container +- [Docker Compose](/self-hosted/deploy/docker-compose/): the `sourcegraph-frontend` container +- [Single-container](/self-hosted/deploy/docker-single-container/): the `sourcegraph/server` container ```sh docker exec -it --user=root $FRONTEND_CONTAINER sh -c 'apk add --no-cache && nano /home/sourcegraph/site-config.json' @@ -1190,7 +1190,7 @@ docker exec -it $FRONTEND_CONTAINER sh -c 'vi ~/site-config.json' ### Sourcegraph with Kubernetes -For [Kubernetes](/admin/deploy/kubernetes/) deployments: +For [Kubernetes](/self-hosted/deploy/kubernetes/) deployments: ```sh kubectl exec -it $FRONTEND_POD -- sh -c 'apk add --no-cache nano && nano ~/site-config.json' diff --git a/docs/admin/config/webhooks/index.mdx b/docs/admin/config/webhooks/index.mdx deleted file mode 100644 index af4ef5f4c..000000000 --- a/docs/admin/config/webhooks/index.mdx +++ /dev/null @@ -1,4 +0,0 @@ -# Webhooks - -- [Incoming webhooks](/admin/config/webhooks/incoming) -- [Outgoing webhooks](/admin/config/webhooks/outgoing) diff --git a/docs/enterprise-portal/index.mdx b/docs/admin/enterprise-portal.mdx similarity index 100% rename from docs/enterprise-portal/index.mdx rename to docs/admin/enterprise-portal.mdx diff --git a/docs/admin/enterprise_getting_started_guide/index.mdx b/docs/admin/enterprise_getting_started_guide.mdx similarity index 79% rename from docs/admin/enterprise_getting_started_guide/index.mdx rename to docs/admin/enterprise_getting_started_guide.mdx index dad731c51..17ef74301 100644 --- a/docs/admin/enterprise_getting_started_guide/index.mdx +++ b/docs/admin/enterprise_getting_started_guide.mdx @@ -6,8 +6,8 @@ If you're deploying a new Enterprise instance, this page covers our most frequen ### General -- [Deployment overview](/admin/deploy/) -- [Resource estimator](/admin/deploy/resource_estimator) +- [Deployment overview](/self-hosted/deploy/) +- [Resource estimator](/self-hosted/deploy/resource_estimator) - [SAML config](/admin/auth/saml/) - [Configuring authorization and authentication](/admin/config/authorization_and_authentication) - We recommend starting here for access and permissions configuration before moving on to the more specific pages on these topics. - [Built-in password authentication](/admin/auth/#builtin-password-authentication) @@ -23,10 +23,10 @@ If you're deploying a new Enterprise instance, this page covers our most frequen ### Docker-compose -- [Basic installation guide](/admin/deploy/docker-compose/) -- [AWS installation](/admin/deploy/docker-compose/aws) -- [Digital Ocean installation](/admin/deploy/docker-compose/digitalocean) -- [Google Cloud installlation](/admin/deploy/docker-compose/google_cloud) +- [Basic installation guide](/self-hosted/deploy/docker-compose/) +- [AWS installation](/self-hosted/deploy/docker-compose/aws) +- [Digital Ocean installation](/self-hosted/deploy/docker-compose/digitalocean) +- [Google Cloud installation](/self-hosted/deploy/docker-compose/google_cloud) ## User articles diff --git a/docs/admin/executors/executor_secrets.mdx b/docs/admin/executors/executor_secrets.mdx index 9deaa503c..17a3cee1d 100644 --- a/docs/admin/executors/executor_secrets.mdx +++ b/docs/admin/executors/executor_secrets.mdx @@ -6,7 +6,7 @@ Secret values are currently only available in server-side batch changes. Use [`s ## How secrets work -Executor secrets are defined per-feature. If you want to define a secret for server-side batch changes, create a secret for that namespace (examples of namespaces are "Code Graph" and "Batch Changes"). Secrets are [encrypted](/admin/config/encryption) if encryption is on, and always redacted in log outputs. +Executor secrets are defined per-feature. If you want to define a secret for server-side batch changes, create a secret for that namespace (examples of namespaces are "Code Graph" and "Batch Changes"). Secrets are [encrypted](/self-hosted/encryption) if encryption is on, and always redacted in log outputs. There are two types of secrets: diff --git a/docs/admin/executors/index.mdx b/docs/admin/executors/index.mdx index 5f4032705..cc8708261 100644 --- a/docs/admin/executors/index.mdx +++ b/docs/admin/executors/index.mdx @@ -5,15 +5,11 @@ Available via the Web app. -Executors are Sourcegraph's solution for running untrusted code in a secure and controllable way. Executors provide a sandbox that can run resource-intensive or untrusted tasks on behalf of the Sourcegraph instance, such as: +Executors are Sourcegraph's solution for isolating and running workloads in a secure and controllable way. Executors provide a sandbox that can run resource-intensive or untrusted tasks on behalf of the Sourcegraph instance, such as: - [Automatically indexing a repository for precise code navigation](/code-navigation/auto_indexing) - [Running batch changes](/batch-changes/server-side) -## Installation - -To deploy executors for your Sourcegraph instance, follow our [executor deployment guide](executors/deploy_executors). - ## Why use executors? Running untrusted code is a core requirement of features such as precise code navigation [auto-indexing](/code-navigation/auto_indexing), and [running batch changes server-side](/batch-changes/server-side). @@ -41,149 +37,3 @@ Deciding how to deploy the executor depends on your use case. For users that wis ## How it works Executor instances are capable of being deployed in a variety of ways. Each runtime varies in how jobs are executed. - -### Locally with src-cli - -Executors architecture - local with src-cli - -1. User runs the `src` (e.g. `src batch`) command from the command line. -2. `src` calls the Sourcegraph API to clone a repository. - 1. The repositories are written to a directory. -3. A Docker Container is created for each "step." - 1. The directory containing the repository is mounted to the container. - 2. "Steps" are ran in sequential order. -4. The container run a defined command against the repository. -5. Logs from the container are sent back to `src`. -6. At the end of processing all repositories, the result is sent to a Sourcegraph API. - 1. e.g. Batch Changes sends a `git diff` to a Sourcegraph API (and invokes other APIs). - -### Binary - -Executors architecture - binary - -1. The executor binary is installed to a machine. - 1. Additional executables (e.g. Docker, `src`) are installed as well -2. The executor instances pulls for available Jobs from a Sourcegraph API -3. A user initiates a process that creates executor Jobs. -4. The executor instance "dequeues" a Job. -5. Executor calls the Sourcegraph API to clone a repository. - 1. The repositories are written to a directory. -6. A Docker Container is created for each "step." - 1. If the Job is `batches` (non-native execution), `src` is invoked - 2. Docker is invoked directly for other Jobs (`codeintel` and native execution `batches`) - 3. The directory containing the repository is mounted to the container. - 4. "Steps" are ran in sequential order. -7. The container run a defined command against the repository. -8. Logs from the container are sent back to the executor. -9. Logs are streamed from the executor to a Sourcegraph API -10. The executor calls a Sourcegraph API to that "complete" the Job. - -### Firecracker - -> NOTE: [What the heck is firecracker, anyway](/admin/executors/firecracker)?? - -Executors architecture - firecracker - -1. The executor binary is installed to a machine. - 1. Additional executables (e.g. Docker, `src`) are installed as well -2. The executor instances pulls for available Jobs from a Sourcegraph API -3. A user initiates a process that creates executor Jobs. -4. The executor instance "dequeues" a Job. -5. Executor calls the Sourcegraph API to clone a repository. - 1. The repositories are written to a directory. -6. `ignite` starts up a Docker container that spawns a single Firecracker VM within the Docker container. - 1. The directory containing the repository is mounted to the VM. -7. Docker Container is created in the Firecracker VM for each "step." - 1. If the Job is `batches` (non-native execution), `src` is invoked - 2. Docker is invoked directly for other Jobs (`codeintel` and native execution `batches`) - 3. "Steps" are ran in sequential order. -8. Within each Firecracker VM a single Docker container is created -9. The container run a defined command against the repository. -10. Logs from the container are sent back to the executor. -11. Logs are streamed from the executor to a Sourcegraph API -12. The executor calls a Sourcegraph API to that "complete" the Job. - -### Docker - -Executors architecture - docker - -1. The executor image is started as a Docker container on a machine -2. The executor pulls for available Jobs from a Sourcegraph API -3. A user initiates a process that creates executor Jobs. -4. The executor instance "dequeues" a Job. -5. Executor calls the Sourcegraph API to clone a repository. - 1. The repositories are written to a directory. -6. A Docker Container is created for each "step." - 1. If the Job is `batches` (non-native execution), `src` is invoked - 2. Docker is invoked directly for other Jobs (`codeintel` and native execution `batches`) - 3. The directory containing the repository is mounted to the container. - 4. "Steps" are ran in sequential order. -7. The container run a defined command against the repository. -8. Logs from the container are sent back to the executor. -9. Logs are streamed from the executor to a Sourcegraph API -10. The executor calls a Sourcegraph API to that "complete" the Job. - -### Native Kubernetes - -> NOTE: This is an experimental feature. - -Executors architecture - native kubernetes - -1. The executor image is started as a pod in a Kubernetes node -2. The executor pulls for available Jobs from a Sourcegraph API -3. A user initiates a process that creates executor Jobs. -4. The executor instance "dequeues" a Job. -5. Executor calls the Sourcegraph API to clone a repository. - 1. The repositories are written to a directory. -6. A Kubernetes Job is created for each "step." - 1. The directory containing the repository is mounted to the container. - 2. "Steps" are ran in sequential order. -7. The container run a defined command against the repository. -8. Logs from the container are sent back to the executor. -9. Logs are streamed from the executor to a Sourcegraph API -10. The executor calls a Sourcegraph API to that "complete" the Job. - -### Docker-in-Docker Kubernetes - -> NOTE: This is an experimental feature. - -Executors architecture - docker in docker kubernetes - -1. The executor image is started as a container in Kubernetes Pod - 1. The dind image is started as a sidecar container in the same Kubernetes Pod -2. The executor pulls for available Jobs from a Sourcegraph API -3. A user initiates a process that creates executor Jobs. -4. The executor instance "dequeues" a Job. -5. Executor calls the Sourcegraph API to clone a repository. - 1. The repositories are written to a directory. -6. A Docker Container is created for each "step." - 1. If the Job is `batches` (non-native execution), `src` is invoked - 2. Docker is invoked directly for other Jobs (`codeintel` and native execution `batches`) - 3. The directory containing the repository is mounted to the container. - 4. "Steps" are ran in sequential order. -7. The container run a defined command against the repository. -8. Logs from the container are sent back to the executor. -9. Logs are streamed from the executor to a Sourcegraph API -10. The executor calls a Sourcegraph API to that "complete" the Job. - -## Troubleshooting - -Refer to the [Troubleshooting Executors](/admin/executors/executors_troubleshooting) document for common debugging operations. diff --git a/docs/admin/faq.mdx b/docs/admin/faq.mdx index 9f13826cb..5e77e2eec 100644 --- a/docs/admin/faq.mdx +++ b/docs/admin/faq.mdx @@ -1,9 +1,5 @@ # Administration FAQ -## How does Sourcegraph store repositories on disk? - -Sourcegraph stores bare Git repositories (without a working tree), which is a complete mirror of the repository on your code host. - ## Does Sourcegraph support SVN? For Subversion and other non-Git code hosts, the recommended way to make these accessible in @@ -24,107 +20,6 @@ can update the configuration if they have direct `docker exec` or `kubectl exec` Sourcegraph instance. Follow the [instructions to update the site config if the web UI is inaccessible](/admin/config/site_config#editing-your-site-configuration-if-you-cannot-access-the-web-ui). -## How do I set up redirect URLs in Sourcegraph? - -Sometimes URLs in Sourcegraph may change. For example, if a code host configuration is -updated to use a different `repositoryPathPattern`, this will change the repository URLs on -Sourcegraph. Users may wish to preserve links to the old URLs, and this requires adding redirects. - -We recommend configuring redirects in a reverse proxy. If you are running Sourcegraph as a single -Docker image, you can deploy a reverse proxy such as [Caddy](https://caddyserver.com/) or -[NGINX](https://www.nginx.com) in front of it. Refer to the -[Caddy](https://github.com/caddyserver/caddy/wiki/v2:-Documentation#rewrite) or -[NGINX](https://www.nginx.com/blog/creating-nginx-rewrite-rules/) documentation for URL rewrites. - -If you are running Sourcegraph as a Kubernetes cluster, you have two additional options: - -1. If you are using NGINX ingress (`kubectl get ingress | grep sourcegraph-frontend`), modify - [`sourcegraph-frontend.Ingress.yaml`](https://github.com/sourcegraph/deploy-sourcegraph-k8s/blob/main/base/sourcegraph/frontend/sourcegraph-frontend.Ingress.yaml) - by [adding a rewrite rule](https://kubernetes.github.io/ingress-nginx/examples/rewrite/). You can also refer to the [ingress configuration examples](https://github.com/sourcegraph/deploy-sourcegraph-k8s/tree/main/examples/ingress-controller). - -## What external HTTP checks are configured? - -We leave the choice of which external HTTP check monitor up to our users. What we provide out-of-the-box is extensive metrics monitoring through Prometheus and Grafana, with builtin alert thresholds and dashboards, and Kubernetes/Docker HTTP health checks which verify that the server is running. Sourcegraph's frontend has a default health check at -https://$SOURCEGRAPH_BASE_URL/healthz. Some users choose to set up their own external HTTP health checker which tests if the homepage loads, a repository page loads, and if a search GraphQL request returns successfully. - -## Monitoring - -Please visit our [Observability Docs](/admin/observability) for more in-depth information about observability in Sourcegraph. - -### What should I look at when my instance is having performance issues? - -Sourcegraph comes with built-in monitoring in the form of [Grafana](/admin/observability/metrics#grafana), connected to [Prometheus](/admin/observability/metrics#prometheus) for metrics and alerting. - -Generally, Grafana should be the first stop you make when experiencing a system performance issue. From there you can look for system alerts or metrics that would provide you with more insights on what’s causing the performance issue. You can learn more about [accessing Grafana here](/admin/observability/metrics#grafana). - -### What are the key values/alerts to look for when looking at the Grafana Dashboard? - -Please refer to the [Dashboards](/admin/observability/metrics#dashboards) guide for more on how to use our Grafana dashboards. - -Please refer to [Understanding alerts](/admin/observability/alerting#understanding-alerts) for examples and suggested actions for alerts. - -### How do I know when more resources are needed for a specified service? - -All resource dashboards contain a section called `Provisioning indicators` that provide information about the current resource usage of containers. These can be used to determine if a scale-up is needed ([example panel](/admin/observability/dashboards#frontend-provisioning-container-cpu-usage-long-term)). - -More information on each available panel in the dashboards is available in the [Dashboards reference](/admin/observability/dashboards). - -### What does this `` mean? - -See [Alert solutions](/admin/observability/alerts) to learn about each alert and their possible solutions. - -### What’s the threshold for each resource? - -All resources dashboards contain a section called `Container monitoring` that indicate thresholds at which alerts will fire for each resource ([example alert](/admin/observability/alerts#frontend-container-cpu-usage)). - -More information on each available panel in the dashboards is available in the [Dashboards reference](/admin/observability/dashboards). - -### How much resources should I add after receiving alerts about running out of resources? - -You should make the decision based on the metrics from the relevant Grafana dashboard linked in each alert. - -### What are some of the important alerts that I should be aware of? - -We recommend paying closer attention to [critical alerts](/admin/observability/alerting#understanding-alerts). - -### How do I set up alerts? - -Please refer to our guide on [setting up alerting](/admin/observability/alerting#setting-up-alerting). - -### How do I create a custom alert? - -Creating a custom alert is not recommended and currently not supported by Sourcegraph. However, please provide feedback on the monitoring dashboards and alerts if you find anything could be improved via our issue tracker. - -More advanced users can also refer to [our FAQ item about custom consumption of Sourcegraph metrics](#can-i-consume-sourcegraph-s-metrics-in-my-own-monitoring-system-datadog-new-relic-etc). - -### Can I consume Sourcegraph's metrics in my own monitoring system (Datadog, New Relic, etc.)? - -Sourcegraph provides [high-level alerting metrics](/admin/observability/metrics#high-level-alerting-metrics) which you can integrate into your own monitoring system—see the [alerting custom consumption guide](/admin/observability/alerting_custom_consumption) for more details. - -While it is technically possible to consume all of Sourcegraph's metrics in an external system, our recommendation is to utilize the builtin monitoring tools and configure Sourcegraph to [send alerts to your own PagerDuty, Slack, email, etc.](/admin/observability/alerting). Metrics and thresholds can change with each release, therefore manually defining the alerts required to monitor Sourcegraph's health is not recommended. Sourcegraph automatically updates the dashboards and alerts on each release to ensure the displayed information is up-to-date. - -Other monitoring systems that support Prometheus scraping (for example, Datadog and New Relic) or [Prometheus federation](https://prometheus.io/docs/prometheus/latest/federation/) can be configured to federate Sourcegraph's [high-level alerting metrics](/admin/observability/metrics#high-level-alerting-metrics). For information on how to configure those systems, please check your provider's documentation. - -The `/-/debug/grafana` endpoint is specifically designed for the built-in Grafana instance that comes with Sourcegraph. When using an external Grafana instance, this endpoint won't automatically redirect to your custom Grafana URL. - -To properly integrate your external Grafana and Prometheus instances with Sourcegraph, you'll want to: -Ensure your configuration in values.yaml is correct: - -``` -frontend: - env: - GRAFANA_SERVER_URL: - value: https://grafana.mycompany.com - PROMETHEUS_URL: - value: http://prometheus.mycompany.com -``` - -You can then access your dashboards directly through your Grafana instance URL. - -### I am getting "Error: Cluster information not available" in the Instrumentation page, what should I do? - -This error is expected if your instance was not [deployed with Kubernetes](/admin/deploy/kubernetes/). The Instrumentation page is currently only available for Kubernetes instances. - ## Sourcegraph is making unauthorized requests to the git server This is normal and happens whenever git is used over HTTP. To avoid unnecessarily sending a password over HTTP, git first diff --git a/docs/admin/how-to/index.mdx b/docs/admin/how-to/index.mdx index 79a5f4764..4ee32f3a3 100644 --- a/docs/admin/how-to/index.mdx +++ b/docs/admin/how-to/index.mdx @@ -1,31 +1,14 @@ # How-to guides -- [How to manually execute database migrations with `migrator`](/admin/updates/migrator/migrator-operations) - - Commands: [up](/admin/updates/migrator/migrator-operations#up), [upto](/admin/updates/migrator/migrator-operations#upto), [downto](/admin/updates/migrator/migrator-operations#downto), [validate](/admin/updates/migrator/migrator-operations#validate), [add-log](/admin/updates/migrator/migrator-operations#add-log) - - Environments: [Kubernetes](/admin/updates/migrator/migrator-operations#kubernetes), [Docker compose](/admin/updates/migrator/migrator-operations#docker--docker-compose), [Local development](/admin/updates/migrator/migrator-operations#local-development) -- [How to troubleshoot a dirty database](/admin/how-to/dirty_database) -- [How to rollback the Postgres database](/admin/how-to/rollback_database) -- [How to apply privileged migrations](/admin/how-to/privileged_migrations) -- [How to troubleshoot an unfinished migration](/admin/how-to/unfinished_migration) - [How to enable or disable an experimental feature](/admin/how-to/enable-experimental-feature) - [How to diagnose an `Unknown Error` during login to your Sourcegraph instance](/admin/how-to/unknown-error-login) - [How to convert version contexts to search contexts](/admin/how-to/converting-version-contexts-to-search-contexts) -- [How to troubleshoot pod evictions](/admin/how-to/troubleshoot-pod-eviction) -- [How to monitor your Sourcegraph instance](/admin/how-to/monitoring-guide) - [How to troubleshoot a repository that is not being updated](/admin/how-to/repo-not-updated) - [How to configure submodules](/admin/how-to/submodule-configuration) - [How to remove users or edit users with the GraphQL API](/admin/how-to/mutate-user-api) -- [How to setup HTTPS connection with Ingress controller on your Kubernetes instance](/admin/how-to/setup-https) -- [How to rebuild corrupt Postgres indexes after upgrading to 3.30 or 3.30.1](/admin/how-to/rebuild-corrupt-postgres-indexes) -- [How to determine cause for Precise-code-intel-worker in CrashLoopBackOff status](/admin/how-to/precise-code-intel-worker-crashloopbackoff) - [How to troubleshoot a failure to update repositories when new repositories are added](/admin/how-to/update_repo_failure) -- [How to run postgres queries in your Sourcegraph instance](/admin/how-to/run-psql) - [How to purge deleted repository data from Sourcegraph](/admin/how-to/remove-repo#manually-purge-deleted-repository-data-from-disk) - [How to address common monorepo problems](/admin/how-to/monorepo-issues) -- [How to Set a password for Redis using a ConfigMap](/admin/how-to/redis_configmap) - [How to import a set of internal repositories to Sourcegraph](/admin/how-to/internal_github_repos) -- [How to identify and resolve index corruption in postgres 14](/admin/how-to/postgres14-index-corruption) - [Migrating code intelligence data from LSIF to SCIP (Sourcegraph 4.5 -> 4.6)](/admin/how-to/lsif_scip_migration) - [How to export search results](/admin/how-to/export-search-results) -- [How to debug / confirm blobstore is healthy](/admin/how-to/blobstore_debugging) -- [How to handle postgresql 12 to 16 drift](/admin/how-to/postgresql-12-to-16-drift) diff --git a/docs/admin/how-to/lsif_scip_migration.mdx b/docs/admin/how-to/lsif_scip_migration.mdx index c494fb0e2..bb98e6418 100644 --- a/docs/admin/how-to/lsif_scip_migration.mdx +++ b/docs/admin/how-to/lsif_scip_migration.mdx @@ -2,12 +2,12 @@ > WARNING: The migration from LSIF -> SCIP is **destructive and irreversible**. A downgrade from 4.6 to a previous version will result in the inability to access migrated code intelligence data (powering precise code navigation features). -Sourcegraph 4.5 introduced an [out-of-band migration](/admin/how-to/unfinished_migration#checking-progress) that re-encodes LSIF code intelligence data as SCIP in the `codeintel-db`. This migration is required to complete prior to a subsequent upgrade to 4.6, as support for reading LSIF-encoded data has been removed as of this version. +Sourcegraph 4.5 introduced an [out-of-band migration](/self-hosted/how-to/unfinished_migration#checking-progress) that re-encodes LSIF code intelligence data as SCIP in the `codeintel-db`. This migration is required to complete prior to a subsequent upgrade to 4.6, as support for reading LSIF-encoded data has been removed as of this version. As of [src-cli 4.5](https://github.com/sourcegraph/src-cli/releases/tag/4.5.0), LSIF indexes will be converted to SCIP prior to upload. This ensures that only _existing_ data needs to be migrated in the background. Using an older version of src-cli to upload code intelligence to your index may continue to feed additional LSIF data that needs to be subsequently migrated. This will ultimately block the ability to upgrade to the next version as the migration will never reach 100% (and remain there). -Once the migration has completed, Postgres may continue to hold on to disk space that was previously occupied by LSIF data. Future versions of Sourcegraph will drop these tables completely, freeing this space. Heavier users of precise code intelligence may wish to reclaim this disk space earlier. Once the migration is complete, you can [truncate the LSIF data tables](/admin/how-to/clear_codeintel_data#clearing-lsif-data) to immediately reclaim this space. +Once the migration has completed, Postgres may continue to hold on to disk space that was previously occupied by LSIF data. Future versions of Sourcegraph will drop these tables completely, freeing this space. Heavier users of precise code intelligence may wish to reclaim this disk space earlier. Once the migration is complete, you can [truncate the LSIF data tables](/self-hosted/how-to/clear_codeintel_data#clearing-lsif-data) to immediately reclaim this space. --- -If you wish to take the scorched earth route and clear all existing code intelligence data from your instance and start fresh, follow the entire guide on [clearing code intelligence data](/admin/how-to/clear_codeintel_data). +If you wish to take the scorched earth route and clear all existing code intelligence data from your instance and start fresh, follow the entire guide on [clearing code intelligence data](/self-hosted/how-to/clear_codeintel_data). diff --git a/docs/admin/how-to/monitoring-guide.mdx b/docs/admin/how-to/monitoring-guide.mdx deleted file mode 100644 index 3b0fb65bf..000000000 --- a/docs/admin/how-to/monitoring-guide.mdx +++ /dev/null @@ -1,18 +0,0 @@ -# Monitoring Guide - -Please visit our [Observability Docs](/admin/observability) for more in-depth information about observability in Sourcegraph. - -## Prerequisites - -This document assumes that you are a [site admin](/admin/). - -## Set up monitoring - -1. Familiarize yourself with [Sourcegraph's monitoring dashboards and metrics](/admin/observability/metrics). - 1. Also see our [full dashboards reference](/admin/observability/dashboards). -2. [Set up alerting](/admin/observability/alerting#setting-up-alerting) and [learn about how to respond to alerts](/admin/observability/alerting#understanding-alerts). - 1. Also see our [full alert solutions reference](/admin/observability/alerts). - -## FAQs - -See the [monitoring section of our FAQ](/admin/faq#monitoring). diff --git a/docs/admin/how-to/monorepo-issues.mdx b/docs/admin/how-to/monorepo-issues.mdx index fa94be771..20362b531 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](/admin/deploy/docker-compose/#operations) and [kubernetes](/admin/deploy/kubernetes/operations)_ +_Learn more about managing resources in [docker-compose](/admin/deploy/docker-compose/#operations) and [kubernetes](/self-hosted/deploy/kubernetes/operations)_ ## Slow hover tooltip results @@ -57,7 +57,7 @@ Selecting the Show History button while viewing a file initiates a request to [f ## Common alerts -The following alerts are common to instances underprovisioned in relation to their monorepos, [learn more about alerts](/admin/observability/alerts): +The following alerts are common to instances underprovisioned in relation to their monorepos, [learn more about alerts](/self-hosted/observability/alerts): - frontend: 20s+ 99th percentile code-intel successful search request duration over 5m - frontend: 15s+ 90th percentile code-intel successful search request duration over 5m diff --git a/docs/admin/how-to/repo-not-updated.mdx b/docs/admin/how-to/repo-not-updated.mdx index 33aa9c058..257b14a57 100644 --- a/docs/admin/how-to/repo-not-updated.mdx +++ b/docs/admin/how-to/repo-not-updated.mdx @@ -19,7 +19,7 @@ This document assumes that you are a [site admin](/admin) and **do not** have `d 4. If clicking on the `Refresh Now` button does not work for you, try using webhooks following the instructions detailed in our [Repository Webhooks Docs](/admin/repo/webhooks#webhook-for-manually-telling-sourcegraph-to-update-a-repository) 5. Look for errors related to this repository in gitserver logs, which should help you to determine the next best course of action. 6. Check the size of the repository. If it's a large repository, it may take a long time to sync and update. To find the size of your .git directory where the repository resides, you may use our [`git-stats` script](/admin/monorepo#statistics). -7. Check the allocated resources to see if the instance has enough resources to process the repository sync using our [Resource Estimator](/admin/deploy/resource_estimator) +7. Check the allocated resources to see if the instance has enough resources to process the repository sync using our [Resource Estimator](/self-hosted/deploy/resource_estimator) 8. Check the code host connection from your Sourcegraph instance. If there is any issue, it needs to be resolved for the repository to sync and update. ## FAQs: diff --git a/docs/admin/how-to/site-admin-quickstart.mdx b/docs/admin/how-to/site-admin-quickstart.mdx index 56ea25284..251aeca7b 100644 --- a/docs/admin/how-to/site-admin-quickstart.mdx +++ b/docs/admin/how-to/site-admin-quickstart.mdx @@ -10,15 +10,15 @@ This guide will walk you through the features and functionalities available to y We recommend Docker Compose for most initial production deployments. You can [migrate to a different deployment method](/admin/updates/#migrating-to-a-new-deployment-type) later on if needed. -If you need a deployment option that offers a higher level of scalability and availability, the [Kubernetes deployment](/admin/deploy/kubernetes/) is recommended. +If you need a deployment option that offers a higher level of scalability and availability, the [Kubernetes deployment](/self-hosted/deploy/kubernetes/) is recommended. -To help give you a starting point on choosing a deployment option and allocating resources to it, check out our [resource estimator](/admin/deploy/resource_estimator). +To help give you a starting point on choosing a deployment option and allocating resources to it, check out our [resource estimator](/self-hosted/deploy/resource_estimator). -For a comphrensive deployment guide for each option, check out our in-depth documentation for both [Docker Compose](/admin/deploy/docker-compose/) and [Kubernetes](/admin/deploy/kubernetes/). +For a comphrensive deployment guide for each option, check out our in-depth documentation for both [Docker Compose](/self-hosted/deploy/docker-compose/) and [Kubernetes](/self-hosted/deploy/kubernetes/). ### Deployment options -We support a number of other deployment types which are described in the [Deployment overview](/admin/deploy/). +We support a number of other deployment types which are described in the [Deployment overview](/self-hosted/deploy/). ### Self-hosted vs. Managed instances @@ -30,7 +30,7 @@ New versions of Sourcegraph are released monthly (with patches released in betwe To check the current version of your instance, go to **User menu > Site admin > Updates**. -For more details on updating your instance, please refer to the [update docs](/admin/updates/). +For more details on updating your instance, please refer to the [update docs](/self-hosted/updates/). ## Configuration @@ -72,14 +72,14 @@ For more info, check out our complete [repository permissions documentation.](/a By default, Sourcegraph bundles the services it needs to operate into installations. These services include PostgreSQL, Redis, and blobstore. -Your Sourcegraph instance can also be configured to use existing external services if you wish. For more information on configuring Sourcegraph to use your external services, please reference this [documentation.](/admin/external_services/) +Your Sourcegraph instance can also be configured to use existing external services if you wish. For more information on configuring Sourcegraph to use your external services, please reference this [documentation.](/self-hosted/external_services/) ## Observability -One key component to managing a Sourcegraph instance is having the ability to observe, monitor, and analyze the health of your instance. Sourcegraph ships with [Grafana](https://grafana.com/) for dashboards; [Prometheus](https://prometheus.io/) for metrics and alerting; as well as a [built-in alerting system.](/admin/observability/alerting) +One key component to managing a Sourcegraph instance is having the ability to observe, monitor, and analyze the health of your instance. Sourcegraph ships with [Grafana](https://grafana.com/) for dashboards; [Prometheus](https://prometheus.io/) for metrics and alerting; as well as a [built-in alerting system.](/self-hosted/observability/alerting) ### Viewing instance health and metrics Alerts and metrics can be viewed and monitored in Grafana. To access the Grafana dashboard bundled with your Sourcegraph instance, go to **User menu > Site admin > Monitoring**. -We also have an exhaustive [reference guide](/admin/observability/dashboards) for understanding the available dashboards, and an [alert solutions guide](/admin/observability/alerts) with descriptions and possible solutions for each alert that fires in Grafana. +We also have an exhaustive [reference guide](/self-hosted/observability/dashboards) for understanding the available dashboards, and an [alert solutions guide](/self-hosted/observability/alerts) with descriptions and possible solutions for each alert that fires in Grafana. diff --git a/docs/admin/how-to/unknown-error-login.mdx b/docs/admin/how-to/unknown-error-login.mdx index 4582e688c..7cdbedbc0 100644 --- a/docs/admin/how-to/unknown-error-login.mdx +++ b/docs/admin/how-to/unknown-error-login.mdx @@ -27,7 +27,7 @@ This document will attempt to identify a common reason for an `Unknown Error` wh 2. If you were trying to login with `http` protocol, try again with `https` instead 3. If you are still having issues, you can ask a site-admin to double check the `externalURL` configured in the Site configuration so you have the correct login landing page - - See [Configuring the external URL](/admin/url) + - See [Configuring the external URL](/self-hosted/url) ## Further resources diff --git a/docs/admin/index.mdx b/docs/admin/index.mdx index 6e8f2ba7e..72a9abcf4 100644 --- a/docs/admin/index.mdx +++ b/docs/admin/index.mdx @@ -1,12 +1,22 @@ # Administration - - Supported on [Enterprise](/pricing/enterprise) plans. - Available via the Web app. - +Supported on [Enterprise](/pricing/enterprise) plans. Sourcegraph administration is primarily managed by site administrators, who are responsible for the configuration of Sourcegraph instances for end users. For a comprehensive introduction to site administration, refer to our [quickstart guide](/admin/how-to/site-admin-quickstart). +## Features + +- [Batch Changes](/batch-changes/) +- [Beta and experimental features](/admin/beta_and_experimental_features) +- [Code navigation](/code-navigation/) +- [Pings](/admin/pings) +- [Telemetry](/admin/telemetry) +- [Enterprise pricing and licenses](/admin/subscriptions/) +- [Search](/admin/search) +- [User feedback surveys](/admin/user_surveys) +- [Analytics](/analytics) +- [Audit logs](/admin/audit_log) + ## [Configure Sourcegraph](/admin/config/) - [Site Administrator Quickstart](/admin/how-to/site-admin-quickstart) @@ -21,16 +31,3 @@ Sourcegraph administration is primarily managed by site administrators, who are - [Repository permissions](/admin/permissions/) - [Batch Changes](/batch-changes/site-admin-configuration) - [Configure webhooks](/admin/config/webhooks/) - -## Features - -- [Batch Changes](/batch-changes/) -- [Beta and experimental features](/admin/beta_and_experimental_features) -- [Code navigation](/code-navigation/) -- [Pings](/admin/pings) -- [Telemetry](/admin/telemetry) -- [Enterprise pricing and licenses](/admin/subscriptions/) -- [Search](/admin/search) -- [User feedback surveys](/admin/user_surveys) -- [Analytics](/analytics) -- [Audit logs](/admin/audit_log) diff --git a/docs/admin/licensing/index.mdx b/docs/admin/licensing.mdx similarity index 100% rename from docs/admin/licensing/index.mdx rename to docs/admin/licensing.mdx diff --git a/docs/admin/migration/index.mdx b/docs/admin/migration/index.mdx index f2315446f..534dec3a3 100644 --- a/docs/admin/migration/index.mdx +++ b/docs/admin/migration/index.mdx @@ -3,5 +3,5 @@ ## Guides - [Migrating from Oracle OpenGrok to Sourcegraph for code search](/admin/migration/opengrok) -- [Back up or migrate to a new Sourcegraph instance](/admin/deploy/migrate-backup) -- [Update notes](/admin/updates/) +- [Back up or migrate to a new Sourcegraph instance](/self-hosted/deploy/migrate-backup) +- [Update notes](/self-hosted/updates/) diff --git a/docs/admin/migration/opengrok.mdx b/docs/admin/migration/opengrok.mdx index ffcd0fa4a..e8fe7894f 100644 --- a/docs/admin/migration/opengrok.mdx +++ b/docs/admin/migration/opengrok.mdx @@ -19,13 +19,13 @@ Sourcegraph is a self-hosted code search and intelligence tool that helps develo - Sourcegraph's [query syntax](/code-search/queries), user interface, and [integrations](/integration/) are superior and easier to use. - Sourcegraph's [code navigation](/code-navigation/), has better language support (hover tooltips, definitions, references, implementations, etc.) and is based on the Language Server Protocol standard. - The [Sourcegraph API](/api/graphql/) is more powerful, better documented, and easier to use than OpenGrok's API. -- Sourcegraph scales to more repositories/users and supports Kubernetes-based clustered/high-availability deployments better (with the [cluster deployment option](/admin/deploy/kubernetes/)). +- Sourcegraph scales to more repositories/users and supports Kubernetes-based clustered/high-availability deployments better (with the [cluster deployment option](/self-hosted/deploy/kubernetes/)). Both Sourcegraph and OpenGrok are self-hosted, and your code never touches Sourcegraph's (or Oracle's) servers. Oracle releases OpenGrok under the open-source CDDL license and does not (currently) have any monetization plans for it. Sourcegraph is a commercial product, with a free tier and [paid premium features](https://about.sourcegraph.com/pricing) available. -Every organization's needs are different. [Try Sourcegraph for free](/admin/deploy/) to see if it's right for your organization. +Every organization's needs are different. [Try Sourcegraph for free](/self-hosted/deploy/) to see if it's right for your organization. For more information about Sourcegraph, see: @@ -79,7 +79,7 @@ Like Oracle OpenGrok, Sourcegraph is self-hosted. You control who can access it. - [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) -- [TLS/SSL and other HTTP/HTTPS configuration](/admin/http_https_configuration) +- [TLS/SSL and other HTTP/HTTPS configuration](/self-hosted/http_https_configuration) ### Rolling out Sourcegraph organization-wide diff --git a/docs/admin/observability/outbound-request-log.mdx b/docs/admin/outbound-request-log.mdx similarity index 95% rename from docs/admin/observability/outbound-request-log.mdx rename to docs/admin/outbound-request-log.mdx index d7eff9ce0..314f43693 100644 --- a/docs/admin/observability/outbound-request-log.mdx +++ b/docs/admin/outbound-request-log.mdx @@ -42,8 +42,8 @@ Keep in mind that some headers might be redacted (you'll see the word "REDACTED" Note: You can set the `redactOutboundRequestHeaders` [site config](/admin/config/site_config#redactOutboundRequestHeaders) option to `false` to disable the redaction of headers and make the "Copy curl" function more convenient. But for security reasons, this setting is only respected in development environments. -## Trouble Shooting +## Troubleshooting ### Page failing to load, or loading slowly -If the Outbound Request Log page is failing to load, or loading slowly, you may need to allocate more resources to Redis. To confirm, please check the charts for Redis under the `provisioning indicators` dropdown in grafana. If these charts show that your CPU usage is consistently over the threshold, allocate more resources to Redis. You can use our [resource estimator](/admin/deploy/resource_estimator) as a guide. +If the Outbound Request Log page is failing to load, or loading slowly, you may need to allocate more resources to Redis. To confirm, please check the charts for Redis under the `provisioning indicators` dropdown in grafana. If these charts show that your CPU usage is consistently over the threshold, allocate more resources to Redis. You can use our [resource estimator](/self-hosted/deploy/resource_estimator) as a guide. diff --git a/docs/admin/permissions/webhooks.mdx b/docs/admin/permissions/webhooks.mdx index 612f56f48..88f41e39a 100644 --- a/docs/admin/permissions/webhooks.mdx +++ b/docs/admin/permissions/webhooks.mdx @@ -35,4 +35,4 @@ not be sent to Sourcegraph. ## Configuring webhooks -Please follow the link for [configuring permission syncing webhooks for Github](/admin/config/webhooks/incoming#user-permissions). +Please follow the link for [configuring permission syncing webhooks for GitHub](/admin/webhooks/incoming#user-permissions). diff --git a/docs/admin/repo/add.mdx b/docs/admin/repo/add.mdx index 71d9e8806..d1cebb49c 100644 --- a/docs/admin/repo/add.mdx +++ b/docs/admin/repo/add.mdx @@ -23,8 +23,8 @@ If your repositories are not showing up, check the site admin **Repositories** page on Sourcegraph (and ensure you're logged in as an admin). If nothing informative is visible there, check for error messages related to communication with your code host's API in the logs from: -- [Docker Compose](/admin/deploy/docker-compose/) and [Kubernetes](/admin/deploy/kubernetes/): the logs from the `worker` container/pod -- [Single-container](/admin/deploy/docker-single-container/): the `sourcegraph/server` Docker container +- [Docker Compose](/self-hosted/deploy/docker-compose/) and [Kubernetes](/self-hosted/deploy/kubernetes/): the logs from the `worker` container/pod +- [Single-container](/self-hosted/deploy/docker-single-container/): the `sourcegraph/server` Docker container ### Repository not cloning or updating diff --git a/docs/admin/repo/auth.mdx b/docs/admin/repo/auth.mdx index bd1ee06a6..a65c799d1 100644 --- a/docs/admin/repo/auth.mdx +++ b/docs/admin/repo/auth.mdx @@ -31,9 +31,9 @@ Some providers may require additional configuration, consult the [code host spec ## Mounting SSH keys into the container -- [Sourcegraph with Docker Compose](/admin/deploy/docker-compose/): See [the Docker Compose git configuration guide](/admin/deploy/docker-compose/#git-configuration). -- [Sourcegraph with Kubernetes](/admin/deploy/kubernetes/): See [Configure repository cloning via SSH](/admin/deploy/kubernetes/configure#ssh-for-cloning). -- [Single-container Sourcegraph](/admin/deploy/docker-single-container/): See [the single-container git configuration guide](/admin/deploy/docker-single-container/#git-configuration-and-authentication). +- [Sourcegraph with Docker Compose](/self-hosted/deploy/docker-compose/): See [the Docker Compose git configuration guide](/admin/deploy/docker-compose/#git-configuration). +- [Sourcegraph with Kubernetes](/self-hosted/deploy/kubernetes/): See [Configure repository cloning via SSH](/self-hosted/deploy/kubernetes/configure#ssh-for-cloning). +- [Single-container Sourcegraph](/self-hosted/deploy/docker-single-container/): See [the single-container git configuration guide](/admin/deploy/docker-single-container/#git-configuration-and-authentication). ## Troubleshooting diff --git a/docs/admin/repo/git_config.mdx b/docs/admin/repo/git_config.mdx index 7aef55b7c..04e2cf0dd 100644 --- a/docs/admin/repo/git_config.mdx +++ b/docs/admin/repo/git_config.mdx @@ -4,9 +4,9 @@ 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](/admin/deploy/docker-compose/): See [the Docker Compose git configuration guide](/admin/deploy/docker-compose/#git-configuration). -- [Sourcegraph with Kubernetes](/admin/deploy/kubernetes/): See [Configure repository cloning via SSH](/admin/deploy/kubernetes/configure#ssh-for-cloning). -- [Single-container Sourcegraph](/admin/deploy/docker-single-container/): See [the single-container git configuration guide](/admin/deploy/docker-single-container/#git-configuration-and-authentication). +- [Sourcegraph with Docker Compose](/self-hosted/deploy/docker-compose/): See [the Docker Compose git configuration guide](/admin/deploy/docker-compose/#git-configuration). +- [Sourcegraph with Kubernetes](/self-hosted/deploy/kubernetes/): See [Configure repository cloning via SSH](/self-hosted/deploy/kubernetes/configure#ssh-for-cloning). +- [Single-container Sourcegraph](/self-hosted/deploy/docker-single-container/): See [the single-container git configuration guide](/admin/deploy/docker-single-container/#git-configuration-and-authentication). ## Example: alternate clone URL for repos diff --git a/docs/admin/repo/pre_load_from_local_disk.mdx b/docs/admin/repo/pre_load_from_local_disk.mdx index b494964bf..785a9a913 100644 --- a/docs/admin/repo/pre_load_from_local_disk.mdx +++ b/docs/admin/repo/pre_load_from_local_disk.mdx @@ -6,12 +6,12 @@ You can use repositories that are already cloned to disk on the host machine to speed up Sourcegraph's cloning. This is useful for very large repositories on which cloning exceeds the resources available to the Docker container. This is not intended for individual users who want to set up a personal Sourcegraph instance just for searching code on their own local disk; we recommend either using a CLI tool such as ripgrep instead, or simply connecting Sourcegraph to your code host with a limited set of repositories. -The steps documented here are intended for [single-container Sourcegraph instances](/admin/deploy/docker-single-container/). The general process also applies for other deployment methods, with some differences: +The steps documented here are intended for [single-container Sourcegraph instances](/self-hosted/deploy/docker-single-container/). The general process also applies for other deployment methods, with some differences: -- [Docker Compose](/admin/deploy/docker-compose/): you need to perform these steps on the relevant [Docker Compose volumes](/admin/deploy/docker-compose/#manage-storage). -- [Kubernetes](/admin/deploy/kubernetes/): you need to perform these steps on the underlying node hosting the `gitserver` pod, or on the persistent volume used by the `gitserver` deployment. +- [Docker Compose](/self-hosted/deploy/docker-compose/): you need to perform these steps on the relevant [Docker Compose volumes](/admin/deploy/docker-compose/#manage-storage). +- [Kubernetes](/self-hosted/deploy/kubernetes/): you need to perform these steps on the underlying node hosting the `gitserver` pod, or on the persistent volume used by the `gitserver` deployment. -> WARNING: For [single-container Sourcegraph instances](/admin/deploy/docker-single-container/), Sourcegraph will alter the contents and structure of files under `/var/opt/sourcegraph` (Sourcegraph’s data volume inside the container), so do not mount repositories in use by other processes under that directory. +> WARNING: For [single-container Sourcegraph instances](/self-hosted/deploy/docker-single-container/), Sourcegraph will alter the contents and structure of files under `/var/opt/sourcegraph` (Sourcegraph’s data volume inside the container), so do not mount repositories in use by other processes under that directory. If you're using the default `--volume $HOME/.sourcegraph/data:/var/opt/sourcegraph` argument to run the `sourcegraph/server` Docker image, and the repository you want to add is named `github.com/my/repo`, then follow these steps: diff --git a/docs/admin/repo/webhooks.mdx b/docs/admin/repo/webhooks.mdx index 957b9bcdb..7238e0efb 100644 --- a/docs/admin/repo/webhooks.mdx +++ b/docs/admin/repo/webhooks.mdx @@ -22,4 +22,4 @@ For repositories that Sourcegraph is already aware of, it will periodically perf ## Code host webhooks -We support receiving webhooks directly from your code host for [GitHub](/admin/config/webhooks/incoming#github), [GitLab](/admin/config/webhooks/incoming#gitlab), [Bitbucket Server](/admin/config/webhooks/incoming#bitbucket-server) and [Bitbucket Cloud](/admin/config/webhooks/incoming#bitbucket-cloud). +We support receiving webhooks directly from your code host for [GitHub](/admin/webhooks/incoming#github), [GitLab](/admin/webhooks/incoming#gitlab), [Bitbucket Server](/admin/webhooks/incoming#bitbucket-server) and [Bitbucket Cloud](/admin/webhooks/incoming#bitbucket-cloud). diff --git a/docs/admin/search.mdx b/docs/admin/search.mdx index 64ff9ca07..bf7e8ba12 100644 --- a/docs/admin/search.mdx +++ b/docs/admin/search.mdx @@ -101,7 +101,7 @@ You can configure indexed branches in site configuration under the `experimental } ``` -Indexing multiple branches will add additional resource requirements to Sourcegraph (particularly memory). The indexer will deduplicate documents between branches. So the size of your index will grow in relation to the number of unique documents. Refer to our [resource estimator](/admin/deploy/resource_estimator) to estimate whether additional resources are required. +Indexing multiple branches will add additional resource requirements to Sourcegraph (particularly memory). The indexer will deduplicate documents between branches. So the size of your index will grow in relation to the number of unique documents. Refer to our [resource estimator](/self-hosted/deploy/resource_estimator) to estimate whether additional resources are required. {' '} @@ -153,7 +153,7 @@ So, assuming that you have 300,000 repositories and a memory map limit of 65,536 ``` Sourcegraph's monitoring system also includes an [alert for this -scenario and mitigation steps](/admin/observability/alerts#zoekt-memory-map-areas-percentage-used). +scenario and mitigation steps](/self-hosted/observability/alerts#zoekt-memory-map-areas-percentage-used). ### Shard merging diff --git a/docs/admin/subscriptions/index.mdx b/docs/admin/subscriptions.mdx similarity index 100% rename from docs/admin/subscriptions/index.mdx rename to docs/admin/subscriptions.mdx diff --git a/docs/admin/teams/index.mdx b/docs/admin/teams.mdx similarity index 100% rename from docs/admin/teams/index.mdx rename to docs/admin/teams.mdx diff --git a/docs/admin/telemetry/index.mdx b/docs/admin/telemetry.mdx similarity index 100% rename from docs/admin/telemetry/index.mdx rename to docs/admin/telemetry.mdx diff --git a/docs/admin/updates/migrator/index.mdx b/docs/admin/updates/migrator/index.mdx deleted file mode 100644 index fa2264ca9..000000000 --- a/docs/admin/updates/migrator/index.mdx +++ /dev/null @@ -1,7 +0,0 @@ -# Migrator Resources - -- [Downgrading](/admin/updates/migrator/downgrading) -- [Migrator operations](/admin/updates/migrator/migrator-operations) -- [Schema drift explained](/admin/updates/migrator/schema-drift) -- [Troubleshooting Upgrades](/admin/updates/migrator/troubleshooting-upgrades) -- [Upgrading Early Versions](/admin/updates/migrator/upgrading-early-versions) diff --git a/docs/admin/config/webhooks/incoming.mdx b/docs/admin/webhooks/incoming.mdx similarity index 97% rename from docs/admin/config/webhooks/incoming.mdx rename to docs/admin/webhooks/incoming.mdx index 2d6034ec8..3121c8a12 100644 --- a/docs/admin/config/webhooks/incoming.mdx +++ b/docs/admin/webhooks/incoming.mdx @@ -278,7 +278,7 @@ Sourcegraph can track incoming webhooks from code hosts to more easily debug iss 2. **Deprecated** Via code host connection: **Site Admin > Batch Changes > Incoming webhooks** ![Legacy webhook logs](https://storage.googleapis.com/sourcegraph-assets/docs/images/administration/config/webhooks/webhook-logs-legacy.png) -By default, sites without [database encryption](/admin/config/encryption) enabled will retain three days of webhook logs. Sites with encryption will not retain webhook logs by default, as webhooks may include sensitive information; these sites can enable webhook logging and optionally configure encryption for them by using the settings below. +By default, sites without [database encryption](/self-hosted/encryption) enabled will retain three days of webhook logs. Sites with encryption will not retain webhook logs by default, as webhooks may include sensitive information; these sites can enable webhook logging and optionally configure encryption for them by using the settings below. ### Enabling webhook logging @@ -313,4 +313,4 @@ To retain webhook logs for one day: ### Encrypting webhook logs -Webhook logs can be encrypted by specifying a `webhookLogKey` in the [on-disk database encryption site configuration](/admin/config/encryption). +Webhook logs can be encrypted by specifying a `webhookLogKey` in the [on-disk database encryption site configuration](/self-hosted/encryption). diff --git a/docs/admin/webhooks/index.mdx b/docs/admin/webhooks/index.mdx new file mode 100644 index 000000000..a1956448c --- /dev/null +++ b/docs/admin/webhooks/index.mdx @@ -0,0 +1,4 @@ +# Webhooks + +- [Incoming webhooks](/admin/webhooks/incoming) +- [Outgoing webhooks](/admin/webhooks/outgoing) diff --git a/docs/admin/config/webhooks/outgoing.mdx b/docs/admin/webhooks/outgoing.mdx similarity index 100% rename from docs/admin/config/webhooks/outgoing.mdx rename to docs/admin/webhooks/outgoing.mdx diff --git a/docs/batch-changes/faq.mdx b/docs/batch-changes/faq.mdx index 1c41ed2df..66a8da64f 100644 --- a/docs/batch-changes/faq.mdx +++ b/docs/batch-changes/faq.mdx @@ -220,7 +220,7 @@ They can! Each changeset that is computed can be assigned to a separate executor ### What additional resources do I need to provision to run batch changes server-side? -See [deploying executors](/admin/executors/deploy_executors) page. You'll require little as a single compute instance and a docker registry mirror if you just want to process batch changes at a small scale; an autoscaling group of instances if you want to process large batch changes very fast. +See [deploying executors](/self-hosted/executors/deploy_executors) page. You'll require little as a single compute instance and a docker registry mirror if you just want to process batch changes at a small scale; an autoscaling group of instances if you want to process large batch changes very fast. ### Can someone accidentally take down the Sourcegraph instance if they run too big a batch change? diff --git a/docs/batch-changes/server-side.mdx b/docs/batch-changes/server-side.mdx index 59b1bb5e0..32fd476d4 100644 --- a/docs/batch-changes/server-side.mdx +++ b/docs/batch-changes/server-side.mdx @@ -11,7 +11,7 @@ By default, Batch Changes uses a command line interface in your local environment to [compute diffs](/batch-changes/how-src-executes-a-batch-spec) and create changesets. This can be impractical for creating batch changes affecting hundreds or thousands of repositories, with large numbers of workspaces, or if the batch change steps require CPU, memory, or disk resources that are unavailable locally. -Instead of computing Batch Changes locally using `src-cli`, you can offload this task to one or many remote server called an [executor](/admin/executors/deploy_executors). Executors are also required to enable code navigation [auto-indexing](/code-navigation/auto_indexing). +Instead of computing Batch Changes locally using `src-cli`, you can offload this task to one or many remote server called an [executor](/self-hosted/executors/deploy_executors). Executors are also required to enable code navigation [auto-indexing](/code-navigation/auto_indexing). This allows to: @@ -23,7 +23,7 @@ This allows to: This is a one-time process. Once a site-admin of the Sourcegraph instance sets up executors and enables running batch changes server-side, all users of the Sourcegraph instance can get started with no additional setup required. -Make sure that [executors are deployed and are online](/admin/executors/deploy_executors). +Make sure that [executors are deployed and are online](/self-hosted/executors/deploy_executors). It's recommended to read [Getting started with running batch changes @@ -35,7 +35,7 @@ Make sure that [executors are deployed and are online](/admin/executors/deploy_e - Running batch changes server-side requires setting up executors. Executors are configured ready-to-use on Sourcegraph Cloud - Running batch changes server-side is limited to user namespaces - The newly introduced APIs for server-side are still experimental and will likely change -- Executors can only be deployed using Terraform (AWS or GCP) or using pre-built binaries (see [deploying executors](/admin/executors/deploy_executors)). +- Executors can only be deployed using Terraform (AWS or GCP) or using pre-built binaries (see [deploying executors](/self-hosted/executors/deploy_executors)). Running batch changes server-side has been tested to run a simple **45K changeset batch change**. Actual performance and setup requirements depend on the complexity of the batch change. diff --git a/docs/batch-changes/site-admin-configuration.mdx b/docs/batch-changes/site-admin-configuration.mdx index 5d8f0d5f7..df9d7f9c2 100644 --- a/docs/batch-changes/site-admin-configuration.mdx +++ b/docs/batch-changes/site-admin-configuration.mdx @@ -12,11 +12,11 @@ Using Batch Changes requires a [code host connection](/admin/code_hosts/) to a s - Additionally, you can also [customize org settings](/admin/config/batch_changes#enable-organization-members-to-administer) to allow members of an organization to share administration privileges over batch changes created in that organization - (Optional) [Configure repository permissions](/admin/permissions/), that Batch Changes will follow - [Configure credentials](/batch-changes/configuring-credentials) -- [Setup incoming webhooks](/admin/config/webhooks/incoming) to make sure changesets sync fast. Learn more about [Batch Changes effect on code host rate limits](/batch-changes/requirements#batch-changes-effect-on-code-host-rate-limits) +- [Setup incoming webhooks](/admin/webhooks/incoming) to make sure changesets sync fast. Learn more about [Batch Changes effect on code host rate limits](/batch-changes/requirements#batch-changes-effect-on-code-host-rate-limits) - Configure any desired optional features, such as: - [Rollout windows](/admin/config/batch_changes#rollout-windows), which control the rate at which Batch Changes will publish changesets on code hosts - [Forks](/admin/config/batch_changes#forks), which push branches created by Batch Changes onto forks of the upstream repository instead of the repository itself - - [Outgoing webhooks](/admin/config/webhooks/outgoing), which publish events related to batch changes and changesets to enable deeper integrations with your other tools and systems + - [Outgoing webhooks](/admin/webhooks/outgoing), which publish events related to batch changes and changesets to enable deeper integrations with your other tools and systems - [Auto-delete branch on merge/close](/admin/config/batch_changes#automatically-delete-branches-on-merge-close), which automatically deletes branches created by Batch Changes when changesets are merged or closed - [Commit signing for GitHub](/admin/config/batch_changes#commit-signing-for-github), which signs commits created by Batch Changes via a GitHub App (Beta) - [Batch spec library](/admin/config/batch_changes#batch-spec-library), which help your users write batch specs and follow best practices diff --git a/docs/cloud/index.mdx b/docs/cloud/index.mdx index 8c7bda1df..0223b1c2d 100644 --- a/docs/cloud/index.mdx +++ b/docs/cloud/index.mdx @@ -27,7 +27,7 @@ As part of this service you will receive a number of benefits from our team, inc - Initial resource estimations based on your organization & code size. - Putting forward a transparent deployment & cost estimate plan. -- Your own `example.sourcegraphcloud.com` domain with fully managed [DNS & HTTPS](/admin/http_https_configuration). Optionally, you can [bring your own domain](#custom-domain). +- Your own `example.sourcegraphcloud.com` domain with fully managed [DNS & HTTPS](/self-hosted/http_https_configuration). Optionally, you can [bring your own domain](#custom-domain). - Hardware provisioning, software installation, and kernel configuration done for you. - Direct assistance in: - [Adding repositories from all of your code hosts to Sourcegraph](/admin/code_hosts/) @@ -52,7 +52,7 @@ All of Sourcegraph's features are available on Sourcegraph Cloud instances out-o ### Regular upgrades and maintenance -- Automatic [upgrades](/admin/updates/) when a new Sourcegraph version is released and maintenance when security patches are needed. +- Automatic [upgrades](/self-hosted/updates/) when a new Sourcegraph version is released and maintenance when security patches are needed. - Regular reassessment of resource utilization based on your organization's unique usage to determine if costs can be reduced without impact to service. Additionally, you will automatically benefit from any committed use cloud provider discounts we receive. ### Custom domains @@ -116,7 +116,7 @@ For unsupported private connectivity methods, Sourcegraph offers connectivity vi ### Health monitoring, support, and SLAs -- Instance performance and health [monitored](/admin/observability/) by our team's on-call engineers. +- Instance performance and health [monitored](/self-hosted/observability/) by our team's on-call engineers. - [Support and SLAs](/sla/#sourcegraph-cloud-sla-managed-instance). ### Backup and restore @@ -150,9 +150,9 @@ All Sourcegraph Cloud instances are provisioned with a Sourcegraph-managed SMTP - Important updates to user accounts (for example, creation of API keys) - For [`builtin` authentication](/admin/auth/#builtin-password-authentication), 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](/admin/config/email#sending-a-test-email). +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). -To opt out of managed SMTP, please let your Sourcegraph Account team know when requesting a trial. You can also opt out by [overriding the managed `email.address` and `email.smtp` configuration with your own in site configuration](/admin/config/email). If you have specific requests for managed SMTP, please [reach out regarding special requirements](#accommodating-special-requirements). +To opt out of managed SMTP, please let your Sourcegraph Account team know when requesting a trial. You can also opt out by [overriding the managed `email.address` and `email.smtp` configuration with your own in site configuration](/self-hosted/email). If you have specific requests for managed SMTP, please [reach out regarding special requirements](#accommodating-special-requirements). To learn more about how the Sourcegraph team operates managed SMTP internally, refer to [our handbook](https://handbook.sourcegraph.com/departments/cloud/technical-docs/managed-smtp/). diff --git a/docs/code-navigation/auto_indexing.mdx b/docs/code-navigation/auto_indexing.mdx index ca0a5ac6b..542014704 100644 --- a/docs/code-navigation/auto_indexing.mdx +++ b/docs/code-navigation/auto_indexing.mdx @@ -21,7 +21,7 @@ The following docs explains how to turn on [auto-indexing](/code-navigation/auto This step is only required if you are on self-hosted Sourcegraph. -First, [deploy the executor service](/admin/executors/deploy_executors) targeting your Sourcegraph instance. This will provide the necessary compute resources that clone the target Git repository, securely analyze the code to produce a code graph data index, then upload that index to your Sourcegraph instance for processing. +First, [deploy the executor service](/self-hosted/executors/deploy_executors) targeting your Sourcegraph instance. This will provide the necessary compute resources that clone the target Git repository, securely analyze the code to produce a code graph data index, then upload that index to your Sourcegraph instance for processing. ### Enable index job scheduling @@ -35,7 +35,7 @@ This step will control the scheduling of indexing jobs which are made available ### Tune the index scheduler -The frequency of index job scheduling can be tuned via the following environment variables read by `worker` service containers running the [`codeintel-auto-indexing`](/admin/workers#codeintel-auto-indexing) task. +The frequency of index job scheduling can be tuned via the following environment variables read by `worker` service containers running the [`codeintel-auto-indexing`](/self-hosted/workers#codeintel-auto-indexing) task. - **`PRECISE_CODE_INTEL_AUTO_INDEXING_TASK_INTERVAL`**: The time to run periodic codeintel auto-indexing tasks. The default is every 2 minutes - **`PRECISE_CODE_INTEL_AUTO_INDEXING_REPOSITORY_PROCESS_DELAY`**: The minimum time that the same repository can be considered for auto-index scheduling. The default is every 24 hours diff --git a/docs/code-navigation/envvars.mdx b/docs/code-navigation/envvars.mdx index 8823e8a1a..28e947067 100644 --- a/docs/code-navigation/envvars.mdx +++ b/docs/code-navigation/envvars.mdx @@ -31,7 +31,7 @@ The following are variables are read from the `worker` service to control code g ### `codeintel-commitgraph` -The following variables influence the behavior of the [`codeintel-commitgraph` worker task](/admin/workers#codeintel-commitgraph). +The following variables influence the behavior of the [`codeintel-commitgraph` worker task](/self-hosted/workers#codeintel-commitgraph). | **Name** | **Default** | **Description** | | ------------------------------------------------------ | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | @@ -41,7 +41,7 @@ The following variables influence the behavior of the [`codeintel-commitgraph` w ### `codeintel-auto-indexing` -The following variables influence the behavior of the [`codeintel-auto-indexing` worker task](/admin/workers#codeintel-auto-indexing). +The following variables influence the behavior of the [`codeintel-auto-indexing` worker task](/self-hosted/workers#codeintel-auto-indexing). | **Name** | **Default** | **Description** | | --------------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------- | @@ -60,7 +60,7 @@ The following settings should be the same for the [`frontend`](#frontend) servic ### `codeintel-janitor` -The following variables influence the behavior of the [`codeintel-janitor` worker task](/admin/workers#codeintel-janitor). +The following variables influence the behavior of the [`codeintel-janitor` worker task](/self-hosted/workers#codeintel-janitor). | **Name** | **Default** | **Description** | | | ------------------------------------------------------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --- | diff --git a/docs/code-navigation/explanations/uploads.mdx b/docs/code-navigation/explanations/uploads.mdx index 141edb01c..1a4643857 100644 --- a/docs/code-navigation/explanations/uploads.mdx +++ b/docs/code-navigation/explanations/uploads.mdx @@ -52,7 +52,7 @@ Sourcegraph maintains a mapping from a commit of a repository to the set of uplo Upon a state change in an upload, we flag the repository as needing an update. Subsequently, the worker service updates the commit graph and asynchronously clears the flag for that repository. -When an upload changes state, the repository is flagged as requiring an update status. Then the [`worker` service](/admin/workers#codeintel-commitgraph) +When an upload changes state, the repository is flagged as requiring an update status. Then the [`worker` service](/self-hosted/workers#codeintel-commitgraph) will update the commit graph and unset the flag for that repository asynchronously. While this flag is set, the repository's commit graph is considered `stale`. This means there may be some upload records in a `COMPLETED` state that aren't yet used to resolve code navigation queries. diff --git a/docs/code-navigation/troubleshooting.mdx b/docs/code-navigation/troubleshooting.mdx index ff109a535..c8979f985 100644 --- a/docs/code-navigation/troubleshooting.mdx +++ b/docs/code-navigation/troubleshooting.mdx @@ -82,7 +82,7 @@ src api -query 'query ViewerSettings { viewerSettings { final } }' | jq -r '.dat ### Traces -[Jaeger](/admin/observability/tracing) traces should be supplied if there is a noticeable performance issue in receiving code navigation results in the SPA. Depending on the type of user operation that is slow, we will need traces for different request types. +[Jaeger](/self-hosted/observability/tracing) traces should be supplied if there is a noticeable performance issue in receiving code navigation results in the SPA. Depending on the type of user operation that is slow, we will need traces for different request types. | **Send traces for requests** | **When latency is high** | | -------------------------------- | ------------------------------------------------------------------- | diff --git a/docs/code_insights/explanations/administration_and_security_of_code_insights.mdx b/docs/code_insights/explanations/administration_and_security_of_code_insights.mdx index 922fdad27..970e2a92a 100644 --- a/docs/code_insights/explanations/administration_and_security_of_code_insights.mdx +++ b/docs/code_insights/explanations/administration_and_security_of_code_insights.mdx @@ -91,7 +91,7 @@ Example: GET_INVENTORY_GIT_SERVER_CONCURRENCY=4 ``` -To understand how this configuration impacts your language stats queries you can use [tracing](/admin/observability/tracing). +To understand how this configuration impacts your language stats queries you can use [tracing](/self-hosted/observability/tracing). ### Language Stats Timeout diff --git a/docs/code_insights/quickstart.mdx b/docs/code_insights/quickstart.mdx index 7d92c138a..137737e31 100644 --- a/docs/code_insights/quickstart.mdx +++ b/docs/code_insights/quickstart.mdx @@ -17,7 +17,7 @@ For more information about Code Insights see the [Code Insights](/code_insights/ - 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 is deployed via [Docker Compose](/admin/deploy/docker-compose/) or [Kubernetes](/admin/deploy/kubernetes/). +- 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/code_insights/references/requirements.mdx b/docs/code_insights/references/requirements.mdx index 6dd7b31e4..4cbfde7b7 100644 --- a/docs/code_insights/references/requirements.mdx +++ b/docs/code_insights/references/requirements.mdx @@ -11,7 +11,7 @@ While the latest version of Sourcegraph server is always recommended: ## Sourcegraph deployment -You can only use Code Insights on a [Docker Compose](/admin/deploy/docker-compose/) or [Kubernetes](/admin/deploy/kubernetes/) Sourcegraph deployment. +You can only use Code Insights on a [Docker Compose](/self-hosted/deploy/docker-compose/) or [Kubernetes](/self-hosted/deploy/kubernetes/) Sourcegraph deployment. ## Code hosts diff --git a/docs/code_monitoring/index.mdx b/docs/code_monitoring/index.mdx index 64689f853..b9df568ef 100644 --- a/docs/code_monitoring/index.mdx +++ b/docs/code_monitoring/index.mdx @@ -51,7 +51,7 @@ An _action_ is executed in response to a trigger event. Currently, code monitori ### Sending a notification email to the owner of the code monitor -Prerequisite: Ensure [email notifications](/admin/observability/alerting#email) are configured in site configuration. +Prerequisite: Ensure [email notifications](/self-hosted/observability/alerting#email) are configured in site configuration. 1. Click the _Code monitoring_ menu item at the top right of your page. 2. Click the _Create new code monitor_ button at the top right of the page. diff --git a/docs/deep-search/index.mdx b/docs/deep-search/index.mdx index 29ee76478..5634b3938 100644 --- a/docs/deep-search/index.mdx +++ b/docs/deep-search/index.mdx @@ -80,4 +80,4 @@ For programmatic access to Deep Search functionality, see the [Deep Search API d ## Monitoring consumption -Customers can request access to [Enterprise Portal](/enterprise-portal#deep-search-usage-monitoring) to monitor Deep Search usage and quota limits.. +Customers can request access to [Enterprise Portal](/admin/enterprise-portal#deep-search-usage-monitoring) to monitor Deep Search usage and quota limits.. diff --git a/docs/dotcom/index.mdx b/docs/dotcom/index.mdx index 6a3cdea10..d89cef788 100644 --- a/docs/dotcom/index.mdx +++ b/docs/dotcom/index.mdx @@ -2,7 +2,7 @@ [Sourcegraph.com](https://sourcegraph.com/search) lets you search 2 million open source repositories. -To use Sourcegraph on your own (private) code, [use Sourcegraph Cloud](/cloud/) or [deploy self-hosted Sourcegraph](/admin/deploy/). +To use Sourcegraph on your own (private) code, [use Sourcegraph Cloud](/cloud/) or [deploy self-hosted Sourcegraph](/self-hosted/deploy/). - [Indexing open source code in Sourcegraph.com](/dotcom/indexing_open_source_code) diff --git a/docs/getting-started/cloud-instance.mdx b/docs/getting-started/cloud-instance.mdx index 2838c50f8..e814f658e 100644 --- a/docs/getting-started/cloud-instance.mdx +++ b/docs/getting-started/cloud-instance.mdx @@ -37,7 +37,7 @@ Getting users into Sourcegraph is easy, you just need to navigate to: By default the Sourcegraph instance cannot send emails. So features like password resets, email invites and email code monitors will not work. -- [Configure email sending / SMTP server](/admin/config/email) +- [Configure email sending / SMTP server](/self-hosted/email) ## Learn Sourcegraph diff --git a/docs/getting-started/index.mdx b/docs/getting-started/index.mdx index 6360a9a67..389589fd7 100644 --- a/docs/getting-started/index.mdx +++ b/docs/getting-started/index.mdx @@ -50,7 +50,7 @@ Sourcegraph's main features are: ## How do I start using Sourcegraph? -1. [Deploy and Configure Sourcegraph](/admin/deploy/) inside your organization on your internal code if nobody else has yet +1. [Deploy and Configure Sourcegraph](/self-hosted/deploy/) inside your organization on your internal code if nobody else has yet 1. Install and configure the [web browser code host integrations](/integration/browser_extension) (recommended) 1. Start searching and browsing code on Sourcegraph by visiting the URL of your organization's internal Sourcegraph instance 1. [Personalize Sourcegraph](/getting-started/personalization/) with themes, quick links, and badges! diff --git a/docs/getting-started/tour.mdx b/docs/getting-started/tour.mdx index 28587d14c..71f0d44e0 100644 --- a/docs/getting-started/tour.mdx +++ b/docs/getting-started/tour.mdx @@ -12,7 +12,7 @@ Using Sourcegraph makes you a more effective code reviewer because code navigati ### Requirements -- A [Sourcegraph Cloud](/cloud/) instance, or [deploy and configure Sourcegraph](/admin/deploy/) and add repositories +- A [Sourcegraph Cloud](/cloud/) instance, or [deploy and configure Sourcegraph](/self-hosted/deploy/) and add repositories - Install the integration for your code host/review tool ### Workflow @@ -31,7 +31,7 @@ Viewing cross-references (internal and external) on Sourcegraph is a great way t ### Requirements -- [Deploy and configure Sourcegraph](/admin/deploy/) and add repositories +- [Deploy and configure Sourcegraph](/self-hosted/deploy/) and add repositories - Install the browser extension and editor plugin for a faster way to initiate searches (optional) ### Workflow @@ -52,7 +52,7 @@ Navigating your code with code navigation on Sourcegraph is a great way to under ### Requirements -- [Deploy and configure Sourcegraph](/admin/deploy/) and add repositories +- [Deploy and configure Sourcegraph](/self-hosted/deploy/) and add repositories - Install the browser extension and editor plugin for a faster way to initiate searches (optional) ### Workflow @@ -72,7 +72,7 @@ Diff search on Sourcegraph is a great starting point for your investigation into ### Requirements -- [Deploy and configure Sourcegraph](/admin/deploy/) and add repositories +- [Deploy and configure Sourcegraph](/self-hosted/deploy/) and add repositories - Install the browser extension and editor plugin for a faster way to initiate searches (optional) ### Workflow diff --git a/docs/how-to/aws-instance-sizing.mdx b/docs/how-to/aws-instance-sizing.mdx index fbb7e4722..00729ed39 100644 --- a/docs/how-to/aws-instance-sizing.mdx +++ b/docs/how-to/aws-instance-sizing.mdx @@ -18,6 +18,6 @@ For example, if you have 8,000 users with 80,000 repositories, your instance siz Sourcegraph AMI will dynamically use the resources available on the EC2 instance type it is deployed to, provided the minimum amount of resources needed is available. If you would like to resize your EC2 instance, follow - the [upgrade steps](/admin/deploy/machine-images/aws-ami#upgrade) to switch + the [upgrade steps](/self-hosted/deploy/machine-images/aws-ami#upgrade) to switch to a more appropriate instance type. diff --git a/docs/admin/config/advanced_config_file.mdx b/docs/self-hosted/advanced_config_file.mdx similarity index 93% rename from docs/admin/config/advanced_config_file.mdx rename to docs/self-hosted/advanced_config_file.mdx index 6ae75271c..93f7afdb5 100644 --- a/docs/admin/config/advanced_config_file.mdx +++ b/docs/self-hosted/advanced_config_file.mdx @@ -25,9 +25,9 @@ Loading configuration in this manner has two significant drawbacks: Set `SITE_CONFIG_FILE=site.json` and mount the config on: -- [Docker Compose](/admin/deploy/docker-compose/) and [Kubernetes](/admin/deploy/kubernetes/): all `frontend` +- [Docker Compose](/self-hosted/deploy/docker-compose/) and [Kubernetes](/self-hosted/deploy/kubernetes/): all `frontend` containers -- [Single-container](/admin/deploy/docker-single-container/): the `sourcegraph/server` container +- [Single-container](/self-hosted/deploy/docker-single-container/): the `sourcegraph/server` container Where `site.json` is a file that contains the [site configuration](/admin/config/site_config), which you would otherwise edit through the in-app site configuration editor. @@ -48,9 +48,9 @@ This will merge both files. Sourcegraph will need access both files. Set `EXTSVC_CONFIG_FILE=extsvc.json` and mount the config on: -- [Docker Compose](/admin/deploy/docker-compose/) and [Kubernetes](/admin/deploy/kubernetes/): all `frontend` +- [Docker Compose](/self-hosted/deploy/docker-compose/) and [Kubernetes](/self-hosted/deploy/kubernetes/): all `frontend` containers -- [Single-container](/admin/deploy/docker-single-container/): the `sourcegraph/server` container +- [Single-container](/self-hosted/deploy/docker-single-container/): the `sourcegraph/server` container Where `extsvc.json` contains a JSON object that specifies _all_ of your code hosts in a single JSONC file: @@ -92,8 +92,8 @@ If you want to _allow_ edits to be made through the web UI (which will be overwr Set `GLOBAL_SETTINGS_FILE=global-settings.json` and mount the config on: -- [Docker Compose](/admin/deploy/docker-compose/) and [Kubernetes](/admin/deploy/kubernetes/): all `frontend` containers -- [Single-container](/admin/deploy/docker-single-container/): the `sourcegraph/server` container +- [Docker Compose](/self-hosted/deploy/docker-compose/) and [Kubernetes](/self-hosted/deploy/kubernetes/): all `frontend` containers +- [Single-container](/self-hosted/deploy/docker-single-container/): the `sourcegraph/server` container Where `global-settings.json` contains the global settings, which you would otherwise edit through the in-app global settings editor. diff --git a/docs/admin/deploy/docker-compose/aws.mdx b/docs/self-hosted/deploy/docker-compose/aws.mdx similarity index 96% rename from docs/admin/deploy/docker-compose/aws.mdx rename to docs/self-hosted/deploy/docker-compose/aws.mdx index 6bd90eb8e..e3c9731c3 100644 --- a/docs/admin/deploy/docker-compose/aws.mdx +++ b/docs/self-hosted/deploy/docker-compose/aws.mdx @@ -18,7 +18,7 @@ Click **Launch Instance** from the [EC2 dashboard](https://console.aws.amazon.co #### Instance type -1. Select an appropriate instance type using our [resource estimator](/admin/deploy/resource_estimator) as reference +1. Select an appropriate instance type using our [resource estimator](/self-hosted/deploy/resource_estimator) as reference #### Key pair (login) @@ -149,7 +149,7 @@ docker ps --filter="name=sourcegraph-frontend-0" ## Upgrade -See the [Docker Compose upgrade docs](/admin/deploy/docker-compose/upgrade). +See the [Docker Compose upgrade docs](/self-hosted/deploy/docker-compose/upgrade). --- @@ -167,5 +167,5 @@ Use [AWS RDS for PostgreSQL](https://aws.amazon.com/rds/) instead of the Dockeri ## Other resources -[HTTP and HTTPS/SSL configuration](/admin/http_https_configuration#sourcegraph-via-docker-compose-caddy-2) +[HTTP and HTTPS/SSL configuration](/self-hosted/http_https_configuration#sourcegraph-via-docker-compose-caddy-2) [Site Administration Quickstart](/admin/how-to/site-admin-quickstart) diff --git a/docs/admin/deploy/docker-compose/azure.mdx b/docs/self-hosted/deploy/docker-compose/azure.mdx similarity index 97% rename from docs/admin/deploy/docker-compose/azure.mdx rename to docs/self-hosted/deploy/docker-compose/azure.mdx index bb81890f7..acf8253b6 100644 --- a/docs/admin/deploy/docker-compose/azure.mdx +++ b/docs/self-hosted/deploy/docker-compose/azure.mdx @@ -12,7 +12,7 @@ In the [Azure Quickstart Center](https://portal.azure.com/?quickstart=true#view/ - `Availability options:` No infrastructure redundancy required - `Image:` Ubuntu Server 18.04 LTS - Gen2 - `VM architecture:` x64 -- `Size:` Select an appropriate instance type using our [resource estimator](/admin/deploy/resource_estimator) as reference +- `Size:` Select an appropriate instance type using our [resource estimator](/self-hosted/deploy/resource_estimator) as reference - `Authentication type:` Select one that works best for you. SSH Key is recommended. - `Inbound port rules:` Allowed selected ports - `Select inbound ports:` HTTP (80), HTTPS (443), SSH (22) @@ -170,7 +170,7 @@ docker ps --filter="name=sourcegraph-frontend-0" ## Upgrade -See the [Docker Compose upgrade docs](/admin/deploy/docker-compose/upgrade). +See the [Docker Compose upgrade docs](/self-hosted/deploy/docker-compose/upgrade). --- @@ -190,5 +190,5 @@ Postgres service will get Sourcegraph back to its previous state. ## Other resources -[HTTP and HTTPS/SSL configuration](/admin/http_https_configuration#sourcegraph-via-docker-compose-caddy-2) +[HTTP and HTTPS/SSL configuration](/self-hosted/http_https_configuration#sourcegraph-via-docker-compose-caddy-2) [Site Administration Quickstart](/admin/how-to/site-admin-quickstart) diff --git a/docs/admin/deploy/docker-compose/configuration.mdx b/docs/self-hosted/deploy/docker-compose/configuration.mdx similarity index 90% rename from docs/admin/deploy/docker-compose/configuration.mdx rename to docs/self-hosted/deploy/docker-compose/configuration.mdx index 85b0ce670..d5e737767 100644 --- a/docs/admin/deploy/docker-compose/configuration.mdx +++ b/docs/self-hosted/deploy/docker-compose/configuration.mdx @@ -1,6 +1,6 @@ # Configuration -> ⚠️ We recommend using our [machine image](/admin/deploy/machine-images/), which is much easier and offers more flexibility when configuring Sourcegraph. Existing customers can reach out to our Customer Support Engineering team support@sourcegraph.com for assistance with migrating. +> ⚠️ We recommend using our [machine image](/self-hosted/deploy/machine-images/), which is much easier and offers more flexibility when configuring Sourcegraph. Existing customers can reach out to our Customer Support Engineering team support@sourcegraph.com for assistance with migrating. You can find the default base [docker-compose.yaml](https://github.com/sourcegraph/deploy-sourcegraph-docker/blob/master/docker-compose/docker-compose.yaml) file inside the [deploy-sourcegraph-docker](https://github.com/sourcegraph/deploy-sourcegraph-docker/blob/master/docker-compose) repository. We strongly recommend using an override file, instead of modifying the base docker-compose.yaml file. @@ -34,7 +34,7 @@ services: The Docker Compose configuration has its own internal PostgreSQL and Redis databases. -You can alternatively configure Sourcegraph to [use external services](/admin/external_services/). +You can alternatively configure Sourcegraph to [use external services](/self-hosted/external_services/). ## Set environment variables @@ -52,7 +52,7 @@ See ["Environment variables in Compose"](https://docs.docker.com/compose/environ ## Enable HTTP tracing -Sourcegraph supports HTTP tracing to help troubleshoot issues. See [Tracing](/admin/observability/tracing) for details. +Sourcegraph supports HTTP tracing to help troubleshoot issues. See [Tracing](/self-hosted/observability/tracing) for details. The base docker-compose.yaml file enables the bundled [otel-collector](https://sourcegraph.com/search?q=repo:%5Egithub%5C.com/sourcegraph/deploy-sourcegraph-docker$+file:docker-compose/docker-compose.yaml+content:%22++otel-collector:%22&patternType=keyword) by default, but a tracing backend needs to be deployed or configured to see HTTP traces. @@ -61,7 +61,7 @@ To enable tracing on your instance, you'll need to either: 1. Deploy our bundled Jaeger backend, or 2. Configure an external tracing backend -Once a tracing backend has been deployed, see our [Tracing](/admin/observability/tracing) page for next steps, including required changes to your Site Configuration to enable traces. +Once a tracing backend has been deployed, see our [Tracing](/self-hosted/observability/tracing) page for next steps, including required changes to your Site Configuration to enable traces. ### Deploy the bundled Jaeger @@ -82,7 +82,7 @@ The bundled otel-collector can be configured to export HTTP traces to an OTel-co To customize the otel-collector config file: - Create a copy of the default config in [otel-collector/config.yaml](https://github.com/sourcegraph/deploy-sourcegraph-docker/blob/main/otel-collector/config.yaml) -- Follow the [OpenTelemetry collector configuration guidance](/admin/observability/opentelemetry) +- Follow the [OpenTelemetry collector configuration guidance](/self-hosted/observability/opentelemetry) - Edit your `docker-compose.override.yaml` file to mount your custom config file to the `otel-collector` container: ```yaml @@ -211,7 +211,7 @@ services: ## Expose debug port -To generate [pprof profiling data](/admin/pprof), you must configure your deployment to expose port 6060 on one of your frontend containers, for example: +To generate [pprof profiling data](/self-hosted/pprof), you must configure your deployment to expose port 6060 on one of your frontend containers, for example: ```yaml # docker-compose.override.yaml @@ -221,4 +221,4 @@ services: - '0.0.0.0:6060:6060' ``` -For specific ports that can be exposed, see the [debug ports](/admin/pprof#debug-ports) section of the [pprof profiling data](/admin/pprof) page. +For specific ports that can be exposed, see the [debug ports](/self-hosted/pprof#debug-ports) section of the [pprof profiling data](/self-hosted/pprof) page. diff --git a/docs/admin/deploy/docker-compose/digitalocean.mdx b/docs/self-hosted/deploy/docker-compose/digitalocean.mdx similarity index 94% rename from docs/admin/deploy/docker-compose/digitalocean.mdx rename to docs/self-hosted/deploy/docker-compose/digitalocean.mdx index 109ec2e31..d6f650dde 100644 --- a/docs/admin/deploy/docker-compose/digitalocean.mdx +++ b/docs/self-hosted/deploy/docker-compose/digitalocean.mdx @@ -19,7 +19,7 @@ This guide will take you through how to deploy a Sourcegraph instance to a singl #### Choose a plan -1. Select an appropriate droplet size using our [resource estimator](/admin/deploy/resource_estimator) as reference +1. Select an appropriate droplet size using our [resource estimator](/self-hosted/deploy/resource_estimator) as reference #### Add block storage @@ -160,7 +160,7 @@ After the initial deployment has been completed, it is strongly recommended to s - Restrict the accessibility of ports other than `80` and `443` via [Cloud Firewalls](https://www.digitalocean.com/docs/networking/firewalls/quickstart/). -- Set up [TLS/SSL](/admin/http_https_configuration#sourcegraph-via-docker-compose-caddy-2) in the Docker Compose deployment +- Set up [TLS/SSL](/self-hosted/http_https_configuration#sourcegraph-via-docker-compose-caddy-2) in the Docker Compose deployment > NOTE: If you have configured a DNS entry for the IP, please ensure to update `externalURL` in your Sourcegraph instance's Site Configuration to reflect that @@ -168,7 +168,7 @@ After the initial deployment has been completed, it is strongly recommended to s ## Upgrade -Please refer to the [Docker Compose upgrade docs](/admin/deploy/docker-compose/upgrade) for detailed instructions on updating your Sourcegraph instance. +Please refer to the [Docker Compose upgrade docs](/self-hosted/deploy/docker-compose/upgrade) for detailed instructions on updating your Sourcegraph instance. --- @@ -188,5 +188,5 @@ get Sourcegraph back to its previous state. ## Other resources -[HTTP and HTTPS/SSL configuration](/admin/http_https_configuration#sourcegraph-via-docker-compose-caddy-2) +[HTTP and HTTPS/SSL configuration](/self-hosted/http_https_configuration#sourcegraph-via-docker-compose-caddy-2) [Site Administration Quickstart](/admin/how-to/site-admin-quickstart) diff --git a/docs/admin/deploy/docker-compose/google_cloud.mdx b/docs/self-hosted/deploy/docker-compose/google_cloud.mdx similarity index 96% rename from docs/admin/deploy/docker-compose/google_cloud.mdx rename to docs/self-hosted/deploy/docker-compose/google_cloud.mdx index 339111c16..09013862b 100644 --- a/docs/admin/deploy/docker-compose/google_cloud.mdx +++ b/docs/self-hosted/deploy/docker-compose/google_cloud.mdx @@ -8,7 +8,7 @@ Click **Create Instance** in your [Google Cloud Compute Engine Console](https:// #### Machine configuration -1. Select an appropriate machine type using our [resource estimator](/admin/deploy/resource_estimator) as reference +1. Select an appropriate machine type using our [resource estimator](/self-hosted/deploy/resource_estimator) as reference #### Boot disk @@ -149,7 +149,7 @@ docker ps --filter="name=sourcegraph-frontend-0" ## Upgrade -Please refer to the [Docker Compose upgrade docs](/admin/deploy/docker-compose/upgrade) for detailed instructions on updating your Sourcegraph instance. +Please refer to the [Docker Compose upgrade docs](/self-hosted/deploy/docker-compose/upgrade) for detailed instructions on updating your Sourcegraph instance. --- @@ -168,5 +168,5 @@ the old external Postgres service will get Sourcegraph back to its previous stat ## Other resources -[HTTP and HTTPS/SSL configuration](/admin/http_https_configuration#sourcegraph-via-docker-compose-caddy-2) +[HTTP and HTTPS/SSL configuration](/self-hosted/http_https_configuration#sourcegraph-via-docker-compose-caddy-2) [Site Administration Quickstart](/admin/how-to/site-admin-quickstart) diff --git a/docs/admin/deploy/docker-compose/index.mdx b/docs/self-hosted/deploy/docker-compose/index.mdx similarity index 93% rename from docs/admin/deploy/docker-compose/index.mdx rename to docs/self-hosted/deploy/docker-compose/index.mdx index 96e633b79..aa7d417f4 100644 --- a/docs/admin/deploy/docker-compose/index.mdx +++ b/docs/self-hosted/deploy/docker-compose/index.mdx @@ -26,7 +26,7 @@ This guide will take you through how to install Sourcegraph with Docker Compose - Install [Docker Compose](https://docs.docker.com/compose/) on the server - Minimum Docker [v20.10.0](https://docs.docker.com/engine/release-notes/#20100) and Docker Compose [v1.29.0](https://docs.docker.com/compose/release-notes/#1290) - Docker Swarm mode is **not** supported -- Check the [resource estimator](/admin/deploy/resource_estimator) for resource requirements +- Check the [resource estimator](/self-hosted/deploy/resource_estimator) for resource requirements - Obtain a [Sourcegraph license](https://about.sourcegraph.com/pricing/) - License is required for instances with **more than 10 users** - optional Configure ingress firewall rules @@ -119,7 +119,7 @@ Continue with the following steps _after_ you have created a public or private c 3\. Create a new branch called `release` off the latest version of Sourcegraph -- This branch will be used to [upgrade Sourcegraph](/admin/deploy/docker-compose/upgrade) and install your Sourcegraph instance. +- This branch will be used to [upgrade Sourcegraph](/self-hosted/deploy/docker-compose/upgrade) and install your Sourcegraph instance. - It also allows us to track all of the customizations made to your Sourcegraph instance. ``` @@ -147,7 +147,7 @@ If you would like to make changes to the default configurations, we highly recom Please make sure to commit any changes to your `release` branch. -For detailed instructions on how to configure the instance using an override file, please refer to the [configuration docs](/admin/deploy/docker-compose/configuration). +For detailed instructions on how to configure the instance using an override file, please refer to the [configuration docs](/self-hosted/deploy/docker-compose/configuration). > NOTE: Using an override file to customize your Sourcegraph instance is highly recommended as it is the best way to prevent merge conflicts during upgrades. @@ -187,7 +187,7 @@ Once the server is ready, navigate to the `sourcegraph-frontend-0` hostname or I ## Additional Information -- [Upgrade](/admin/deploy/docker-compose/upgrade) -- [Management Operations](/admin/deploy/docker-compose/operations) -- [HTTP and HTTPS/SSL configuration](/admin/http_https_configuration#sourcegraph-via-docker-compose-caddy-2) +- [Upgrade](/self-hosted/deploy/docker-compose/upgrade) +- [Management Operations](/self-hosted/deploy/docker-compose/operations) +- [HTTP and HTTPS/SSL configuration](/self-hosted/http_https_configuration#sourcegraph-via-docker-compose-caddy-2) - [Site Administration Quickstart](/admin/how-to/site-admin-quickstart) diff --git a/docs/admin/deploy/docker-compose/migrate.mdx b/docs/self-hosted/deploy/docker-compose/migrate.mdx similarity index 91% rename from docs/admin/deploy/docker-compose/migrate.mdx rename to docs/self-hosted/deploy/docker-compose/migrate.mdx index 08cfeb238..7f240dfd0 100644 --- a/docs/admin/deploy/docker-compose/migrate.mdx +++ b/docs/self-hosted/deploy/docker-compose/migrate.mdx @@ -1,6 +1,6 @@ # Migrate from the single Docker image to Docker Compose -> ⚠️ We recommend new users use our [machine image](/admin/deploy/machine-images/) or [script-install](/admin/deploy/single-node/script) instructions, which are easier and offer more flexibility when configuring Sourcegraph. Existing customers can reach out to our Customer Engineering team support@sourcegraph.com if they wish to migrate to these deployment models. +> ⚠️ We recommend new users use our [machine image](/self-hosted/deploy/machine-images/) or [script-install](/self-hosted/deploy/single-node/script) instructions, which are easier and offer more flexibility when configuring Sourcegraph. Existing customers can reach out to our Customer Engineering team support@sourcegraph.com if they wish to migrate to these deployment models. Since Sourcegraph 3.13, deploying via Docker Compose is the recommended method for production deployments as it provides resource isolation between Sourcegraph services which makes it more scalable and stable. This page describes how to migrate from a single Docker image deployment to the Docker Compose deployment method. @@ -84,9 +84,9 @@ scp example_user@example_docker_host.com:/tmp/*.out Follow your cloud provider's installation guide to create the new Docker Compose instance: -- [Deploy Sourcegraph with Docker Compose on AWS](/admin/deploy/docker-compose/aws) -- [Deploy Sourcegraph with Docker Compose on Google Cloud](/admin/deploy/docker-compose/google_cloud) -- [Deploy Sourcegraph with Docker Compose on DigitalOcean](/admin/deploy/docker-compose/digitalocean) +- [Deploy Sourcegraph with Docker Compose on AWS](/self-hosted/deploy/docker-compose/aws) +- [Deploy Sourcegraph with Docker Compose on Google Cloud](/self-hosted/deploy/docker-compose/google_cloud) +- [Deploy Sourcegraph with Docker Compose on DigitalOcean](/self-hosted/deploy/docker-compose/digitalocean) Once you have finished the above, come back here for directions on how to copy over the database from your old `sourcegraph/server` instance. diff --git a/docs/admin/deploy/docker-compose/operations.mdx b/docs/self-hosted/deploy/docker-compose/operations.mdx similarity index 92% rename from docs/admin/deploy/docker-compose/operations.mdx rename to docs/self-hosted/deploy/docker-compose/operations.mdx index fe4f36486..b0ce888e5 100644 --- a/docs/admin/deploy/docker-compose/operations.mdx +++ b/docs/self-hosted/deploy/docker-compose/operations.mdx @@ -1,6 +1,6 @@ # Management Operations -> ⚠️ We recommend using our [machine image](/admin/deploy/machine-images/), which is much easier and offers more flexibility when configuring Sourcegraph. Existing customers can reach out to our Customer Support Engineering team support@sourcegraph.com for assistance with migrating. +> ⚠️ We recommend using our [machine image](/self-hosted/deploy/machine-images/), which is much easier and offers more flexibility when configuring Sourcegraph. Existing customers can reach out to our Customer Support Engineering team support@sourcegraph.com for assistance with migrating. --- @@ -8,10 +8,10 @@ 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](/admin/deploy/docker-compose/aws#storage-and-backups) -- [Storage and backups for Azure](/admin/deploy/docker-compose/aws#storage-and-backups) -- [Storage and backups for Google Cloud](/admin/deploy/docker-compose/google_cloud#storage-and-backups) -- [Storage and backups for Digital Ocean](/admin/deploy/docker-compose/digitalocean#storage-and-backups) +- [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 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) ## Access the database @@ -27,7 +27,7 @@ docker exec -it codeinsights-db psql -U postgres #access codeinsights-db contain The `frontend` container in the `docker-compose.yaml` file will automatically run on startup and migrate the databases if any changes are required, however administrators may wish to migrate their databases before upgrading the rest of the system when working with large databases. Sourcegraph guarantees database backward compatibility to the most recent minor point release so the database can safely be upgraded before the application code. -To execute the database migrations independently, follow the [docker-compose instructions on how to manually run database migrations](/admin/updates/migrator/migrator-operations#docker-compose). Running the `up` (default) command on the `migrator` of the _version you are upgrading to_ will apply all migrations required by the next version of Sourcegraph. +To execute the database migrations independently, follow the [docker-compose instructions on how to manually run database migrations](/self-hosted/updates/migrator/migrator-operations#docker-compose). Running the `up` (default) command on the `migrator` of the _version you are upgrading to_ will apply all migrations required by the next version of Sourcegraph. ## Backup and restore @@ -232,6 +232,6 @@ zoekt-webserver-0 /sbin/tini -- /bin/sh -c z ... Up (healthy)> docke You can monitor the health of a deployment in several ways: -- Using [Sourcegraph's built-in observability suite](/admin/observability/), which includes dashboards and alerting for Sourcegraph services. +- Using [Sourcegraph's built-in observability suite](/self-hosted/observability/), which includes dashboards and alerting for Sourcegraph services. - Using [`docker ps`](https://docs.docker.com/engine/reference/commandline/ps/) to check on the status of containers within the deployment (any tooling designed to work with Docker containers and/or Docker Compose will work too). - This requires direct access to your instance's host machine. diff --git a/docs/admin/deploy/docker-compose/upgrade.mdx b/docs/self-hosted/deploy/docker-compose/upgrade.mdx similarity index 92% rename from docs/admin/deploy/docker-compose/upgrade.mdx rename to docs/self-hosted/deploy/docker-compose/upgrade.mdx index f00e9dada..0b93393a9 100644 --- a/docs/admin/deploy/docker-compose/upgrade.mdx +++ b/docs/self-hosted/deploy/docker-compose/upgrade.mdx @@ -2,10 +2,10 @@ import {CURRENT_VERSION_STRING} from 'src/components/PreCodeBlock'; # Upgrade Sourcegraph on Docker Compose -This document describes the process to update a Docker Compose Sourcegraph instance. If you are unfamiliar with sourcegraph versioning or releases see our [general concepts documentation](/admin/updates/). +This document describes the process to update a Docker Compose Sourcegraph instance. If you are unfamiliar with sourcegraph versioning or releases see our [general concepts documentation](/self-hosted/updates/). > -> Always consult the [release notes](/admin/updates/docker_compose) for the +> Always consult the [release notes](/self-hosted/updates/docker_compose) for the > versions your upgrade will pass over and end on. > @@ -70,11 +70,11 @@ $ docker-compose up -d --remove-orphans > advisement.{' '} > -To perform a multi-version upgrade via migrators [upgrade](/admin/updates/migrator/migrator-operations#upgrade) command on a Sourcegraph instance running on Docker compose follow the procedure below: +To perform a multi-version upgrade via migrators [upgrade](/self-hosted/updates/migrator/migrator-operations#upgrade) command on a Sourcegraph instance running on Docker compose follow the procedure below: 1. **Check Upgrade Readiness**: - - Check the [upgrade notes](/admin/updates/docker_compose#docker-compose-upgrade-notes) for the version range you're passing through. + - Check the [upgrade notes](/self-hosted/updates/docker_compose#docker-compose-upgrade-notes) for the version range you're passing through. - Check the `Site Admin > Updates` page to determine [upgrade readiness](/admin/updates/#upgrade-readiness). 2. **Pull and merge upstream changes**: @@ -90,7 +90,7 @@ To perform a multi-version upgrade via migrators [upgrade](/admin/updates/migrat ``` 4. **Run Migrator with the `upgrade` command**: - - _For more detailed instructions and available command flags see our [migrator docs](/admin/updates/migrator/migrator-operations#upgrade)._ + - _For more detailed instructions and available command flags see our [migrator docs](/self-hosted/updates/migrator/migrator-operations#upgrade)._ 1. If the migrator `image:` in your `docker-compose.yaml` wasn't updated to in the **latest** release of `migrator` in step 2 set migrator's image to the latest release. **Example:** ```yaml diff --git a/docs/admin/deploy/docker-single-container/aws.mdx b/docs/self-hosted/deploy/docker-single-container/aws.mdx similarity index 83% rename from docs/admin/deploy/docker-single-container/aws.mdx rename to docs/self-hosted/deploy/docker-single-container/aws.mdx index 6a76f757b..4b1f3e716 100644 --- a/docs/admin/deploy/docker-single-container/aws.mdx +++ b/docs/self-hosted/deploy/docker-single-container/aws.mdx @@ -5,9 +5,9 @@ import { # Install single-container Sourcegraph with Docker on AWS -This tutorial shows you how to deploy [single-container Sourcegraph with Docker](/admin/deploy/docker-single-container/) to a single EC2 instance on AWS. +This tutorial shows you how to deploy [single-container Sourcegraph with Docker](/self-hosted/deploy/docker-single-container/) to a single EC2 instance on AWS. -> NOTE: We _do not_ recommend using this method for a production instance. If deploying a production instance, see [our recommendations](/admin/deploy/) for how to choose a deployment type that suits your needs. We recommend [Docker Compose](/admin/deploy/docker-compose/aws) for most initial production deployments. +> NOTE: We _do not_ recommend using this method for a production instance. If deploying a production instance, see [our recommendations](/self-hosted/deploy/) for how to choose a deployment type that suits your needs. We recommend [Docker Compose](/self-hosted/deploy/docker-compose/aws) for most initial production deployments. --- @@ -44,7 +44,7 @@ This tutorial shows you how to deploy [single-container Sourcegraph with Docker] - Select **Next: ...** until you get to the **Configure Security Group** page. Then add the following rules: - Default **HTTP** rule: port range `80`, source `0.0.0.0/0, ::/0` - Default **HTTPS** rule: port range `443`, source `0.0.0.0/0, ::/0` - - (NOTE: additional work will be required later on to [configure NGINX to support SSL](/admin/http_https_configuration#nginx-ssl-https-configuration)) + - (NOTE: additional work will be required later on to [configure NGINX to support SSL](/self-hosted/http_https_configuration#nginx-ssl-https-configuration)) - Launch your instance, then navigate to its public IP in your browser. (This can be found by navigating to the instance page on EC2 and looking in the "Description" panel for the "IPv4 Public IP" value.) You may have to wait a minute or two for the instance to finish initializing before Sourcegraph becomes accessible. You can monitor the status by SSHing into the EC2 instance and viewing the logs: ``` @@ -69,6 +69,6 @@ docker run docker run -d --publish 80:7080 --publish 443:7080 --restart unless-s ## Using an external database for persistence -The Docker container has its own internal PostgreSQL and Redis databases. To preserve this data when you kill and recreate the container, you can [use external services](/admin/external_services/) for persistence, such as [AWS RDS for PostgreSQL](https://aws.amazon.com/rds/), [Amazon ElastiCache](https://aws.amazon.com/elasticache/redis/), and [S3](https://aws.amazon.com/s3/) for storing user uploads. +The Docker container has its own internal PostgreSQL and Redis databases. To preserve this data when you kill and recreate the container, you can [use external services](/self-hosted/external_services/) for persistence, such as [AWS RDS for PostgreSQL](https://aws.amazon.com/rds/), [Amazon ElastiCache](https://aws.amazon.com/elasticache/redis/), and [S3](https://aws.amazon.com/s3/) for storing user uploads. > NOTE: Use of external databases requires [Sourcegraph Enterprise](https://about.sourcegraph.com/pricing). diff --git a/docs/admin/deploy/docker-single-container/digitalocean.mdx b/docs/self-hosted/deploy/docker-single-container/digitalocean.mdx similarity index 81% rename from docs/admin/deploy/docker-single-container/digitalocean.mdx rename to docs/self-hosted/deploy/docker-single-container/digitalocean.mdx index f868b2ac1..eaa7fea5b 100644 --- a/docs/admin/deploy/docker-single-container/digitalocean.mdx +++ b/docs/self-hosted/deploy/docker-single-container/digitalocean.mdx @@ -5,9 +5,9 @@ import { # Install single-container Sourcegraph with Docker on DigitalOcean -This tutorial shows you how to deploy [single-container Sourcegraph with Docker](/admin/deploy/docker-single-container/) to a single node running on DigitalOcean. +This tutorial shows you how to deploy [single-container Sourcegraph with Docker](/self-hosted/deploy/docker-single-container/) to a single node running on DigitalOcean. -> NOTE: We _do not_ recommend using this method for a production instance. If deploying a production instance, see [our recommendations](/admin/deploy/) for how to choose a deployment type that suits your needs. We recommend [Docker Compose](/admin/deploy/docker-compose/digitalocean) for most initial production deployments. +> NOTE: We _do not_ recommend using this method for a production instance. If deploying a production instance, see [our recommendations](/self-hosted/deploy/) for how to choose a deployment type that suits your needs. We recommend [Docker Compose](/self-hosted/deploy/docker-compose/digitalocean) for most initial production deployments. --- @@ -33,7 +33,7 @@ After initial setup, we recommend you do the following: - Restrict the accessibility of ports other than `80` and `443` via [Cloud Firewalls](https://www.digitalocean.com/docs/networking/firewalls/quickstart/). -- Set up [TLS/SSL](/admin/http_https_configuration#nginx-ssl-https-configuration) in the NGINX configuration. +- Set up [TLS/SSL](/self-hosted/http_https_configuration#nginx-ssl-https-configuration) in the NGINX configuration. --- diff --git a/docs/admin/deploy/docker-single-container/google_cloud.mdx b/docs/self-hosted/deploy/docker-single-container/google_cloud.mdx similarity index 78% rename from docs/admin/deploy/docker-single-container/google_cloud.mdx rename to docs/self-hosted/deploy/docker-single-container/google_cloud.mdx index 1f0a0e91e..c22652ada 100644 --- a/docs/admin/deploy/docker-single-container/google_cloud.mdx +++ b/docs/self-hosted/deploy/docker-single-container/google_cloud.mdx @@ -5,9 +5,9 @@ import { # Install single-container Sourcegraph with Docker on Google Cloud -This tutorial shows you how to deploy [single-container Sourcegraph with Docker](/admin/deploy/docker-single-container/) to a single node running on Google Cloud. +This tutorial shows you how to deploy [single-container Sourcegraph with Docker](/self-hosted/deploy/docker-single-container/) to a single node running on Google Cloud. -> NOTE: We _do not_ recommend using this method for a production instance. If deploying a production instance, see [our recommendations](/admin/deploy/) for how to choose a deployment type that suits your needs. We recommend [Docker Compose](/admin/deploy/docker-compose/google_cloud) for most initial production deployments. +> NOTE: We _do not_ recommend using this method for a production instance. If deploying a production instance, see [our recommendations](/self-hosted/deploy/) for how to choose a deployment type that suits your needs. We recommend [Docker Compose](/self-hosted/deploy/docker-compose/google_cloud) for most initial production deployments. --- @@ -51,6 +51,6 @@ docker run -d ... sourcegraph/server:X.Y.Z ## Using an external database for persistence -The Docker container has its own internal PostgreSQL and Redis databases. To preserve this data when you kill and recreate the container, you can [use external services](/admin/external_services/) for persistence, such as Google Cloud's [Cloud SQL for PostgreSQL](https://cloud.google.com/sql/docs/postgres/), [Cloud Memorystore](https://cloud.google.com/memorystore/), and [Cloud Storage](https://cloud.google.com/storage) for storing user uploads. +The Docker container has its own internal PostgreSQL and Redis databases. To preserve this data when you kill and recreate the container, you can [use external services](/self-hosted/external_services/) for persistence, such as Google Cloud's [Cloud SQL for PostgreSQL](https://cloud.google.com/sql/docs/postgres/), [Cloud Memorystore](https://cloud.google.com/memorystore/), and [Cloud Storage](https://cloud.google.com/storage) for storing user uploads. > NOTE: Use of external databases requires [Sourcegraph Enterprise](https://about.sourcegraph.com/pricing). diff --git a/docs/admin/deploy/docker-single-container/index.mdx b/docs/self-hosted/deploy/docker-single-container/index.mdx similarity index 89% rename from docs/admin/deploy/docker-single-container/index.mdx rename to docs/self-hosted/deploy/docker-single-container/index.mdx index 59ecdc8a8..519fd7aa9 100644 --- a/docs/admin/deploy/docker-single-container/index.mdx +++ b/docs/self-hosted/deploy/docker-single-container/index.mdx @@ -7,7 +7,7 @@ import { The Docker Single Container deployment type is a way to very quickly get an instance of Sourcegraph set up locally to experiment with many of its features. However, it is **not recommended** for a production instance, and **has limitations** depending on the OS you are deploying to, as well as the associated resources. See the [troubleshooting section](#troubleshooting) for additional information. -[Code Insights](/code_insights/) is not supported in Single Container deployments. To try Code Insights you must deploy using [Docker Compose](/admin/deploy/docker-compose/) or [Kubernetes](/admin/deploy/kubernetes/). [Tracing](/admin/observability/tracing) is disabled by default, and if you intend to enable it, you will have to deploy and configure the [OpenTelemetry Collector](/admin/observability/opentelemetry). The Single Container deployment does not ship with this service included. It is strongly recommended to use one of the aforementioned deployment methods if tracing support is a requirement. +[Code Insights](/code_insights/) is not supported in Single Container deployments. To try Code Insights you must deploy using [Docker Compose](/self-hosted/deploy/docker-compose/) or [Kubernetes](/self-hosted/deploy/kubernetes/). [Tracing](/self-hosted/observability/tracing) is disabled by default, and if you intend to enable it, you will have to deploy and configure the [OpenTelemetry Collector](/self-hosted/observability/opentelemetry). The Single Container deployment does not ship with this service included. It is strongly recommended to use one of the aforementioned deployment methods if tracing support is a requirement. ## Installation @@ -25,7 +25,7 @@ Once the server is ready (logo is displayed in the terminal), navigate to the ho For next steps and further configuration options, review the high-level configuration items below, or visit the [detailed configuration documentation](/admin/config/). -> WARNING: **We do not recommend using this method for a production instance.** If deploying a production instance, see [our recommendations](/admin/deploy/) for how to choose a deployment type that suits your needs. We recommend [Docker Compose](/admin/deploy/docker-compose/) for most initial production deployments. +> WARNING: **We do not recommend using this method for a production instance.** If deploying a production instance, see [our recommendations](/self-hosted/deploy/) for how to choose a deployment type that suits your needs. We recommend [Docker Compose](/self-hosted/deploy/docker-compose/) for most initial production deployments. ## Configuration @@ -87,7 +87,7 @@ To provide HTTP(S) authentication, assuming you're using the default `--volume $ ### Expose debug port -This is required to [collect debug data](/admin/pprof). +This is required to [collect debug data](/self-hosted/pprof). The docker run command for single-container Sourcegraph needs an additional publish flag to expose the debug port: @@ -143,7 +143,7 @@ SELECT * FROM users; ### Postgresql 16 -> Warning: The 5.11 release updates the database container images from Postgres 12 to Postgres 16. Customers are advised to have a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/admin/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! +> Warning: The 5.11 release updates the database container images from Postgres 12 to Postgres 16. Customers are advised to have a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! From sourcegraph version 5.11 onwards, the Sourcegraph single container Docker image uses Postgresql 16. Upgrading from Postgresql 12 to Postgresql 16 is a manual process, that is similar to the one outlined below for multi-version upgrades, but migrator has been merged into the container, allowing for a simpler upgrade. @@ -156,7 +156,7 @@ From sourcegraph version 5.11 onwards, the Sourcegraph single container Docker i **Before performing a multi-version upgrade**: - Read our [update policy](/admin/updates/#update-policy) to learn about Sourcegraph updates. -- Find the entries that apply to the version range you're passing through in the [update notes for Sourcegraph with Docker Single Container](/admin/updates/server#multi-version-upgrade-procedure). +- Find the entries that apply to the version range you're passing through in the [update notes for Sourcegraph with Docker Single Container](/self-hosted/updates/server#multi-version-upgrade-procedure). 0. You must first shutdown the container instance via `docker stop [CONTAINER]`. 1. Start a temporary Postgres container on top of the Postgres data directory used by the old `sourcegraph/server` image. You must use the _new_ postgresql-16-codeinsights image, which is based on the new Postgresql 16 image, and provides an automatic upgrade script to move from Postgresql 12 to Postgresql 16. @@ -177,7 +177,7 @@ A [standard upgrade](/admin/updates/#standard-upgrades) occurs between two minor **Before upgrading:** - Read our [update policy](/admin/updates/#update-policy) to learn about Sourcegraph updates. -- Find the relevant entry for your update in the [update notes for single-container Sourcegraph with Docker](/admin/updates/server). +- Find the relevant entry for your update in the [update notes for single-container Sourcegraph with Docker](/self-hosted/updates/server). To update, just use the newer `sourcegraph/server:N.N.N` Docker image (where `N.N.N` is a patch or single minor release away your current version) in place of the older one, using the same Docker volumes. Your server's data will be migrated automatically if needed. You can always find the version number details of the latest release via the [technical changelog](/technical-changelog). @@ -204,13 +204,13 @@ A [multi-version upgrade](/admin/updates/#multi-version-upgrades) is a downtime- **Before performing a multi-version upgrade**: - Read our [update policy](/admin/updates/#update-policy) to learn about Sourcegraph updates. -- Find the entries that apply to the version range you're passing through in the [update notes for Sourcegraph with Docker Single Container](/admin/updates/server#multi-version-upgrade-procedure). +- Find the entries that apply to the version range you're passing through in the [update notes for Sourcegraph with Docker Single Container](/self-hosted/updates/server#multi-version-upgrade-procedure). To perform a multi-version upgrade on a Sourcegraph instance running on Docker Single Container: 1. Stop the running Sourcegraph container via `docker stop [CONTAINER]`. -1. Start a temporary Postgres container on top of the Postgres data directory used by the old `sourcegraph/server` image. This Postgres instance will be used by the following upgrade migration. If using an [external database](/admin/external_services/postgres), the database is already accessible from the `migrator` so no action is needed. Otherwise, start the new Postgres container by following the steps [described below](#running-temporary-postgres-containers). -1. Follow the instructions on [how to run the migrator job in Docker](/admin/updates/migrator/migrator-operations#docker-compose) to perform the upgrade migratiohn. For specific documentation on the `upgrade` command, see the [command documentation](/admin/updates/migrator/migrator-operations#upgrade). The following specific steps are an easy way to run the upgrade command: +1. Start a temporary Postgres container on top of the Postgres data directory used by the old `sourcegraph/server` image. This Postgres instance will be used by the following upgrade migration. If using an [external database](/self-hosted/external_services/postgres), the database is already accessible from the `migrator` so no action is needed. Otherwise, start the new Postgres container by following the steps [described below](#running-temporary-postgres-containers). +1. Follow the instructions on [how to run the migrator job in Docker](/self-hosted/updates/migrator/migrator-operations#docker-compose) to perform the upgrade migratiohn. For specific documentation on the `upgrade` command, see the [command documentation](/self-hosted/updates/migrator/migrator-operations#upgrade). The following specific steps are an easy way to run the upgrade command:

@@ -320,7 +320,7 @@ You can do this by adding `-e PGRESTORE=true` to your `docker run` command. This The database is only accessible from within the container. To perform a restore you will need to copy the required files to the container and then execute the restore commands from within the container using `docker exec`. -You can find examples of this procedure for `docker-compose` in our [docker-compose migration docs](/admin/deploy/docker-compose/migrate). +You can find examples of this procedure for `docker-compose` in our [docker-compose migration docs](/self-hosted/deploy/docker-compose/migrate). ### Special instructions for RHEL, Fedora, CentOS and others @@ -338,9 +338,9 @@ To fix this, run: Cloud specific Sourcegraph installation guides for AWS, Google Cloud and Digital Ocean. -- [Install Sourcegraph with Docker on AWS](/admin/deploy/docker-single-container/aws) -- [Install Sourcegraph with Docker on Google Cloud](/admin/deploy/docker-single-container/google_cloud) -- [Install Sourcegraph with Docker on DigitalOcean](/admin/deploy/docker-single-container/digitalocean) +- [Install Sourcegraph with Docker on AWS](/self-hosted/deploy/docker-single-container/aws) +- [Install Sourcegraph with Docker on Google Cloud](/self-hosted/deploy/docker-single-container/google_cloud) +- [Install Sourcegraph with Docker on DigitalOcean](/self-hosted/deploy/docker-single-container/digitalocean) ### Insiders build diff --git a/docs/admin/deploy/index.mdx b/docs/self-hosted/deploy/index.mdx similarity index 90% rename from docs/admin/deploy/index.mdx rename to docs/self-hosted/deploy/index.mdx index e9cbe82cf..900065898 100644 --- a/docs/admin/deploy/index.mdx +++ b/docs/self-hosted/deploy/index.mdx @@ -44,11 +44,11 @@ Multi-node, self hosted solution great for large enterprises and/or other orgs l - **Kustomize** utilizes built-in features of kubectl for configuring Sourcegraph deployments - + @@ -69,7 +69,7 @@ Single-node, self hosted solution for enterprises looking for a simpler, non-Kub @@ -83,16 +83,16 @@ Machine images provide a pre-configured Sourcegraph instance that can be deploye -See [Sourcegraph Machine Images](/admin/deploy/machine-images) for more information. +See [Sourcegraph Machine Images](/self-hosted/deploy/machine-images) for more information. Deploying with machine images requires technical expertise and the ability @@ -103,7 +103,7 @@ See [Sourcegraph Machine Images](/admin/deploy/machine-images) for more informat For setting up quick **non-production** environments on-premises. -- [Docker Single Container](/admin/deploy/docker-single-container/) - Install Sourcegraph using a single Docker container +- [Docker Single Container](/self-hosted/deploy/docker-single-container/) - Install Sourcegraph using a single Docker container ### ARM / ARM64 support diff --git a/docs/admin/deploy/instance-size.mdx b/docs/self-hosted/deploy/instance-size.mdx similarity index 88% rename from docs/admin/deploy/instance-size.mdx rename to docs/self-hosted/deploy/instance-size.mdx index 70ebc3ff2..ef0af453e 100644 --- a/docs/admin/deploy/instance-size.mdx +++ b/docs/self-hosted/deploy/instance-size.mdx @@ -33,9 +33,9 @@ table. | **Provider** | **Node type** | **Boot/ephemeral disk size** | | -------------------------------------------------------------------------------------------- | ------------------------------- | ---------------------------- | -| [Amazon EKS (better than plain EC2)](/admin/deploy/kubernetes/eks) | m5.4xlarge | 100 GB (SSD preferred) | +| [Amazon EKS (better than plain EC2)](/self-hosted/deploy/kubernetes/eks) | m5.4xlarge | 100 GB (SSD preferred) | | [Google Kubernetes Engine (GKE)](https://cloud.google.com/kubernetes-engine/docs/quickstart) | n2-standard-16 | 100 GB (default) | -| [Azure](/admin/deploy/kubernetes/azure) | D16 v3 | 100 GB (SSD preferred) | +| [Azure](/self-hosted/deploy/kubernetes/azure) | D16 v3 | 100 GB (SSD preferred) | | [Other](https://kubernetes.io/docs/setup/production-environment/turnkey-solutions/) | 16 vCPU, 60 GiB memory per node | 100 GB (SSD preferred) | @@ -65,4 +65,4 @@ table. ## Resources -Please refer to our [resource estimator](/admin/deploy/resource_estimator) for more information regarding resources allocation for your Sourcegraph deployment. +Please refer to our [resource estimator](/self-hosted/deploy/resource_estimator) for more information regarding resources allocation for your Sourcegraph deployment. diff --git a/docs/admin/deploy/kubernetes/azure.mdx b/docs/self-hosted/deploy/kubernetes/azure.mdx similarity index 87% rename from docs/admin/deploy/kubernetes/azure.mdx rename to docs/self-hosted/deploy/kubernetes/azure.mdx index 1bce0e9b7..eeaefaa99 100644 --- a/docs/admin/deploy/kubernetes/azure.mdx +++ b/docs/self-hosted/deploy/kubernetes/azure.mdx @@ -1,7 +1,7 @@ # Sourcegraph with Kubernetes on Azure > WARNING: This guide applies exclusively to a Kubernetes deployment **without** Helm. -> If you have not deployed Sourcegraph yet, it is highly recommended to use Helm as it simplifies the configuration and greatly simplifies the later upgrade process. See our guidance on [using Helm to deploy to Azure AKS](/admin/deploy/kubernetes#configure-sourcegraph-on-azure-managed-kubernetes-service-aks). +> If you have not deployed Sourcegraph yet, it is highly recommended to use Helm as it simplifies the configuration and greatly simplifies the later upgrade process. See our guidance on [using Helm to deploy to Azure AKS](/self-hosted/deploy/kubernetes#configure-sourcegraph-on-azure-managed-kubernetes-service-aks). Install the [Azure CLI tool](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest) and log in: @@ -47,7 +47,7 @@ Connect to the cluster for future `kubectl` commands: az aks get-credentials --resource-group sourcegraphResourceGroup --name sourcegraphCluster ``` -Follow the [Sourcegraph cluster installation instructions](/admin/deploy/kubernetes/configure#configure-a-storage-class) with `storageClass` set to `managed-premium` in `config.json`: +Follow the [Sourcegraph cluster installation instructions](/self-hosted/deploy/kubernetes/configure#configure-a-storage-class) with `storageClass` set to `managed-premium` in `config.json`: ```diff - "storageClass": "default" diff --git a/docs/admin/deploy/kubernetes/configure.mdx b/docs/self-hosted/deploy/kubernetes/configure.mdx similarity index 96% rename from docs/admin/deploy/kubernetes/configure.mdx rename to docs/self-hosted/deploy/kubernetes/configure.mdx index 45e5b2dfc..ffac988ba 100644 --- a/docs/admin/deploy/kubernetes/configure.mdx +++ b/docs/self-hosted/deploy/kubernetes/configure.mdx @@ -4,10 +4,10 @@ This guide will demonstrate how to customize a Kubernetes deployment (**non-Helm - - + + - + @@ -82,7 +82,7 @@ components: This will allow the frontend service to discover endpoints for each service replica and communicate with them through the Kubernetes API. Note that this component should only be added if RBAC is enabled in your cluster. -If you are not using Kubernetes service discovery (for example, if you are running without RBAC or outside Kubernetes), you must manually configure service endpoints for the frontend. See [Running Sourcegraph Without Kubernetes Service Discovery](/admin/deploy/without_service_discovery) for instructions. +If you are not using Kubernetes service discovery (for example, if you are running without RBAC or outside Kubernetes), you must manually configure service endpoints for the frontend. See [Running Sourcegraph Without Kubernetes Service Discovery](/self-hosted/deploy/without_service_discovery) for instructions. --- @@ -176,14 +176,14 @@ Following these steps will allow Prometheus to successfully scrape metrics from ## Tracing -Sourcegraph supports HTTP tracing to help troubleshoot issues. See [Tracing](/admin/observability/tracing) for details. +Sourcegraph supports HTTP tracing to help troubleshoot issues. See [Tracing](/self-hosted/observability/tracing) for details. To enable tracing on your Kustomize instance, you'll need to either: 1. Deploy our bundled OpenTelemetry Collector with our bundled Jaeger backend, or 2. Deploy our bundled OpenTelemetry Collector and configure an external tracing backend -Once a tracing backend has been deployed, see our [Tracing](/admin/observability/tracing) page for next steps, including required changes to your Site Configuration to enable traces. +Once a tracing backend has been deployed, see our [Tracing](/self-hosted/observability/tracing) page for next steps, including required changes to your Site Configuration to enable traces. ### Deploy the bundled OpenTelemetry Collector and Jaeger @@ -233,7 +233,7 @@ patches: The component will update the `command` for the `otel-collector` container to `"--config=/etc/otel-collector/conf/config.yaml"`, which is now pointing to the mounted config. -See the [OpenTelemetry](/admin/observability/opentelemetry) page for details on how to configure your backend of choice. +See the [OpenTelemetry](/self-hosted/observability/opentelemetry) page for details on how to configure your backend of choice. --- @@ -273,11 +273,11 @@ This component will create a new namespace using the `namespace` value (`ns-sour ## Resources -Properly allocating resources is crucial for ensuring optimal performance of your Sourcegraph instance. To ensure this, it is recommended to use one of the provided [sizes components](#instance-size-based-resources) for resource allocation, specifically designed for your [instance size](/admin/deploy/instance-size). These components have been tested and optimized based on load test results, and are designed to work seamlessly with Sourcegraph's design and functionality. +Properly allocating resources is crucial for ensuring optimal performance of your Sourcegraph instance. To ensure this, it is recommended to use one of the provided [sizes components](#instance-size-based-resources) for resource allocation, specifically designed for your [instance size](/self-hosted/deploy/instance-size). These components have been tested and optimized based on load test results, and are designed to work seamlessly with Sourcegraph's design and functionality. ### Instance-size-based resources -To allocate resources based on your [instance size](/admin/deploy/instance-size): +To allocate resources based on your [instance size](/self-hosted/deploy/instance-size): ```yaml # instances/$INSTANCE_NAME/kustomization.yaml @@ -543,7 +543,7 @@ components: - ../../components/storage-class/name-update ``` -**Step 2**: Enter the value of your existing storage class name in your [buildConfig.yaml file](/admin/deploy/kubernetes/kustomize#buildconfig-yaml) using the `STORAGECLASS_NAME` config key +**Step 2**: Enter the value of your existing storage class name in your [buildConfig.yaml file](/self-hosted/deploy/kubernetes/kustomize#buildconfig-yaml) using the `STORAGECLASS_NAME` config key Example, add `STORAGECLASS_NAME=sourcegraph` if `sourcegraph` is the name for the existing storage class: @@ -934,7 +934,7 @@ components: ## Service mesh -There are a few [known issues](/admin/deploy/kubernetes/troubleshoot#service-mesh) when running Sourcegraph with service mesh. We recommend including the `network/envoy` component in your components list to bypass the issue where Envoy, the proxy used by Istio, breaks Sourcegraph search function by dropping proxied trailers for [HTTP/1](https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#config-core-v3-http1protocoloptions) requests. +There are a few [known issues](/self-hosted/deploy/kubernetes/troubleshoot#service-mesh) when running Sourcegraph with service mesh. We recommend including the `network/envoy` component in your components list to bypass the issue where Envoy, the proxy used by Istio, breaks Sourcegraph search function by dropping proxied trailers for [HTTP/1](https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#config-core-v3-http1protocoloptions) requests. ```yaml # instances/$INSTANCE_NAME/kustomization.yaml @@ -1020,7 +1020,7 @@ patches: ## External services -You can use an external or managed version of PostgreSQL and Redis with your Sourcegraph instance. For detailed information as well as the requirements for each service, please see our docs on [using external services with Sourcegraph](/admin/external_services/). +You can use an external or managed version of PostgreSQL and Redis with your Sourcegraph instance. For detailed information as well as the requirements for each service, please see our docs on [using external services with Sourcegraph](/self-hosted/external_services/). ### External Secrets @@ -1056,7 +1056,7 @@ Similar changes will be required for other pods and services, depending on the s ### External Postgres -For optimal performance and resilience, it is recommended to use an external database when deploying Sourcegraph. For more information on database requirements, please refer to the [Postgres guide](/admin/postgres). +For optimal performance and resilience, it is recommended to use an external database when deploying Sourcegraph. For more information on database requirements, please refer to the [Postgres guide](/self-hosted/postgres). To connect Sourcegraph to an existing PostgreSQL instance, add the relevant environment variables ([such as PGHOST, PGPORT, PGUSER, etc.](http://www.postgresql.org/docs/current/static/libpq-envars.html)) to the frontend ConfigMap by adding the new environment variables to the end of the _FRONTEND ENV VARS_ section at the bottom of your [kustomization file](/admin/deploy/kubernetes/kustomize/#kustomizationyaml). For example: @@ -1312,4 +1312,4 @@ When working with an [Internet Gateway](http://docs.aws.amazon.com/AmazonVPC/lat ## Troubleshooting -See the [Troubleshooting docs](/admin/deploy/kubernetes/troubleshoot). +See the [Troubleshooting docs](/self-hosted/deploy/kubernetes/troubleshoot). diff --git a/docs/admin/deploy/kubernetes/eks.mdx b/docs/self-hosted/deploy/kubernetes/eks.mdx similarity index 96% rename from docs/admin/deploy/kubernetes/eks.mdx rename to docs/self-hosted/deploy/kubernetes/eks.mdx index 3c9ce73f6..c939f90f6 100644 --- a/docs/admin/deploy/kubernetes/eks.mdx +++ b/docs/self-hosted/deploy/kubernetes/eks.mdx @@ -2,7 +2,7 @@ [Amazon EKS](https://aws.amazon.com/eks/) is Amazon's managed Kubernetes offering, similar to how Google Cloud offers managed Kubernetes clusters (GKE). -> WARNING: This guide applies exclusively to a Kubernetes deployment **without** Helm. If you have not deployed Sourcegraph yet, it is higly recommended to use Helm as it simplifies the configuration and greatly simplifies the later upgrade process. See our guidance on [using Helm to deploy to Amazon EKS](/admin/deploy/kubernetes#configure-sourcegraph-on-elastic-kubernetes-service-eks). +> WARNING: This guide applies exclusively to a Kubernetes deployment **without** Helm. If you have not deployed Sourcegraph yet, it is higly recommended to use Helm as it simplifies the configuration and greatly simplifies the later upgrade process. See our guidance on [using Helm to deploy to Amazon EKS](/self-hosted/deploy/kubernetes#configure-sourcegraph-on-elastic-kubernetes-service-eks). If your preferred cloud provider is Amazon, we strongly recommend using EKS instead of plain EC2. By using EKS, you will not need to manage your own Kubernetes control plane (complex). Instead, Amazon will provide it for you and you will only be responsible for managing the [NodeGroups](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html) and the Sourcegraph deployment running on the Kubernetes cluster. @@ -97,4 +97,4 @@ Your Kubernetes cluster is now all set up and running! Luckily, deploying Sourcegraph on your cluster is much easier and quicker than the above steps. :) -Follow our [installation documentation](/admin/deploy/kubernetes/) to continue. +Follow our [installation documentation](/self-hosted/deploy/kubernetes/) to continue. diff --git a/docs/admin/deploy/kubernetes/index.mdx b/docs/self-hosted/deploy/kubernetes/index.mdx similarity index 96% rename from docs/admin/deploy/kubernetes/index.mdx rename to docs/self-hosted/deploy/kubernetes/index.mdx index f37bfad36..a8e0ae5d3 100644 --- a/docs/admin/deploy/kubernetes/index.mdx +++ b/docs/self-hosted/deploy/kubernetes/index.mdx @@ -33,7 +33,7 @@ Our Helm chart has a lot of sensible defaults baked into the values.yaml so that 1. Prepare any required customizations - Most environments will likely require some customizations to the default Helm chart values. See _[Configuration](#configuration)_ for more information. -- Additionally, resource allocations for individual services may need to be adjusted. See our _[Resource Estimator](/admin/deploy/resource_estimator)_ for more information. +- Additionally, resource allocations for individual services may need to be adjusted. See our _[Resource Estimator](/self-hosted/deploy/resource_estimator)_ for more information. 2. Review the customized Helm chart @@ -107,7 +107,7 @@ When making configuration changes, it's recommended to review the changes that w #### Using external PostgreSQL databases -To use external PostgreSQL databases, first review our [general recommendations](/admin/external_services/postgres#using-your-own-postgresql-server) and [required postgres permissions](/admin/external_services/postgres#postgres-permissions-and-database-migrations). +To use external PostgreSQL databases, first review our [general recommendations](/self-hosted/external_services/postgres#using-your-own-postgresql-server) and [required postgres permissions](/self-hosted/external_services/postgres#postgres-permissions-and-database-migrations). We recommend storing the credentials in [Secrets] created outside the helm chart and managed in a secure manner. Each database requires its own Secret and should follow the following format. The Secret name can be customized as desired: @@ -191,7 +191,7 @@ pgsql: #### Using external Redis instances -To use external Redis instances, first review our [general recommendations](/admin/external_services/redis). +To use external Redis instances, first review our [general recommendations](/self-hosted/external_services/redis). If your external Redis instances do not require authentication, you can configure access in your [override.yaml](https://github.com/sourcegraph/deploy-sourcegraph-helm/blob/main/charts/sourcegraph/examples/external-redis/override.yaml) with the `endpoint` settings: @@ -245,14 +245,14 @@ The [using your own Redis](https://github.com/sourcegraph/deploy-sourcegraph-hel #### Using external Object Storage -To use an external Object Storage service (S3-compatible services, or GCS), first review our [general recommendations](/admin/external_services/object_storage). Then review the following example and adjust to your use case. +To use an external Object Storage service (S3-compatible services, or GCS), first review our [general recommendations](/self-hosted/external_services/object_storage). Then review the following example and adjust to your use case. See [override.yaml](https://github.com/sourcegraph/deploy-sourcegraph-helm/tree/main/charts/sourcegraph/examples/external-object-storage/override.yaml) for an example override file. The example assumes the use of AWS S3. You may configure the environment variables accordingly for your own use case based - on our [general recommendations](/admin/external_services/object_storage). + on our [general recommendations](/self-hosted/external_services/object_storage). If you provide credentials with an access key / secret key, we recommend storing the credentials in [Secrets] created outside the helm chart and managed in a secure manner. An example Secret is shown here: @@ -381,14 +381,14 @@ More details on how to create and configure a subchart can be found in the [helm ### Tracing -Sourcegraph supports HTTP tracing to help troubleshoot issues. See [Tracing](/admin/observability/tracing) for details. +Sourcegraph supports HTTP tracing to help troubleshoot issues. See [Tracing](/self-hosted/observability/tracing) for details. To enable tracing on your Helm instance, you'll need to either: 1. Deploy our bundled Jaeger backend, or 2. Configure an external tracing backend -Once a tracing backend has been deployed, see our [Tracing](/admin/observability/tracing) page for next steps, including required changes to your Site Configuration to enable traces. +Once a tracing backend has been deployed, see our [Tracing](/self-hosted/observability/tracing) page for next steps, including required changes to your Site Configuration to enable traces. #### Enable the bundled Jaeger deployment @@ -403,7 +403,7 @@ jaeger: To configure the bundled otel-collector to export traces to an external OTel-compatible backend, you you can customize the otel-collector's config file directly in your Helm values `override.yaml` file. -For the specific configurations to set, see our [OpenTelemetry](/admin/observability/opentelemetry) page. +For the specific configurations to set, see our [OpenTelemetry](/self-hosted/observability/opentelemetry) page. ```yaml openTelemetry: @@ -470,7 +470,7 @@ openTelemetry: #### Configure trace sampling -Review the [trace sampling](/admin/observability/opentelemetry#sampling-traces) documentation, and the [opentelemetry-exporter/override-processor.yaml](https://github.com/sourcegraph/deploy-sourcegraph-helm/tree/main/charts/sourcegraph/examples/opentelemetry-exporter/override-processor.yaml) example, then add the configs to your Helm values override file: +Review the [trace sampling](/self-hosted/observability/opentelemetry#sampling-traces) documentation, and the [opentelemetry-exporter/override-processor.yaml](https://github.com/sourcegraph/deploy-sourcegraph-helm/tree/main/charts/sourcegraph/examples/opentelemetry-exporter/override-processor.yaml) example, then add the configs to your Helm values override file: ```yaml openTelemetry: @@ -964,10 +964,10 @@ Now the deployment is complete. More information on configuring the Sourcegraph ## Upgrading Sourcegraph -The following procedures describe the process to update a Helm Sourcegraph instance. If you are unfamiliar with sourcegraph versioning or releases see our [general concepts documentation](/admin/updates/). +The following procedures describe the process to update a Helm Sourcegraph instance. If you are unfamiliar with sourcegraph versioning or releases see our [general concepts documentation](/self-hosted/updates/). - Always consult the [release notes](/admin/updates/kubernetes) for the + Always consult the [release notes](/self-hosted/updates/kubernetes) for the versions your upgrade will pass over and end on. @@ -1016,7 +1016,7 @@ When all pods have restarted and show as Running, you can browse to your Sourceg **Step 1:** Check Upgrade Readiness: -- Check the [upgrade notes](/admin/updates/kubernetes#kubernetes-upgrade-notes) for the version range you're passing through. +- Check the [upgrade notes](/self-hosted/updates/kubernetes#kubernetes-upgrade-notes) for the version range you're passing through. - Check the `Site Admin > Updates` page to determine [upgrade readiness](/admin/updates/#upgrade-readiness). **Step 2:** @@ -1030,7 +1030,7 @@ When all pods have restarted and show as Running, you can browse to your Sourceg `v5.11.6271` and then use the standard upgrade procedure to get to their target version. This is because migrator in all versions from `v6.0.0` onwards will no longer connect to Postgres 12 databases. For more info see - our [PostgreSQL upgrade docs](/admin/postgres#requirements). + our [PostgreSQL upgrade docs](/self-hosted/postgres#requirements). @@ -1097,7 +1097,7 @@ TEST SUITE: None ✅ Schema migrations complete ``` -You can learn more about running migrator operations in helm in the [migrator operations doc](/admin/updates/migrator/migrator-operations#kubernetes-helm). +You can learn more about running migrator operations in helm in the [migrator operations doc](/self-hosted/updates/migrator/migrator-operations#kubernetes-helm). **Step 4:** **Upgrade your instance via `helm upgrade`** @@ -1115,7 +1115,7 @@ You can revert to a previous version with the following command: $ helm rollback sourcegraph ``` -If you are rolling back more than a single version, then you must also [roll back your database](/admin/how-to/rollback_database), as database migrations (which may have run at some point during the upgrade) are guaranteed to be compatible with one previous minor version. +If you are rolling back more than a single version, then you must also [roll back your database](/self-hosted/how-to/rollback_database), as database migrations (which may have run at some point during the upgrade) are guaranteed to be compatible with one previous minor version. ### Database Migrations diff --git a/docs/admin/deploy/kubernetes/kustomize.mdx b/docs/self-hosted/deploy/kubernetes/kustomize.mdx similarity index 81% rename from docs/admin/deploy/kubernetes/kustomize.mdx rename to docs/self-hosted/deploy/kubernetes/kustomize.mdx index 82cc2e745..7a389f1e6 100644 --- a/docs/admin/deploy/kubernetes/kustomize.mdx +++ b/docs/self-hosted/deploy/kubernetes/kustomize.mdx @@ -28,7 +28,7 @@ Below is an overview of installing Sourcegraph on Kubernetes using Kustomize. If your Sourcegraph version is older than `v4.5.0` or hasn't - [migrated](/admin/deploy/kubernetes/kustomize/migrate) to + [migrated](/self-hosted/deploy/kubernetes/kustomize/migrate) to [`deploy-sourcegraph-k8s`](https://github.com/sourcegraph/deploy-sourcegraph-k8s), please refer to the [legacy deployment docs for Kubernetes](https://docs.sourcegraph.com/@v4.4.2/admin/deploy/kubernetes). @@ -38,7 +38,7 @@ Below is an overview of installing Sourcegraph on Kubernetes using Kustomize. Create a release branch from the default branch (or [an available tag](https://github.com/sourcegraph/deploy-sourcegraph-k8s/tags)) in your local fork of the [deploy-sourcegraph-k8s](https://github.com/sourcegraph/deploy-sourcegraph-k8s) repository. -See the [docs on reference repository](/admin/deploy/repositories) for detailed instructions on creating a local fork. +See the [docs on reference repository](/self-hosted/deploy/repositories) for detailed instructions on creating a local fork. ```bash # Recommended: replace the URL with your private fork @@ -107,7 +107,7 @@ components: - ../../components/storage-class/gke ``` -See our [configurations guide](/admin/deploy/kubernetes/configure) for the full list of available storage class components. +See our [configurations guide](/self-hosted/deploy/kubernetes/configure) for the full list of available storage class components. #### Option 2: Use an existing storage class @@ -203,26 +203,26 @@ After the initial deployment, additional configuration might be required for Sou Common configurations that are strongly recommended for all Sourcegraph deployments: -- [Enable the Sourcegraph monitoring stack](/admin/deploy/kubernetes/configure#monitoring-stack) -- [Enable tracing](/admin/deploy/kubernetes/configure#tracing) -- [Adjust resource allocations](/admin/deploy/kubernetes/configure#instance-size-based-resources) -- [Adjust storage sizes](/admin/deploy/kubernetes/configure#adjust-storage-sizes) -- [Configure ingress](/admin/deploy/kubernetes/configure#ingress) -- [Enable TLS](/admin/deploy/kubernetes/configure#tls) +- [Enable the Sourcegraph monitoring stack](/self-hosted/deploy/kubernetes/configure#monitoring-stack) +- [Enable tracing](/self-hosted/deploy/kubernetes/configure#tracing) +- [Adjust resource allocations](/self-hosted/deploy/kubernetes/configure#instance-size-based-resources) +- [Adjust storage sizes](/self-hosted/deploy/kubernetes/configure#adjust-storage-sizes) +- [Configure ingress](/self-hosted/deploy/kubernetes/configure#ingress) +- [Enable TLS](/self-hosted/deploy/kubernetes/configure#tls) Other common configurations include: -- [Set up an external PostgreSQL Database](/admin/deploy/kubernetes/configure#external-postgres) -- [Set up SSH connection for cloning repositories](/admin/deploy/kubernetes/configure#ssh-for-cloning) +- [Set up an external PostgreSQL Database](/self-hosted/deploy/kubernetes/configure#external-postgres) +- [Set up SSH connection for cloning repositories](/self-hosted/deploy/kubernetes/configure#ssh-for-cloning) -See the [configuration guide for Kustomize](/admin/deploy/kubernetes/configure) for more configuration options. +See the [configuration guide for Kustomize](/self-hosted/deploy/kubernetes/configure) for more configuration options. ## Learn more -- [Scaling Sourcegraph on Kubernetes](/admin/deploy/kubernetes/scale) +- [Scaling Sourcegraph on Kubernetes](/self-hosted/deploy/kubernetes/scale) - Examples of deploying Sourcegraph to the cloud provider listed below: -- [Amazon EKS](/admin/deploy/kubernetes/kustomize/eks) -- [Google GKE](/admin/deploy/kubernetes/kustomize/gke) -- [Migration guide](/admin/deploy/kubernetes/kustomize/migrate) on migrating from [deploy-sourcegraph](https://github.com/sourcegraph/deploy-sourcegraph) to [deploy-sourcegraph-k8s](https://github.com/sourcegraph/deploy-sourcegraph-k8s) -- [Other deployment options](/admin/deploy/) -- [Troubleshooting](/admin/deploy/kubernetes/troubleshoot) +- [Amazon EKS](/self-hosted/deploy/kubernetes/kustomize/eks) +- [Google GKE](/self-hosted/deploy/kubernetes/kustomize/gke) +- [Migration guide](/self-hosted/deploy/kubernetes/kustomize/migrate) on migrating from [deploy-sourcegraph](https://github.com/sourcegraph/deploy-sourcegraph) to [deploy-sourcegraph-k8s](https://github.com/sourcegraph/deploy-sourcegraph-k8s) +- [Other deployment options](/self-hosted/deploy/) +- [Troubleshooting](/self-hosted/deploy/kubernetes/troubleshoot) diff --git a/docs/admin/deploy/kubernetes/kustomize/eks.mdx b/docs/self-hosted/deploy/kubernetes/kustomize/eks.mdx similarity index 98% rename from docs/admin/deploy/kubernetes/kustomize/eks.mdx rename to docs/self-hosted/deploy/kubernetes/kustomize/eks.mdx index cf0af962a..0f960eedd 100644 --- a/docs/admin/deploy/kubernetes/kustomize/eks.mdx +++ b/docs/self-hosted/deploy/kubernetes/kustomize/eks.mdx @@ -99,7 +99,7 @@ Once you have created a new overlay using the kustomization file from our quick- - create a DNS A record for your Sourcegraph instance domain - enable TLS is highly recommended. -If you would like to enable TLS with your own certificate, please read the [TLS configuration guide](/admin/deploy/kubernetes/configure#tls) for detailed instructions. +If you would like to enable TLS with your own certificate, please read the [TLS configuration guide](/self-hosted/deploy/kubernetes/configure#tls) for detailed instructions. ##### AWS-managed certificate diff --git a/docs/admin/deploy/kubernetes/kustomize/gke.mdx b/docs/self-hosted/deploy/kubernetes/kustomize/gke.mdx similarity index 96% rename from docs/admin/deploy/kubernetes/kustomize/gke.mdx rename to docs/self-hosted/deploy/kubernetes/kustomize/gke.mdx index 7d243028e..4cc9998eb 100644 --- a/docs/admin/deploy/kubernetes/kustomize/gke.mdx +++ b/docs/self-hosted/deploy/kubernetes/kustomize/gke.mdx @@ -102,7 +102,7 @@ Once you have created a new overlay using the kustomization file from our exampl - create a DNS A record for your Sourcegraph instance domain - enable TLS is highly recommended. -If you would like to enable TLS with your own certificate, please read the [TLS configuration guide](/admin/deploy/kubernetes/configure#tls) for detailed instructions. +If you would like to enable TLS with your own certificate, please read the [TLS configuration guide](/self-hosted/deploy/kubernetes/configure#tls) for detailed instructions. ##### Google-managed certificate @@ -125,7 +125,7 @@ components: - ../../components/clusters/gke/managed-cert ``` -Step 2: Set the `GKE_MANAGED_CERT_NAME` variable with your Google-managed certificate name under the [BUILD CONFIGURATIONS](/admin/deploy/kubernetes/kustomize#buildconfig-yaml) section: +Step 2: Set the `GKE_MANAGED_CERT_NAME` variable with your Google-managed certificate name under the [BUILD CONFIGURATIONS](/self-hosted/deploy/kubernetes/kustomize#buildconfig-yaml) section: ```yaml # instances/$INSTANCE_NAME/buildConfig.yaml diff --git a/docs/admin/deploy/kubernetes/kustomize/index.mdx b/docs/self-hosted/deploy/kubernetes/kustomize/index.mdx similarity index 92% rename from docs/admin/deploy/kubernetes/kustomize/index.mdx rename to docs/self-hosted/deploy/kubernetes/kustomize/index.mdx index d7e68bbdd..b6ebcd268 100644 --- a/docs/admin/deploy/kubernetes/kustomize/index.mdx +++ b/docs/self-hosted/deploy/kubernetes/kustomize/index.mdx @@ -116,7 +116,7 @@ All custom overlays built for a specific instance should be stored in the [insta ### kustomization.yaml -The [kustomization.yaml file](#kustomization-yaml) is a fundamental element of a Kustomize overlay. It is situated in the root directory of the overlay and serves as a means of customizing and configuring the resources defined in the base manifests, as outlined in our [configuration documentation](/admin/deploy/kubernetes/configure). +The [kustomization.yaml file](#kustomization-yaml) is a fundamental element of a Kustomize overlay. It is situated in the root directory of the overlay and serves as a means of customizing and configuring the resources defined in the base manifests, as outlined in our [configuration documentation](/self-hosted/deploy/kubernetes/configure). To correctly configure your Sourcegraph deployment, it is crucial to create an overlay using the `kustomization.template.yaml` file provided. This [kustomization.yaml file](#kustomization-yaml) is specifically designed for Sourcegraph deployments, making the configuration process more manageable. The file includes various options and sections, allowing for the creation of a Sourcegraph instance that is tailored to the specific environment. @@ -128,7 +128,7 @@ The order of components in the [kustomization.template.yaml file](#kustomization Some Kustomize components may require additional configuration. These inputs typically specify environment/use-case-specific settings. For example, the name of your private registry to update images. Only update the values inside the `buildConfig.yaml` file if a component's documentation explicitly instructs you to do so. Not all components need extra configuration, and some have suitable defaults. -Modifying `buildConfig.yaml` unnecessarily can cause errors or unintended behavior. Always check the [configuration docs](/admin/deploy/kubernetes/configure) or comments in [kustomization.yaml](#kustomization-yaml) before changing this file. +Modifying `buildConfig.yaml` unnecessarily can cause errors or unintended behavior. Always check the [configuration docs](/self-hosted/deploy/kubernetes/configure) or comments in [kustomization.yaml](#kustomization-yaml) before changing this file. ### patches directory @@ -184,7 +184,7 @@ Rename the [buildConfig.template.yaml](#buildconfig-yaml) file in `instances/$IN $ mv instances/template/buildConfig.template.yaml instances/$INSTANCE_NAME/buildConfig.yaml ``` -**Step 3**: You can begin customizing your Sourcegraph deployment by updating the [kustomization.yaml file](#kustomization-yaml) inside your overlay, following our [configuration guides](/admin/deploy/kubernetes/configure) for guidance. +**Step 3**: You can begin customizing your Sourcegraph deployment by updating the [kustomization.yaml file](#kustomization-yaml) inside your overlay, following our [configuration guides](/self-hosted/deploy/kubernetes/configure) for guidance. ## Components @@ -194,7 +194,7 @@ Most of our components are designed to be reusable for different environments an ### Rule of thumbs -It is important to understand how each component covered in the [configuration guide](/admin/deploy/kubernetes/configure) is used to configure your Sourcegraph deployment. Each component has specific configuration options and settings that need to be configured correctly in order for your deployment to function properly. By reading the details and understanding how each component is used, you can make informed decisions about which components to enable or disable in your overlay file, and how to configure them to meet your needs. It also helps to learn how to troubleshoot if something goes wrong. +It is important to understand how each component covered in the [configuration guide](/self-hosted/deploy/kubernetes/configure) is used to configure your Sourcegraph deployment. Each component has specific configuration options and settings that need to be configured correctly in order for your deployment to function properly. By reading the details and understanding how each component is used, you can make informed decisions about which components to enable or disable in your overlay file, and how to configure them to meet your needs. It also helps to learn how to troubleshoot if something goes wrong. Here are some **rule of thumbs** to follow when combining different components to ensure that they work together seamlessly and avoid any conflicts: @@ -248,7 +248,7 @@ $ kubectl kustomize https://github.com/sourcegraph/deploy-sourcegraph-k8s/exampl ## Kustomize with Helm -Kustomize can be used in conjunction with Helm to configure Sourcegraph, as outlined in [this guidance](/admin/deploy/kubernetes#integrate-kustomize-with-helm-chart). However, this approach is only recommended as a temporary workaround while Sourcegraph adds support for previously unsupported customizations in its Helm chart. This means that using Kustomize with Helm is not a long-term solution. +Kustomize can be used in conjunction with Helm to configure Sourcegraph, as outlined in [this guidance](/self-hosted/deploy/kubernetes#integrate-kustomize-with-helm-chart). However, this approach is only recommended as a temporary workaround while Sourcegraph adds support for previously unsupported customizations in its Helm chart. This means that using Kustomize with Helm is not a long-term solution. ## Deprecated diff --git a/docs/admin/deploy/kubernetes/kustomize/migrate.mdx b/docs/self-hosted/deploy/kubernetes/kustomize/migrate.mdx similarity index 88% rename from docs/admin/deploy/kubernetes/kustomize/migrate.mdx rename to docs/self-hosted/deploy/kubernetes/kustomize/migrate.mdx index 60ee2798b..1a34ebb33 100644 --- a/docs/admin/deploy/kubernetes/kustomize/migrate.mdx +++ b/docs/self-hosted/deploy/kubernetes/kustomize/migrate.mdx @@ -36,11 +36,11 @@ The goal of this migration process is to create a new overlay that will generate ## Step 1: Upgrade current instance with the old repository -Upgrade your current instance to the latest version of Sourcegraph (must be 4.5.0 or above) following the [standard upgrade process](/admin/deploy/kubernetes/upgrade#standard-upgrades) for the repository ([deploy-sourcegraph](https://github.com/sourcegraph/deploy-sourcegraph)) your instance was deployed with. +Upgrade your current instance to the latest version of Sourcegraph (must be 4.5.0 or above) following the [standard upgrade process](/self-hosted/deploy/kubernetes/upgrade#standard-upgrades) for the repository ([deploy-sourcegraph](https://github.com/sourcegraph/deploy-sourcegraph)) your instance was deployed with. ### From Privileged to Non-privileged -Sourcegraph's deployment mode changed from privileged (containers run as root) to non-privileged (containers run as non-root) as the default in the new Kustomize setup. If your instance is currently running in privileged mode and you want to upgrade to `non-privileged` mode, use the [migrate-to-nonprivileged overlay](https://github.com/sourcegraph/deploy-sourcegraph/tree/master/overlays/migrate-to-nonprivileged) from the Sourcegraph [deploy-sourcegraph](https://github.com/sourcegraph/deploy-sourcegraph) repository when following the [standard upgrade process](/admin/deploy/kubernetes/upgrade#standard-upgrades) to perform your upgrade. +Sourcegraph's deployment mode changed from privileged (containers run as root) to non-privileged (containers run as non-root) as the default in the new Kustomize setup. If your instance is currently running in privileged mode and you want to upgrade to `non-privileged` mode, use the [migrate-to-nonprivileged overlay](https://github.com/sourcegraph/deploy-sourcegraph/tree/master/overlays/migrate-to-nonprivileged) from the Sourcegraph [deploy-sourcegraph](https://github.com/sourcegraph/deploy-sourcegraph) repository when following the [standard upgrade process](/self-hosted/deploy/kubernetes/upgrade#standard-upgrades) to perform your upgrade. > NOTE: Applying the [migrate-to-nonprivileged overlay](https://github.com/sourcegraph/deploy-sourcegraph/tree/master/overlays/migrate-to-nonprivileged) will convert your deployment to run in non-privileged mode @@ -157,21 +157,21 @@ resources: ## Step 8: Recreate instance resources -Follow our [configuration guide](/admin/deploy/kubernetes/configure) to recreate your running instance with the provided components. +Follow our [configuration guide](/self-hosted/deploy/kubernetes/configure) to recreate your running instance with the provided components. It is recommended to refrain from introducing any changes to the characteristics of a running Kubernetes cluster during a migration. For example, if the cluster is currently running in privileged mode with root user access, deploying the instance in non-privileized mode could cause permission errors. Ensure the following configurations are present/ consistent for your Sourcegraph instance during migrations: -- [Storage size for all services](/admin/deploy/kubernetes/configure#adjust-storage-sizes) -- [Permission settings](/admin/deploy/kubernetes/configure#base-cluster) (privileged or non-privileged mode) -- [Networking](/admin/deploy/kubernetes/configure#network-access) -- [Ingress](/admin/deploy/kubernetes/configure#ingress) -- [Storage class](/admin/deploy/kubernetes/configure#storage-class) -- [Storage class name](/admin/deploy/kubernetes/configure#update-storageclassname) -- [Namespace](/admin/deploy/kubernetes/configure#namespace) -- [cAdvisor](/admin/deploy/kubernetes/configure#deploy-cadvisor) -- [Tracing services](/admin/deploy/kubernetes/configure#tracing) (OpenTelemetry and Jaeger for example) +- [Storage size for all services](/self-hosted/deploy/kubernetes/configure#adjust-storage-sizes) +- [Permission settings](/self-hosted/deploy/kubernetes/configure#base-cluster) (privileged or non-privileged mode) +- [Networking](/self-hosted/deploy/kubernetes/configure#network-access) +- [Ingress](/self-hosted/deploy/kubernetes/configure#ingress) +- [Storage class](/self-hosted/deploy/kubernetes/configure#storage-class) +- [Storage class name](/self-hosted/deploy/kubernetes/configure#update-storageclassname) +- [Namespace](/self-hosted/deploy/kubernetes/configure#namespace) +- [cAdvisor](/self-hosted/deploy/kubernetes/configure#deploy-cadvisor) +- [Tracing services](/self-hosted/deploy/kubernetes/configure#tracing) (OpenTelemetry and Jaeger for example) If you have previously made changes directly to the files inside [the base directory](https://github.com/sourcegraph/deploy-sourcegraph/tree/master/base), please convert these changes into [patches](https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/patches/) before adding them to your `kustomization.yaml` file as patches. @@ -189,7 +189,7 @@ components: The default cluster now runs in non-privileged mode. -If your instance was deployed using the non-privileged overlay, you can follow the [configuration guide](/admin/deploy/kubernetes/configure) without adding the `clusters/old-base` component. +If your instance was deployed using the non-privileged overlay, you can follow the [configuration guide](/self-hosted/deploy/kubernetes/configure) without adding the `clusters/old-base` component. ## Step 9: Build and review new manifests diff --git a/docs/admin/deploy/kubernetes/operations.mdx b/docs/self-hosted/deploy/kubernetes/operations.mdx similarity index 92% rename from docs/admin/deploy/kubernetes/operations.mdx rename to docs/self-hosted/deploy/kubernetes/operations.mdx index 97a1645e0..1495fcdce 100644 --- a/docs/admin/deploy/kubernetes/operations.mdx +++ b/docs/self-hosted/deploy/kubernetes/operations.mdx @@ -1,12 +1,12 @@ # Operations guides for Sourcegraph on Kubernetes -Operations guides specific to managing [Sourcegraph on Kubernetes](/admin/deploy/kubernetes/) installations. +Operations guides specific to managing [Sourcegraph on Kubernetes](/self-hosted/deploy/kubernetes/) installations. - - - + + + @@ -17,13 +17,13 @@ Trying to deploy Sourcegraph on Kubernetes? Refer to our [installation guide](/a ## Configure -We strongly recommend referring to our [Configuration guide](/admin/deploy/kubernetes/configure) to learn about how to configure your Sourcegraph with Kubernetes instance. +We strongly recommend referring to our [Configuration guide](/self-hosted/deploy/kubernetes/configure) to learn about how to configure your Sourcegraph with Kubernetes instance. ## Deploy -Refer to our [installation guide](/admin/deploy/kubernetes/) for details on how to deploy Sourcegraph. +Refer to our [installation guide](/self-hosted/deploy/kubernetes/) for details on how to deploy Sourcegraph. -Migrating from another [deployment type](/admin/deploy/)? Refer to our [migration guides](/admin/deploy/migrate-backup). +Migrating from another [deployment type](/self-hosted/deploy/)? Refer to our [migration guides](/self-hosted/deploy/migrate-backup). ## Deploy with Kustomize @@ -31,7 +31,7 @@ In order to deploy Sourcegraph that is configured for your cluster: #### Building manifests -Build a new set of manifests using an overlay you've created following our [configuration guide for Kustomize](/admin/deploy/kubernetes/kustomize/): +Build a new set of manifests using an overlay you've created following our [configuration guide for Kustomize](/self-hosted/deploy/kubernetes/kustomize/): ```bash $ kubectl kustomize $PATH_TO_OVERLAY -o cluster.yaml @@ -436,13 +436,13 @@ worker ClusterIP 10.72.7.72 3189/TC ## Migrate to Kustomize -See the [migration docs for Kustomize](/admin/deploy/kubernetes/kustomize/migrate) for more information. +See the [migration docs for Kustomize](/self-hosted/deploy/kubernetes/kustomize/migrate) for more information. ## Upgrade -- See the [Updating Sourcegraph docs](/admin/updates/) on how to upgrade.
-- See the [Updating a Kubernetes Sourcegraph instance docs](/admin/deploy/kubernetes/upgrade) for details on changes in each version to determine if manual migration steps are necessary. +- See the [Updating Sourcegraph docs](/self-hosted/updates/) on how to upgrade.
+- See the [Updating a Kubernetes Sourcegraph instance docs](/self-hosted/deploy/kubernetes/upgrade) for details on changes in each version to determine if manual migration steps are necessary. ## Troubleshoot -See the [Troubleshooting docs](/admin/deploy/kubernetes/troubleshoot). +See the [Troubleshooting docs](/self-hosted/deploy/kubernetes/troubleshoot). diff --git a/docs/admin/deploy/kubernetes/scale.mdx b/docs/self-hosted/deploy/kubernetes/scale.mdx similarity index 89% rename from docs/admin/deploy/kubernetes/scale.mdx rename to docs/self-hosted/deploy/kubernetes/scale.mdx index df5eda71a..26c739117 100644 --- a/docs/admin/deploy/kubernetes/scale.mdx +++ b/docs/self-hosted/deploy/kubernetes/scale.mdx @@ -2,11 +2,11 @@ Sourcegraph can scale to accommodate large codebases and many users. -Increase resources according to the [Scaling Overview per Service](/admin/deploy/scale) if you notice slower search or navigation. +Increase resources according to the [Scaling Overview per Service](/self-hosted/deploy/scale) if you notice slower search or navigation. ## Cluster resource guidelines -For production environments, we recommend allocate resources based on your [instance size](/admin/deploy/instance-size). See our [resource estimator](/admin/deploy/resource_estimator) for estimates. +For production environments, we recommend allocate resources based on your [instance size](/self-hosted/deploy/instance-size). See our [resource estimator](/self-hosted/deploy/resource_estimator) for estimates. --- @@ -26,7 +26,7 @@ Notes: - If your change requires restarting `gitserver` pods and they are rescheduled to other nodes, they may go offline briefly (showing a `Multi-Attach` error). This is due to volume detach/reattach. [Contact us](https://about.sourcegraph.com/contact/) for mitigation steps depending on your cloud provider. - See the docs to understand each service's role: - [Sourcegraph Architecture Overview](https://docs-legacy.sourcegraph.com/dev/background-information/architecture) - - [Scaling Overview per Service](/admin/deploy/scale) + - [Scaling Overview per Service](/self-hosted/deploy/scale) --- diff --git a/docs/admin/deploy/kubernetes/troubleshoot.mdx b/docs/self-hosted/deploy/kubernetes/troubleshoot.mdx similarity index 94% rename from docs/admin/deploy/kubernetes/troubleshoot.mdx rename to docs/self-hosted/deploy/kubernetes/troubleshoot.mdx index 7849378db..4bd6306c4 100644 --- a/docs/admin/deploy/kubernetes/troubleshoot.mdx +++ b/docs/self-hosted/deploy/kubernetes/troubleshoot.mdx @@ -1,8 +1,8 @@ # Troubleshoot Sourcegraph with Kubernetes -If [Sourcegraph with Kubernetes](/admin/deploy/kubernetes/) does not start up or shows unexpected behavior, there are a variety of ways you can determine the root cause of the failure. +If [Sourcegraph with Kubernetes](/self-hosted/deploy/kubernetes/) does not start up or shows unexpected behavior, there are a variety of ways you can determine the root cause of the failure. -See our [operations guide](/admin/deploy/kubernetes/operations) for more useful commands and operations. +See our [operations guide](/self-hosted/deploy/kubernetes/operations) for more useful commands and operations. ## Common errors @@ -34,7 +34,7 @@ Run `kubectl version` to verify the **Client Version** matches the **Server Vers Run `kubectl get ingresses -A` to check if there is more than one ingress for `sourcegraph-frontend`. You can delete the duplicate with `kubectl delete ingress sourcegraph-frontend --namespace $YOUR_NAMESPACE` -> NOTE: See our ["configuration guide"](/admin/deploy/kubernetes/configure#security-configure-network-access) for more information on network access. +> NOTE: See our ["configuration guide"](/self-hosted/deploy/kubernetes/configure#security-configure-network-access) for more information on network access. #### Error: error when creating "base/cadvisor/cadvisor.ClusterRoleBinding.yaml": subjects[0].namespace: Required value @@ -67,7 +67,7 @@ Alternatively, you can wait until the rate limits are reset. #### Irrelevant cAdvisor metrics are causing strange alerts and performance issues. This is most likely due to cAdvisor picking up other metrics from the cluster. -A workaround is available: [Filtering cAdvisor metrics](/admin/deploy/kubernetes/configure#filtering-cadvisor-metrics). +A workaround is available: [Filtering cAdvisor metrics](/self-hosted/deploy/kubernetes/configure#filtering-cadvisor-metrics). #### I don't see any metrics on my Grafana Dashboard. diff --git a/docs/admin/deploy/kubernetes/upgrade.mdx b/docs/self-hosted/deploy/kubernetes/upgrade.mdx similarity index 86% rename from docs/admin/deploy/kubernetes/upgrade.mdx rename to docs/self-hosted/deploy/kubernetes/upgrade.mdx index 4761383c5..efb75e2a0 100644 --- a/docs/admin/deploy/kubernetes/upgrade.mdx +++ b/docs/self-hosted/deploy/kubernetes/upgrade.mdx @@ -1,13 +1,13 @@ # Updating Sourcegraph with Kubernetes -This document describes the process to update a **Kubernetes Kustomize** or **Kubernetes Legacy** Sourcegraph instance. If you are unfamiliar with Sourcegraph versioning or releases see our [general concepts documentation](/admin/updates/). +This document describes the process to update a **Kubernetes Kustomize** or **Kubernetes Legacy** Sourcegraph instance. If you are unfamiliar with Sourcegraph versioning or releases see our [general concepts documentation](/self-hosted/updates/). -This guide is **not for use with Helm**. Please refer to the [Upgrading Sourcegraph with Helm docs](/admin/deploy/kubernetes#upgrading-sourcegraph) for Helm deployments. +This guide is **not for use with Helm**. Please refer to the [Upgrading Sourcegraph with Helm docs](/self-hosted/deploy/kubernetes#upgrading-sourcegraph) for Helm deployments. > **_⚠️ Attention:_** > -> - **_Always consult the [release notes](/admin/updates/kubernetes) for the versions your upgrade will pass over and end on._** -> - _This guide assumes you have created a `release` branch following the [reference repositories docs](/admin/deploy/repositories)_ +> - **_Always consult the [release notes](/self-hosted/updates/kubernetes) for the versions your upgrade will pass over and end on._** +> - _This guide assumes you have created a `release` branch following the [reference repositories docs](/self-hosted/deploy/repositories)_ > - **\*please see our [cautionary note](/admin/updates/#best-practices) on upgrades**, if you have any concerns about running a multiversion upgrade, please reach out to us at [support@sourcegraph.com](mailto:support@sourcegraph.com) for advisement.\* ## Standard upgrades @@ -16,7 +16,7 @@ A [standard upgrade](/admin/updates/#upgrade-types) occurs between a Sourcegraph ### Upgrade with Kubernetes Kustomize -The following procedure is for performing a **standard upgrade** with Sourcegraph instances version **`v4.5.0` and above**, which have [**migrated**](/admin/deploy/kubernetes/kustomize/migrate) to the [deploy-sourcegraph-k8s repo](https://github.com/sourcegraph/deploy-sourcegraph-k8s). +The following procedure is for performing a **standard upgrade** with Sourcegraph instances version **`v4.5.0` and above**, which have [**migrated**](/self-hosted/deploy/kubernetes/kustomize/migrate) to the [deploy-sourcegraph-k8s repo](https://github.com/sourcegraph/deploy-sourcegraph-k8s). **Step 1**: Create a backup copy of the deployment configuration file @@ -78,11 +78,11 @@ $ kubectl get pods -o wide --watch > **⚠️ Attention:** please see our [cautionary note](/admin/updates/#best-practices) on upgrades, if you have any concerns about running a multiversion upgrade, please reach out to us at [support@sourcegraph.com](mailto:support@sourcegraph.com) for advisement. -To perform a multi-version upgrade via migrators [upgrade](/admin/updates/migrator/migrator-operations#upgrade) command on a Sourcegraph instance deployed with our [kustomize repo](https://github.com/sourcegraph/deploy-sourcegraph-k8s) follow the procedure below: +To perform a multi-version upgrade via migrators [upgrade](/self-hosted/updates/migrator/migrator-operations#upgrade) command on a Sourcegraph instance deployed with our [kustomize repo](https://github.com/sourcegraph/deploy-sourcegraph-k8s) follow the procedure below: 1. **Check Upgrade Readiness**: - - Check the [upgrade notes](/admin/updates/kubernetes#kubernetes-upgrade-notes) for the version range you're passing through. + - Check the [upgrade notes](/self-hosted/updates/kubernetes#kubernetes-upgrade-notes) for the version range you're passing through. - Check the `Site Admin > Updates` page to determine [upgrade readiness](/admin/updates/#upgrade-readiness). 2. **Pull and merge upstream changes**: @@ -107,11 +107,11 @@ To perform a multi-version upgrade via migrators [upgrade](/admin/updates/migrat kubectl apply --prune -l deploy=sourcegraph -f cluster.yaml ``` - > Note: This step will ensure that any PostgreSQL upgrade performed as an entrypoint script will have a chance to execute before the migrator is run. For more information see [Upgradeing PostgreSQL](/admin/postgres#upgrading-postgresql). + > Note: This step will ensure that any PostgreSQL upgrade performed as an entrypoint script will have a chance to execute before the migrator is run. For more information see [Upgradeing PostgreSQL](/self-hosted/postgres#upgrading-postgresql). 4. **Run Migrator with the `upgrade` command**: - - _For more detailed instructions and available command flags see our [migrator docs](/admin/updates/migrator/migrator-operations#upgrade)._ + - _For more detailed instructions and available command flags see our [migrator docs](/self-hosted/updates/migrator/migrator-operations#upgrade)._ 1. In the `configure/migrator/migrator.Job.yaml` [manifest](https://github.com/sourcegraph/deploy-sourcegraph-k8s/blob/main/components/utils/migrator/resources/migrator.Job.yaml): - set the `image:` to the **latest** release of `migrator` @@ -196,7 +196,7 @@ To perform a multi-version upgrade via migrators [upgrade](/admin/updates/migrat Due to limitations with the Kustomize deployment method introduced in Sourcegraph `v4.5.0`, multi-version upgrades (e.g. `v4.2.0` -> `v5.0.3`), migrations to `deploy-sourcegraph-k8s` should be conducted seperately from a full upgrade. -Admins upgrading a Sourcegraph instance older than `v4.5.0` and migrating from our [legacy kubernetes](https://github.com/sourcegraph/deploy-sourcegraph) offering to our new [kustomize manifests](https://github.com/sourcegraph/deploy-sourcegraph-k8s) should upgrade to `v4.5.0` perform the `migrate` [procedure](/admin/deploy/kubernetes/kustomize/migrate) and then perfom the remaining upgrade to bring Sourcegraph up to the desired version. +Admins upgrading a Sourcegraph instance older than `v4.5.0` and migrating from our [legacy kubernetes](https://github.com/sourcegraph/deploy-sourcegraph) offering to our new [kustomize manifests](https://github.com/sourcegraph/deploy-sourcegraph-k8s) should upgrade to `v4.5.0` perform the `migrate` [procedure](/self-hosted/deploy/kubernetes/kustomize/migrate) and then perfom the remaining upgrade to bring Sourcegraph up to the desired version. ## Rollback @@ -204,7 +204,7 @@ Admins upgrading a Sourcegraph instance older than `v4.5.0` and migrating from o You can rollback by resetting your `release` branch to the old state before redeploying the instance. -If you are rolling back more than a single version, then you must also [rollback your database](/admin/how-to/rollback_database), as database migrations (which may have run at some point during the upgrade) are guaranteed to be compatible with one previous minor version. +If you are rolling back more than a single version, then you must also [rollback your database](/self-hosted/how-to/rollback_database), as database migrations (which may have run at some point during the upgrade) are guaranteed to be compatible with one previous minor version. ### Rollback with Kustomize @@ -219,7 +219,7 @@ kubectl apply --prune -l deploy=sourcegraph -f cluster-rollback.yaml ### Rollback with `migrator downgrade` -For rolling back a multiversion upgrade use the `migrator` [downgrade](/admin/updates/migrator/migrator-operations#downgrade) command. Learn mor in our [downgrade docs](/admin/updates/migrator/downgrading). +For rolling back a multiversion upgrade use the `migrator` [downgrade](/self-hosted/updates/migrator/migrator-operations#downgrade) command. Learn mor in our [downgrade docs](/self-hosted/updates/migrator/downgrading). --- @@ -227,7 +227,7 @@ For rolling back a multiversion upgrade use the `migrator` [downgrade](/admin/up In some situations, administrators may wish to migrate their databases before upgrading the rest of the system to reduce downtime. Sourcegraph guarantees database backward compatibility to the most recent minor point release so the database can safely be upgraded before the application code. -To execute the database migrations independently, follow the [Kubernetes instructions on how to manually run database migrations](/admin/updates/migrator/migrator-operations). Running the `up` (default) command on the `migrator` of the _version you are upgrading to_ will apply all migrations required by the next version of Sourcegraph. +To execute the database migrations independently, follow the [Kubernetes instructions on how to manually run database migrations](/self-hosted/updates/migrator/migrator-operations). Running the `up` (default) command on the `migrator` of the _version you are upgrading to_ will apply all migrations required by the next version of Sourcegraph. ## Improving update reliability and latency with node selectors @@ -273,4 +273,4 @@ the following: ## Troubleshooting -See the [troubleshooting page](/admin/deploy/kubernetes/troubleshoot). +See the [troubleshooting page](/self-hosted/deploy/kubernetes/troubleshoot). diff --git a/docs/admin/deploy/machine-images/aws-ami.mdx b/docs/self-hosted/deploy/machine-images/aws-ami.mdx similarity index 97% rename from docs/admin/deploy/machine-images/aws-ami.mdx rename to docs/self-hosted/deploy/machine-images/aws-ami.mdx index 5f0c66016..586e0dc3a 100644 --- a/docs/admin/deploy/machine-images/aws-ami.mdx +++ b/docs/self-hosted/deploy/machine-images/aws-ami.mdx @@ -62,7 +62,7 @@ To configure SSL, and lock down the instance from the public internet, see the [ ### Executors -Executors are supported using [native kubernetes executors](/admin/executors/deploy_executors_kubernetes). +Executors are supported using [native kubernetes executors](/self-hosted/executors/deploy_executors_kubernetes). Executors support [auto-indexing](/code-navigation/auto_indexing) and [server-side batch changes](/batch-changes/server-side). @@ -189,8 +189,8 @@ Now that your instance is confirmed to be working, and you have HTTPS working th Please take time to review the following before proceeding with the upgrades: - [Technical changelog](/technical-changelog) -- [Update policy](/admin/updates#update-policy) -- [Update notes](/admin/updates/kubernetes) +- [Update policy](/self-hosted/updates#update-policy) +- [Update notes](/self-hosted/updates/kubernetes) Back up your volumes before each upgrade! diff --git a/docs/admin/deploy/machine-images/aws-oneclick.mdx b/docs/self-hosted/deploy/machine-images/aws-oneclick.mdx similarity index 87% rename from docs/admin/deploy/machine-images/aws-oneclick.mdx rename to docs/self-hosted/deploy/machine-images/aws-oneclick.mdx index af074403b..7419e11b7 100644 --- a/docs/admin/deploy/machine-images/aws-oneclick.mdx +++ b/docs/self-hosted/deploy/machine-images/aws-oneclick.mdx @@ -2,7 +2,7 @@ This page describes how to launch a verified and pre-configured Sourcegraph instance in just ~10 minutes using our one-click CloudFormation template and standard AMIs. -Prefer manually installing on AWS yourself? See our [AMI](/admin/deploy/machine-images/aws-ami) installation options. +Prefer manually installing on AWS yourself? See our [AMI](/self-hosted/deploy/machine-images/aws-ami) installation options. ## Prerequisites @@ -25,7 +25,7 @@ Using our wizard, a single EC2 instance will be created with the following: The instance will launch in the default VPC. If your AWS user does not have a default VPC, or the option `Auto-assign public IPv4 address` is not enabled for a subnet within that VPC, please see our [Manual - AMI](/admin/deploy/machine-images/aws-ami) instructions instead. + AMI](/self-hosted/deploy/machine-images/aws-ami) instructions instead. ![aws-oneclick](https://storage.googleapis.com/sourcegraph-assets/Docs/aws-oneclick-diagram.png) @@ -57,7 +57,7 @@ Example: With 8,000 users with 80,000 repositories, your instance size would be Encryption guide](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) and install Sourcegraph using our [Manual - AMI](/admin/deploy/machine-images/aws-ami) instructions instead. + AMI](/self-hosted/deploy/machine-images/aws-ami) instructions instead. Choose an AWS Region in the launcher below and click **Launch Stack**. When prompted, choose your **SSH Keypair** and **Sourcegraph Instance Size** per the chart above, then **Create Stack**. @@ -70,7 +70,7 @@ Find the URL of your Sourcegraph instance in the **Outputs** section of the AWS ### Executors -Executors are supported using [native kubernetes executors](/admin/executors/deploy_executors_kubernetes). +Executors are supported using [native kubernetes executors](/self-hosted/executors/deploy_executors_kubernetes). Executors support [auto-indexing](/code-navigation/auto_indexing) and [server-side batch changes](/batch-changes/server-side). @@ -101,7 +101,7 @@ To use server-side batch changes you will need to enable the `native-ssbc-execut By default Sourcegraph will be available over HTTP on the public internet. To secure it you should now perform the following: -1. [Configure DNS and HTTPS/TLS](/admin/deploy/machine-images/aws-ami#networking) using an AWS Load Balancer and AWS Certificate Manager. +1. [Configure DNS and HTTPS/TLS](/self-hosted/deploy/machine-images/aws-ami#networking) using an AWS Load Balancer and AWS Certificate Manager. 2. [Configure user authentication](/admin/auth/) (SSO, SAML, OpenID Connect, etc.) 3. [Review the new Network Security Group](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) to prevent access from the public internet and follow the principle of least privilege. @@ -111,15 +111,15 @@ By default Sourcegraph will be available over HTTP on the public internet. To se We strongly recommend you taking [snapshots of the entire Sourcegraph data EBS volume](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-creating-snapshot.html) on an [automatic, scheduled basis](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-lifecycle.html). Only the Sourcegraph data volume (500G) needs to be backed up. -To restore from a backup, simply follow our [upgrade instructions](/admin/deploy/machine-images/aws-ami#upgrade) and skip directly to **Step 2: Launch a new instance** - choosing your desired Sourcegraph version and your backed up data volume. +To restore from a backup, simply follow our [upgrade instructions](/self-hosted/deploy/machine-images/aws-ami#upgrade) and skip directly to **Step 2: Launch a new instance** - choosing your desired Sourcegraph version and your backed up data volume. ### Upgrading your Sourcegraph instance -Updates are released every month, and upgrading is a simple process: backup your instance, detach the Sourcegraph data volume, and start a new instance using the latest AMI with your data volume attached. For step-by-step instructions [see here](/admin/deploy/machine-images/aws-ami#upgrade). +Updates are released every month, and upgrading is a simple process: backup your instance, detach the Sourcegraph data volume, and start a new instance using the latest AMI with your data volume attached. For step-by-step instructions [see here](/self-hosted/deploy/machine-images/aws-ami#upgrade). ### Monitoring & alerting -Sourcegraph comes with extensive built-in monitoring dashboards & the ability to configure alerts. Please see our [monitoring guide](/admin/how-to/monitoring-guide) for more information. +Sourcegraph comes with extensive built-in monitoring dashboards & the ability to configure alerts. Please see our [monitoring guide](/self-hosted/how-to/monitoring-guide) for more information. ### Get Support diff --git a/docs/admin/deploy/machine-images/gce.mdx b/docs/self-hosted/deploy/machine-images/gce.mdx similarity index 97% rename from docs/admin/deploy/machine-images/gce.mdx rename to docs/self-hosted/deploy/machine-images/gce.mdx index 6af61ce6c..43f449765 100644 --- a/docs/admin/deploy/machine-images/gce.mdx +++ b/docs/self-hosted/deploy/machine-images/gce.mdx @@ -119,7 +119,7 @@ $ sudo su sourcegraph ### Executors -Executors are supported using [native kubernetes executors](/admin/executors/deploy_executors_kubernetes). +Executors are supported using [native kubernetes executors](/self-hosted/executors/deploy_executors_kubernetes). Executors support [auto-indexing](/code-navigation/auto_indexing) and [server-side batch changes](/batch-changes/server-side). @@ -170,9 +170,9 @@ As a result, setting up a static IP for your Sourcegraph instance is strongly re Please take time to review the following before proceeding with the upgrades: - [Technical changelog](/technical-changelog) -- [Update policy](/admin/updates#update-policy) -- [Update notes](/admin/updates/kubernetes) -- [Multi-version upgrade procedure](/admin/updates/kubernetes#multi-version-upgrade-procedure) +- [Update policy](/self-hosted/updates#update-policy) +- [Update notes](/self-hosted/updates/kubernetes) +- [Multi-version upgrade procedure](/self-hosted/updates/kubernetes#multi-version-upgrade-procedure) IMPORTANT: **Back up your volumes before each upgrade** @@ -228,7 +228,7 @@ You can terminate the stopped Sourcegraph Google Image instance once you have co You must follow the [multi-version upgrade - procedure](/admin/updates/kubernetes#multi-version-upgrade-procedure) if you + procedure](/self-hosted/updates/kubernetes#multi-version-upgrade-procedure) if you are attempting a multi-version upgrade. diff --git a/docs/admin/deploy/machine-images/index.mdx b/docs/self-hosted/deploy/machine-images/index.mdx similarity index 100% rename from docs/admin/deploy/machine-images/index.mdx rename to docs/self-hosted/deploy/machine-images/index.mdx diff --git a/docs/admin/deploy/migrate-backup.mdx b/docs/self-hosted/deploy/migrate-backup.mdx similarity index 93% rename from docs/admin/deploy/migrate-backup.mdx rename to docs/self-hosted/deploy/migrate-backup.mdx index 55e789fc3..50e185d89 100644 --- a/docs/admin/deploy/migrate-backup.mdx +++ b/docs/self-hosted/deploy/migrate-backup.mdx @@ -4,7 +4,7 @@ In some circumstances it may be necessary or advantageous to migrate from one So ## Specific guides -- [Migrate from the single Docker image to Docker Compose](/admin/deploy/docker-compose/migrate) +- [Migrate from the single Docker image to Docker Compose](/self-hosted/deploy/docker-compose/migrate) ## Data stores @@ -54,7 +54,7 @@ This list is not guaranteed to be complete, but rather representative of the typ | Repository (git) data | Yes | | | Search indexes | Yes | | | [Code graph data](/code-navigation/precise_code_navigation) | No | This can be regenerated by re-running the indexing and upload process for affected repositories and revisions, but will not be regenerated by default. | -| [Prometheus metrics](/admin/observability/metrics) | No | | +| [Prometheus metrics](/self-hosted/observability/metrics) | No | | | blobstore | Yes | This is where unprocessed uploads are stored. | ### Ephemeral data (Redis) @@ -63,7 +63,7 @@ Short-lived data, including session data and some usage statistics, are stored i ### External data -Certain categories of data can be stored outside the Sourcegraph deployment. For example, [configuration JSON files can be loaded from disk](/admin/config/advanced_config_file), and Sourcegraph can connect to [external services (PostgreSQL, Redis, S3/GCS)](/admin/external_services/) instead of using PostgreSQL, Redis, and blobstore internally. +Certain categories of data can be stored outside the Sourcegraph deployment. For example, [configuration JSON files can be loaded from disk](/self-hosted/advanced_config_file), and Sourcegraph can connect to [external services (PostgreSQL, Redis, S3/GCS)](/self-hosted/external_services/) instead of using PostgreSQL, Redis, and blobstore internally. In these cases, no migration should be necessary, simply re-use the existing external data sources on the new Sourcegraph instance. @@ -77,7 +77,7 @@ The easiest option is to simply back up or migrate [configuration JSON data](#co This option provides a more complete backup, and ensures that almost all state will be restored. Repositories will have to be re-cloned and re-indexed, so some downtime will be required while these operations complete. -Follow the instructions in our [Docker to Docker Compose migration guide](/admin/deploy/docker-compose/migrate#backup-single-docker-image-database) to generate a dump of Sourcegraph's Postgres database. [Contact us](https://about.sourcegraph.com/contact/sales) for specific recommendations for your deployment type. +Follow the instructions in our [Docker to Docker Compose migration guide](/self-hosted/deploy/docker-compose/migrate#backup-single-docker-image-database) to generate a dump of Sourcegraph's Postgres database. [Contact us](https://about.sourcegraph.com/contact/sales) for specific recommendations for your deployment type. ### Option 3: All data diff --git a/docs/admin/deploy/repositories.mdx b/docs/self-hosted/deploy/repositories.mdx similarity index 90% rename from docs/admin/deploy/repositories.mdx rename to docs/self-hosted/deploy/repositories.mdx index 4fd41074b..fd81e3af5 100644 --- a/docs/admin/deploy/repositories.mdx +++ b/docs/self-hosted/deploy/repositories.mdx @@ -51,7 +51,7 @@ git clone https://github.com/SG_DEPLOY_GITHUB_USERNAME/$SG_PRIVATE_DEPLOY_REPO_N ### Step 4: Create a release branch -Create a `release` branch to track all of your customizations to Sourcegraph. This branch will be used to [upgrade Sourcegraph](/admin/updates) and [install your Sourcegraph instance](/admin/deploy/#installation). +Create a `release` branch to track all of your customizations to Sourcegraph. This branch will be used to [upgrade Sourcegraph](/self-hosted/updates) and [install your Sourcegraph instance](/admin/deploy/#installation). ```bash cd $SG_PRIVATE_DEPLOY_REPO_NAME @@ -77,4 +77,4 @@ git checkout $YOUR_RELEASE_BRANCH git merge {CURRENT_VERSION} ``` -A [standard upgrade](/admin/updates#standard-upgrades) occurs between two minor versions of Sourcegraph. If you are looking to jump forward several versions, you must perform a [multi-version upgrade](/admin/updates#multi-version-upgrades) instead. +A [standard upgrade](/self-hosted/updates#standard-upgrades) occurs between two minor versions of Sourcegraph. If you are looking to jump forward several versions, you must perform a [multi-version upgrade](/self-hosted/updates#multi-version-upgrades) instead. diff --git a/docs/admin/deploy/resource_estimator.mdx b/docs/self-hosted/deploy/resource_estimator.mdx similarity index 92% rename from docs/admin/deploy/resource_estimator.mdx rename to docs/self-hosted/deploy/resource_estimator.mdx index e6e9d7878..90142316e 100644 --- a/docs/admin/deploy/resource_estimator.mdx +++ b/docs/self-hosted/deploy/resource_estimator.mdx @@ -31,8 +31,8 @@ Repository permissions on Sourcegraph can have a noticeable impact on search per ### What kind of data can be regenerated without backup? -See our docs on [Persistent data backup in Kubernetes](/admin/deploy/migrate-backup#persistent-data-backup-in-kubernetes) for more detail. +See our docs on [Persistent data backup in Kubernetes](/self-hosted/deploy/migrate-backup#persistent-data-backup-in-kubernetes) for more detail. #### How does Sourcegraph scale? -[Click here to learn more about how each Sourcegraph service scales.](/admin/deploy/scale) +[Click here to learn more about how each Sourcegraph service scales.](/self-hosted/deploy/scale) diff --git a/docs/admin/deploy/scale.mdx b/docs/self-hosted/deploy/scale.mdx similarity index 90% rename from docs/admin/deploy/scale.mdx rename to docs/self-hosted/deploy/scale.mdx index d3d74925c..463415971 100644 --- a/docs/admin/deploy/scale.mdx +++ b/docs/self-hosted/deploy/scale.mdx @@ -27,14 +27,14 @@ Here is a list of components you can find in a typical Sourcegraph deployment: | | | | :------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`frontend`](/admin/deploy/scale#frontend) | Serves the web application, extensions, and graphQL services. Almost every service has a link back to the frontend, from which it gathers configuration updates. | -| [`gitserver`](/admin/deploy/scale#gitserver) | Mirrors repositories from their code host. All other Sourcegraph services talk to gitserver when they need data from git. | -| [`precise-code-intel`](/admin/deploy/scale#precise-code-intel) | Converts LSIF upload file into Postgres data. The entire index must be read into memory to be correlated. | -| [`searcher`](/admin/deploy/scale#searcher) | Provides on-demand un-indexed search for repositories. It fetches archives from gitserver and searches them with regexp. Indexes symbols in repositories using Ctags. | -| [`syntect-server`](/admin/deploy/scale#syntect-server) | An HTTP server that exposes the Rust Syntect syntax highlighting library for use by other services. | -| [`worker`](/admin/deploy/scale#worker) | Runs a collection of background jobs periodically in response to internal requests and external events. It is currently janitorial and commit based. | -| [`zoekt-indexserver`](/admin/deploy/scale#zoekt-indexserver) | Indexes all enabled repositories on Sourcegraph and keeps the indexes up to date. Lives inside the indexed-search pod in a Kubernetes deployment. | -| [`zoekt-webserver`](/admin/deploy/scale#zoekt-webserver) | Runs searches from indexes stored in memory and disk. The indexes are persisted to disk to avoid re-indexing on startup. Lives inside the indexed-search pod in a Kubernetes deployment. | +| [`frontend`](/self-hosted/deploy/scale#frontend) | Serves the web application, extensions, and graphQL services. Almost every service has a link back to the frontend, from which it gathers configuration updates. | +| [`gitserver`](/self-hosted/deploy/scale#gitserver) | Mirrors repositories from their code host. All other Sourcegraph services talk to gitserver when they need data from git. | +| [`precise-code-intel`](/self-hosted/deploy/scale#precise-code-intel) | Converts LSIF upload file into Postgres data. The entire index must be read into memory to be correlated. | +| [`searcher`](/self-hosted/deploy/scale#searcher) | Provides on-demand un-indexed search for repositories. It fetches archives from gitserver and searches them with regexp. Indexes symbols in repositories using Ctags. | +| [`syntect-server`](/self-hosted/deploy/scale#syntect-server) | An HTTP server that exposes the Rust Syntect syntax highlighting library for use by other services. | +| [`worker`](/self-hosted/deploy/scale#worker) | Runs a collection of background jobs periodically in response to internal requests and external events. It is currently janitorial and commit based. | +| [`zoekt-indexserver`](/self-hosted/deploy/scale#zoekt-indexserver) | Indexes all enabled repositories on Sourcegraph and keeps the indexes up to date. Lives inside the indexed-search pod in a Kubernetes deployment. | +| [`zoekt-webserver`](/self-hosted/deploy/scale#zoekt-webserver) | Runs searches from indexes stored in memory and disk. The indexes are persisted to disk to avoid re-indexing on startup. Lives inside the indexed-search pod in a Kubernetes deployment. | ### External Services @@ -42,24 +42,24 @@ A list of services that can be externalized. See our docs on [Using external ser | | | | :------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`codeinsights-db`](/admin/deploy/scale#codeinsights-db) | A PostgreSQL instance for storing code insights data. | -| [`codeintel-db`](/admin/deploy/scale#codeintel-db) | A PostgreSQL instance for storing large-volume code graph data. | -| [`jaeger`](/admin/deploy/scale#jeager) | A Jaeger instance for end-to-end distributed tracing. | -| [`blobstore`](/admin/deploy/scale#blobstore) | A blobstore instance that serves as a local S3-compatible object storage to hold user uploads for code-intel before they can be processed. | -| [`pgsql`](/admin/deploy/scale#pgsql) | A PostgreSQL instance for storing long-term information, such as user information when using Sourcegraph’s built-in authentication provider instead of an external one. | -| [`redis-cache`](/admin/deploy/scale#redis-cache) | A Redis instance for storing cache data. | -| [`redis-store`](/admin/deploy/scale#redis-store) | A Redis instance for storing short-term information such as user sessions. | +| [`codeinsights-db`](/self-hosted/deploy/scale#codeinsights-db) | A PostgreSQL instance for storing code insights data. | +| [`codeintel-db`](/self-hosted/deploy/scale#codeintel-db) | A PostgreSQL instance for storing large-volume code graph data. | +| [`jaeger`](/self-hosted/deploy/scale#jeager) | A Jaeger instance for end-to-end distributed tracing. | +| [`blobstore`](/self-hosted/deploy/scale#blobstore) | A blobstore instance that serves as a local S3-compatible object storage to hold user uploads for code-intel before they can be processed. | +| [`pgsql`](/self-hosted/deploy/scale#pgsql) | A PostgreSQL instance for storing long-term information, such as user information when using Sourcegraph’s built-in authentication provider instead of an external one. | +| [`redis-cache`](/self-hosted/deploy/scale#redis-cache) | A Redis instance for storing cache data. | +| [`redis-store`](/self-hosted/deploy/scale#redis-store) | A Redis instance for storing short-term information such as user sessions. | ### Monitoring Tools -Sourcegraph provides a number of tools to monitor the health and usage of your deployment. See our [Observability docs](/admin/observability/) for more information. +Sourcegraph provides a number of tools to monitor the health and usage of your deployment. See our [Observability docs](/self-hosted/observability/) for more information. You can also learn more about the architecture of Sourcegraph’s monitoring stack in [Sourcegraph monitoring architecture](https://handbook.sourcegraph.com/departments/engineering/dev/tools/observability/monitoring_architecture) | | | | :--------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| [`cadvisor`](/admin/deploy/scale#cadvisor) | A custom cAdvisor instance that exports container monitoring metrics scraped by Prometheus and visualized in Grafana. | -| [`grafana`](/admin/deploy/scale#grafana) | A Grafana instance that displays data from Prometheus and Jaeger. It is shipped with customized dashboards for Sourcegraph services. | -| [`prometheus`](/admin/deploy/scale#prometheus) | A customized Prometheus instance for collecting high-level and low-cardinality, metrics across services. | +| [`cadvisor`](/self-hosted/deploy/scale#cadvisor) | A custom cAdvisor instance that exports container monitoring metrics scraped by Prometheus and visualized in Grafana. | +| [`grafana`](/self-hosted/deploy/scale#grafana) | A Grafana instance that displays data from Prometheus and Jaeger. It is shipped with customized dashboards for Sourcegraph services. | +| [`prometheus`](/self-hosted/deploy/scale#prometheus) | A customized Prometheus instance for collecting high-level and low-cardinality, metrics across services. | --- @@ -132,7 +132,7 @@ A PostgreSQL instance for storing code insights data. a Postgres database running out of memory indicates that it is currently misconfigured, and the amount of memory each worker can utilize should be reduced. See our [Postgres database configuration - guide](/admin/config/postgres-conf) for more information. + guide](/self-hosted/postgres-conf) for more information. --- @@ -184,7 +184,7 @@ A PostgreSQL instance for storing large-volume code graph data. built-in utilities (like autovacuum for example). For example, a Postgres database running out of memory indicates that it is currently misconfigured, and the amount of memory each worker can utilize should be reduced. See our [Postgres database - configuration guide](/admin/config/postgres-conf) for more information. + configuration guide](/self-hosted/postgres-conf) for more information. --- @@ -357,13 +357,13 @@ Basically anything not related to code-intel. | :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Overview` | Executes queries | | `Factors` | The default setup should be sufficient for most deployments | -| `Guideline` | The database must be configured properly following our [Postgres configuration guide](/admin/config/postgres-conf) to use the assigned resources efficiently | +| `Guideline` | The database must be configured properly following our [Postgres configuration guide](/self-hosted/postgres-conf) to use the assigned resources efficiently | | Memory | | | :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Overview` | Linear to the concurrent number of API requests proxies | | `Factors` | The default setup should be sufficient for most deployments | -| `Guideline` | The database must be configured properly following our [Postgres configuration guide](/admin/config/postgres-conf) to use the assigned resources efficiently | +| `Guideline` | The database must be configured properly following our [Postgres configuration guide](/self-hosted/postgres-conf) to use the assigned resources efficiently | | Storage | | | :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -371,7 +371,7 @@ Basically anything not related to code-intel. | `Factors` | Size of all repositories | | | Number of insight queries | | `Guideline` | Starts at default as the value grows depending on the number of active users and activity | -| | The database must be configured properly following our [Postgres configuration guide](/admin/config/postgres-conf) to use the assigned resources efficiently | +| | The database must be configured properly following our [Postgres configuration guide](/self-hosted/postgres-conf) to use the assigned resources efficiently | | `Type` | Persistent Volumes for Kubernetes | | | Persistent SSD for Docker Compose | @@ -382,7 +382,7 @@ Basically anything not related to code-intel. built-in utilities (like autovacuum for example). For example, a Postgres database running out of memory indicates that it is currently misconfigured and the amount of memory each worker can utilize should be reduced. See our [Postgres database - configuration guide](/admin/config/postgres-conf) for more information. + configuration guide](/self-hosted/postgres-conf) for more information. --- @@ -434,7 +434,7 @@ It currently bundles Alertmanager as well as integrations to the Sourcegraph web | :---------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Overview` | The default setup should be sufficient for most deployments | | `Factors` | Number of active users | -| `Guideline` | For Kubernetes deployments, please follow the [instruction here](/admin/deploy/kubernetes/configure#filtering-cadvisor-metrics) to prevent Prometheus from scraping metrics outside of your Sourcegraph namespace | +| `Guideline` | For Kubernetes deployments, please follow the [instruction here](/self-hosted/deploy/kubernetes/configure#filtering-cadvisor-metrics) to prevent Prometheus from scraping metrics outside of your Sourcegraph namespace | --- @@ -606,7 +606,7 @@ Runs a collection of background jobs periodically in response to internal reques {' '} - See the docs on [Worker services](/admin/workers#worker-jobs) for a list of worker + See the docs on [Worker services](/self-hosted/workers#worker-jobs) for a list of worker jobs. diff --git a/docs/admin/deploy/single-node/index.mdx b/docs/self-hosted/deploy/single-node/index.mdx similarity index 55% rename from docs/admin/deploy/single-node/index.mdx rename to docs/self-hosted/deploy/single-node/index.mdx index 4104d4245..ae83fab13 100644 --- a/docs/admin/deploy/single-node/index.mdx +++ b/docs/self-hosted/deploy/single-node/index.mdx @@ -3,6 +3,6 @@ For customers who want to self-host, we recommend one of the single-node deployment options. - Cloud - - [Machine images](/admin/deploy/machine-images) + - [Machine images](/self-hosted/deploy/machine-images) - Local - - [Docker Compose](/admin/deploy/docker-compose) + - [Docker Compose](/self-hosted/deploy/docker-compose) diff --git a/docs/admin/deploy/single-node/script.mdx b/docs/self-hosted/deploy/single-node/script.mdx similarity index 93% rename from docs/admin/deploy/single-node/script.mdx rename to docs/self-hosted/deploy/single-node/script.mdx index 9b6d53579..dbd082468 100644 --- a/docs/admin/deploy/single-node/script.mdx +++ b/docs/self-hosted/deploy/single-node/script.mdx @@ -13,7 +13,7 @@ The script can be run on the following distros. - Amazon Linux 2 As it is impossible to test all possible deployment environments it is possible albeit unlikely to encounter an error. We highly suggest using one of our -curated [Machine Images](/admin/deploy/machine-images/) if possible. +curated [Machine Images](/self-hosted/deploy/machine-images/) if possible. ## Instance Size Chart @@ -79,9 +79,9 @@ We recommend deploying your own reverse proxy to terminate TLS connections with ## Upgrade - [Technical changelog](/technical-changelog) -- [Update policy](/admin/updates#update-policy) -- [Update notes](/admin/updates/kubernetes) -- [Multi-version upgrade procedure](/admin/updates/kubernetes#multi-version-upgrade-procedure) +- [Update policy](/self-hosted/updates#update-policy) +- [Update notes](/self-hosted/updates/kubernetes) +- [Multi-version upgrade procedure](/self-hosted/updates/kubernetes#multi-version-upgrade-procedure) > Important: Back up your volumes before each upgrade diff --git a/docs/admin/deploy/without_service_discovery.mdx b/docs/self-hosted/deploy/without_service_discovery.mdx similarity index 89% rename from docs/admin/deploy/without_service_discovery.mdx rename to docs/self-hosted/deploy/without_service_discovery.mdx index 3bfb627b6..d9e32da2e 100644 --- a/docs/admin/deploy/without_service_discovery.mdx +++ b/docs/self-hosted/deploy/without_service_discovery.mdx @@ -15,4 +15,4 @@ If you are deploying Sourcegraph in an environment **without Kubernetes service - SRC_GIT_SERVERS - SYMBOLS_URL -For detailed instructions on how to set these environment variables in a Docker Compose deployment, see the [Docker Compose configuration guide](/admin/deploy/docker-compose/configuration#set-environment-variables). +For detailed instructions on how to set these environment variables in a Docker Compose deployment, see the [Docker Compose configuration guide](/self-hosted/deploy/docker-compose/configuration#set-environment-variables). diff --git a/docs/admin/deployment_best_practices.mdx b/docs/self-hosted/deployment_best_practices.mdx similarity index 92% rename from docs/admin/deployment_best_practices.mdx rename to docs/self-hosted/deployment_best_practices.mdx index 43d9b3d33..79a496011 100644 --- a/docs/admin/deployment_best_practices.mdx +++ b/docs/self-hosted/deployment_best_practices.mdx @@ -10,7 +10,7 @@ Sourcegraph is a highly scalable and configurable application. As an open source - user's engagement level - number and size of code repositories synced to Sourcegraph. -_To get a better idea of your resource requirements for your instance use our [resource estimator](/admin/deploy/resource_estimator)._ +_To get a better idea of your resource requirements for your instance use our [resource estimator](/self-hosted/deploy/resource_estimator)._ ## Deployment Best Practices @@ -20,8 +20,8 @@ A comparison table of supported self-hosted deployment methodologies can be [fou Kubernetes deployments may be customized in a variety of ways, we consider the following best practice: -- If Helm cannot be used, [Kustomize can be used to apply configuration changes](/admin/deploy/kubernetes/kustomize). -- As a last resort, the [manifests can be edited in a forked copy of the Sourcegraph repository](/admin/deploy/kubernetes/). +- If Helm cannot be used, [Kustomize can be used to apply configuration changes](/self-hosted/deploy/kubernetes/kustomize). +- As a last resort, the [manifests can be edited in a forked copy of the Sourcegraph repository](/self-hosted/deploy/kubernetes/). - The suggested Kubernetes version is the current [GKE Stable release version](https://cloud.google.com/kubernetes-engine/docs/release-notes-stable) - We attempt to support new versions of Kubernetes 2-3 months after their release. - Users are expected to run a compliant Kubernetes version ([a CNCF certified Kubernetes distribution](https://github.com/cncf/k8s-conformance)) @@ -33,7 +33,7 @@ _Unless scale, resiliency, or some other legitimate need exists that necessitate ### Docker Compose - Be sure your deployment meets our [Docker Compose requirements](/admin/deploy/docker-compose/#requirements). -- Review the [configuration section](/admin/deploy/docker-compose/#configuration) of our [Docker Compose deployment docs](/admin/deploy/docker-compose/). +- Review the [configuration section](/admin/deploy/docker-compose/#configuration) of our [Docker Compose deployment docs](/self-hosted/deploy/docker-compose/). ### Sourcegraph Server (single Docker container) diff --git a/docs/admin/config/email.mdx b/docs/self-hosted/email.mdx similarity index 100% rename from docs/admin/config/email.mdx rename to docs/self-hosted/email.mdx diff --git a/docs/admin/config/encryption.mdx b/docs/self-hosted/encryption.mdx similarity index 100% rename from docs/admin/config/encryption.mdx rename to docs/self-hosted/encryption.mdx diff --git a/docs/admin/executors/deploy_executors.mdx b/docs/self-hosted/executors/deploy_executors.mdx similarity index 90% rename from docs/admin/executors/deploy_executors.mdx rename to docs/self-hosted/executors/deploy_executors.mdx index 1f6204c4f..ef557a957 100644 --- a/docs/admin/executors/deploy_executors.mdx +++ b/docs/self-hosted/executors/deploy_executors.mdx @@ -2,11 +2,11 @@ Executors can be deployed in a variety of manners. The supported deployment options are: -- [Linux Binary Service](/admin/executors/deploy_executors_binary) ([Firecracker](./firecracker) compatible) -- [Terraform on AWS or GCP](/admin/executors/deploy_executors_terraform) ([Firecracker](./firecracker) compatible) -- [Native Kubernetes](/admin/executors/deploy_executors_kubernetes) -- [Docker-in-Docker on Kubernetes](/admin/executors/deploy_executors_dind) -- [Docker-Compose](/admin/executors/deploy_executors_docker) +- [Linux Binary Service](/self-hosted/executors/deploy_executors_binary) ([Firecracker](./firecracker) compatible) +- [Terraform on AWS or GCP](/self-hosted/executors/deploy_executors_terraform) ([Firecracker](./firecracker) compatible) +- [Native Kubernetes](/self-hosted/executors/deploy_executors_kubernetes) +- [Docker-in-Docker on Kubernetes](/self-hosted/executors/deploy_executors_dind) +- [Docker-Compose](/self-hosted/executors/deploy_executors_docker) See [deciding which executor deployment method to use ](../executors#deciding-which-executor-deployment-method-to-use) for more information on these different deployment options. @@ -46,7 +46,7 @@ The maximum number of Jobs an Executor instance can run in parallel is configure The CPU and Memory usage of an individual Job is configured by the Environment Variables `EXECUTOR_JOB_NUM_CPUS` and `EXECUTOR_JOB_MEMORY`. -See [executor configuration](/admin/executors/executors_config) for a full list of configuration options. +See [executor configuration](/self-hosted/executors/executors_config) for a full list of configuration options. Note: changing CPU and Memory for jobs will affect the overall requirements @@ -68,7 +68,7 @@ It is recommended to add the following **Disk** configuration in AWS. #### Firecracker requirements To run Executors with Firecracker enabled requires the machine to support [Kernel-based Virtual Machine](https://en.wikipedia.org/wiki/Kernel-based_Virtual_Machine). -See [deploying Executors binary](/admin/executors/deploy_executors_binary) for additional information on configuring Linux Machines. +See [deploying Executors binary](/self-hosted/executors/deploy_executors_binary) for additional information on configuring Linux Machines. #### Cloud providers @@ -97,31 +97,31 @@ Once the shared secret is set in Sourcegraph, you can start setting up executors @@ -226,9 +226,9 @@ If your environment makes use of custom certificates, you can add them to one of ### Adding certificates to a binary deployment -> NOTE: see the [troubleshooting guide](/admin/executors/executors_troubleshooting#connecting-to-cloud-provider-executor-instances) for instructions on how to connect to cloud provider VMs. +> NOTE: see the [troubleshooting guide](/self-hosted/executors/executors_troubleshooting#connecting-to-cloud-provider-executor-instances) for instructions on how to connect to cloud provider VMs. -After successfully [deploying binaries](/admin/executors/deploy_executors_binary), follow these steps: +After successfully [deploying binaries](/self-hosted/executors/deploy_executors_binary), follow these steps: 1. Copy your certificates to `/etc/ssl/certs`. 1. If you are using systemd, run `systemctl restart executor`. If not, proceed to the next step. diff --git a/docs/admin/executors/deploy_executors_binary.mdx b/docs/self-hosted/executors/deploy_executors_binary.mdx similarity index 95% rename from docs/admin/executors/deploy_executors_binary.mdx rename to docs/self-hosted/executors/deploy_executors_binary.mdx index 47bdc0c33..23f4f7c5e 100644 --- a/docs/admin/executors/deploy_executors_binary.mdx +++ b/docs/self-hosted/executors/deploy_executors_binary.mdx @@ -2,7 +2,7 @@ ## Installation -> Note: See [offline installation guide](/admin/executors/deploy_executors_binary_offline) for instructions on how to install executors in an air-gapped environment. +> Note: See [offline installation guide](/self-hosted/executors/deploy_executors_binary_offline) for instructions on how to install executors in an air-gapped environment. The following steps will guide you through the process of installing executors on a linux machine. @@ -15,7 +15,7 @@ In order to run executors on your machine, a few things need to be set up correc - Git has to be installed at a version `>= v2.26` - The ability to run commands as `root` on the host machine and configure networking routes -If [Firecracker isolation will be used](/admin/executors/firecracker): _(recommended)_ +If [Firecracker isolation will be used](/self-hosted/executors/firecracker): _(recommended)_ - The host has to support KVM (for AWS that means a [metal instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html), on GCP that means [enabling nested virtualization](https://cloud.google.com/compute/docs/instances/nested-virtualization/enabling)) - The following additional dependencies need to be installed: @@ -76,7 +76,7 @@ mv executor /usr/local/bin The executor Linux binary is configured through environment variables which need to be passed to it when you run it (including for the `install`, `validate` and `test-vm` comamnds). You can add these to your shell profile, or an environment file. The `EXECUTOR_FRONTEND_URL`, `EXECUTOR_FRONTEND_PASSWORD` and `EXECUTOR_QUEUE_NAME` **or** `EXECUTOR_QUEUE_NAMES` are _required_ and will need to be set prior to running the executor service for the first time. -See [Executor configuration](/admin/executors/executors_config) for a full list of configuration options for the executor service. +See [Executor configuration](/self-hosted/executors/executors_config) for a full list of configuration options for the executor service. ```bash # Example: diff --git a/docs/admin/executors/deploy_executors_binary_offline.mdx b/docs/self-hosted/executors/deploy_executors_binary_offline.mdx similarity index 92% rename from docs/admin/executors/deploy_executors_binary_offline.mdx rename to docs/self-hosted/executors/deploy_executors_binary_offline.mdx index 5cc891198..f4ce239bd 100644 --- a/docs/admin/executors/deploy_executors_binary_offline.mdx +++ b/docs/self-hosted/executors/deploy_executors_binary_offline.mdx @@ -5,7 +5,7 @@ When running in an air-gap environment, the executor binary can be deployed with ## Initial Dependencies Executors -require [initial dependencies](/admin/executors/deploy_executors_binary#dependencies) to +require [initial dependencies](/self-hosted/executors/deploy_executors_binary#dependencies) to be installed on the host machine. The minimum dependencies (when not using [Firecracker](/admin/executors/#firecracker) Isolation) are: @@ -31,7 +31,7 @@ pull the images. ## Environment Variables -See [deploy executors binary](/admin/executors/deploy_executors_binary#step-2-setup-environment-variables) for a list of environment +See [deploy executors binary](/self-hosted/executors/deploy_executors_binary#step-2-setup-environment-variables) for a list of environment variables that are configurable. ## Batch Changes @@ -80,7 +80,7 @@ updating `codeIntelAutoIndexing.indexerMap` in the **Site configuration**. For e ## Firecracker Setup -See [Firecracker details](/admin/executors/firecracker) to determine if firecracker fits your use case. If you are using +See [Firecracker details](/self-hosted/executors/firecracker) to determine if firecracker fits your use case. If you are using Firecracker, you will need to install additional dependencies. If you are not using Firecracker, ensure the environment variable `EXECUTOR_USE_FIRECRACKER` is set to `false`. @@ -88,7 +88,7 @@ If you are not using Firecracker, ensure the environment variable `EXECUTOR_USE_ ### Initial Dependencies Executors running Firecracker Isolation -require [initial dependencies](/admin/executors/deploy_executors_binary#dependencies) to +require [initial dependencies](/self-hosted/executors/deploy_executors_binary#dependencies) to be installed on the host machine. - `dmsetup` @@ -136,7 +136,7 @@ Executors use `ignite` to spawn Firecracker VMs to run code in isolation. To ins ### Install IPTables IPTables prevent Firecracker from talking on Private IPv4 Address ( -see [Firecracker details](/admin/executors/firecracker#known-caveats)). To install IPTables, the `executor` binary has a command to +see [Firecracker details](/self-hosted/executors/firecracker#known-caveats)). To install IPTables, the `executor` binary has a command to install IPTables rules: ```shell diff --git a/docs/admin/executors/deploy_executors_dind.mdx b/docs/self-hosted/executors/deploy_executors_dind.mdx similarity index 82% rename from docs/admin/executors/deploy_executors_dind.mdx rename to docs/self-hosted/executors/deploy_executors_dind.mdx index 2c1e4bd67..b82d2081e 100644 --- a/docs/admin/executors/deploy_executors_dind.mdx +++ b/docs/self-hosted/executors/deploy_executors_dind.mdx @@ -17,9 +17,9 @@ Ensure you have the following tools installed: #### Deployment via Kustomize -Please refer to the [Sourcegraph Kustomize docs](/admin/deploy/kubernetes/kustomize) for the latest instructions. +Please refer to the [Sourcegraph Kustomize docs](/self-hosted/deploy/kubernetes/kustomize) for the latest instructions. -To include Executors dind, see [configure Sourcegraph with Kustomize](/admin/deploy/kubernetes/configure) on how to specify the component. +To include Executors dind, see [configure Sourcegraph with Kustomize](/self-hosted/deploy/kubernetes/configure) on how to specify the component. #### Deployment via Helm @@ -30,7 +30,7 @@ To specifically deploy Executors, 1. Create an overrides file, `override.yaml`, with any other customizations you may require. 1. See [details on configurations](/admin/deploy/kubernetes/helm#configuration) - 2. See [here](/admin/executors/executors_config) for a full list of executor environment variables + 2. See [here](/self-hosted/executors/executors_config) for a full list of executor environment variables 2. Run the following command: ```bash @@ -42,4 +42,4 @@ To specifically deploy Executors, Executors deployed in kubernetes do not use [Firecracker](/admin/executors/#how-it-works), meaning they require [privileged access](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) to the docker daemon running in a sidecar alongside the executor pod. -If you have security concerns, consider deploying via [terraform](/admin/executors/deploy_executors_terraform) or [installing the binary](/admin/executors/deploy_executors_binary) directly. +If you have security concerns, consider deploying via [terraform](/self-hosted/executors/deploy_executors_terraform) or [installing the binary](/self-hosted/executors/deploy_executors_binary) directly. diff --git a/docs/admin/executors/deploy_executors_docker.mdx b/docs/self-hosted/executors/deploy_executors_docker.mdx similarity index 89% rename from docs/admin/executors/deploy_executors_docker.mdx rename to docs/self-hosted/executors/deploy_executors_docker.mdx index bcd48df72..5eed44983 100644 --- a/docs/admin/executors/deploy_executors_docker.mdx +++ b/docs/self-hosted/executors/deploy_executors_docker.mdx @@ -18,11 +18,11 @@ Privileged containers are required to run executors in docker-compose. This is b - Minimum Docker [v20.10.0](https://docs.docker.com/engine/release-notes/#20100) and Docker Compose [v1.29.0](https://docs.docker.com/compose/release-notes/#1290) - Docker Swarm mode is **not** supported - Clone the [deploy-sourcegraph-docker](https://github.com/sourcegraph/deploy-sourcegraph-docker) -- Edit the `deploy-sourcegraph-docker/docker-compose/executors/executor.docker-compose.yaml` and update the [environment variables](/admin/executors/executors_config) +- Edit the `deploy-sourcegraph-docker/docker-compose/executors/executor.docker-compose.yaml` and update the [environment variables](/self-hosted/executors/executors_config) - Follow the instructions in the `README` for more specific deployment instructions. ## Note Executors deployed via docker-compose do not use [Firecracker](/admin/executors/#how-it-works), meaning they require [privileged access](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) to the docker daemon running on the host. -If you have security concerns, consider deploying via [terraform](/admin/executors/deploy_executors_terraform) or [installing the binary](/admin/executors/deploy_executors_binary) directly. +If you have security concerns, consider deploying via [terraform](/self-hosted/executors/deploy_executors_terraform) or [installing the binary](/self-hosted/executors/deploy_executors_binary) directly. diff --git a/docs/admin/executors/deploy_executors_kubernetes.mdx b/docs/self-hosted/executors/deploy_executors_kubernetes.mdx similarity index 92% rename from docs/admin/executors/deploy_executors_kubernetes.mdx rename to docs/self-hosted/executors/deploy_executors_kubernetes.mdx index 956a3909b..fd4499e51 100644 --- a/docs/admin/executors/deploy_executors_kubernetes.mdx +++ b/docs/self-hosted/executors/deploy_executors_kubernetes.mdx @@ -74,13 +74,13 @@ Native Kubernetes Executors can be deployed via either the `sourcegraph-executor Additional environment variables may need to be configured for your - Executors deployment. See [here](/admin/executors/executors_config) for + Executors deployment. See [here](/self-hosted/executors/executors_config) for a complete list. 3. Deploy the native Kubernetes Executor resources to your Kubernetes cluster via either the `sourcegraph-executor-k8s` [Helm chart](https://github.com/sourcegraph/deploy-sourcegraph-helm/tree/main/charts/sourcegraph-executor/k8s) or the `executors/k8s` [Kustomize component](https://github.com/sourcegraph/deploy-sourcegraph-k8s/tree/main/components/executors/k8s). - 1. For more details on how to work with the Sourcegraph Helm chart, see the [Helm chart docs](/admin/deploy/kubernetes#configuration) (_Note: The same Helm values `override.yaml` file can be used for both the main `sourcegraph` Helm chart as well as the `sourcegraph-executor-k8s` chart_) - 2. For more details on how to configure the `executors/k8s` component for your Kustomize deployment, see the [Kustomize configuration docs](/admin/deploy/kubernetes/configure#overview) + 1. For more details on how to work with the Sourcegraph Helm chart, see the [Helm chart docs](/self-hosted/deploy/kubernetes#configuration) (_Note: The same Helm values `override.yaml` file can be used for both the main `sourcegraph` Helm chart as well as the `sourcegraph-executor-k8s` chart_) + 2. For more details on how to configure the `executors/k8s` component for your Kustomize deployment, see the [Kustomize configuration docs](/self-hosted/deploy/kubernetes/configure#overview) 4. Once all the native Kubernetes Executor resources have been deployed to your cluster, confirm that the Executors are online by checking the _Executors_ page under **Site admin > Executors > Instances** ## Additional Notes @@ -89,8 +89,8 @@ Native Kubernetes Executors can be deployed via either the `sourcegraph-executor Executors deployed on Kubernetes do not use [Firecracker](/admin/executors/#how-it-works). -If you have security concerns, consider deploying via [terraform](/admin/executors/deploy_executors_terraform) -or [installing the binary](/admin/executors/deploy_executors_binary) directly. +If you have security concerns, consider deploying via [terraform](/self-hosted/executors/deploy_executors_terraform) +or [installing the binary](/self-hosted/executors/deploy_executors_binary) directly. ### Job Scheduling diff --git a/docs/admin/executors/deploy_executors_terraform.mdx b/docs/self-hosted/executors/deploy_executors_terraform.mdx similarity index 99% rename from docs/admin/executors/deploy_executors_terraform.mdx rename to docs/self-hosted/executors/deploy_executors_terraform.mdx index 39c9dc780..4e64ceefa 100644 --- a/docs/admin/executors/deploy_executors_terraform.mdx +++ b/docs/self-hosted/executors/deploy_executors_terraform.mdx @@ -286,7 +286,7 @@ you@sourcegraph-executor-h0rv:~$ curl ## Auto-scaling > NOTE: Auto scaling is currently not supported -> when [downloading and running executor binaries yourself](/admin/executors/deploy_executors_binary), +> when [downloading and running executor binaries yourself](/self-hosted/executors/deploy_executors_binary), > and on managed instances when using self-hosted executors, since it requires deployment adjustments. Auto-scaling of executor instances can help to increase concurrency of jobs, without paying for unused resources. With auto-scaling, you can scale down to 0 instances when no workload exist and scale up as far as you like and your cloud provider can support. Auto-scaling needs to be configured separately. @@ -410,7 +410,7 @@ Next, you can test whether the number of executors rises and shrinks as load spi ## Upgrading executors Upgrading executors is relatively uninvolved. Simply follow the instructions below. -Also, check the [changelog](https://sourcegraph.com/changelog) for any Executors related breaking changes or new features or flags that you might want to configure. See [Executors maintenance](/admin/executors/deploy_executors#Maintaining-and-upgrading-executors) for version compatability. +Also, check the [changelog](https://sourcegraph.com/changelog) for any Executors related breaking changes or new features or flags that you might want to configure. See [Executors maintenance](/self-hosted/executors/deploy_executors#Maintaining-and-upgrading-executors) for version compatability. ### **Step 1:** Update the source version of the terraform modules diff --git a/docs/admin/executors/executors_config.mdx b/docs/self-hosted/executors/executors_config.mdx similarity index 100% rename from docs/admin/executors/executors_config.mdx rename to docs/self-hosted/executors/executors_config.mdx diff --git a/docs/admin/executors/executors_troubleshooting.mdx b/docs/self-hosted/executors/executors_troubleshooting.mdx similarity index 95% rename from docs/admin/executors/executors_troubleshooting.mdx rename to docs/self-hosted/executors/executors_troubleshooting.mdx index b413c34a4..d1db17000 100644 --- a/docs/admin/executors/executors_troubleshooting.mdx +++ b/docs/self-hosted/executors/executors_troubleshooting.mdx @@ -21,7 +21,7 @@ You can now run `executor validate`, which will inform you about any configurati The next step is to create a temporary Firecracker VM for debugging purposes. -> NOTE: if the host VM is provisioned with the [Sourcegraph terraform modules](/admin/executors/deploy_executors_terraform), the VMs may be configured to stop automatically. Refer to [Disabling the auto-deletion of Executor VMs](#disabling-the-auto-deletion-of-executor-vms) for information to prevent this. +> NOTE: if the host VM is provisioned with the [Sourcegraph terraform modules](/self-hosted/executors/deploy_executors_terraform), the VMs may be configured to stop automatically. Refer to [Disabling the auto-deletion of Executor VMs](#disabling-the-auto-deletion-of-executor-vms) for information to prevent this. Run one of the following commands `executor test-vm` to generate a test firecracker VM: @@ -44,7 +44,7 @@ Execute the generated `ignite attach ` command to gain a shell to the Firecr ## Disabling the auto-deletion of Executor VMs -> NOTE: These instructions are for users using the VMs deployed via the [Terraform Modules](/admin/executors/deploy_executors_terraform) +> NOTE: These instructions are for users using the VMs deployed via the [Terraform Modules](/self-hosted/executors/deploy_executors_terraform) The Executor host VMs are configured to automatically tear themselves down once all jobs in the queue are completed. While this is desired behaviour under regular circumstances, it complicates debugging issues in the executor configuration or connections. To prevent the VMs from automatically stopping: @@ -58,7 +58,7 @@ The VM should now persist after all jobs are satisfied. If a server-side batch change fails unexpectedly, it's possible to recreate the generated Firecracker VM from the batch change execution. -> NOTE: if the host VM is provisioned with the [Sourcegraph terraform modules](/admin/executors/deploy_executors_terraform), the VMs may be configured to stop automatically. Refer to [Disabling the auto-deletion of Executor VMs](#disabling-the-auto-deletion-of-executor-vms) for information to prevent this. +> NOTE: if the host VM is provisioned with the [Sourcegraph terraform modules](/self-hosted/executors/deploy_executors_terraform), the VMs may be configured to stop automatically. Refer to [Disabling the auto-deletion of Executor VMs](#disabling-the-auto-deletion-of-executor-vms) for information to prevent this. 1. Navigate to the failed execution page of the Batch Change 1. Select a failed Workspace on the left and click the `Diagnostics` link on the right pane @@ -188,7 +188,7 @@ This section lists some common mistakes with environment variables. Some of thes ## Verify Firecracker support -The VM instance must [support KVM](/admin/executors/deploy_executors#firecracker-requirements). In effect, this means the instance must meet certain requirements depending on the Cloud provider in use. +The VM instance must [support KVM](/self-hosted/executors/deploy_executors#firecracker-requirements). In effect, this means the instance must meet certain requirements depending on the Cloud provider in use. ### GCP diff --git a/docs/admin/executors/firecracker.mdx b/docs/self-hosted/executors/firecracker.mdx similarity index 94% rename from docs/admin/executors/firecracker.mdx rename to docs/self-hosted/executors/firecracker.mdx index bde3c1cb8..aed377a36 100644 --- a/docs/admin/executors/firecracker.mdx +++ b/docs/self-hosted/executors/firecracker.mdx @@ -12,7 +12,7 @@ See [this architecture diagram](/admin/executors/#firecracker) detailing Firecra Using Firecracker is our **most secure** isolation method, but it is not a **necessary** isolation method. Most users will be fine running containers on the executor host, or deploying bundled executors via Kubernetes jobs. Firecracker isolation was created when our design constrains included multi-tenant environments, and is likely overkill for any on-premise Sourcegraph instance administrated by a single company. -For companies with very high security consciousness, Firecracker isolation is still an option. See the [How to use](/admin/executors/firecracker#how-to-use) for installation instructions and deployment caveats. +For companies with very high security consciousness, Firecracker isolation is still an option. See the [How to use](/self-hosted/executors/firecracker#how-to-use) for installation instructions and deployment caveats. > Note: Firecracker relies on some specific kernel extensions to run, which are only available on some classes of compute on Cloud providers such as AWS and GCP. @@ -20,7 +20,7 @@ For companies with very high security consciousness, Firecracker isolation is st To use Firecracker, the host machine has to support KVM. When deploying on an AWS, that means the compute node must run on a [metal instance (`.metal`)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html). When deploying on GCP, that means the compute node must have [nested virtualization enabled](https://cloud.google.com/compute/docs/instances/nested-virtualization/enabling). -See [deploying Executors binary](/admin/executors/deploy_executors_binary) for additional information on configuring Linux Machines. +See [deploying Executors binary](/self-hosted/executors/deploy_executors_binary) for additional information on configuring Linux Machines. ### AWS Bare Metal diff --git a/docs/self-hosted/executors/index.mdx b/docs/self-hosted/executors/index.mdx new file mode 100644 index 000000000..ebce562e0 --- /dev/null +++ b/docs/self-hosted/executors/index.mdx @@ -0,0 +1,189 @@ +# Executors + + + Supported on [Enterprise](/pricing/enterprise) plans. + Available via the Web app. + + +Executors are Sourcegraph's solution for running untrusted code in a secure and controllable way. Executors provide a sandbox that can run resource-intensive or untrusted tasks on behalf of the Sourcegraph instance, such as: + +- [Automatically indexing a repository for precise code navigation](/code-navigation/auto_indexing) +- [Running batch changes](/batch-changes/server-side) + +## Installation + +To deploy executors for your Sourcegraph instance, follow our [executor deployment guide](executors/deploy_executors). + +## Why use executors? + +Running untrusted code is a core requirement of features such as precise code navigation [auto-indexing](/code-navigation/auto_indexing), and [running batch changes server-side](/batch-changes/server-side). + +Auto-indexing jobs, in particular, require the invocation of arbitrary and untrusted code to support the resolution of project dependencies. Invocation of post-install hooks, use of insecure [package management tools](https://github.com/golang/go/issues/29230), and package manager proxy attacks can create opportunities in which an adversary can gain unlimited use of compute or exfiltrate data. The latter outcome is particularly dangerous for on-premise installations of Sourcegraph, which is the chosen option for companies wanting to maintain strict privacy of their code property. + +Instead of performing this work within the Sourcegraph instance, where code is available on disk and unprotected internal services are available over the local network, we move untrusted compute into a sandboxed environment, the _executor_, that has access only to the clone of a single repository on disk (its _workspace_) and to the public internet. + +## Sandboxing Model + +Executors can be deployed with [Firecracker](https://sourcegraph.com/github.com/firecracker-microvm/firecracker) isolation in accordance with our [sandboxing model](/admin/executors/#how-it-works) to isolate jobs from each other and the host. +This requires executors to be run on machines capable of running Linux KVM extensions. On the most popular cloud providers, this either means running executors on bare-metal machines (AWS) or machines capable of nested virtualization (GCP). + +Optionally, executors can be run without using KVM-based isolation, which is less secure but might be easier to run on common machines. + +## Deciding which executor deployment method to use + +Deciding how to deploy the executor depends on your use case. For users that wish to process their untrusted compute in the most secure manner, we recommend leveraging the [Firecracker](./executors/firecracker) isolation method. For users that have constraints around running nested virtualization, the following flowchart can help you decide which deployment option is best for your environment: + +Executor Deployment Flowchart + +## How it works + +Executor instances are capable of being deployed in a variety of ways. Each runtime varies in how jobs are executed. + +### Locally with src-cli + +Executors architecture - local with src-cli + +1. User runs the `src` (e.g. `src batch`) command from the command line. +2. `src` calls the Sourcegraph API to clone a repository. + 1. The repositories are written to a directory. +3. A Docker Container is created for each "step." + 1. The directory containing the repository is mounted to the container. + 2. "Steps" are ran in sequential order. +4. The container run a defined command against the repository. +5. Logs from the container are sent back to `src`. +6. At the end of processing all repositories, the result is sent to a Sourcegraph API. + 1. e.g. Batch Changes sends a `git diff` to a Sourcegraph API (and invokes other APIs). + +### Binary + +Executors architecture - binary + +1. The executor binary is installed to a machine. + 1. Additional executables (e.g. Docker, `src`) are installed as well +2. The executor instances pulls for available Jobs from a Sourcegraph API +3. A user initiates a process that creates executor Jobs. +4. The executor instance "dequeues" a Job. +5. Executor calls the Sourcegraph API to clone a repository. + 1. The repositories are written to a directory. +6. A Docker Container is created for each "step." + 1. If the Job is `batches` (non-native execution), `src` is invoked + 2. Docker is invoked directly for other Jobs (`codeintel` and native execution `batches`) + 3. The directory containing the repository is mounted to the container. + 4. "Steps" are ran in sequential order. +7. The container run a defined command against the repository. +8. Logs from the container are sent back to the executor. +9. Logs are streamed from the executor to a Sourcegraph API +10. The executor calls a Sourcegraph API to that "complete" the Job. + +### Firecracker + +> NOTE: [What the heck is firecracker, anyway](/self-hosted/executors/firecracker)?? + +Executors architecture - firecracker + +1. The executor binary is installed to a machine. + 1. Additional executables (e.g. Docker, `src`) are installed as well +2. The executor instances pulls for available Jobs from a Sourcegraph API +3. A user initiates a process that creates executor Jobs. +4. The executor instance "dequeues" a Job. +5. Executor calls the Sourcegraph API to clone a repository. + 1. The repositories are written to a directory. +6. `ignite` starts up a Docker container that spawns a single Firecracker VM within the Docker container. + 1. The directory containing the repository is mounted to the VM. +7. Docker Container is created in the Firecracker VM for each "step." + 1. If the Job is `batches` (non-native execution), `src` is invoked + 2. Docker is invoked directly for other Jobs (`codeintel` and native execution `batches`) + 3. "Steps" are ran in sequential order. +8. Within each Firecracker VM a single Docker container is created +9. The container run a defined command against the repository. +10. Logs from the container are sent back to the executor. +11. Logs are streamed from the executor to a Sourcegraph API +12. The executor calls a Sourcegraph API to that "complete" the Job. + +### Docker + +Executors architecture - docker + +1. The executor image is started as a Docker container on a machine +2. The executor pulls for available Jobs from a Sourcegraph API +3. A user initiates a process that creates executor Jobs. +4. The executor instance "dequeues" a Job. +5. Executor calls the Sourcegraph API to clone a repository. + 1. The repositories are written to a directory. +6. A Docker Container is created for each "step." + 1. If the Job is `batches` (non-native execution), `src` is invoked + 2. Docker is invoked directly for other Jobs (`codeintel` and native execution `batches`) + 3. The directory containing the repository is mounted to the container. + 4. "Steps" are ran in sequential order. +7. The container run a defined command against the repository. +8. Logs from the container are sent back to the executor. +9. Logs are streamed from the executor to a Sourcegraph API +10. The executor calls a Sourcegraph API to that "complete" the Job. + +### Native Kubernetes + +> NOTE: This is an experimental feature. + +Executors architecture - native kubernetes + +1. The executor image is started as a pod in a Kubernetes node +2. The executor pulls for available Jobs from a Sourcegraph API +3. A user initiates a process that creates executor Jobs. +4. The executor instance "dequeues" a Job. +5. Executor calls the Sourcegraph API to clone a repository. + 1. The repositories are written to a directory. +6. A Kubernetes Job is created for each "step." + 1. The directory containing the repository is mounted to the container. + 2. "Steps" are ran in sequential order. +7. The container run a defined command against the repository. +8. Logs from the container are sent back to the executor. +9. Logs are streamed from the executor to a Sourcegraph API +10. The executor calls a Sourcegraph API to that "complete" the Job. + +### Docker-in-Docker Kubernetes + +> NOTE: This is an experimental feature. + +Executors architecture - docker in docker kubernetes + +1. The executor image is started as a container in Kubernetes Pod + 1. The dind image is started as a sidecar container in the same Kubernetes Pod +2. The executor pulls for available Jobs from a Sourcegraph API +3. A user initiates a process that creates executor Jobs. +4. The executor instance "dequeues" a Job. +5. Executor calls the Sourcegraph API to clone a repository. + 1. The repositories are written to a directory. +6. A Docker Container is created for each "step." + 1. If the Job is `batches` (non-native execution), `src` is invoked + 2. Docker is invoked directly for other Jobs (`codeintel` and native execution `batches`) + 3. The directory containing the repository is mounted to the container. + 4. "Steps" are ran in sequential order. +7. The container run a defined command against the repository. +8. Logs from the container are sent back to the executor. +9. Logs are streamed from the executor to a Sourcegraph API +10. The executor calls a Sourcegraph API to that "complete" the Job. + +## Troubleshooting + +Refer to the [Troubleshooting Executors](/self-hosted/executors/executors_troubleshooting) document for common debugging operations. diff --git a/docs/admin/external_services/index.mdx b/docs/self-hosted/external_services/index.mdx similarity index 81% rename from docs/admin/external_services/index.mdx rename to docs/self-hosted/external_services/index.mdx index 5125e3bb7..0ba457e33 100644 --- a/docs/admin/external_services/index.mdx +++ b/docs/self-hosted/external_services/index.mdx @@ -18,10 +18,10 @@ Your Sourcegraph instance can be configured to use an external or managed versio See the following guides to use an external or managed version of each service type. -- See [Using your own PostgreSQL server](/admin/external_services/postgres) to replace the bundled PostgreSQL instances. -- See [Using your own Redis server](/admin/external_services/redis) to replace the bundled Redis instances. -- See [Using a managed object storage service (S3 or GCS)](/admin/external_services/object_storage) to replace the bundled blobstore instance. -- See [Using an external Jaeger instance](/admin/observability/tracing#Use-an-external-Jaeger-instance) to replace the bundled Jaeger instance. +- See [Using your own PostgreSQL server](/self-hosted/external_services/postgres) to replace the bundled PostgreSQL instances. +- See [Using your own Redis server](/self-hosted/external_services/redis) to replace the bundled Redis instances. +- See [Using a managed object storage service (S3 or GCS)](/self-hosted/external_services/object_storage) to replace the bundled blobstore instance. +- See [Using an external Jaeger instance](/self-hosted/observability/tracing#Use-an-external-Jaeger-instance) to replace the bundled Jaeger instance. > NOTE: Using Sourcegraph with an external service is a [paid feature](https://about.sourcegraph.com/pricing). [Contact us](https://about.sourcegraph.com/contact/sales) to get a trial license. diff --git a/docs/admin/external_services/object_storage.mdx b/docs/self-hosted/external_services/object_storage.mdx similarity index 100% rename from docs/admin/external_services/object_storage.mdx rename to docs/self-hosted/external_services/object_storage.mdx diff --git a/docs/admin/external_services/postgres.mdx b/docs/self-hosted/external_services/postgres.mdx similarity index 96% rename from docs/admin/external_services/postgres.mdx rename to docs/self-hosted/external_services/postgres.mdx index a882f523b..160df042f 100644 --- a/docs/admin/external_services/postgres.mdx +++ b/docs/self-hosted/external_services/postgres.mdx @@ -7,7 +7,7 @@ import { You can use your own PostgreSQL v16+ server with Sourcegraph if you wish. For example, you may prefer this if you already have existing backup infrastructure around your own PostgreSQL server, wish to use Amazon RDS, etc. -Please review the [PostgreSQL](/admin/postgres) documentation for a complete list of requirements. +Please review the [PostgreSQL](/self-hosted/postgres) documentation for a complete list of requirements. As of version 6.0.0 The Sourcegraph application will require PostgreSQL @@ -101,7 +101,7 @@ You are then free to remove the now unused `pgsql` and `codeintel-db` services a ### Version requirements -Please refer to our [Postgres](/admin/postgres) documentation to learn about version requirements. +Please refer to our [Postgres](/self-hosted/postgres) documentation to learn about version requirements. ### Caveats @@ -346,7 +346,7 @@ CREATE extension intarray; After the database is configured, Sourcegraph will attempt to run migrations. There are a few migrations that may fail as they attempt to run actions that require `SUPERUSER` permissions. -These failures must be interpreted by the database administrator and resolved using guidance from [How to Troubleshoot a Dirty Database](/admin/how-to/dirty_database). Generally-speaking this will involve looking up the migration source code and manually applying the necessary SQL code. +These failures must be interpreted by the database administrator and resolved using guidance from [How to Troubleshoot a Dirty Database](/self-hosted/how-to/dirty_database). Generally-speaking this will involve looking up the migration source code and manually applying the necessary SQL code. **Initial Schema Creation** @@ -356,7 +356,7 @@ The first migration fails since it attempts to add `COMMENT`s to installed exten failed to run migration for schema "frontend": failed upgrade migration 1528395834: ERROR: current transaction is aborted, commands ignored until end of transaction block (SQLSTATE 25P02) ``` -In this case, locate the UP migration 1528395834 and apply all SQL after the final `COMMENT ON EXTENSION` command following the [dirty database procedure](/admin/how-to/dirty_database). +In this case, locate the UP migration 1528395834 and apply all SQL after the final `COMMENT ON EXTENSION` command following the [dirty database procedure](/self-hosted/how-to/dirty_database). **Dropping the `sg_service` role** @@ -407,7 +407,7 @@ CREATE extension intarray; After the database is configured, Sourcegraph will attempt to run migrations, this time using the CodeIntel DB. There are a few migrations that may fail as they attempt to run actions that require `SUPERUSER` permissions. -These failures must be intepreted by the database administrator and resolved using guidance from [How to Troubleshoot a Dirty Database](/admin/how-to/dirty_database). Generally-speaking this will involve looking up the migration source code and manually applying the necessary SQL code. The `codeintel_schema_migrations` table should be consulted for dirty migrations in this case. +These failures must be intepreted by the database administrator and resolved using guidance from [How to Troubleshoot a Dirty Database](/self-hosted/how-to/dirty_database). Generally-speaking this will involve looking up the migration source code and manually applying the necessary SQL code. The `codeintel_schema_migrations` table should be consulted for dirty migrations in this case. **Initial CodeIntel schema creation** diff --git a/docs/admin/external_services/redis.mdx b/docs/self-hosted/external_services/redis.mdx similarity index 90% rename from docs/admin/external_services/redis.mdx rename to docs/self-hosted/external_services/redis.mdx index 4701d2e1d..d980b8596 100644 --- a/docs/admin/external_services/redis.mdx +++ b/docs/self-hosted/external_services/redis.mdx @@ -23,5 +23,5 @@ If using Docker for Desktop, `host.docker.internal` will resolve to the host IP ### Kubernetes without Helm -- See our documentation for Kubernetes [here](/admin/deploy/kubernetes/configure#external-redis) -- **Related:** [How to Set a Password for Redis using a ConfigMap](/admin/how-to/redis_configmap) +- See our documentation for Kubernetes [here](/self-hosted/deploy/kubernetes/configure#external-redis) +- **Related:** [How to Set a Password for Redis using a ConfigMap](/self-hosted/how-to/redis_configmap) diff --git a/docs/self-hosted/faq.mdx b/docs/self-hosted/faq.mdx new file mode 100644 index 000000000..9aa9e3867 --- /dev/null +++ b/docs/self-hosted/faq.mdx @@ -0,0 +1,106 @@ +# Administration FAQ + +## How does Sourcegraph store repositories on disk? + +Sourcegraph stores bare Git repositories (without a working tree), which is a complete mirror of the repository on your code host. + +## How do I set up redirect URLs in Sourcegraph? + +Sometimes URLs in Sourcegraph may change. For example, if a code host configuration is +updated to use a different `repositoryPathPattern`, this will change the repository URLs on +Sourcegraph. Users may wish to preserve links to the old URLs, and this requires adding redirects. + +We recommend configuring redirects in a reverse proxy. If you are running Sourcegraph as a single +Docker image, you can deploy a reverse proxy such as [Caddy](https://caddyserver.com/) or +[NGINX](https://www.nginx.com) in front of it. Refer to the +[Caddy](https://github.com/caddyserver/caddy/wiki/v2:-Documentation#rewrite) or +[NGINX](https://www.nginx.com/blog/creating-nginx-rewrite-rules/) documentation for URL rewrites. + +If you are running Sourcegraph as a Kubernetes cluster, you have two additional options: + +1. If you are using NGINX ingress (`kubectl get ingress | grep sourcegraph-frontend`), modify + [`sourcegraph-frontend.Ingress.yaml`](https://github.com/sourcegraph/deploy-sourcegraph-k8s/blob/main/base/sourcegraph/frontend/sourcegraph-frontend.Ingress.yaml) + by [adding a rewrite rule](https://kubernetes.github.io/ingress-nginx/examples/rewrite/). You can also refer to the [ingress configuration examples](https://github.com/sourcegraph/deploy-sourcegraph-k8s/tree/main/examples/ingress-controller). + +## What external HTTP checks are configured? + +We leave the choice of which external HTTP check monitor up to our users. What we provide out-of-the-box is extensive metrics monitoring through Prometheus and Grafana, with builtin alert thresholds and dashboards, and Kubernetes/Docker HTTP health checks which verify that the server is running. Sourcegraph's frontend has a default health check at +https://$SOURCEGRAPH_BASE_URL/healthz. Some users choose to set up their own external HTTP health checker which tests if the homepage loads, a repository page loads, and if a search GraphQL request returns successfully. + +## Monitoring + +Please visit our [Observability Docs](/self-hosted/observability) for more in-depth information about observability in Sourcegraph. + +### What should I look at when my instance is having performance issues? + +Sourcegraph comes with built-in monitoring in the form of [Grafana](/self-hosted/observability/metrics#grafana), connected to [Prometheus](/self-hosted/observability/metrics#prometheus) for metrics and alerting. + +Generally, Grafana should be the first stop you make when experiencing a system performance issue. From there you can look for system alerts or metrics that would provide you with more insights on what’s causing the performance issue. You can learn more about [accessing Grafana here](/self-hosted/observability/metrics#grafana). + +### What are the key values/alerts to look for when looking at the Grafana Dashboard? + +Please refer to the [Dashboards](/self-hosted/observability/metrics#dashboards) guide for more on how to use our Grafana dashboards. + +Please refer to [Understanding alerts](/self-hosted/observability/alerting#understanding-alerts) for examples and suggested actions for alerts. + +### How do I know when more resources are needed for a specified service? + +All resource dashboards contain a section called `Provisioning indicators` that provide information about the current resource usage of containers. These can be used to determine if a scale-up is needed ([example panel](/self-hosted/observability/dashboards#frontend-provisioning-container-cpu-usage-long-term)). + +More information on each available panel in the dashboards is available in the [Dashboards reference](/self-hosted/observability/dashboards). + +### What does this `` mean? + +See [Alert solutions](/self-hosted/observability/alerts) to learn about each alert and their possible solutions. + +### What’s the threshold for each resource? + +All resources dashboards contain a section called `Container monitoring` that indicate thresholds at which alerts will fire for each resource ([example alert](/self-hosted/observability/alerts#frontend-container-cpu-usage)). + +More information on each available panel in the dashboards is available in the [Dashboards reference](/self-hosted/observability/dashboards). + +### How much resources should I add after receiving alerts about running out of resources? + +You should make the decision based on the metrics from the relevant Grafana dashboard linked in each alert. + +### What are some of the important alerts that I should be aware of? + +We recommend paying closer attention to [critical alerts](/self-hosted/observability/alerting#understanding-alerts). + +### How do I set up alerts? + +Please refer to our guide on [setting up alerting](/self-hosted/observability/alerting#setting-up-alerting). + +### How do I create a custom alert? + +Creating a custom alert is not recommended and currently not supported by Sourcegraph. However, please provide feedback on the monitoring dashboards and alerts if you find anything could be improved via our issue tracker. + +More advanced users can also refer to [our FAQ item about custom consumption of Sourcegraph metrics](#can-i-consume-sourcegraph-s-metrics-in-my-own-monitoring-system-datadog-new-relic-etc). + +### Can I consume Sourcegraph's metrics in my own monitoring system (Datadog, New Relic, etc.)? + +Sourcegraph provides [high-level alerting metrics](/self-hosted/observability/metrics#high-level-alerting-metrics) which you can integrate into your own monitoring system—see the [alerting custom consumption guide](/self-hosted/observability/alerting_custom_consumption) for more details. + +While it is technically possible to consume all of Sourcegraph's metrics in an external system, our recommendation is to utilize the builtin monitoring tools and configure Sourcegraph to [send alerts to your own PagerDuty, Slack, email, etc.](/self-hosted/observability/alerting). Metrics and thresholds can change with each release, therefore manually defining the alerts required to monitor Sourcegraph's health is not recommended. Sourcegraph automatically updates the dashboards and alerts on each release to ensure the displayed information is up-to-date. + +Other monitoring systems that support Prometheus scraping (for example, Datadog and New Relic) or [Prometheus federation](https://prometheus.io/docs/prometheus/latest/federation/) can be configured to federate Sourcegraph's [high-level alerting metrics](/self-hosted/observability/metrics#high-level-alerting-metrics). For information on how to configure those systems, please check your provider's documentation. + +The `/-/debug/grafana` endpoint is specifically designed for the built-in Grafana instance that comes with Sourcegraph. When using an external Grafana instance, this endpoint won't automatically redirect to your custom Grafana URL. + +To properly integrate your external Grafana and Prometheus instances with Sourcegraph, you'll want to: +Ensure your configuration in values.yaml is correct: + +``` +frontend: + env: + GRAFANA_SERVER_URL: + value: https://grafana.mycompany.com + PROMETHEUS_URL: + value: http://prometheus.mycompany.com +``` + +You can then access your dashboards directly through your Grafana instance URL. + +### I am getting "Error: Cluster information not available" in the Instrumentation page, what should I do? + +This error is expected if your instance was not [deployed with Kubernetes](/self-hosted/deploy/kubernetes/). The Instrumentation page is currently only available for Kubernetes instances. diff --git a/docs/admin/how-to/blobstore_debugging.mdx b/docs/self-hosted/how-to/blobstore_debugging.mdx similarity index 94% rename from docs/admin/how-to/blobstore_debugging.mdx rename to docs/self-hosted/how-to/blobstore_debugging.mdx index 8322d040b..3a938d103 100644 --- a/docs/admin/how-to/blobstore_debugging.mdx +++ b/docs/self-hosted/how-to/blobstore_debugging.mdx @@ -1,6 +1,6 @@ # Blobstore debugging tips -If you recently updated to Sourcegraph v4.2.1+, please be sure to look at the [blobstore update notes](/admin/how-to/blobstore_update_notes) +If you recently updated to Sourcegraph v4.2.1+, please be sure to look at the [blobstore update notes](/self-hosted/how-to/blobstore_update_notes) This page provides more tips on debugging why blobstore may not be working properly. @@ -8,7 +8,7 @@ This page provides more tips on debugging why blobstore may not be working prope ## Can I disable blobstore? -Today, Sourcegraph uses blobstore for storing precise code intel (LSIF/SCIP) uploads. You can also configure Sourcegraph to use [S3 or GCS for object storage](/admin/external_services/object_storage) if you prefer. +Today, Sourcegraph uses blobstore for storing precise code intel (LSIF/SCIP) uploads. You can also configure Sourcegraph to use [S3 or GCS for object storage](/self-hosted/external_services/object_storage) if you prefer. In the near future, other Sourcegraph features like Batch Changes may also rely on object storage and so, if possible, it's best to make sure it is working. diff --git a/docs/admin/how-to/blobstore_update_notes.mdx b/docs/self-hosted/how-to/blobstore_update_notes.mdx similarity index 85% rename from docs/admin/how-to/blobstore_update_notes.mdx rename to docs/self-hosted/how-to/blobstore_update_notes.mdx index 9cae3e2b0..668748d8f 100644 --- a/docs/admin/how-to/blobstore_update_notes.mdx +++ b/docs/self-hosted/how-to/blobstore_update_notes.mdx @@ -8,7 +8,7 @@ Sourcegraph is committed to only distributing open-source software that is permi As a result, Sourcegraph v4.2.1+ and v4.3+ no longer use or distribute _any_ minio or AGPL-licensed software. -If your Sourcegraph instance is already configured to use [external object storage](/admin/external_services/object_storage), or you use `DISABLE_MINIO=true` in `sourcegraph/server` deployments, then this change should not affect you (there would already be no Minio software running as part of Sourcegraph). It is also safe to remove any minio specific env variables from your deployment. +If your Sourcegraph instance is already configured to use [external object storage](/self-hosted/external_services/object_storage), or you use `DISABLE_MINIO=true` in `sourcegraph/server` deployments, then this change should not affect you (there would already be no Minio software running as part of Sourcegraph). It is also safe to remove any minio specific env variables from your deployment. **If you are on running a proxy with the `NO_PROXY` env variable, you'll need to make sure that minio is removed from this list, and blobstore is added.** diff --git a/docs/admin/how-to/clear_codeintel_data.mdx b/docs/self-hosted/how-to/clear_codeintel_data.mdx similarity index 89% rename from docs/admin/how-to/clear_codeintel_data.mdx rename to docs/self-hosted/how-to/clear_codeintel_data.mdx index 8fc4328f6..8d02d5294 100644 --- a/docs/admin/how-to/clear_codeintel_data.mdx +++ b/docs/self-hosted/how-to/clear_codeintel_data.mdx @@ -4,7 +4,7 @@ Clear all precise code intelligence data from your instance and start fresh. ## Clearing the `frontend` database -The following commands assume a connection to the `frontend` database. Refer to our guide on [`psql`](/admin/how-to/run-psql) if you do not use an [external database](/admin/external_services/). +The following commands assume a connection to the `frontend` database. Refer to our guide on [`psql`](/self-hosted/how-to/run-psql) if you do not use an [external database](/self-hosted/external_services/). If you are clearing **all** code intelligence data, then you will need to clear the metadata information in the frontend database. This will clear the high-level information about code intelligence indexes, but the raw data will remain in the `codeintel-db` database, which will also need to be cleared (see the next section). @@ -27,7 +27,7 @@ COMMIT; ## Clearing the `codeintel-db` database -The following commands assume a connection to the `codeintel-db` database. Refer to our guide on [`psql`](/admin/how-to/run-psql) if you do not use an [external database](/admin/external_services/). +The following commands assume a connection to the `codeintel-db` database. Refer to our guide on [`psql`](/self-hosted/how-to/run-psql) if you do not use an [external database](/self-hosted/external_services/). ### Clearing LSIF data diff --git a/docs/admin/how-to/dirty_database.mdx b/docs/self-hosted/how-to/dirty_database.mdx similarity index 83% rename from docs/admin/how-to/dirty_database.mdx rename to docs/self-hosted/how-to/dirty_database.mdx index 64995c54c..9d032578b 100644 --- a/docs/admin/how-to/dirty_database.mdx +++ b/docs/self-hosted/how-to/dirty_database.mdx @@ -1,6 +1,6 @@ # How to troubleshoot a dirty database -> NOTE: If you are on a version **strictly lower than** Sourcegraph 3.37.0, see the [legacy dirty database documentation](/admin/how-to/dirty_database_pre_3_37). The following documentation applies only to Sourcegraph instances version 3.37.0 and above. +> NOTE: If you are on a version **strictly lower than** Sourcegraph 3.37.0, see the [legacy dirty database documentation](/self-hosted/how-to/dirty_database_pre_3_37). The following documentation applies only to Sourcegraph instances version 3.37.0 and above. This document will take you through how to resolve a 'dirty database' error. @@ -23,9 +23,9 @@ The target schema is marked as dirty and no other migration operation is seen ru ## Prerequisites - 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.](/admin/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.** +- **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](/admin/deploy/kubernetes/operations#access-the-database), [docker-compose](/admin/deploy/docker-compose/#access-the-database), and [Sourcegraph single-container](/admin/deploy/docker-single-container/#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), [docker-compose](/admin/deploy/docker-compose/#access-the-database), and [Sourcegraph single-container](/admin/deploy/docker-single-container/#access-the-database) instances at these links. ## Steps to resolve @@ -33,7 +33,7 @@ The following procedure requires that you are able to execute commands from insi Some classes of errors can be successfully retried via a manual invocation of the failed `migrator` command. If the previous operation was interrupted due to a network issue, a timeout, or a crashed/restarted database host, or if the error that occurred was due to a transient error such as a SQL deadlock, then re-application of the migration is likely to succeed. -When [re-running the migrator](/admin/updates/migrator/migrator-operations), add the optional flag `--ignore-single-dirty-log` to attempt re-application of a previously failed migration, and add the optional flag `--ignore-single-pending-log` to to attempt re-application of a migration which was never completed by a previous invocation of the `migrator`. Both flags apply to the `migrator` commands `up`, `upto`, `downto`, `upgrade`, and `downgrade`. These flags only allow re-application of the **next** migration in the sequence (and multiple sequential failures will require multiple invocations). +When [re-running the migrator](/self-hosted/updates/migrator/migrator-operations), add the optional flag `--ignore-single-dirty-log` to attempt re-application of a previously failed migration, and add the optional flag `--ignore-single-pending-log` to to attempt re-application of a migration which was never completed by a previous invocation of the `migrator`. Both flags apply to the `migrator` commands `up`, `upto`, `downto`, `upgrade`, and `downgrade`. These flags only allow re-application of the **next** migration in the sequence (and multiple sequential failures will require multiple invocations). **DO NOT** set either of these flags permanently on a `migrator` attached as an init container (in Kubernetes) or as a dependent container (in Docker Compose), as it may allow mutation of the database schema with non-mutual access. Concurrent modification may result in greater error frequency (at best) and data corruption (at worst). These flags should only be used on a manual invocation of a `migrator` command. @@ -107,7 +107,7 @@ If you're running into errors such as being unable to create a unique index due ### 3. Add a migration log entry -**Ensure the migration applied, then signal that the migration has been run**. Run the `migrator` instance against your database to create an explicit migration log. For the following, consult the [Kubernetes](/admin/updates/migrator/migrator-operations#kubernetes), [Docker-compose](/admin/updates/migrator/migrator-operations#docker--docker-compose), or [local development](/admin/updates/migrator/migrator-operations#local-development) instructions on how to manually run database operations. The specific migrator command to run is: +**Ensure the migration applied, then signal that the migration has been run**. Run the `migrator` instance against your database to create an explicit migration log. For the following, consult the [Kubernetes](/self-hosted/updates/migrator/migrator-operations#kubernetes), [Docker-compose](/self-hosted/updates/migrator/migrator-operations#docker--docker-compose), or [local development](/self-hosted/updates/migrator/migrator-operations#local-development) instructions on how to manually run database operations. The specific migrator command to run is: - For Kubernetes: replace container args with `["add-log", "-db=", "-version="]` - For Docker-compose: replace container args with `"add-log" "-db=" "-version="` diff --git a/docs/admin/how-to/dirty_database_pre_3_37.mdx b/docs/self-hosted/how-to/dirty_database_pre_3_37.mdx similarity index 92% rename from docs/admin/how-to/dirty_database_pre_3_37.mdx rename to docs/self-hosted/how-to/dirty_database_pre_3_37.mdx index 31e12b6f8..ac063d1d4 100644 --- a/docs/admin/how-to/dirty_database_pre_3_37.mdx +++ b/docs/self-hosted/how-to/dirty_database_pre_3_37.mdx @@ -1,6 +1,6 @@ # How to troubleshoot a dirty database -> NOTE: This document refers to Sourcegraph instances with a version **strictly lower than** 3.37.0. For instructions on dealing with a dirty database for newer Sourcegraph instances, see [the updated documentation](/admin/how-to/dirty_database). +> NOTE: This document refers to Sourcegraph instances with a version **strictly lower than** 3.37.0. For instructions on dealing with a dirty database for newer Sourcegraph instances, see [the updated documentation](/self-hosted/how-to/dirty_database). This document will take you through how to resolve a 'dirty database' error. During an upgrade, the `pgsql`, `codeintel-db`, and `codeinsights-db` databases must be migrated. If the upgrade was interrupted during the migration, this can result in a 'dirty database' error. @@ -15,9 +15,9 @@ Resolving this error requires discovering which migration file failed to run, an ## Prerequisites - 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.](/admin/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.** +- **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](/admin/deploy/kubernetes/operations#access-the-database), [docker-compose](/admin/deploy/docker-compose/operations#access-the-database), and [Sourcegraph single-container](/admin/deploy/docker-single-container/#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), [docker-compose](/self-hosted/deploy/docker-compose/operations#access-the-database), and [Sourcegraph single-container](/admin/deploy/docker-single-container/#access-the-database) instances at these links. ## TL;DR Steps to resolve @@ -101,4 +101,4 @@ Additionally Grafana will alert you of an index is in this state. _The Grafana a ## Further resources -- [Sourcegraph - Upgrading Sourcegraph to a new version](/admin/updates) +- [Sourcegraph - Upgrading Sourcegraph to a new version](/self-hosted/updates) diff --git a/docs/self-hosted/how-to/index.mdx b/docs/self-hosted/how-to/index.mdx new file mode 100644 index 000000000..a33048d70 --- /dev/null +++ b/docs/self-hosted/how-to/index.mdx @@ -0,0 +1,31 @@ +# How-to guides + +- [How to manually execute database migrations with `migrator`](/self-hosted/updates/migrator/migrator-operations) + - Commands: [up](/self-hosted/updates/migrator/migrator-operations#up), [upto](/self-hosted/updates/migrator/migrator-operations#upto), [downto](/self-hosted/updates/migrator/migrator-operations#downto), [validate](/self-hosted/updates/migrator/migrator-operations#validate), [add-log](/self-hosted/updates/migrator/migrator-operations#add-log) + - Environments: [Kubernetes](/self-hosted/updates/migrator/migrator-operations#kubernetes), [Docker compose](/self-hosted/updates/migrator/migrator-operations#docker--docker-compose), [Local development](/self-hosted/updates/migrator/migrator-operations#local-development) +- [How to troubleshoot a dirty database](/self-hosted/how-to/dirty_database) +- [How to rollback the Postgres database](/self-hosted/how-to/rollback_database) +- [How to apply privileged migrations](/self-hosted/how-to/privileged_migrations) +- [How to troubleshoot an unfinished migration](/self-hosted/how-to/unfinished_migration) +- [How to enable or disable an experimental feature](/admin/how-to/enable-experimental-feature) +- [How to diagnose an `Unknown Error` during login to your Sourcegraph instance](/admin/how-to/unknown-error-login) +- [How to convert version contexts to search contexts](/admin/how-to/converting-version-contexts-to-search-contexts) +- [How to troubleshoot pod evictions](/self-hosted/how-to/troubleshoot-pod-eviction) +- [How to monitor your Sourcegraph instance](/self-hosted/how-to/monitoring-guide) +- [How to troubleshoot a repository that is not being updated](/admin/how-to/repo-not-updated) +- [How to configure submodules](/admin/how-to/submodule-configuration) +- [How to remove users or edit users with the GraphQL API](/admin/how-to/mutate-user-api) +- [How to setup HTTPS connection with Ingress controller on your Kubernetes instance](/self-hosted/how-to/setup-https) +- [How to rebuild corrupt Postgres indexes after upgrading to 3.30 or 3.30.1](/self-hosted/how-to/rebuild-corrupt-postgres-indexes) +- [How to determine cause for Precise-code-intel-worker in CrashLoopBackOff status](/self-hosted/how-to/precise-code-intel-worker-crashloopbackoff) +- [How to troubleshoot a failure to update repositories when new repositories are added](/admin/how-to/update_repo_failure) +- [How to run postgres queries in your Sourcegraph instance](/self-hosted/how-to/run-psql) +- [How to purge deleted repository data from Sourcegraph](/admin/how-to/remove-repo#manually-purge-deleted-repository-data-from-disk) +- [How to address common monorepo problems](/admin/how-to/monorepo-issues) +- [How to Set a password for Redis using a ConfigMap](/self-hosted/how-to/redis_configmap) +- [How to import a set of internal repositories to Sourcegraph](/admin/how-to/internal_github_repos) +- [How to identify and resolve index corruption in postgres 14](/self-hosted/how-to/postgres14-index-corruption) +- [Migrating code intelligence data from LSIF to SCIP (Sourcegraph 4.5 -> 4.6)](/admin/how-to/lsif_scip_migration) +- [How to export search results](/admin/how-to/export-search-results) +- [How to debug / confirm blobstore is healthy](/self-hosted/how-to/blobstore_debugging) +- [How to handle postgresql 12 to 16 drift](/admin/how-to/postgresql-12-to-16-drift) diff --git a/docs/self-hosted/how-to/monitoring-guide.mdx b/docs/self-hosted/how-to/monitoring-guide.mdx new file mode 100644 index 000000000..e4bf57f59 --- /dev/null +++ b/docs/self-hosted/how-to/monitoring-guide.mdx @@ -0,0 +1,18 @@ +# Monitoring Guide + +Please visit our [Observability Docs](/self-hosted/observability) for more in-depth information about observability in Sourcegraph. + +## Prerequisites + +This document assumes that you are a [site admin](/admin/). + +## Set up monitoring + +1. Familiarize yourself with [Sourcegraph's monitoring dashboards and metrics](/self-hosted/observability/metrics). + 1. Also see our [full dashboards reference](/self-hosted/observability/dashboards). +2. [Set up alerting](/self-hosted/observability/alerting#setting-up-alerting) and [learn about how to respond to alerts](/self-hosted/observability/alerting#understanding-alerts). + 1. Also see our [full alert solutions reference](/self-hosted/observability/alerts). + +## FAQs + +See the [monitoring section of our FAQ](/admin/faq#monitoring). diff --git a/docs/admin/how-to/postgres14-index-corruption.mdx b/docs/self-hosted/how-to/postgres14-index-corruption.mdx similarity index 94% rename from docs/admin/how-to/postgres14-index-corruption.mdx rename to docs/self-hosted/how-to/postgres14-index-corruption.mdx index c97b2eab5..85ddeb45b 100644 --- a/docs/admin/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](/admin/deploy/docker-compose/#access-the-database), [Kubernetes](/admin/deploy/kubernetes/operations#access-the-database). +> NOTE: You can refer to the following instructions for accessing databases on your deployment type: [Docker Compose](/admin/deploy/docker-compose/#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 @@ -52,6 +52,6 @@ _You may want to use the amcheck query above to verify the reindex has resolved ### Upgrading your database -In default Sourcegraph deployments internal PostgreSQL instances are used and may be upgraded via the [pg_upgrade](https://www.postgresql.org/docs/11/pgupgrade.html). For external databases consult your service providers documentation. For a deeper look at database upgrade operations please consult our [PostgreSQL documentation](/admin/postgres#upgrading-postgresql). +In default Sourcegraph deployments internal PostgreSQL instances are used and may be upgraded via the [pg_upgrade](https://www.postgresql.org/docs/11/pgupgrade.html). For external databases consult your service providers documentation. For a deeper look at database upgrade operations please consult our [PostgreSQL documentation](/self-hosted/postgres#upgrading-postgresql). If you have any questions, please reach out to support on Slack or email support@sourcegraph.com. diff --git a/docs/admin/how-to/postgres_12_to_16_drift.mdx b/docs/self-hosted/how-to/postgres_12_to_16_drift.mdx similarity index 100% rename from docs/admin/how-to/postgres_12_to_16_drift.mdx rename to docs/self-hosted/how-to/postgres_12_to_16_drift.mdx diff --git a/docs/admin/how-to/precise-code-intel-worker-crashloopbackoff.mdx b/docs/self-hosted/how-to/precise-code-intel-worker-crashloopbackoff.mdx similarity index 85% rename from docs/admin/how-to/precise-code-intel-worker-crashloopbackoff.mdx rename to docs/self-hosted/how-to/precise-code-intel-worker-crashloopbackoff.mdx index 0c45fea0b..693fabd0c 100644 --- a/docs/admin/how-to/precise-code-intel-worker-crashloopbackoff.mdx +++ b/docs/self-hosted/how-to/precise-code-intel-worker-crashloopbackoff.mdx @@ -2,7 +2,7 @@ This document will discuss one of the main reasons why the `precise-code-intel-worker` goes into a `CrashLoopBackOff` state in a Kubernetes. It does not attempt to solve _all_ reasons why this state can happen. -This commonly happens when upgrading from a Sourcegraph version prior to 3.22 to a later version and failing to deploy the MinIO container. This is because in [3.21 -> 3.22 we removed the `code intel bundle manager` and replaced it with `MinIO`.](/admin/updates/kubernetes#3-21-3-22) +This commonly happens when upgrading from a Sourcegraph version prior to 3.22 to a later version and failing to deploy the MinIO container. This is because in [3.21 -> 3.22 we removed the `code intel bundle manager` and replaced it with `MinIO`.](/self-hosted/updates/kubernetes#3-21-3-22) ## Symptoms @@ -17,7 +17,7 @@ precise-code-intel-worker-9b69b5b59-z7xx4 0/1 CrashLoopBackOff 415 1. Check what version of Sourcegraph you are on. If it is 3.22 or later, you will need to deploy `MinIO` because the `precise-code-intel-worker` depends on MinIO to function. If 3.4.2+, then minio is no longer used and instead `sourcegraph/blobstore` is used. -2. [Check what pods you have deployed and make sure MinIO is in the list.](/admin/deploy/kubernetes/operations#list-pods-in-cluster) +2. [Check what pods you have deployed and make sure MinIO is in the list.](/self-hosted/deploy/kubernetes/operations#list-pods-in-cluster) `kubectl get pods -o wide` @@ -25,5 +25,5 @@ precise-code-intel-worker-9b69b5b59-z7xx4 0/1 CrashLoopBackOff 415 ## Further resources -- [Sourcegraph - Kubernetes Configuration](/admin/deploy/kubernetes/configure) +- [Sourcegraph - Kubernetes Configuration](/self-hosted/deploy/kubernetes/configure) - [Deploy Sourcegraph K8s - blobstore](https://github.com/sourcegraph/deploy-sourcegraph-k8s/tree/main/base/sourcegraph/blobstore) diff --git a/docs/admin/how-to/privileged_migrations.mdx b/docs/self-hosted/how-to/privileged_migrations.mdx similarity index 81% rename from docs/admin/how-to/privileged_migrations.mdx rename to docs/self-hosted/how-to/privileged_migrations.mdx index a5abd7f26..57c8196cd 100644 --- a/docs/admin/how-to/privileged_migrations.mdx +++ b/docs/self-hosted/how-to/privileged_migrations.mdx @@ -8,7 +8,7 @@ Note that these flags affect the `migrator` commands `up`, `upto`, `downto`, `up ## `--unprivileged-only` -Add the optional flag `--unprivileged-only` when [running the migrator](/admin/updates/migrator/migrator-operations) against your Postgres instance. When the migration runner encounters an unapplied privileged migration, it will halt with an error message similar to the following. +Add the optional flag `--unprivileged-only` when [running the migrator](/self-hosted/updates/migrator/migrator-operations) against your Postgres instance. When the migration runner encounters an unapplied privileged migration, it will halt with an error message similar to the following. ``` ❌ failed to run migration for schema "frontend": refusing to apply a privileged migration: schema "frontend" requires database migrations 1657908958 and 1657908965 to be applied by a database user with elevated permissions @@ -17,4 +17,4 @@ The migration runner is currently being run with -unprivileged-only. The indicat This option is used to fail-fast upgrades that require manual user intervention. To allow the migrator to make additional progress, the privileged query/queries must be applied manually with a superuser (most commonly via a psql shell attached to the Postgres instance). -You can manually [find and apply the target privileged migrations](/admin/how-to/dirty_database#2-run-the-sql-queries-to-finish-incomplete-migrations) and [manually add a migration log entry](/admin/how-to/dirty_database#3-add-a-migration-log-entry). +You can manually [find and apply the target privileged migrations](/self-hosted/how-to/dirty_database#2-run-the-sql-queries-to-finish-incomplete-migrations) and [manually add a migration log entry](/self-hosted/how-to/dirty_database#3-add-a-migration-log-entry). diff --git a/docs/admin/how-to/rebuild-corrupt-postgres-indexes.mdx b/docs/self-hosted/how-to/rebuild-corrupt-postgres-indexes.mdx similarity index 97% rename from docs/admin/how-to/rebuild-corrupt-postgres-indexes.mdx rename to docs/self-hosted/how-to/rebuild-corrupt-postgres-indexes.mdx index 0e79d52c1..d7e12eb67 100644 --- a/docs/admin/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](/admin/deploy/docker-compose/#access-the-database), [Kubernetes](/admin/deploy/kubernetes/operations#access-the-database). +> NOTE: You can refer to the following instructions for accessing databases on your deployment type: [Docker Compose](/admin/deploy/docker-compose/#access-the-database), [Kubernetes](/self-hosted/deploy/kubernetes/operations#access-the-database). ```shell export DB=pgsql # change for other databases diff --git a/docs/admin/how-to/redis_configmap.mdx b/docs/self-hosted/how-to/redis_configmap.mdx similarity index 97% rename from docs/admin/how-to/redis_configmap.mdx rename to docs/self-hosted/how-to/redis_configmap.mdx index 9583363bd..06887f6a0 100644 --- a/docs/admin/how-to/redis_configmap.mdx +++ b/docs/self-hosted/how-to/redis_configmap.mdx @@ -13,8 +13,8 @@ The Redis Docker image does not expose a dedicated environment variable to set a Reference Materials -- [Docs: Configure custom Redis](/admin/deploy/kubernetes/configure#external-redis) -- [Docs: Using your own Redis server](/admin/external_services/redis) +- [Docs: Configure custom Redis](/self-hosted/deploy/kubernetes/configure#external-redis) +- [Docs: Using your own Redis server](/self-hosted/external_services/redis) ## Conventions diff --git a/docs/admin/how-to/rollback_database.mdx b/docs/self-hosted/how-to/rollback_database.mdx similarity index 86% rename from docs/admin/how-to/rollback_database.mdx rename to docs/self-hosted/how-to/rollback_database.mdx index ff8d10356..3554cebe5 100644 --- a/docs/admin/how-to/rollback_database.mdx +++ b/docs/self-hosted/how-to/rollback_database.mdx @@ -15,6 +15,6 @@ If a customer downgrades their instance to a previous version, they need to down A database schema downgrade will not always be enough. If a newer version was running even for a small time, it could have migrated data in the background into a format that's no longer readable by the previous version of Sourcegraph. -The `migrator` can be used to run both schema and data migrations (in the appropriate order) so that the old version of Sourcegraph can start and run without broken features. See the [command documentation](/admin/updates/migrator/migrator-operations#downgrade) for additional details. +The `migrator` can be used to run both schema and data migrations (in the appropriate order) so that the old version of Sourcegraph can start and run without broken features. See the [command documentation](/self-hosted/updates/migrator/migrator-operations#downgrade) for additional details. -The log output of the `migrator` should include `INFO`-level logs and successfully terminate with `migrator exited with code 0`. If you see an error message or any of the databases have been flagged as "dirty", please follow ["How to troubleshoot a dirty database"](/admin/how-to/dirty_database). A dirty database at this stage requires manual intervention. Please contact support at `mailto:support@sourcegraph.com` or via your enterprise support channel for further assistance. +The log output of the `migrator` should include `INFO`-level logs and successfully terminate with `migrator exited with code 0`. If you see an error message or any of the databases have been flagged as "dirty", please follow ["How to troubleshoot a dirty database"](/self-hosted/how-to/dirty_database). A dirty database at this stage requires manual intervention. Please contact support at `mailto:support@sourcegraph.com` or via your enterprise support channel for further assistance. diff --git a/docs/admin/how-to/run-psql.mdx b/docs/self-hosted/how-to/run-psql.mdx similarity index 100% rename from docs/admin/how-to/run-psql.mdx rename to docs/self-hosted/how-to/run-psql.mdx diff --git a/docs/admin/how-to/setup-https.mdx b/docs/self-hosted/how-to/setup-https.mdx similarity index 100% rename from docs/admin/how-to/setup-https.mdx rename to docs/self-hosted/how-to/setup-https.mdx diff --git a/docs/admin/how-to/troubleshoot-pod-eviction.mdx b/docs/self-hosted/how-to/troubleshoot-pod-eviction.mdx similarity index 94% rename from docs/admin/how-to/troubleshoot-pod-eviction.mdx rename to docs/self-hosted/how-to/troubleshoot-pod-eviction.mdx index 8528d3a9a..22782f6e5 100644 --- a/docs/admin/how-to/troubleshoot-pod-eviction.mdx +++ b/docs/self-hosted/how-to/troubleshoot-pod-eviction.mdx @@ -20,5 +20,5 @@ This document assumes that you have deployed Sourcegraph on Kubernetes and you a ## Further resources -- [Sourcegraph - Alert solutions](/admin/observability/alerts) +- [Sourcegraph - Alert solutions](/self-hosted/observability/alerts) - [Kubernetes Eviction docs](https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/) diff --git a/docs/admin/how-to/unfinished_migration.mdx b/docs/self-hosted/how-to/unfinished_migration.mdx similarity index 93% rename from docs/admin/how-to/unfinished_migration.mdx rename to docs/self-hosted/how-to/unfinished_migration.mdx index 2ef0cb664..1b566177c 100644 --- a/docs/admin/how-to/unfinished_migration.mdx +++ b/docs/self-hosted/how-to/unfinished_migration.mdx @@ -17,7 +17,7 @@ ERROR: Unfinished migrations. Please revert Sourcegraph to the previous version If you were performing a [standard upgrade](/admin/updates/#standard-upgrades) between two minor versions, then the suggested action is to perform an infrastructure rollback and continue running the previous instance version until the violating out-of-band migrations have completed. The progress of the migrations can be checked [in the UI](#checking-progress). Older versions of Sourcegraph may have performed schema migrations prior to this check, but a schema rollback should not be necessary as our database schemas are backwards-compatible with one minor version. -Alternatively to rolling back and waiting, the unfinished migrations can be run directly via the `migrator`. See the [command documentation](/admin/updates/migrator/migrator-operations#run-out-of-band-migrations) for additional details. +Alternatively to rolling back and waiting, the unfinished migrations can be run directly via the `migrator`. See the [command documentation](/self-hosted/updates/migrator/migrator-operations#run-out-of-band-migrations) for additional details. [Multi-version upgrades](/admin/updates/#multi-version-upgrades) and downgrade operations ensure that the required out-of-band migrations have completed or finished rolling back. If this is not the case, contact support as it indicates a non-obvious error in your environment or a bug Sourcegraph's migration tooling. @@ -35,4 +35,4 @@ If an out-of-band migration is not making progress or there are errors associate ## Further resources -- [Sourcegraph - Upgrading Sourcegraph to a new version](/admin/updates/) +- [Sourcegraph - Upgrading Sourcegraph to a new version](/self-hosted/updates/) diff --git a/docs/admin/how-to/upgrade-postgres-12-16-builtin-dbs.mdx b/docs/self-hosted/how-to/upgrade-postgres-12-16-builtin-dbs.mdx similarity index 82% rename from docs/admin/how-to/upgrade-postgres-12-16-builtin-dbs.mdx rename to docs/self-hosted/how-to/upgrade-postgres-12-16-builtin-dbs.mdx index d56407e86..8461980fd 100644 --- a/docs/admin/how-to/upgrade-postgres-12-16-builtin-dbs.mdx +++ b/docs/self-hosted/how-to/upgrade-postgres-12-16-builtin-dbs.mdx @@ -1,6 +1,6 @@ # Upgrading Built-in PostgreSQL -The following doc contains detailed instructions for upgrading the built-in PostgreSQL databases. Via our `postgresql-16` and `postgresql-16-codeinsights` image entrypoint script. This doc assumes an admin is attempting to upgrade to Sourcegraph `6.0.0` from an older version (usually pre `5.10.0`) using one of our "deploy" repos. For more general info see [Upgrading PostgreSQL](/admin/postgres#upgrading-postgresql). +The following doc contains detailed instructions for upgrading the built-in PostgreSQL databases. Via our `postgresql-16` and `postgresql-16-codeinsights` image entrypoint script. This doc assumes an admin is attempting to upgrade to Sourcegraph `6.0.0` from an older version (usually pre `5.10.0`) using one of our "deploy" repos. For more general info see [Upgrading PostgreSQL](/self-hosted/postgres#upgrading-postgresql). > WARNING: Upgrading the PostgreSQL database requires stopping your Sourcegraph deployment which will result in **downtime**. > @@ -8,7 +8,7 @@ The following doc contains detailed instructions for upgrading the built-in Post ## Docker Compose -Docker compose supports [standard](/admin/deploy/docker-compose/upgrade#standard-upgrades) and [multi-version](/admin/deploy/docker-compose/upgrade#multi-version-upgrades) upgrades to Postgres 16 versions! However, if you prefer to upgrade your DBs independent of a Sourcegraph version upgrade see the following procedure. +Docker compose supports [standard](/self-hosted/deploy/docker-compose/upgrade#standard-upgrades) and [multi-version](/self-hosted/deploy/docker-compose/upgrade#multi-version-upgrades) upgrades to Postgres 16 versions! However, if you prefer to upgrade your DBs independent of a Sourcegraph version upgrade see the following procedure. 1. **Bring down your containers** @@ -16,7 +16,7 @@ Docker compose supports [standard](/admin/deploy/docker-compose/upgrade#standard docker-compose down --remove-orphans ``` -2. Change the `image:` in your `docker-compose.yaml` to the release of `pgsql`, `codeinsights-db`, and `codeintel-db`. Or [merge in changes](/admin/deploy/docker-compose/upgrade#standard-upgrades) from the tagged sourcegraph release you're planning to upgrade to. **Example:** +2. Change the `image:` in your `docker-compose.yaml` to the release of `pgsql`, `codeinsights-db`, and `codeintel-db`. Or [merge in changes](/self-hosted/deploy/docker-compose/upgrade#standard-upgrades) from the tagged sourcegraph release you're planning to upgrade to. **Example:** ```yaml pgsql: @@ -42,7 +42,7 @@ Wait for the database containers to come up healthy. If for some reason the data ## Kubernetes Kustomize -Kubernetes Kustomize supports [standard](/admin/deploy/kubernetes/upgrade#standard-upgrades) and [multi-version](/deploy/kubernetes/upgrade#multi-version-upgrades) upgrades to Postgres 16 versions! However, if you prefer to upgrade your DBs independent of a Sourcegraph version upgrade see the following procedure. +Kubernetes Kustomize supports [standard](/self-hosted/deploy/kubernetes/upgrade#standard-upgrades) and [multi-version](/deploy/kubernetes/upgrade#multi-version-upgrades) upgrades to Postgres 16 versions! However, if you prefer to upgrade your DBs independent of a Sourcegraph version upgrade see the following procedure. 1. **Disable Connections to the Database**: - The following services must have their replicas scaled to 0: - Deployments (e.g., `kubectl scale deployment --replicas=0`) - precise-code-intel-worker - repo-updater - searcher - sourcegraph-frontend - sourcegraph-frontend-internal - symbols - worker - Stateful sets (e.g., `kubectl scale sts --replicas=0`): - gitserver - indexed-search @@ -100,7 +100,7 @@ To safely upgrade PostgreSQL in Helm deployments: 1. **First upgrade to an intermediate version**: - - Upgrade to either Sourcegraph `v5.10.3940` or `v5.11.6271` using the [helm multi-version upgrade procedure](/admin/deploy/kubernetes#multi-version-upgrade-procedure) or [standard upgrade procedure](/admin/deploy/kubernetes#standard-upgrades) + - Upgrade to either Sourcegraph `v5.10.3940` or `v5.11.6271` using the [helm multi-version upgrade procedure](/self-hosted/deploy/kubernetes#multi-version-upgrade-procedure) or [standard upgrade procedure](/self-hosted/deploy/kubernetes#standard-upgrades) - These specific versions include the necessary PostgreSQL upgrade scripts to safely migrate from PG12 to PG16 2. **Verify the PostgreSQL upgrade** (optional): diff --git a/docs/admin/http_https_configuration.mdx b/docs/self-hosted/http_https_configuration.mdx similarity index 94% rename from docs/admin/http_https_configuration.mdx rename to docs/self-hosted/http_https_configuration.mdx index 213220970..1050cfeae 100644 --- a/docs/admin/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:/ ![NGINX and Sourcegraph architecture](https://storage.googleapis.com/sourcegraph-assets/Docs/sourcegraph-nginx.svg) -**Note**: Non-sighted users can view a [text-representation of this diagram](/admin/sourcegraph-nginx-mermaid). +**Note**: Non-sighted users can view a [text-representation of this diagram](/self-hosted/sourcegraph-nginx-mermaid). ### Sourcegraph single instance (Docker) @@ -47,7 +47,7 @@ docker container run \ ### Sourcegraph Cluster (Kubernetes) -We use the [ingress-nginx](https://kubernetes.github.io/ingress-nginx/) for Sourcegraph Cluster running on Kubernetes. Refer to the [deploy-sourcegraph Configuration](/admin/deploy/kubernetes/configure#network-access) documentation for more information. +We use the [ingress-nginx](https://kubernetes.github.io/ingress-nginx/) for Sourcegraph Cluster running on Kubernetes. Refer to the [deploy-sourcegraph Configuration](/self-hosted/deploy/kubernetes/configure#network-access) documentation for more information. ### NGINX SSL/HTTPS configuration @@ -114,7 +114,7 @@ There are a few options: docker logs $(docker ps | grep sourcegraph/server | awk '{ print $1 }') ``` -**[2. Generate a self-signed certificate](/admin/ssl_https_self_signed_cert_nginx)**
+**[2. Generate a self-signed certificate](/self-hosted/ssl_https_self_signed_cert_nginx)**
_This step can be skipped if you already have a certificate from a [globally trusted Certificate Authority (CA) provider](https://en.wikipedia.org/wiki/Certificate_authority#Providers)._ @@ -162,7 +162,7 @@ You should configure Sourcegraph's `externalURL` in the [site configuration](/ad ## Sourcegraph via Docker Compose: Caddy 2 -Sourcegraph's [Docker Compose deployment](/admin/deploy/docker-compose/) uses [Caddy 2](https://caddyserver.com/) as its reverse proxy. The Docker Compose deployment ships with a few builtin templates that cover common scenarios for exposing Sourcegraph: +Sourcegraph's [Docker Compose deployment](/self-hosted/deploy/docker-compose/) uses [Caddy 2](https://caddyserver.com/) as its reverse proxy. The Docker Compose deployment ships with a few builtin templates that cover common scenarios for exposing Sourcegraph: - plain HTTP - HTTPS with automatically provisioned Let's Encrypt certificates diff --git a/docs/self-hosted/index.mdx b/docs/self-hosted/index.mdx index 549647e16..653def6da 100644 --- a/docs/self-hosted/index.mdx +++ b/docs/self-hosted/index.mdx @@ -2,21 +2,25 @@ Supported on [Enterprise](/pricing/enterprise) plans. +This section of the documentation is meant for Sourcegraph enterprise self-hosted users. + Sourcegraph administration is primarily managed by site administrators, who are responsible for the deployment, management, and configuration of Sourcegraph instances for end users. For a comprehensive introduction to site administration, refer to our [quickstart guide](/admin/how-to/site-admin-quickstart). -## [Deploy Sourcegraph](/admin/deploy) +## [Deploy Sourcegraph](/self-hosted/deploy/) Get started running Sourcegraph on-prem. -- [Deployment overview](/admin/deploy/) -- [Best practices](/admin/deployment_best_practices) -- [Validate a Sourcegraph deployment](/admin/validation) (experimental) +- [Deployment overview](/self-hosted/deploy/) +- [Using external services (PostgreSQL, Redis, S3/GCS)](/self-hosted/external_services) +- [PostgreSQL Config](/self-hosted/postgres-conf) +- [Best practices](/self-hosted/deployment_best_practices) +- [Validate a Sourcegraph deployment](/self-hosted/validation) (experimental) -## [Upgrade Sourcegraph](/admin/updates) +## [Upgrade Sourcegraph](/self-hosted/updates) -- [Upgrade Overview](/admin/updates/) +- [Upgrade Overview](/self-hosted/updates/) - [Migrate to Sourcegraph](/admin/migration/) -- [Upgrading PostgreSQL](/admin/postgres#upgrading-postgresql) +- [Upgrading PostgreSQL](/self-hosted/postgres#upgrading-postgresql) ## [Configure Sourcegraph](/admin/config) @@ -25,39 +29,36 @@ Get started running Sourcegraph on-prem. - [Add Git repositories](/admin/repo/add) (from a code host or clone URL) - [Monorepo](/admin/monorepo) - [Repository webhooks](/admin/repo/webhooks) -- [HTTP and HTTPS/SSL configuration](/admin/http_https_configuration) - - [Adding SSL (HTTPS) to Sourcegraph with a self-signed certificate](/admin/ssl_https_self_signed_cert_nginx) +- [HTTP and HTTPS/SSL configuration](/self-hosted/http_https_configuration) + - [Adding SSL (HTTPS) to Sourcegraph with a self-signed certificate](/self-hosted/ssl_https_self_signed_cert_nginx) - [User authentication](/admin/auth/) - [User data deletion](/admin/user_data_deletion) - [Provision users through SCIM](/admin/scim) (Beta) - [Access control](/admin/access_control/) (Beta) -- [Setting the URL for your instance](/admin/url) +- [Setting the URL for your instance](/self-hosted/url) +- [Configure email sending / SMTP server](/self-hosted/email) - [Repository permissions](/admin/permissions/) - [Batch Changes](/batch-changes/site-admin-configuration) - [Configure webhooks](/admin/config/webhooks/) -- [Scaling workers](/admin/workers) -- [PostgreSQL configuration](/admin/config/postgres-conf) - -## [Observability](/admin/observability) - -- [Monitoring guide](/admin/how-to/monitoring-guide) -- [Metrics and dashboards](/admin/observability/metrics) -- [Alerting](/admin/observability/alerting) -- [Tracing](/admin/observability/tracing) -- [Logs](/admin/observability/logs) -- [Outbound request log](/admin/observability/outbound-request-log) -- [OpenTelemetry](/admin/observability/opentelemetry) -- [Health checks](/admin/observability/health_checks) -- [Troubleshooting guide](/admin/observability/troubleshooting) - -## Features - -- [Batch Changes](/batch-changes/) -- [Beta and experimental features](/admin/beta_and_experimental_features) -- [Code navigation](/code-navigation/) -- [Pings](/admin/pings) -- [Enterprise pricing and licenses](/admin/subscriptions/) -- [Search](/admin/search) -- [User feedback surveys](/admin/user_surveys) -- [Analytics](/analytics) -- [Audit logs](/admin/audit_log) +- [Scaling workers](/self-hosted/workers) +- [PostgreSQL configuration](/self-hosted/postgres-conf) + +## Advanced tasks + +- [Loading configuration via the file system](/self-hosted/advanced_config_file) +- [Restore postgres database from snapshot](/self-hosted/restore/) +- [Enabling database encryption for sensitive data](/self-hosted/encryption) +- [Configuring Sourcegraph in private networks](/self-hosted/private-network) +- [Restricting outgoing connections](/self-hosted/network-filtering) + +## [Observability](/self-hosted/observability) + +- [Monitoring guide](/self-hosted/how-to/monitoring-guide) +- [Metrics and dashboards](/self-hosted/observability/metrics) +- [Alerting](/self-hosted/observability/alerting) +- [Tracing](/self-hosted/observability/tracing) +- [Logs](/self-hosted/observability/logs) +- [Outbound request log](/admin/outbound-request-log) +- [OpenTelemetry](/self-hosted/observability/opentelemetry) +- [Health checks](/self-hosted/observability/health_checks) +- [Troubleshooting guide](/self-hosted/observability/troubleshooting) diff --git a/docs/admin/config/network-filtering.mdx b/docs/self-hosted/network-filtering.mdx similarity index 100% rename from docs/admin/config/network-filtering.mdx rename to docs/self-hosted/network-filtering.mdx diff --git a/docs/admin/observability/.gitattributes b/docs/self-hosted/observability/.gitattributes similarity index 100% rename from docs/admin/observability/.gitattributes rename to docs/self-hosted/observability/.gitattributes diff --git a/docs/admin/observability/alerting.mdx b/docs/self-hosted/observability/alerting.mdx similarity index 95% rename from docs/admin/observability/alerting.mdx rename to docs/self-hosted/observability/alerting.mdx index d3831f9b7..510740643 100644 --- a/docs/admin/observability/alerting.mdx +++ b/docs/self-hosted/observability/alerting.mdx @@ -24,8 +24,8 @@ Alerts fall in one of two severity levels: site administrator to investigate and monitor when convenient, and please let us know so that we can improve them. -Refer to the [alert solutions reference](/admin/observability/alerts) for a complete list of Sourcegraph alerts, as well as possible solutions when these alerts are firing. -Learn more about metrics, dashboards, and alert labels in our [metrics guide](/admin/observability/metrics). +Refer to the [alert solutions reference](/self-hosted/observability/alerts) for a complete list of Sourcegraph alerts, as well as possible solutions when these alerts are firing. +Learn more about metrics, dashboards, and alert labels in our [metrics guide](/self-hosted/observability/metrics). ## Setting up alerting @@ -209,6 +209,6 @@ If there is an alert you are aware of and you wish to silence notifications (fro } ``` -You can find the appropriate identifier for each alert in [alert solutions](/admin/observability/alerts). +You can find the appropriate identifier for each alert in [alert solutions](/self-hosted/observability/alerts). -> NOTE: You can still see the alerts on your [Grafana dashboard](/admin/observability/metrics#grafana). +> NOTE: You can still see the alerts on your [Grafana dashboard](/self-hosted/observability/metrics#grafana). diff --git a/docs/admin/observability/alerting_custom_consumption.mdx b/docs/self-hosted/observability/alerting_custom_consumption.mdx similarity index 92% rename from docs/admin/observability/alerting_custom_consumption.mdx rename to docs/self-hosted/observability/alerting_custom_consumption.mdx index 50084cc39..cbb40b048 100644 --- a/docs/admin/observability/alerting_custom_consumption.mdx +++ b/docs/self-hosted/observability/alerting_custom_consumption.mdx @@ -1,8 +1,8 @@ # Custom consumption of Sourcegraph alerts -If Sourcegraph's builtin [alerting](/admin/observability/alerting) (which can notify you via email, Slack, PagerDuty, webhook, and more) is not sufficient for you, or if you just prefer to consume the alerts programatically for some reason, then this page is for you. +If Sourcegraph's builtin [alerting](/self-hosted/observability/alerting) (which can notify you via email, Slack, PagerDuty, webhook, and more) is not sufficient for you, or if you just prefer to consume the alerts programatically for some reason, then this page is for you. -For more information about Sourcegraph alerts, see [high level alerting metrics](/admin/observability/metrics#high-level-alerting-metrics). +For more information about Sourcegraph alerts, see [high level alerting metrics](/self-hosted/observability/metrics#high-level-alerting-metrics). ## Prometheus queries diff --git a/docs/admin/observability/alerts.mdx b/docs/self-hosted/observability/alerts.mdx similarity index 100% rename from docs/admin/observability/alerts.mdx rename to docs/self-hosted/observability/alerts.mdx diff --git a/docs/admin/observability/dashboards.mdx b/docs/self-hosted/observability/dashboards.mdx similarity index 100% rename from docs/admin/observability/dashboards.mdx rename to docs/self-hosted/observability/dashboards.mdx diff --git a/docs/admin/observability/health_checks.mdx b/docs/self-hosted/observability/health_checks.mdx similarity index 63% rename from docs/admin/observability/health_checks.mdx rename to docs/self-hosted/observability/health_checks.mdx index ed9ab63d9..2e39efefa 100644 --- a/docs/admin/observability/health_checks.mdx +++ b/docs/self-hosted/observability/health_checks.mdx @@ -2,4 +2,4 @@ An application health check status endpoint is available at the URL path `/healthz`. It returns HTTP 200 if and only if the main frontend server and databases (PostgreSQL and Redis) are available, and also returns the version of the instance. -The [Kubernetes cluster deployment option](/admin/deploy/kubernetes/) ships with comprehensive health checks for each Kubernetes deployment. +The [Kubernetes cluster deployment option](/self-hosted/deploy/kubernetes/) ships with comprehensive health checks for each Kubernetes deployment. diff --git a/docs/admin/observability/index.mdx b/docs/self-hosted/observability/index.mdx similarity index 56% rename from docs/admin/observability/index.mdx rename to docs/self-hosted/observability/index.mdx index 90865b974..08605176f 100644 --- a/docs/admin/observability/index.mdx +++ b/docs/self-hosted/observability/index.mdx @@ -12,39 +12,39 @@ Sourcegraph is designed, and ships with, a number of observability tools and cap ## Guides -- [Metrics and dashboards](/admin/observability/metrics) -- [Alerting](/admin/observability/alerting) -- [Tracing](/admin/observability/tracing) -- [Logs](/admin/observability/logs) -- [Outbound request log](/admin/observability/outbound-request-log) -- [OpenTelemetry](/admin/observability/opentelemetry) -- [Health checks](/admin/observability/health_checks) -- [Troubleshooting guide](/admin/observability/troubleshooting) -- [Monitoring guide](/admin/how-to/monitoring-guide) +- [Metrics and dashboards](/self-hosted/observability/metrics) +- [Alerting](/self-hosted/observability/alerting) +- [Tracing](/self-hosted/observability/tracing) +- [Logs](/self-hosted/observability/logs) +- [Outbound request log](/admin/outbound-request-log) +- [OpenTelemetry](/self-hosted/observability/opentelemetry) +- [Health checks](/self-hosted/observability/health_checks) +- [Troubleshooting guide](/self-hosted/observability/troubleshooting) +- [Monitoring guide](/self-hosted/how-to/monitoring-guide) ## Reference -- [Dashboards reference](/admin/observability/dashboards) -- [Alert solutions](/admin/observability/alerts) +- [Dashboards reference](/self-hosted/observability/dashboards) +- [Alert solutions](/self-hosted/observability/alerts) ## Support diff --git a/docs/admin/observability/logs.mdx b/docs/self-hosted/observability/logs.mdx similarity index 97% rename from docs/admin/observability/logs.mdx rename to docs/self-hosted/observability/logs.mdx index 7d554cd1f..b02fd0817 100644 --- a/docs/admin/observability/logs.mdx +++ b/docs/self-hosted/observability/logs.mdx @@ -2,7 +2,7 @@ This document describes the log output from Sourcegraph services and how to configure it. -Note: For request logs, see [Outbound request log](/admin/observability/outbound-request-log). +Note: For request logs, see [Outbound request log](/admin/outbound-request-log). ## Log levels diff --git a/docs/admin/observability/metrics.mdx b/docs/self-hosted/observability/metrics.mdx similarity index 86% rename from docs/admin/observability/metrics.mdx rename to docs/self-hosted/observability/metrics.mdx index 410a4f24e..f111766ce 100644 --- a/docs/admin/observability/metrics.mdx +++ b/docs/self-hosted/observability/metrics.mdx @@ -1,6 +1,6 @@ # Metrics and dashboards -Sourcegraph ships with [Grafana](https://grafana.com) for dashboards, [Prometheus](https://prometheus.io/) for metrics and alerting. We also provide [built-in alerting](/admin/observability/alerting) for these metrics. +Sourcegraph ships with [Grafana](https://grafana.com) for dashboards, [Prometheus](https://prometheus.io/) for metrics and alerting. We also provide [built-in alerting](/self-hosted/observability/alerting) for these metrics. ## Grafana @@ -16,13 +16,13 @@ Site admins can view the Grafana monitoring dashboards on a Sourcegraph instance ### Dashboards -A complete [dashboard reference](/admin/observability/dashboards) is available for more context on our available service dashboards and panels. +A complete [dashboard reference](/self-hosted/observability/dashboards) is available for more context on our available service dashboards and panels. Additional dashboards can also be set up—see [Grafana configuration](#grafana-configuration) for more details. #### View documentation -On service dashboards, each metric panel has links attached that lead to relevant [alert solutions](/admin/observability/alerts) or [panel documentation](/admin/observability/dashboards). +On service dashboards, each metric panel has links attached that lead to relevant [alert solutions](/self-hosted/observability/alerts) or [panel documentation](/self-hosted/observability/dashboards). These can be accessed from the top left corner of each panel. #### View alerts @@ -76,7 +76,7 @@ Follow the instructions below to access Grafana directly to, for example, edit c > NOTE: Most of the dashboards that Sourcegraph ships with are not configurable through the Grafana UI. > In general, we recommend [these configuration methods instead](#grafana-configuration). -If you are using the [Kubernetes deployment option](/admin/deploy/kubernetes/), you can access Grafana directly using Kubernetes port forwarding to your local machine: +If you are using the [Kubernetes deployment option](/self-hosted/deploy/kubernetes/), you can access Grafana directly using Kubernetes port forwarding to your local machine: ```sh kubectl port-forward svc/grafana 3370:30070 @@ -84,7 +84,7 @@ kubectl port-forward svc/grafana 3370:30070 Grafana will be available http://localhost:3370/-/debug/grafana. -If you are using [Docker Single Container](/admin/deploy/docker-single-container/) or the [Docker Compose deployment option](/admin/deploy/), Grafana is available locally at http://localhost:3370/-/debug/grafana without any additional setup. +If you are using [Docker Single Container](/self-hosted/deploy/docker-single-container/) or the [Docker Compose deployment option](/self-hosted/deploy/), Grafana is available locally at http://localhost:3370/-/debug/grafana without any additional setup. If Sourcegraph is deployed to a remote server, then access via an SSH tunnel using a tool such as [sshuttle](https://github.com/sshuttle/sshuttle) is required to establish a secure connection to Grafana. To access the remote server using `sshuttle` from your local machine: @@ -151,8 +151,8 @@ For most use cases, you can query Prometheus through [Grafana](#grafana) using G Sourcegraph's metrics include a single high-level metric `alert_count` which indicates the number of `level=critical` and `level=warning` alerts each service has fired over time for each Sourcegraph service. This is the same metric presented on the **Overview** Grafana dashboard. -> NOTE: We provide [built-in alerting](/admin/observability/alerting) for these alerting metrics to help monitor the health of your Sourcegraph instance. -> Refer to our [alert solutions reference](/admin/observability/alerts) for details on specific alerts. +> NOTE: We provide [built-in alerting](/self-hosted/observability/alerting) for these alerting metrics to help monitor the health of your Sourcegraph instance. +> Refer to our [alert solutions reference](/self-hosted/observability/alerts) for details on specific alerts. **Description:** The number of alerts each service has fired for a given alert name and severity level. @@ -165,7 +165,7 @@ For example, `0.5` and `0.7` indicate no alerts are firing, while `1.2` indicate | -------------- | -------------------------------------------------------------------------------- | | `service_name` | the name of the service that fired the alert | | `name` | the name of the alert that the service fired | -| `level` | either `critical` or `warning`, as defined [here](/admin/observability/alerting) | +| `level` | either `critical` or `warning`, as defined [here](/self-hosted/observability/alerting) | | `description` | a human-readable description of the alert | #### Complete reference @@ -174,7 +174,7 @@ A complete reference of Sourcegraph's vast set of Prometheus metrics is not yet ### Prometheus configuration -Sourcegraph runs a customized image of Prometheus, which packages a standard Prometheus installation together with rules files and target files tailored to Sourcegraph and quality-of-life integrations such as [the ability to configure alerting from the Sourcegraph web application](/admin/observability/alerting/). +Sourcegraph runs a customized image of Prometheus, which packages a standard Prometheus installation together with rules files and target files tailored to Sourcegraph and quality-of-life integrations such as [the ability to configure alerting from the Sourcegraph web application](/self-hosted/observability/alerting/). A directory can be mounted at `/sg_prometheus_add_ons`. It can contain additional config files of two types: @@ -192,13 +192,13 @@ Most of the time, Sourcegraph site admins will monitor and query key metrics thr Grafana also provides the dashboards that monitor the standard metrics that indicate the health of the instance. Follow the instructions below to access Prometheus directly instead. -If you are using the [Kubernetes deployment option](/admin/deploy/kubernetes/), port-forward the Prometheus service: +If you are using the [Kubernetes deployment option](/self-hosted/deploy/kubernetes/), port-forward the Prometheus service: ```sh kubectl port-forward svc/prometheus 9090:30090 ``` -If you are using [Docker Single Container](/admin/deploy/docker-single-container/) or the [Docker Compose deployment option](/admin/deploy/), you will need to restart the Sourcegraph container +If you are using [Docker Single Container](/self-hosted/deploy/docker-single-container/) or the [Docker Compose deployment option](/self-hosted/deploy/), you will need to restart the Sourcegraph container with a flag `--publish 9090:9090` in the `docker run` command. Prometheus will be available http://localhost:9090. diff --git a/docs/admin/observability/opentelemetry.mdx b/docs/self-hosted/observability/opentelemetry.mdx similarity index 93% rename from docs/admin/observability/opentelemetry.mdx rename to docs/self-hosted/observability/opentelemetry.mdx index 9505b03c3..b8b5dd2bb 100644 --- a/docs/admin/observability/opentelemetry.mdx +++ b/docs/self-hosted/observability/opentelemetry.mdx @@ -1,6 +1,6 @@ # OpenTelemetry -> This page is a deep dive into OpenTelemetry and customizing it. To get started with HTTP Tracing, see the [Tracing](/admin/observability/tracing) page. +> This page is a deep dive into OpenTelemetry and customizing it. To get started with HTTP Tracing, see the [Tracing](/self-hosted/observability/tracing) page. [OpenTelemetry](https://opentelemetry.io/) (OTel) is an industry-standard toolset to handle observability data, ex. metrics, logs, and traces. @@ -16,14 +16,14 @@ Sourcegraph's bundled otel-collector is deployed via Docker image, and is config For details on how to deploy the otel-collector, and where to find its configuration file, refer to the docs page specific to your deployment type: -- [Kubernetes with Helm](/admin/deploy/kubernetes#configure-opentelemetry-collector-to-use-an-external-tracing-backend) -- [Kubernetes with Kustomize](/admin/deploy/kubernetes/configure#deploy-opentelemetry-collector-to-use-an-external-tracing-backend) -- [Docker Compose](/admin/deploy/docker-compose/configuration#configure-an-external-tracing-backend) +- [Kubernetes with Helm](/self-hosted/deploy/kubernetes#configure-opentelemetry-collector-to-use-an-external-tracing-backend) +- [Kubernetes with Kustomize](/self-hosted/deploy/kubernetes/configure#deploy-opentelemetry-collector-to-use-an-external-tracing-backend) +- [Docker Compose](/self-hosted/deploy/docker-compose/configuration#configure-an-external-tracing-backend) ## HTTP Tracing Backends Sourcegraph containers export HTTP traces in OTel format to the bundled otel-collector. -For more information about HTTP traces, see the [Tracing](/admin/observability/tracing) page. +For more information about HTTP traces, see the [Tracing](/self-hosted/observability/tracing) page. The bundled otel-collector includes the following exporters, which support HTTP traces in OTel format: @@ -205,7 +205,7 @@ exporters: ### Jaeger -If you're looking for information about Sourcegraph's bundled Jaeger instance, head back to the [Tracing](/admin/observability/tracing) page to find the instructions for your deployment method. +If you're looking for information about Sourcegraph's bundled Jaeger instance, head back to the [Tracing](/self-hosted/observability/tracing) page to find the instructions for your deployment method. Refer to the [Jaeger](https://opentelemetry.io/docs/languages/js/exporters/#jaeger) documentation for options. diff --git a/docs/admin/observability/tracing.mdx b/docs/self-hosted/observability/tracing.mdx similarity index 85% rename from docs/admin/observability/tracing.mdx rename to docs/self-hosted/observability/tracing.mdx index 6b8f03534..5d6ccd217 100644 --- a/docs/admin/observability/tracing.mdx +++ b/docs/self-hosted/observability/tracing.mdx @@ -16,9 +16,9 @@ The quickest way to get started with HTTP tracing is to deploy our bundled Jaege To deploy our bundled Jaeger backend, follow the instructions for your deployment type: -- [Kubernetes with Helm](/admin/deploy/kubernetes#enable-the-bundled-jaeger-deployment) -- [Kubernetes with Kustomize](/admin/deploy/kubernetes/configure#deploy-the-bundled-opentelemetry-collector-and-jaeger) -- [Docker Compose](/admin/deploy/docker-compose/configuration#deploy-the-bundled-jaeger) +- [Kubernetes with Helm](/self-hosted/deploy/kubernetes#enable-the-bundled-jaeger-deployment) +- [Kubernetes with Kustomize](/self-hosted/deploy/kubernetes/configure#deploy-the-bundled-opentelemetry-collector-and-jaeger) +- [Docker Compose](/self-hosted/deploy/docker-compose/configuration#deploy-the-bundled-jaeger) Then configure your Site Configuration: @@ -47,14 +47,14 @@ Once deployed, the Jaeger web UI will be accessible at `/-/debug/jaeger` ### External OpenTelemetry-Compatible Platforms -If you prefer to use an external, OTel-compatible platform, you can configure Sourcegraph to export traces to it instead. See our [OpenTelemetry documentation](/admin/observability/opentelemetry) for further details. +If you prefer to use an external, OTel-compatible platform, you can configure Sourcegraph to export traces to it instead. See our [OpenTelemetry documentation](/self-hosted/observability/opentelemetry) for further details. Then configure your Site Configuration: 1. Configure `observability.tracing` > `urlTemplate` 2. Optionally, configure `observability.client`, for Sourcegraph clients to also report traces, ex. src cli -For example, if you export your traces to [Honeycomb](/admin/observability/opentelemetry#otlp-compatible-backends), your Site Configuration may look like: +For example, if you export your traces to [Honeycomb](/self-hosted/observability/opentelemetry#otlp-compatible-backends), your Site Configuration may look like: ```json "observability.tracing": { @@ -80,7 +80,7 @@ We generally use the following approach when using traces to help root-cause an 3. Explore the request tree in the the tracing backend's UI, and take note of: 1. Items near the leaves which take up a significant portion of the overall request time 2. Spans which have errors attached to them -4. Search your Sourcegraph instance [logs](/admin/observability/logs) for events which include the corresponding `TraceId` or `SpanId` values +4. Search your Sourcegraph instance [logs](/self-hosted/observability/logs) for events which include the corresponding `TraceId` or `SpanId` values 5. Include this information in your Sourcegraph support ticket, by attaching the trace JSON file, and / or screenshots ### Trace a search query diff --git a/docs/admin/observability/troubleshooting.mdx b/docs/self-hosted/observability/troubleshooting.mdx similarity index 96% rename from docs/admin/observability/troubleshooting.mdx rename to docs/self-hosted/observability/troubleshooting.mdx index 4d3753af5..556d3b68d 100644 --- a/docs/admin/observability/troubleshooting.mdx +++ b/docs/self-hosted/observability/troubleshooting.mdx @@ -22,7 +22,7 @@ issue or generating a high-quality issue report. If this is the case, this could indicate high gitserver load. To confirm, take the following steps: -1. [Open Grafana](/admin/observability/metrics#grafana). +1. [Open Grafana](/self-hosted/observability/metrics#grafana). 1. **If using Sourcegraph 3.14**: Simply check if either of these alerts are firing: - `gitserver: 50+ concurrent command executions (abnormally high load)` - `gitserver: echo command execution duration exceeding 1s` @@ -32,7 +32,7 @@ If this is the case, this could indicate high gitserver load. To confirm, take t metric) and "Commands running concurrently" dashboard (tracks the `src_gitserver_exec_running` metric). If either of these is high (> 1s echo duration or 100s simultaneous execs), then this indicates gitserver is under heavy load and likely the bottleneck. -1. Confirm your gitserver is not under-provisioned, by e.g. comparing its allocated resources with what the [resource estimator](/admin/deploy/resource_estimator) shows. +1. Confirm your gitserver is not under-provisioned, by e.g. comparing its allocated resources with what the [resource estimator](/self-hosted/deploy/resource_estimator) shows. Solution: set `USE_ENHANCED_LANGUAGE_DETECTION=false` in the Sourcegraph runtime environment. @@ -174,7 +174,7 @@ _Note:_ This is unneeded if you are using the 'namespaced' overlay If your users are experiencing search timeouts or search performance issues, please perform the following steps: 1. Try appending variations of `index:only`, `timeout:60s` and `count:999999` to the search query to see if it is still slow. -1. [Access Grafana directly](/admin/observability/metrics#accessing-grafana-directly). +1. [Access Grafana directly](/self-hosted/observability/metrics#accessing-grafana-directly). 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. @@ -269,7 +269,7 @@ Network panel](https://developers.google.com/web/tools/chrome-devtools/network). ### Check resource usage -[Access Prometheus](/admin/observability/metrics#accessing-prometheus) and examine the following metrics: +[Access Prometheus](/self-hosted/observability/metrics#accessing-prometheus) and examine the following metrics: **Memory:** `process_resident_memory_bytes` is a gauge that tracks memory usage per backend process. @@ -288,7 +288,7 @@ Network panel](https://developers.google.com/web/tools/chrome-devtools/network). Go to `/site-admin/usage-statistics` to view daily, weekly, and monthly user statistics. To drill down (e.g., into sub-daily traffic, visits per page type, latencies, etc.), [access -Grafana](/admin/observability/metrics#grafana) and visit the Sourcegraph Internal > HTTP dashboard page, which +Grafana](/self-hosted/observability/metrics#grafana) and visit the Sourcegraph Internal > HTTP dashboard page, which includes the following panels: - QPS by Status Code @@ -301,7 +301,7 @@ title > Edit > copying the expression in the Metrics field. ### Check error rates -[Access Grafana](/admin/observability/metrics#grafana) and view the following charts: +[Access Grafana](/self-hosted/observability/metrics#grafana) and view the following charts: - Folder: Sourcegraph Internal > Dashboard: HTTP > Chart: QPS by Status Code - This shows request rates by HTTP status code for end-user requests. @@ -314,11 +314,11 @@ title > Edit > copying the expression in the Metrics field. If you are looking for the trace associated with a specific request, - [Find the trace ID in the HTTP response in the browser developer tools "Network" tab](#check-browser-network-panel). -- [Access Jaeger](/admin/observability/tracing#accessing-jaeger) and look up the trace ID. +- [Access Jaeger](/self-hosted/observability/tracing#accessing-jaeger) and look up the trace ID. If you do not have a specific request or cannot find the trace ID, -- [Access Jaeger](/admin/observability/tracing#accessing-jaeger). +- [Access Jaeger](/self-hosted/observability/tracing#accessing-jaeger). - Search for a matching span by setting the appropriate fields in the sidebar. 2 ways: start with a span ID, or manually locate your span by searching the Jaeger GUI diff --git a/docs/admin/config/postgres-conf.mdx b/docs/self-hosted/postgres-conf.mdx similarity index 95% rename from docs/admin/config/postgres-conf.mdx rename to docs/self-hosted/postgres-conf.mdx index 50cc07842..1bea7cd7e 100644 --- a/docs/admin/config/postgres-conf.mdx +++ b/docs/self-hosted/postgres-conf.mdx @@ -2,7 +2,7 @@ Sourcegraph Kubernetes cluster site admins can override the default PostgreSQL configuration by supplying their own `postgresql.conf` file contents. These are specified in [`pgsql.ConfigMap.yaml`](https://github.com/sourcegraph/deploy-sourcegraph/blob/master/base/pgsql/pgsql.ConfigMap.yaml). -For [Docker Compose](/admin/deploy/docker-compose/) deployment, site admins can also override the default PostgreSQL configuration by modifying the external configuration files at [pgsql/conf/postgresql.conf], [codeintel-db/conf/postgresql.conf], and [codeinsights-db/conf/postgresql.conf]. These files are mounted to the Postgres server during runtime (NOTE: This is only available in versions 3.39 and later). +For [Docker Compose](/self-hosted/deploy/docker-compose/) deployment, site admins can also override the default PostgreSQL configuration by modifying the external configuration files at [pgsql/conf/postgresql.conf], [codeintel-db/conf/postgresql.conf], and [codeinsights-db/conf/postgresql.conf]. These files are mounted to the Postgres server during runtime (NOTE: This is only available in versions 3.39 and later). There is no officially supported way of customizing the PostgreSQL configuration in the single Docker image. diff --git a/docs/admin/postgres.mdx b/docs/self-hosted/postgres.mdx similarity index 86% rename from docs/admin/postgres.mdx rename to docs/self-hosted/postgres.mdx index 481f32253..3b17b9cca 100644 --- a/docs/admin/postgres.mdx +++ b/docs/self-hosted/postgres.mdx @@ -10,7 +10,7 @@ Sourcegraph uses several PostgreSQL databases to support various functionality. ### Version requirements -We support Postgres 16 and above. Older versions of Sourcegraph supported 12 see our [Postgres 12 deprecation notice](/admin/postgres12_end_of_life_notice) for more details. Starting in Sourcegraph 6.0.0, sourcegraph services will no longer connect to a PostgreSQL 12 or lower database. Instead, it will display an error message in container logs for services attempting to connect to a PostgreSQL database below version 16. +We support Postgres 16 and above. Older versions of Sourcegraph supported 12 see our [Postgres 12 deprecation notice](/self-hosted/postgres12_end_of_life_notice) for more details. Starting in Sourcegraph 6.0.0, sourcegraph services will no longer connect to a PostgreSQL 12 or lower database. Instead, it will display an error message in container logs for services attempting to connect to a PostgreSQL database below version 16. ``` migrator | ✱ Sourcegraph migrator 6.0.0 @@ -45,7 +45,7 @@ vector ## Configuring PostgreSQL -Sourcegraph databases come preconfigured, however admins may make custom configurations as needed. For more information see our [configuration docs](/admin/config/postgres-conf). +Sourcegraph databases come preconfigured, however admins may make custom configurations as needed. For more information see our [configuration docs](/self-hosted/postgres-conf). ## Upgrading PostgreSQL @@ -65,12 +65,12 @@ These images contain an entry script that will detect and upgrade Postgres insta > > Additionally, once the upgrade process is started via the database container, interrupting the container before the upgrade is complete could result in corrupting the underlying Postgres database. **We strongly advise taking a backup before the upgrade.** -**For instance specfic instructions on how to upgrade a builtin Postgres database via the image entrypoint script, see [our instance specific operational instructions](/admin/how-to/upgrade-postgres-12-16-builtin-dbs).** +**For instance specfic instructions on how to upgrade a builtin Postgres database via the image entrypoint script, see [our instance specific operational instructions](/self-hosted/how-to/upgrade-postgres-12-16-builtin-dbs).** We have the following advisements to admins: - Container orchestration management systems (e.g. Kubernetes) may restart containers at any time, **it is recommended that you take a backup of your database before starting the upgrade process.** -- Review your deployment types [upgrade notes](/admin/updates#upgrades-index) before upgrading. The PostgreSQL upgrade process mutates the database schema in a way that may Sourcegraph `v5.10.0` and `v5.11.0` may not recognize. [Learn more about pg12 to pg16 schema drift here](/admin/how-to/postgres_12_to_16_drift). +- Review your deployment types [upgrade notes](/self-hosted/updates#upgrades-index) before upgrading. The PostgreSQL upgrade process mutates the database schema in a way that may Sourcegraph `v5.10.0` and `v5.11.0` may not recognize. [Learn more about pg12 to pg16 schema drift here](/self-hosted/how-to/postgres_12_to_16_drift). For additional assistance with PostgreSQL upgrades, please contact support@sourcegraph.com. @@ -86,7 +86,7 @@ The `PG_UPGRADE_EXTRA_ARGS` environment variable allows you to customize the `pg ### Upgrading external PostgreSQL instances -When running an [external PostgreSQL instance](/admin/external_services/postgres), please do the following: +When running an [external PostgreSQL instance](/self-hosted/external_services/postgres), please do the following: 1. Back up the Postgres DB so that you can restore to the old version should anything go wrong. 2. Turn off Sourcegraph entirely (bring down all containers and pods so they cannot talk to Postgres.) diff --git a/docs/admin/postgres12_end_of_life_notice.mdx b/docs/self-hosted/postgres12_end_of_life_notice.mdx similarity index 100% rename from docs/admin/postgres12_end_of_life_notice.mdx rename to docs/self-hosted/postgres12_end_of_life_notice.mdx diff --git a/docs/admin/postgresql_collation_version_mismatch_resolution.mdx b/docs/self-hosted/postgresql_collation_version_mismatch_resolution.mdx similarity index 100% rename from docs/admin/postgresql_collation_version_mismatch_resolution.mdx rename to docs/self-hosted/postgresql_collation_version_mismatch_resolution.mdx diff --git a/docs/admin/pprof.mdx b/docs/self-hosted/pprof.mdx similarity index 97% rename from docs/admin/pprof.mdx rename to docs/self-hosted/pprof.mdx index 0a323f991..6e0c7ff74 100644 --- a/docs/admin/pprof.mdx +++ b/docs/self-hosted/pprof.mdx @@ -14,7 +14,7 @@ See [expose debug port in Docker Compose](/admin/deploy/docker-compose/#operatio ### Sourcegraph with Kubernetes -If you're using the [Kubernetes cluster deployment](/admin/deploy/kubernetes/), +If you're using the [Kubernetes cluster deployment](/self-hosted/deploy/kubernetes/), you need to port-forward 6060 from the frontend pod (if you have more than one, choose one): ```bash script diff --git a/docs/admin/config/private-network.mdx b/docs/self-hosted/private-network.mdx similarity index 100% rename from docs/admin/config/private-network.mdx rename to docs/self-hosted/private-network.mdx diff --git a/docs/admin/config/restore/index.mdx b/docs/self-hosted/restore.mdx similarity index 100% rename from docs/admin/config/restore/index.mdx rename to docs/self-hosted/restore.mdx diff --git a/docs/admin/sourcegraph-nginx-mermaid.mdx b/docs/self-hosted/sourcegraph-nginx-mermaid.mdx similarity index 100% rename from docs/admin/sourcegraph-nginx-mermaid.mdx rename to docs/self-hosted/sourcegraph-nginx-mermaid.mdx diff --git a/docs/admin/ssl_https_self_signed_cert_nginx.mdx b/docs/self-hosted/ssl_https_self_signed_cert_nginx.mdx similarity index 97% rename from docs/admin/ssl_https_self_signed_cert_nginx.mdx rename to docs/self-hosted/ssl_https_self_signed_cert_nginx.mdx index 4b1905c39..132e96570 100644 --- a/docs/admin/ssl_https_self_signed_cert_nginx.mdx +++ b/docs/self-hosted/ssl_https_self_signed_cert_nginx.mdx @@ -149,7 +149,7 @@ This is largely the same as step 5, except easier. For other developer machines ## Next steps - [Configure Sourcegraph's `externalURL`](/admin/config/site_config) -- [Redirect to external HTTPS URL](/admin/http_https_configuration#redirect-to-external-https-url) -- [NGINX HTTP Strict Transport Security](/admin/http_https_configuration#redirect-to-external-https-url) +- [Redirect to external HTTPS URL](/self-hosted/http_https_configuration#redirect-to-external-https-url) +- [NGINX HTTP Strict Transport Security](/self-hosted/http_https_configuration#redirect-to-external-https-url) - [NGINX SSL Termination guide](https://docs.nginx.com/nginx/admin-guide/security-controls/terminating-ssl-http/) - [NGINX HTTPS Servers guide](https://nginx.org/en/docs/http/configuring_https_servers.html). diff --git a/docs/admin/updates/automatic.mdx b/docs/self-hosted/updates/automatic.mdx similarity index 88% rename from docs/admin/updates/automatic.mdx rename to docs/self-hosted/updates/automatic.mdx index ae6f45521..a33d96624 100644 --- a/docs/admin/updates/automatic.mdx +++ b/docs/self-hosted/updates/automatic.mdx @@ -1,12 +1,12 @@ # Automatic multi-version upgrades -> Warning: Automatic upgrades to v5.10.0 will fail please upgrade to a v5.9.x version and perform a standard upgrade instead! See our [postgres 12 end of life](https://sourcegraph.com/docs/admin/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! This is one of the reasons the "Auto Upgrade" toggle is automatically turned off after a version change. This behavior is intentional—it’s designed to prevent users from unintentionally performing multi-version upgrades (MVUs) that span critical changes, such as major infrastructure updates like a PostgreSQL version upgrade. +> Warning: Automatic upgrades to v5.10.0 will fail please upgrade to a v5.9.x version and perform a standard upgrade instead! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! This is one of the reasons the "Auto Upgrade" toggle is automatically turned off after a version change. This behavior is intentional—it’s designed to prevent users from unintentionally performing multi-version upgrades (MVUs) that span critical changes, such as major infrastructure updates like a PostgreSQL version upgrade. From **Sourcegraph 5.1 and later**, multi-version upgrades can be performed **automatically** as if they were a standard upgrade for the same deployment type. Automatic multi-version upgrades take the following general form: 1. Determine if your instance is ready to Upgrade: 1. Check your Sourcegraph instances `Site admin > Updates` page. ([more info](/admin/updates/#upgrade-readiness)) - 2. Consult upgrade notes for your deployment type accross the range of your upgrade. ([Kubernetes](/admin/updates/kubernetes), [Docker-compose](/admin/updates/docker_compose), [Server](/admin/updates/server)) + 2. Consult upgrade notes for your deployment type accross the range of your upgrade. ([Kubernetes](/self-hosted/updates/kubernetes), [Docker-compose](/self-hosted/updates/docker_compose), [Server](/self-hosted/updates/server)) 2. Merge the latest Sourcegraph release into your deployment manifests. 3. With upstream changes to your manifests merged, start the new instance. diff --git a/docs/admin/updates/docker_compose.mdx b/docs/self-hosted/updates/docker_compose.mdx similarity index 91% rename from docs/admin/updates/docker_compose.mdx rename to docs/self-hosted/updates/docker_compose.mdx index 915e5be29..e3699a789 100644 --- a/docs/admin/updates/docker_compose.mdx +++ b/docs/self-hosted/updates/docker_compose.mdx @@ -4,8 +4,8 @@ This page lists the changes that are relevant for upgrading Sourcegraph on **Doc For upgrade procedures or general info about sourcegraph versioning see the links below: -- [Docker Compose Upgrade Procedures](/admin/deploy/docker-compose/upgrade) -- [General Upgrade Info](/admin/updates/) +- [Docker Compose Upgrade Procedures](/self-hosted/deploy/docker-compose/upgrade) +- [General Upgrade Info](/self-hosted/updates/) - [Technical changelog](/technical-changelog) > **\*Attention:** These notes may contain relevant information about the infrastructure update such as resource requirement changes or versions of depencies (Docker, Docker Compose, externalized databases).\* @@ -40,11 +40,11 @@ Only self-hosted customers using the Sourcegraph provided PostgreSQL container i Self-hosted customers using external databases, such as AWS RDS, GCP CloudSQL, or another self-managed solution are NOT affected. -See our [PostgreSQL Collation Version Mismatch Resolution](/admin/postgresql_collation_version_mismatch_resolution) notes for more details. +See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgresql_collation_version_mismatch_resolution) notes for more details. ## v6.0.0 -- Sourcegraph 6.0.0 no longer supports PostgreSQL 12, admins must upgrade to PostgreSQL 16. See our [postgres 12 end of life](/admin/postgres12_end_of_life_notice) notice! As well as [supporting documentation](/admin/postgres) and advisements on how to upgrade. +- Sourcegraph 6.0.0 no longer supports PostgreSQL 12, admins must upgrade to PostgreSQL 16. See our [postgres 12 end of life](/self-hosted/postgres12_end_of_life_notice) notice! As well as [supporting documentation](/self-hosted/postgres) and advisements on how to upgrade. ## v5.9.0 ➔ v5.10.1164 @@ -54,7 +54,7 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/admin/postgresql_col > Warning: Admins are advised to upgrade directly to v5.10.1164 circumventing this release. > -> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to take a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/admin/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! +> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to take a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! > > Warning: `automatic` and migrator `upgrade` command will not work for this release, please upgrade directly to `v5.10.1164`, or to a 5.9 version and conduct a standard upgrade using migrator's default `up` command! @@ -146,9 +146,9 @@ This release introduces a background job that will convert all LSIF data into SC #### Notes: - Target the tag [`v4.0.1`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v4.0.1/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. -- `jaeger` (deployed with the `jaeger-all-in-one` image) has been removed in favor of an [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) DaemonSet + Deployment configuration. See [Configure a tracing backend](/admin/deploy/docker-compose/operations#configure-a-tracing-backend) -- Exporting traces to an external observability backend is now available. Read the [documentation](/admin/deploy/docker-compose/operations#configure-a-tracing-backend) to configure. -- The bundled Jaeger instance is now disabled by default. It can be [enabled](/admin/deploy/docker-compose/operations#enable-the-bundled-jaeger-deployment) if you do not wish to utilise your own external tracing backend. +- `jaeger` (deployed with the `jaeger-all-in-one` image) has been removed in favor of an [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) DaemonSet + Deployment configuration. See [Configure a tracing backend](/self-hosted/deploy/docker-compose/operations#configure-a-tracing-backend) +- Exporting traces to an external observability backend is now available. Read the [documentation](/self-hosted/deploy/docker-compose/operations#configure-a-tracing-backend) to configure. +- The bundled Jaeger instance is now disabled by default. It can be [enabled](/self-hosted/deploy/docker-compose/operations#enable-the-bundled-jaeger-deployment) if you do not wish to utilise your own external tracing backend. ## v3.42 ➔ v3.43 @@ -210,7 +210,7 @@ This release introduces a background job that will convert all LSIF data into SC - Target the tag [`v3.37.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.37.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. - This release adds a new container that runs database migrations (`migrator`) independently of the frontend container. Confirm the environment variables on this new container match your database settings. -- **If performing a multiversion upgrade from an instance prior to this version see our [upgrading early versions documentation](/admin/updates/migrator/upgrading-early-versions#before-v3370)** +- **If performing a multiversion upgrade from an instance prior to this version see our [upgrading early versions documentation](/self-hosted/updates/migrator/upgrading-early-versions#before-v3370)** ## v3.35 ➔ v3.36 @@ -266,7 +266,7 @@ This release introduces a background job that will convert all LSIF data into SC #### Notes: - Target the tag [`v3.29.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.29.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. -- This upgrade adds a new `worker` service that runs a number of background jobs that were previously run in the `frontend` service. See [notes on deploying workers](/admin/workers#deploying-workers) for additional details. Good initial values for CPU and memory resources allocated to this new service should match the `frontend` service. +- This upgrade adds a new `worker` service that runs a number of background jobs that were previously run in the `frontend` service. See [notes on deploying workers](/self-hosted/workers#deploying-workers) for additional details. Good initial values for CPU and memory resources allocated to this new service should match the `frontend` service. ## v3.27 ➔ v3.28 @@ -282,8 +282,8 @@ This release introduces a background job that will convert all LSIF data into SC #### Notes: - Target the tag [`v3.27.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.27.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. -- If you are using an external database, [upgrade your database](/admin/postgres#upgrading-external-postgresql-instances) to Postgres 12 or above prior to upgrading Sourcegraph. No action is required if you are using the supplied supplied database images. -- **If performing a multiversion upgrade from an instance prior to this version see our [upgrading early versions documentation](/admin/updates/migrator/upgrading-early-versions#before-v3270)** +- If you are using an external database, [upgrade your database](/self-hosted/postgres#upgrading-external-postgresql-instances) to Postgres 12 or above prior to upgrading Sourcegraph. No action is required if you are using the supplied supplied database images. +- **If performing a multiversion upgrade from an instance prior to this version see our [upgrading early versions documentation](/self-hosted/updates/migrator/upgrading-early-versions#before-v3270)** ## v3.25 ➔ v3.26 @@ -317,11 +317,11 @@ This release introduces a background job that will convert all LSIF data into SC - Target the tag [`v3.22.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.22.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. - This upgrade removes the `code intel bundle manager`. This service has been deprecated and all references to it have been removed. -- This upgrade also adds a MinIO container that doesn't require any custom configuration. You can find more detailed documentation [here](/admin/external_services/object_storage). +- This upgrade also adds a MinIO container that doesn't require any custom configuration. You can find more detailed documentation [here](/self-hosted/external_services/object_storage). ## v3.20 ➔ v3.21 #### Notes: - Target the tag [`v3.21.1`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.21.1/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. -- This release introduces a second database instance, `codeintel-db`. If you have configured Sourcegraph with an external database, then update the `CODEINTEL_PG*` environment variables to point to a new external database as described in the [external database documentation](/admin/external_services/postgres). Again, these must not point to the same database or the Sourcegraph instance will refuse to start. +- This release introduces a second database instance, `codeintel-db`. If you have configured Sourcegraph with an external database, then update the `CODEINTEL_PG*` environment variables to point to a new external database as described in the [external database documentation](/self-hosted/external_services/postgres). Again, these must not point to the same database or the Sourcegraph instance will refuse to start. diff --git a/docs/admin/updates/index.mdx b/docs/self-hosted/updates/index.mdx similarity index 76% rename from docs/admin/updates/index.mdx rename to docs/self-hosted/updates/index.mdx index be7cbdd50..f3bad845f 100644 --- a/docs/admin/updates/index.mdx +++ b/docs/self-hosted/updates/index.mdx @@ -74,7 +74,7 @@ Sourcegraph has two upgrade types. **Standard** upgrades and **Multiversion** up To facilitate the management of Sourcegraph's databases, we have created the `migrator` service. `migrator` is usually triggered automatically on Sourcegraph startup but can also be interacted with like a cli tool. Migrator's primary purpose is to manage and apply schema migrations. - To learn more about migrations see our [developer docs](https://docs-legacy.sourcegraph.com/dev/background-information/sql/migrations_overview). -- For a full listing of migrator's command arguments see its [usage docs](/admin/updates/migrator/migrator-operations). +- For a full listing of migrator's command arguments see its [usage docs](/self-hosted/updates/migrator/migrator-operations). ### Best Practices @@ -92,8 +92,8 @@ Sourcegraph upgrades take the following general form: 1. Determine if your instance is ready to Upgrade (check upgrade notes) 2. Merge the latest Sourcegraph release into your deployment manifests 3. Select an upgrade method: - - If updating more than a single minor version, perform a multiversion upgrade with either the migrator [upgrade command](/admin/updates/migrator/migrator-operations#upgrade) or an [automatic upgrade](/admin/updates/automatic). _This method requires downtime._ - - If updating a single minor version, perform a standard upgrade with the [migrator up command](/admin/updates/migrator/migrator-operations#up) or an [automatic upgrade](/admin/updates/automatic). `up` is the default migrator entry command and runs on `frontend` startup. + - If updating more than a single minor version, perform a multiversion upgrade with either the migrator [upgrade command](/self-hosted/updates/migrator/migrator-operations#upgrade) or an [automatic upgrade](/self-hosted/updates/automatic). _This method requires downtime._ + - If updating a single minor version, perform a standard upgrade with the [migrator up command](/self-hosted/updates/migrator/migrator-operations#up) or an [automatic upgrade](/self-hosted/updates/automatic). `up` is the default migrator entry command and runs on `frontend` startup. 4. With upstream changes to your manifests merged, start the new instance > Note: For more explicit steps, specific to your deployment see the operations guides linked below. @@ -107,36 +107,36 @@ Navigate to the `Site admin > Updates` page. Here you'll be notified if your ins If your instance has schema drift or unfinished oob migrations you may need to address these issues before upgrading. Feel free to reach out to us at [support@sourcegraph.com](mailto:support@sourcegraph.com). - [More info on OOB migrations](https://docs-legacy.sourcegraph.com/dev/background-information/sql/migrations_overview#out-of-band-migrations) -- [More info on schema drift](/admin/updates/migrator/schema-drift) +- [More info on schema drift](/self-hosted/updates/migrator/schema-drift) ## Instance Specific Procedures ### Upgrades index - **Sourcegraph with Docker Compose** - - [Standard Upgrade Operations](/admin/deploy/docker-compose/upgrade#standard-upgrades) - - [Multiversion Upgrade Operations](/admin/deploy/docker-compose/upgrade#multi-version-upgrades) - - [Upgrade Notes](/admin/updates/docker_compose) + - [Standard Upgrade Operations](/self-hosted/deploy/docker-compose/upgrade#standard-upgrades) + - [Multiversion Upgrade Operations](/self-hosted/deploy/docker-compose/upgrade#multi-version-upgrades) + - [Upgrade Notes](/self-hosted/updates/docker_compose) - **Sourcegraph with Kubernetes** - **Kustomize** - - [Standard Upgrade Operations](/admin/deploy/kubernetes/upgrade#standard-upgrades) - - [Multiversion Upgrade Operations](/admin/deploy/kubernetes/upgrade#multi-version-upgrades) + - [Standard Upgrade Operations](/self-hosted/deploy/kubernetes/upgrade#standard-upgrades) + - [Multiversion Upgrade Operations](/self-hosted/deploy/kubernetes/upgrade#multi-version-upgrades) - **Helm** - - [Standard Upgrade Operations](/admin/deploy/kubernetes#standard-upgrades) - - [Multiversion Upgrade Operations](/admin/deploy/kubernetes#multi-version-upgrades) - - [Upgrade Notes](/admin/updates/kubernetes) + - [Standard Upgrade Operations](/self-hosted/deploy/kubernetes#standard-upgrades) + - [Multiversion Upgrade Operations](/self-hosted/deploy/kubernetes#multi-version-upgrades) + - [Upgrade Notes](/self-hosted/updates/kubernetes) - **Single-container Sourcegraph with Docker** - [Standard Upgrade Operations](/admin/deploy/docker-single-container/#standard-upgrades) - [Multiversion Upgrade Operations](/admin/deploy/docker-single-container/#multi-version-upgrades) - - [Upgrade Notes](/admin/updates/server) -- [**Pure-docker custom deployments**](/admin/updates/pure_docker) -- [**Sourcegraph AWS AMI instances**](/admin/deploy/machine-images/aws-ami#upgrade) + - [Upgrade Notes](/self-hosted/updates/server) +- [**Pure-docker custom deployments**](/self-hosted/updates/pure_docker) +- [**Sourcegraph AWS AMI instances**](/self-hosted/deploy/machine-images/aws-ami#upgrade) ## Other helpful links -- [PostgreSQL Collation Version Mismatch Resolution](/admin/postgresql_collation_version_mismatch_resolution) -- [Postgres 12 End Of Life Notice](/admin/postgres12_end_of_life_notice) -- [Migrator operations](/admin/updates/migrator/migrator-operations) -- [Upgrading Early Versions](/admin/updates/migrator/upgrading-early-versions) -- [Troubleshooting upgrades](/admin/updates/migrator/troubleshooting-upgrades) -- [Downgrading](/admin/updates/migrator/downgrading) +- [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgresql_collation_version_mismatch_resolution) +- [Postgres 12 End Of Life Notice](/self-hosted/postgres12_end_of_life_notice) +- [Migrator operations](/self-hosted/updates/migrator/migrator-operations) +- [Upgrading Early Versions](/self-hosted/updates/migrator/upgrading-early-versions) +- [Troubleshooting upgrades](/self-hosted/updates/migrator/troubleshooting-upgrades) +- [Downgrading](/self-hosted/updates/migrator/downgrading) diff --git a/docs/admin/updates/kubernetes.mdx b/docs/self-hosted/updates/kubernetes.mdx similarity index 87% rename from docs/admin/updates/kubernetes.mdx rename to docs/self-hosted/updates/kubernetes.mdx index 6fe7b7b0b..a9ef02d64 100644 --- a/docs/admin/updates/kubernetes.mdx +++ b/docs/self-hosted/updates/kubernetes.mdx @@ -4,9 +4,9 @@ This page lists the changes that are relevant for upgrading Sourcegraph on **Kub For upgrade procedures or general info about sourcegraph versioning see the links below: -- [Kubernetes Kustomize Upgrade Procedures](/admin/deploy/kubernetes/upgrade) -- [Kubernetes Helm Upgrade Procedures](/admin/deploy/kubernetes#upgrading-sourcegraph) -- [General Upgrade Info](/admin/updates) +- [Kubernetes Kustomize Upgrade Procedures](/self-hosted/deploy/kubernetes/upgrade) +- [Kubernetes Helm Upgrade Procedures](/self-hosted/deploy/kubernetes#upgrading-sourcegraph) +- [General Upgrade Info](/self-hosted/updates) - [Technical changelog](/technical-changelog) > **\*Attention:** These notes may contain relevant information about the infrastructure update such as resource requirement changes or versions of dependencies (Docker, kubernetes, externalized databases).\* @@ -46,11 +46,11 @@ Only self-hosted customers using the Sourcegraph provided PostgreSQL container i Self-hosted customers using external databases, such as AWS RDS, GCP CloudSQL, or another self-managed solution are NOT affected. -See our [PostgreSQL Collation Version Mismatch Resolution](/admin/postgresql_collation_version_mismatch_resolution) notes for more details. +See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgresql_collation_version_mismatch_resolution) notes for more details. ## v6.0.0 -- Sourcegraph 6.0.0 no longer supports PostgreSQL 12, admins must upgrade to PostgreSQL 16. See our [postgres 12 end of life](/admin/postgres12_end_of_life_notice) notice! As well as [supporting documentation](/admin/postgres) and advisements on how to upgrade. +- Sourcegraph 6.0.0 no longer supports PostgreSQL 12, admins must upgrade to PostgreSQL 16. See our [postgres 12 end of life](/self-hosted/postgres12_end_of_life_notice) notice! As well as [supporting documentation](/self-hosted/postgres) and advisements on how to upgrade. - The Kubernetes Helm deployment type does not support MVU from Sourcegraph `v5.9.45` versions and earlier to Sourcegraph `v6.0.0`. @@ -58,7 +58,7 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/admin/postgresql_col `v5.11.6271` then use the standard upgrade procedure to get to `v6.0.0`. This is because migrator v6.0.0 will no longer connect to Postgres 12 databases. For more info see our [PostgreSQL upgrade - docs](/admin/postgres#requirements). + docs](/self-hosted/postgres#requirements). ## v5.9.0 ➔ v5.10.1164 @@ -69,7 +69,7 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/admin/postgresql_col > Warning: Admins are advised to upgrade directly to v5.10.1164 circumventing this release. > -> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to take a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/admin/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! +> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to take a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! > > Warning: `automatic` and migrator `upgrade` command will not work for this release, please upgrade directly to `v5.10.1164`, or to a 5.9 version and conduct a standard upgrade using migrator's default `up` command! @@ -102,9 +102,9 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/admin/postgresql_col #### Notes: -- Our new [`kustomize` repo](https://github.com/sourcegraph/deploy-sourcegraph-k8s) is introduced. Admins are advised to follow our [migrate procedure](/admin/deploy/kubernetes/kustomize/migrate) to migrate away from our [legacy deployment](https://github.com/sourcegraph/deploy-sourcegraph) +- Our new [`kustomize` repo](https://github.com/sourcegraph/deploy-sourcegraph-k8s) is introduced. Admins are advised to follow our [migrate procedure](/self-hosted/deploy/kubernetes/kustomize/migrate) to migrate away from our [legacy deployment](https://github.com/sourcegraph/deploy-sourcegraph) - - **See our [note](/admin/deploy/kubernetes/upgrade#using-mvu-to-migrate-to-kustomize) on multiversion upgrades coinciding with this migration. Admins are advised to stop at this version, [migrate](/admin/deploy/kubernetes/kustomize/migrate), and then proceed with upgrading.** + - **See our [note](/self-hosted/deploy/kubernetes/upgrade#using-mvu-to-migrate-to-kustomize) on multiversion upgrades coinciding with this migration. Admins are advised to stop at this version, [migrate](/self-hosted/deploy/kubernetes/kustomize/migrate), and then proceed with upgrading.** - This release introduces a background job that will convert all LSIF data into SCIP. **This migration is irreversible** and a rollback from this version may result in loss of precise code intelligence data. Please see the [migration notes](/admin/how-to/lsif_scip_migration) for more details. @@ -131,7 +131,7 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/admin/postgresql_col #### Notes: - The `worker-executors` Service object is now included in manifests generated using `kustomize`. This object was already introduced in the base manifest, but omitted from manifests generated using `kustomize`. Its purpose is to enable ingested executor metrics to be scraped by Prometheus. It should have no impact on behavior. -- `minio` has been replaced with `blobstore`. Please see the update notes [here](/admin/how-to/blobstore_update_notes) +- `minio` has been replaced with `blobstore`. Please see the update notes [here](/self-hosted/how-to/blobstore_update_notes) - This upgrade adds a [node-exporter](https://github.com/prometheus/node_exporter) DaemonSet, which collects crucial machine-level metrics that help Sourcegraph scale your deployment. - **Note**: Similarly to `cadvisor`, `node-exporter`: @@ -146,8 +146,8 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/admin/postgresql_col #### Notes: - `jaeger-agent` sidecars have been removed in favor of an [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) DaemonSet + Deployment configuration. See [Configure a tracing backend section.](#configure-a-tracing-backend) -- Exporting traces to an external observability backend is now available. Read the [documentation](/admin/deploy/kubernetes/configure#configure-a-tracing-backend) to configure. -- The bundled Jaeger instance is now disabled by default. It can be [enabled](/admin/deploy/kubernetes/configure#enable-the-bundled-jaeger-deployment) if you do not wish to utilise your own external tracing backend. +- Exporting traces to an external observability backend is now available. Read the [documentation](/self-hosted/deploy/kubernetes/configure#configure-a-tracing-backend) to configure. +- The bundled Jaeger instance is now disabled by default. It can be [enabled](/self-hosted/deploy/kubernetes/configure#enable-the-bundled-jaeger-deployment) if you do not wish to utilise your own external tracing backend. ## v3.40 ➔ v3.41 @@ -176,7 +176,7 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/admin/postgresql_col #### Notes: - This release adds a new `migrator` initContainer to the frontend deployment to run database migrations. Confirm the environment variables on this new container match your database settings. [Docs](/admin/deploy/kubernetes/#database-migrations) -- **If performing a multiversion upgrade from an instance prior to this version see our [upgrading early versions documentation](/admin/updates/migrator/upgrading-early-versions#before-v3370)** +- **If performing a multiversion upgrade from an instance prior to this version see our [upgrading early versions documentation](/self-hosted/updates/migrator/upgrading-early-versions#before-v3370)** ## v3.35 ➔ v3.36 @@ -189,7 +189,7 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/admin/postgresql_col #### Notes: - The query-runner deployment has been removed, so if you deploy with a method other than the `kubectl-apply-all.sh`, a manual removal of the deployment may be necessary. - Follow the [standard upgrade procedure](/admin/deploy/kubernetes/upgrade) to upgrade your deployment. + Follow the [standard upgrade procedure](/self-hosted/deploy/kubernetes/upgrade) to upgrade your deployment. - There is a [known issue](/code_insights/how-tos/Troubleshooting#oob-migration-has-made-progress-but-is-stuck-before-reaching-100) with the Code Insights out-of-band settings migration not reaching 100% complete when encountering deleted users or organizations. ## v3.30 ➔ v3.31 @@ -213,7 +213,7 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/admin/postgresql_col #### Notes: -- This upgrade adds a new `worker` service that runs a number of background jobs that were previously run in the `frontend` service. See [notes on deploying workers](/admin/workers#deploying-workers) for additional details. Good initial values for CPU and memory resources allocated to this new service should match the `frontend` service. +- This upgrade adds a new `worker` service that runs a number of background jobs that were previously run in the `frontend` service. See [notes on deploying workers](/self-hosted/workers#deploying-workers) for additional details. Good initial values for CPU and memory resources allocated to this new service should match the `frontend` service. ## v3.27 ➔ v3.28 @@ -234,8 +234,8 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/admin/postgresql_col > Expect to have downtime relative to the size of your database. Additionally, you must ensure that have enough storage > space to accommodate the migration. A rough guide would be 2x the current on-disk database size -- If you are using an external database, [upgrade your database](/admin/postgres#upgrading-external-postgresql-instances) to Postgres 12 or above prior to upgrading Sourcegraph. No action is required if you are using the supplied database images. -- **If performing a multiversion upgrade from an instance prior to this version see our [upgrading early versions documentation](/admin/updates/migrator/upgrading-early-versions#before-v3270)** +- If you are using an external database, [upgrade your database](/self-hosted/postgres#upgrading-external-postgresql-instances) to Postgres 12 or above prior to upgrading Sourcegraph. No action is required if you are using the supplied database images. +- **If performing a multiversion upgrade from an instance prior to this version see our [upgrading early versions documentation](/self-hosted/updates/migrator/upgrading-early-versions#before-v3270)** ## v3.24 ➔ v3.25 @@ -249,13 +249,13 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/admin/postgresql_col #### Notes: - This upgrade removes the `code intel bundle manager`. This service has been deprecated and all references to it have been removed. -- This upgrade also adds a MinIO container that doesn't require any custom configuration. You can find more detailed documentation in [here](/admin/external_services/object_storage). +- This upgrade also adds a MinIO container that doesn't require any custom configuration. You can find more detailed documentation in [here](/self-hosted/external_services/object_storage). ## v3.20 ➔ v3.21 #### Notes: -- This release introduces a second database instance, `codeintel-db`. If you have configured Sourcegraph with an external database, then update the `CODEINTEL_PG*` environment variables to point to a new external database as described in the [external database documentation](/admin/external_services/postgres). Again, these must not point to the same database or the Sourcegraph instance will refuse to start. +- This release introduces a second database instance, `codeintel-db`. If you have configured Sourcegraph with an external database, then update the `CODEINTEL_PG*` environment variables to point to a new external database as described in the [external database documentation](/self-hosted/external_services/postgres). Again, these must not point to the same database or the Sourcegraph instance will refuse to start. ## v3.18 ➔ v3.19 diff --git a/docs/admin/updates/migrator/downgrading.mdx b/docs/self-hosted/updates/migrator/downgrading.mdx similarity index 92% rename from docs/admin/updates/migrator/downgrading.mdx rename to docs/self-hosted/updates/migrator/downgrading.mdx index c93969ff6..a35ad2e1f 100644 --- a/docs/admin/updates/migrator/downgrading.mdx +++ b/docs/self-hosted/updates/migrator/downgrading.mdx @@ -8,13 +8,13 @@ Sourcegraph guarantees database backward compatibility to the most recent minor In practice downgrading a Sourcegraph instance should always be a last option. Some versions of Sourcegraph apply out of band migrations which are irreversible and data loss may result. **We highly recommend creating a database backup before proceeding with an upgrade**. -> Note: As a percaution its advised that after any downgrade the databases are checked with the `migrator` [`drift` command](/admin/updates/migrator/migrator-operations#drift) to identify any problems reversing migrations. +> Note: As a percaution its advised that after any downgrade the databases are checked with the `migrator` [`drift` command](/self-hosted/updates/migrator/migrator-operations#drift) to identify any problems reversing migrations. If ever you are uncertain about a downgrade please reach out to us at [support@sourcegraph.com](mailto:support@sourcegraph.com) ## Multiversion downgrades - `downgrade` with `migrator` -The migrator service can be run with the `downgrade` command. See the [command documentation](/admin/updates/migrator/migrator-operations#downgrade). +The migrator service can be run with the `downgrade` command. See the [command documentation](/self-hosted/updates/migrator/migrator-operations#downgrade). `downgrade` applies reverse schema migrations corresponding with the migrations performed over a version range. It also triggers reverse out of band migrations where possible. Some out of band migrations are irreversible. diff --git a/docs/self-hosted/updates/migrator/index.mdx b/docs/self-hosted/updates/migrator/index.mdx new file mode 100644 index 000000000..f52ef1dcd --- /dev/null +++ b/docs/self-hosted/updates/migrator/index.mdx @@ -0,0 +1,7 @@ +# Migrator Resources + +- [Downgrading](/self-hosted/updates/migrator/downgrading) +- [Migrator operations](/self-hosted/updates/migrator/migrator-operations) +- [Schema drift explained](/self-hosted/updates/migrator/schema-drift) +- [Troubleshooting Upgrades](/self-hosted/updates/migrator/troubleshooting-upgrades) +- [Upgrading Early Versions](/self-hosted/updates/migrator/upgrading-early-versions) diff --git a/docs/admin/updates/migrator/migrator-operations.mdx b/docs/self-hosted/updates/migrator/migrator-operations.mdx similarity index 95% rename from docs/admin/updates/migrator/migrator-operations.mdx rename to docs/self-hosted/updates/migrator/migrator-operations.mdx index 527f86efe..ca290d41f 100644 --- a/docs/admin/updates/migrator/migrator-operations.mdx +++ b/docs/self-hosted/updates/migrator/migrator-operations.mdx @@ -93,18 +93,18 @@ upgrade \ - `--disable-animation`: Print plain log messages instead of an animated progress bar. - `--skip-version-check`: Skip comparing the current instance version against `--from`. - `--skip-drift-check`: Skip comparing the database schema shape against the schema defined by `--from`. -- `--unprivileged-only` and `--noop-privileged`: Controls behavior of schema migrations the presence of [privileged definitions](/admin/how-to/privileged_migrations). +- `--unprivileged-only` and `--noop-privileged`: Controls behavior of schema migrations the presence of [privileged definitions](/self-hosted/how-to/privileged_migrations). - `--ignore-migrator-update`: Controls whether to hard- or soft-fail if a newer migrator version is available. It is recommended to use the latest migrator version. **Notes**: - Successive invocations of this command will re-attempt the last failed or attempted (but incomplete) migration. This command run as if the `--ignore-single-{dirty,pending}-log` flags supplied by the commands `up`, `upto`, and `downto` were enabled. -- This command checks that the schema of the database is in the correct state for the current version, if schema drift is detected it must be resolved before completing the upgrade. [Learn more here.](/admin/updates/migrator/schema-drift). +- This command checks that the schema of the database is in the correct state for the current version, if schema drift is detected it must be resolved before completing the upgrade. [Learn more here.](/self-hosted/updates/migrator/schema-drift). - Successive invocations of this command may _cause_ database drift when partial progress is made. When making a subsequent upgrade attempt, invoke this command with `--skip-drift-check` ignore the failing startup check. ### drift -The `drift` command describes the current (live) database schema and compares it against the expected schema at the given version. The output of this command will include all relevant schema differences that could affect application correctness and performance. When schema drift is detected, a diff of the expected and actual Postgres object definitions will be shown, along with instructions on how to manually resolve the disparity. [Learn more here.](/admin/updates/migrator/schema-drift) +The `drift` command describes the current (live) database schema and compares it against the expected schema at the given version. The output of this command will include all relevant schema differences that could affect application correctness and performance. When schema drift is detected, a diff of the expected and actual Postgres object definitions will be shown, along with instructions on how to manually resolve the disparity. [Learn more here.](/self-hosted/updates/migrator/schema-drift) ```sh drift \ @@ -151,7 +151,7 @@ downgrade \ - `--disable-animation`: Print plain log messages instead of an animated progress bar. - `--skip-version-check`: Skip comparing the current instance version against `--from`. - `--skip-drift-check`: Skip comparing the database schema shape against the schema defined by `--from`. -- `--unprivileged-only`: Controls behavior of schema migrations the presence of [privileged definitions](/admin/how-to/privileged_migrations). +- `--unprivileged-only`: Controls behavior of schema migrations the presence of [privileged definitions](/self-hosted/how-to/privileged_migrations). - `--ignore-migrator-update`: Controls whether to hard- or soft-fail if a newer migrator version is available. It is recommended to use the latest migrator version. **Notes**: @@ -161,7 +161,7 @@ downgrade \ ### add-log -The `add-log` command adds an entry to the `migration_logs` table after a site administrator has explicitly applied the contents of a migration definition. This command may be performed by a site-administrator as part of [repairing a dirty database](/admin/how-to/dirty_database#3-add-a-migration-log-entry). +The `add-log` command adds an entry to the `migration_logs` table after a site administrator has explicitly applied the contents of a migration definition. This command may be performed by a site-administrator as part of [repairing a dirty database](/self-hosted/how-to/dirty_database#3-add-a-migration-log-entry). ```sh add-log \ @@ -220,8 +220,8 @@ up \ - `--db`: The target schema(s) to modify. Comma-separated values are allowed. - `--skip-upgrade-validation`: Skip asserting that the [standard upgrade policy](/admin/updates/#upgrade-types) is being followed. - `--skip-oobmigration-validation`: Skip reading the progress of out-of-band migrations to assert completion of newly deprecated migrations. -- `--ignore-single-dirty-log` and `--ignore-single-pending-log`: Re-attempt to apply the **next** migration that was marked as errored or as incomplete (respectively). See [how to troubleshoot a dirty database](/admin/how-to/dirty_database#0-attempt-re-application). -- `--unprivileged-only`: Controls behavior of schema migrations the presence of [privileged definitions](/admin/how-to/privileged_migrations). +- `--ignore-single-dirty-log` and `--ignore-single-pending-log`: Re-attempt to apply the **next** migration that was marked as errored or as incomplete (respectively). See [how to troubleshoot a dirty database](/self-hosted/how-to/dirty_database#0-attempt-re-application). +- `--unprivileged-only`: Controls behavior of schema migrations the presence of [privileged definitions](/self-hosted/how-to/privileged_migrations). **Notes**: @@ -229,7 +229,7 @@ up \ ### run-out-of-band-migrations -The `run-out-of-band-migrations` command runs out-of-band migrations within the `migrator`. This command may be performed by a site-administrator as part of [repairing an unfinished migration](/admin/how-to/unfinished_migration). +The `run-out-of-band-migrations` command runs out-of-band migrations within the `migrator`. This command may be performed by a site-administrator as part of [repairing an unfinished migration](/self-hosted/how-to/unfinished_migration). ```sh run-out-of-band-migrations \ @@ -417,7 +417,7 @@ Observe the output of the `migrator` container via: $ docker logs migrator_$SOURCEGRAPH_VERSION ``` -The log output of the `migrator` should include `INFO`-level logs and successfully terminate with `migrator exited with code 0`. If you see an error message or any of the databases have been flagged as "dirty", please follow ["How to troubleshoot a dirty database"](/admin/how-to/dirty_database). A dirty database will not affect your ability to use Sourcegraph however it will need to be resolved to upgrade further. If you are unable to resolve the issues, contact support at `mailto:support@sourcegraph.com` for further assistance. Otherwise, you are now safe to upgrade Sourcegraph. +The log output of the `migrator` should include `INFO`-level logs and successfully terminate with `migrator exited with code 0`. If you see an error message or any of the databases have been flagged as "dirty", please follow ["How to troubleshoot a dirty database"](/self-hosted/how-to/dirty_database). A dirty database will not affect your ability to use Sourcegraph however it will need to be resolved to upgrade further. If you are unable to resolve the issues, contact support at `mailto:support@sourcegraph.com` for further assistance. Otherwise, you are now safe to upgrade Sourcegraph. ### Local development diff --git a/docs/admin/updates/migrator/schema-drift.mdx b/docs/self-hosted/updates/migrator/schema-drift.mdx similarity index 93% rename from docs/admin/updates/migrator/schema-drift.mdx rename to docs/self-hosted/updates/migrator/schema-drift.mdx index b6fd3014d..8401e9a6d 100644 --- a/docs/admin/updates/migrator/schema-drift.mdx +++ b/docs/self-hosted/updates/migrator/schema-drift.mdx @@ -12,7 +12,7 @@ During an upgrade you may run into the following message. This error indicates that `migrator` has detected some difference between the state of the schema in your database and the expected schema for the database in the `-from` or current version of your Sourcegraph instance. -When the schema [drift](/admin/updates/migrator/migrator-operations#drift) command is run you'll see a set of diffs representing the areas where your instance schema has diverged from the expected state as well as the SQL operations to fix these examples of drift. For example: +When the schema [drift](/self-hosted/updates/migrator/migrator-operations#drift) command is run you'll see a set of diffs representing the areas where your instance schema has diverged from the expected state as well as the SQL operations to fix these examples of drift. For example: ``` ❌ Missing index "external_service_repos"."external_service_repos_repo_id_external_service_id_unique" diff --git a/docs/admin/updates/migrator/troubleshooting-upgrades.mdx b/docs/self-hosted/updates/migrator/troubleshooting-upgrades.mdx similarity index 94% rename from docs/admin/updates/migrator/troubleshooting-upgrades.mdx rename to docs/self-hosted/updates/migrator/troubleshooting-upgrades.mdx index 813fb927f..08974629c 100644 --- a/docs/admin/updates/migrator/troubleshooting-upgrades.mdx +++ b/docs/self-hosted/updates/migrator/troubleshooting-upgrades.mdx @@ -24,4 +24,4 @@ In order to retrieve the error message printed by the migrator on startup, you'l Error from server (BadRequest): container "frontend" in pod "sourcegraph-frontend-69f4b68d75-w98lx" is waiting to start: PodInitializing ``` -Once a failing migration error message can be found, follow the guide on [how to troubleshoot a dirty database](/admin/how-to/dirty_database). +Once a failing migration error message can be found, follow the guide on [how to troubleshoot a dirty database](/self-hosted/how-to/dirty_database). diff --git a/docs/admin/updates/migrator/upgrading-early-versions.mdx b/docs/self-hosted/updates/migrator/upgrading-early-versions.mdx similarity index 93% rename from docs/admin/updates/migrator/upgrading-early-versions.mdx rename to docs/self-hosted/updates/migrator/upgrading-early-versions.mdx index ffac6dcb4..95db419ff 100644 --- a/docs/admin/updates/migrator/upgrading-early-versions.mdx +++ b/docs/self-hosted/updates/migrator/upgrading-early-versions.mdx @@ -15,16 +15,16 @@ The `upgrade` `migrator` command is introduced in `v4.0.0`, just remember to use In `v3.37.0` the `migrator` service was introduced. Docker-compose and Kubernetes instances hoping to upgrade from versions before the introduction of migrator will need to create the `migrator` manifest in order to run `migrator` commands. -- In Docker-compose add the [migrator service](https://github.com/sourcegraph/deploy-sourcegraph-docker/blob/master/docker-compose/docker-compose.yaml#LL3C1-L53C35) to the top of your `docker-compose.yaml` file and follow the [multiversion upgrade proceedure](/admin/deploy/docker-compose/upgrade#multi-version-upgrades). -- In kubernetes deployments you'll need to create the [`migrator.Job.yaml` job manifest](https://github.com/sourcegraph/deploy-sourcegraph/blob/master/configure/migrator/migrator.Job.yaml) and use it as described in the [multiversion upgrade procedure](/admin/deploy/kubernetes/upgrade#multi-version-upgrades). +- In Docker-compose add the [migrator service](https://github.com/sourcegraph/deploy-sourcegraph-docker/blob/master/docker-compose/docker-compose.yaml#LL3C1-L53C35) to the top of your `docker-compose.yaml` file and follow the [multiversion upgrade proceedure](/self-hosted/deploy/docker-compose/upgrade#multi-version-upgrades). +- In kubernetes deployments you'll need to create the [`migrator.Job.yaml` job manifest](https://github.com/sourcegraph/deploy-sourcegraph/blob/master/configure/migrator/migrator.Job.yaml) and use it as described in the [multiversion upgrade procedure](/self-hosted/deploy/kubernetes/upgrade#multi-version-upgrades). > Note: _It may be more effective in some cases to `git checkout` a later version of Sourcegraph to get access to `migrator` manifests and invoke migrator this was before checking back out your `release` branch and proceeding with the upgrade._ ## Before v3.27.0 In version `3.27` `pgsql` and `codeintel-db` databases were upgraded from Postgres 11 to Postgres 12. **If upgrading from 3.26 or before to 3.27 or later**, the `pgsql` and `codeintel-db` databases must have their Postgres version upgraded. If this step is not performed, then the following upgrade procedure will fail fast (and leave all existing data untouched). -- If using an external database, follow the [upgrading external PostgreSQL instances](/admin/postgres#upgrading-external-postgresql-instances) guide. -- Otherwise, perform the following steps from the [upgrading internal Postgres instances](/admin/postgres#upgrading-internal-postgresql-instances) guide. +- If using an external database, follow the [upgrading external PostgreSQL instances](/self-hosted/postgres#upgrading-external-postgresql-instances) guide. +- Otherwise, perform the following steps from the [upgrading internal Postgres instances](/self-hosted/postgres#upgrading-internal-postgresql-instances) guide. The following procedures decribe how to upgrade the Postgres version: diff --git a/docs/admin/updates/pure_docker.mdx b/docs/self-hosted/updates/pure_docker.mdx similarity index 97% rename from docs/admin/updates/pure_docker.mdx rename to docs/self-hosted/updates/pure_docker.mdx index f16c9650a..2206a4ec0 100644 --- a/docs/admin/updates/pure_docker.mdx +++ b/docs/self-hosted/updates/pure_docker.mdx @@ -32,7 +32,7 @@ Only self-hosted customers using the Sourcegraph provided PostgreSQL container i Self-hosted customers using external databases, such as AWS RDS, GCP CloudSQL, or another self-managed solution are NOT affected. -See our [PostgreSQL Collation Version Mismatch Resolution](/admin/postgresql_collation_version_mismatch_resolution) notes for more details. +See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgresql_collation_version_mismatch_resolution) notes for more details. ## v5.2.6 ➔ v5.2.7 @@ -340,7 +340,7 @@ As a template, perform the same actions as the following diffs in your own deplo ## v4.1 ➔ v4.2.1 -- `minio` has been replaced with `blobstore`. Please see the update notes [here](/admin/how-to/blobstore_update_notes) +- `minio` has been replaced with `blobstore`. Please see the update notes [here](/self-hosted/how-to/blobstore_update_notes) As a template, perform the same actions as the following diffs in your own deployment: @@ -541,7 +541,7 @@ As a template, perform the same actions as the following diffs in your own deplo **Notes**: -- This upgrade adds a new `worker` service that runs a number of background jobs that were previously run in the `frontend` service. See [notes on deploying workers](/admin/workers#deploying-workers) for additional details. Good initial values for CPU and memory resources allocated to this new service should match the `frontend` service. +- This upgrade adds a new `worker` service that runs a number of background jobs that were previously run in the `frontend` service. See [notes on deploying workers](/self-hosted/workers#deploying-workers) for additional details. Good initial values for CPU and memory resources allocated to this new service should match the `frontend` service. ## v3.27 ➔ v3.28 @@ -566,7 +566,7 @@ As a template, perform the same actions as the following diffs in your own deplo **Notes**: -- If you are using an external database, [upgrade your database](/admin/postgres#upgrading-external-postgresql-instances) to Postgres 12.5 or above prior to upgrading Sourcegraph. No action is required if you are using the supplied supplied database images. +- If you are using an external database, [upgrade your database](/self-hosted/postgres#upgrading-external-postgresql-instances) to Postgres 12.5 or above prior to upgrading Sourcegraph. No action is required if you are using the supplied supplied database images. ## v3.26 ➔ v3.26 @@ -617,7 +617,7 @@ As a template, perform the same actions as the following diffs in your own deplo **Notes**: - This upgrade removes the `code intel bundle manager`. This service has been deprecated and all references to it have been removed. -- This upgrade also adds a MinIO container that doesn't require any custom configuration. You can find more detailed documentation [here](/admin/external_services/object_storage). +- This upgrade also adds a MinIO container that doesn't require any custom configuration. You can find more detailed documentation [here](/self-hosted/external_services/object_storage). ## v3.20 ➔ v3.21 diff --git a/docs/admin/updates/server.mdx b/docs/self-hosted/updates/server.mdx similarity index 89% rename from docs/admin/updates/server.mdx rename to docs/self-hosted/updates/server.mdx index f03ebb466..057b03643 100644 --- a/docs/admin/updates/server.mdx +++ b/docs/self-hosted/updates/server.mdx @@ -4,8 +4,8 @@ This page lists the changes that are relevant for upgrading Sourcegraph on a **s For upgrade procedures or general info about sourcegraph versioning see the links below: -- [Single Container Upgrade Procedures](/admin/deploy/docker-single-container#upgrade) -- [General Upgrade Info](/admin/updates/) +- [Single Container Upgrade Procedures](/self-hosted/deploy/docker-single-container#upgrade) +- [General Upgrade Info](/self-hosted/updates/) - [Technical changelog](/technical-changelog) > **\*Attention:** These notes may contain relevant information about the infrastructure update such as resource requirement changes or versions of depencies (Docker, externalized databases).\* @@ -70,7 +70,7 @@ For upgrade procedures or general info about sourcegraph versioning see the link #### Notes: -- If you are using an external database, [upgrade your database](/admin/postgres#upgrading-external-postgresql-instances) to Postgres 12 or above prior to upgrading Sourcegraph. If you are using the embedded database, [prepare your data for migration](/admin/postgres#upgrading-single-node-docker-deployments) prior to upgrading Sourcegraph. +- If you are using an external database, [upgrade your database](/self-hosted/postgres#upgrading-external-postgresql-instances) to Postgres 12 or above prior to upgrading Sourcegraph. If you are using the embedded database, [prepare your data for migration](/self-hosted/postgres#upgrading-single-node-docker-deployments) prior to upgrading Sourcegraph. ## v3.24 ➔ v3.25 @@ -91,5 +91,5 @@ No upgrade notes. #### Notes: -- This release introduces a second database instance, `codeintel-db`. If you have configured Sourcegraph with an external database, then update the `CODEINTEL_PG*` environment variables to point to a new external database as described in the [external database documentation](/admin/external_services/postgres). Again, these must not point to the same database or the Sourcegraph instance will refuse to start. +- This release introduces a second database instance, `codeintel-db`. If you have configured Sourcegraph with an external database, then update the `CODEINTEL_PG*` environment variables to point to a new external database as described in the [external database documentation](/self-hosted/external_services/postgres). Again, these must not point to the same database or the Sourcegraph instance will refuse to start. - **Turn off database secrets encryption**. In Sourcegraph version 3.20, we would automatically generate a secret key file (`/var/lib/sourcegraph/token`) inside the container for encrypting secrets stored in the database. However, it is not yet ready for general use and format of the secret key file might change. Therefore, it is best to delete the secret key file (`/var/lib/sourcegraph/token`) and turn off the database secrets encryption. diff --git a/docs/admin/url.mdx b/docs/self-hosted/url.mdx similarity index 100% rename from docs/admin/url.mdx rename to docs/self-hosted/url.mdx diff --git a/docs/admin/validation.mdx b/docs/self-hosted/validation.mdx similarity index 100% rename from docs/admin/validation.mdx rename to docs/self-hosted/validation.mdx diff --git a/docs/admin/workers.mdx b/docs/self-hosted/workers.mdx similarity index 99% rename from docs/admin/workers.mdx rename to docs/self-hosted/workers.mdx index 0b0de6be3..44d007a0e 100644 --- a/docs/admin/workers.mdx +++ b/docs/self-hosted/workers.mdx @@ -142,7 +142,7 @@ This job periodically cleans up the `repo_statistics` table by rolling up all ro #### `record-encrypter` -This job bulk encrypts existing data in the database when an encryption key is introduced, and decrypts it when instructed to do. See [encryption](/admin/config/encryption) for additional details. +This job bulk encrypts existing data in the database when an encryption key is introduced, and decrypts it when instructed to do. See [encryption](/self-hosted/encryption) for additional details. #### `zoekt-repos-updater` diff --git a/docs/technical-changelog.mdx b/docs/technical-changelog.mdx index 741dc04fa..c8c7ac5cd 100644 --- a/docs/technical-changelog.mdx +++ b/docs/technical-changelog.mdx @@ -8,223 +8,221 @@ This page documents all notable changes to Sourcegraph. For curated highlights o ## v6.11.0 -- [sourcegraph](https://github.com/sourcegraph/sourcegraph/releases/tag/v6.11.0) +- [sourcegraph](https://github.com/sourcegraph/sourcegraph/releases/tag/v6.11.0) -- [docker-compose](https://github.com/sourcegraph/deploy-sourcegraph-docker/releases/tag/v6.11.0) +- [docker-compose](https://github.com/sourcegraph/deploy-sourcegraph-docker/releases/tag/v6.11.0) -- [helm](https://github.com/sourcegraph/deploy-sourcegraph-helm/releases/tag/v6.11.0) +- [helm](https://github.com/sourcegraph/deploy-sourcegraph-helm/releases/tag/v6.11.0) -- [kustomize](https://github.com/sourcegraph/deploy-sourcegraph-k8s/releases/tag/v6.11.0) +- [kustomize](https://github.com/sourcegraph/deploy-sourcegraph-k8s/releases/tag/v6.11.0) ### Features #### Others -- add ability to collapse individual references `(PR #7991)` - - Results in reference panel can now be collapsed. +- add ability to collapse individual references `(PR #7991)` + - Results in reference panel can now be collapsed. ### Fix #### Site Admin -- show auth errors directly on sign-in page for unauthenticated users `(PR #8001)` - - Fixed a bug where OAuth authentication errors (like "could not get verified email for GitHub user") were not being displayed in the UI, causing users to get stuck in an infinite login loop. +- show auth errors directly on sign-in page for unauthenticated users `(PR #8001)` + - Fixed a bug where OAuth authentication errors (like "could not get verified email for GitHub user") were not being displayed in the UI, causing users to get stuck in an infinite login loop. #### Code Intelligence -- add num_resets condition to queued_partial_ukey index `(PR #8124)` - - N/A -- do not deduplicate reset auto-indexing jobs `(PR #8095)` - - N/A -- disable automatic CRC32 checksums for S3 requests `(PR #8073)` - - Fixed s3proxy issue for multipart SCIP uploads -- dedupliacte some auto-indexing jobs automatically `(PR #7496)` - - We no longer queue duplicated jobs for repository HEAD auto-indexing. +- add num_resets condition to queued_partial_ukey index `(PR #8124)` + - N/A +- do not deduplicate reset auto-indexing jobs `(PR #8095)` + - N/A +- disable automatic CRC32 checksums for S3 requests `(PR #8073)` + - Fixed s3proxy issue for multipart SCIP uploads +- dedupliacte some auto-indexing jobs automatically `(PR #7496)` + - We no longer queue duplicated jobs for repository HEAD auto-indexing. #### Code Nav -- highlight dependency on go-enry with filetype names `(PR #8174)` - - N/A -- Remove deprecated AppCode and Atom editors `(PR #8129)` - - Remove support for Atom and AppCode from the "Editor" action. +- highlight dependency on go-enry with filetype names `(PR #8174)` + - N/A +- Remove deprecated AppCode and Atom editors `(PR #8129)` + - Remove support for Atom and AppCode from the "Editor" action. #### Gitserver -- treat 'fatal: bad tree object' errors on fetch as repository corruption events `(PR #7961)` - - Gitserver will now automatically reclone the repository if a `"fatal: bad tree object XXX"` error is observed during a fetch. (There is no way to recover from this, so re-cloning the repository is our only option.) +- treat 'fatal: bad tree object' errors on fetch as repository corruption events `(PR #7961)` + - Gitserver will now automatically reclone the repository if a `"fatal: bad tree object XXX"` error is observed during a fetch. (There is no way to recover from this, so re-cloning the repository is our only option.) #### Release -- Canonical Names Dont Count Dev Builds `(PR #8023)` - - fix(release): canonical names dont count dev builds -- improve error handling on rds first sync `(PR #7732)` - - fix(RDS connections): improve initial connection error message +- Canonical Names Dont Count Dev Builds `(PR #8023)` + - fix(release): canonical names dont count dev builds +- improve error handling on rds first sync `(PR #7732)` + - fix(RDS connections): improve initial connection error message #### Search -- Disable implicit repo name search when `repo: filter` is present `(PR #8071)` - - fix(search): Disable implicit repo name search when `repo: filter` is present +- Disable implicit repo name search when `repo: filter` is present `(PR #8071)` + - fix(search): Disable implicit repo name search when `repo: filter` is present ### Chore #### Deepsearch -- add "star" to conversation header `(PR #8075)` - - chore(deepsearch): add "star" to conversation header +- add "star" to conversation header `(PR #8075)` + - chore(deepsearch): add "star" to conversation header #### Mcp -- omit schema for mcp tools `(PR #8153)` - - MCP Schemas for tools will now be omitted by default which allows antigravity and vscode versions older than 1.32 not reject the Sourcegraph tool list which uses a newer schema. +- omit schema for mcp tools `(PR #8153)` + - MCP Schemas for tools will now be omitted by default which allows antigravity and vscode versions older than 1.32 not reject the Sourcegraph tool list which uses a newer schema. ### Reverts - There were no reverts for this release +There were no reverts for this release ### Uncategorized #### Others -- Convert site-admin auth providers page to native Svelte `(PR #8160)` - - Replaced the React `SiteAdminAuthenticationProvidersPage` component with a native Svelte implementation - - Updated integration test assertions to match the new markup structure -- Add banners to admin UI about config from file `(PR #8147)` - - When a site-config of global settings file is loaded from file system, the config editors in-app now correctly reflect the read-only state. -- fix(deep search): default to `everything` if `citations` and `files` are not available `(PR #8121)` - - Default to the `everything` sources tab if `citations` and `files` are not available. -- fix(deep search): unique render key for all sources tab `(PR #8120)` - - Fix the runtime error on the `All Sources` tab caused by duplicate render keys. -- fix(deep search): use relative links in synthetic citations sources `(PR #8117)` - - Use relative links for the synthetic citation source to avoid the double external URL bug. -- Add Opus 4.5 with thinking and deprecate Opus 4.1 models `(PR #8108)` - - Deprecates Opus 4.1 models in favor of the Opus 4.5 -- feat(deep search): optimisitic navigation to the new conversation page `(PR #8092)` - - Optimistic UI update on new Deep Search conversation creation: immediately navigate to the conversation view showing the submitted question with a loading indicator, before the server responds. -- fix(deep search): allow to navigate to DS home page from the conversation with a top nav link `(PR #8091)` - - Currently, clicking the Deep Search link in the top nav from the conversation view does nothing. This PR resolves the issue, allowing it to navigate to the Deep Search home page as expected. -- modelconfig: Redact provider access tokens `(PR #8076)` - - Model configuration in site-config now redacts access tokens in the UI. -- fix(deep search): expanded file preview consistent horizonal padding `(PR #8058)` - - Make horizonal padding consistent with citations padding. -- feat(deep search): jump between sources when files are expanded `(PR #8057)` - - When a user clicks on a citation in the conversation response while the file preview is open, the preview now updates to show the new file/range. -- fix(deep search): apply markdown styles `(PR #8055)` - - Apply markdown styles to Deep Search responses with enabled citations. -- analytics: Remove unused in-app analytics frontend components and APIs `(PR #8048)` - - This completes the in-app analytics deprecation and removes the following APIs: - ```graphql - type Query { - instanceOwnershipStats: OwnershipStats! - } - type User { - usageStatistics: UserUsageStatistics! - } - type Site { - usageStatistics( - days: Int - weeks: Int - months: Int - ): SiteUsageStatistics! - analytics: Analytics! - } - ``` -- fix(deep search): do not create new annotations for the same citations `(PR #8027)` - - Do not create new annotations for the same citations. -- fix(deep search): focus citations pane on annotation clicks `(PR #8026)` - - When a non-citations pane is focused and a user clicks on the annotation -> focus the citations pane and scroll to the relevant citation. -- fix(deep search): preserve revisions for citations `(PR #8022)` - - Preserves revisions for Deep Search citations. -- fix(deep search): ensure hovered separator is always on top of the resizable panels `(PR #8021)` - - Ensure the hovered separator is always on top of resizable panels. -- Add Tab key selection in @ menu for Deep Search `(PR #8020)` - - Add tab support when selecting repos in Deep Search @ menu -- Add claude-opus-4-5-20251101 to anthropic models `(PR #8015)` - - Adds Claude Opus 4.5 to model selection -- ui(deepsearch): show thread title in page title `(PR #7995)` - - Show thread title in page title -- observability: add incidentio alerts support `(PR #7994)` - - Added support for `incidentio` in `observability.alerts` -- prometheus: upgrade Alertmanager, remove fork usage `(PR #7993)` - - Upgraded Alertmanager to v0.29.0 -- Minor improvements to slack message for workspaces refunds `(PR #7990)` - - Updated the "REFUND POLICY VIOLATION" Slack alert to include direct links to the workspace admin page and Stripe dashboard, rather than just the raw UUID. - - Modified the refund handler to skip the state transition if the workspace is already deleted, preventing unnecessary Sentry errors. -- oauth: add predefined Raycast client `(PR #7966)` - - Added a predefined OAuth2 client for the [Sourcegraph Raycast extension](https://www.raycast.com/bobheadxi/sourcegraph). -- feat(deep search): experimental "citations" pane `(PR #7936)` - - Introduce DeepSearchSourcesState context to manage per-conversation/question citation and source state for Deep Search. - - Add DOM-based citation extraction and synthetic FileSource generation, enabling bidirectional highlighting and scrolling between answer content and the sources pane. - - Redesign the sources panel into tabbed “Citations” vs other source types, with ordering by citation number, smarter deduplication, and inline code snippet previews. - - Add shared scroll helper and clickable line-number links in CodeExcerpt for smoother navigation from sources to code. - - Tighten the Deep Search system prompt to standardize markdown, code blocks, and Sourcegraph-style links. -- frontend: users list: set policy to network only `(PR #7908)` - - N/A -- Removed sentry alert for ws chargebacks `(PR #7903)` - - Remove sentry alert for chargebacks - - Workspace deletion for chargebacks now handles DestroyPending and ErrWorkspaceNotFound states, to not try to delete already-deleted workspaces. -- frontend: No longer require frontend restarts after changing some settings `(PR #7853)` - - Frontend service restarts are no longer required when changing certain settings. -- deep search: support markdown routes `(PR #7757)` - - Users can append ".md" to a deep search url in which case we return a markdown version of the thread. -- Automated workspaces refunds and chargebacks handling `(PR #7572)` - - Automated refund policy validation based on geography and time - - Automated workspace deletion for policy-compliant full refunds and chargebacks - - Added Slack alerts for out-of-policy refunds - - Added test coverage +- Convert site-admin auth providers page to native Svelte `(PR #8160)` + - Replaced the React `SiteAdminAuthenticationProvidersPage` component with a native Svelte implementation + - Updated integration test assertions to match the new markup structure +- Add banners to admin UI about config from file `(PR #8147)` + - When a site-config of global settings file is loaded from file system, the config editors in-app now correctly reflect the read-only state. +- fix(deep search): default to `everything` if `citations` and `files` are not available `(PR #8121)` + - Default to the `everything` sources tab if `citations` and `files` are not available. +- fix(deep search): unique render key for all sources tab `(PR #8120)` + - Fix the runtime error on the `All Sources` tab caused by duplicate render keys. +- fix(deep search): use relative links in synthetic citations sources `(PR #8117)` + - Use relative links for the synthetic citation source to avoid the double external URL bug. +- Add Opus 4.5 with thinking and deprecate Opus 4.1 models `(PR #8108)` + - Deprecates Opus 4.1 models in favor of the Opus 4.5 +- feat(deep search): optimisitic navigation to the new conversation page `(PR #8092)` + - Optimistic UI update on new Deep Search conversation creation: immediately navigate to the conversation view showing the submitted question with a loading indicator, before the server responds. +- fix(deep search): allow to navigate to DS home page from the conversation with a top nav link `(PR #8091)` + - Currently, clicking the Deep Search link in the top nav from the conversation view does nothing. This PR resolves the issue, allowing it to navigate to the Deep Search home page as expected. +- modelconfig: Redact provider access tokens `(PR #8076)` + - Model configuration in site-config now redacts access tokens in the UI. +- fix(deep search): expanded file preview consistent horizonal padding `(PR #8058)` + - Make horizonal padding consistent with citations padding. +- feat(deep search): jump between sources when files are expanded `(PR #8057)` + - When a user clicks on a citation in the conversation response while the file preview is open, the preview now updates to show the new file/range. +- fix(deep search): apply markdown styles `(PR #8055)` + - Apply markdown styles to Deep Search responses with enabled citations. +- analytics: Remove unused in-app analytics frontend components and APIs `(PR #8048)` + - This completes the in-app analytics deprecation and removes the following APIs: + ```graphql + type Query { + instanceOwnershipStats: OwnershipStats! + } + type User { + usageStatistics: UserUsageStatistics! + } + type Site { + usageStatistics( + days: Int + weeks: Int + months: Int + ): SiteUsageStatistics! + analytics: Analytics! + } + ``` +- fix(deep search): do not create new annotations for the same citations `(PR #8027)` + - Do not create new annotations for the same citations. +- fix(deep search): focus citations pane on annotation clicks `(PR #8026)` + - When a non-citations pane is focused and a user clicks on the annotation -> focus the citations pane and scroll to the relevant citation. +- fix(deep search): preserve revisions for citations `(PR #8022)` + - Preserves revisions for Deep Search citations. +- fix(deep search): ensure hovered separator is always on top of the resizable panels `(PR #8021)` + - Ensure the hovered separator is always on top of resizable panels. +- Add Tab key selection in @ menu for Deep Search `(PR #8020)` + - Add tab support when selecting repos in Deep Search @ menu +- Add claude-opus-4-5-20251101 to anthropic models `(PR #8015)` + - Adds Claude Opus 4.5 to model selection +- ui(deepsearch): show thread title in page title `(PR #7995)` + - Show thread title in page title +- observability: add incidentio alerts support `(PR #7994)` + - Added support for `incidentio` in `observability.alerts` +- prometheus: upgrade Alertmanager, remove fork usage `(PR #7993)` + - Upgraded Alertmanager to v0.29.0 +- Minor improvements to slack message for workspaces refunds `(PR #7990)` + - Updated the "REFUND POLICY VIOLATION" Slack alert to include direct links to the workspace admin page and Stripe dashboard, rather than just the raw UUID. + - Modified the refund handler to skip the state transition if the workspace is already deleted, preventing unnecessary Sentry errors. +- oauth: add predefined Raycast client `(PR #7966)` + - Added a predefined OAuth2 client for the [Sourcegraph Raycast extension](https://www.raycast.com/bobheadxi/sourcegraph). +- feat(deep search): experimental "citations" pane `(PR #7936)` + - Introduce DeepSearchSourcesState context to manage per-conversation/question citation and source state for Deep Search. + - Add DOM-based citation extraction and synthetic FileSource generation, enabling bidirectional highlighting and scrolling between answer content and the sources pane. + - Redesign the sources panel into tabbed “Citations” vs other source types, with ordering by citation number, smarter deduplication, and inline code snippet previews. + - Add shared scroll helper and clickable line-number links in CodeExcerpt for smoother navigation from sources to code. + - Tighten the Deep Search system prompt to standardize markdown, code blocks, and Sourcegraph-style links. +- frontend: users list: set policy to network only `(PR #7908)` + - N/A +- Removed sentry alert for ws chargebacks `(PR #7903)` + - Remove sentry alert for chargebacks + - Workspace deletion for chargebacks now handles DestroyPending and ErrWorkspaceNotFound states, to not try to delete already-deleted workspaces. +- frontend: No longer require frontend restarts after changing some settings `(PR #7853)` + - Frontend service restarts are no longer required when changing certain settings. +- deep search: support markdown routes `(PR #7757)` + - Users can append ".md" to a deep search url in which case we return a markdown version of the thread. +- Automated workspaces refunds and chargebacks handling `(PR #7572)` + - Automated refund policy validation based on geography and time + - Automated workspace deletion for policy-compliant full refunds and chargebacks + - Added Slack alerts for out-of-policy refunds + - Added test coverage {/* RSS={"version":"v6.11.0", "releasedAt": "2025-12-08"} */} - # 6.10 Patch 1 ## v6.10.3349 -- [sourcegraph](https://github.com/sourcegraph/sourcegraph/releases/tag/v6.10.3349) +- [sourcegraph](https://github.com/sourcegraph/sourcegraph/releases/tag/v6.10.3349) -- [docker-compose](https://github.com/sourcegraph/deploy-sourcegraph-docker/releases/tag/v6.10.3349) +- [docker-compose](https://github.com/sourcegraph/deploy-sourcegraph-docker/releases/tag/v6.10.3349) -- [helm](https://github.com/sourcegraph/deploy-sourcegraph-helm/releases/tag/v6.10.3349) +- [helm](https://github.com/sourcegraph/deploy-sourcegraph-helm/releases/tag/v6.10.3349) -- [kustomize](https://github.com/sourcegraph/deploy-sourcegraph-k8s/releases/tag/v6.10.3349) +- [kustomize](https://github.com/sourcegraph/deploy-sourcegraph-k8s/releases/tag/v6.10.3349) ### Features #### Database -- include AWS_STS_REGIONAL_ENDPOINTS in DSN `(PR #7844)` +- include AWS_STS_REGIONAL_ENDPOINTS in DSN `(PR #7844)` #### Source -- UI for GH App groups cache permissions `(PR #7814)` +- UI for GH App groups cache permissions `(PR #7814)` ### Fix #### Database -- better error handling and logging for RDS connection updater `(PR #7900)` -- unset connection params postgres does not recognize `(PR #7886)` +- better error handling and logging for RDS connection updater `(PR #7900)` +- unset connection params postgres does not recognize `(PR #7886)` #### Release -- unbound var error in image push scripts `(PR #7831)` +- unbound var error in image push scripts `(PR #7831)` ### Reverts - There were no reverts for this release +There were no reverts for this release ### Uncategorized #### Others -- [Backport oauth: add predefined Raycast client] 6.10.x `(PR #7968)` -- [Backport 6.10.x] workspaces: require a 5-seat purchase `(PR #7892)` -- [Backport 6.10.x] mt/bitbucket: fix repo list query `(PR #7889)` -- [Backport 6.10.x] Add missing cody UI css variable `(PR #7868)` -- [Backport 6.10.x] dbconn refactors to fix PG_CONNECTION_UPDATER `(PR #7825)` +- [Backport oauth: add predefined Raycast client] 6.10.x `(PR #7968)` +- [Backport 6.10.x] workspaces: require a 5-seat purchase `(PR #7892)` +- [Backport 6.10.x] mt/bitbucket: fix repo list query `(PR #7889)` +- [Backport 6.10.x] Add missing cody UI css variable `(PR #7868)` +- [Backport 6.10.x] dbconn refactors to fix PG_CONNECTION_UPDATER `(PR #7825)` {/* RSS={"version":"v6.10.3349", "releasedAt": "2025-11-25"} */} - # 6.10 Patch 0 ## v6.10.0 @@ -391,8 +389,8 @@ There were no reverts for this release #### Security -- Update redis to 7.4.6-272 `(PR #7488)` - - This release patches multiple critical CVEs in Redis, including CVE-2025-49844, CVE-2025-46817, CVE-2025-46818, and CVE-2025-46819. See [Redis release notes](https://redis.io/docs/latest/operate/rs/release-notes/rs-7-4-2-releases/rs-7-4-6-272/) for details. +- Update redis to 7.4.6-272 `(PR #7488)` + - This release patches multiple critical CVEs in Redis, including CVE-2025-49844, CVE-2025-46817, CVE-2025-46818, and CVE-2025-46819. See [Redis release notes](https://redis.io/docs/latest/operate/rs/release-notes/rs-7-4-2-releases/rs-7-4-6-272/) for details. ### Reverts @@ -3154,7 +3152,7 @@ There were no reverts for this release - [kustomize](https://github.com/sourcegraph/deploy-sourcegraph-k8s/releases/tag/v6.2.2553) > Attention - This patch contains a known issue for self-hosted customers upgrading from previous versions of Sourcegraph whom are using the Sourcegraph provided PostgreSQL container images. -> Please see our [PostgreSQL Collation Version Mismatch Resolution](/admin/postgresql_collation_version_mismatch_resolution) notes for more details. +> Please see our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgresql_collation_version_mismatch_resolution) notes for more details. ### Features @@ -4928,7 +4926,7 @@ There were no reverts for this release > If you are required to continue on 6.0 release series, please upgrade to 6.0 Patch 2. > Attention - Postgres 12 is no longer supported! If upgrading from Sourcegraph version 5.9 or earlier, this release will update our included database container images from Postgres 12 to Postgres 16. -> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/admin/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. +> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. > > Also be sure to check your deployment type's [upgrade notes](http://sourcegraph.com/docs/admin/updates#instance-specific-procedures)! @@ -5621,7 +5619,7 @@ The following PRs were merged onto the previous release branch but could not be # 5.11 Patch 5 > Attention - If upgrading from Sourcegraph version 5.9 or earlier, this release will update our included database container images from Postgres 12 to Postgres 16. -> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/admin/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. +> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. > > Also be sure to check your deployment type's [upgrade notes](http://sourcegraph.com/docs/admin/updates#instance-specific-procedures)! @@ -5654,7 +5652,7 @@ There were no reverts for this release # 5.11 Patch 4 > Attention - If upgrading from Sourcegraph version 5.9 or earlier, this release will update our included database container images from Postgres 12 to Postgres 16. -> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/admin/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. +> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. > > Also be sure to check your deployment type's [upgrade notes](http://sourcegraph.com/docs/admin/updates#instance-specific-procedures)! @@ -5696,7 +5694,7 @@ There were no reverts for this release # 5.11 Patch 3 > Attention - If upgrading from Sourcegraph version 5.9 or earlier, this release will update our included database container images from Postgres 12 to Postgres 16. -> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/admin/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. +> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. > > Also be sure to check your deployment type's [upgrade notes](http://sourcegraph.com/docs/admin/updates#instance-specific-procedures)! @@ -5747,7 +5745,7 @@ There were no reverts for this release # 5.11 Patch 2 > Attention - If upgrading from Sourcegraph version 5.9 or earlier, this release will update our included database container images from Postgres 12 to Postgres 16. -> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/admin/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. +> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. > > Also be sure to check your deployment type's [upgrade notes](http://sourcegraph.com/docs/admin/updates#instance-specific-procedures)! @@ -5776,7 +5774,7 @@ There were no reverts for this release # 5.11 Patch 1 > Attention - If upgrading from Sourcegraph version 5.9 or earlier, this release will update our included database container images from Postgres 12 to Postgres 16. -> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/admin/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. +> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. > > Also be sure to check your deployment type's [upgrade notes](http://sourcegraph.com/docs/admin/updates#instance-specific-procedures)! @@ -5813,7 +5811,7 @@ There were no reverts for this release # 5.11 Patch 0 > Attention - If upgrading from Sourcegraph version 5.9 or earlier, this release will update our included database container images from Postgres 12 to Postgres 16. -> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/admin/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. +> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. > > Also be sure to check your deployment type's [upgrade notes](http://sourcegraph.com/docs/admin/updates#instance-specific-procedures)! @@ -6367,7 +6365,7 @@ The following PRs were merged onto the previous release branch but could not be # 5.10 Patch 3 -> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to have a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/admin/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! +> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to have a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! > > Also be sure to check your deployment type's [upgrade notes](http://sourcegraph.com/docs/admin/updates#instance-specific-procedures)! @@ -6404,7 +6402,7 @@ There were no reverts for this release # 5.10 Patch 2 -> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to have a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/admin/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! +> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to have a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! > > Also be sure to check your deployment type's [upgrade notes](http://sourcegraph.com/docs/admin/updates#instance-specific-procedures)! @@ -6468,7 +6466,7 @@ There were no reverts for this release # 5.10 Patch 1 -> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to take a database backup before upgrading! See our [Postgres 12 end of life](https://sourcegraph.com/docs/admin/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! +> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to take a database backup before upgrading! See our [Postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! > > Warning: `automatic` upgrades will require setting the environment variable `SRC_AUTOUPGRADE_IGNORE_DRIFT=true` on the `sourcegraph-frontend` deployment/container. > @@ -6512,7 +6510,7 @@ There were no reverts for this release > Warning: Admins are advised to upgrade directly to v5.10.1164 circumventing this release. > -> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to have a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/admin/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! +> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to have a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! > > Warning: `automatic` and migrator `upgrade` command will not work for this release, please upgrade directly to `v5.10.1164`, or to a 5.9 version and conduct a standard upgrade using migrator's default `up` command! > @@ -11570,7 +11568,7 @@ The following PRs were merged onto the previous release branch but could not be - Added history of changes to the site configuration page. Site admins can now see information about changes made to the site configuration, by whom and when. [#49842](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/49842) - For Perforce depots, users will now see the changelist ID (CL) instead of Git commit SHAs when visiting a depot or the view changelists page [#51195](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/51195) - Visiting a specific CL will now use the CL ID in the URL instead of the commit SHA. Other areas affected by this change are browsing files at a specific CL, viewing a specific file changed as part of a specific CL. To enable this behaviour, site admins should set `"perforceChangelistMapping": "enabled"` under experimentalFeatures in the site configuration. Note that currently we process only one perforce depot at a time to map the commit SHAs to their CL IDs in the backend. In a subsequent release we will add support to process multiple depots in parallel. Other areas where currently commit SHAs are used will be updated in future releases. [#53253](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/53253) [#53608](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/53608) [#54051](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/54051) -- Added autoupgrading to automatically perform multi-version upgrades, without manual `migrator` invocations, through the `frontend` deployment. Please see the [documentation](/admin/updates/automatic) for details. [#52242](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/52242) [#53196](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/53196) +- Added autoupgrading to automatically perform multi-version upgrades, without manual `migrator` invocations, through the `frontend` deployment. Please see the [documentation](/self-hosted/updates/automatic) for details. [#52242](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/52242) [#53196](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/53196) ### Changed @@ -11742,7 +11740,7 @@ The following PRs were merged onto the previous release branch but could not be - Native support for ingesting and searching GitHub topics with `repo:has.topic()` [#48875](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/48875) - [Role- Access Control](/admin/access_control) is now available as an enterprise feature (in Beta). It is currently only supported for Batch Changes functionality. [#43276](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/43276) - Site admins can now [restrict creation of batch changes to certain u[sers](/admin/access_control/batch_changes) by tailoring their roles and the permissions granted to those )roles. [#34491](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/34491) -- Site admins can now [configure outgoing webh[ooks](/admin/config/webhooks/outgoing) for Batch Changes to inform external tools of events related to Sourceg)raph batch changes and their changesets. [#38278](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/38278) +- Site admins can now [configure outgoing webh[ooks](/admin/webhooks/outgoing) for Batch Changes to inform external tools of events related to Sourceg)raph batch changes and their changesets. [#38278](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/38278) - [Sourcegraph[ Own](/own) is now available as an experimental enterprise feature. Enable the `search-ownership` fe)ature flag to use it. - Gitserver supports a new `COURSIER_CACHE_DIR` env var to configure the cache location for coursier JVM package repos. - Pings now emit a histogram of repository sizes cloned by Sourcegraph [48211](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/48211). @@ -11806,7 +11804,7 @@ The following PRs were merged onto the previous release branch but could not be - Archived and deleted changesets are no longer counted towards the completion percentage shown in the Batch Changes UI. [#46831](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/46831) - Code Insights has a new UI for the "Add or remove insights" view, which now allows you to search code insights by series label in addition to insight title. [#46538](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/46538) -- When SMTP is configured, users created by site admins via the "Create user" page will no longer have their email verified by default - Users must verify their emails by using the "Set password" link they get sent, or have their emails verified by a site admin via the "Emails" tab in user settings or the `setUserEmailVerified` mutation. The `createUser` mutation retains the old behaviour of automatically marking emails as verified. To learn more, refer to the [SMTP and email deli[very](/admin/config/email) documentation. [#46187](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/46187)) +- When SMTP is configured, users created by site admins via the "Create user" page will no longer have their email verified by default - Users must verify their emails by using the "Set password" link they get sent, or have their emails verified by a site admin via the "Emails" tab in user settings or the `setUserEmailVerified` mutation. The `createUser` mutation retains the old behaviour of automatically marking emails as verified. To learn more, refer to the [SMTP and email deli[very](/self-hosted/email) documentation. [#46187](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/46187)) - Connection checks for code host connections have been changed to talk to code host APIs directly via HTTP instead of doing DNS lookup and TCP dial. That makes them more resistant in environments where proxies are used. [#46918](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/46918) - Expiration of licenses is now handled differently. When a license is expired promotion to site-admin is disabled, license-specific features are disabled (exceptions being SSO & permission syncing), grace period has been replaced with a 7-day-before-expiration warning. [#47251](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/47251) - Searcher will now timeout searches in 2 hours instead of 10 minutes. This timeout was raised for batch use cases (such as code insights) searching old revisions in very large repositories. This limit can be tuned with the environment variable `PROCESSING_TIMEOUT`. [#47469](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/47469) @@ -11930,9 +11928,9 @@ The following PRs were merged onto the previous release branch but could not be - Search contexts can now be starred (favorited) in the search context management page. Starred search contexts will appear before other contexts in the context dropdown menu next to the search box. [#45230](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/45230) - Search contexts now let you set a context as your default. The default will be selected every time you open Sourcegraph and will appear near the top in the context dropdown menu next to the search box. [#45387](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/45387) - [search.largeF[iles](/admin/config/site_config#search-largeFiles) accepts an optional prefix `!` to negate a pattern. The o)rder of the patterns within search.largeFiles is honored such that the last pattern matching overrides preceding patterns. For patterns that begin with a literal `!` prefix with a backslash, for example, `\!fileNameStartsWithExcl!.txt`. Previously indexed files that become excluded due to this change will remain in the index until the next reindex [#45318](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/45318) -- [Webh[ooks](/admin/config/webhooks/incoming) have been overhauled completely and can now be found under **Site admin >) Repositories > Incoming webhooks**. Webhooks that were added via code host configuration are [deprec[ated](/admin/config/webhooks/incoming#deprecation-notice) and will be removed in 5.1.0. +- [Webh[ooks](/admin/webhooks/incoming) have been overhauled completely and can now be found under **Site admin >) Repositories > Incoming webhooks**. Webhooks that were added via code host configuration are [deprec[ated](/admin/webhooks/incoming#deprecation-notice) and will be removed in 5.1.0. - Added support fo)r receiving webhook `push` events from GitHub which will trigger Sourcegraph to fetch the latest commit rather than relying on polling. -- Added support for private container registries in Sourcegraph executors. [Using private registries](/admin/executors/deploy_executors#using-private-registries) +- Added support for private container registries in Sourcegraph executors. [Using private registries](/self-hosted/executors/deploy_executors#using-private-registries) ### Changed @@ -11962,7 +11960,7 @@ The following PRs were merged onto the previous release branch but could not be # v4.2.1 -- `minio` has been replaced with `blobstore`. Please see the update notes [here](/admin/how-to/blobstore_update_notes) +- `minio` has been replaced with `blobstore`. Please see the update notes [here](/self-hosted/how-to/blobstore_update_notes) # v4.2.0 @@ -11972,8 +11970,8 @@ The following PRs were merged onto the previous release branch but could not be - Added `codeIntelAutoIndexing.indexerMap` to site-config that allows users to update the indexers used when inferring precise code intelligence auto-indexing jobs (without having to overwrite the entire inference scripts). For example, `"codeIntelAutoIndexing.indexerMap": {"go": "my.registry/sourcegraph/lsif-go"}` will cause Go projects to use the specified container (in a alternative Docker registry). [#43199](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/43199) - Code Insights data points that do not contain any results will display zero instead of being omitted from the visualization. Only applies to insight data created after 4.2. [#43166](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/43166) - Sourcegraph ships with node-exporter, a Prometheus tool that provides hardware / OS metrics that helps Sourcegraph scale your deployment. See your deployment update for more information: - - [Kubernetes](/admin/updates/kubernetes) - - [Docker Compose](/admin/updates/docker_compose) + - [Kubernetes](/self-hosted/updates/kubernetes) + - [Docker Compose](/self-hosted/updates/docker_compose) - A structural search diagnostic to warn users when a language filter is not set. [#43835](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/43835) - GitHub/GitLab OAuth success/fail attempts are now a part of the audit log. [#43886](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/43886) - When rendering a file which is backed by Git LFS, we show a page informing the file is LFS and linking to the file on the codehost. Previously we rendered the LFS pointer. [#43686](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/43686) @@ -12076,19 +12074,19 @@ The following PRs were merged onto the previous release branch but could not be ### Added - A new look for Sourcegraph, previously in beta as "Simple UI", is now permanently enabled. [#41021](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/41021) -- A new [multi-version upgrade](/admin/updates#multi-version-upgrades) process now allows Sourcegraph instances to upgrade more than a single minor version. Instances at version 3.20 or later can now jump directly to 4.0. [#40628](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/40628) +- A new [multi-version upgrade](/self-hosted/updates#multi-version-upgrades) process now allows Sourcegraph instances to upgrade more than a single minor version. Instances at version 3.20 or later can now jump directly to 4.0. [#40628](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/40628) - Matching ranges in file paths are now highlighted for path results and content results. Matching paths in repository names are now highlighted for repository results. [#41296](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/41296) [#41385](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/41385) [#41470](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/41470) - Aggregations by repository, file, author, and capture group are now provided for search results. [#39643](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/39643) - Blob views and search results are now lazily syntax highlighted for better performance. [#39563](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/39563) [#40263](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/40263) - File links in both the search results and the blob sidebar and now prefetched on hover or focus. [#40354](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/40354) [#41420](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/41420) - Negation support for the search predicates `-repo:has.path()` and `-repo:has.content()`. [#40283](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/40283) -- Experimental clientside OpenTelemetry can now be enabled with `"observability.client": { "openTelemetry": "/-/debug/otlp" }`, which sends OpenTelemetry to the new [bundled OpenTelemetry Collector](/admin/observability/opentelemetry). [#37907](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/37907) +- Experimental clientside OpenTelemetry can now be enabled with `"observability.client": { "openTelemetry": "/-/debug/otlp" }`, which sends OpenTelemetry to the new [bundled OpenTelemetry Collector](/self-hosted/observability/opentelemetry). [#37907](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/37907) - File diff stats are now characterized by 2 figures: lines added and lines removed. Previously, a 3rd figure for lines modified was also used. This is represented by the fields on the `DiffStat` type on the GraphQL API. [#40454](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/40454) ### Changed -- [Sourcegraph with Kubernetes (without Helm)](/admin/deploy/kubernetes): The `jaeger-agent` sidecar has been replaced by an [OpenTelemetry Collector](/admin/observability/opentelemetry) DaemonSet + Deployment configuration. The bundled Jaeger instance is now disabled by default, instead of enabled. [#40456](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/40456) -- [Sourcegraph with Docker Compose](/admin/deploy/docker-compose): The `jaeger` service has been replaced by an [OpenTelemetry Collector](/admin/observability/opentelemetry) service. The bundled Jaeger instance is now disabled by default, instead of enabled. [#40455](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/40455) +- [Sourcegraph with Kubernetes (without Helm)](/self-hosted/deploy/kubernetes): The `jaeger-agent` sidecar has been replaced by an [OpenTelemetry Collector](/self-hosted/observability/opentelemetry) DaemonSet + Deployment configuration. The bundled Jaeger instance is now disabled by default, instead of enabled. [#40456](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/40456) +- [Sourcegraph with Docker Compose](/self-hosted/deploy/docker-compose): The `jaeger` service has been replaced by an [OpenTelemetry Collector](/self-hosted/observability/opentelemetry) service. The bundled Jaeger instance is now disabled by default, instead of enabled. [#40455](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/40455) - `"observability.tracing": { "type": "opentelemetry" }` is now the default tracer type. To revert to existing behaviour, set `"type": "jaeger"` instead. The legacy values `"type": "opentracing"` and `"type": "datadog"` have been removed. [#41242](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/41242) - `"observability.tracing": { "urlTemplate": "" }` is now the default, and if `"urlTemplate"` is left empty, no trace URLs are generated. To revert to existing behaviour, set `"urlTemplate": "{{ .ExternalURL }}/-/debug/jaeger/trace/{{ .TraceID }}"` instead. [#41242](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/41242) - Code host connection tokens are no longer supported as a fallback method for syncing changesets in Batch Changes. [#25394](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/25394) diff --git a/src/data/navigation.ts b/src/data/navigation.ts index bf6ff2cbb..dcf5f62bd 100644 --- a/src/data/navigation.ts +++ b/src/data/navigation.ts @@ -444,7 +444,10 @@ export const navigation: NavigationItem[] = [ sections: [ {title: 'Configuration', href: '/admin/config'}, {title: 'Licensing', href: '/admin/licensing'}, - {title: 'Enterprise Portal', href: '/enterprise-portal'}, + { + title: 'Enterprise Portal', + href: '/admin/enterprise-portal' + }, {title: 'Codehosts', href: '/admin/code_hosts'}, {title: 'User Authentication', href: '/admin/auth'}, {title: 'Access Control', href: '/admin/access_control'}, @@ -459,7 +462,8 @@ export const navigation: NavigationItem[] = [ { title: 'Enterprise Getting Started', href: '/admin/enterprise_getting_started_guide' - } + }, + {title: 'Architecture', href: '/admin/architecture'} ] }, { @@ -470,10 +474,9 @@ export const navigation: NavigationItem[] = [ title: 'Enterprise Self-Hosted', href: '/self-hosted', sections: [ - {title: 'Deploy', href: '/admin/deploy'}, - {title: 'Architecture', href: '/admin/architecture'}, - {title: 'Upgrade', href: '/admin/updates'}, - {title: 'Observability', href: '/admin/observability'} + {title: 'Deploy', href: '/self-hosted/deploy'}, + {title: 'Upgrade', href: '/self-hosted/updates'}, + {title: 'Observability', href: '/self-hosted/observability'} ] }, { diff --git a/src/data/redirects.ts b/src/data/redirects.ts index 4b81054df..eddd33369 100644 --- a/src/data/redirects.ts +++ b/src/data/redirects.ts @@ -5791,6 +5791,598 @@ const redirectsData = [ source: '/admin/self-hosted', destination: '/self-hosted', permanent: true + }, + { + source: '/enterprise-portal', + destination: '/admin/enterprise-portal', + permanent: true + }, + { + source: '/admin/observability/outbound-request-log', + destination: '/admin/outbound-request-log', + permanent: true + }, + { + source: '/admin/config/webhooks/incoming', + destination: '/admin/webhooks/incoming', + permanent: true + }, + { + source: '/admin/config/webhooks', + destination: '/admin/webhooks', + permanent: true + }, + { + source: '/admin/config/webhooks/outgoing', + destination: '/admin/webhooks/outgoing', + permanent: true + }, + { + source: '/admin/config/advanced_config_file', + destination: '/self-hosted/advanced_config_file', + permanent: true + }, + { + source: '/admin/deploy/docker-compose/aws', + destination: '/self-hosted/deploy/docker-compose/aws', + permanent: true + }, + { + source: '/admin/deploy/docker-compose/azure', + destination: '/self-hosted/deploy/docker-compose/azure', + permanent: true + }, + { + source: '/admin/deploy/docker-compose/configuration', + destination: '/self-hosted/deploy/docker-compose/configuration', + permanent: true + }, + { + source: '/admin/deploy/docker-compose/digitalocean', + destination: '/self-hosted/deploy/docker-compose/digitalocean', + permanent: true + }, + { + source: '/admin/deploy/docker-compose/google_cloud', + destination: '/self-hosted/deploy/docker-compose/google_cloud', + permanent: true + }, + { + source: '/admin/deploy/docker-compose', + destination: '/self-hosted/deploy/docker-compose', + permanent: true + }, + { + source: '/admin/deploy/docker-compose/migrate', + destination: '/self-hosted/deploy/docker-compose/migrate', + permanent: true + }, + { + source: '/admin/deploy/docker-compose/operations', + destination: '/self-hosted/deploy/docker-compose/operations', + permanent: true + }, + { + source: '/admin/deploy/docker-compose/upgrade', + destination: '/self-hosted/deploy/docker-compose/upgrade', + permanent: true + }, + { + source: '/admin/deploy/docker-single-container/aws', + destination: '/self-hosted/deploy/docker-single-container/aws', + permanent: true + }, + { + source: '/admin/deploy/docker-single-container/digitalocean', + destination: '/self-hosted/deploy/docker-single-container/digitalocean', + permanent: true + }, + { + source: '/admin/deploy/docker-single-container/google_cloud', + destination: '/self-hosted/deploy/docker-single-container/google_cloud', + permanent: true + }, + { + source: '/admin/deploy/docker-single-container', + destination: '/self-hosted/deploy/docker-single-container', + permanent: true + }, + { + source: '/admin/deploy', + destination: '/self-hosted/deploy', + permanent: true + }, + { + source: '/admin/deploy/instance-size', + destination: '/self-hosted/deploy/instance-size', + permanent: true + }, + { + source: '/admin/deploy/kubernetes/azure', + destination: '/self-hosted/deploy/kubernetes/azure', + permanent: true + }, + { + source: '/admin/deploy/kubernetes/configure', + destination: '/self-hosted/deploy/kubernetes/configure', + permanent: true + }, + { + source: '/admin/deploy/kubernetes/eks', + destination: '/self-hosted/deploy/kubernetes/eks', + permanent: true + }, + { + source: '/admin/deploy/kubernetes', + destination: '/self-hosted/deploy/kubernetes', + permanent: true + }, + { + source: '/admin/deploy/kubernetes/kustomize', + destination: '/self-hosted/deploy/kubernetes/kustomize', + permanent: true + }, + { + source: '/admin/deploy/kubernetes/kustomize/eks', + destination: '/self-hosted/deploy/kubernetes/kustomize/eks', + permanent: true + }, + { + source: '/admin/deploy/kubernetes/kustomize/gke', + destination: '/self-hosted/deploy/kubernetes/kustomize/gke', + permanent: true + }, + { + source: '/admin/deploy/kubernetes/kustomize', + destination: '/self-hosted/deploy/kubernetes/kustomize', + permanent: true + }, + { + source: '/admin/deploy/kubernetes/kustomize/migrate', + destination: '/self-hosted/deploy/kubernetes/kustomize/migrate', + permanent: true + }, + { + source: '/admin/deploy/kubernetes/operations', + destination: '/self-hosted/deploy/kubernetes/operations', + permanent: true + }, + { + source: '/admin/deploy/kubernetes/scale', + destination: '/self-hosted/deploy/kubernetes/scale', + permanent: true + }, + { + source: '/admin/deploy/kubernetes/troubleshoot', + destination: '/self-hosted/deploy/kubernetes/troubleshoot', + permanent: true + }, + { + source: '/admin/deploy/kubernetes/upgrade', + destination: '/self-hosted/deploy/kubernetes/upgrade', + permanent: true + }, + { + source: '/admin/deploy/machine-images/aws-ami', + destination: '/self-hosted/deploy/machine-images/aws-ami', + permanent: true + }, + { + source: '/admin/deploy/machine-images/aws-oneclick', + destination: '/self-hosted/deploy/machine-images/aws-oneclick', + permanent: true + }, + { + source: '/admin/deploy/machine-images/gce', + destination: '/self-hosted/deploy/machine-images/gce', + permanent: true + }, + { + source: '/admin/deploy/machine-images', + destination: '/self-hosted/deploy/machine-images', + permanent: true + }, + { + source: '/admin/deploy/migrate-backup', + destination: '/self-hosted/deploy/migrate-backup', + permanent: true + }, + { + source: '/admin/deploy/repositories', + destination: '/self-hosted/deploy/repositories', + permanent: true + }, + { + source: '/admin/deploy/resource_estimator', + destination: '/self-hosted/deploy/resource_estimator', + permanent: true + }, + { + source: '/admin/deploy/scale', + destination: '/self-hosted/deploy/scale', + permanent: true + }, + { + source: '/admin/deploy/single-node', + destination: '/self-hosted/deploy/single-node', + permanent: true + }, + { + source: '/admin/deploy/single-node/script', + destination: '/self-hosted/deploy/single-node/script', + permanent: true + }, + { + source: '/admin/deploy/without_service_discovery', + destination: '/self-hosted/deploy/without_service_discovery', + permanent: true + }, + { + source: '/admin/deployment_best_practices', + destination: '/self-hosted/deployment_best_practices', + permanent: true + }, + { + source: '/admin/config/email', + destination: '/self-hosted/email', + permanent: true + }, + { + source: '/admin/config/encryption', + destination: '/self-hosted/encryption', + permanent: true + }, + { + source: '/admin/executors/deploy_executors', + destination: '/self-hosted/executors/deploy_executors', + permanent: true + }, + { + source: '/admin/executors/deploy_executors_binary', + destination: '/self-hosted/executors/deploy_executors_binary', + permanent: true + }, + { + source: '/admin/executors/deploy_executors_binary_offline', + destination: '/self-hosted/executors/deploy_executors_binary_offline', + permanent: true + }, + { + source: '/admin/executors/deploy_executors_dind', + destination: '/self-hosted/executors/deploy_executors_dind', + permanent: true + }, + { + source: '/admin/executors/deploy_executors_docker', + destination: '/self-hosted/executors/deploy_executors_docker', + permanent: true + }, + { + source: '/admin/executors/deploy_executors_kubernetes', + destination: '/self-hosted/executors/deploy_executors_kubernetes', + permanent: true + }, + { + source: '/admin/executors/deploy_executors_terraform', + destination: '/self-hosted/executors/deploy_executors_terraform', + permanent: true + }, + { + source: '/admin/executors/executors_config', + destination: '/self-hosted/executors/executors_config', + permanent: true + }, + { + source: '/admin/executors/executors_troubleshooting', + destination: '/self-hosted/executors/executors_troubleshooting', + permanent: true + }, + { + source: '/admin/executors/firecracker', + destination: '/self-hosted/executors/firecracker', + permanent: true + }, + { + source: '/admin/external_services', + destination: '/self-hosted/external_services', + permanent: true + }, + { + source: '/admin/external_services/object_storage', + destination: '/self-hosted/external_services/object_storage', + permanent: true + }, + { + source: '/admin/external_services/postgres', + destination: '/self-hosted/external_services/postgres', + permanent: true + }, + { + source: '/admin/external_services/redis', + destination: '/self-hosted/external_services/redis', + permanent: true + }, + { + source: '/admin/how-to/blobstore_debugging', + destination: '/self-hosted/how-to/blobstore_debugging', + permanent: true + }, + { + source: '/admin/how-to/blobstore_update_notes', + destination: '/self-hosted/how-to/blobstore_update_notes', + permanent: true + }, + { + source: '/admin/how-to/clear_codeintel_data', + destination: '/self-hosted/how-to/clear_codeintel_data', + permanent: true + }, + { + source: '/admin/how-to/dirty_database', + destination: '/self-hosted/how-to/dirty_database', + permanent: true + }, + { + source: '/admin/how-to/dirty_database_pre_3_37', + destination: '/self-hosted/how-to/dirty_database_pre_3_37', + permanent: true + }, + { + source: '/admin/how-to/monitoring-guide', + destination: '/self-hosted/how-to/monitoring-guide', + permanent: true + }, + { + source: '/admin/how-to/postgres14-index-corruption', + destination: '/self-hosted/how-to/postgres14-index-corruption', + permanent: true + }, + { + source: '/admin/how-to/postgres_12_to_16_drift', + destination: '/self-hosted/how-to/postgres_12_to_16_drift', + permanent: true + }, + { + source: '/admin/how-to/precise-code-intel-worker-crashloopbackoff', + destination: + '/self-hosted/how-to/precise-code-intel-worker-crashloopbackoff', + permanent: true + }, + { + source: '/admin/how-to/privileged_migrations', + destination: '/self-hosted/how-to/privileged_migrations', + permanent: true + }, + { + source: '/admin/how-to/rebuild-corrupt-postgres-indexes', + destination: '/self-hosted/how-to/rebuild-corrupt-postgres-indexes', + permanent: true + }, + { + source: '/admin/how-to/redis_configmap', + destination: '/self-hosted/how-to/redis_configmap', + permanent: true + }, + { + source: '/admin/how-to/rollback_database', + destination: '/self-hosted/how-to/rollback_database', + permanent: true + }, + { + source: '/admin/how-to/run-psql', + destination: '/self-hosted/how-to/run-psql', + permanent: true + }, + { + source: '/admin/how-to/setup-https', + destination: '/self-hosted/how-to/setup-https', + permanent: true + }, + { + source: '/admin/how-to/troubleshoot-pod-eviction', + destination: '/self-hosted/how-to/troubleshoot-pod-eviction', + permanent: true + }, + { + source: '/admin/how-to/unfinished_migration', + destination: '/self-hosted/how-to/unfinished_migration', + permanent: true + }, + { + source: '/admin/how-to/upgrade-postgres-12-16-builtin-dbs', + destination: '/self-hosted/how-to/upgrade-postgres-12-16-builtin-dbs', + permanent: true + }, + { + source: '/admin/http_https_configuration', + destination: '/self-hosted/http_https_configuration', + permanent: true + }, + { + source: '/admin/config/network-filtering', + destination: '/self-hosted/network-filtering', + permanent: true + }, + { + source: '/admin/observability/.gitattributes', + destination: '/self-hosted/observability/.gitattributes', + permanent: true + }, + { + source: '/admin/observability/alerting', + destination: '/self-hosted/observability/alerting', + permanent: true + }, + { + source: '/admin/observability/alerting_custom_consumption', + destination: '/self-hosted/observability/alerting_custom_consumption', + permanent: true + }, + { + source: '/admin/observability/alerts', + destination: '/self-hosted/observability/alerts', + permanent: true + }, + { + source: '/admin/observability/dashboards', + destination: '/self-hosted/observability/dashboards', + permanent: true + }, + { + source: '/admin/observability/health_checks', + destination: '/self-hosted/observability/health_checks', + permanent: true + }, + { + source: '/admin/observability', + destination: '/self-hosted/observability', + permanent: true + }, + { + source: '/admin/observability/logs', + destination: '/self-hosted/observability/logs', + permanent: true + }, + { + source: '/admin/observability/metrics', + destination: '/self-hosted/observability/metrics', + permanent: true + }, + { + source: '/admin/observability/opentelemetry', + destination: '/self-hosted/observability/opentelemetry', + permanent: true + }, + { + source: '/admin/observability/tracing', + destination: '/self-hosted/observability/tracing', + permanent: true + }, + { + source: '/admin/observability/troubleshooting', + destination: '/self-hosted/observability/troubleshooting', + permanent: true + }, + { + source: '/admin/config/postgres-conf', + destination: '/self-hosted/postgres-conf', + permanent: true + }, + { + source: '/admin/postgres', + destination: '/self-hosted/postgres', + permanent: true + }, + { + source: '/admin/postgres12_end_of_life_notice', + destination: '/self-hosted/postgres12_end_of_life_notice', + permanent: true + }, + { + source: '/admin/postgresql_collation_version_mismatch_resolution', + destination: + '/self-hosted/postgresql_collation_version_mismatch_resolution', + permanent: true + }, + { + source: '/admin/pprof', + destination: '/self-hosted/pprof', + permanent: true + }, + { + source: '/admin/config/private-network', + destination: '/self-hosted/private-network', + permanent: true + }, + { + source: '/admin/config/restore', + destination: '/self-hosted/restore', + permanent: true + }, + { + source: '/admin/sourcegraph-nginx-mermaid', + destination: '/self-hosted/sourcegraph-nginx-mermaid', + permanent: true + }, + { + source: '/admin/ssl_https_self_signed_cert_nginx', + destination: '/self-hosted/ssl_https_self_signed_cert_nginx', + permanent: true + }, + { + source: '/admin/updates/automatic', + destination: '/self-hosted/updates/automatic', + permanent: true + }, + { + source: '/admin/updates/docker_compose', + destination: '/self-hosted/updates/docker_compose', + permanent: true + }, + { + source: '/admin/updates', + destination: '/self-hosted/updates', + permanent: true + }, + { + source: '/admin/updates/kubernetes', + destination: '/self-hosted/updates/kubernetes', + permanent: true + }, + { + source: '/admin/updates/migrator/downgrading', + destination: '/self-hosted/updates/migrator/downgrading', + permanent: true + }, + { + source: '/admin/updates/migrator', + destination: '/self-hosted/updates/migrator', + permanent: true + }, + { + source: '/admin/updates/migrator/migrator-operations', + destination: '/self-hosted/updates/migrator/migrator-operations', + permanent: true + }, + { + source: '/admin/updates/migrator/schema-drift', + destination: '/self-hosted/updates/migrator/schema-drift', + permanent: true + }, + { + source: '/admin/updates/migrator/troubleshooting-upgrades', + destination: '/self-hosted/updates/migrator/troubleshooting-upgrades', + permanent: true + }, + { + source: '/admin/updates/migrator/upgrading-early-versions', + destination: '/self-hosted/updates/migrator/upgrading-early-versions', + permanent: true + }, + { + source: '/admin/updates/pure_docker', + destination: '/self-hosted/updates/pure_docker', + permanent: true + }, + { + source: '/admin/updates/server', + destination: '/self-hosted/updates/server', + permanent: true + }, + { + source: '/admin/url', + destination: '/self-hosted/url', + permanent: true + }, + { + source: '/admin/validation', + destination: '/self-hosted/validation', + permanent: true + }, + { + source: '/admin/workers', + destination: '/self-hosted/workers', + permanent: true } ]; From da1e7ec87b2728a42b1b5f5cf854620f68c0aff4 Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 21:29:30 +0100 Subject: [PATCH 08/21] Extend landing page and navigation for self-hosted --- docs/self-hosted/index.mdx | 66 ++++++++++++++++++++++++++++++++++++-- src/data/navigation.ts | 40 +++++++++++++++++++++-- 2 files changed, 101 insertions(+), 5 deletions(-) diff --git a/docs/self-hosted/index.mdx b/docs/self-hosted/index.mdx index 653def6da..a1219c4ed 100644 --- a/docs/self-hosted/index.mdx +++ b/docs/self-hosted/index.mdx @@ -11,14 +11,26 @@ Sourcegraph administration is primarily managed by site administrators, who are Get started running Sourcegraph on-prem. - [Deployment overview](/self-hosted/deploy/) -- [Using external services (PostgreSQL, Redis, S3/GCS)](/self-hosted/external_services) -- [PostgreSQL Config](/self-hosted/postgres-conf) +- [Single-node deployment](/self-hosted/deploy/single-node/) +- [Docker Compose](/self-hosted/deploy/docker-compose/) +- [Kubernetes](/self-hosted/deploy/kubernetes/) +- [Machine images](/self-hosted/deploy/machine-images/) +- [Docker single container](/self-hosted/deploy/docker-single-container/) +- [Instance sizing](/self-hosted/deploy/instance-size) +- [Resource estimator](/self-hosted/deploy/resource_estimator) +- [Scaling](/self-hosted/deploy/scale) - [Best practices](/self-hosted/deployment_best_practices) - [Validate a Sourcegraph deployment](/self-hosted/validation) (experimental) ## [Upgrade Sourcegraph](/self-hosted/updates) - [Upgrade Overview](/self-hosted/updates/) +- [Automatic upgrades](/self-hosted/updates/automatic) +- [Docker Compose upgrades](/self-hosted/updates/docker_compose) +- [Kubernetes upgrades](/self-hosted/updates/kubernetes) +- [Pure Docker upgrades](/self-hosted/updates/pure_docker) +- [Server upgrades](/self-hosted/updates/server) +- [Migrator](/self-hosted/updates/migrator/) - [Migrate to Sourcegraph](/admin/migration/) - [Upgrading PostgreSQL](/self-hosted/postgres#upgrading-postgresql) @@ -43,6 +55,27 @@ Get started running Sourcegraph on-prem. - [Scaling workers](/self-hosted/workers) - [PostgreSQL configuration](/self-hosted/postgres-conf) +## [Using external services](/self-hosted/external_services/) + +- [External services overview](/self-hosted/external_services/) +- [PostgreSQL](/self-hosted/external_services/postgres) +- [Redis](/self-hosted/external_services/redis) +- [Object storage (S3/GCS)](/self-hosted/external_services/object_storage) + +## [Executors](/self-hosted/executors/) + +- [Executors overview](/self-hosted/executors/) +- [Deploy executors](/self-hosted/executors/deploy_executors) +- [Kubernetes deployment](/self-hosted/executors/deploy_executors_kubernetes) +- [Terraform deployment](/self-hosted/executors/deploy_executors_terraform) +- [Docker deployment](/self-hosted/executors/deploy_executors_docker) +- [Binary deployment](/self-hosted/executors/deploy_executors_binary) +- [Binary deployment (offline)](/self-hosted/executors/deploy_executors_binary_offline) +- [Docker-in-Docker](/self-hosted/executors/deploy_executors_dind) +- [Firecracker](/self-hosted/executors/firecracker) +- [Configuration](/self-hosted/executors/executors_config) +- [Troubleshooting](/self-hosted/executors/executors_troubleshooting) + ## Advanced tasks - [Loading configuration via the file system](/self-hosted/advanced_config_file) @@ -50,15 +83,44 @@ Get started running Sourcegraph on-prem. - [Enabling database encryption for sensitive data](/self-hosted/encryption) - [Configuring Sourcegraph in private networks](/self-hosted/private-network) - [Restricting outgoing connections](/self-hosted/network-filtering) +- [PostgreSQL](/self-hosted/postgres) +- [PostgreSQL 12 end of life notice](/self-hosted/postgres12_end_of_life_notice) +- [PostgreSQL collation version mismatch resolution](/self-hosted/postgresql_collation_version_mismatch_resolution) +- [Profiling (pprof)](/self-hosted/pprof) ## [Observability](/self-hosted/observability) - [Monitoring guide](/self-hosted/how-to/monitoring-guide) - [Metrics and dashboards](/self-hosted/observability/metrics) +- [Dashboards reference](/self-hosted/observability/dashboards) - [Alerting](/self-hosted/observability/alerting) +- [Custom alerting consumption](/self-hosted/observability/alerting_custom_consumption) +- [Alerts reference](/self-hosted/observability/alerts) - [Tracing](/self-hosted/observability/tracing) - [Logs](/self-hosted/observability/logs) - [Outbound request log](/admin/outbound-request-log) - [OpenTelemetry](/self-hosted/observability/opentelemetry) - [Health checks](/self-hosted/observability/health_checks) - [Troubleshooting guide](/self-hosted/observability/troubleshooting) + +## [How-to Guides](/self-hosted/how-to/) + +- [Blobstore debugging](/self-hosted/how-to/blobstore_debugging) +- [Blobstore update notes](/self-hosted/how-to/blobstore_update_notes) +- [Clear code intelligence data](/self-hosted/how-to/clear_codeintel_data) +- [Dirty database (pre 3.37)](/self-hosted/how-to/dirty_database_pre_3_37) +- [Dirty database](/self-hosted/how-to/dirty_database) +- [PostgreSQL 12 to 16 drift](/self-hosted/how-to/postgres_12_to_16_drift) +- [PostgreSQL 14 index corruption](/self-hosted/how-to/postgres14-index-corruption) +- [Precise code intel worker crashloopbackoff](/self-hosted/how-to/precise-code-intel-worker-crashloopbackoff) +- [Privileged migrations](/self-hosted/how-to/privileged_migrations) +- [Rebuild corrupt PostgreSQL indexes](/self-hosted/how-to/rebuild-corrupt-postgres-indexes) +- [Redis ConfigMap](/self-hosted/how-to/redis_configmap) +- [Rollback database](/self-hosted/how-to/rollback_database) +- [Run psql](/self-hosted/how-to/run-psql) +- [Setup HTTPS](/self-hosted/how-to/setup-https) +- [Troubleshoot pod eviction](/self-hosted/how-to/troubleshoot-pod-eviction) +- [Unfinished migration](/self-hosted/how-to/unfinished_migration) +- [Upgrade PostgreSQL 12 to 16 (builtin DBs)](/self-hosted/how-to/upgrade-postgres-12-16-builtin-dbs) + +## [FAQs](/self-hosted/faq) diff --git a/src/data/navigation.ts b/src/data/navigation.ts index dcf5f62bd..b14ab0778 100644 --- a/src/data/navigation.ts +++ b/src/data/navigation.ts @@ -474,9 +474,43 @@ export const navigation: NavigationItem[] = [ title: 'Enterprise Self-Hosted', href: '/self-hosted', sections: [ - {title: 'Deploy', href: '/self-hosted/deploy'}, - {title: 'Upgrade', href: '/self-hosted/updates'}, - {title: 'Observability', href: '/self-hosted/observability'} + { + title: 'Deploy', + href: '/self-hosted/deploy', + subsections: [ + {title: 'Single-node', href: '/self-hosted/deploy/single-node'}, + {title: 'Docker Compose', href: '/self-hosted/deploy/docker-compose'}, + {title: 'Kubernetes', href: '/self-hosted/deploy/kubernetes'}, + {title: 'Machine Images', href: '/self-hosted/deploy/machine-images'} + ] + }, + { + title: 'Upgrade', + href: '/self-hosted/updates', + subsections: [ + {title: 'Migrator', href: '/self-hosted/updates/migrator'} + ] + }, + { + title: 'External Services', + href: '/self-hosted/external_services' + }, + { + title: 'Executors', + href: '/self-hosted/executors' + }, + { + title: 'Observability', + href: '/self-hosted/observability' + }, + { + title: 'How-to Guides', + href: '/self-hosted/how-to' + }, + { + title: 'FAQs', + href: '/self-hosted/faq' + } ] }, { From 67c31e8eda6c9520a62e0e31833379e9c19ea0b0 Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 21:29:39 +0100 Subject: [PATCH 09/21] Add callout for deep search tier availability for consistency --- docs/deep-search/index.mdx | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/deep-search/index.mdx b/docs/deep-search/index.mdx index 5634b3938..be1e9b803 100644 --- a/docs/deep-search/index.mdx +++ b/docs/deep-search/index.mdx @@ -1,15 +1,16 @@ # Deep Search + + Supported on [Enterprise Starter](/pricing/enterprise-starter) and + [Enterprise](/pricing/enterprise) plans. It's not supported for BYOK users. + Please reach out to your Sourcegraph account team to request access. + Available on the Web. + +

Learn more about Sourcegraph's agentic Code Search tool Deep Search.

- - Deep Search is available for Enterprise and Enterprise Starter customers. - It's not supported for BYOK users. Please reach out to your Sourcegraph - account team to request access. - - Deep Search is an agentic code search tool that understands natural language questions about your codebase. When a question is submitted, Deep Search performs an in-depth search and returns a detailed answer. The conversation can be continued with follow-up questions to dive deeper into relevant code. Under the hood, Deep Search is an AI agent that uses various tools to generate its answer. The tools are functionalities available in Sourcegraph. They include multiple modes of Sourcegraph's Code Search and Code Navigation features. All processing happens within your Sourcegraph instance. Only external calls are made to the configured LLM. From 47389c48ff9530f0f25106199548c5514d3e8383 Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 21:47:24 +0100 Subject: [PATCH 10/21] Fix some more links --- docs/admin/architecture.mdx | 2 +- docs/admin/code_hosts/aws_codecommit.mdx | 4 +-- docs/admin/how-to/monorepo-issues.mdx | 2 +- docs/admin/how-to/site-admin-quickstart.mdx | 2 +- docs/admin/repo/auth.mdx | 4 +-- docs/admin/repo/git_config.mdx | 4 +-- docs/admin/repo/pre_load_from_local_disk.mdx | 2 +- .../self-hosted/deploy/docker-compose/aws.mdx | 2 +- .../deploy/docker-compose/azure.mdx | 2 +- .../deploy/docker-compose/digitalocean.mdx | 2 +- .../deploy/docker-compose/google_cloud.mdx | 2 +- .../deploy/docker-compose/upgrade.mdx | 8 ++--- .../deploy/docker-single-container/index.mdx | 10 +++--- .../deploy/kubernetes/configure.mdx | 36 +++++++++---------- docs/self-hosted/deploy/kubernetes/index.mdx | 6 ++-- .../deploy/kubernetes/kustomize.mdx | 6 ++-- .../deploy/kubernetes/kustomize/eks.mdx | 2 +- .../deploy/kubernetes/kustomize/migrate.mdx | 8 ++--- .../deploy/kubernetes/operations.mdx | 2 +- .../self-hosted/deploy/kubernetes/upgrade.mdx | 8 ++--- docs/self-hosted/deploy/repositories.mdx | 2 +- .../self-hosted/deployment_best_practices.mdx | 6 ++-- .../deploy_executors_binary_offline.mdx | 2 +- docs/self-hosted/how-to/dirty_database.mdx | 2 +- .../how-to/dirty_database_pre_3_37.mdx | 2 +- .../how-to/postgres14-index-corruption.mdx | 2 +- .../rebuild-corrupt-postgres-indexes.mdx | 2 +- .../how-to/unfinished_migration.mdx | 4 +-- docs/self-hosted/observability/logs.mdx | 2 +- .../observability/troubleshooting.mdx | 2 +- docs/self-hosted/pprof.mdx | 4 +-- docs/self-hosted/updates/automatic.mdx | 2 +- docs/self-hosted/updates/index.mdx | 4 +-- docs/self-hosted/updates/kubernetes.mdx | 2 +- .../updates/migrator/downgrading.mdx | 2 +- .../updates/migrator/migrator-operations.mdx | 10 +++--- .../migrator/upgrading-early-versions.mdx | 2 +- docs/self-hosted/updates/pure_docker.mdx | 2 +- docs/tutorials/index.mdx | 10 +++--- 39 files changed, 89 insertions(+), 89 deletions(-) diff --git a/docs/admin/architecture.mdx b/docs/admin/architecture.mdx index 888eaddd0..f9a7a9767 100644 --- a/docs/admin/architecture.mdx +++ b/docs/admin/architecture.mdx @@ -57,7 +57,7 @@ This is the default because it works with no extra configuration and is good for With some setup, customers can enable [precise code navigation](/code-navigation/precise_code_navigation). Repositories add a step to their build pipeline that computes the index for that code revision and uploads it to Sourcegraph. We must write language-specific indexers, so adding precise code navigation support for new languages is a non-trivial task. - Learn more in the [Code Navigation docs](/code-search/code-navigation) + Learn more in the [Code Navigation docs](/code-navigation) ### Dependencies diff --git a/docs/admin/code_hosts/aws_codecommit.mdx b/docs/admin/code_hosts/aws_codecommit.mdx index 7e3902951..150deb60c 100644 --- a/docs/admin/code_hosts/aws_codecommit.mdx +++ b/docs/admin/code_hosts/aws_codecommit.mdx @@ -136,8 +136,8 @@ 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. See [docs](/admin/deploy/docker-single-container/#ssh-authentication-config-keys-knownhosts) for more information about our ssh file system. - 1. Read our [guide here](/admin/deploy/docker-compose/#git-ssh-configuration) for Docker Compose deployments +1. Copy all the files at your `$HOME/.ssh directory` to `$HOME/.sourcegraph/config/ssh` directory. See [docs](/self-hosted/deploy/docker-single-container/#ssh-authentication-config-keys-knownhosts) for more information about our ssh file system. + 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/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/how-to/monorepo-issues.mdx b/docs/admin/how-to/monorepo-issues.mdx index 20362b531..5212c650f 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](/admin/deploy/docker-compose/#operations) and [kubernetes](/self-hosted/deploy/kubernetes/operations)_ +_Learn more about managing resources in [docker-compose](/self-hosted/deploy/docker-compose/#operations) and [kubernetes](/self-hosted/deploy/kubernetes/operations)_ ## Slow hover tooltip results diff --git a/docs/admin/how-to/site-admin-quickstart.mdx b/docs/admin/how-to/site-admin-quickstart.mdx index 251aeca7b..cc6ac6423 100644 --- a/docs/admin/how-to/site-admin-quickstart.mdx +++ b/docs/admin/how-to/site-admin-quickstart.mdx @@ -8,7 +8,7 @@ This guide will walk you through the features and functionalities available to y ### What is the best deployment option for me? -We recommend Docker Compose for most initial production deployments. You can [migrate to a different deployment method](/admin/updates/#migrating-to-a-new-deployment-type) later on if needed. +We recommend Docker Compose for most initial production deployments. You can [migrate to a different deployment method](/self-hosted/updates/#migrating-to-a-new-deployment-type) later on if needed. If you need a deployment option that offers a higher level of scalability and availability, the [Kubernetes deployment](/self-hosted/deploy/kubernetes/) is recommended. diff --git a/docs/admin/repo/auth.mdx b/docs/admin/repo/auth.mdx index a65c799d1..cb9a19260 100644 --- a/docs/admin/repo/auth.mdx +++ b/docs/admin/repo/auth.mdx @@ -31,9 +31,9 @@ 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](/admin/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/#git-configuration). - [Sourcegraph with Kubernetes](/self-hosted/deploy/kubernetes/): See [Configure repository cloning via SSH](/self-hosted/deploy/kubernetes/configure#ssh-for-cloning). -- [Single-container Sourcegraph](/self-hosted/deploy/docker-single-container/): See [the single-container git configuration guide](/admin/deploy/docker-single-container/#git-configuration-and-authentication). +- [Single-container Sourcegraph](/self-hosted/deploy/docker-single-container/): See [the single-container git configuration guide](/self-hosted/deploy/docker-single-container/#git-configuration-and-authentication). ## Troubleshooting diff --git a/docs/admin/repo/git_config.mdx b/docs/admin/repo/git_config.mdx index 04e2cf0dd..6f7d1d890 100644 --- a/docs/admin/repo/git_config.mdx +++ b/docs/admin/repo/git_config.mdx @@ -4,9 +4,9 @@ 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](/admin/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/#git-configuration). - [Sourcegraph with Kubernetes](/self-hosted/deploy/kubernetes/): See [Configure repository cloning via SSH](/self-hosted/deploy/kubernetes/configure#ssh-for-cloning). -- [Single-container Sourcegraph](/self-hosted/deploy/docker-single-container/): See [the single-container git configuration guide](/admin/deploy/docker-single-container/#git-configuration-and-authentication). +- [Single-container Sourcegraph](/self-hosted/deploy/docker-single-container/): See [the single-container git configuration guide](/self-hosted/deploy/docker-single-container/#git-configuration-and-authentication). ## Example: alternate clone URL for repos diff --git a/docs/admin/repo/pre_load_from_local_disk.mdx b/docs/admin/repo/pre_load_from_local_disk.mdx index 785a9a913..c7a4d4656 100644 --- a/docs/admin/repo/pre_load_from_local_disk.mdx +++ b/docs/admin/repo/pre_load_from_local_disk.mdx @@ -8,7 +8,7 @@ You can use repositories that are already cloned to disk on the host machine to The steps documented here are intended for [single-container Sourcegraph instances](/self-hosted/deploy/docker-single-container/). The general process also applies for other deployment methods, with some differences: -- [Docker Compose](/self-hosted/deploy/docker-compose/): you need to perform these steps on the relevant [Docker Compose volumes](/admin/deploy/docker-compose/#manage-storage). +- [Docker Compose](/self-hosted/deploy/docker-compose/): you need to perform these steps on the relevant [Docker Compose volumes](/self-hosted/deploy/docker-compose/#manage-storage). - [Kubernetes](/self-hosted/deploy/kubernetes/): you need to perform these steps on the underlying node hosting the `gitserver` pod, or on the persistent volume used by the `gitserver` deployment. > WARNING: For [single-container Sourcegraph instances](/self-hosted/deploy/docker-single-container/), Sourcegraph will alter the contents and structure of files under `/var/opt/sourcegraph` (Sourcegraph’s data volume inside the container), so do not mount repositories in use by other processes under that directory. diff --git a/docs/self-hosted/deploy/docker-compose/aws.mdx b/docs/self-hosted/deploy/docker-compose/aws.mdx index e3c9731c3..685fdc1d1 100644 --- a/docs/self-hosted/deploy/docker-compose/aws.mdx +++ b/docs/self-hosted/deploy/docker-compose/aws.mdx @@ -121,7 +121,7 @@ cd "${DEPLOY_SOURCEGRAPH_DOCKER_CHECKOUT}"/docker-compose docker-compose up -d --remove-orphans ``` -> NOTE: If you're deploying a production instance, we recommend [forking the deployment configuration repository](/admin/deploy/docker-compose/#step-1-fork-the-deployment-repository) to track any customizations you make to the deployment config. If you do so, you'll want to update the _startup script_ you pasted from above to refer to the clone URL and revision of your fork: +> NOTE: If you're deploying a production instance, we recommend [forking the deployment configuration repository](/self-hosted/deploy/docker-compose/#step-1-fork-the-deployment-repository) to track any customizations you make to the deployment config. If you do so, you'll want to update the _startup script_ you pasted from above to refer to the clone URL and revision of your fork: > > - `DEPLOY_SOURCEGRAPH_DOCKER_FORK_CLONE_URL`: The Git clone URL of your deployment repository. If it is a private repository, please check with your code host on how to generate a URL for cloning private repository > - `DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION`: The revision (branch) in your fork containing the customizations, typically "release" diff --git a/docs/self-hosted/deploy/docker-compose/azure.mdx b/docs/self-hosted/deploy/docker-compose/azure.mdx index acf8253b6..41834a7d9 100644 --- a/docs/self-hosted/deploy/docker-compose/azure.mdx +++ b/docs/self-hosted/deploy/docker-compose/azure.mdx @@ -136,7 +136,7 @@ cd "${DEPLOY_SOURCEGRAPH_DOCKER_CHECKOUT}"/docker-compose docker-compose up -d --remove-orphans ``` -> NOTE: If you're deploying a production instance, we recommend [forking the deployment configuration repository](/admin/deploy/docker-compose/#step-1-fork-the-deployment-repository) to track any customizations you make to the deployment config. If you do so, you'll want to update the _startup script_ you pasted from above to refer to the clone URL and revision of your fork: +> NOTE: If you're deploying a production instance, we recommend [forking the deployment configuration repository](/self-hosted/deploy/docker-compose/#step-1-fork-the-deployment-repository) to track any customizations you make to the deployment config. If you do so, you'll want to update the _startup script_ you pasted from above to refer to the clone URL and revision of your fork: > > - `DEPLOY_SOURCEGRAPH_DOCKER_FORK_CLONE_URL`: The Git clone URL of your deployment repository. If it is a private repository, please check with your code host on how to generate a URL for cloning private repository > - `DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION`: The revision (branch) in your fork containing the customizations, typically "release" diff --git a/docs/self-hosted/deploy/docker-compose/digitalocean.mdx b/docs/self-hosted/deploy/docker-compose/digitalocean.mdx index d6f650dde..6e391a211 100644 --- a/docs/self-hosted/deploy/docker-compose/digitalocean.mdx +++ b/docs/self-hosted/deploy/docker-compose/digitalocean.mdx @@ -126,7 +126,7 @@ cd "${DEPLOY_SOURCEGRAPH_DOCKER_CHECKOUT}"/docker-compose docker-compose up -d --remove-orphans ``` -> NOTE: If you're deploying a production instance, we recommend [forking the deployment configuration repository](/admin/deploy/docker-compose/#step-1-fork-the-deployment-repository) to track any customizations you make to the deployment config. If you do so, you'll want to update the _startup script_ you pasted from above to refer to the clone URL and revision of your fork: +> NOTE: If you're deploying a production instance, we recommend [forking the deployment configuration repository](/self-hosted/deploy/docker-compose/#step-1-fork-the-deployment-repository) to track any customizations you make to the deployment config. If you do so, you'll want to update the _startup script_ you pasted from above to refer to the clone URL and revision of your fork: > > - `DEPLOY_SOURCEGRAPH_DOCKER_FORK_CLONE_URL`: The Git clone URL of your deployment repository. If it is a private repository, please check with your code host on how to generate a URL for cloning private repository > - `DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION`: The revision (branch) in your fork containing the customizations, typically "release" diff --git a/docs/self-hosted/deploy/docker-compose/google_cloud.mdx b/docs/self-hosted/deploy/docker-compose/google_cloud.mdx index 09013862b..d4692f159 100644 --- a/docs/self-hosted/deploy/docker-compose/google_cloud.mdx +++ b/docs/self-hosted/deploy/docker-compose/google_cloud.mdx @@ -120,7 +120,7 @@ cd "${DEPLOY_SOURCEGRAPH_DOCKER_CHECKOUT}"/docker-compose docker-compose up -d --remove-orphans ``` -> NOTE: If you're deploying a production instance, we recommend [forking the deployment configuration repository](/admin/deploy/docker-compose/#step-1-fork-the-deployment-repository) to track any customizations you make to the deployment config. If you do so, you'll want to update the _startup script_ you pasted from above to refer to the clone URL and revision of your fork: +> NOTE: If you're deploying a production instance, we recommend [forking the deployment configuration repository](/self-hosted/deploy/docker-compose/#step-1-fork-the-deployment-repository) to track any customizations you make to the deployment config. If you do so, you'll want to update the _startup script_ you pasted from above to refer to the clone URL and revision of your fork: > > - `DEPLOY_SOURCEGRAPH_DOCKER_FORK_CLONE_URL`: The Git clone URL of your deployment repository. If it is a private repository, please check with your code host on how to generate a URL for cloning private repository > - `DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION`: The revision (branch) in your fork containing the customizations, typically "release" diff --git a/docs/self-hosted/deploy/docker-compose/upgrade.mdx b/docs/self-hosted/deploy/docker-compose/upgrade.mdx index 0b93393a9..78cae68fd 100644 --- a/docs/self-hosted/deploy/docker-compose/upgrade.mdx +++ b/docs/self-hosted/deploy/docker-compose/upgrade.mdx @@ -11,9 +11,9 @@ This document describes the process to update a Docker Compose Sourcegraph insta ### Standard upgrades -A [standard upgrade](/admin/updates/#upgrade-types) occurs between a Sourcegraph version and the minor or major version released immediately after it. If you would like to jump forward several versions, you must perform a [multi-version upgrade](#multi-version-upgrades) instead. +A [standard upgrade](/self-hosted/updates/#upgrade-types) occurs between a Sourcegraph version and the minor or major version released immediately after it. If you would like to jump forward several versions, you must perform a [multi-version upgrade](#multi-version-upgrades) instead. -If you've [configured Docker Compose with a release branch](/admin/deploy/docker-compose/#step-1-prepare-the-deployment-repository), please merge the upstream release tag for the next minor version into your `release` branch. +If you've [configured Docker Compose with a release branch](/self-hosted/deploy/docker-compose/#step-1-prepare-the-deployment-repository), please merge the upstream release tag for the next minor version into your `release` branch. In the following example, the release branch is being upgraded to {CURRENT_VERSION_STRING()}. @@ -64,7 +64,7 @@ $ docker-compose up -d --remove-orphans > > Multiversion upgrades **require downtime**, please see our [cautionary -> note](/admin/updates/#best-practices) on upgrades, if you have any +> note](/self-hosted/updates/#best-practices) on upgrades, if you have any > concerns about running a multiversion upgrade, please reach out to us at > [support@sourcegraph.com](mailto:support@sourcegraph.com) for > advisement.{' '} @@ -75,7 +75,7 @@ To perform a multi-version upgrade via migrators [upgrade](/self-hosted/updates/ 1. **Check Upgrade Readiness**: - Check the [upgrade notes](/self-hosted/updates/docker_compose#docker-compose-upgrade-notes) for the version range you're passing through. - - Check the `Site Admin > Updates` page to determine [upgrade readiness](/admin/updates/#upgrade-readiness). + - Check the `Site Admin > Updates` page to determine [upgrade readiness](/self-hosted/updates/#upgrade-readiness). 2. **Pull and merge upstream changes**: diff --git a/docs/self-hosted/deploy/docker-single-container/index.mdx b/docs/self-hosted/deploy/docker-single-container/index.mdx index 519fd7aa9..d9f5fbe94 100644 --- a/docs/self-hosted/deploy/docker-single-container/index.mdx +++ b/docs/self-hosted/deploy/docker-single-container/index.mdx @@ -155,7 +155,7 @@ From sourcegraph version 5.11 onwards, the Sourcegraph single container Docker i **Before performing a multi-version upgrade**: -- Read our [update policy](/admin/updates/#update-policy) to learn about Sourcegraph updates. +- Read our [update policy](/self-hosted/updates/#update-policy) to learn about Sourcegraph updates. - Find the entries that apply to the version range you're passing through in the [update notes for Sourcegraph with Docker Single Container](/self-hosted/updates/server#multi-version-upgrade-procedure). 0. You must first shutdown the container instance via `docker stop [CONTAINER]`. @@ -172,11 +172,11 @@ You now have a single server Sourcegraph container image running on Postgresql 1 ### Standard upgrades -A [standard upgrade](/admin/updates/#standard-upgrades) occurs between two minor versions of Sourcegraph. If you are looking to jump forward several versions, you must perform a [multi-version upgrade](#multi-version-upgrades) instead. +A [standard upgrade](/self-hosted/updates/#standard-upgrades) occurs between two minor versions of Sourcegraph. If you are looking to jump forward several versions, you must perform a [multi-version upgrade](#multi-version-upgrades) instead. **Before upgrading:** -- Read our [update policy](/admin/updates/#update-policy) to learn about Sourcegraph updates. +- Read our [update policy](/self-hosted/updates/#update-policy) to learn about Sourcegraph updates. - Find the relevant entry for your update in the [update notes for single-container Sourcegraph with Docker](/self-hosted/updates/server). To update, just use the newer `sourcegraph/server:N.N.N` Docker image (where `N.N.N` is a patch or single minor release away your current version) in place of the older one, using the same Docker volumes. Your server's data will be migrated automatically if needed. You can always find the version number details of the latest release via the [technical changelog](/technical-changelog). @@ -193,7 +193,7 @@ To update, just use the newer `sourcegraph/server:N.N.N` Docker image in place o ### (Legacy) Multi-version upgrades -A [multi-version upgrade](/admin/updates/#multi-version-upgrades) is a downtime-incurring upgrade from version 3.20 or later to any future version. Multi-version upgrades will run both schema and data migrations to ensure the data available from the instance remains available post-upgrade. +A [multi-version upgrade](/self-hosted/updates/#multi-version-upgrades) is a downtime-incurring upgrade from version 3.20 or later to any future version. Multi-version upgrades will run both schema and data migrations to ensure the data available from the instance remains available post-upgrade. > NOTE: It is highly recommended to **take an up-to-date snapshot of your databases** prior to starting a multi-version upgrade. The upgrade process aggressively mutates the shape and contents of your database, and undiscovered errors in the migration process or unexpected environmental differences may cause an unusable instance or data loss. > @@ -203,7 +203,7 @@ A [multi-version upgrade](/admin/updates/#multi-version-upgrades) is a downtime- **Before performing a multi-version upgrade**: -- Read our [update policy](/admin/updates/#update-policy) to learn about Sourcegraph updates. +- Read our [update policy](/self-hosted/updates/#update-policy) to learn about Sourcegraph updates. - Find the entries that apply to the version range you're passing through in the [update notes for Sourcegraph with Docker Single Container](/self-hosted/updates/server#multi-version-upgrade-procedure). To perform a multi-version upgrade on a Sourcegraph instance running on Docker Single Container: diff --git a/docs/self-hosted/deploy/kubernetes/configure.mdx b/docs/self-hosted/deploy/kubernetes/configure.mdx index ffac988ba..8fd6ca32e 100644 --- a/docs/self-hosted/deploy/kubernetes/configure.mdx +++ b/docs/self-hosted/deploy/kubernetes/configure.mdx @@ -13,9 +13,9 @@ This guide will demonstrate how to customize a Kubernetes deployment (**non-Helm ## Overview -To ensure optimal performance and functionality of your Sourcegraph deployment, please only include components listed in the [kustomization.template.yaml file](/admin/deploy/kubernetes/kustomize/#kustomization-yaml) for your instance overlay. These components include settings that have been specifically designed and tested for Sourcegraph and do not require any additional configuration changes. +To ensure optimal performance and functionality of your Sourcegraph deployment, please only include components listed in the [kustomization.template.yaml file](/self-hosted/deploy/kubernetes/kustomize/#kustomization-yaml) for your instance overlay. These components include settings that have been specifically designed and tested for Sourcegraph and do not require any additional configuration changes. -The order of components listed in the [kustomization.template.yaml file](/admin/deploy/kubernetes/kustomize/#kustomization-yaml) is important and should be maintained. The components are listed in a specific order to ensure proper dependency management and compatibility between components. Reordering components can introduce conflicts or prevent components from interacting as expected. Only modify the component order if explicitly instructed to do so by the documentation. Otherwise, leave the component order as-is to avoid issues. +The order of components listed in the [kustomization.template.yaml file](/self-hosted/deploy/kubernetes/kustomize/#kustomization-yaml) is important and should be maintained. The components are listed in a specific order to ensure proper dependency management and compatibility between components. Reordering components can introduce conflicts or prevent components from interacting as expected. Only modify the component order if explicitly instructed to do so by the documentation. Otherwise, leave the component order as-is to avoid issues. Following these guidelines will help you create a seamless deployment and avoid conflicts. @@ -38,11 +38,11 @@ To enable cluster metrics monitoring, you will need to [deploy cAdvisor](#deploy ### RBAC -Sourcegraph has removed Role-Based Access Control (RBAC) resources from the default base cluster for the Kustomize deployment. This means that [service discovery](#service-discovery) is not enabled by default, and the endpoints for each service replica must be manually added to the frontend ConfigMap. When using the [size components](#instance-size-based-resources) included in the [kustomization file built for Sourcegraph](/admin/deploy/kubernetes/kustomize/#kustomization-yaml), service endpoints are automatically added to the ConfigMap. +Sourcegraph has removed Role-Based Access Control (RBAC) resources from the default base cluster for the Kustomize deployment. This means that [service discovery](#service-discovery) is not enabled by default, and the endpoints for each service replica must be manually added to the frontend ConfigMap. When using the [size components](#instance-size-based-resources) included in the [kustomization file built for Sourcegraph](/self-hosted/deploy/kubernetes/kustomize/#kustomization-yaml), service endpoints are automatically added to the ConfigMap. ### Non-Privileged -By default, all Sourcegraph services are deployed in a non-root and non-privileged mode, as defined in the [base](/admin/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](/self-hosted/deploy/kubernetes/kustomize/#base) cluster. ### Privileged @@ -219,7 +219,7 @@ components: Follow these steps to configure the otel-collector to export traces to an external OTel-compatible backend: 1. Create a subdirectory called 'patches' within the directory of your overlay -2. Copy and paste the [base/otel-collector/otel-collector.ConfigMap.yaml file](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-k8s@master/-/tree/base/otel-collector/otel-collector.ConfigMap.yaml) to the new [patches subdirectory](/admin/deploy/kubernetes/kustomize/#patches-directory) +2. Copy and paste the [base/otel-collector/otel-collector.ConfigMap.yaml file](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-k8s@master/-/tree/base/otel-collector/otel-collector.ConfigMap.yaml) to the new [patches subdirectory](/self-hosted/deploy/kubernetes/kustomize/#patches-directory) 3. In the copied file, make the necessary changes to the `exporters` and `service` blocks to connect to your backend based on the documentation linked above 4. Include the following content in your overlay: @@ -570,7 +570,7 @@ components: - ../../components/storage-class/name-update ``` -**Step 2**: Enter the value of your existing storage class name in your [buildConfig.yaml](/admin/deploy/kubernetes/kustomize/#buildconfig-yaml) file using the `STORAGECLASS_NAME` config key +**Step 2**: Enter the value of your existing storage class name in your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file using the `STORAGECLASS_NAME` config key Example, set `STORAGECLASS_NAME=sourcegraph` if `sourcegraph` is the name for the existing storage class: @@ -594,7 +594,7 @@ components: - ../../components/storage-class/cloud ``` -Update the following variables in your [buildConfig.yaml](/admin/deploy/kubernetes/kustomize/#buildconfig-yaml) file. Replace them with the correct values according to the instructions provided by your cloud provider: +Update the following variables in your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file. Replace them with the correct values according to the instructions provided by your cloud provider: ```yaml # instances/$INSTANCE_NAME/buildConfig.yaml @@ -686,7 +686,7 @@ data: # the data is abbreviated in this example ``` -**Step 3**: Configure the TLS settings of your Ingress by adding the following variables to your [buildConfig.yaml](/admin/deploy/kubernetes/kustomize/#buildconfig-yaml) file: +**Step 3**: Configure the TLS settings of your Ingress by adding the following variables to your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file: - **TLS_HOST**: your domain name - **TLS_INGRESS_CLASS_NAME**: ingress class name required by your cluster-issuer @@ -713,7 +713,7 @@ components: ### TLS with Let’s Encrypt -Alternatively, you can configure [cert-manager with Let’s Encrypt](https://cert-manager.io/docs/configuration/acme/) in your cluster. Then, follow the steps listed above for configuring TLS certificate via TLS Secrets manually. However, when adding the variables to the [buildConfig.yaml/admin/deploy/kubernetes/kustomize/#buildconfig-yaml) file, set **TLS_CLUSTER_ISSUER=letsencrypt** to include the cert-manager with Let's Encrypt. +Alternatively, you can configure [cert-manager with Let’s Encrypt](https://cert-manager.io/docs/configuration/acme/) in your cluster. Then, follow the steps listed above for configuring TLS certificate via TLS Secrets manually. However, when adding the variables to the [buildConfig.yaml/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file, set **TLS_CLUSTER_ISSUER=letsencrypt** to include the cert-manager with Let's Encrypt. ### TLS secret name @@ -776,7 +776,7 @@ components: To configure the hostname for your Sourcegraph ingress, follow these steps: -**Step 1**: In your [buildConfig.yaml](/admin/deploy/kubernetes/kustomize/#buildconfig-yaml) file, include the `HOST_DOMAIN` variable and set it to your desired hostname, for example: +**Step 1**: In your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file, include the `HOST_DOMAIN` variable and set it to your desired hostname, for example: ```yaml # instances/$INSTANCE_NAME/buildConfig.yaml @@ -829,7 +829,7 @@ To configure ingress-nginx annotations for the Sourcegraph frontend ingress: $ mkdir -p instances/$INSTANCE_NAME/patches ``` -**Step 2**: Copy the `frontend-ingress-annotations.yaml` patch file from the components/patches directory to the new [patches subdirectory](/admin/deploy/kubernetes/kustomize/#patches-directory) +**Step 2**: Copy the `frontend-ingress-annotations.yaml` patch file from the components/patches directory to the new [patches subdirectory](/self-hosted/deploy/kubernetes/kustomize/#patches-directory) ```bash $ cp components/patches/frontend-ingress-annotations.yaml instances/$INSTANCE_NAME/patches/frontend-ingress-annotations.yaml @@ -948,7 +948,7 @@ components: ### Frontend -To update the environment variables for the **sourcegraph-frontend** service, add the new environment variables to the end of the _FRONTEND ENV VARS_ section at the bottom of your [kustomization file](/admin/deploy/kubernetes/kustomize/#kustomizationyaml). For example: +To update the environment variables for the **sourcegraph-frontend** service, add the new environment variables to the end of the _FRONTEND ENV VARS_ section at the bottom of your [kustomization file](/self-hosted/deploy/kubernetes/kustomize/#kustomizationyaml). For example: ```yaml # instances/$INSTANCE_NAME/kustomization.yaml @@ -1058,7 +1058,7 @@ Similar changes will be required for other pods and services, depending on the s For optimal performance and resilience, it is recommended to use an external database when deploying Sourcegraph. For more information on database requirements, please refer to the [Postgres guide](/self-hosted/postgres). -To connect Sourcegraph to an existing PostgreSQL instance, add the relevant environment variables ([such as PGHOST, PGPORT, PGUSER, etc.](http://www.postgresql.org/docs/current/static/libpq-envars.html)) to the frontend ConfigMap by adding the new environment variables to the end of the _FRONTEND ENV VARS_ section at the bottom of your [kustomization file](/admin/deploy/kubernetes/kustomize/#kustomizationyaml). For example: +To connect Sourcegraph to an existing PostgreSQL instance, add the relevant environment variables ([such as PGHOST, PGPORT, PGUSER, etc.](http://www.postgresql.org/docs/current/static/libpq-envars.html)) to the frontend ConfigMap by adding the new environment variables to the end of the _FRONTEND ENV VARS_ section at the bottom of your [kustomization file](/self-hosted/deploy/kubernetes/kustomize/#kustomizationyaml). For example: ```yaml # instances/$INSTANCE_NAME/kustomization.yaml @@ -1099,7 +1099,7 @@ components: - ../../components/services/redis ``` -**Step 2**: Set the following variable in your [buildConfig.yaml/admin/deploy/kubernetes/kustomize/#buildconfig-yaml) file: +**Step 2**: Set the following variable in your [buildConfig.yaml/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file: ```yaml # instances/$INSTANCE_NAME/buildConfig.yaml @@ -1187,7 +1187,7 @@ cAdvisor can pick up metrics for services unrelated to the Sourcegraph deploymen $ mkdir instances/$INSTANCE_NAME/patches ``` -2\. Create a copy of the `prometheus.ConfigMap.yaml` file in the new [patches subdirectory](/admin/deploy/kubernetes/kustomize/#patches-directory) +2\. Create a copy of the `prometheus.ConfigMap.yaml` file in the new [patches subdirectory](/self-hosted/deploy/kubernetes/kustomize/#patches-directory) ```bash mv base/monitoring/prometheus/rbacs/prometheus.ConfigMap.yaml instances/$INSTANCE_NAME/patches/prometheus.ConfigMap.yaml @@ -1228,7 +1228,7 @@ components: - ../../components/enable/private-registry ``` -**Step 2:** Set the `PRIVATE_REGISTRY` variable in your [buildConfig.yaml](/admin/deploy/kubernetes/kustomize/#buildconfig-yaml) file. For example: +**Step 2:** Set the `PRIVATE_REGISTRY` variable in your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file. For example: ```yaml # instances/$INSTANCE_NAME/buildConfig.yaml @@ -1248,7 +1248,7 @@ components: - ../../components/resources/imagepullsecrets ``` -**Step 2:** Set the `IMAGE_PULL_SECRET_NAME` variable in your [buildConfig.yaml](/admin/deploy/kubernetes/kustomize/#buildconfig-yaml) file. +**Step 2:** Set the `IMAGE_PULL_SECRET_NAME` variable in your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file. For example: @@ -1278,7 +1278,7 @@ patches: ## Multi-version upgrade -In order to perform a [multi-version upgrade](/admin/updates/#multi-version-upgrades), all pods must be scaled down to 0 except databases, which can be handled by including the `utils/multi-version-upgrade` component: +In order to perform a [multi-version upgrade](/self-hosted/updates/#multi-version-upgrades), all pods must be scaled down to 0 except databases, which can be handled by including the `utils/multi-version-upgrade` component: ```yaml # instances/$INSTANCE_NAME/kustomization.yaml diff --git a/docs/self-hosted/deploy/kubernetes/index.mdx b/docs/self-hosted/deploy/kubernetes/index.mdx index a8e0ae5d3..011f3fe0d 100644 --- a/docs/self-hosted/deploy/kubernetes/index.mdx +++ b/docs/self-hosted/deploy/kubernetes/index.mdx @@ -973,7 +973,7 @@ The following procedures describe the process to update a Helm Sourcegraph insta ### Standard upgrades -A [standard upgrade](/admin/updates/#upgrade-types) occurs between a Sourcegraph version and the minor or major version released immediately after it. If you would like to jump forward several versions, you must perform a [multi-version upgrade](#multi-version-upgrades) instead. +A [standard upgrade](/self-hosted/updates/#upgrade-types) occurs between a Sourcegraph version and the minor or major version released immediately after it. If you would like to jump forward several versions, you must perform a [multi-version upgrade](#multi-version-upgrades) instead. **Step 1:** Review [Helm Changelog] and [Sourcegraph Changelog] and select the most recent version compatible with your current Sourcegraph version. @@ -1006,7 +1006,7 @@ When all pods have restarted and show as Running, you can browse to your Sourceg ### Multi-version upgrades - Please see our [cautionary note](/admin/updates/#best-practices) on + Please see our [cautionary note](/self-hosted/updates/#best-practices) on upgrades, if you have any concerns about running a multi-version upgrade, please reach out to us at [support@sourcegraph.com](mailto:support@sourcegraph.com) for advisement. @@ -1017,7 +1017,7 @@ When all pods have restarted and show as Running, you can browse to your Sourceg **Step 1:** Check Upgrade Readiness: - Check the [upgrade notes](/self-hosted/updates/kubernetes#kubernetes-upgrade-notes) for the version range you're passing through. -- Check the `Site Admin > Updates` page to determine [upgrade readiness](/admin/updates/#upgrade-readiness). +- Check the `Site Admin > Updates` page to determine [upgrade readiness](/self-hosted/updates/#upgrade-readiness). **Step 2:** diff --git a/docs/self-hosted/deploy/kubernetes/kustomize.mdx b/docs/self-hosted/deploy/kubernetes/kustomize.mdx index 7a389f1e6..553cca0fd 100644 --- a/docs/self-hosted/deploy/kubernetes/kustomize.mdx +++ b/docs/self-hosted/deploy/kubernetes/kustomize.mdx @@ -49,7 +49,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](/admin/deploy/kubernetes/kustomize/#template) directory and rename it to `instances/my-sourcegraph`: +Create a copy of the [instances/template](/self-hosted/deploy/kubernetes/kustomize/#template) directory and rename it to `instances/my-sourcegraph`: ```bash $ cp -R instances/template instances/my-sourcegraph @@ -62,7 +62,7 @@ Create a copy of the [instances/template](/admin/deploy/kubernetes/kustomize/#te ### **Step 3**: Set up the configuration files -**1.** Rename the [kustomization.template.yaml](/admin/deploy/kubernetes/kustomize/#kustomization-yaml) file in `instances/my-sourcegraph` to `kustomization.yaml`. +**1.** Rename the [kustomization.template.yaml](/self-hosted/deploy/kubernetes/kustomize/#kustomization-yaml) file in `instances/my-sourcegraph` to `kustomization.yaml`. - The `kustomization.yaml` file is used to configure your Sourcegraph instance. @@ -70,7 +70,7 @@ Create a copy of the [instances/template](/admin/deploy/kubernetes/kustomize/#te $ mv instances/my-sourcegraph/kustomization.template.yaml instances/my-sourcegraph/kustomization.yaml ``` -**2.** Rename the [buildConfig.template.yaml](/admin/deploy/kubernetes/kustomize/#buildconfig-yaml) file in `instances/my-sourcegraph` to `buildConfig.yaml`. +**2.** Rename the [buildConfig.template.yaml](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file in `instances/my-sourcegraph` to `buildConfig.yaml`. - The `buildConfig.yaml` file is used to configure components included in your `kustomization` file if required. diff --git a/docs/self-hosted/deploy/kubernetes/kustomize/eks.mdx b/docs/self-hosted/deploy/kubernetes/kustomize/eks.mdx index 0f960eedd..d3dd60631 100644 --- a/docs/self-hosted/deploy/kubernetes/kustomize/eks.mdx +++ b/docs/self-hosted/deploy/kubernetes/kustomize/eks.mdx @@ -122,7 +122,7 @@ components: - ../../components/clusters/aws/managed-cert ``` -Step 2: Set the `AWS_MANAGED_CERT_ARN` variable with the `ARN of your AWS-managed TLS certificate` under the [BUILD CONFIGURATIONS](/admin/deploy/kubernetes/kustomize/#buildconfig-yaml) section: +Step 2: Set the `AWS_MANAGED_CERT_ARN` variable with the `ARN of your AWS-managed TLS certificate` under the [BUILD CONFIGURATIONS](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) section: ```yaml # instances/$INSTANCE_NAME/buildConfig.yaml diff --git a/docs/self-hosted/deploy/kubernetes/kustomize/migrate.mdx b/docs/self-hosted/deploy/kubernetes/kustomize/migrate.mdx index 1a34ebb33..f0e952b83 100644 --- a/docs/self-hosted/deploy/kubernetes/kustomize/migrate.mdx +++ b/docs/self-hosted/deploy/kubernetes/kustomize/migrate.mdx @@ -57,7 +57,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](/admin/deploy/kubernetes/kustomize/#template) directory and rename it to `instances/my-sourcegraph`: +Create a copy of the [instances/template](/self-hosted/deploy/kubernetes/kustomize/#template) directory and rename it to `instances/my-sourcegraph`: ```bash $ cp -R instances/template instances/my-sourcegraph @@ -71,7 +71,7 @@ Create a copy of the [instances/template](/admin/deploy/kubernetes/kustomize/#te The `kustomization.yaml` file is used to configure your Sourcegraph instance. -**1.** Rename the [kustomization.template.yaml](/admin/deploy/kubernetes/kustomize/#kustomization-yaml) file in `instances/my-sourcegraph` to `kustomization.yaml`. +**1.** Rename the [kustomization.template.yaml](/self-hosted/deploy/kubernetes/kustomize/#kustomization-yaml) file in `instances/my-sourcegraph` to `kustomization.yaml`. - The `kustomization.yaml` file is used to configure your Sourcegraph instance. @@ -81,7 +81,7 @@ The `kustomization.yaml` file is used to configure your Sourcegraph instance. #### buildConfig.yaml -**2.** Rename the [buildConfig.template.yaml](/admin/deploy/kubernetes/kustomize/#buildconfig-yaml) file in `instances/my-sourcegraph` to `buildConfig.yaml`. +**2.** Rename the [buildConfig.template.yaml](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file in `instances/my-sourcegraph` to `buildConfig.yaml`. - The `buildConfig.yaml` file is used to configure components included in your `kustomization` file when required. @@ -214,7 +214,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](/admin/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/kustomize/#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/deploy/kubernetes/operations.mdx b/docs/self-hosted/deploy/kubernetes/operations.mdx index 1495fcdce..e67c5abb5 100644 --- a/docs/self-hosted/deploy/kubernetes/operations.mdx +++ b/docs/self-hosted/deploy/kubernetes/operations.mdx @@ -13,7 +13,7 @@ Operations guides specific to managing [Sourcegraph on Kubernetes](/self-hosted/ ## Featured guides -Trying to deploy Sourcegraph on Kubernetes? Refer to our [installation guide](/admin/deploy/kubernetes/#installation). +Trying to deploy Sourcegraph on Kubernetes? Refer to our [installation guide](/self-hosted/deploy/kubernetes/#installation). ## Configure diff --git a/docs/self-hosted/deploy/kubernetes/upgrade.mdx b/docs/self-hosted/deploy/kubernetes/upgrade.mdx index efb75e2a0..2d2f7671d 100644 --- a/docs/self-hosted/deploy/kubernetes/upgrade.mdx +++ b/docs/self-hosted/deploy/kubernetes/upgrade.mdx @@ -8,11 +8,11 @@ This guide is **not for use with Helm**. Please refer to the [Upgrading Sourcegr > > - **_Always consult the [release notes](/self-hosted/updates/kubernetes) for the versions your upgrade will pass over and end on._** > - _This guide assumes you have created a `release` branch following the [reference repositories docs](/self-hosted/deploy/repositories)_ -> - **\*please see our [cautionary note](/admin/updates/#best-practices) on upgrades**, if you have any concerns about running a multiversion upgrade, please reach out to us at [support@sourcegraph.com](mailto:support@sourcegraph.com) for advisement.\* +> - **\*please see our [cautionary note](/self-hosted/updates/#best-practices) on upgrades**, if you have any concerns about running a multiversion upgrade, please reach out to us at [support@sourcegraph.com](mailto:support@sourcegraph.com) for advisement.\* ## Standard upgrades -A [standard upgrade](/admin/updates/#upgrade-types) occurs between a Sourcegraph version and the minor or major version released immediately after it. If you would like to jump forward several versions, you must perform a [multi-version upgrade](#multi-version-upgrades) instead. +A [standard upgrade](/self-hosted/updates/#upgrade-types) occurs between a Sourcegraph version and the minor or major version released immediately after it. If you would like to jump forward several versions, you must perform a [multi-version upgrade](#multi-version-upgrades) instead. ### Upgrade with Kubernetes Kustomize @@ -76,14 +76,14 @@ $ kubectl get pods -o wide --watch ## Multi-version upgrades -> **⚠️ Attention:** please see our [cautionary note](/admin/updates/#best-practices) on upgrades, if you have any concerns about running a multiversion upgrade, please reach out to us at [support@sourcegraph.com](mailto:support@sourcegraph.com) for advisement. +> **⚠️ Attention:** please see our [cautionary note](/self-hosted/updates/#best-practices) on upgrades, if you have any concerns about running a multiversion upgrade, please reach out to us at [support@sourcegraph.com](mailto:support@sourcegraph.com) for advisement. To perform a multi-version upgrade via migrators [upgrade](/self-hosted/updates/migrator/migrator-operations#upgrade) command on a Sourcegraph instance deployed with our [kustomize repo](https://github.com/sourcegraph/deploy-sourcegraph-k8s) follow the procedure below: 1. **Check Upgrade Readiness**: - Check the [upgrade notes](/self-hosted/updates/kubernetes#kubernetes-upgrade-notes) for the version range you're passing through. - - Check the `Site Admin > Updates` page to determine [upgrade readiness](/admin/updates/#upgrade-readiness). + - Check the `Site Admin > Updates` page to determine [upgrade readiness](/self-hosted/updates/#upgrade-readiness). 2. **Pull and merge upstream changes**: diff --git a/docs/self-hosted/deploy/repositories.mdx b/docs/self-hosted/deploy/repositories.mdx index fd81e3af5..331e4ccb7 100644 --- a/docs/self-hosted/deploy/repositories.mdx +++ b/docs/self-hosted/deploy/repositories.mdx @@ -51,7 +51,7 @@ git clone https://github.com/SG_DEPLOY_GITHUB_USERNAME/$SG_PRIVATE_DEPLOY_REPO_N ### Step 4: Create a release branch -Create a `release` branch to track all of your customizations to Sourcegraph. This branch will be used to [upgrade Sourcegraph](/self-hosted/updates) and [install your Sourcegraph instance](/admin/deploy/#installation). +Create a `release` branch to track all of your customizations to Sourcegraph. This branch will be used to [upgrade Sourcegraph](/self-hosted/updates) and [install your Sourcegraph instance](/self-hosted/deploy/#installation). ```bash cd $SG_PRIVATE_DEPLOY_REPO_NAME diff --git a/docs/self-hosted/deployment_best_practices.mdx b/docs/self-hosted/deployment_best_practices.mdx index 79a496011..be7f99485 100644 --- a/docs/self-hosted/deployment_best_practices.mdx +++ b/docs/self-hosted/deployment_best_practices.mdx @@ -14,7 +14,7 @@ _To get a better idea of your resource requirements for your instance use our [r ## Deployment Best Practices -A comparison table of supported self-hosted deployment methodologies can be [found here](/admin/deploy/#deployment-types). +A comparison table of supported self-hosted deployment methodologies can be [found here](/self-hosted/deploy/#deployment-types). ### Kubernetes @@ -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](/admin/deploy/docker-compose/#requirements). -- Review the [configuration section](/admin/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/#requirements). +- 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/executors/deploy_executors_binary_offline.mdx b/docs/self-hosted/executors/deploy_executors_binary_offline.mdx index f4ce239bd..163e083d6 100644 --- a/docs/self-hosted/executors/deploy_executors_binary_offline.mdx +++ b/docs/self-hosted/executors/deploy_executors_binary_offline.mdx @@ -67,7 +67,7 @@ image `sourcegraph/batcheshelper` is available in the internal Docker Registry. ## Auto Indexing Auto Indexing requires images to be available in the internal Docker Registry. The images for languages can be found in -the [Code Navigation](/code-search/code-navigation) page. +the [Code Navigation](/code-navigation) page. Once the images are available in the internal Docker Registry, the `executor` can be configured to use the images by updating `codeIntelAutoIndexing.indexerMap` in the **Site configuration**. For example, diff --git a/docs/self-hosted/how-to/dirty_database.mdx b/docs/self-hosted/how-to/dirty_database.mdx index 9d032578b..f07870ad0 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), [docker-compose](/admin/deploy/docker-compose/#access-the-database), and [Sourcegraph single-container](/admin/deploy/docker-single-container/#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), [docker-compose](/self-hosted/deploy/docker-compose/#access-the-database), and [Sourcegraph single-container](/self-hosted/deploy/docker-single-container/#access-the-database) instances at these links. ## Steps to resolve diff --git a/docs/self-hosted/how-to/dirty_database_pre_3_37.mdx b/docs/self-hosted/how-to/dirty_database_pre_3_37.mdx index ac063d1d4..d6dcdd085 100644 --- a/docs/self-hosted/how-to/dirty_database_pre_3_37.mdx +++ b/docs/self-hosted/how-to/dirty_database_pre_3_37.mdx @@ -17,7 +17,7 @@ Resolving this error requires discovering which migration file failed to run, an - 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), [docker-compose](/self-hosted/deploy/docker-compose/operations#access-the-database), and [Sourcegraph single-container](/admin/deploy/docker-single-container/#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), [docker-compose](/self-hosted/deploy/docker-compose/operations#access-the-database), and [Sourcegraph single-container](/self-hosted/deploy/docker-single-container/#access-the-database) instances at these links. ## TL;DR Steps to resolve diff --git a/docs/self-hosted/how-to/postgres14-index-corruption.mdx b/docs/self-hosted/how-to/postgres14-index-corruption.mdx index 85ddeb45b..2c348381d 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](/admin/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/#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 d7e12eb67..f7781b2d1 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](/admin/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/#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/how-to/unfinished_migration.mdx b/docs/self-hosted/how-to/unfinished_migration.mdx index 1b566177c..abd5e86fb 100644 --- a/docs/self-hosted/how-to/unfinished_migration.mdx +++ b/docs/self-hosted/how-to/unfinished_migration.mdx @@ -15,11 +15,11 @@ ERROR: Unfinished migrations. Please revert Sourcegraph to the previous version ## Resolution -If you were performing a [standard upgrade](/admin/updates/#standard-upgrades) between two minor versions, then the suggested action is to perform an infrastructure rollback and continue running the previous instance version until the violating out-of-band migrations have completed. The progress of the migrations can be checked [in the UI](#checking-progress). Older versions of Sourcegraph may have performed schema migrations prior to this check, but a schema rollback should not be necessary as our database schemas are backwards-compatible with one minor version. +If you were performing a [standard upgrade](/self-hosted/updates/#standard-upgrades) between two minor versions, then the suggested action is to perform an infrastructure rollback and continue running the previous instance version until the violating out-of-band migrations have completed. The progress of the migrations can be checked [in the UI](#checking-progress). Older versions of Sourcegraph may have performed schema migrations prior to this check, but a schema rollback should not be necessary as our database schemas are backwards-compatible with one minor version. Alternatively to rolling back and waiting, the unfinished migrations can be run directly via the `migrator`. See the [command documentation](/self-hosted/updates/migrator/migrator-operations#run-out-of-band-migrations) for additional details. -[Multi-version upgrades](/admin/updates/#multi-version-upgrades) and downgrade operations ensure that the required out-of-band migrations have completed or finished rolling back. If this is not the case, contact support as it indicates a non-obvious error in your environment or a bug Sourcegraph's migration tooling. +[Multi-version upgrades](/self-hosted/updates/#multi-version-upgrades) and downgrade operations ensure that the required out-of-band migrations have completed or finished rolling back. If this is not the case, contact support as it indicates a non-obvious error in your environment or a bug Sourcegraph's migration tooling. As an emergency escape hatch, the environment variable `SRC_DISABLE_OOBMIGRATION_VALIDATION` can be set to `true` on the `frontend` and `worker` services to disable the startup check. This is not recommended as it may result in broken features or data loss. diff --git a/docs/self-hosted/observability/logs.mdx b/docs/self-hosted/observability/logs.mdx index b02fd0817..aefdf7e78 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](/admin/deploy/docker-compose/#set-environment-variables) and [server](/admin/deploy/docker-single-container/#environment-variables) deployments. +Learn more about how to apply these environment variables in [docker-compose](/self-hosted/deploy/docker-compose/#set-environment-variables) and [server](/self-hosted/deploy/docker-single-container/#environment-variables) deployments. ## Log format diff --git a/docs/self-hosted/observability/troubleshooting.mdx b/docs/self-hosted/observability/troubleshooting.mdx index 556d3b68d..d92d1d9b2 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](/admin/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 6e0c7ff74..bb7e8fe6a 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](/admin/deploy/docker-compose/#operations). +See [expose debug port in Docker Compose](/self-hosted/deploy/docker-compose/#operations). ### Sourcegraph with Kubernetes @@ -24,7 +24,7 @@ kubectl port-forward sourcegraph-frontend-xxxx 6060:6060 ### Single-container Sourcegraph -See [expose debug port in single-container Sourcegraph](/admin/deploy/docker-single-container/#expose-debug-port). +See [expose debug port in single-container Sourcegraph](/self-hosted/deploy/docker-single-container/#expose-debug-port). ## Generating profiling data diff --git a/docs/self-hosted/updates/automatic.mdx b/docs/self-hosted/updates/automatic.mdx index a33d96624..79e5abc80 100644 --- a/docs/self-hosted/updates/automatic.mdx +++ b/docs/self-hosted/updates/automatic.mdx @@ -5,7 +5,7 @@ From **Sourcegraph 5.1 and later**, multi-version upgrades can be performed **automatically** as if they were a standard upgrade for the same deployment type. Automatic multi-version upgrades take the following general form: 1. Determine if your instance is ready to Upgrade: - 1. Check your Sourcegraph instances `Site admin > Updates` page. ([more info](/admin/updates/#upgrade-readiness)) + 1. Check your Sourcegraph instances `Site admin > Updates` page. ([more info](/self-hosted/updates/#upgrade-readiness)) 2. Consult upgrade notes for your deployment type accross the range of your upgrade. ([Kubernetes](/self-hosted/updates/kubernetes), [Docker-compose](/self-hosted/updates/docker_compose), [Server](/self-hosted/updates/server)) 2. Merge the latest Sourcegraph release into your deployment manifests. 3. With upstream changes to your manifests merged, start the new instance. diff --git a/docs/self-hosted/updates/index.mdx b/docs/self-hosted/updates/index.mdx index f3bad845f..a534ed4de 100644 --- a/docs/self-hosted/updates/index.mdx +++ b/docs/self-hosted/updates/index.mdx @@ -126,8 +126,8 @@ If your instance has schema drift or unfinished oob migrations you may need to a - [Multiversion Upgrade Operations](/self-hosted/deploy/kubernetes#multi-version-upgrades) - [Upgrade Notes](/self-hosted/updates/kubernetes) - **Single-container Sourcegraph with Docker** - - [Standard Upgrade Operations](/admin/deploy/docker-single-container/#standard-upgrades) - - [Multiversion Upgrade Operations](/admin/deploy/docker-single-container/#multi-version-upgrades) + - [Standard Upgrade Operations](/self-hosted/deploy/docker-single-container/#standard-upgrades) + - [Multiversion Upgrade Operations](/self-hosted/deploy/docker-single-container/#multi-version-upgrades) - [Upgrade Notes](/self-hosted/updates/server) - [**Pure-docker custom deployments**](/self-hosted/updates/pure_docker) - [**Sourcegraph AWS AMI instances**](/self-hosted/deploy/machine-images/aws-ami#upgrade) diff --git a/docs/self-hosted/updates/kubernetes.mdx b/docs/self-hosted/updates/kubernetes.mdx index a9ef02d64..eb2496c21 100644 --- a/docs/self-hosted/updates/kubernetes.mdx +++ b/docs/self-hosted/updates/kubernetes.mdx @@ -175,7 +175,7 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgres #### Notes: -- This release adds a new `migrator` initContainer to the frontend deployment to run database migrations. Confirm the environment variables on this new container match your database settings. [Docs](/admin/deploy/kubernetes/#database-migrations) +- This release adds a new `migrator` initContainer to the frontend deployment to run database migrations. Confirm the environment variables on this new container match your database settings. [Docs](/self-hosted/deploy/kubernetes/#database-migrations) - **If performing a multiversion upgrade from an instance prior to this version see our [upgrading early versions documentation](/self-hosted/updates/migrator/upgrading-early-versions#before-v3370)** ## v3.35 ➔ v3.36 diff --git a/docs/self-hosted/updates/migrator/downgrading.mdx b/docs/self-hosted/updates/migrator/downgrading.mdx index a35ad2e1f..77ae206a3 100644 --- a/docs/self-hosted/updates/migrator/downgrading.mdx +++ b/docs/self-hosted/updates/migrator/downgrading.mdx @@ -48,7 +48,7 @@ $ ~/deploy-sourcegraph-docker/docker-compose/ v4.5.1* docker logs migrator ✅ Schema migrations complete ``` -Downgrade is run using a similar to procedure to a [multiversion upgrade](/admin/updates/#upgrades-index): +Downgrade is run using a similar to procedure to a [multiversion upgrade](/self-hosted/updates/#upgrades-index): - Services that connect to the databases must be disabled before running `downgrade` - Manifests must be reverted to the version you are downgrading to and reapplyed **after** the `downgrade` is complete. diff --git a/docs/self-hosted/updates/migrator/migrator-operations.mdx b/docs/self-hosted/updates/migrator/migrator-operations.mdx index ca290d41f..2bb180b17 100644 --- a/docs/self-hosted/updates/migrator/migrator-operations.mdx +++ b/docs/self-hosted/updates/migrator/migrator-operations.mdx @@ -21,14 +21,14 @@ To run a `migrator` command, follow the guide for your Sourcegraph distribution The `migrator` is a Sourcegraph service whose purpose is to managed the state of `pgsql`, `codeintel-db`, and `codeinsights-db` database schemas. -Whenever a `docker-compose` or `kubernetes` based deployment is started `migrator` is run with the default `up` command. In kubernetes as an [`initContainer`](https://github.com/sourcegraph/deploy-sourcegraph/blob/master/base/frontend/sourcegraph-frontend.Deployment.yaml#L30-L40), and in [docker-compose](https://github.com/sourcegraph/deploy-sourcegraph-docker/blob/master/docker-compose/docker-compose.yaml#L14-L53) as a `depends_on` of the `frontend`. `up` runs all necessary schema migrations in the case of a [standard upgrade](/admin/updates/#upgrade-types), and then exits. The `frontend` service will not start until `migrator` exits successfully. +Whenever a `docker-compose` or `kubernetes` based deployment is started `migrator` is run with the default `up` command. In kubernetes as an [`initContainer`](https://github.com/sourcegraph/deploy-sourcegraph/blob/master/base/frontend/sourcegraph-frontend.Deployment.yaml#L30-L40), and in [docker-compose](https://github.com/sourcegraph/deploy-sourcegraph-docker/blob/master/docker-compose/docker-compose.yaml#L14-L53) as a `depends_on` of the `frontend`. `up` runs all necessary schema migrations in the case of a [standard upgrade](/self-hosted/updates/#upgrade-types), and then exits. The `frontend` service will not start until `migrator` exits successfully. -`migrator` can also be used like a command line tool, accepting _command_ arguments with _flags_. The most common usage of `migrator` this way is to perform [multiversion upgrades](/admin/updates/#upgrade-types) with the [`upgrade`](#upgrade) command. Many other commands are also available. +`migrator` can also be used like a command line tool, accepting _command_ arguments with _flags_. The most common usage of `migrator` this way is to perform [multiversion upgrades](/self-hosted/updates/#upgrade-types) with the [`upgrade`](#upgrade) command. Many other commands are also available. Some notes on `migrator`: - The `migrator` service was introduced in `v3.37.0`. -- `migrator`'s `upgrade` command was introduced in `v4.0.0` and is intended to be used to upgrade versions as old as `3.20.x`. **Always check your deployment types [upgrade notes](/admin/updates/#upgrades-index) before a multiversion upgrade.** +- `migrator`'s `upgrade` command was introduced in `v4.0.0` and is intended to be used to upgrade versions as old as `3.20.x`. **Always check your deployment types [upgrade notes](/self-hosted/updates/#upgrades-index) before a multiversion upgrade.** - Commands such as `downgrade`, `drift`, `run-out-of-band-migrations`, and `upgrade`, all work against Sourcegraph versions as old as `v3.20.x`. ## Migrator environment variables @@ -70,7 +70,7 @@ The `migrator` service exposes the following commands: ### upgrade -The `upgrade` command performs database schema migrations and out-of-band migrations to rewrite existing instance data in-place into the shaped expected by a given target Sourcegraph version. This command is used by site-administrators to perform [multi-version upgrades](/admin/updates/#upgrade-types). +The `upgrade` command performs database schema migrations and out-of-band migrations to rewrite existing instance data in-place into the shaped expected by a given target Sourcegraph version. This command is used by site-administrators to perform [multi-version upgrades](/self-hosted/updates/#upgrade-types). ```sh upgrade \ @@ -218,7 +218,7 @@ up \ **Optional arguments**: - `--db`: The target schema(s) to modify. Comma-separated values are allowed. -- `--skip-upgrade-validation`: Skip asserting that the [standard upgrade policy](/admin/updates/#upgrade-types) is being followed. +- `--skip-upgrade-validation`: Skip asserting that the [standard upgrade policy](/self-hosted/updates/#upgrade-types) is being followed. - `--skip-oobmigration-validation`: Skip reading the progress of out-of-band migrations to assert completion of newly deprecated migrations. - `--ignore-single-dirty-log` and `--ignore-single-pending-log`: Re-attempt to apply the **next** migration that was marked as errored or as incomplete (respectively). See [how to troubleshoot a dirty database](/self-hosted/how-to/dirty_database#0-attempt-re-application). - `--unprivileged-only`: Controls behavior of schema migrations the presence of [privileged definitions](/self-hosted/how-to/privileged_migrations). diff --git a/docs/self-hosted/updates/migrator/upgrading-early-versions.mdx b/docs/self-hosted/updates/migrator/upgrading-early-versions.mdx index 95db419ff..8c748d3ab 100644 --- a/docs/self-hosted/updates/migrator/upgrading-early-versions.mdx +++ b/docs/self-hosted/updates/migrator/upgrading-early-versions.mdx @@ -5,7 +5,7 @@ This document provides advise on multiversion upgrades starting from `v4.0.0` an Reminders: - Except in the case of the `up` command, always run `migrator` commands with the most recent release image. -- Always refer to the [upgrade notes](/admin/updates/#upgrades-index) for the versions you'll pass over in the case of a multiversion upgrade. +- Always refer to the [upgrade notes](/self-hosted/updates/#upgrades-index) for the versions you'll pass over in the case of a multiversion upgrade. ## Before v4.0.0 diff --git a/docs/self-hosted/updates/pure_docker.mdx b/docs/self-hosted/updates/pure_docker.mdx index 2206a4ec0..78f98a549 100644 --- a/docs/self-hosted/updates/pure_docker.mdx +++ b/docs/self-hosted/updates/pure_docker.mdx @@ -3,7 +3,7 @@ This document describes the exact changes needed to update a [pure-Docker Sourcegraph cluster](https://github.com/sourcegraph/deploy-sourcegraph-docker). Each section comprehensively describes the changes needed in Docker images, environment variables, and added/removed services. **Always refer to this page before upgrading Sourcegraph,** as it comprehensively describes the steps needed to upgrade, and any manual migration steps you must perform. -1. Read our [update policy](/admin/updates/#update-policy) to learn about Sourcegraph updates. +1. Read our [update policy](/self-hosted/updates/#update-policy) to learn about Sourcegraph updates. 2. Find the relevant entry for your update in the update notes on this page. **If the notes indicate a patch release exists, target the highest one.** ## Unreleased diff --git a/docs/tutorials/index.mdx b/docs/tutorials/index.mdx index cc3e3e376..b260bc13e 100644 --- a/docs/tutorials/index.mdx +++ b/docs/tutorials/index.mdx @@ -71,11 +71,11 @@ Full [search query syntax](/code-search/queries). ### Code Navigation -| Topic | Content Type | Description | -| ----------------------------------------------------------------------------------------------------------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| [Introduction to Code Navigation](/code-navigation/) | Explanation | There are 2 types of code navigation that Sourcegraph supports: search-based and precise. | -| [Code Navigation Features](/code-navigation/features) | Explanation | An overview of Code Navigation features, such as "find references", "go to definition", and "find implementations". | -| [Code Navigation](https://www.loom.com/share/a354ee1d87524239a8322d4c9c3131e9?sid=ce08dd70-4489-4cdc-b067-d470a505ce41) | Tutorial (video) | Finding definitions and references, and an explanation of precise versus search-based [code navigation](/code-search/code-navigation). | +| Topic | Content Type | Description | +| ----------------------------------------------------------------------------------------------------------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------- | +| [Introduction to Code Navigation](/code-navigation/) | Explanation | There are 2 types of code navigation that Sourcegraph supports: search-based and precise. | +| [Code Navigation Features](/code-navigation/features) | Explanation | An overview of Code Navigation features, such as "find references", "go to definition", and "find implementations". | +| [Code Navigation](https://www.loom.com/share/a354ee1d87524239a8322d4c9c3131e9?sid=ce08dd70-4489-4cdc-b067-d470a505ce41) | Tutorial (video) | Finding definitions and references, and an explanation of precise versus search-based [code navigation](/code-navigation). | ## Code Insights From 58439a7177b8e06f1faa4bca412cf6e91af4e5b3 Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 21:54:12 +0100 Subject: [PATCH 11/21] Fix more link targets --- docs/admin/access_control/index.mdx | 2 +- docs/admin/auth/index.mdx | 2 +- docs/admin/code_hosts/aws_codecommit.mdx | 4 +- docs/admin/code_hosts/azuredevops.mdx | 6 +- docs/admin/code_hosts/bitbucket_cloud.mdx | 4 +- docs/admin/code_hosts/bitbucket_server.mdx | 10 +- docs/admin/code_hosts/gerrit.mdx | 4 +- docs/admin/code_hosts/gitlab.mdx | 8 +- docs/admin/code_hosts/gitolite.mdx | 4 +- docs/admin/code_hosts/index.mdx | 6 +- docs/admin/code_hosts/non-git.mdx | 2 +- docs/admin/code_hosts/other.mdx | 4 +- docs/admin/code_hosts/phabricator.mdx | 4 +- docs/admin/config/index.mdx | 4 +- docs/admin/executors/index.mdx | 2 +- docs/admin/index.mdx | 4 +- docs/admin/licensing.mdx | 2 +- docs/admin/permissions/index.mdx | 2 +- docs/admin/repo/add.mdx | 4 - docs/api/mcp/index.mdx | 98 ++++++++++--------- docs/batch-changes/index.mdx | 4 +- docs/code-navigation/auto_indexing.mdx | 2 +- .../precise_code_navigation.mdx | 2 +- .../search_based_code_navigation.mdx | 2 +- .../syntactic_code_navigation.mdx | 2 +- docs/code-search/index.mdx | 4 +- docs/code-search/types/search-jobs.mdx | 4 +- docs/code-search/types/symbol.mdx | 4 +- docs/code_insights/index.mdx | 4 +- docs/code_monitoring/index.mdx | 4 +- docs/deep-search/index.mdx | 6 +- docs/self-hosted/deploy/index.mdx | 9 +- docs/self-hosted/executors/index.mdx | 2 +- docs/self-hosted/index.mdx | 4 +- docs/self-hosted/observability/index.mdx | 2 +- docs/self-hosted/updates/index.mdx | 2 +- docs/tutorials/index.mdx | 2 +- 37 files changed, 133 insertions(+), 102 deletions(-) diff --git a/docs/admin/access_control/index.mdx b/docs/admin/access_control/index.mdx index f61d11d3f..4bc8c1ba2 100644 --- a/docs/admin/access_control/index.mdx +++ b/docs/admin/access_control/index.mdx @@ -1,7 +1,7 @@ # Access control - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. diff --git a/docs/admin/auth/index.mdx b/docs/admin/auth/index.mdx index 7633cdb2c..4d0a15bdc 100644 --- a/docs/admin/auth/index.mdx +++ b/docs/admin/auth/index.mdx @@ -1,7 +1,7 @@ # User authentication - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. diff --git a/docs/admin/code_hosts/aws_codecommit.mdx b/docs/admin/code_hosts/aws_codecommit.mdx index 150deb60c..4435bc901 100644 --- a/docs/admin/code_hosts/aws_codecommit.mdx +++ b/docs/admin/code_hosts/aws_codecommit.mdx @@ -1,7 +1,7 @@ # AWS CodeCommit - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. @@ -38,6 +38,7 @@ AWS CodeCommit connections support the following configuration options, which ar {/* SCHEMA_SYNC_START: admin/code_hosts/aws_codecommit.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} {/* Last updated: 2025-12-08T20:10:38Z via sourcegraph/sourcegraph@v6.11.0 */} + ```json { // REQUIRED: @@ -108,6 +109,7 @@ AWS CodeCommit connections support the following configuration options, which ar "secretAccessKey": null } ``` + {/* SCHEMA_SYNC_END: admin/code_hosts/aws_codecommit.schema.json */} ## Setup steps for SSH connections to AWS CodeCommit repositories diff --git a/docs/admin/code_hosts/azuredevops.mdx b/docs/admin/code_hosts/azuredevops.mdx index a48386446..f9983a2e1 100644 --- a/docs/admin/code_hosts/azuredevops.mdx +++ b/docs/admin/code_hosts/azuredevops.mdx @@ -1,7 +1,7 @@ # Azure DevOps - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. @@ -66,8 +66,9 @@ Azure DevOps connections support the following configuration options, which are {/* SCHEMA_SYNC_START: admin/code_hosts/azuredevops.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} {/* Last updated: 2025-12-08T20:10:37Z via sourcegraph/sourcegraph@v6.11.0 */} + ```json - // Authentication alternatives: token OR windowsPassword +// Authentication alternatives: token OR windowsPassword { // A flag to enforce Azure DevOps repository access permissions @@ -161,6 +162,7 @@ Azure DevOps connections support the following configuration options, which are "windowsPassword": null } ``` + {/* SCHEMA_SYNC_END: admin/code_hosts/azuredevops.schema.json */} ## Webhooks diff --git a/docs/admin/code_hosts/bitbucket_cloud.mdx b/docs/admin/code_hosts/bitbucket_cloud.mdx index 5cbd0f8d1..80b2f2cec 100644 --- a/docs/admin/code_hosts/bitbucket_cloud.mdx +++ b/docs/admin/code_hosts/bitbucket_cloud.mdx @@ -1,7 +1,7 @@ # Bitbucket Cloud - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. @@ -117,6 +117,7 @@ Bitbucket Cloud connections support the following configuration options, which a {/* SCHEMA_SYNC_START: admin/code_hosts/bitbucket_cloud.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} {/* Last updated: 2025-12-08T20:10:36Z via sourcegraph/sourcegraph@v6.11.0 */} + ```json { // The workspace access token to use when authenticating with Bitbucket Cloud. @@ -226,6 +227,7 @@ Bitbucket Cloud connections support the following configuration options, which a "webhookSecret": null } ``` + {/* SCHEMA_SYNC_END: admin/code_hosts/bitbucket_cloud.schema.json */} ## Webhooks diff --git a/docs/admin/code_hosts/bitbucket_server.mdx b/docs/admin/code_hosts/bitbucket_server.mdx index b0e61ea25..45434a032 100644 --- a/docs/admin/code_hosts/bitbucket_server.mdx +++ b/docs/admin/code_hosts/bitbucket_server.mdx @@ -1,7 +1,7 @@ # Bitbucket Server/Bitbucket Data Center - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. @@ -203,8 +203,9 @@ Bitbucket Server / Bitbucket Data Center connections support the following confi {/* SCHEMA_SYNC_START: admin/code_hosts/bitbucket_server.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} {/* Last updated: 2025-12-08T20:10:35Z via sourcegraph/sourcegraph@v6.11.0 */} + ```json - // Authentication alternatives: token OR password +// Authentication alternatives: token OR password { // If non-null, enforces Bitbucket Server / Bitbucket Data Center repository permissions. @@ -318,9 +319,7 @@ Bitbucket Server / Bitbucket Data Center connections support the following confi // - [ // "?name=my-repo\u0026projectname=PROJECT\u0026visibility=private" // ] - "repositoryQuery": [ - "none" - ], + "repositoryQuery": ["none"], // A Bitbucket Server / Bitbucket Data Center personal access token with Read permissions. When using batch changes, the token needs Write permissions. Create one at https://[your-bitbucket-hostname]/plugins/servlet/access-tokens/add. Also set the corresponding "username" field. // For Bitbucket Server / Bitbucket Data Center instances that don't support personal access tokens (Bitbucket Server / Bitbucket Data Center version 5.4 and older), specify user-password credentials in the "username" and "password" fields. @@ -342,4 +341,5 @@ Bitbucket Server / Bitbucket Data Center connections support the following confi } } ``` + {/* SCHEMA_SYNC_END: admin/code_hosts/bitbucket_server.schema.json */} diff --git a/docs/admin/code_hosts/gerrit.mdx b/docs/admin/code_hosts/gerrit.mdx index fd5cdb2b9..007b3e1be 100644 --- a/docs/admin/code_hosts/gerrit.mdx +++ b/docs/admin/code_hosts/gerrit.mdx @@ -1,7 +1,7 @@ # Gerrit - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. @@ -114,6 +114,7 @@ Gerrit connections support the following configuration options, which are specif {/* SCHEMA_SYNC_START: admin/code_hosts/gerrit.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} {/* Last updated: 2025-12-08T20:10:40Z via sourcegraph/sourcegraph@v6.11.0 */} + ```json { // If non-null, enforces Gerrit repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site_config#auth-providers) `auth.providers` field, of type "gerrit" with the same `url` field as specified in this `GerritConnection`. @@ -186,4 +187,5 @@ Gerrit connections support the following configuration options, which are specif "username": null } ``` + {/* SCHEMA_SYNC_END: admin/code_hosts/gerrit.schema.json */} diff --git a/docs/admin/code_hosts/gitlab.mdx b/docs/admin/code_hosts/gitlab.mdx index a5e6b0c0d..c38c7bec6 100644 --- a/docs/admin/code_hosts/gitlab.mdx +++ b/docs/admin/code_hosts/gitlab.mdx @@ -2,7 +2,7 @@ Supported on Sourcegraph [Free](/pricing/free) and - [Enterprise](/pricing/enterprise) plans. + [Enterprise](/pricing/plans/enterprise) plans. Site admins can sync Git repositories hosted on [GitLab](https://gitlab.com) (GitLab.com and GitLab CE/EE) with Sourcegraph so that users can search and navigate the repositories. @@ -190,6 +190,7 @@ See [Internal rate limits](/admin/code_hosts/rate_limits#internal-rate-limits). {/* SCHEMA_SYNC_START: admin/code_hosts/gitlab.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} {/* Last updated: 2025-12-08T20:10:34Z via sourcegraph/sourcegraph@v6.11.0 */} + ```json { // If non-null, enforces GitLab repository permissions. This requires that there be an item in the `auth.providers` field of type "gitlab" with the same `url` field as specified in this `GitLabConnection`. @@ -267,9 +268,7 @@ See [Internal rate limits](/admin/code_hosts/rate_limits#internal-rate-limits). // "?membership=true\u0026search=foo", // "groups/mygroup/projects" // ] - "projectQuery": [ - "none" - ], + "projectQuery": ["none"], // A list of projects to mirror from this GitLab instance. Supports including by name ({"name": "group/name"}) or by ID ({"id": 42}). // Other example values: @@ -328,6 +327,7 @@ See [Internal rate limits](/admin/code_hosts/rate_limits#internal-rate-limits). "webhooks": null } ``` + {/* SCHEMA_SYNC_END: admin/code_hosts/gitlab.schema.json */} ## Native integration diff --git a/docs/admin/code_hosts/gitolite.mdx b/docs/admin/code_hosts/gitolite.mdx index e5ba78783..3d5b1be21 100644 --- a/docs/admin/code_hosts/gitolite.mdx +++ b/docs/admin/code_hosts/gitolite.mdx @@ -1,7 +1,7 @@ # Gitolite - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. @@ -26,6 +26,7 @@ To connect Gitolite to Sourcegraph: {/* SCHEMA_SYNC_START: admin/code_hosts/gitolite.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} {/* Last updated: 2025-12-08T20:10:41Z via sourcegraph/sourcegraph@v6.11.0 */} + ```json { // A list of repositories to never mirror from this Gitolite instance. Supports excluding by exact name ({"name": "foo"}). @@ -72,4 +73,5 @@ To connect Gitolite to Sourcegraph: "prefix": null } ``` + {/* SCHEMA_SYNC_END: admin/code_hosts/gitolite.schema.json */} diff --git a/docs/admin/code_hosts/index.mdx b/docs/admin/code_hosts/index.mdx index ff07272b6..e6edce526 100644 --- a/docs/admin/code_hosts/index.mdx +++ b/docs/admin/code_hosts/index.mdx @@ -1,9 +1,9 @@ # Code host connections - [Enterprise Starter](/pricing/enterprise-starter) only supports GitHub.com, - GitLab.com, and Bitbucket.org. [Enterprise](/pricing/enterprise) supports - all listed code hosts. + [Enterprise Starter](/pricing/plans/enterprise-starter) only supports + GitHub.com, GitLab.com, and Bitbucket.org. + [Enterprise](/pricing/plans/enterprise) supports all listed code hosts. Available via the Web app. diff --git a/docs/admin/code_hosts/non-git.mdx b/docs/admin/code_hosts/non-git.mdx index c94428627..d64f5b1cc 100644 --- a/docs/admin/code_hosts/non-git.mdx +++ b/docs/admin/code_hosts/non-git.mdx @@ -1,7 +1,7 @@ # Non-Git code hosts (Perforce, Mercurial, Subversion, raw text, etc.) - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. diff --git a/docs/admin/code_hosts/other.mdx b/docs/admin/code_hosts/other.mdx index 5b300145f..283cd5040 100644 --- a/docs/admin/code_hosts/other.mdx +++ b/docs/admin/code_hosts/other.mdx @@ -1,7 +1,7 @@ # Other Git repository hosts - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. @@ -69,6 +69,7 @@ Repositories must be listed individually: {/* SCHEMA_SYNC_START: admin/code_hosts/other_external_service.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} {/* Last updated: 2025-12-08T20:10:42Z via sourcegraph/sourcegraph@v6.11.0 */} + ```json { // A list of repositories to never mirror by name after applying repositoryPathPattern. Supports excluding by exact name ({"name": "myrepo"}) or regular expression ({"pattern": ".*secret.*"}). @@ -110,4 +111,5 @@ Repositories must be listed individually: "url": null } ``` + {/* SCHEMA_SYNC_END: admin/code_hosts/other_external_service.schema.json */} diff --git a/docs/admin/code_hosts/phabricator.mdx b/docs/admin/code_hosts/phabricator.mdx index 0d343effc..18a92ba73 100644 --- a/docs/admin/code_hosts/phabricator.mdx +++ b/docs/admin/code_hosts/phabricator.mdx @@ -1,7 +1,7 @@ # Phabricator - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. @@ -77,6 +77,7 @@ The Sourcegraph instance's site admin must [update the `corsOrigin` site config {/* SCHEMA_SYNC_START: admin/code_hosts/phabricator.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} {/* Last updated: 2025-12-08T20:10:41Z via sourcegraph/sourcegraph@v6.11.0 */} + ```json { // SSH cipher to use when cloning via SSH. Must be a valid choice from `ssh -Q cipher`. @@ -101,4 +102,5 @@ The Sourcegraph instance's site admin must [update the `corsOrigin` site config "url": null } ``` + {/* SCHEMA_SYNC_END: admin/code_hosts/phabricator.schema.json */} diff --git a/docs/admin/config/index.mdx b/docs/admin/config/index.mdx index cadab3141..8aba0448f 100644 --- a/docs/admin/config/index.mdx +++ b/docs/admin/config/index.mdx @@ -1,6 +1,8 @@ # Configuring Sourcegraph -Supported on [Enterprise](/pricing/enterprise) plans. + + Supported on [Enterprise](/pricing/plans/enterprise) plans. + - [Site configuration](/admin/config/site_config) - [Global and user settings](/admin/config/settings) diff --git a/docs/admin/executors/index.mdx b/docs/admin/executors/index.mdx index cc8708261..f057a0493 100644 --- a/docs/admin/executors/index.mdx +++ b/docs/admin/executors/index.mdx @@ -1,7 +1,7 @@ # Executors - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. diff --git a/docs/admin/index.mdx b/docs/admin/index.mdx index 72a9abcf4..927d1bac6 100644 --- a/docs/admin/index.mdx +++ b/docs/admin/index.mdx @@ -1,6 +1,8 @@ # Administration -Supported on [Enterprise](/pricing/enterprise) plans. + + Supported on [Enterprise](/pricing/plans/enterprise) plans. + Sourcegraph administration is primarily managed by site administrators, who are responsible for the configuration of Sourcegraph instances for end users. For a comprehensive introduction to site administration, refer to our [quickstart guide](/admin/how-to/site-admin-quickstart). diff --git a/docs/admin/licensing.mdx b/docs/admin/licensing.mdx index 4715bf4c9..6512845b5 100644 --- a/docs/admin/licensing.mdx +++ b/docs/admin/licensing.mdx @@ -1,7 +1,7 @@ # Licensing - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. diff --git a/docs/admin/permissions/index.mdx b/docs/admin/permissions/index.mdx index 3609c3f03..2b262b1d8 100644 --- a/docs/admin/permissions/index.mdx +++ b/docs/admin/permissions/index.mdx @@ -1,7 +1,7 @@ # Permissions - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. diff --git a/docs/admin/repo/add.mdx b/docs/admin/repo/add.mdx index d1cebb49c..0f1d8aa93 100644 --- a/docs/admin/repo/add.mdx +++ b/docs/admin/repo/add.mdx @@ -10,10 +10,6 @@ - [Add repositories by Git clone URLs](/admin/code_hosts/other) - [Add repositories from non-Git code hosts](/admin/code_hosts/non-git) - [Add Perforce repositories](/admin/repo/perforce) - - [Add JVM dependencies](/admin/code_hosts/jvm) - - [Add Go dependencies](/admin/code_hosts/go) - - [Add npm dependencies](/admin/code_hosts/npm) - - [Add Python dependencies](/admin/code_hosts/python) - [Pre-load repositories from the local disk](/admin/repo/pre_load_from_local_disk) ## Troubleshooting diff --git a/docs/api/mcp/index.mdx b/docs/api/mcp/index.mdx index 121407b4e..9c8e133fb 100644 --- a/docs/api/mcp/index.mdx +++ b/docs/api/mcp/index.mdx @@ -5,7 +5,9 @@ search and analysis capabilities.

-Supported on [Enterprise](/pricing/enterprise) plans. + + Supported on [Enterprise](/pricing/plans/enterprise) plans. + This feature is @@ -302,11 +304,11 @@ Read file contents with line numbers and support for specific ranges and revisio **Parameters:** -- `repo` - Repository name (required) -- `path` - File path within repository (required) -- `startLine` - Starting line number (optional) -- `endLine` - Ending line number (optional) -- `revision` - Branch, tag, or commit hash (optional) +- `repo` - Repository name (required) +- `path` - File path within repository (required) +- `startLine` - Starting line number (optional) +- `endLine` - Ending line number (optional) +- `revision` - Branch, tag, or commit hash (optional) **Use cases:** Reading specific files, examining code sections, reviewing different versions @@ -320,9 +322,9 @@ List files and directories in a repository path. **Parameters:** -- `repo` - Repository name (required) -- `path` - Directory path (optional, defaults to root) -- `revision` - Branch, tag, or commit hash (optional) +- `repo` - Repository name (required) +- `path` - Directory path (optional, defaults to root) +- `revision` - Branch, tag, or commit hash (optional) #### `sg_list_repos` @@ -330,9 +332,9 @@ Search and list repositories by name patterns with pagination support. **Parameters:** -- `query` - Search pattern for repository names (required) -- `limit` - Maximum results per page (optional, default 50) -- `after`/`before` - Pagination cursors (optional) +- `query` - Search pattern for repository names (required) +- `limit` - Maximum results per page (optional, default 50) +- `after`/`before` - Pagination cursors (optional) ### Code Search @@ -342,13 +344,13 @@ Perform exact keyword searches with boolean operators and filters. **Parameters:** -- `query` - Search query with optional filters (required) +- `query` - Search query with optional filters (required) **Supported filters:** -- `repo:` - limit to specific repositories -- `file:` - search specific file patterns -- `rev:` - search specific revisions +- `repo:` - limit to specific repositories +- `file:` - search specific file patterns +- `rev:` - search specific revisions **Features:** Boolean AND/OR operators, regex patterns @@ -358,13 +360,13 @@ Semantic search with flexible linguistic matching. **Parameters:** -- `query` - Natural language search query (required) +- `query` - Natural language search query (required) **Supported filters:** -- `repo:` - limit to specific repositories -- `file:` - search specific file patterns -- `rev:` - search specific revisions +- `repo:` - limit to specific repositories +- `file:` - search specific file patterns +- `rev:` - search specific revisions **Features:** Flexible linguistic matching, stemming, broader results than keyword search @@ -376,10 +378,10 @@ Find the definition of a symbol from a usage location. **Parameters:** -- `repo` - Repository name (required) -- `path` - File path containing symbol usage (required) -- `symbol` - Symbol name to find definition for (required) -- `revision` - Branch, tag, or commit hash (optional) +- `repo` - Repository name (required) +- `path` - File path containing symbol usage (required) +- `symbol` - Symbol name to find definition for (required) +- `revision` - Branch, tag, or commit hash (optional) **Features:** Cross-repository support, compiler-level accuracy @@ -389,10 +391,10 @@ Find all references to a symbol from its definition location. **Parameters:** -- `repo` - Repository name (required) -- `path` - File path containing symbol definition (required) -- `symbol` - Symbol name to find references for (required) -- `revision` - Branch, tag, or commit hash (optional) +- `repo` - Repository name (required) +- `path` - File path containing symbol definition (required) +- `symbol` - Symbol name to find references for (required) +- `revision` - Branch, tag, or commit hash (optional) ### Version Control & History @@ -402,12 +404,12 @@ Search commits by message, author, content, files, and date ranges. **Parameters:** -- `repos` - Array of repository names (required) -- `messageTerms` - Terms to search in commit messages (optional) -- `authors` - Filter by commit authors (optional) -- `contentTerms` - Search in actual code changes (optional) -- `files` - Filter by file paths (optional) -- `after`/`before` - Date range filters (optional) +- `repos` - Array of repository names (required) +- `messageTerms` - Terms to search in commit messages (optional) +- `authors` - Filter by commit authors (optional) +- `contentTerms` - Search in actual code changes (optional) +- `files` - Filter by file paths (optional) +- `after`/`before` - Date range filters (optional) #### `sg_diff_search` @@ -415,12 +417,12 @@ Search actual code changes for specific patterns across repositories. **Parameters:** -- `pattern` - Search pattern for code changes (required) -- `repos` - Array of repository names (required) -- `added` - Search only added code (optional) -- `removed` - Search only removed code (optional) -- `author` - Filter by author (optional) -- `after`/`before` - Date range filters (optional) +- `pattern` - Search pattern for code changes (required) +- `repos` - Array of repository names (required) +- `added` - Search only added code (optional) +- `removed` - Search only removed code (optional) +- `author` - Filter by author (optional) +- `after`/`before` - Date range filters (optional) #### `sg_compare_revisions` @@ -428,11 +430,11 @@ Compare changes between two specific revisions. **Parameters:** -- `repo` - Repository name (required) -- `base` - Base revision (older version) (required) -- `head` - Head revision (newer version) (required) -- `first` - Maximum file diffs to return (optional, default 50) -- `after` - Pagination cursor (optional) +- `repo` - Repository name (required) +- `base` - Base revision (older version) (required) +- `head` - Head revision (newer version) (required) +- `first` - Maximum file diffs to return (optional, default 50) +- `after` - Pagination cursor (optional) #### `sg_get_contributor_repos` @@ -440,9 +442,9 @@ Find repositories where a contributor has made commits. **Parameters:** -- `author` - Author name or email (required) -- `limit` - Maximum repositories to return (optional, default 20) -- `minCommits` - Minimum commits required (optional, default 1) +- `author` - Author name or email (required) +- `limit` - Maximum repositories to return (optional, default 20) +- `minCommits` - Minimum commits required (optional, default 1) ## Usage Examples diff --git a/docs/batch-changes/index.mdx b/docs/batch-changes/index.mdx index 58b0ad69e..474ab8e57 100644 --- a/docs/batch-changes/index.mdx +++ b/docs/batch-changes/index.mdx @@ -1,6 +1,8 @@ # Batch Changes -Supported on [Enterprise](/pricing/enterprise) plans. + + Supported on [Enterprise](/pricing/plans/enterprise) plans. +

This section is about Batch Changes, which helps you automate and ship diff --git a/docs/code-navigation/auto_indexing.mdx b/docs/code-navigation/auto_indexing.mdx index 542014704..39865c9ed 100644 --- a/docs/code-navigation/auto_indexing.mdx +++ b/docs/code-navigation/auto_indexing.mdx @@ -1,7 +1,7 @@ # Auto-indexing - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Currently in Beta and available via Web app. diff --git a/docs/code-navigation/precise_code_navigation.mdx b/docs/code-navigation/precise_code_navigation.mdx index 19c47ade9..0f9245940 100644 --- a/docs/code-navigation/precise_code_navigation.mdx +++ b/docs/code-navigation/precise_code_navigation.mdx @@ -1,7 +1,7 @@ # Precise Code Navigation - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. diff --git a/docs/code-navigation/search_based_code_navigation.mdx b/docs/code-navigation/search_based_code_navigation.mdx index 358863567..3cb865a80 100644 --- a/docs/code-navigation/search_based_code_navigation.mdx +++ b/docs/code-navigation/search_based_code_navigation.mdx @@ -1,7 +1,7 @@ # Search-based Code Navigation - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via VS Code and JetBrains editor extensions and the Web. diff --git a/docs/code-navigation/syntactic_code_navigation.mdx b/docs/code-navigation/syntactic_code_navigation.mdx index 8f7c9a422..79860ce8b 100644 --- a/docs/code-navigation/syntactic_code_navigation.mdx +++ b/docs/code-navigation/syntactic_code_navigation.mdx @@ -1,7 +1,7 @@ # Syntactic Code Navigation - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. This feature is currently in Beta and enabled by default for Cloud customers diff --git a/docs/code-search/index.mdx b/docs/code-search/index.mdx index b5839c178..d01758f74 100644 --- a/docs/code-search/index.mdx +++ b/docs/code-search/index.mdx @@ -1,8 +1,8 @@ # Code Search - Supported on [Enterprise Starter](/pricing/enterprise-starter) and - [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise Starter](/pricing/plans/enterprise-starter) and + [Enterprise](/pricing/plans/enterprise) plans. Available via VS Code and JetBrains editor extensions and the Web. diff --git a/docs/code-search/types/search-jobs.mdx b/docs/code-search/types/search-jobs.mdx index c2ef7c98a..8e72ae086 100644 --- a/docs/code-search/types/search-jobs.mdx +++ b/docs/code-search/types/search-jobs.mdx @@ -1,6 +1,8 @@ # Search Jobs -Supported on [Enterprise](/pricing/enterprise) plans. + + Supported on [Enterprise](/pricing/plans/enterprise) plans. + Use Search Jobs to search code at scale for large-scale organizations. diff --git a/docs/code-search/types/symbol.mdx b/docs/code-search/types/symbol.mdx index 6a0b18a1f..6930c1886 100644 --- a/docs/code-search/types/symbol.mdx +++ b/docs/code-search/types/symbol.mdx @@ -1,8 +1,8 @@ # Symbol search - Supported on [Enterprise Starter](/pricing/enterprise-starter) and - [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise Starter](/pricing/plans/enterprise-starter) and + [Enterprise](/pricing/plans/enterprise) plans. Available via VS Code and JetBrains editor extensions and the Web. diff --git a/docs/code_insights/index.mdx b/docs/code_insights/index.mdx index a8b2feaed..2e843c436 100644 --- a/docs/code_insights/index.mdx +++ b/docs/code_insights/index.mdx @@ -1,6 +1,8 @@ # Code Insights -Supported on [Enterprise](/pricing/enterprise) plans. + + Supported on [Enterprise](/pricing/plans/enterprise) plans. +

Anything you can search, you can track and analyze

diff --git a/docs/code_monitoring/index.mdx b/docs/code_monitoring/index.mdx index b9df568ef..fb546a0f0 100644 --- a/docs/code_monitoring/index.mdx +++ b/docs/code_monitoring/index.mdx @@ -1,6 +1,8 @@ # Code monitoring -Supported on [Enterprise](/pricing/enterprise) plans. + + Supported on [Enterprise](/pricing/plans/enterprise) plans. +

Keep on top of events in your codebase. Watch your code with code monitors diff --git a/docs/deep-search/index.mdx b/docs/deep-search/index.mdx index be1e9b803..196a35576 100644 --- a/docs/deep-search/index.mdx +++ b/docs/deep-search/index.mdx @@ -1,9 +1,9 @@ # Deep Search - Supported on [Enterprise Starter](/pricing/enterprise-starter) and - [Enterprise](/pricing/enterprise) plans. It's not supported for BYOK users. - Please reach out to your Sourcegraph account team to request access. + Supported on [Enterprise Starter](/pricing/plans/enterprise-starter) and + [Enterprise](/pricing/plans/enterprise) plans. It's not supported for BYOK + users. Please reach out to your Sourcegraph account team to request access. Available on the Web. diff --git a/docs/self-hosted/deploy/index.mdx b/docs/self-hosted/deploy/index.mdx index 900065898..e65e3a59e 100644 --- a/docs/self-hosted/deploy/index.mdx +++ b/docs/self-hosted/deploy/index.mdx @@ -1,7 +1,7 @@ # Deployment Overview - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. @@ -26,6 +26,7 @@ Best for a wide range of customers open to a Sourcegraph managed [Sourcegraph Cl {' '} + - + - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. diff --git a/docs/self-hosted/index.mdx b/docs/self-hosted/index.mdx index a1219c4ed..051ebd0ca 100644 --- a/docs/self-hosted/index.mdx +++ b/docs/self-hosted/index.mdx @@ -1,6 +1,8 @@ # Enterprise Self-Hosted -Supported on [Enterprise](/pricing/enterprise) plans. + + Supported on [Enterprise](/pricing/plans/enterprise) plans. + This section of the documentation is meant for Sourcegraph enterprise self-hosted users. diff --git a/docs/self-hosted/observability/index.mdx b/docs/self-hosted/observability/index.mdx index 08605176f..fcce0b116 100644 --- a/docs/self-hosted/observability/index.mdx +++ b/docs/self-hosted/observability/index.mdx @@ -1,7 +1,7 @@ # Observability - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. diff --git a/docs/self-hosted/updates/index.mdx b/docs/self-hosted/updates/index.mdx index a534ed4de..23a2409e3 100644 --- a/docs/self-hosted/updates/index.mdx +++ b/docs/self-hosted/updates/index.mdx @@ -1,7 +1,7 @@ # Updating Sourcegraph - Supported on [Enterprise](/pricing/enterprise) plans. + Supported on [Enterprise](/pricing/plans/enterprise) plans. Available via the Web app. diff --git a/docs/tutorials/index.mdx b/docs/tutorials/index.mdx index b260bc13e..c57f4d10f 100644 --- a/docs/tutorials/index.mdx +++ b/docs/tutorials/index.mdx @@ -46,7 +46,7 @@ Full [search query syntax](/code-search/queries). | [Intro to Search Filters](https://www.loom.com/share/f48295092e7f4a9b874bfd8f81595a87?sid=dd05c740-be70-4374-b890-219a48c8d9f2) | Tutorial (video) | An overview of the most commonly-used search filters such as Language, Repo, and File. | | [Search Types](https://www.loom.com/share/2484f5b47fec47c68369399a26a18150?sid=52b5df3f-35d4-4ea0-b009-cd64946d1d38) | Tutorial (video) | Searching against Code, Repo, Path, Symbol, Commit, and Diff data. | | [Saving Searches](https://www.loom.com/share/5728c5fc9ac14a11aa9ca875c6eaa406?sid=eb6112d7-5f3e-45fb-ae89-a990355f0ab8) | Tutorial (video) | [Saving](/code-search/working/saved_searches) commonly-used searches. | -| [Search Contexts](https://www.loom.com/share/0b2ebb0a96154a87bad3c3c451f2ffcd?sid=dd211b02-6d7b-4c52-86fd-bebccc4a63d9) | Tutorial (video) | Intro to [Search Contexts](/code-search/working/search_contexts.mdx) and how to manage them. | +| [Search Contexts](https://www.loom.com/share/0b2ebb0a96154a87bad3c3c451f2ffcd?sid=dd211b02-6d7b-4c52-86fd-bebccc4a63d9) | Tutorial (video) | Intro to [Search Contexts](/code-search/working/search_contexts) and how to manage them. | ### Advanced Searching From dac309b5f2fe71e1e4fa6173edcc8ea3aedb9eee Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 22:16:00 +0100 Subject: [PATCH 12/21] Fix more dead links --- docs/admin/audit_log.mdx | 2 +- docs/admin/code_hosts/gitlab.mdx | 2 +- docs/admin/index.mdx | 2 +- docs/admin/webhooks/incoming.mdx | 2 +- docs/api/mcp/index.mdx | 2 +- docs/cli/how-tos/fetch_sboms.mdx | 4 +-- .../how-tos/verify_container_signatures.mdx | 4 +-- docs/cli/references/index.mdx | 2 -- docs/code-navigation/how-to/index.mdx | 2 +- .../how-to/index_other_languages.mdx | 2 +- docs/code-navigation/index.mdx | 12 ++++----- .../precise_code_navigation.mdx | 4 +-- docs/code-search/types/search-jobs.mdx | 2 +- docs/cody/capabilities/chat.mdx | 4 +-- docs/cody/capabilities/index.mdx | 2 +- docs/cody/clients/cody-with-sourcegraph.mdx | 6 ++--- docs/cody/clients/install-jetbrains.mdx | 6 ++--- docs/cody/clients/install-visual-studio.mdx | 2 +- docs/cody/clients/install-vscode.mdx | 4 +-- docs/cody/core-concepts/context.mdx | 2 +- docs/cody/faq.mdx | 2 +- docs/cody/index.mdx | 2 +- docs/cody/prompts-guide.mdx | 2 +- docs/cody/quickstart.mdx | 2 +- docs/cody/use-cases/vsc-tutorial.mdx | 2 +- docs/getting-started/index.mdx | 2 +- docs/integration/go.mdx | 27 ------------------- docs/pricing/plans/enterprise-starter.mdx | 2 +- .../deploy/docker-compose/index.mdx | 2 +- .../deploy/docker-compose/upgrade.mdx | 2 +- docs/self-hosted/deploy/kubernetes/index.mdx | 2 +- .../deploy/machine-images/aws-ami.mdx | 2 +- .../deploy/machine-images/aws-oneclick.mdx | 2 +- .../self-hosted/deploy/machine-images/gce.mdx | 2 +- docs/self-hosted/how-to/index.mdx | 2 +- .../rebuild-corrupt-postgres-indexes.mdx | 2 +- docs/self-hosted/how-to/redis_configmap.mdx | 4 +-- .../upgrade-postgres-12-16-builtin-dbs.mdx | 2 +- docs/self-hosted/index.mdx | 2 +- docs/self-hosted/private-network.mdx | 18 ++++++------- 40 files changed, 61 insertions(+), 90 deletions(-) delete mode 100644 docs/integration/go.mdx diff --git a/docs/admin/audit_log.mdx b/docs/admin/audit_log.mdx index 50d11965c..82d6574a6 100644 --- a/docs/admin/audit_log.mdx +++ b/docs/admin/audit_log.mdx @@ -135,7 +135,7 @@ Audit logs are structured logs delivered as JSON to STDERR. As long as one can i ### Log Output -All audit logs are delivered to **STDERR** for each individual [component](./deploy/scale.mdx#core-components). +All audit logs are delivered to **STDERR** for each individual [component](/self-hosted/deploy/kubernetes/scale#core-components). ### Filtering Audit Logs diff --git a/docs/admin/code_hosts/gitlab.mdx b/docs/admin/code_hosts/gitlab.mdx index c38c7bec6..520c4ca37 100644 --- a/docs/admin/code_hosts/gitlab.mdx +++ b/docs/admin/code_hosts/gitlab.mdx @@ -1,7 +1,7 @@ # GitLab - Supported on Sourcegraph [Free](/pricing/free) and + Supported on Sourcegraph [Free](/pricing/plans/free) and [Enterprise](/pricing/plans/enterprise) plans. diff --git a/docs/admin/index.mdx b/docs/admin/index.mdx index 927d1bac6..f0159d9bb 100644 --- a/docs/admin/index.mdx +++ b/docs/admin/index.mdx @@ -32,4 +32,4 @@ Sourcegraph administration is primarily managed by site administrators, who are - [Access control](/admin/access_control/) (Beta) - [Repository permissions](/admin/permissions/) - [Batch Changes](/batch-changes/site-admin-configuration) -- [Configure webhooks](/admin/config/webhooks/) +- [Configure webhooks](/admin/webhooks/) diff --git a/docs/admin/webhooks/incoming.mdx b/docs/admin/webhooks/incoming.mdx index 3121c8a12..87b2849ca 100644 --- a/docs/admin/webhooks/incoming.mdx +++ b/docs/admin/webhooks/incoming.mdx @@ -10,7 +10,7 @@ Webhooks currently serve three purposes for reacting to external events: See the table below for code host compatibility: - Code host | Code push | [Batch changes](/batch_changes) | User permissions + Code host | Code push | [Batch changes](/batch-changes) | User permissions ----------------------------- | :----------------------------------------------: | :-------: | :--------------: GitHub | 🟢 | 🟢 | 🟢 diff --git a/docs/api/mcp/index.mdx b/docs/api/mcp/index.mdx index 9c8e133fb..d92001cdc 100644 --- a/docs/api/mcp/index.mdx +++ b/docs/api/mcp/index.mdx @@ -11,7 +11,7 @@ This feature is - [experimental](admin/beta_and_experimental_features#experimental-features) + [experimental](/admin/beta_and_experimental_features#experimental-features) and might change or be removed in the future. diff --git a/docs/cli/how-tos/fetch_sboms.mdx b/docs/cli/how-tos/fetch_sboms.mdx index b69fb4fab..bd940a0f0 100644 --- a/docs/cli/how-tos/fetch_sboms.mdx +++ b/docs/cli/how-tos/fetch_sboms.mdx @@ -6,13 +6,13 @@ Use the Sourcegraph CLI (`src`) to fetch SBOMs for a specific release. ## Prerequisites -1. Install `src` following the [Quickstart](../quickstart.mdx). +1. Install `src` following the [Quickstart](/cli/quickstart). 2. Install `cosign` following the [Installation Guide](https://docs.sigstore.dev/cosign/system_config/installation/). ## Fetching SBOMs -1. Determine the Sourcegraph version to verify. Use either a [recent release](../../CHANGELOG.mdx) or your instance's current version. +1. Determine the Sourcegraph version to verify. Use either a [recent release](/technical-changelog) or your instance's current version. > **Note:** SBOMs are only available only for Sourcegraph release 5.9.0 and later. diff --git a/docs/cli/how-tos/verify_container_signatures.mdx b/docs/cli/how-tos/verify_container_signatures.mdx index a632308d8..af50162dd 100644 --- a/docs/cli/how-tos/verify_container_signatures.mdx +++ b/docs/cli/how-tos/verify_container_signatures.mdx @@ -6,13 +6,13 @@ To verify signatures for a specific release, use the Sourcegraph CLI (`src`). Th ## Prerequisites -1. Install `src` following the [Quickstart](../quickstart.mdx). +1. Install `src` following the [Quickstart](/cli/quickstart). 2. Install `cosign` following the [Installation Guide](https://docs.sigstore.dev/cosign/system_config/installation/). ## Verification Process -1. Determine the Sourcegraph version to verify. Use either a [recent release](../../CHANGELOG.mdx) or your instance's current version. +1. Determine the Sourcegraph version to verify. Use either a [recent release](/technical-changelog) or your instance's current version. > **Note:** Signature verification is available only for Sourcegraph release 5.11.4013 and later. diff --git a/docs/cli/references/index.mdx b/docs/cli/references/index.mdx index 1c8e4626e..60930d60c 100644 --- a/docs/cli/references/index.mdx +++ b/docs/cli/references/index.mdx @@ -14,11 +14,9 @@ * [`login`](references/login) * [`orgs`](references/orgs) * [`repos`](references/repos) -* [`sbom`](references/sbom) * [`search`](references/search) * [`search-jobs`](references/search-jobs) * [`serve-git`](references/serve-git) -* [`signature`](references/signature) * [`snapshot`](references/snapshot) * [`teams`](references/teams) * [`users`](references/users) diff --git a/docs/code-navigation/how-to/index.mdx b/docs/code-navigation/how-to/index.mdx index a92e3dc22..e02e5e003 100644 --- a/docs/code-navigation/how-to/index.mdx +++ b/docs/code-navigation/how-to/index.mdx @@ -1,6 +1,6 @@ # How-to guides -- [Adding precise code navigation to CI/CD workflows](/code-navigation/how-to/adding_lsif_to_workflows) +- [Adding precise code navigation to CI/CD workflows](/code-navigation/how-to/adding_scip_to_workflows) - [Combining SCIP uploads from CI/CD and auto-indexing](/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing) - [Go SCIP indexing](/code-navigation/how-to/index_a_go_repository) - [Index a TypeScript or JavaScript repository](/code-navigation/how-to/index_a_typescript_and_javascript_repository) diff --git a/docs/code-navigation/how-to/index_other_languages.mdx b/docs/code-navigation/how-to/index_other_languages.mdx index ad72c4eb2..74e4674e2 100644 --- a/docs/code-navigation/how-to/index_other_languages.mdx +++ b/docs/code-navigation/how-to/index_other_languages.mdx @@ -57,7 +57,7 @@ Successful output will appear similar to the following example. ## Automate code indexing -Now that you have successfully enabled code navigation for your repository, you can automate source code indexing to ensure precise code navigation stays up to date with the most recent code changes in the repository. See our [continuous integration guide](/code-navigation/how-to/adding_lsif_to_workflows) to setup automation. +Now that you have successfully enabled code navigation for your repository, you can automate source code indexing to ensure precise code navigation stays up to date with the most recent code changes in the repository. See our [continuous integration guide](/code-navigation/how-to/adding_scip_to_workflows) to setup automation. ## Troubleshooting diff --git a/docs/code-navigation/index.mdx b/docs/code-navigation/index.mdx index 1cddaca89..e79695135 100644 --- a/docs/code-navigation/index.mdx +++ b/docs/code-navigation/index.mdx @@ -64,10 +64,10 @@ Code Navigation helps you with the following tasks: | **Feature** | **Description** | | ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Popover](/code_navigation/explanations/features#popover) | Quickly view a symbol's type signature and documentation without switching to another source file | -| [Go to definition](/code_navigation/explanations/features#go-to-definition) | Click the button or symbol name, navigates you to the symbol's definition | -| [Find references](/code_navigation/explanations/features#find-references) | Selecting it in the popover lists all references, definitions, and implementations at the bottom, including precise and search-based results | -| [Find implementations](/code_navigation/explanations/features#find-implementations) | Click to go to a symbol's interface definition or, at the interface, see all implementations across repositories, including interfaces implemented by a struct | +| [Popover](/code-navigation/features#popover) | Quickly view a symbol's type signature and documentation without switching to another source file | +| [Go to definition](/code-navigation/features#go-to-definition) | Click the button or symbol name, navigates you to the symbol's definition | +| [Find references](/code-navigation/features#find-references) | Selecting it in the popover lists all references, definitions, and implementations at the bottom, including precise and search-based results | +| [Find implementations](/code-navigation/features#find-implementations) | Click to go to a symbol's interface definition or, at the interface, see all implementations across repositories, including interfaces implemented by a struct | | [Perform an action](/code-navigation/features#perform-an-action) | When browsing code, you can perform a couple of actions like open in code host, raw download and view blame. | @@ -79,5 +79,5 @@ Code Navigation helps you with the following tasks: There are two types of Code Navigation that Sourcegraph supports: -- [Search-based Code Navigation](/code_navigation/explanations/search_based_code_navigation): Works out of the box with most popular programming languages, powered by Sourcegraph's code search. It uses a mix of text search and syntax-level heuristics (no language-level semantic information) for fast, performant searches across large code bases. -- [Precise Code Navigation](/code_navigation/explanations/precise_code_navigation): Uses compile-time information to provide users with accurate cross-repository navigation experience across the entire code base. +- [Search-based Code Navigation](/code-navigation/search_based_code_navigation): Works out of the box with most popular programming languages, powered by Sourcegraph's code search. It uses a mix of text search and syntax-level heuristics (no language-level semantic information) for fast, performant searches across large code bases. +- [Precise Code Navigation](/code-navigation/precise_code_navigation): Uses compile-time information to provide users with accurate cross-repository navigation experience across the entire code base. diff --git a/docs/code-navigation/precise_code_navigation.mdx b/docs/code-navigation/precise_code_navigation.mdx index 0f9245940..679a5fb6a 100644 --- a/docs/code-navigation/precise_code_navigation.mdx +++ b/docs/code-navigation/precise_code_navigation.mdx @@ -33,8 +33,8 @@ Precise code navigation relies on the open source [SCIP Code Intelligence Protoc 1. **Manual indexing**. Index a repository and upload it to your Sourcegraph instance: - - [Index a Go repository](/code_navigation/how-to/index_a_go_repository#manual-indexing) - - [Index a TypeScript or JavaScript repository](/code_navigation/how-to/index_a_typescript_and_javascript_repository#manual-indexing) + - [Index a Go repository](/code-navigation/how-to/index_a_go_repository#manual-indexing) + - [Index a TypeScript or JavaScript repository](/code-navigation/how-to/index_a_typescript_and_javascript_repository#manual-indexing) - [Index a Java, Scala, or Kotlin repository](https://sourcegraph.github.io/scip-java/docs/getting-started.html) - [Index a Python repository](https://sourcegraph.com/github.com/sourcegraph/scip-python) - [Index a Ruby repository](https://sourcegraph.com/github.com/sourcegraph/scip-ruby) diff --git a/docs/code-search/types/search-jobs.mdx b/docs/code-search/types/search-jobs.mdx index 8e72ae086..440ebc071 100644 --- a/docs/code-search/types/search-jobs.mdx +++ b/docs/code-search/types/search-jobs.mdx @@ -44,7 +44,7 @@ Search Jobs requires an object storage to store the results of your search jobs. By default, Search Jobs stores results using our bundled `blobstore` service. If the `blobstore` service is deployed, and you want to use it to store results from Search Jobs, you don't need to configure anything. -To use a third party managed object storage service, see instructions in [externalizing object storage](../../admin/external_services/object_storage#search-job-results). +To use a third party managed object storage service, see instructions in [externalizing object storage](/self-hosted/external_services/object_storage#search-job-results). ### Environment Variables diff --git a/docs/cody/capabilities/chat.mdx b/docs/cody/capabilities/chat.mdx index b9b344034..320127e01 100644 --- a/docs/cody/capabilities/chat.mdx +++ b/docs/cody/capabilities/chat.mdx @@ -86,7 +86,7 @@ Image upload support varies by client. Check the [feature parity reference](/cod ## LLM selection -Cody allows you to select the LLM you want to use for your chat, which is optimized for speed versus accuracy. Enterprise users with the new [model configuration](/cody/clients/model-configuration) can use the LLM selection dropdown to choose a chat model. +Cody allows you to select the LLM you want to use for your chat, which is optimized for speed versus accuracy. Enterprise users with the new [model configuration](/cody/enterprise/model-configuration) can use the LLM selection dropdown to choose a chat model. You can read about these supported LLM models [here](/cody/capabilities/supported-models#chat-and-commands). @@ -110,7 +110,7 @@ Cody keeps a history of your chat sessions. You can view it by clicking the **Hi ## Prompts -Cody offers quick, ready-to-use [prompts](/cody/capabilities/commands) for common actions to write, describe, fix, and smell code. Read more about [prompts](/cody/capabilities/commands) here. +Cody offers quick, ready-to-use [prompts](/cody/capabilities/prompts) for common actions to write, describe, fix, and smell code. Read more about [prompts](/cody/capabilities/prompts) here. ## Ask Cody to write code diff --git a/docs/cody/capabilities/index.mdx b/docs/cody/capabilities/index.mdx index 4c2492747..d362a658e 100644 --- a/docs/cody/capabilities/index.mdx +++ b/docs/cody/capabilities/index.mdx @@ -25,7 +25,7 @@ diff --git a/docs/cody/clients/cody-with-sourcegraph.mdx b/docs/cody/clients/cody-with-sourcegraph.mdx index b2c075f33..58e95b4f3 100644 --- a/docs/cody/clients/cody-with-sourcegraph.mdx +++ b/docs/cody/clients/cody-with-sourcegraph.mdx @@ -41,9 +41,9 @@ The chat interface with your Code Search queries opens parallel to your query se ## Chat with Cody on the web interface -The feature set for the Cody chat is the same as the IDE extensions. Your previous chats can be viewed from the **History** tab. Claude 3.5 Sonnet is selected as the default chat model. You can change this LLM model based on your use case to optimize speed, accuracy, or cost. Enterprise users with the new [model configuration](/cody/clients/model-configuration) can use the LLM selection dropdown to choose a chat model. You can read about these supported LLM models [here](/cody/capabilities/supported-models#chat-and-commands). +The feature set for the Cody chat is the same as the IDE extensions. Your previous chats can be viewed from the **History** tab. Claude 3.5 Sonnet is selected as the default chat model. You can change this LLM model based on your use case to optimize speed, accuracy, or cost. Enterprise users with the new [model configuration](/cody/enterprise/model-configuration) can use the LLM selection dropdown to choose a chat model. You can read about these supported LLM models [here](/cody/capabilities/supported-models#chat-and-commands). -To help you automate your key tasks in your development workflow, you get **[Prompts](/cody/capabilities/commands)**. If you are a part of an organization on Sourcegraph.com or a self-hosted Sourcegraph instance, you can view these pre-built Prompts created by your teammates. On the contrary, you can create your Prompts via the **Prompt Library** from your Sourcegraph instance. +To help you automate your key tasks in your development workflow, you get **[Prompts](/cody/capabilities/prompts)**. If you are a part of an organization on Sourcegraph.com or a self-hosted Sourcegraph instance, you can view these pre-built Prompts created by your teammates. On the contrary, you can create your Prompts via the **Prompt Library** from your Sourcegraph instance. ## Context selection @@ -73,6 +73,6 @@ If Cody's answer isn't helpful, you can try asking again with a different contex ## Prompts -Cody allows you create quick, ready-to-use [prompts](/cody/capabilities/commands) to automate key tasks in your workflow. Prompts are created and saved in the Prompt Library and can be accessed from the **Tools > Prompt Library** in the top navigation bar in your Sourcegraph instance. +Cody allows you create quick, ready-to-use [prompts](/cody/capabilities/prompts) to automate key tasks in your workflow. Prompts are created and saved in the Prompt Library and can be accessed from the **Tools > Prompt Library** in the top navigation bar in your Sourcegraph instance. ![cody-web-prompts](https://storage.googleapis.com/sourcegraph-assets/Docs/cody-web-prompts-2025.png) diff --git a/docs/cody/clients/install-jetbrains.mdx b/docs/cody/clients/install-jetbrains.mdx index 7a6149cbf..fe9451c9b 100644 --- a/docs/cody/clients/install-jetbrains.mdx +++ b/docs/cody/clients/install-jetbrains.mdx @@ -102,7 +102,7 @@ Since your first message to Cody anchors the conversation, you can return to the You can view which LLMs you can access on our [supported LLMs page](/cody/capabilities/supported-models). Enterprise users with the new - [model configuration](/cody/clients/model-configuration) can use the LLM + [model configuration](/cody/enterprise/model-configuration) can use the LLM selection dropdown to choose a chat model. @@ -180,7 +180,7 @@ For repos mentioned in the `exclude` field, Cody prompts are disabled, and you c ## Prompts -Cody allows you create quick, ready-to-use [prompts](/cody/capabilities/commands) to automate key tasks in your workflow. Prompts are created and saved in the Prompt Library and can be accessed from the **Tools > Prompt Library** in the top navigation bar in your Sourcegraph instance. +Cody allows you create quick, ready-to-use [prompts](/cody/capabilities/prompts) to automate key tasks in your workflow. Prompts are created and saved in the Prompt Library and can be accessed from the **Tools > Prompt Library** in the top navigation bar in your Sourcegraph instance. To help you get started, there are a few prompts that are available by default. These can assist you to: @@ -221,7 +221,7 @@ All you need to do is select and highlight the code line with the error and clic ## Supported LLM models -Enterprise users who have [model configuration](/Cody/clients/model-configuration#model-configuration) configured can also select from the available models for their instance. On instances with the ["completions" configuration](/Cody/clients/model-configuration#completions-configuration), a site admin determines the LLM, which cannot be changed within the editor. +Enterprise users who have [model configuration](/cody/enterprise/model-configuration#model-configuration) configured can also select from the available models for their instance. On instances with the ["completions" configuration](/cody/enterprise/model-configuration#completions-configuration), a site admin determines the LLM, which cannot be changed within the editor. Read and learn more about the [supported diff --git a/docs/cody/clients/install-visual-studio.mdx b/docs/cody/clients/install-visual-studio.mdx index f92c86d20..9ab07ff4c 100644 --- a/docs/cody/clients/install-visual-studio.mdx +++ b/docs/cody/clients/install-visual-studio.mdx @@ -74,7 +74,7 @@ When you have both a repository and files @-mentioned, Cody will search the repo ## Prompts -Cody allows you create quick, ready-to-use [prompts](/cody/capabilities/commands) to automate key tasks in your workflow. Prompts are created and saved in the Prompt Library and can be accessed from the **Tools > Prompt Library** in the top navigation bar in your Sourcegraph instance. +Cody allows you create quick, ready-to-use [prompts](/cody/capabilities/prompts) to automate key tasks in your workflow. Prompts are created and saved in the Prompt Library and can be accessed from the **Tools > Prompt Library** in the top navigation bar in your Sourcegraph instance. To help you get started, there are a few prompts that are available by default. These can assist you to: diff --git a/docs/cody/clients/install-vscode.mdx b/docs/cody/clients/install-vscode.mdx index 8460f66c9..4fe49668f 100644 --- a/docs/cody/clients/install-vscode.mdx +++ b/docs/cody/clients/install-vscode.mdx @@ -150,7 +150,7 @@ A chat history icon at the top of your chat input window allows you to navigate You can view which LLMs you have access to on our [supported LLMs page](/cody/capabilities/supported-models). Enterprise users with the new - [model configuration](/cody/clients/model-configuration) can use the LLM + [model configuration](/cody/enterprise/model-configuration) can use the LLM selection dropdown to choose a chat model. @@ -228,7 +228,7 @@ For repos mentioned in the `exclude` field, prompts are disabled, and you cannot ## Prompts -Cody allows you create quick, ready-to-use [prompts](/cody/capabilities/commands) to automate key tasks in your workflow. Prompts are created and saved in the Prompt Library and can be accessed from the **Tools > Prompt Library** in the top navigation bar in your Sourcegraph instance. +Cody allows you create quick, ready-to-use [prompts](/cody/capabilities/prompts) to automate key tasks in your workflow. Prompts are created and saved in the Prompt Library and can be accessed from the **Tools > Prompt Library** in the top navigation bar in your Sourcegraph instance. To help you get started, there are a few prompts that are available by default. These can assist you to: diff --git a/docs/cody/core-concepts/context.mdx b/docs/cody/core-concepts/context.mdx index bdae6fb5f..a8ba30633 100644 --- a/docs/cody/core-concepts/context.mdx +++ b/docs/cody/core-concepts/context.mdx @@ -55,7 +55,7 @@ Cody works in conjunction with an LLM to provide codebase-aware answers. The LLM A typical prompt has three parts: -- **Prefix**: An optional description of the desired output, often derived from predefined [Prompts](/cody/capabilities/commands) that specify tasks the LLM can perform +- **Prefix**: An optional description of the desired output, often derived from predefined [Prompts](/cody/capabilities/prompts) that specify tasks the LLM can perform - **User input**: The information provided, including your code query or request - **Context**: Additional information that helps the LLM provide a relevant answer based on your specific codebase diff --git a/docs/cody/faq.mdx b/docs/cody/faq.mdx index 46c51744d..4c7b6cf5d 100644 --- a/docs/cody/faq.mdx +++ b/docs/cody/faq.mdx @@ -220,7 +220,7 @@ If you're a Cody Pro user: If you're on Enterprise Starter: - Your workspaces will have Cody access until \*July 23, 2025, after which Cody's access will be removed. -- Your Enterprise Starter subscription remains fully supported for Code Search, with upcoming improvements like [Deep Search](/code-search/types/deep-search). +- Your Enterprise Starter subscription remains fully supported for Code Search, with upcoming improvements like Deep Search. - Enterprise Starter customers can sign up with Amp today at [ampcode.com](http://ampcode.com) and receive **$10 in free credits** **plus $30 additional free credits** as a thank you for using Enterprise Starter. If you're an Enterprise user: diff --git a/docs/cody/index.mdx b/docs/cody/index.mdx index 96a0b9495..417983151 100644 --- a/docs/cody/index.mdx +++ b/docs/cody/index.mdx @@ -87,7 +87,7 @@ Cody's main features include: | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **[Chat](/cody/capabilities/chat)** | Chat directly with AI to ask questions about your code, generate code, and edit code. Cody has the context of your open file and repository by default, and you can use `@` to add context on specific files, symbols, remote repositories, or other non-code artifacts. | | **[Auto-edit](/cody/capabilities/auto-edit)** | Suggests code changes by analyzing cursor movements and typing. After you've made at least one character edit in your codebase, it begins proposing contextual modifications based on your cursor position and recent changes. | -| **[Prompts](/cody/capabilities/commands)** | Automate key tasks in your workflow with premade and customizable prompts. Any common query or task can be built into a prompt to save and share with your team. | +| **[Prompts](/cody/capabilities/prompts)** | Automate key tasks in your workflow with premade and customizable prompts. Any common query or task can be built into a prompt to save and share with your team. | | **[Context](/cody/core-concepts/context)** | Cody provides the best LLM models and context to power chat. It uses the powerful Sourcegraph's advanced Search API to pull context from both local and remote codebases. | | **[Debug code](/cody/capabilities/debug-code)** | Cody is optimized to identify and fix errors in your code. Its debugging capability and autocomplete suggestions can significantly accelerate your debugging process, increasing developer productivity. | | **[Context Filters](/cody/capabilities/ignore-context)** | Cody can ignore selected repositories from chat and autocomplete results, which helps you control and manage what context your codebase uses. | diff --git a/docs/cody/prompts-guide.mdx b/docs/cody/prompts-guide.mdx index fd6bd1f0b..75008a37f 100644 --- a/docs/cody/prompts-guide.mdx +++ b/docs/cody/prompts-guide.mdx @@ -226,7 +226,7 @@ To accelerate and automate your work, you can leverage Cody's Prompt Library, wh The Prompt Library is a system for creating and sharing customizable prompts. It is explicitly designed for scalability, repeatability, and flexibility. -Learn more about the [Prompts and the Prompt Library here](/cody/capabilities/commands). +Learn more about the [Prompts and the Prompt Library here](/cody/capabilities/prompts). ## Example Prompts diff --git a/docs/cody/quickstart.mdx b/docs/cody/quickstart.mdx index c897af911..a3279a4ab 100644 --- a/docs/cody/quickstart.mdx +++ b/docs/cody/quickstart.mdx @@ -29,7 +29,7 @@ After installing the extension and connecting to your Sourcegraph Enterprise ins By default, the chat input will have the context of your entire codebase, and Claude 3.5 Sonnet is selected as the default chat model. You can change the LLM model and context based on your use case to optimize speed, accuracy, or cost. -To help you automate your key tasks in your development workflow, you get **[Prompts](/cody/capabilities/commands)**. If you are a part of an organization on Sourcegraph.com or a self-hosted Sourcegraph instance, you can view these pre-built Prompts created by your teammates. Alternatively, you can create your own Prompts via the **Prompt Library** from your Sourcegraph instance. +To help you automate your key tasks in your development workflow, you get **[Prompts](/cody/capabilities/prompts)**. If you are a part of an organization on Sourcegraph.com or a self-hosted Sourcegraph instance, you can view these pre-built Prompts created by your teammates. Alternatively, you can create your own Prompts via the **Prompt Library** from your Sourcegraph instance. The Cody chat interface offers a few more options and settings. [You can read more in these docs](/cody/capabilities/chat). diff --git a/docs/cody/use-cases/vsc-tutorial.mdx b/docs/cody/use-cases/vsc-tutorial.mdx index 4600acac1..54cf6f384 100644 --- a/docs/cody/use-cases/vsc-tutorial.mdx +++ b/docs/cody/use-cases/vsc-tutorial.mdx @@ -73,7 +73,7 @@ You can also run this command from the [Cody: Commands Menu](command:cody.menu.c **✨ Pro-tips for understanding code with Cody** - Cody can also explain errors too, with the "Ask Cody to Explain" option in the 💡 menus, or by right clicking on any items in the "Problems" tab of VS Code. -- You can define your own custom code to explain commands to suit, such as a prompt that requests an explanation focused on potential security issues, using [Custom Commands (Beta)](/cody/capabilities/custom-commands). +- You can define your own custom code to explain commands to suit, such as a prompt that requests an explanation focused on potential security issues, using [prompts](/cody/capabilities/prompts). ## Fix Code diff --git a/docs/getting-started/index.mdx b/docs/getting-started/index.mdx index 389589fd7..7411e8011 100644 --- a/docs/getting-started/index.mdx +++ b/docs/getting-started/index.mdx @@ -110,7 +110,7 @@ Please read the [code navigation documentation](/code-navigation/) to learn more Cody is an AI code assistant that uses Sourcegraph code search, the code graph, and LLMs to provide context-aware answers about your codebase. Cody can explain code, refactor code, and write code, all within the context of your existing codebase. -[Learn more about Cody](/cody/overview/). +[Learn more about Cody](/cody/). ## Notebooks diff --git a/docs/integration/go.mdx b/docs/integration/go.mdx deleted file mode 100644 index 711a3d03f..000000000 --- a/docs/integration/go.mdx +++ /dev/null @@ -1,27 +0,0 @@ -# Go dependencies integration with Sourcegraph - -You can use Sourcegraph with Go modules from any Go module proxy, including open source code from proxy.golang.org or a private proxy such as [Athens](https://github.com/gomods/athens). - -This integration makes it possible to search and navigate through the source code of published Go modules (for example, [`gorilla/mux@v1.8.0`](https://sourcegraph.com/go/github.com/gorilla/mux@v1.8.0)). - -| Feature | Supported? | -| --------------------------------------------------------------------------- | ---------- | -| [Repository syncing](#repository-syncing) | ✅ | -| [Repository permissions](#repository-syncing) | ❌ | -| [Multiple Go repositories code hosts](#multiple-go-dependencies-code-hosts) | ❌ | - -## Setup - -See the "[Go dependencies](/admin/code_hosts/go)" documentation. - -## Repository syncing - -Site admins can [add Go packages to Sourcegraph](/admin/code_hosts/go#repository-syncing). - -## Repository permissions - -⚠️ Go dependency repositories are visible by all users of the Sourcegraph instance. - -## Multiple Go dependencies code hosts - -⚠️ It's only possible to create one Ruby dependency code host for each Sourcegraph instance. diff --git a/docs/pricing/plans/enterprise-starter.mdx b/docs/pricing/plans/enterprise-starter.mdx index e7dd04757..256e4a471 100644 --- a/docs/pricing/plans/enterprise-starter.mdx +++ b/docs/pricing/plans/enterprise-starter.mdx @@ -25,7 +25,7 @@ Workspaces on the Enterprise Starter plan are billed monthly based on the number If you fail to make the payment after the grace period, your workspace will be deleted, and you will not be able to recover your data. -Please also see [FAQs](faqs.mdx) for more FAQs, including how to downgrade Enterprise Starter. +Please also see [FAQs](/pricing/faqs) for more FAQs, including how to downgrade Enterprise Starter. ## Features supported diff --git a/docs/self-hosted/deploy/docker-compose/index.mdx b/docs/self-hosted/deploy/docker-compose/index.mdx index aa7d417f4..72d8bff18 100644 --- a/docs/self-hosted/deploy/docker-compose/index.mdx +++ b/docs/self-hosted/deploy/docker-compose/index.mdx @@ -133,7 +133,7 @@ Continue with the following steps _after_ you have created a public or private c You can find the default [docker-compose.yaml](https://github.com/sourcegraph/deploy-sourcegraph-docker/blob/master/docker-compose/docker-compose.yaml) file inside the deployment repository. -If you would like to make changes to the default configurations, we highly recommend you create a new file called `docker-compose.override.yaml` in the same directory where the default docker-compose.yaml file is located, and make your customizations inside the [docker-compose.override.yaml](configuration#what-is-an-override-file) file. +If you would like to make changes to the default configurations, we highly recommend you create a new file called `docker-compose.override.yaml` in the same directory where the default docker-compose.yaml file is located, and make your customizations inside the [docker-compose.override.yaml](/self-hosted/deploy/docker-compose/configuration#what-is-an-override-file) file. - Here is a list of customizations you can make using an override file: - Add replicas diff --git a/docs/self-hosted/deploy/docker-compose/upgrade.mdx b/docs/self-hosted/deploy/docker-compose/upgrade.mdx index 78cae68fd..e7b373ebe 100644 --- a/docs/self-hosted/deploy/docker-compose/upgrade.mdx +++ b/docs/self-hosted/deploy/docker-compose/upgrade.mdx @@ -104,7 +104,7 @@ To perform a multi-version upgrade via migrators [upgrade](/self-hosted/updates/ command: ['upgrade', '--from=v5.9.0', '--to=v6.0.0'] ``` > _Note: you may add the `--dry-run` flag to the `command:` to test things out before altering the dbs_ 3. Run migrator with `docker-compose up migrator` - - Migrator `depends_on:` will ensure the databases are ready before attempting to run the migrator. Ensuring that database entry point scripts are run before the migrator attempts to connect to the databases. For users upgrading from a version earlier than `5.10.0`, a PostgreSQL version is required and will be performed automatically here. For more details, see [Upgrading PostgreSQL](/admin/postgresql#upgrading-postgresql). + - Migrator `depends_on:` will ensure the databases are ready before attempting to run the migrator. Ensuring that database entry point scripts are run before the migrator attempts to connect to the databases. For users upgrading from a version earlier than `5.10.0`, a PostgreSQL version is required and will be performed automatically here. For more details, see [Upgrading PostgreSQL](/self-hosted/postgres#upgrading-postgresql). **Example:** ```sh $ ~/deploy-sourcegraph-docker/docker-compose/ docker-compose up migrator diff --git a/docs/self-hosted/deploy/kubernetes/index.mdx b/docs/self-hosted/deploy/kubernetes/index.mdx index 011f3fe0d..013be9fcc 100644 --- a/docs/self-hosted/deploy/kubernetes/index.mdx +++ b/docs/self-hosted/deploy/kubernetes/index.mdx @@ -1001,7 +1001,7 @@ $ helm upgrade --install -f override.yaml --version {CURRENT_VERSION_NO_V} sourc $ kubectl get pods --watch ``` -When all pods have restarted and show as Running, you can browse to your Sourcegraph deployment and login to verify the instance is working as expected. For troubleshooting, refer to the [Operations guide](/admin/install/kubernetes/operations) for common commands to gather more information about failures. +When all pods have restarted and show as Running, you can browse to your Sourcegraph deployment and login to verify the instance is working as expected. For troubleshooting, refer to the [Operations guide](/self-hosted/deploy/kubernetes/operations) for common commands to gather more information about failures. ### Multi-version upgrades diff --git a/docs/self-hosted/deploy/machine-images/aws-ami.mdx b/docs/self-hosted/deploy/machine-images/aws-ami.mdx index 586e0dc3a..19e773afa 100644 --- a/docs/self-hosted/deploy/machine-images/aws-ami.mdx +++ b/docs/self-hosted/deploy/machine-images/aws-ami.mdx @@ -87,7 +87,7 @@ helm upgrade -i -f ./override.yaml --version "$(cat /home/ec2-user/.sourcegraph- 1. Check `Site-Admin > Executors > Instances` to verify the executor connected successfully. If it does not appear try reboot the instance -To use server-side batch changes you will need to enable the `native-ssbc-execution` [feature flag](/admin/executors/native_execution#enable). +To use server-side batch changes, see the [server-side batch changes documentation](/batch-changes/server-side). --- diff --git a/docs/self-hosted/deploy/machine-images/aws-oneclick.mdx b/docs/self-hosted/deploy/machine-images/aws-oneclick.mdx index 7419e11b7..2c047fafa 100644 --- a/docs/self-hosted/deploy/machine-images/aws-oneclick.mdx +++ b/docs/self-hosted/deploy/machine-images/aws-oneclick.mdx @@ -95,7 +95,7 @@ helm upgrade -i -f ./override.yaml --version "$(cat /home/ec2-user/.sourcegraph- 1. Check `Site-Admin > Executors > Instances` to verify the executor connected successfully. If it does not appear try reboot the instance -To use server-side batch changes you will need to enable the `native-ssbc-execution` [feature flag](/admin/executors/native_execution#enable). +To use server-side batch changes, see the [server-side batch changes documentation](/batch-changes/server-side). ### Secure your instance diff --git a/docs/self-hosted/deploy/machine-images/gce.mdx b/docs/self-hosted/deploy/machine-images/gce.mdx index 43f449765..0ca8f792b 100644 --- a/docs/self-hosted/deploy/machine-images/gce.mdx +++ b/docs/self-hosted/deploy/machine-images/gce.mdx @@ -144,7 +144,7 @@ helm upgrade -i -f ./override.yaml --version "$(cat /home/sourcegraph/.sourcegra 1. Check `Site-Admin > Executors > Instances` to verify the executor connected successfully. If it does not appear try reboot the instance. -To use server-side batch changes you will need to enable the `native-ssbc-execution` [feature flag](/admin/executors/native_execution#enable). +To use server-side batch changes, see the [server-side batch changes documentation](/batch-changes/server-side). --- diff --git a/docs/self-hosted/how-to/index.mdx b/docs/self-hosted/how-to/index.mdx index a33048d70..c2241d38b 100644 --- a/docs/self-hosted/how-to/index.mdx +++ b/docs/self-hosted/how-to/index.mdx @@ -28,4 +28,4 @@ - [Migrating code intelligence data from LSIF to SCIP (Sourcegraph 4.5 -> 4.6)](/admin/how-to/lsif_scip_migration) - [How to export search results](/admin/how-to/export-search-results) - [How to debug / confirm blobstore is healthy](/self-hosted/how-to/blobstore_debugging) -- [How to handle postgresql 12 to 16 drift](/admin/how-to/postgresql-12-to-16-drift) +- [How to handle postgresql 12 to 16 drift](/self-hosted/how-to/postgres_12_to_16_drift) 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 f7781b2d1..2742b4c1b 100644 --- a/docs/self-hosted/how-to/rebuild-corrupt-postgres-indexes.mdx +++ b/docs/self-hosted/how-to/rebuild-corrupt-postgres-indexes.mdx @@ -120,7 +120,7 @@ commit; In case your database is large and `reindex (verbose) database sg` takes too long to re-run multiple times as you remove duplicates, you can instead run individual index rebuilding statements, and resume where you left of. -Here's a query that produces a list of such statements for all indexes that contain collatable key columns (we had corruption in these indexes in the [3.30 upgrade](/admin/migration/3_30)). This is a sub-set of the indexes that gets re-indexed by `reindex database sg`. +Here's a query that produces a list of such statements for all indexes that contain collatable key columns (we had corruption in these indexes in the 3.30 upgrade). This is a sub-set of the indexes that gets re-indexed by `reindex database sg`. ```sql select diff --git a/docs/self-hosted/how-to/redis_configmap.mdx b/docs/self-hosted/how-to/redis_configmap.mdx index 06887f6a0..0283a14f0 100644 --- a/docs/self-hosted/how-to/redis_configmap.mdx +++ b/docs/self-hosted/how-to/redis_configmap.mdx @@ -160,7 +160,7 @@ metadata: ``` -7. Modify the manifests for all services listed in[ Configure custom Redis](/admin/install/kubernetes/configure#external-redis). The listing below is an example of the two environment variables that must be added to the services listed in the documentation. +7. Modify the manifests for all services listed in[Configure custom Redis](/self-hosted/deploy/kubernetes/configure#external-redis). The listing below is an example of the two environment variables that must be added to the services listed in the documentation. ``` apiVersion: apps/v1 @@ -177,7 +177,7 @@ kind: Deployment value: redis://:demopasswordchangeme123@redis-store:6379 ``` -**Note:** Be sure to add both environment variables to all services listed in [Configure custom Redis](/admin/install/kubernetes/configure#external-redis). +**Note:** Be sure to add both environment variables to all services listed in [Configure custom Redis](/self-hosted/deploy/kubernetes/configure#external-redis). 8. After making the necessary changes to the manifests, apply the changes. Kubernetes should recreate all pods that were modified. 9. Verify the sourcegraph-frontend pods are running and do not contain log messages that indicate that sourcegraph-frontend is unable to the redis services. diff --git a/docs/self-hosted/how-to/upgrade-postgres-12-16-builtin-dbs.mdx b/docs/self-hosted/how-to/upgrade-postgres-12-16-builtin-dbs.mdx index 8461980fd..2f12582c8 100644 --- a/docs/self-hosted/how-to/upgrade-postgres-12-16-builtin-dbs.mdx +++ b/docs/self-hosted/how-to/upgrade-postgres-12-16-builtin-dbs.mdx @@ -42,7 +42,7 @@ Wait for the database containers to come up healthy. If for some reason the data ## Kubernetes Kustomize -Kubernetes Kustomize supports [standard](/self-hosted/deploy/kubernetes/upgrade#standard-upgrades) and [multi-version](/deploy/kubernetes/upgrade#multi-version-upgrades) upgrades to Postgres 16 versions! However, if you prefer to upgrade your DBs independent of a Sourcegraph version upgrade see the following procedure. +Kubernetes Kustomize supports [standard](/self-hosted/deploy/kubernetes/upgrade#standard-upgrades) and [multi-version](/self-hosted/deploy/kubernetes/upgrade#multi-version-upgrades) upgrades to Postgres 16 versions! However, if you prefer to upgrade your DBs independent of a Sourcegraph version upgrade see the following procedure. 1. **Disable Connections to the Database**: - The following services must have their replicas scaled to 0: - Deployments (e.g., `kubectl scale deployment --replicas=0`) - precise-code-intel-worker - repo-updater - searcher - sourcegraph-frontend - sourcegraph-frontend-internal - symbols - worker - Stateful sets (e.g., `kubectl scale sts --replicas=0`): - gitserver - indexed-search diff --git a/docs/self-hosted/index.mdx b/docs/self-hosted/index.mdx index 051ebd0ca..259db312b 100644 --- a/docs/self-hosted/index.mdx +++ b/docs/self-hosted/index.mdx @@ -53,7 +53,7 @@ Get started running Sourcegraph on-prem. - [Configure email sending / SMTP server](/self-hosted/email) - [Repository permissions](/admin/permissions/) - [Batch Changes](/batch-changes/site-admin-configuration) -- [Configure webhooks](/admin/config/webhooks/) +- [Configure webhooks](/admin/webhooks/) - [Scaling workers](/self-hosted/workers) - [PostgreSQL configuration](/self-hosted/postgres-conf) diff --git a/docs/self-hosted/private-network.mdx b/docs/self-hosted/private-network.mdx index 8a9dac9c7..88d92ca7a 100644 --- a/docs/self-hosted/private-network.mdx +++ b/docs/self-hosted/private-network.mdx @@ -11,17 +11,17 @@ additional configuration may be required to ensure all networking features funct The following is a list of Sourcegraph services that initiate outbound connections to external services. Sourcegraph services not included in this list can be assumed to only connect to services within the Sourcegraph deployment's network segment: -- **executor**: Sourcegraph [Executor](../executors) batch change or precise indexing jobs may need to connect to +- **executor**: Sourcegraph [Executor](/self-hosted/executors/) batch change or precise indexing jobs may need to connect to services hosted within an organization's private network - **frontend**: The frontend service communicates externally when connecting to: - - External [auth providers](../auth) - - Sending [telemetry data](../pings) - - Testing [code host connections](../code_hosts) - - Connecting to [externally hosted](../external_services) Sourcegraph services - - Connecting to external [LLM providers](../../cody/capabilities/supported-models) with Cody -- **gitserver**: Executes git commands against externally hosted [code hosts](../external_service) -- **migrator**: Connects to Postgres instances (which may be [externally hosted](../external_services/postgres)) to process database migrations -- **worker**: Sourcegraph [Worker](../workers) run various background jobs that may require establishing connections to + - External [auth providers](/admin/auth/) + - Sending [telemetry data](/admin/pings) + - Testing [code host connections](/admin/code_hosts/) + - Connecting to [externally hosted](/self-hosted/external_services/) Sourcegraph services + - Connecting to external [LLM providers](/cody/capabilities/supported-models) with Cody +- **gitserver**: Executes git commands against externally hosted [code hosts](/admin/code_hosts/) +- **migrator**: Connects to Postgres instances (which may be [externally hosted](/self-hosted/postgres)) to process database migrations +- **worker**: Sourcegraph Worker background jobs that may require establishing connections to services hosted within an organization's private network ## HTTP proxy configuration From eef72301af8f119785ada8410f4356a3f4c3f87b Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 22:22:30 +0100 Subject: [PATCH 13/21] Fix last batch of broken links --- docs/admin/executors/index.mdx | 2 +- docs/admin/oauth_apps.mdx | 2 +- docs/analytics/index.mdx | 10 ++--- .../batch-spec-yaml-reference.mdx | 6 +-- docs/batch-changes/update-a-batch-change.mdx | 2 +- docs/code-search/types/structural.mdx | 2 +- .../search_results_aggregations.mdx | 4 +- docs/cody/enterprise/model-configuration.mdx | 2 +- .../getting-started/github-vs-sourcegraph.mdx | 40 +++++++++---------- .../how-tos/troubleshooting.mdx | 4 +- .../browser_extension/quickstart.mdx | 2 +- .../deploy/kubernetes/kustomize/index.mdx | 6 +-- .../deploy_executors_binary_offline.mdx | 11 ++--- .../executors/deploy_executors_dind.mdx | 4 +- .../executors/deploy_executors_kubernetes.mdx | 2 +- docs/self-hosted/observability/alerts.mdx | 4 +- docs/self-hosted/observability/logs.mdx | 2 +- docs/self-hosted/updates/docker_compose.mdx | 4 +- docs/self-hosted/updates/kubernetes.mdx | 4 +- .../updates/migrator/schema-drift.mdx | 2 +- docs/self-hosted/updates/pure_docker.mdx | 4 +- docs/self-hosted/updates/server.mdx | 6 +-- docs/technical-changelog.mdx | 16 ++++---- 23 files changed, 67 insertions(+), 74 deletions(-) diff --git a/docs/admin/executors/index.mdx b/docs/admin/executors/index.mdx index f057a0493..9e28084e6 100644 --- a/docs/admin/executors/index.mdx +++ b/docs/admin/executors/index.mdx @@ -27,7 +27,7 @@ Optionally, executors can be run without using KVM-based isolation, which is les ## Deciding which executor deployment method to use -Deciding how to deploy the executor depends on your use case. For users that wish to process their untrusted compute in the most secure manner, we recommend leveraging the [Firecracker](./executors/firecracker) isolation method. For users that have constraints around running nested virtualization, the following flowchart can help you decide which deployment option is best for your environment: +Deciding how to deploy the executor depends on your use case. For users that wish to process their untrusted compute in the most secure manner, we recommend leveraging the [Firecracker](/self-hosted/executors/firecracker) isolation method. For users that have constraints around running nested virtualization, the following flowchart can help you decide which deployment option is best for your environment: - `[IDE_name].cody`: Cody extension interactions from IDEs.
- `server.web`: Interactions with the web interface (e.g., searches, code navigation, insights, and some chat events). Variations like `server.svelte-web` may exist. | | Timestamp Date (or Month) | When the activity was recorded. | | Language | Programming language of the interaction. This is only recorded for a subset of events, mostly completion and code navigation, and will therefore be blank for many rows. | diff --git a/docs/batch-changes/batch-spec-yaml-reference.mdx b/docs/batch-changes/batch-spec-yaml-reference.mdx index f6659d6b5..70a9d7821 100644 --- a/docs/batch-changes/batch-spec-yaml-reference.mdx +++ b/docs/batch-changes/batch-spec-yaml-reference.mdx @@ -295,7 +295,7 @@ steps: ## `steps.outputs` -Output variables that are set after the [`steps.run`](#steps-run) command has been executed. These variables are available in the global `outputs` namespace as `outputs.` [template variables](batch_spec_templating) in the `run`, `env`, and `outputs` properties of subsequent steps, and the [`changesetTemplate`](#changesettemplate). Two steps with the same output variable name will overwrite the previous contents. +Output variables that are set after the [`steps.run`](#steps-run) command has been executed. These variables are available in the global `outputs` namespace as `outputs.` [template variables](/batch-changes/batch-spec-templating) in the `run`, `env`, and `outputs` properties of subsequent steps, and the [`changesetTemplate`](#changesettemplate). Two steps with the same output variable name will overwrite the previous contents. ### Examples @@ -358,7 +358,7 @@ The value the output should be set to. `steps.outputs.$name.value` can include [template - variables](batch_spec_templating). + variables](/batch-changes/batch-spec-templating). ## `steps.outputs..format` @@ -376,7 +376,7 @@ As an optimization, the [Sourcegraph CLI](/cli/) tries to evaluate the condition Ahead-of-time evaluation is possible if the condition contains only static data. Example: `if: ${{ eq repository.name "github.com/my-org/my-repo" }}`. The repository name is known before the execution of the steps, so evaluation succeeds. Sourcegraph CLI will not include the given step in the list of steps to execute for repositories that don't have the matching name. That, in turn, allows the modification of this step's `run` attribute, for example, without invalidating the cache for the repositories in which it's never executed. - `steps.if` can include [templating](/batch_spec_templating). + `steps.if` can include [templating](/batch-changes/batch-spec-templating). ### Examples diff --git a/docs/batch-changes/update-a-batch-change.mdx b/docs/batch-changes/update-a-batch-change.mdx index 2a83d47ec..a018748b7 100644 --- a/docs/batch-changes/update-a-batch-change.mdx +++ b/docs/batch-changes/update-a-batch-change.mdx @@ -24,7 +24,7 @@ For more information, see [Code host interactions in Batch Changes](/batch-chang To update a batch change after previewing the changes, do the following: -- Edit the [batch spec](/batch-changes/batch-spec-yaml-reference) with which you created the batch change to include the changes you want to make to the batch change. For example, change [the commit message in the `changesetTemplate`](/batch-changes/batch-spec-yaml-reference#changesettemplatecommitmessage), or add a new changeset id [to the importedChangesets](/batch-changes/references/batch-spec-yaml-reference#importchangesets), or [modify the repositoriesMatchingQuery](/batch-changes/references/batch-spec-yaml-reference#onrepositoriesmatchingquery) to return different search results +- Edit the [batch spec](/batch-changes/batch-spec-yaml-reference) with which you created the batch change to include the changes you want to make to the batch change. For example, change [the commit message in the `changesetTemplate`](/batch-changes/batch-spec-yaml-reference#changesettemplatecommitmessage), or add a new changeset id [to the importedChangesets](/batch-changes/batch-spec-yaml-reference#importchangesets), or [modify the repositoriesMatchingQuery](/batch-changes/batch-spec-yaml-reference#onrepositoriesmatchingquery) to return different search results - Use the [Sourcegraph CLI (`src`)](https://github.com/sourcegraph/src-cli) to execute and preview the batch spec ```bash diff --git a/docs/code-search/types/structural.mdx b/docs/code-search/types/structural.mdx index ba87fd869..90f1dc43b 100644 --- a/docs/code-search/types/structural.mdx +++ b/docs/code-search/types/structural.mdx @@ -11,7 +11,7 @@ ask your site administrator to set experimentalFeatures.structuralSearch = "enabled" in site configuration. Structural search has performance limitations and is not actively developed. We recommend using regex search or a combination of [Search - Jobs](./search-jobs.mdx) and custom scripts instead. Please reach out to [support@sourcegraph.com](mailto:support@sourcegraph.com) + Jobs](/code-search/types/search-jobs) and custom scripts instead. Please reach out to [support@sourcegraph.com](mailto:support@sourcegraph.com) for guidance on alternative approaches. diff --git a/docs/code_insights/explanations/search_results_aggregations.mdx b/docs/code_insights/explanations/search_results_aggregations.mdx index 43d91edbf..dc61fbac5 100644 --- a/docs/code_insights/explanations/search_results_aggregations.mdx +++ b/docs/code_insights/explanations/search_results_aggregations.mdx @@ -2,7 +2,7 @@ In version 4.0 and later, Code Insights provides aggregations shown on the search screen. -This lets you track version and license spread, library adoption, common commit messages, lengths of specific files, usage frequencies, and the [many common use case examples here](../references/search_aggregations_use_cases.md). +This lets you track version and license spread, library adoption, common commit messages, lengths of specific files, usage frequencies, and the [many common use case examples here](/code_insights/references/search_aggregations_use_cases). ## Available aggregations: @@ -39,7 +39,7 @@ If you attempt to run a query for which a given mode is not supported, the toolt ### Timeout limits -At the moment all aggregations search queries are run with a 2-second timeout, even if your search specified a timeout. If the aggregation times out, you will be able to trigger a longer search with a 1-minute timeout by clicking `Run aggregation`. The extended timeout can be configured by changing the number of seconds in global settings `insights.aggregations.extendedTimeout`. If configuring this to greater than 60 seconds please see [More information on timeouts](../../code_search/how-to/exhaustive.md#timeouts). +At the moment all aggregations search queries are run with a 2-second timeout, even if your search specified a timeout. If the aggregation times out, you will be able to trigger a longer search with a 1-minute timeout by clicking `Run aggregation`. The extended timeout can be configured by changing the number of seconds in global settings `insights.aggregations.extendedTimeout`. After adding new repositories it can be common for aggregations to experience timeouts while those repositories await initial indexing. This is due to aggregations running exhaustive searches over all repositories and will resolve once that indexing is complete. diff --git a/docs/cody/enterprise/model-configuration.mdx b/docs/cody/enterprise/model-configuration.mdx index 983596fc5..0a5816d05 100644 --- a/docs/cody/enterprise/model-configuration.mdx +++ b/docs/cody/enterprise/model-configuration.mdx @@ -23,7 +23,7 @@ The model configuration for Cody is managed through the `"modelConfiguration"` f | **Field** | **Description** | | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [`sourcegraph`](/cody/enterprise/model-configuration#sourcegraph-provided-models) | Configures access to Sourcegraph-provided models available through Cody Gateway. | -| [`providerOverrides`](/cody/model-configuration#provider-overrides) | Configures access to models through your keys with most common LLM providers (BYOK) or hosted behind any openaicompatible endpoint | +| [`providerOverrides`](/cody/enterprise/model-configuration#provider-overrides) | Configures access to models through your keys with most common LLM providers (BYOK) or hosted behind any openaicompatible endpoint | | [`modelOverrides`](/cody/enterprise/model-configuration#model-overrides) | Extends or modifies the list of models Cody recognizes and their configurations. | | [`selfHostedModels`](/cody/enterprise/model-configuration#self-hosted-models) | Adds models to Cody’s recognized models list with default configurations provided by Sourcegraph. Only available for certain models; general models can be configured in `modelOverrides`. | | [`defaultModels`](/cody/enterprise/model-configuration#default-models) | Specifies the models assigned to each Cody feature (chat, fast chat, autocomplete). | diff --git a/docs/getting-started/github-vs-sourcegraph.mdx b/docs/getting-started/github-vs-sourcegraph.mdx index b6dc27fb0..df96e704c 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/explanations/features#symbol-search) is available for more than [75 languages](https://about.sourcegraph.com/blog/introducing-sourcegraph-server-2-6). +Sourcegraph’s [symbol search](/code-navigation/features#symbol-search) is available for more than 75 languages. | **Features** | **GitHub** | **Sourcegraph** | | --------------------------------------- | -------------------------------------------------------------------------------------------------- | --------------- | @@ -236,15 +236,15 @@ With Sourcegraph, a [search context](/code-search/working/search_contexts) repre Both GitHub and Sourcegraph offer out-of-the-box, search-based code navigation. This version of code navigation uses search-based heuristics to find references and definitions across a codebase without any setup required. It is powerful and convenient, but it can sometimes present inaccurate results. For example, it can return false positive references for symbols with common names. It is limited to returning definitions and references within a single repository (it won’t track references across multiple repositories). -GitHub’s [search-based code navigation](https://docs.github.com/en/repositories/working-with-files/using-files/navigating-code-on-github) officially supports 10 languages according to the documentation, but more languages are supported in the latest beta preview. Sourcegraph’s [search-based code navigation](/code_navigation/explanations/search_based_code_navigation) supports 40 languages. +GitHub’s [search-based code navigation](https://docs.github.com/en/repositories/working-with-files/using-files/navigating-code-on-github) officially supports 10 languages according to the documentation, but more languages are supported in the latest beta preview. Sourcegraph’s [search-based code navigation](/code-navigation/search_based_code_navigation) supports 40 languages. -| **Features** | **GitHub** | **Sourcegraph** | -| ------------------------ | ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | -| Technical implementation | Heuristic-based | Heuristic-based | -| Language support | 10 languages (C#, CodeQL, Elixir, Go, Java, JavaScript,TypeScript, PHP, Python, Ruby) | 40 languages (The full list of supported languages can be found [here](/code_navigation/explanations/search_based_code_navigation)) | -| Setup | No setup required | No setup required | -| Accuracy | Moderate (some false positives) | Moderate (some false positives) | -| Cross-repository | ✗ | ✗ | +| **Features** | **GitHub** | **Sourcegraph** | +| ------------------------ | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| Technical implementation | Heuristic-based | Heuristic-based | +| Language support | 10 languages (C#, CodeQL, Elixir, Go, Java, JavaScript,TypeScript, PHP, Python, Ruby) | 40 languages (The full list of supported languages can be found [here](/code-navigation/search_based_code_navigation)) | +| Setup | No setup required | No setup required | +| Accuracy | Moderate (some false positives) | Moderate (some false positives) | +| Cross-repository | ✗ | ✗ | ### Precise code navigation @@ -252,21 +252,21 @@ GitHub and Sourcegraph both offer precise code navigation as well. Despite havin GitHub’s [precise code navigation](https://docs.github.com/en/repositories/working-with-files/using-files/navigating-code-on-github#precise-and-search-based-navigation) is an improved form of heuristic-based code navigation which uses syntax trees to offer higher accuracy for references and definitions and cross-repository navigation. It is more accurate than GitHub’s search-based code navigation, but it can still present inaccuracies. It is available out-of-the-box on GitHub and is automatically used over search-based code navigation when available. It is supported for 1 language, Python. -Sourcegraph’s [precise code navigation](/code_navigation/explanations/precise_code_navigation) is not heuristic-based. Instead, it uses [SCIP and LSIF](/code_navigation/references/indexers) data to deliver precomputed code navigation, meaning that it is fast and compiler-accurate. It is the only 100% accurate solution for code navigation between Sourcegraph’s and GitHub’s offerings. +Sourcegraph’s [precise code navigation](/code-navigation/precise_code_navigation) is not heuristic-based. Instead, it uses SCIP and LSIF data to deliver precomputed code navigation, meaning that it is fast and compiler-accurate. It is the only 100% accurate solution for code navigation between Sourcegraph’s and GitHub’s offerings. -Because precise code navigation uses code graph (SCIP) data, it is not susceptible to false positives or other potential errors (such as those caused by symbols with the same name). It also supports cross-repository navigation, which shows symbol usage across repositories and [transitive dependencies](/code_navigation/explanations/features#beta-dependency-navigation). It also has a unique feature, “Find implementations,” which allows you to navigate to a symbol’s interface definition or find all the places an interface is being implemented. +Because precise code navigation uses code graph (SCIP) data, it is not susceptible to false positives or other potential errors (such as those caused by symbols with the same name). It also supports cross-repository navigation, which shows symbol usage across repositories and [transitive dependencies](/code-navigation/features#beta-dependency-navigation). It also has a unique feature, “Find implementations,” which allows you to navigate to a symbol’s interface definition or find all the places an interface is being implemented. -Sourcegraph’s precise code navigation is opt-in and requires you to upload code graph data ([LSIF or SCIP](/code_navigation/references/indexers)) to Sourcegraph. This data can be automatically generated and uploaded to Sourcegraph via [auto-indexing](/code_navigation/explanations/auto_indexing). For repositories without SCIP or LSIF data, Sourcegraph automatically falls back to search-based code navigation. +Sourcegraph’s precise code navigation is opt-in and requires you to upload code graph data (LSIF or SCIP) to Sourcegraph. This data can be automatically generated and uploaded to Sourcegraph via [auto-indexing](/code-navigation/auto_indexing). For repositories without SCIP or LSIF data, Sourcegraph automatically falls back to search-based code navigation. -Sourcegraph’s precise code navigation [supports 11 languages](/code_navigation/references/indexers). +Sourcegraph’s precise code navigation supports 11 languages. -| **Features** | **GitHub** | **Sourcegraph** | -| ------------------------ | --------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| Technical implementation | Heuristic-based | SCIP-based (code graph data) | -| Accuracy | High (some false positives) | Perfect (compiler-accurate) | -| Language support | 1 language (Python) | 11 languages (Go, TypeScript, JavaScript, C, C++, Java, Scala, Kotlin, Rust, Python, Ruby) | -| Setup | No setup required | Opt-in (Must set up LSIF/SCIP indexing. [Auto-indexing](/code_navigation/explanations/auto_indexing) available.) | -| Cross-repository | ✓ | ✓ | +| **Features** | **GitHub** | **Sourcegraph** | +| ------------------------ | --------------------------- | --------------------------------------------------------------------------------------------------- | +| Technical implementation | Heuristic-based | SCIP-based (code graph data) | +| Accuracy | High (some false positives) | Perfect (compiler-accurate) | +| Language support | 1 language (Python) | 11 languages (Go, TypeScript, JavaScript, C, C++, Java, Scala, Kotlin, Rust, Python, Ruby) | +| Setup | No setup required | Opt-in (Must set up LSIF/SCIP indexing. [Auto-indexing](/code-navigation/auto_indexing) available.) | +| Cross-repository | ✓ | ✓ | ## Codebase insights and analytics diff --git a/docs/integration/browser_extension/how-tos/troubleshooting.mdx b/docs/integration/browser_extension/how-tos/troubleshooting.mdx index c4f343f13..fc56a45cf 100644 --- a/docs/integration/browser_extension/how-tos/troubleshooting.mdx +++ b/docs/integration/browser_extension/how-tos/troubleshooting.mdx @@ -44,9 +44,7 @@ If that still doesn't help, take a screenshot of the console and network activit ## Unable to connect to `http://...` Ensure the URL is correct and you are logged in -Since `v3.14.0+`, the Sourcegraph browser extension can only authenticate with Sourcegraph instances that have [HTTPS](/admin/tls_ssl) configured. - -Previously, the Sourcegraph browser extension was able to authenticate with instances that hadn't enabled tls / ssl. However, modern web browsers have started to adopt and implement [an IETF proposal](https://web.dev/samesite-cookies-explained/) that removes the deprecated logic that allowed this behavior. Please configure [HTTPS](/admin/tls_ssl) in order to continue using the browser extension with your private instance. +The Sourcegraph browser extension can only authenticate with Sourcegraph instances that have [HTTPS](/self-hosted/http_https_configuration) configured. ## `The string did not match the expected pattern` error in Safari diff --git a/docs/integration/browser_extension/quickstart.mdx b/docs/integration/browser_extension/quickstart.mdx index ef57196e5..d3d578072 100644 --- a/docs/integration/browser_extension/quickstart.mdx +++ b/docs/integration/browser_extension/quickstart.mdx @@ -31,7 +31,7 @@ To use the browser extension with your private repositories, you need to set up Follow these instructions: -1. [Install Sourcegraph](/admin/install). Skip this step if you already have a private Sourcegraph instance. +1. [Install Sourcegraph](/self-hosted/deploy/). Skip this step if you already have a private Sourcegraph instance. 2. Click the Sourcegraph extension icon in the browser toolbar on the browser tab for your private Sourcegraph instance then open the settings page. 3. Enter the URL (including the protocol) of your Sourcegraph instance (such as `https://sourcegraph.example.com`) 4. Make sure the connection status shows "Looks good!" diff --git a/docs/self-hosted/deploy/kubernetes/kustomize/index.mdx b/docs/self-hosted/deploy/kubernetes/kustomize/index.mdx index b6ebcd268..a5f33b0d2 100644 --- a/docs/self-hosted/deploy/kubernetes/kustomize/index.mdx +++ b/docs/self-hosted/deploy/kubernetes/kustomize/index.mdx @@ -4,10 +4,10 @@ An introduction to Kustomize created for Sourcegraph. - + - - + + diff --git a/docs/self-hosted/executors/deploy_executors_binary_offline.mdx b/docs/self-hosted/executors/deploy_executors_binary_offline.mdx index 163e083d6..e6f44d666 100644 --- a/docs/self-hosted/executors/deploy_executors_binary_offline.mdx +++ b/docs/self-hosted/executors/deploy_executors_binary_offline.mdx @@ -36,13 +36,11 @@ variables that are configurable. ## Batch Changes -Batch Changes requires either `src-cli` to be installed on the host machine or -for [Native Execution](/admin/executors/native_execution) to be enabled. +Batch Changes requires `src-cli` to be installed on the host machine for running batch changes [server-side](/batch-changes/server-side). ### src-cli -Executors requires the `src-cli` to be installed on the host machine, if not -using [Native Execution](/admin/executors/native_execution) for Batch Changes. To install `src-cli`: +Executors require `src-cli` to be installed on the host machine. To install `src-cli`: 1. Download the `src-cli` binary [version](https://github.com/sourcegraph/src-cli/releases) that matches your deployed Sourcegraph Version (e.g. `v4.1.0`) from a machine with internet access. @@ -59,10 +57,7 @@ using [Native Execution](/admin/executors/native_execution) for Batch Changes. T Current version: 4.1.0 ``` -### Native Execution - -See [Native Execution](native_execution) for details on how to enable Native Execution. Ensure the -image `sourcegraph/batcheshelper` is available in the internal Docker Registry. +Ensure the image `sourcegraph/batcheshelper` is available in the internal Docker Registry if using the native execution mode. ## Auto Indexing diff --git a/docs/self-hosted/executors/deploy_executors_dind.mdx b/docs/self-hosted/executors/deploy_executors_dind.mdx index b82d2081e..2e489794d 100644 --- a/docs/self-hosted/executors/deploy_executors_dind.mdx +++ b/docs/self-hosted/executors/deploy_executors_dind.mdx @@ -23,13 +23,13 @@ To include Executors dind, see [configure Sourcegraph with Kustomize](/self-host #### Deployment via Helm -Please refer to the [Sourcegraph Helm docs](/admin/deploy/kubernetes/helm#quickstart) for the latest instructions. +Please refer to the [Sourcegraph Helm docs](/self-hosted/deploy/kubernetes#quickstart) for the latest instructions. To specifically deploy Executors, 1. Create an overrides file, `override.yaml`, with any other customizations you may require. - 1. See [details on configurations](/admin/deploy/kubernetes/helm#configuration) + 1. See [details on configurations](/self-hosted/deploy/kubernetes#configuration) 2. See [here](/self-hosted/executors/executors_config) for a full list of executor environment variables 2. Run the following command: diff --git a/docs/self-hosted/executors/deploy_executors_kubernetes.mdx b/docs/self-hosted/executors/deploy_executors_kubernetes.mdx index fd4499e51..2b60121e7 100644 --- a/docs/self-hosted/executors/deploy_executors_kubernetes.mdx +++ b/docs/self-hosted/executors/deploy_executors_kubernetes.mdx @@ -4,7 +4,7 @@ This feature is in beta and is available in Sourcegraph 5.1.0 and later. -The native Kubernetes Executors have a master Executor pod that schedules worker pods via the Kubernetes API. The master Executor pod manages the lifecycle of jobs, while the worker pods process the actual [batch change](/batch_changes/explanations/server_side) or [precise auto indexing](/code-navigation/auto_indexing) job specs. For more details, see [how it works](/admin/executors#native-kubernetes). +The native Kubernetes Executors have a master Executor pod that schedules worker pods via the Kubernetes API. The master Executor pod manages the lifecycle of jobs, while the worker pods process the actual [batch change](/batch-changes/server-side) or [precise auto indexing](/code-navigation/auto_indexing) job specs. For more details, see [how it works](/admin/executors#native-kubernetes). ## Requirements diff --git a/docs/self-hosted/observability/alerts.mdx b/docs/self-hosted/observability/alerts.mdx index 6e813d3f3..028b516c7 100644 --- a/docs/self-hosted/observability/alerts.mdx +++ b/docs/self-hosted/observability/alerts.mdx @@ -244,7 +244,7 @@ Generated query for warning alert: `max((histogram_quantile(0.9, sum by (le) (ra - **Check that most repositories are indexed** by visiting https://sourcegraph.example.com/site-admin/repositories?filter=needs-index (it should show few or no results.) - **Kubernetes:** Check CPU usage of zoekt-webserver in the indexed-search pod, consider increasing CPU limits in the `indexed-search.Deployment.yaml` if regularly hitting max CPU utilization. - **Docker Compose:** Check CPU usage on the Zoekt Web Server dashboard, consider increasing `cpus:` of the zoekt-webserver container in `docker-compose.yml` if regularly hitting max CPU utilization. -- This alert may indicate that your instance is struggling to process symbols queries on a monorepo, [learn more here](../how-to/monorepo-issues). +- This alert may indicate that your instance is struggling to process symbols queries on a monorepo. - Learn more about the related dashboard panel in the [dashboards reference](dashboards#frontend-99th-percentile-search-codeintel-request-duration). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -279,7 +279,7 @@ Generated query for warning alert: `max((histogram_quantile(0.99, sum by (le) (r - **Check that most repositories are indexed** by visiting https://sourcegraph.example.com/site-admin/repositories?filter=needs-index (it should show few or no results.) - **Kubernetes:** Check CPU usage of zoekt-webserver in the indexed-search pod, consider increasing CPU limits in the `indexed-search.Deployment.yaml` if regularly hitting max CPU utilization. - **Docker Compose:** Check CPU usage on the Zoekt Web Server dashboard, consider increasing `cpus:` of the zoekt-webserver container in `docker-compose.yml` if regularly hitting max CPU utilization. -- This alert may indicate that your instance is struggling to process symbols queries on a monorepo, [learn more here](../how-to/monorepo-issues). +- This alert may indicate that your instance is struggling to process symbols queries on a monorepo. - Learn more about the related dashboard panel in the [dashboards reference](dashboards#frontend-90th-percentile-search-codeintel-request-duration). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: diff --git a/docs/self-hosted/observability/logs.mdx b/docs/self-hosted/observability/logs.mdx index aefdf7e78..99e179a52 100644 --- a/docs/self-hosted/observability/logs.mdx +++ b/docs/self-hosted/observability/logs.mdx @@ -30,7 +30,7 @@ The valid values are: ### OpenTelemetry -When [configured to export JSON logs](#log-format), Sourcegraph services that have migrated to the [new internal logging standard](/dev/how-to/add_logging) that will export a JSON log format compliant with [OpenTelemetry's log data model](https://opentelemetry.io/docs/reference/specification/logs/data-model/): +When [configured to export JSON logs](#log-format), Sourcegraph services export a JSON log format compliant with [OpenTelemetry's log data model](https://opentelemetry.io/docs/reference/specification/logs/data-model/): ```json { diff --git a/docs/self-hosted/updates/docker_compose.mdx b/docs/self-hosted/updates/docker_compose.mdx index e3699a789..5b99021c2 100644 --- a/docs/self-hosted/updates/docker_compose.mdx +++ b/docs/self-hosted/updates/docker_compose.mdx @@ -251,11 +251,11 @@ This release introduces a background job that will convert all LSIF data into SC #### Notes: - Target the tag [`v3.31.2`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.31.2/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. -- The **built-in** main Postgres (`pgsql`) and codeintel (`codeintel-db`) databases have switched to an alpine-based Docker image. Upon upgrading, Sourcegraph will need to re-index the entire database. All users that use our bundled (built-in) database instances **must** read through the [3.31 upgrade guide](/admin/migration/3_31) _before_ upgrading. +- The **built-in** main Postgres (`pgsql`) and codeintel (`codeintel-db`) databases have switched to an alpine-based Docker image. Upon upgrading, Sourcegraph will need to re-index the entire database. ## v3.29 ➔ v3.30 -> WARNING: **If you have already upgraded to 3.30.0, 3.30.1, or 3.30.2** please follow [this migration guide](/admin/migration/3_30). +> WARNING: **If you have already upgraded to 3.30.0, 3.30.1, or 3.30.2** please see the rebuild corrupt postgres indexes guide for recovery steps. #### Notes: diff --git a/docs/self-hosted/updates/kubernetes.mdx b/docs/self-hosted/updates/kubernetes.mdx index eb2496c21..ae6451e52 100644 --- a/docs/self-hosted/updates/kubernetes.mdx +++ b/docs/self-hosted/updates/kubernetes.mdx @@ -198,11 +198,11 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgres #### Notes: -- The **built-in** main Postgres (`pgsql`) and codeintel (`codeintel-db`) databases have switched to an alpine-based Docker image. Upon upgrading, Sourcegraph will need to re-index the entire database. All users that use our bundled (built-in) database instances **must** read through the [3.31 upgrade guide](/admin/migration/3_31) _before_ upgrading. +- The **built-in** main Postgres (`pgsql`) and codeintel (`codeintel-db`) databases have switched to an alpine-based Docker image. Upon upgrading, Sourcegraph will need to re-index the entire database. ## v3.29 ➔ v3.30 -> WARNING: **If you have already upgraded to 3.30.0, 3.30.1, or 3.30.2** please follow [this migration guide](/admin/migration/3_30). +> WARNING: **If you have already upgraded to 3.30.0, 3.30.1, or 3.30.2** please see the rebuild corrupt postgres indexes guide for recovery steps. #### Notes: diff --git a/docs/self-hosted/updates/migrator/schema-drift.mdx b/docs/self-hosted/updates/migrator/schema-drift.mdx index 8401e9a6d..69b394b95 100644 --- a/docs/self-hosted/updates/migrator/schema-drift.mdx +++ b/docs/self-hosted/updates/migrator/schema-drift.mdx @@ -7,7 +7,7 @@ During an upgrade you may run into the following message. ``` * Sourcegraph migrator v4.1.3 ❌ Schema drift detected for frontend -💡 Before continuing with this operation, run the migrator's drift command and follow instructions to repair the schema to the expected current state. [See these docs](/admin/how-to/manual_database_migrations#drift) for additional instructions. +💡 Before continuing with this operation, run the migrator's drift command and follow instructions to repair the schema to the expected current state. ``` This error indicates that `migrator` has detected some difference between the state of the schema in your database and the expected schema for the database in the `-from` or current version of your Sourcegraph instance. diff --git a/docs/self-hosted/updates/pure_docker.mdx b/docs/self-hosted/updates/pure_docker.mdx index 78f98a549..103a00daf 100644 --- a/docs/self-hosted/updates/pure_docker.mdx +++ b/docs/self-hosted/updates/pure_docker.mdx @@ -513,11 +513,11 @@ As a template, perform the same actions as the following diffs in your own deplo **Notes**: -- The **built-in** main Postgres (`pgsql`) and codeintel (`codeintel-db`) databases have switched to an alpine-based Docker image. Upon upgrading, Sourcegraph will need to re-index the entire database. All users that use our bundled (built-in) database instances **must** read through the [3.31 upgrade guide](/admin/migration/3_31) _before_ upgrading. +- The **built-in** main Postgres (`pgsql`) and codeintel (`codeintel-db`) databases have switched to an alpine-based Docker image. Upon upgrading, Sourcegraph will need to re-index the entire database. ## v3.29 ➔ v3.30 -> WARNING: **If you have already upgraded to 3.30.0, 3.30.1, or 3.30.2** please follow [this migration guide](/admin/migration/3_30). +> WARNING: **If you have already upgraded to 3.30.0, 3.30.1, or 3.30.2** please see the rebuild corrupt postgres indexes guide for recovery steps. As a template, perform the same actions as the following diffs in your own deployment: diff --git a/docs/self-hosted/updates/server.mdx b/docs/self-hosted/updates/server.mdx index 057b03643..0e75c29b1 100644 --- a/docs/self-hosted/updates/server.mdx +++ b/docs/self-hosted/updates/server.mdx @@ -38,7 +38,7 @@ For upgrade procedures or general info about sourcegraph versioning see the link #### Notes: -- The Docker Single Container Deployment image has switched to a Wolfi-based container image. Upon upgrading, Sourcegraph will need to re-index the entire database. All users **must** read through the [5.1 upgrade guide](/admin/migration/5_1) _before_ upgrading. +- The Docker Single Container Deployment image has switched to a Wolfi-based container image. Upon upgrading, Sourcegraph will need to re-index the entire database. ## v4.4.2 ➔ v4.5.0 @@ -58,11 +58,11 @@ For upgrade procedures or general info about sourcegraph versioning see the link #### Notes: -- The **built-in** main Postgres (`pgsql`) and codeintel (`codeintel-db`) databases have switched to an alpine-based Docker image. Upon upgrading, Sourcegraph will need to re-index the entire database. All users that use our bundled (built-in) database instances **must** read through the [3.31 upgrade guide](/admin/migration/3_31) _before_ upgrading. +- The **built-in** main Postgres (`pgsql`) and codeintel (`codeintel-db`) databases have switched to an alpine-based Docker image. Upon upgrading, Sourcegraph will need to re-index the entire database. ## v3.29 ➔ v3.30 -> WARNING: **If you have already upgraded to 3.30.0, 3.30.1, or 3.30.2** please follow [this migration guide](/admin/migration/3_30). +> WARNING: **If you have already upgraded to 3.30.0, 3.30.1, or 3.30.2** please see the rebuild corrupt postgres indexes guide for recovery steps. ## v3.26 ➔ v3.27 diff --git a/docs/technical-changelog.mdx b/docs/technical-changelog.mdx index c8c7ac5cd..2f5236ca6 100644 --- a/docs/technical-changelog.mdx +++ b/docs/technical-changelog.mdx @@ -8121,7 +8121,7 @@ There were no reverts for this release - Introduce a new experimental embeddings index and context retriever. - Make scip-syntax process multiple languages in a single invocation `(PR #364)` - Add OpenAI o1 models and early-access models support to Cody Gateway `(PR #323)` - - [feat(code gateway): add support for OpenAI o1 models and early-access models handling.](feat: add OpenAI o1 models and early-access models support to Cody Gateway) + - feat(code gateway): add support for OpenAI o1 models and early-access models handling. - Implements pagination for syntactic usages `(PR #310)` ### Fix @@ -11222,7 +11222,7 @@ The following PRs were merged onto the previous release branch but could not be ### Changed -- `cody.restrictUsersFeatureFlag` has been deprecated and replaced by role based access control instead. Until the old configuration value is removed from your site config, it will be respected just as before but with a warning displayed at the top of Sourcegraph. Once removed, the old feature flag will not be respected and instead the Cody access will be managed via role based access controls, see [the docs](/cody/overview/enable-cody-enterprise#enable-cody-only-for-some-users) for more information. [#58831](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/58831) +- `cody.restrictUsersFeatureFlag` has been deprecated and replaced by role based access control instead. Until the old configuration value is removed from your site config, it will be respected just as before but with a warning displayed at the top of Sourcegraph. Once removed, the old feature flag will not be respected and instead the Cody access will be managed via role based access controls. [#58831](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/58831) - The setting `experimentalFeatures.searchQueryInput` now refers to the new query input as `v2` (not `experimental`). - Search-based code intel doesn't include the currently selected search context anymore. It was possible to get into a situation where search-based code intel wouldn't find any information due to being restricted by the current search context. [#58010](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/58010) - The last commit which changed a file/directory is now shown in the files panel on the repo and file pages. To avoid duplicating information and confusion, the commits panel was removed. [58328](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/58328) @@ -11234,7 +11234,7 @@ The following PRs were merged onto the previous release branch but could not be - For `size` the supported units are `B`, `b`, `kB`, `KB`, `kiB`, `KiB`, `MiB`, `MB`, `GiB`, `GB`. No decimals points are supported. - Structural Search is now disabled by default. To enable it, set `experimentalFeatures.structuralSearch: "enabled"` in the site configuration. [#57584](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/57584) - Search Jobs switches the format of downloaded results from CSV to JSON. [#59619](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/59619) -- [Search Jobs](/code_search/how-to/search-jobs) is now in beta and enabled by default. It can be disabled in the site configuration by setting `experimentalFeatures.searchJobs: false`. +- [Search Jobs](/code-search/types/search-jobs) is now in beta and enabled by default. It can be disabled in the site configuration by setting `experimentalFeatures.searchJobs: false`. - The search input on the search homepage is now automatically focused when the page loads. - GRPC is now the only method for our internal APIs, and can not be disabled. All of corresponding the REST implementations have been removed. The vast majority of customers upgrading to 5.3 don't need to take any action - The change should be invisible. However, if you have restrictions on Sourcegraph’s internal (service to service) traffic, some firewall or security configurations may be necessary. You can downgrade to Sourcegraph 5.2 and disable gRPC while you troubleshoot / reach out to our customer support team. See [https://sourcegraph.com/docs/admin/updates/grpc](https://sourcegraph.com/docs/admin/updates/grpc) for more details. [#59093](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/59093) - The default `count:` for search has been increased to 10000, significantly increasing the number of searches that are exhaustive by default. [#60114](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/60114) @@ -11374,7 +11374,7 @@ The following PRs were merged onto the previous release branch but could not be - Recorded command logs can now be viewed for Git operations performed by Sourcegraph. This provides auditing and debugging capabilities. [#54997](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/54997) - Disk usage metrics for gitservers are now displayed on the site admin Git Servers page, showing free/total disk space. This helps site admins monitor storage capacity on GitServers. [#55958](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/55958) - Overhauled Admin Onboarding UI for enhanced user experience, introducing a license key modal with validation, automated navigation to Site Configuration Page, an interactive onboarding checklist button, and direct documentation links for SMTP and user authentication setup. [56366](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/56366) -- New experimental feature "Search Jobs". Search Jobs allows you to run search queries across your organization's codebase (all repositories, branches, and revisions) at scale. It enhances the existing Sourcegraph's search capabilities, enabling you to run searches without query timeouts or incomplete results. Please refer to the [documentation](/code_search/how-to/search-jobs) for more information. +- New experimental feature "Search Jobs". Search Jobs allows you to run search queries across your organization's codebase (all repositories, branches, and revisions) at scale. It enhances the existing Sourcegraph's search capabilities, enabling you to run searches without query timeouts or incomplete results. Please refer to the [documentation](/code-search/types/search-jobs) for more information. ### Changed @@ -11383,7 +11383,7 @@ The following PRs were merged onto the previous release branch but could not be - Newly created access tokens are now hidden by default in the Sourcegraph UI. To view a token, click "show" button next to the token. [#56481](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/56481) - The GitHub proxy service has been removed and is no longer required. You can safely remove it from your deployment. [#55290](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/55290) - On startup, Zoekt indexserver will now delete the `/.indexserver.tmp` directory to remove leftover repository clones, possibly causing a brief delay. Due to a bug, this directory wasn't previously cleaned up and could cause unnecessary disk usage. [zoekt#646](https://github.com/sourcegraph/zoekt/pull/646). -- GRPC is now used by default for all internal (service to service) communication. This change should be invisible to most customers. However, if you're running in an environment that places restrictions on Sourcegraph's internal traffic, some prior configuration might be required. See the ["Sourcegraph 5.2 gRPC Configuration Guide"](/admin/updates/grpc) for more information. [#56738](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/56738) +- GRPC is now used by default for all internal (service to service) communication. This change should be invisible to most customers. However, if you're running in an environment that places restrictions on Sourcegraph's internal traffic, some prior configuration might be required. [#56738](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/56738) ### Fixed @@ -11581,7 +11581,7 @@ The following PRs were merged onto the previous release branch but could not be been marked as deprecated and will be removed in a future release [#52566](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/52566) - Update minimum supported Redis version to 6.2 [#52248](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/52248) - The batch spec properties [`transformChanges`](/batch-changes/batch-spec-yaml-reference#transformchanges) and [`workspaces`](/batch-changes/batch-spec-yaml-reference#workspaces) are now generally available. -- Cody feature flags have been simplified [#52919](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/52919) See [the docs page for complete setup details](/cody/explanations/enabling_cody_enterprise) +- Cody feature flags have been simplified [#52919](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/52919) - `cody.enabled` in site-config now controls whether Cody is on/off, default `false`. - When `cody.enabled` is set and no specific configuration for `completions` and `embeddings` are given, Cody will by default talk to the `sourcegraph` provider, Sourcegraphs Cody Gateway which allows access to chat completions and embeddings. - Enabling Cody now requires `cody.enabled` set to `true` and `completions` to be set. @@ -11591,7 +11591,7 @@ The following PRs were merged onto the previous release branch but could not be - The embeddings configuration now requires a `provider` field to be set. - Ping data now reflects whether `cody.enabled` and `completions` are set. - If a Sourcegraph request is traced, its trace ID and span ID are now set to the `X-Trace` and `X-Trace-Span` response headers respectively. The trace URL (if a template is configured in `observability.tracing.urlTemplate`) is now set to `X-Trace-URL` - Previously, the URL was set to `X-Trace`. [#53259](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/53259) -- For users using the single-container server image with the default built-in database, the database must be reindexed. This process can take up to a few hours on systems with large datasets. See [Migrating to Sourcegraph 5.1.x](/admin/migration/5_1) for full details. [#53256](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/53256) +- For users using the single-container server image with the default built-in database, the database must be reindexed. This process can take up to a few hours on systems with large datasets. [#53256](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/53256) - [Sourcegraph Own](/own) is now available as a beta enterprise feature. `search-ownership` feature flag is removed and doesn't need to be used. - Update Jaeger to 1.45.0, and Opentelemetry-Collector to 0.75.0 [#54000](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/54000) - Switched container OS to Wolfi for hardened containers [#47182](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/47182), [#47368](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/47368) @@ -11795,7 +11795,7 @@ The following PRs were merged onto the previous release branch but could not be - Monitoring: the searcher dashboard now contains more detailed request metrics as well as information on interactions with the local cache (via gitserver). [#47654](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/47654) - Renders GitHub pull request references in the commit list. [#47593](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/47593) - Added a new background permissions syncer & scheduler which is backed by database, unlike the old one that was based on an in-memory processing queue. The new system is enabled by default, but can be disabled. Revert to the in-memory processing queue by setting the feature flag `database-permission-sync-worker` to `false`. [#47783](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/47783) -- Zoekt introduces a new opt-in feature, "shard merging". Shard merging consolidates small index files into larger ones, which reduces Zoekt-webserver's memory footprint [documenta[tion](/code_search/explanations/search_details#shard-merging)) +- Zoekt introduces a new opt-in feature, "shard merging". Shard merging consolidates small index files into larger ones, which reduces Zoekt-webserver's memory footprint. - Blob viewer is now backed by the CodeMirror editor. Previous table-based blob viewer can be re-enabled by setting `experimentalFeatures.enableCodeMirrorFileView` to `false`. [#47563](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/47563) - Code folding support for the CodeMirror blob viewer. [#47266](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/47266) - CodeMirror blob keyboard navigation as experimental feature. Can be enabled in settings by setting `experimentalFeatures.codeNavigation` to `selection-driven`. [#44698](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/44698) From 72637b0e9c689adce044e377220c020d41f0c4b6 Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 22:37:46 +0100 Subject: [PATCH 14/21] Consistently use hyphens over underscores Noticed we're quite inconsistent here. This updates all files and links, and adds redirects to keep this change backwards compatible. --- .../batch-changes.mdx} | 2 +- .../index.mdx | 8 +- .../ownership.mdx | 2 +- docs/admin/architecture.mdx | 18 +- docs/admin/{audit_log.mdx => audit-log.mdx} | 0 docs/admin/auth/builtin.mdx | 4 +- docs/admin/auth/index.mdx | 30 +- .../auth/{login_form.mdx => login-form.mdx} | 12 +- .../auth/saml/{azure_ad.mdx => azure-ad.mdx} | 0 docs/admin/auth/saml/generic.mdx | 6 +- docs/admin/auth/saml/index.mdx | 12 +- .../saml/{jump_cloud.mdx => jump-cloud.mdx} | 2 +- ...{microsoft_adfs.mdx => microsoft-adfs.mdx} | 6 +- .../saml/{one_login.mdx => one-login.mdx} | 0 ...mdx => beta-and-experimental-features.mdx} | 0 .../aws-codecommit.mdx} | 2 +- .../azuredevops.mdx | 8 +- .../bitbucket-cloud.mdx} | 12 +- .../bitbucket-server.mdx} | 28 +- .../{code_hosts => code-hosts}/gerrit.mdx | 6 +- .../{code_hosts => code-hosts}/github.mdx | 22 +- .../{code_hosts => code-hosts}/gitlab.mdx | 14 +- .../{code_hosts => code-hosts}/gitolite.mdx | 2 +- .../{code_hosts => code-hosts}/index.mdx | 24 +- .../{code_hosts => code-hosts}/non-git.mdx | 2 +- .../{code_hosts => code-hosts}/other.mdx | 4 +- .../phabricator.mdx | 6 +- .../rate-limits.mdx} | 20 +- .../src-serve-git.mdx} | 6 +- ...x => authorization-and-authentication.mdx} | 8 +- .../{batch_changes.mdx => batch-changes.mdx} | 8 +- docs/admin/config/index.mdx | 10 +- docs/admin/config/settings.mdx | 2 +- .../{site_config.mdx => site-config.mdx} | 2 +- ...x => enterprise-getting-started-guide.mdx} | 10 +- ...cutor_secrets.mdx => executor-secrets.mdx} | 0 docs/admin/executors/index.mdx | 4 +- docs/admin/faq.mdx | 6 +- .../how-to/enable-experimental-feature.mdx | 2 +- docs/admin/how-to/index.mdx | 6 +- ...ub_repos.mdx => internal-github-repos.mdx} | 2 +- ..._migration.mdx => lsif-scip-migration.mdx} | 6 +- docs/admin/how-to/mutate-user-api.mdx | 2 +- docs/admin/how-to/repo-not-updated.mdx | 4 +- docs/admin/how-to/site-admin-quickstart.mdx | 6 +- docs/admin/how-to/unknown-error-login.mdx | 2 +- ...po_failure.mdx => update-repo-failure.mdx} | 0 docs/admin/index.mdx | 10 +- docs/admin/licensing.mdx | 2 +- docs/admin/migration/opengrok.mdx | 8 +- docs/admin/{oauth_apps.mdx => oauth-apps.mdx} | 2 +- docs/admin/organizations.mdx | 2 +- docs/admin/outbound-request-log.mdx | 6 +- docs/admin/permissions/api.mdx | 4 +- docs/admin/permissions/index.mdx | 22 +- docs/admin/permissions/webhooks.mdx | 2 +- docs/admin/pings.mdx | 2 +- docs/admin/repo/add.mdx | 16 +- docs/admin/repo/auth.mdx | 6 +- .../repo/{git_config.mdx => git-config.mdx} | 0 docs/admin/repo/index.mdx | 6 +- docs/admin/repo/metadata.mdx | 2 +- docs/admin/repo/perforce.mdx | 10 +- docs/admin/repo/plasticscm.mdx | 2 +- ..._disk.mdx => pre-load-from-local-disk.mdx} | 6 +- docs/admin/repo/recording.mdx | 2 +- ...ate_frequency.mdx => update-frequency.mdx} | 8 +- docs/admin/repo/webhooks.mdx | 4 +- docs/admin/scim.mdx | 2 +- docs/admin/search.mdx | 4 +- ...event_logs.mdx => security-event-logs.mdx} | 6 +- ...vice_accounts.mdx => service-accounts.mdx} | 18 +- ...ta_deletion.mdx => user-data-deletion.mdx} | 0 .../{user_surveys.mdx => user-surveys.mdx} | 0 docs/admin/webhooks/incoming.mdx | 6 +- docs/api/graphql/index.mdx | 4 +- .../managing-code-insights-with-api.mdx | 4 +- .../managing-search-contexts-with-api.mdx | 2 +- docs/api/graphql/search.mdx | 2 +- docs/api/index.mdx | 2 +- docs/api/mcp/index.mdx | 6 +- docs/api/{stream_api => stream-api}/index.mdx | 2 +- .../batch-spec-yaml-reference.mdx | 4 +- .../batch-changes/configuring-credentials.mdx | 4 +- docs/batch-changes/faq.mdx | 2 +- .../permissions-in-batch-changes.mdx | 6 +- docs/batch-changes/publishing-changesets.mdx | 2 +- docs/batch-changes/requirements.mdx | 8 +- docs/batch-changes/server-side.mdx | 6 +- .../site-admin-configuration.mdx | 16 +- docs/cli/explanations/env.mdx | 2 +- ...token.mdx => creating-an-access-token.mdx} | 0 .../{fetch_sboms.mdx => fetch-sboms.mdx} | 0 docs/cli/how-tos/index.mdx | 10 +- ..._tokens.mdx => managing-access-tokens.mdx} | 0 ...token.mdx => revoking-an-access-token.mdx} | 0 ...es.mdx => verify-container-signatures.mdx} | 0 docs/cli/references/serve-git.mdx | 2 +- docs/cloud/index.mdx | 28 +- .../{logpush_gcs.mdx => logpush-gcs.mdx} | 0 docs/cloud/{logpush_s3.mdx => logpush-s3.mdx} | 0 ...y_aws.mdx => private-connectivity-aws.mdx} | 10 +- ...y_gcp.mdx => private-connectivity-gcp.mdx} | 10 +- ...mdx => private-connectivity-public-lb.mdx} | 8 +- ...vate-connectivity-sourcegraph-connect.mdx} | 4 +- ...tration-and-security-of-code-insights.mdx} | 0 .../automatically-generated-data-series.mdx} | 2 +- .../explanations/code-insights-filters.mdx} | 2 +- .../current-limitations-of-code-insights.mdx} | 10 +- .../explanations/data-retention.mdx} | 0 docs/code-insights/explanations/index.mdx | 11 + .../search-results-aggregations.mdx} | 2 +- .../explanations/viewing-code-insights.mdx} | 4 +- .../how-tos/Troubleshooting.mdx | 0 ...g-a-custom-dashboard-of-code-insights.mdx} | 4 +- .../how-tos/filtering-an-insight.mdx} | 10 +- docs/code-insights/how-tos/index.mdx | 7 + .../index.mdx | 8 +- .../language-insight-quickstart.mdx} | 10 +- .../quickstart.mdx | 14 +- ...insights-may-not-match-search-results.mdx} | 0 .../references/common-use-cases.mdx} | 14 +- .../references/incomplete-data-points.mdx} | 2 +- docs/code-insights/references/index.mdx | 11 + .../references/license.mdx | 0 .../references/repository-scope.mdx} | 2 +- .../references/requirements.mdx | 0 .../search-aggregations-use-cases.mdx} | 2 +- .../types/inventory-stats.mdx | 0 .../campaigns-icon.svg | 0 .../file-icon.svg | 0 .../index.mdx | 0 ...on.mdx => auto-indexing-configuration.mdx} | 2 +- .../{auto_indexing.mdx => auto-indexing.mdx} | 36 +- ...erence.mdx => auto-indexing-inference.mdx} | 6 +- docs/code-navigation/explanations/uploads.mdx | 2 +- docs/code-navigation/features.mdx | 6 +- ...flows.mdx => adding-scip-to-workflows.mdx} | 10 +- ...-uploads-from-ci-cd-and-auto-indexing.mdx} | 8 +- ...pository.mdx => index-a-go-repository.mdx} | 0 ...-typescript-and-javascript-repository.mdx} | 0 ...anguages.mdx => index-other-languages.mdx} | 10 +- docs/code-navigation/how-to/index.mdx | 12 +- ...olicies-resource-usage-best-practices.mdx} | 2 +- docs/code-navigation/index.mdx | 10 +- ...ration.mdx => inference-configuration.mdx} | 12 +- ...gation.mdx => precise-code-navigation.mdx} | 18 +- ...private-maven-repository-configuration.mdx | 2 +- ...n.mdx => search-based-code-navigation.mdx} | 2 +- ...tion.mdx => syntactic-code-navigation.mdx} | 2 +- docs/code-navigation/troubleshooting.mdx | 2 +- ..._an_indexer.mdx => writing-an-indexer.mdx} | 8 +- docs/code-search/features.mdx | 2 +- ....mdx => create-search-context-graphql.mdx} | 2 +- docs/code-search/how-to/index.mdx | 2 +- docs/code-search/index.mdx | 4 +- docs/code-search/queries/index.mdx | 4 +- docs/code-search/types/search-jobs.mdx | 4 +- docs/code-search/types/symbol.mdx | 2 +- ...{saved_searches.mdx => saved-searches.mdx} | 0 ...earch_contexts.mdx => search-contexts.mdx} | 0 ...{search_filters.mdx => search-filters.mdx} | 0 ...ressions.mdx => search-subexpressions.mdx} | 0 docs/code_insights/explanations/index.mdx | 11 - docs/code_insights/how-tos/index.mdx | 7 - docs/code_insights/references/index.mdx | 11 - docs/cody/capabilities/supported-models.mdx | 2 +- docs/cody/prompts-guide.mdx | 2 +- docs/dotcom/index.mdx | 2 +- ...code.mdx => indexing-open-source-code.mdx} | 0 docs/getting-started/cloud-instance.mdx | 12 +- .../getting-started/github-vs-sourcegraph.mdx | 30 +- docs/getting-started/index.mdx | 8 +- ...{aws_codecommit.mdx => aws-codecommit.mdx} | 8 +- ...itbucket_cloud.mdx => bitbucket-cloud.mdx} | 8 +- ...bucket_server.mdx => bitbucket-server.mdx} | 26 +- .../how-tos/browser-search-engine.mdx} | 2 +- .../how-tos/google-workspace.mdx} | 2 +- .../browser-extension/how-tos/index.mdx | 7 + .../how-tos/troubleshooting.mdx | 2 +- .../index.mdx | 12 +- .../quickstart.mdx | 2 +- .../references/features.mdx | 2 +- .../browser-extension/references/index.mdx | 6 + .../references/privacy.mdx | 0 .../browser_extension/how-tos/index.mdx | 7 - .../browser_extension/references/index.mdx | 6 - docs/integration/github.mdx | 18 +- docs/integration/gitlab.mdx | 20 +- docs/integration/gitolite.mdx | 6 +- docs/integration/index.mdx | 12 +- ...on.mdx => migrating-firefox-extension.mdx} | 0 ...{open_in_editor.mdx => open-in-editor.mdx} | 0 docs/integration/phabricator.mdx | 18 +- docs/model-provider/index.mdx | 2 +- ...d_ownership.mdx => assigned-ownership.mdx} | 4 +- ...wners_format.mdx => codeowners-format.mdx} | 4 +- ...ingestion.mdx => codeowners-ingestion.mdx} | 0 ...erence.mdx => configuration-reference.mdx} | 2 +- docs/own/index.mdx | 8 +- ...nfig_file.mdx => advanced-config-file.mdx} | 10 +- .../self-hosted/deploy/docker-compose/aws.mdx | 4 +- .../deploy/docker-compose/azure.mdx | 4 +- .../deploy/docker-compose/configuration.mdx | 2 +- .../deploy/docker-compose/digitalocean.mdx | 6 +- .../{google_cloud.mdx => google-cloud.mdx} | 4 +- .../deploy/docker-compose/index.mdx | 6 +- .../deploy/docker-compose/migrate.mdx | 2 +- .../deploy/docker-compose/operations.mdx | 4 +- .../deploy/docker-compose/upgrade.mdx | 4 +- .../deploy/docker-single-container/aws.mdx | 4 +- .../docker-single-container/digitalocean.mdx | 2 +- .../{google_cloud.mdx => google-cloud.mdx} | 4 +- .../deploy/docker-single-container/index.mdx | 10 +- docs/self-hosted/deploy/instance-size.mdx | 2 +- .../deploy/kubernetes/configure.mdx | 8 +- docs/self-hosted/deploy/kubernetes/index.mdx | 12 +- .../deploy/kubernetes/operations.mdx | 2 +- docs/self-hosted/deploy/kubernetes/scale.mdx | 2 +- .../self-hosted/deploy/kubernetes/upgrade.mdx | 2 +- .../deploy/machine-images/aws-ami.mdx | 4 +- .../deploy/machine-images/aws-oneclick.mdx | 4 +- .../self-hosted/deploy/machine-images/gce.mdx | 6 +- .../deploy/machine-images/index.mdx | 2 +- docs/self-hosted/deploy/migrate-backup.mdx | 14 +- ...e_estimator.mdx => resource-estimator.mdx} | 0 docs/self-hosted/deploy/scale.mdx | 2 +- ...very.mdx => without-service-discovery.mdx} | 0 ...ices.mdx => deployment-best-practices.mdx} | 4 +- docs/self-hosted/email.mdx | 2 +- ...dx => deploy-executors-binary-offline.mdx} | 6 +- ...binary.mdx => deploy-executors-binary.mdx} | 4 +- ...ors_dind.mdx => deploy-executors-dind.mdx} | 4 +- ...docker.mdx => deploy-executors-docker.mdx} | 4 +- ...es.mdx => deploy-executors-kubernetes.mdx} | 8 +- ...orm.mdx => deploy-executors-terraform.mdx} | 8 +- ...loy_executors.mdx => deploy-executors.mdx} | 34 +- ...cutors_config.mdx => executors-config.mdx} | 0 ...ting.mdx => executors-troubleshooting.mdx} | 8 +- docs/self-hosted/executors/firecracker.mdx | 4 +- docs/self-hosted/executors/index.mdx | 8 +- .../index.mdx | 6 +- .../object-storage.mdx} | 4 +- .../postgres.mdx | 6 +- .../redis.mdx | 2 +- docs/self-hosted/faq.mdx | 2 +- ..._debugging.mdx => blobstore-debugging.mdx} | 4 +- ...e_notes.mdx => blobstore-update-notes.mdx} | 2 +- ...ntel_data.mdx => clear-codeintel-data.mdx} | 6 +- ...e_3_37.mdx => dirty-database-pre-3-37.mdx} | 2 +- ...{dirty_database.mdx => dirty-database.mdx} | 2 +- docs/self-hosted/how-to/index.mdx | 20 +- ..._drift.mdx => postgres-12-to-16-drift.mdx} | 0 ...grations.mdx => privileged-migrations.mdx} | 2 +- ...edis_configmap.mdx => redis-configmap.mdx} | 2 +- ...ack_database.mdx => rollback-database.mdx} | 2 +- ...migration.mdx => unfinished-migration.mdx} | 0 ...ation.mdx => http-https-configuration.mdx} | 6 +- docs/self-hosted/index.mdx | 74 +- ...on.mdx => alerting-custom-consumption.mdx} | 0 docs/self-hosted/observability/alerting.mdx | 6 +- docs/self-hosted/observability/alerts.mdx | 6 +- .../{health_checks.mdx => health-checks.mdx} | 0 docs/self-hosted/observability/index.mdx | 2 +- .../observability/troubleshooting.mdx | 2 +- docs/self-hosted/postgres.mdx | 6 +- ....mdx => postgres12-end-of-life-notice.mdx} | 0 ...collation-version-mismatch-resolution.mdx} | 0 docs/self-hosted/private-network.mdx | 6 +- ...x => ssl-https-self-signed-cert-nginx.mdx} | 6 +- docs/self-hosted/updates/automatic.mdx | 4 +- ...{docker_compose.mdx => docker-compose.mdx} | 14 +- docs/self-hosted/updates/index.mdx | 8 +- docs/self-hosted/updates/kubernetes.mdx | 16 +- .../updates/migrator/migrator-operations.mdx | 14 +- .../migrator/troubleshooting-upgrades.mdx | 2 +- .../{pure_docker.mdx => pure-docker.mdx} | 10 +- docs/self-hosted/updates/server.mdx | 6 +- docs/self-hosted/url.mdx | 2 +- docs/self-hosted/workers.mdx | 4 +- docs/sla/index.mdx | 4 +- docs/technical-changelog.mdx | 46 +- docs/tutorials/index.mdx | 16 +- src/data/navigation.ts | 79 +- src/data/redirects.ts | 673 +++++++++++++++++- 285 files changed, 1587 insertions(+), 901 deletions(-) rename docs/admin/{access_control/batch_changes.mdx => access-control/batch-changes.mdx} (95%) rename docs/admin/{access_control => access-control}/index.mdx (95%) rename docs/admin/{access_control => access-control}/ownership.mdx (92%) rename docs/admin/{audit_log.mdx => audit-log.mdx} (100%) rename docs/admin/auth/{login_form.mdx => login-form.mdx} (94%) rename docs/admin/auth/saml/{azure_ad.mdx => azure-ad.mdx} (100%) rename docs/admin/auth/saml/{jump_cloud.mdx => jump-cloud.mdx} (98%) rename docs/admin/auth/saml/{microsoft_adfs.mdx => microsoft-adfs.mdx} (98%) rename docs/admin/auth/saml/{one_login.mdx => one-login.mdx} (100%) rename docs/admin/{beta_and_experimental_features.mdx => beta-and-experimental-features.mdx} (100%) rename docs/admin/{code_hosts/aws_codecommit.mdx => code-hosts/aws-codecommit.mdx} (99%) rename docs/admin/{code_hosts => code-hosts}/azuredevops.mdx (96%) rename docs/admin/{code_hosts/bitbucket_cloud.mdx => code-hosts/bitbucket-cloud.mdx} (95%) rename docs/admin/{code_hosts/bitbucket_server.mdx => code-hosts/bitbucket-server.mdx} (96%) rename docs/admin/{code_hosts => code-hosts}/gerrit.mdx (98%) rename docs/admin/{code_hosts => code-hosts}/github.mdx (98%) rename docs/admin/{code_hosts => code-hosts}/gitlab.mdx (97%) rename docs/admin/{code_hosts => code-hosts}/gitolite.mdx (97%) rename docs/admin/{code_hosts => code-hosts}/index.mdx (89%) rename docs/admin/{code_hosts => code-hosts}/non-git.mdx (98%) rename docs/admin/{code_hosts => code-hosts}/other.mdx (97%) rename docs/admin/{code_hosts => code-hosts}/phabricator.mdx (96%) rename docs/admin/{code_hosts/rate_limits.mdx => code-hosts/rate-limits.mdx} (85%) rename docs/admin/{code_hosts/src_serve_git.mdx => code-hosts/src-serve-git.mdx} (96%) rename docs/admin/config/{authorization_and_authentication.mdx => authorization-and-authentication.mdx} (97%) rename docs/admin/config/{batch_changes.mdx => batch-changes.mdx} (99%) rename docs/admin/config/{site_config.mdx => site-config.mdx} (99%) rename docs/admin/{enterprise_getting_started_guide.mdx => enterprise-getting-started-guide.mdx} (86%) rename docs/admin/executors/{executor_secrets.mdx => executor-secrets.mdx} (100%) rename docs/admin/how-to/{internal_github_repos.mdx => internal-github-repos.mdx} (94%) rename docs/admin/how-to/{lsif_scip_migration.mdx => lsif-scip-migration.mdx} (91%) rename docs/admin/how-to/{update_repo_failure.mdx => update-repo-failure.mdx} (100%) rename docs/admin/{oauth_apps.mdx => oauth-apps.mdx} (98%) rename docs/admin/repo/{git_config.mdx => git-config.mdx} (100%) rename docs/admin/repo/{pre_load_from_local_disk.mdx => pre-load-from-local-disk.mdx} (94%) rename docs/admin/repo/{update_frequency.mdx => update-frequency.mdx} (90%) rename docs/admin/{security_event_logs.mdx => security-event-logs.mdx} (97%) rename docs/admin/{service_accounts.mdx => service-accounts.mdx} (89%) rename docs/admin/{user_data_deletion.mdx => user-data-deletion.mdx} (100%) rename docs/admin/{user_surveys.mdx => user-surveys.mdx} (100%) rename docs/api/{stream_api => stream-api}/index.mdx (98%) rename docs/cli/how-tos/{creating_an_access_token.mdx => creating-an-access-token.mdx} (100%) rename docs/cli/how-tos/{fetch_sboms.mdx => fetch-sboms.mdx} (100%) rename docs/cli/how-tos/{managing_access_tokens.mdx => managing-access-tokens.mdx} (100%) rename docs/cli/how-tos/{revoking_an_access_token.mdx => revoking-an-access-token.mdx} (100%) rename docs/cli/how-tos/{verify_container_signatures.mdx => verify-container-signatures.mdx} (100%) rename docs/cloud/{logpush_gcs.mdx => logpush-gcs.mdx} (100%) rename docs/cloud/{logpush_s3.mdx => logpush-s3.mdx} (100%) rename docs/cloud/{private_connectivity_aws.mdx => private-connectivity-aws.mdx} (95%) rename docs/cloud/{private_connectivity_gcp.mdx => private-connectivity-gcp.mdx} (95%) rename docs/cloud/{private_connectivity_public_lb.mdx => private-connectivity-public-lb.mdx} (94%) rename docs/cloud/{private_connectivity_sourcegraph_connect.mdx => private-connectivity-sourcegraph-connect.mdx} (98%) rename docs/{code_insights/explanations/administration_and_security_of_code_insights.mdx => code-insights/explanations/administration-and-security-of-code-insights.mdx} (100%) rename docs/{code_insights/explanations/automatically_generated_data_series.mdx => code-insights/explanations/automatically-generated-data-series.mdx} (96%) rename docs/{code_insights/explanations/code_insights_filters.mdx => code-insights/explanations/code-insights-filters.mdx} (98%) rename docs/{code_insights/explanations/current_limitations_of_code_insights.mdx => code-insights/explanations/current-limitations-of-code-insights.mdx} (95%) rename docs/{code_insights/explanations/data_retention.mdx => code-insights/explanations/data-retention.mdx} (100%) create mode 100644 docs/code-insights/explanations/index.mdx rename docs/{code_insights/explanations/search_results_aggregations.mdx => code-insights/explanations/search-results-aggregations.mdx} (97%) rename docs/{code_insights/explanations/viewing_code_insights.mdx => code-insights/explanations/viewing-code-insights.mdx} (92%) rename docs/{code_insights => code-insights}/how-tos/Troubleshooting.mdx (100%) rename docs/{code_insights/how-tos/creating_a_custom_dashboard_of_code_insights.mdx => code-insights/how-tos/creating-a-custom-dashboard-of-code-insights.mdx} (92%) rename docs/{code_insights/how-tos/filtering_an_insight.mdx => code-insights/how-tos/filtering-an-insight.mdx} (92%) create mode 100644 docs/code-insights/how-tos/index.mdx rename docs/{code_insights => code-insights}/index.mdx (84%) rename docs/{code_insights/language_insight_quickstart.mdx => code-insights/language-insight-quickstart.mdx} (89%) rename docs/{code_insights => code-insights}/quickstart.mdx (88%) rename docs/{code_insights/references/common_reasons_code_insights_may_not_match_search_results.mdx => code-insights/references/common-reasons-code-insights-may-not-match-search-results.mdx} (100%) rename docs/{code_insights/references/common_use_cases.mdx => code-insights/references/common-use-cases.mdx} (92%) rename docs/{code_insights/references/incomplete_data_points.mdx => code-insights/references/incomplete-data-points.mdx} (98%) create mode 100644 docs/code-insights/references/index.mdx rename docs/{code_insights => code-insights}/references/license.mdx (100%) rename docs/{code_insights/references/repository_scope.mdx => code-insights/references/repository-scope.mdx} (97%) rename docs/{code_insights => code-insights}/references/requirements.mdx (100%) rename docs/{code_insights/references/search_aggregations_use_cases.mdx => code-insights/references/search-aggregations-use-cases.mdx} (98%) rename docs/{code_insights => code-insights}/types/inventory-stats.mdx (100%) rename docs/{code_monitoring => code-monitoring}/campaigns-icon.svg (100%) rename docs/{code_monitoring => code-monitoring}/file-icon.svg (100%) rename docs/{code_monitoring => code-monitoring}/index.mdx (100%) rename docs/code-navigation/{auto_indexing_configuration.mdx => auto-indexing-configuration.mdx} (99%) rename docs/code-navigation/{auto_indexing.mdx => auto-indexing.mdx} (93%) rename docs/code-navigation/explanations/{auto_indexing_inference.mdx => auto-indexing-inference.mdx} (95%) rename docs/code-navigation/how-to/{adding_scip_to_workflows.mdx => adding-scip-to-workflows.mdx} (96%) rename docs/code-navigation/how-to/{combining_scip_uploads_from_ci_cd_and_auto_indexing.mdx => combining-scip-uploads-from-ci-cd-and-auto-indexing.mdx} (82%) rename docs/code-navigation/how-to/{index_a_go_repository.mdx => index-a-go-repository.mdx} (100%) rename docs/code-navigation/how-to/{index_a_typescript_and_javascript_repository.mdx => index-a-typescript-and-javascript-repository.mdx} (100%) rename docs/code-navigation/how-to/{index_other_languages.mdx => index-other-languages.mdx} (93%) rename docs/code-navigation/how-to/{policies_resource_usage_best_practices.mdx => policies-resource-usage-best-practices.mdx} (98%) rename docs/code-navigation/{inference_configuration.mdx => inference-configuration.mdx} (97%) rename docs/code-navigation/{precise_code_navigation.mdx => precise-code-navigation.mdx} (92%) rename docs/code-navigation/{search_based_code_navigation.mdx => search-based-code-navigation.mdx} (99%) rename docs/code-navigation/{syntactic_code_navigation.mdx => syntactic-code-navigation.mdx} (98%) rename docs/code-navigation/{writing_an_indexer.mdx => writing-an-indexer.mdx} (98%) rename docs/code-search/how-to/{create_search_context_graphql.mdx => create-search-context-graphql.mdx} (99%) rename docs/code-search/working/{saved_searches.mdx => saved-searches.mdx} (100%) rename docs/code-search/working/{search_contexts.mdx => search-contexts.mdx} (100%) rename docs/code-search/working/{search_filters.mdx => search-filters.mdx} (100%) rename docs/code-search/working/{search_subexpressions.mdx => search-subexpressions.mdx} (100%) delete mode 100644 docs/code_insights/explanations/index.mdx delete mode 100644 docs/code_insights/how-tos/index.mdx delete mode 100644 docs/code_insights/references/index.mdx rename docs/dotcom/{indexing_open_source_code.mdx => indexing-open-source-code.mdx} (100%) rename docs/integration/{aws_codecommit.mdx => aws-codecommit.mdx} (73%) rename docs/integration/{bitbucket_cloud.mdx => bitbucket-cloud.mdx} (83%) rename docs/integration/{bitbucket_server.mdx => bitbucket-server.mdx} (93%) rename docs/integration/{browser_extension/how-tos/browser_search_engine.mdx => browser-extension/how-tos/browser-search-engine.mdx} (98%) rename docs/integration/{browser_extension/how-tos/google_workspace.mdx => browser-extension/how-tos/google-workspace.mdx} (98%) create mode 100644 docs/integration/browser-extension/how-tos/index.mdx rename docs/integration/{browser_extension => browser-extension}/how-tos/troubleshooting.mdx (97%) rename docs/integration/{browser_extension => browser-extension}/index.mdx (80%) rename docs/integration/{browser_extension => browser-extension}/quickstart.mdx (98%) rename docs/integration/{browser_extension => browser-extension}/references/features.mdx (95%) create mode 100644 docs/integration/browser-extension/references/index.mdx rename docs/integration/{browser_extension => browser-extension}/references/privacy.mdx (100%) delete mode 100644 docs/integration/browser_extension/how-tos/index.mdx delete mode 100644 docs/integration/browser_extension/references/index.mdx rename docs/integration/{migrating_firefox_extension.mdx => migrating-firefox-extension.mdx} (100%) rename docs/integration/{open_in_editor.mdx => open-in-editor.mdx} (100%) rename docs/own/{assigned_ownership.mdx => assigned-ownership.mdx} (97%) rename docs/own/{codeowners_format.mdx => codeowners-format.mdx} (96%) rename docs/own/{codeowners_ingestion.mdx => codeowners-ingestion.mdx} (100%) rename docs/own/{configuration_reference.mdx => configuration-reference.mdx} (97%) rename docs/self-hosted/{advanced_config_file.mdx => advanced-config-file.mdx} (97%) rename docs/self-hosted/deploy/docker-compose/{google_cloud.mdx => google-cloud.mdx} (98%) rename docs/self-hosted/deploy/docker-single-container/{google_cloud.mdx => google-cloud.mdx} (95%) rename docs/self-hosted/deploy/{resource_estimator.mdx => resource-estimator.mdx} (100%) rename docs/self-hosted/deploy/{without_service_discovery.mdx => without-service-discovery.mdx} (100%) rename docs/self-hosted/{deployment_best_practices.mdx => deployment-best-practices.mdx} (96%) rename docs/self-hosted/executors/{deploy_executors_binary_offline.mdx => deploy-executors-binary-offline.mdx} (95%) rename docs/self-hosted/executors/{deploy_executors_binary.mdx => deploy-executors-binary.mdx} (98%) rename docs/self-hosted/executors/{deploy_executors_dind.mdx => deploy-executors-dind.mdx} (92%) rename docs/self-hosted/executors/{deploy_executors_docker.mdx => deploy-executors-docker.mdx} (89%) rename docs/self-hosted/executors/{deploy_executors_kubernetes.mdx => deploy-executors-kubernetes.mdx} (96%) rename docs/self-hosted/executors/{deploy_executors_terraform.mdx => deploy-executors-terraform.mdx} (98%) rename docs/self-hosted/executors/{deploy_executors.mdx => deploy-executors.mdx} (91%) rename docs/self-hosted/executors/{executors_config.mdx => executors-config.mdx} (100%) rename docs/self-hosted/executors/{executors_troubleshooting.mdx => executors-troubleshooting.mdx} (98%) rename docs/self-hosted/{external_services => external-services}/index.mdx (93%) rename docs/self-hosted/{external_services/object_storage.mdx => external-services/object-storage.mdx} (98%) rename docs/self-hosted/{external_services => external-services}/postgres.mdx (99%) rename docs/self-hosted/{external_services => external-services}/redis.mdx (97%) rename docs/self-hosted/how-to/{blobstore_debugging.mdx => blobstore-debugging.mdx} (96%) rename docs/self-hosted/how-to/{blobstore_update_notes.mdx => blobstore-update-notes.mdx} (97%) rename docs/self-hosted/how-to/{clear_codeintel_data.mdx => clear-codeintel-data.mdx} (96%) rename docs/self-hosted/how-to/{dirty_database_pre_3_37.mdx => dirty-database-pre-3-37.mdx} (99%) rename docs/self-hosted/how-to/{dirty_database.mdx => dirty-database.mdx} (99%) rename docs/self-hosted/how-to/{postgres_12_to_16_drift.mdx => postgres-12-to-16-drift.mdx} (100%) rename docs/self-hosted/how-to/{privileged_migrations.mdx => privileged-migrations.mdx} (94%) rename docs/self-hosted/how-to/{redis_configmap.mdx => redis-configmap.mdx} (99%) rename docs/self-hosted/how-to/{rollback_database.mdx => rollback-database.mdx} (97%) rename docs/self-hosted/how-to/{unfinished_migration.mdx => unfinished-migration.mdx} (100%) rename docs/self-hosted/{http_https_configuration.mdx => http-https-configuration.mdx} (97%) rename docs/self-hosted/observability/{alerting_custom_consumption.mdx => alerting-custom-consumption.mdx} (100%) rename docs/self-hosted/observability/{health_checks.mdx => health-checks.mdx} (100%) rename docs/self-hosted/{postgres12_end_of_life_notice.mdx => postgres12-end-of-life-notice.mdx} (100%) rename docs/self-hosted/{postgresql_collation_version_mismatch_resolution.mdx => postgresql-collation-version-mismatch-resolution.mdx} (100%) rename docs/self-hosted/{ssl_https_self_signed_cert_nginx.mdx => ssl-https-self-signed-cert-nginx.mdx} (96%) rename docs/self-hosted/updates/{docker_compose.mdx => docker-compose.mdx} (97%) rename docs/self-hosted/updates/{pure_docker.mdx => pure-docker.mdx} (99%) diff --git a/docs/admin/access_control/batch_changes.mdx b/docs/admin/access-control/batch-changes.mdx similarity index 95% rename from docs/admin/access_control/batch_changes.mdx rename to docs/admin/access-control/batch-changes.mdx index 91eb69c13..bd4c29481 100644 --- a/docs/admin/access_control/batch_changes.mdx +++ b/docs/admin/access-control/batch-changes.mdx @@ -1,6 +1,6 @@ # Access control for Batch Changes -Granular controls for who can access [Batch Changes](/batch-changes/) can be configured by site admins by tuning the roles assigned to users and the permissions granted to those roles. This page describes the permission types available for Batch Changes, and whether they are granted by default to the **User** [system role](/admin/access_control#system-roles). All permissions are granted to the **Site Administrator** system role by default. +Granular controls for who can access [Batch Changes](/batch-changes/) can be configured by site admins by tuning the roles assigned to users and the permissions granted to those roles. This page describes the permission types available for Batch Changes, and whether they are granted by default to the **User** [system role](/admin/access-control#system-roles). All permissions are granted to the **Site Administrator** system role by default. Name | Description | Granted to **User** by default? diff --git a/docs/admin/access_control/index.mdx b/docs/admin/access-control/index.mdx similarity index 95% rename from docs/admin/access_control/index.mdx rename to docs/admin/access-control/index.mdx index 4bc8c1ba2..356e57e9a 100644 --- a/docs/admin/access_control/index.mdx +++ b/docs/admin/access-control/index.mdx @@ -14,7 +14,7 @@ same repository access on Sourcegraph as your code host. -Sourcegraph uses [Role-Based Access Control (RBAC)](https://en.wikipedia.org/wiki/Role-based_access_control) to enable fine-grained control over different features and abilities of Sourcegraph, without having to modify permissions for each user individually. Currently, the scope of permissions control is limited to [Batch Changes](/admin/access_control/batch_changes) functionality, but it will be expanded to other areas in the future. +Sourcegraph uses [Role-Based Access Control (RBAC)](https://en.wikipedia.org/wiki/Role-based_access_control) to enable fine-grained control over different features and abilities of Sourcegraph, without having to modify permissions for each user individually. Currently, the scope of permissions control is limited to [Batch Changes](/admin/access-control/batch-changes) functionality, but it will be expanded to other areas in the future. ## Managing roles and permissions @@ -44,9 +44,9 @@ To edit the permissions granted to a role, click the role to expand it, then sel You can read about the specific permission types available for each RBAC-enabled product area below: -- [Batch Changes](/admin/access_control/batch_changes) -- [Ownership](/admin/access_control/ownership) -- [Service accounts](/admin/service_accounts) +- [Batch Changes](/admin/access-control/batch-changes) +- [Ownership](/admin/access-control/ownership) +- [Service accounts](/admin/service-accounts) ### Deleting a role diff --git a/docs/admin/access_control/ownership.mdx b/docs/admin/access-control/ownership.mdx similarity index 92% rename from docs/admin/access_control/ownership.mdx rename to docs/admin/access-control/ownership.mdx index c2bf1860b..9258e22a5 100644 --- a/docs/admin/access_control/ownership.mdx +++ b/docs/admin/access-control/ownership.mdx @@ -1,6 +1,6 @@ # Access control for Ownership -Granular controls for who can assign [Ownership](/own/) can be configured by site admins by tuning the roles assigned to users and the permissions granted to those roles. This page describes the permission types available for Ownership, and whether they are granted by default to the **User** [system role](/admin/access_control/#system-roles). All permissions are granted to the **Site Administrator** system role by default. +Granular controls for who can assign [Ownership](/own/) can be configured by site admins by tuning the roles assigned to users and the permissions granted to those roles. This page describes the permission types available for Ownership, and whether they are granted by default to the **User** [system role](/admin/access-control/#system-roles). All permissions are granted to the **Site Administrator** system role by default. | Name | Description | Granted to **User** by default? | | ------------------- | ---------------------------------------------------------------------------- | :-----------------------------: | diff --git a/docs/admin/architecture.mdx b/docs/admin/architecture.mdx index f9a7a9767..389636e8f 100644 --- a/docs/admin/architecture.mdx +++ b/docs/admin/architecture.mdx @@ -50,11 +50,11 @@ Sourcegraph also has a fast search path for code that isn't indexed yet or will Unlike Search (which is completely text-based), Code Navigation surfaces data such as doc comments for a symbol and actions such as the "go to definition" or "find references" features based on our semantic understanding of code. -By default, Sourcegraph provides [search-based code navigation](/code-navigation/search_based_code_navigation). This reuses all the architecture that makes search fast, but it can result in false positives (for example, finding two definitions for a symbol or references that aren't actually references) or false negatives (for example, not being able to find the definition or all references). +By default, Sourcegraph provides [search-based code navigation](/code-navigation/search-based-code-navigation). This reuses all the architecture that makes search fast, but it can result in false positives (for example, finding two definitions for a symbol or references that aren't actually references) or false negatives (for example, not being able to find the definition or all references). This is the default because it works with no extra configuration and is good for many use cases and languages. We support many languages this way because it only requires writing a few regular expressions. -With some setup, customers can enable [precise code navigation](/code-navigation/precise_code_navigation). Repositories add a step to their build pipeline that computes the index for that code revision and uploads it to Sourcegraph. We must write language-specific indexers, so adding precise code navigation support for new languages is a non-trivial task. +With some setup, customers can enable [precise code navigation](/code-navigation/precise-code-navigation). Repositories add a step to their build pipeline that computes the index for that code revision and uploads it to Sourcegraph. We must write language-specific indexers, so adding precise code navigation support for new languages is a non-trivial task. Learn more in the [Code Navigation docs](/code-navigation) @@ -93,7 +93,7 @@ Code Insights can generate data in the background or just-in-time when viewing c There is also a feature flag left over from the original development of the early-stage product that we retained in case a customer who doesn't purchase it ever has a justified need to disable insights. You can set `"experimentalFeatures": { "codeInsights": false }` in your settings to disable insights. -You can learn more in the [Code Insights](/code_insights) docs. +You can learn more in the [Code Insights](/code-insights) docs. ### Dependencies @@ -120,7 +120,7 @@ The **trigger** watches for new data; if there is new data, we call this an even The actions are run in response to a trigger event. For now, the only supported action is an email notification to the primary email address of the code monitor's owner. To work, `email.address` and `email.smtp` must be configured in the site configuration. Code monitoring actions will be extended in the future to support webhooks. - Learn more in the [Code Monitoring docs](/code_monitoring) + Learn more in the [Code Monitoring docs](/code-monitoring) ### Dependencies @@ -129,7 +129,7 @@ The actions are run in response to a trigger event. For now, the only supported ## Browser extensions -The [Sourcegraph browser extensions](/integration/browser_extension) bring the features of Sourcegraph directly into the UI of code hosts such as GitHub, GitLab, and Bitbucket. +The [Sourcegraph browser extensions](/integration/browser-extension) bring the features of Sourcegraph directly into the UI of code hosts such as GitHub, GitLab, and Bitbucket. With the Sourcegraph browser extension installed, users get Sourcegraph features (including Code Navigation) on their code host while browsing code, viewing diffs, or reviewing pull requests. @@ -142,7 +142,7 @@ Native integrations bring Sourcegraph features directly into the UI of code host Instead of requiring a browser extension, native integrations inject a script by extending the code host directly (for example, using the code host's plugin architecture). The advantage is that Sourcegraph can be enabled for all users of a code host instance without any action required from each user. - Learn more in the [Code host integrations docs](/admin/code_hosts) + Learn more in the [Code host integrations docs](/admin/code-hosts) #### Dependencies @@ -163,7 +163,7 @@ Instead of requiring a browser extension, native integrations inject a script by - Learn more in the [src-cli docs](/admin/code_hosts) and [GitHub + Learn more in the [src-cli docs](/admin/code-hosts) and [GitHub repo](https://github.com/sourcegraph/src-cli) @@ -183,7 +183,7 @@ Sourcegraph's recommended deployment methods are: 4. Kubernetes Kustomize: Helm is Sourcegraph's more standardized and vetted approach to deploying with Kubernetes, but if Kustomize is your preferred deployment method it is a viable and supported approach. 5. Machine Images: Sourcegraph can be deployed using dedicated Machine Images for specific Cloud providers. This can be a simple solution in specific circumstances, though has its own considerations. If you are considering this path, please discuss with your account team. -The [resource estimator](/self-hosted/deploy/resource_estimator#sourcegraph-resource-estimator) can guide you on the requirements for each deployment type. +The [resource estimator](/self-hosted/deploy/resource-estimator#sourcegraph-resource-estimator) can guide you on the requirements for each deployment type. Learn more in the [deployment docs](/self-hosted/deploy) @@ -193,7 +193,7 @@ The [resource estimator](/self-hosted/deploy/resource_estimator#sourcegraph-reso Observability encapsulates the monitoring and debugging of Sourcegraph deployments. Sourcegraph is designed and ships several observability tools and out-of-the-box capabilities to enable visibility into the health and state of a Sourcegraph deployment. -Monitoring includes [metrics and dashboards](/self-hosted/observability/metrics), [alerting](/self-hosted/observability/alerting), and [health checking](/self-hosted/observability/health_checks) capabilities. +Monitoring includes [metrics and dashboards](/self-hosted/observability/metrics), [alerting](/self-hosted/observability/alerting), and [health checking](/self-hosted/observability/health-checks) capabilities. - `grafana` is the frontend for service metrics and ships with customized dashboards for Sourcegraph services - prometheus handles the scraping of service metrics and ships with recording rules, alert rules, and alerting capabilities diff --git a/docs/admin/audit_log.mdx b/docs/admin/audit-log.mdx similarity index 100% rename from docs/admin/audit_log.mdx rename to docs/admin/audit-log.mdx diff --git a/docs/admin/auth/builtin.mdx b/docs/admin/auth/builtin.mdx index f6f5401a1..521d0f0f5 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/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. Use this auth provider, if you have no organizational requirements to use a SSO provider. @@ -84,7 +84,7 @@ When [SMTP is enabled](/self-hosted/email), special behaviours apply to whether ## Account lockout -Password reset links expire after 4 hours by default - this can be configured in site configuration with the [`auth.passwordResetLinkExpiry`](/admin/config/site_config#auth-passwordResetLinkExpiry) field. +Password reset links expire after 4 hours by default - this can be configured in site configuration with the [`auth.passwordResetLinkExpiry`](/admin/config/site-config#auth-passwordResetLinkExpiry) field. Account will be locked out for 30 minutes after 5 consecutive failed sign-in attempts within one hour for the builtin authentication provider. The threshold and duration of lockout and consecutive periods can be customized via `"auth.lockout"` in the site configuration: diff --git a/docs/admin/auth/index.mdx b/docs/admin/auth/index.mdx index 4d0a15bdc..1ce6af921 100644 --- a/docs/admin/auth/index.mdx +++ b/docs/admin/auth/index.mdx @@ -34,15 +34,15 @@ The following methods are supported for sign up and sign in: - [HTTP authentication proxies](#http-authentication-proxies) - [Username header prefixes](#username-header-prefixes) -The authentication providers are configured in the [`auth.providers`](/admin/config/site_config#authentication-providers) site configuration option. +The authentication providers are configured in the [`auth.providers`](/admin/config/site-config#authentication-providers) site configuration option. ## Programmatic authentication -For automated systems, CI/CD pipelines, and API integrations that need to authenticate without human interaction, use [service accounts](/admin/service_accounts). Service accounts are specialized user accounts designed for automation that authenticate using access tokens rather than passwords. +For automated systems, CI/CD pipelines, and API integrations that need to authenticate without human interaction, use [service accounts](/admin/service-accounts). Service accounts are specialized user accounts designed for automation that authenticate using access tokens rather than passwords. ## Login form configuration -To configure the presentation of the login form, see the [login form configuration page](/admin/auth/login_form). +To configure the presentation of the login form, see the [login form configuration page](/admin/auth/login-form). ## Recommendations @@ -116,7 +116,7 @@ configuration. Leave the `url` field empty for GitHub.com. -Once you've configured GitHub as a sign-on provider, you may also want to [add GitHub repositories to Sourcegraph](/admin/code_hosts/github#repository-syncing). +Once you've configured GitHub as a sign-on provider, you may also want to [add GitHub repositories to Sourcegraph](/admin/code-hosts/github#repository-syncing). ### How to control user sign-up and sign-in with GitHub auth provider @@ -246,7 +246,7 @@ Then add the following lines to your site configuration: Replace the `clientID` and `clientSecret` values with the values from your GitLab OAuth app configuration. -Once you've configured GitLab as a sign-on provider, you may also want to [add GitLab repositories to Sourcegraph](/admin/code_hosts/gitlab#repository-syncing). +Once you've configured GitLab as a sign-on provider, you may also want to [add GitLab repositories to Sourcegraph](/admin/code-hosts/gitlab#repository-syncing). > NOTE: Administrators on the GitLab instance who then sign in to Sourcegraph will not have access to all of the repositories on Sourcegraph as well. Administrators will only have access to repositories on GitLab for which they are assigned the Reporter role and above. @@ -312,7 +312,7 @@ The `token` parameter can be found on the **Settings > SAML SSO** page on GitLab ### Don't sync user permissions for internal repositories -If your organization has a lot of internal repositories that should be accessible to everyone on GitLab, you may want to [mark internal repositories as public](/admin/code_hosts/gitlab#internal-repositories), and then configure your auth provider to not sync user permissions for internal repositories: +If your organization has a lot of internal repositories that should be accessible to everyone on GitLab, you may want to [mark internal repositories as public](/admin/code-hosts/gitlab#internal-repositories), and then configure your auth provider to not sync user permissions for internal repositories: ```json { @@ -333,7 +333,7 @@ Sourcegraph instance: - `Repositories`: `Read` (more information in [repository permissions section](/admin/permissions)) After the consumer is created, you will need the `Key` and the `Secret`, which can be found by expanding OAuth consumer in the list. -Then add the following lines to your [site configuration](/admin/config/site_config): +Then add the following lines to your [site configuration](/admin/config/site-config): ```json { @@ -361,7 +361,7 @@ Sourcegraph instance: - `Repositories`: `Read` (more information in [repository permissions section](/admin/permissions)) After the link is created, you will need to copy the `Client ID` and the `Client Secret`. -Then add the following lines to your [site configuration](/admin/config/site_config): +Then add the following lines to your [site configuration](/admin/config/site-config): ```json { @@ -385,7 +385,7 @@ Replace the `clientID` and `clientSecret` values with the values from your Bitbu Beta To enable users to add Gerrit credentials and verify their access to repositories on Sourcegraph, -add the following lines to your [site configuration](/admin/config/site_config): +add the following lines to your [site configuration](/admin/config/site-config): ```json { @@ -403,7 +403,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/config/site-config#openid-connect-including-google-workspace) 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/config/site-config#openid-connect-including-google-workspace) 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/config/site-config#openid-connect-including-google-workspace) 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/config/site-config#openid-connect-including-google-workspace) configuration for Google Workspace: ```json { @@ -547,9 +547,9 @@ Consequently, you can only sign in via an auth provider if your email on Sourceg Let's say the email field in your Sourcegraph account was kept blank when a site admin created the account for you, but the username matches your username on GitHub or GitLab. Will this work? If you try to sign in to SG with GitHub or GitLab, it won't work, and you will see an error informing you that a verified email is missing. Exceptions to this rule are [HTTP Proxies](#http-authentication-proxies), where there's an option to make the link via username only. -For [Bitbucket](/admin/config/authorization_and_authentication#bitbucket-server-bitbucket-data-center-authorization), we don't support OAuth. Still, the match between the chosen auth provider used with Bitbucket and a user's Bitbucket account happens via username. +For [Bitbucket](/admin/config/authorization-and-authentication#bitbucket-server-bitbucket-data-center-authorization), we don't support OAuth. Still, the match between the chosen auth provider used with Bitbucket and a user's Bitbucket account happens via username. -Using only a username to match a Sourcegraph account to an auth provider account is not recommended, as you can see [here](/admin/code_hosts/gitlab#username), for example. +Using only a username to match a Sourcegraph account to an auth provider account is not recommended, as you can see [here](/admin/code-hosts/gitlab#username), for example. Usernames in Sourcegraph are mutable, so a malicious user could change a username, elevating their privileges. ## Linking accounts from multiple auth providers diff --git a/docs/admin/auth/login_form.mdx b/docs/admin/auth/login-form.mdx similarity index 94% rename from docs/admin/auth/login_form.mdx rename to docs/admin/auth/login-form.mdx index f7fff7a7d..4a51a8858 100644 --- a/docs/admin/auth/login_form.mdx +++ b/docs/admin/auth/login-form.mdx @@ -25,7 +25,7 @@ of auth providers is hardcoded in the application. The default order can be overriden with an optional `order` parameter. It is an integer and items will be sorted in natural order (1, 2, 3, ...). -Example [site configuration](/admin/config/site_config): +Example [site configuration](/admin/config/site-config): ```json { @@ -66,7 +66,7 @@ This default can be changed, e.g. in case there are 1 or 2 preferred methods for For example there might be a different auth provider setup for regular engineers and a different one for site admins. It makes sense to only show the default one to engineers to reduce confusion of regular users. -There is a [site configuration](/admin/config/site_config) parameter `auth.primaryLoginProvidersCount`: +There is a [site configuration](/admin/config/site-config) parameter `auth.primaryLoginProvidersCount`: ```json { @@ -87,9 +87,9 @@ when the `Other login methods` button is clicked. By default Sourcegraph shows a button for each auth provider, such as `Continue with GitHub`. The text label for the button is created from 2 parts: `Continue with` prefix and `Github`. These can be controlled with `displayPrefix` and `displayName` -optional parameters of auth provider in [site configuration](/admin/config/site_config): +optional parameters of auth provider in [site configuration](/admin/config/site-config): -Example [site configuration](/admin/config/site_config): +Example [site configuration](/admin/config/site-config): ```json { @@ -125,7 +125,7 @@ but still sync permissions from code hosts. This can be done by setting `"noSign This will hide the code host auth providers from the login form, but will still allow users to connect their external accounts from their User Settings > Account Security page. Users will also be presented with a modal upon sign-in, asking them to connect these external accounts. -Example [site configuration](/admin/config/site_config): +Example [site configuration](/admin/config/site-config): ```json { @@ -153,7 +153,7 @@ Example [site configuration](/admin/config/site_config): > NOTE: Hiding an auth provider is mostly useful for development purposes and special cases. It is also possible to hide the auth provider from the login form completely. Auth providers have a `hidden` boolean property. -See the [site configuration](/admin/config/site_config) example below: +See the [site configuration](/admin/config/site-config) example below: ```json { diff --git a/docs/admin/auth/saml/azure_ad.mdx b/docs/admin/auth/saml/azure-ad.mdx similarity index 100% rename from docs/admin/auth/saml/azure_ad.mdx rename to docs/admin/auth/saml/azure-ad.mdx diff --git a/docs/admin/auth/saml/generic.mdx b/docs/admin/auth/saml/generic.mdx index 4171e0893..4486c1356 100644 --- a/docs/admin/auth/saml/generic.mdx +++ b/docs/admin/auth/saml/generic.mdx @@ -12,14 +12,14 @@ Your identity provider should provide documentation on how to register a new SAM - [Auth0](https://auth0.com/docs/protocols/saml/saml-idp-generic) - [Ping Identity](https://learning.getpostman.com/docs/postman-enterprise/sso/saml-ping/) - [Salesforce Identity](https://help.salesforce.com/articleView?id=identity_provider_enable.htm) -- We have vendor-specific instructions for [Okta](/admin/auth/saml/okta), [Microsoft Entra ID](/admin/auth/saml/azure_ad), and [Microsoft ADFS](/admin/auth/saml/microsoft_adfs) +- We have vendor-specific instructions for [Okta](/admin/auth/saml/okta), [Microsoft Entra ID](/admin/auth/saml/azure-ad), and [Microsoft ADFS](/admin/auth/saml/microsoft-adfs) If you do not see your identity provider in the list above or otherwise have trouble with SAML configuration, please reach out to [support@sourcegraph.com](mailto:support@sourcegraph.com?subject=SAML%20help&body=I%20am%20trying%20to%20configure%20Sourcegraph%20with%20SAML%20authentication%20with%20%3Cfill%20in%20your%20auth%20provider%3E%2C%20but%20am%20running%20into%20issues%3A%20%3Cplease%20describe%3E). Ensure the following values are set for the application configuration in the identity provider. (Note: the exact names and labels may vary slightly for different identity providers) -- **Assertion Consumer Service URL, Recipient URL, Destination URL, Single sign-on URL:** `https://sourcegraph.example.com/.auth/saml/acs` (substituting the `externalURL` from your [site configuration](/admin/config/site_config)) -- **Service Provider (issuer, entity ID, audience URI, metadata URL):** `https://sourcegraph.example.com/.auth/saml/metadata` (substituting the `externalURL` from your [site configuration](/admin/config/site_config)). Some identity providers require you to input these metadata values manually, instead of fetching everything from one URL. In that case, navigate to `https://sourcegraph.example.com/.auth/saml/metadata` and transcribe the values in the XML to the identity provider configuration. +- **Assertion Consumer Service URL, Recipient URL, Destination URL, Single sign-on URL:** `https://sourcegraph.example.com/.auth/saml/acs` (substituting the `externalURL` from your [site configuration](/admin/config/site-config)) +- **Service Provider (issuer, entity ID, audience URI, metadata URL):** `https://sourcegraph.example.com/.auth/saml/metadata` (substituting the `externalURL` from your [site configuration](/admin/config/site-config)). Some identity providers require you to input these metadata values manually, instead of fetching everything from one URL. In that case, navigate to `https://sourcegraph.example.com/.auth/saml/metadata` and transcribe the values in the XML to the identity provider configuration. - **Attribute statements (claims):** Sourcegraph _requires_ that an attribute `email` be set with the value of the user's verified email address. This is used to uniquely identify users to Sourcegraph. Other attributes such as `login` and `displayName` are optional. - `email` (required): the user's email - `login` (optional): the user's username diff --git a/docs/admin/auth/saml/index.mdx b/docs/admin/auth/saml/index.mdx index b03626986..035d43b98 100644 --- a/docs/admin/auth/saml/index.mdx +++ b/docs/admin/auth/saml/index.mdx @@ -7,22 +7,22 @@ Security Assertion Markup Language (SAML) is a common web protocol used to pass Select your SAML identity provider for setup instructions: - [Okta](/admin/auth/saml/okta) -- [Microsoft Entra ID](/admin/auth/saml/azure_ad) -- [Microsoft Active Directory Federation Services (ADFS)](/admin/auth/saml/microsoft_adfs) +- [Microsoft Entra ID](/admin/auth/saml/azure-ad) +- [Microsoft Active Directory Federation Services (ADFS)](/admin/auth/saml/microsoft-adfs) - [Auth0](/admin/auth/saml/generic) -- [OneLogin](/admin/auth/saml/one_login) +- [OneLogin](/admin/auth/saml/one-login) - [Ping Identity](/admin/auth/saml/generic) - [Salesforce Identity](/admin/auth/saml/generic) -- [JumpCloud](/admin/auth/saml/jump_cloud) +- [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/config/site-config#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. ## Add a SAML provider -1. In Sourcegraph [site config](/admin/config/site_config), ensure `externalURL` is set to a value consistent with the URL you used in the previous section in the identity provider configuration. +1. In Sourcegraph [site config](/admin/config/site-config), ensure `externalURL` is set to a value consistent with the URL you used in the previous section in the identity provider configuration. > NOTE: Make sure to use the exact same scheme (`http` or `https`), and there should be no trailing slash. diff --git a/docs/admin/auth/saml/jump_cloud.mdx b/docs/admin/auth/saml/jump-cloud.mdx similarity index 98% rename from docs/admin/auth/saml/jump_cloud.mdx rename to docs/admin/auth/saml/jump-cloud.mdx index 2af9ca99b..dcc3bc84d 100644 --- a/docs/admin/auth/saml/jump_cloud.mdx +++ b/docs/admin/auth/saml/jump-cloud.mdx @@ -1,6 +1,6 @@ # Configuring SAML with JumpCloud -> NOTE: Please substitute `https://sourcegraph.example.com` with the actual value of `externalURL` in your [site configuration](/admin/config/site_config)). +> NOTE: Please substitute `https://sourcegraph.example.com` with the actual value of `externalURL` in your [site configuration](/admin/config/site-config)). ## 1. Configure SAML 2.0 application on JumpCloud diff --git a/docs/admin/auth/saml/microsoft_adfs.mdx b/docs/admin/auth/saml/microsoft-adfs.mdx similarity index 98% rename from docs/admin/auth/saml/microsoft_adfs.mdx rename to docs/admin/auth/saml/microsoft-adfs.mdx index d5dfc583d..9797efa52 100644 --- a/docs/admin/auth/saml/microsoft_adfs.mdx +++ b/docs/admin/auth/saml/microsoft-adfs.mdx @@ -12,8 +12,8 @@ These instructions guide you through configuring Sourcegraph as a relying party - Active Directory instance where all users have email and username attributes. - An instance of ADFS running on Windows Server, joined to your Active Directory domain. -- Sourcegraph should be [configured to use HTTPS](/self-hosted/http_https_configuration#nginx-ssl-https-configuration). -- Ensure that `externalURL` in [site config](/admin/config/site_config) meets the following +- Sourcegraph should be [configured to use HTTPS](/self-hosted/http-https-configuration#nginx-ssl-https-configuration). +- Ensure that `externalURL` in [site config](/admin/config/site-config) meets the following criteria: - It is the URL used by end users (no trailing slash). - It is HTTPS. @@ -126,7 +126,7 @@ First, check that the Federation metadata address value (which should look like `https://sourcegraph.example.com/.auth/saml/metadata`) is accessible by navigating to it in your web browser. If this fails, then something is likely misconfigured in Sourcegraph. Check that you have at most 1 SAML auth provider configured (`auth.providers` in [site -config](/admin/config/site_config)) or contact support for further guidance. +config](/admin/config/site-config)) or contact support for further guidance. If the endpoint works in your browser, it downloads a `metadata` XML file. This indicates the endpoint is working, but is inaccessible from ADFS (likely due to a firewall issue or ADFS not diff --git a/docs/admin/auth/saml/one_login.mdx b/docs/admin/auth/saml/one-login.mdx similarity index 100% rename from docs/admin/auth/saml/one_login.mdx rename to docs/admin/auth/saml/one-login.mdx diff --git a/docs/admin/beta_and_experimental_features.mdx b/docs/admin/beta-and-experimental-features.mdx similarity index 100% rename from docs/admin/beta_and_experimental_features.mdx rename to docs/admin/beta-and-experimental-features.mdx diff --git a/docs/admin/code_hosts/aws_codecommit.mdx b/docs/admin/code-hosts/aws-codecommit.mdx similarity index 99% rename from docs/admin/code_hosts/aws_codecommit.mdx rename to docs/admin/code-hosts/aws-codecommit.mdx index 4435bc901..a8593303d 100644 --- a/docs/admin/code_hosts/aws_codecommit.mdx +++ b/docs/admin/code-hosts/aws-codecommit.mdx @@ -31,7 +31,7 @@ For detailed instructions on how to create the credentials in IAM, see: [Setup f AWS CodeCommit connections support the following configuration options, which are specified in the JSON editor in the site admin "Manage code hosts" area. -{/*

[View page on our docs](/admin/code_hosts/aws_codecommit) to see rendered content.
*/} +{/*
[View page on our docs](/admin/code-hosts/aws-codecommit) to see rendered content.
*/} ### admin/code_hosts/aws_codecommit.schema.json diff --git a/docs/admin/code_hosts/azuredevops.mdx b/docs/admin/code-hosts/azuredevops.mdx similarity index 96% rename from docs/admin/code_hosts/azuredevops.mdx rename to docs/admin/code-hosts/azuredevops.mdx index f9983a2e1..59fa79b5c 100644 --- a/docs/admin/code_hosts/azuredevops.mdx +++ b/docs/admin/code-hosts/azuredevops.mdx @@ -49,17 +49,17 @@ Next, configure the code host connection by following the next steps: Currently, all repositories belonging to the configured organizations/projects will be synced. -In addition, you may exclude one or more repositories by setting the [`exclude`](/admin/code_hosts/azuredevops#configuration) field in the code host connection. +In addition, you may exclude one or more repositories by setting the [`exclude`](/admin/code-hosts/azuredevops#configuration) field in the code host connection. ### HTTPS cloning -Sourcegraph clones repositories from Azure DevOps via HTTP(S), using the [`username`](/admin/code_hosts/azuredevops#configuration) and [`token`](/admin/code_hosts/azuredevops#configuration) required fields you provide in the configuration. +Sourcegraph clones repositories from Azure DevOps via HTTP(S), using the [`username`](/admin/code-hosts/azuredevops#configuration) and [`token`](/admin/code-hosts/azuredevops#configuration) required fields you provide in the configuration. ## Configuration Azure DevOps connections support the following configuration options, which are specified in the JSON editor in the site admin "Manage code hosts" area. -{/*
[View page on our docs](/admin/code_hosts/azuredevops) to see rendered content.
*/} +{/*
[View page on our docs](/admin/code-hosts/azuredevops) to see rendered content.
*/} ### admin/code_hosts/azuredevops.schema.json @@ -173,7 +173,7 @@ Please consult [this page](/admin/webhooks/incoming) in order to configure webho [User-level permissions](/admin/permissions/syncing#permission-syncing) syncing is supported for Azure DevOps code host connections. Here is the list of prerequisites: -1. Configure Azure DevOps as an OAuth provider by consulting [this page](/admin/config/authorization_and_authentication#azure-devops-services) +1. Configure Azure DevOps as an OAuth provider by consulting [this page](/admin/config/authorization-and-authentication#azure-devops-services) 2. Next verify that users can now sign up / login to your Sourcegraph instance with your Azure DevOps OAuth provider 3. Set the following in your Azure DevOps code host connection: diff --git a/docs/admin/code_hosts/bitbucket_cloud.mdx b/docs/admin/code-hosts/bitbucket-cloud.mdx similarity index 95% rename from docs/admin/code_hosts/bitbucket_cloud.mdx rename to docs/admin/code-hosts/bitbucket-cloud.mdx index 80b2f2cec..4a664e6c6 100644 --- a/docs/admin/code_hosts/bitbucket_cloud.mdx +++ b/docs/admin/code-hosts/bitbucket-cloud.mdx @@ -20,9 +20,9 @@ Currently, all repositories belonging to the user configured will be synced. In addition, there is one more field for configuring which repositories are mirrored: -- [`teams`](/admin/code_hosts/bitbucket_cloud#configuration) +- [`teams`](/admin/code-hosts/bitbucket-cloud#configuration) A list of teams (workspaces) that the configured user has access to whose repositories should be synced. -- [`exclude`](/admin/code_hosts/bitbucket_cloud#configuration) +- [`exclude`](/admin/code-hosts/bitbucket-cloud#configuration) A list of repositories to exclude, which takes precedence over the `teams` field. ## Configuration options @@ -70,7 +70,7 @@ Use the newly created access token to configure the Bitbucket Cloud connection: ### HTTPS cloning -Sourcegraph clones repositories from your Bitbucket Cloud via HTTP(S), using the [`username`](/admin/code_hosts/bitbucket_cloud#configuration) and [`appPassword`](/admin/code_hosts/bitbucket_cloud#configuration) required fields you provide in the configuration. +Sourcegraph clones repositories from your Bitbucket Cloud via HTTP(S), using the [`username`](/admin/code-hosts/bitbucket-cloud#configuration) and [`appPassword`](/admin/code-hosts/bitbucket-cloud#configuration) required fields you provide in the configuration. ## Rate limits @@ -80,7 +80,7 @@ When Sourcegraph encounters rate limits on Bitbucket Cloud, it will retry the re ### Internal rate limits -See [Internal rate limits](/admin/code_hosts/rate_limits#internal-rate-limits) +See [Internal rate limits](/admin/code-hosts/rate-limits#internal-rate-limits) ## User authentication @@ -110,7 +110,7 @@ Then, add or edit a Bitbucket Cloud connection as described above and include th Bitbucket Cloud connections support the following configuration options, which are specified in the JSON editor in the site admin "Manage code hosts" area. -{/*
[View page on our docs](/admin/code_hosts/bitbucket_cloud) to see rendered content.
*/} +{/*
[View page on our docs](/admin/code-hosts/bitbucket-cloud) to see rendered content.
*/} ### admin/code_hosts/bitbucket_cloud.schema.json @@ -135,7 +135,7 @@ Bitbucket Cloud connections support the following configuration options, which a // 🚨 NOTE 🚨: Please use the "apiToken" field instead of this field, since Bitbucket Cloud is deprecating app passwords as of June 9, 2026. See https://www.atlassian.com/blog/bitbucket/bitbucket-cloud-transitions-to-api-tokens-enhancing-security-with-app-password-deprecation for more details. "appPassword": null, - // If non-null, enforces Bitbucket Cloud repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site_config#auth-providers) `auth.providers` field, of type "bitbucketcloud" with the same `url` field as specified in this `BitbucketCloudConnection`. + // If non-null, enforces Bitbucket Cloud repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site-config#auth-providers) `auth.providers` field, of type "bitbucketcloud" with the same `url` field as specified in this `BitbucketCloudConnection`. "authorization": { "identityProvider": null }, diff --git a/docs/admin/code_hosts/bitbucket_server.mdx b/docs/admin/code-hosts/bitbucket-server.mdx similarity index 96% rename from docs/admin/code_hosts/bitbucket_server.mdx rename to docs/admin/code-hosts/bitbucket-server.mdx index 45434a032..a3e48fb26 100644 --- a/docs/admin/code_hosts/bitbucket_server.mdx +++ b/docs/admin/code-hosts/bitbucket-server.mdx @@ -14,7 +14,7 @@ To connect Bitbucket Server / Bitbucket Data Center to Sourcegraph: 1. Configure the connection to Bitbucket Server / Bitbucket Data Center using the action buttons above the text field, and additional fields can be added using Cmd/Ctrl+Space for auto-completion. See the [configuration documentation below](#configuration). 1. Press **Add repositories**. -Also consider installing the [Sourcegraph Bitbucket Server plugin](/integration/bitbucket_server#sourcegraph-bitbucket-server-plugin) which enables native code navigation for every Bitbucket user when browsing code and reviewing pull requests, allows for faster permission syncing between Sourcegraph and Bitbucket Server / Bitbucket Data Center and adds support for webhooks to Bitbucket Server / Bitbucket Data Center. +Also consider installing the [Sourcegraph Bitbucket Server plugin](/integration/bitbucket-server#sourcegraph-bitbucket-server-plugin) which enables native code navigation for every Bitbucket user when browsing code and reviewing pull requests, allows for faster permission syncing between Sourcegraph and Bitbucket Server / Bitbucket Data Center and adds support for webhooks to Bitbucket Server / Bitbucket Data Center. ## Access token permissions @@ -30,13 +30,13 @@ For Bitbucket Server instances that don't support personal access tokens (Bitbuc There are four fields for configuring which repositories are mirrored: -- [`repos`](/admin/code_hosts/bitbucket_server#configuration) +- [`repos`](/admin/code-hosts/bitbucket-server#configuration) - A list of repositories in `projectKey/repositorySlug` format. The order determines the order in which we sync repository metadata and is safe to change. -- [`repositoryQuery`](/admin/code_hosts/bitbucket_server#configuration) +- [`repositoryQuery`](/admin/code-hosts/bitbucket-server#configuration) - A list of strings with some pre-defined options (`none`, `all`), and/or a [Bitbucket Server / Bitbucket Data Center Repo Search Request Query Parameters](https://docs.atlassian.com/bitbucket-server/rest/6.1.2/bitbucket-rest.html#idp355). -- [`exclude`](/admin/code_hosts/bitbucket_server#configuration) +- [`exclude`](/admin/code-hosts/bitbucket-server#configuration) - A list of repositories to exclude which takes precedence over the `repos`, and `repositoryQuery` fields. -- [`excludePersonalRepositories`](/admin/code_hosts/bitbucket_server#configuration) +- [`excludePersonalRepositories`](/admin/code-hosts/bitbucket-server#configuration) - With this enabled, Sourcegraph will exclude any personal repositories from being imported, even if it has access to them. ## Webhooks @@ -51,12 +51,12 @@ Enforcing Bitbucket Server / Bitbucket Data Center permissions can be configured > NOTE: It can take some time to complete full cycle of repository permissions sync if you have a large number of users or repositories. [See sync duration time](/admin/permissions/syncing#sync-duration) for more information. -> NOTE: Sourcegraph can only sync permissions for personal repositories on Bitbucket Server / Bitbucket Data Center when the Sourcegraph [Bitbucket Server plugin](/integration/bitbucket_server) is installed. +> NOTE: Sourcegraph can only sync permissions for personal repositories on Bitbucket Server / Bitbucket Data Center when the Sourcegraph [Bitbucket Server plugin](/integration/bitbucket-server) is installed. ### Prerequisites 1. You have the exact same user accounts, **with matching usernames**, in Sourcegraph and Bitbucket Server / Bitbucket Data Center. This can be accomplished by configuring an [external authentication provider](/admin/auth/) that mirrors user accounts from a central directory like LDAP or Active Directory. The same should be done on Bitbucket Server / Bitbucket Data Center with [external user directories](https://confluence.atlassian.com/bitbucketserver/external-user-directories-776640394.html). -1. Ensure you have set `auth.enableUsernameChanges` to **`false`** in the [site config](/admin/config/site_config) to prevent users from changing their usernames and **escalating their privileges**. +1. Ensure you have set `auth.enableUsernameChanges` to **`false`** in the [site config](/admin/config/site-config) to prevent users from changing their usernames and **escalating their privileges**. ### Setup @@ -159,15 +159,15 @@ As an admin user, go to the "Application Links" page. You can use the sidebar na ### Fast permission sync with Bitbucket Server plugin -By installing the [Bitbucket Server plugin](/integration/bitbucket_server), you can make use of the fast permission sync feature that allows using Bitbucket Server / Bitbucket Data Center permissions on larger instances. +By installing the [Bitbucket Server plugin](/integration/bitbucket-server), you can make use of the fast permission sync feature that allows using Bitbucket Server / Bitbucket Data Center permissions on larger instances. ### Fast permission syncing -With the [Sourcegraph Bitbucket Server plugin](/integration/bitbucket_server#sourcegraph-bitbucket-server-plugin) you can enable fast permission syncing: +With the [Sourcegraph Bitbucket Server plugin](/integration/bitbucket-server#sourcegraph-bitbucket-server-plugin) you can enable fast permission syncing: 1. Connect Bitbucket Server / Bitbucket Data Center to Sourcegraph (_see instructions above_). 1. Follow the [instructions to set up repository permissions](#repository-permissions) with Bitbucket Server / Bitbucket Data Center. -1. Install the [Sourcegraph Bitbucket Server plugin](/integration/bitbucket_server#sourcegraph-bitbucket-server-plugin) on your Bitbucket Server / Bitbucket Data Center instance. +1. Install the [Sourcegraph Bitbucket Server plugin](/integration/bitbucket-server#sourcegraph-bitbucket-server-plugin) on your Bitbucket Server / Bitbucket Data Center instance. 1. In Sourcegraph, go to **Site admin > Manage code hosts** and edit the Bitbucket Server / Bitbucket Data Center configuration. 1. Add the `"plugin.permissions"` property: @@ -186,17 +186,17 @@ Bitbucket Server / Bitbucket Data Center versions older than v5.5 require specif ### HTTPS cloning -Sourcegraph by default clones repositories from your Bitbucket Server / Bitbucket Data Center via HTTP(S), using the access token or account credentials you provide in the configuration. The [`username`](/admin/code_hosts/bitbucket_server#configuration) field is always used when cloning, so it is required. +Sourcegraph by default clones repositories from your Bitbucket Server / Bitbucket Data Center via HTTP(S), using the access token or account credentials you provide in the configuration. The [`username`](/admin/code-hosts/bitbucket-server#configuration) field is always used when cloning, so it is required. ## Internal rate limits -See [Internal rate limits](/admin/code_hosts/rate_limits#internal-rate-limits). +See [Internal rate limits](/admin/code-hosts/rate-limits#internal-rate-limits). ## Configuration Bitbucket Server / Bitbucket Data Center connections support the following configuration options, which are specified in the JSON editor in the site admin "Manage code hosts" area. -{/*
[View page on our docs](/admin/code_hosts/bitbucket_server) to see rendered content.
*/} +{/*
[View page on our docs](/admin/code-hosts/bitbucket-server) to see rendered content.
*/} ### admin/code_hosts/bitbucket_server.schema.json @@ -252,7 +252,7 @@ Bitbucket Server / Bitbucket Data Center connections support the following confi // ] "exclude": null, - // Whether or not personal repositories should be excluded or not. When true, Sourcegraph will ignore personal repositories it may have access to. See https://sourcegraph.com/docs/integration/bitbucket_server#excluding-personal-repositories for more information. + // Whether or not personal repositories should be excluded or not. When true, Sourcegraph will ignore personal repositories it may have access to. See https://sourcegraph.com/docs/integration/bitbucket-server#excluding-personal-repositories for more information. "excludePersonalRepositories": false, // SSH cipher to use when cloning via SSH. Must be a valid choice from `ssh -Q cipher`. diff --git a/docs/admin/code_hosts/gerrit.mdx b/docs/admin/code-hosts/gerrit.mdx similarity index 98% rename from docs/admin/code_hosts/gerrit.mdx rename to docs/admin/code-hosts/gerrit.mdx index 007b3e1be..c0b21aa8e 100644 --- a/docs/admin/code_hosts/gerrit.mdx +++ b/docs/admin/code-hosts/gerrit.mdx @@ -74,7 +74,7 @@ To clone using SSH, provide `"gitSSHCredential"` in the configuration: If the `"authorization": {}` option has been set on a Gerrit code host connection, a Gerrit authentication provider will be required so that authroized users are able to search for and browse the code mirrored by that code host connection. -1. In the **Site Admin** settings area, select [**Site configuration**](/admin/config/site_config) from the options on the left. +1. In the **Site Admin** settings area, select [**Site configuration**](/admin/config/site-config) from the options on the left. 2. Add a Gerrit configuration to the list of `"auth.providers"`. ![Add a Gerrit configuration to the list of configured authentication providers](https://storage.googleapis.com/sourcegraph-assets/docs/images/administration/config/external-services/gerrit/gerrit-auth.png) 3. Here is an example configuration: @@ -107,7 +107,7 @@ As a user: Gerrit connections support the following configuration options, which are specified in the JSON editor in the site admin "Manage code hosts" area. -{/*
[View page on our docs](/admin/code_hosts/gerrit) to see rendered content.
*/} +{/*
[View page on our docs](/admin/code-hosts/gerrit) to see rendered content.
*/} ### admin/code_hosts/gerrit.schema.json @@ -117,7 +117,7 @@ Gerrit connections support the following configuration options, which are specif ```json { - // If non-null, enforces Gerrit repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site_config#auth-providers) `auth.providers` field, of type "gerrit" with the same `url` field as specified in this `GerritConnection`. + // If non-null, enforces Gerrit repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site-config#auth-providers) `auth.providers` field, of type "gerrit" with the same `url` field as specified in this `GerritConnection`. "authorization": { "identityProvider": null }, diff --git a/docs/admin/code_hosts/github.mdx b/docs/admin/code-hosts/github.mdx similarity index 98% rename from docs/admin/code_hosts/github.mdx rename to docs/admin/code-hosts/github.mdx index 8931ac184..f906a7163 100644 --- a/docs/admin/code_hosts/github.mdx +++ b/docs/admin/code-hosts/github.mdx @@ -21,7 +21,7 @@ There are 2 ways to connect with GitHub: Sourcegraph 5.1+ -{/* */} +{/* */} There are two ways to connect a GitHub App: @@ -99,7 +99,7 @@ When creating a code host connection for a GitHub App with multiple installation > NOTE: When you create a GitHub App, Sourcegraph automatically sets up an [incoming webhook](/admin/webhooks/incoming) for the app. This webhook subscribes to events for any repository or organization the app has access to, allowing Sourcegraph to keep repository and permission data in sync with GitHub. -> NOTE: If you are using [Batch Changes](/batch-changes/), you can create a GitHub App to perform [commit signing](/admin/config/batch_changes#commit-signing-for-github) (Beta). +> NOTE: If you are using [Batch Changes](/batch-changes/), you can create a GitHub App to perform [commit signing](/admin/config/batch-changes#commit-signing-for-github) (Beta). #### Multiple installations @@ -313,10 +313,10 @@ For more details, see [GitHub API access](#github-api-access). There are four fields for configuring which repositories are mirrored/synchronized: -- [`repos`](/admin/code_hosts/github#repos)A list of repositories in `owner/name` format. The order determines the order in which we sync repository metadata and is safe to change. -- [`orgs`](/admin/code_hosts/github#orgs)A list of organizations (every repository belonging to the organization will be cloned). -- [`repositoryQuery`](/admin/code_hosts/github#repositoryQuery)A list of strings with three pre-defined options (`public`, `affiliated`, `none`, none of which are subject to result limitations), and/or a [GitHub advanced search query](https://github.com/search/advanced). Note: There is an existing limitation that requires the latter, GitHub advanced search queries, to return [less than 1000 results](#repositoryquery-returns-first-1000-results-only). -- [`exclude`](/admin/code_hosts/github#exclude)A list of repositories to exclude which takes precedence over the `repos`, `orgs`, and `repositoryQuery` fields. +- [`repos`](/admin/code-hosts/github#repos)A list of repositories in `owner/name` format. The order determines the order in which we sync repository metadata and is safe to change. +- [`orgs`](/admin/code-hosts/github#orgs)A list of organizations (every repository belonging to the organization will be cloned). +- [`repositoryQuery`](/admin/code-hosts/github#repositoryQuery)A list of strings with three pre-defined options (`public`, `affiliated`, `none`, none of which are subject to result limitations), and/or a [GitHub advanced search query](https://github.com/search/advanced). Note: There is an existing limitation that requires the latter, GitHub advanced search queries, to return [less than 1000 results](#repositoryquery-returns-first-1000-results-only). +- [`exclude`](/admin/code-hosts/github#exclude)A list of repositories to exclude which takes precedence over the `repos`, `orgs`, and `repositoryQuery` fields. ## Rate limits @@ -338,7 +338,7 @@ $ curl -s https:///api/v3/rate_limit -H "Authorization: B ### Internal rate limits -See [Internal rate limits](/admin/code_hosts/rate_limits#internal-rate-limits). +See [Internal rate limits](/admin/code-hosts/rate-limits#internal-rate-limits). ## Repository permissions @@ -422,7 +422,7 @@ This caching behaviour can be enabled via the `authorization.groupsCacheTTL` fie } ``` -In the corresponding [authorization provider](/admin/auth/#github) in [site configuration](/admin/config/site_config), the `allowGroupsPermissionsSync` field must be set as well for the correct auth scopes to be requested from users: +In the corresponding [authorization provider](/admin/auth/#github) in [site configuration](/admin/config/site-config), the `allowGroupsPermissionsSync` field must be set as well for the correct auth scopes to be requested from users: ```json { @@ -475,7 +475,7 @@ Please consult [this page](/admin/webhooks/incoming) in order to configure webho GitHub connections support the following configuration options, which are specified in the JSON editor in the site admin "Manage code hosts" area. -{/*
[View page on our docs](/admin/code_hosts/github) to see rendered content.
*/} +{/*
[View page on our docs](/admin/code-hosts/github) to see rendered content.
*/} ### admin/code_hosts/github.schema.json @@ -486,7 +486,7 @@ GitHub connections support the following configuration options, which are specif // Authentication alternatives: token OR gitHubAppDetails OR externalAccount OR useRandomExternalAccount { - // If non-null, enforces GitHub repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site_config#auth-providers) `auth.providers` field, of type "github" with the same `url` field as specified in this `GitHubConnection`. + // If non-null, enforces GitHub repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site-config#auth-providers) `auth.providers` field, of type "github" with the same `url` field as specified in this `GitHubConnection`. "authorization": { "groupsCacheTTL": 72, "markInternalReposAsPublic": false, @@ -613,7 +613,7 @@ GitHub connections support the following configuration options, which are specif "none" ], - // A GitHub personal access token. Create one for GitHub.com at https://github.com/settings/tokens/new?description=Sourcegraph (for GitHub Enterprise, replace github.com with your instance's hostname). See https://sourcegraph.com/docs/admin/code_hosts/github#github-api-access for which scopes are required for which use cases. + // A GitHub personal access token. Create one for GitHub.com at https://github.com/settings/tokens/new?description=Sourcegraph (for GitHub Enterprise, replace github.com with your instance's hostname). See https://sourcegraph.com/docs/admin/code-hosts/github#github-api-access for which scopes are required for which use cases. "token": null, // REQUIRED: diff --git a/docs/admin/code_hosts/gitlab.mdx b/docs/admin/code-hosts/gitlab.mdx similarity index 97% rename from docs/admin/code_hosts/gitlab.mdx rename to docs/admin/code-hosts/gitlab.mdx index 520c4ca37..7321037ab 100644 --- a/docs/admin/code_hosts/gitlab.mdx +++ b/docs/admin/code-hosts/gitlab.mdx @@ -49,12 +49,12 @@ Example config: There are three fields for configuring which projects are mirrored/synchronized: -- [`projects`](/admin/code_hosts/gitlab#configuration): A list of projects in `{"name": "group/name"}` or `{"id": id}` format. The order determines the order in which we sync project metadata and is safe to change. -- [`projectQuery`](/admin/code_hosts/gitlab#configuration): A list of strings. Accepted values include: +- [`projects`](/admin/code-hosts/gitlab#configuration): A list of projects in `{"name": "group/name"}` or `{"id": id}` format. The order determines the order in which we sync project metadata and is safe to change. +- [`projectQuery`](/admin/code-hosts/gitlab#configuration): A list of strings. Accepted values include: - The special value `none`, which will sync no repositories. - Query parameters for the [GitLab Projects API endpoint](https://docs.gitlab.com/ee/api/projects.html). For example, `?archived=false`. - A path and set of query parameters for any GitLab API endpoint that returns a list of repos. For example, `groups/mygroup/projects?visibility=public`. -- [`exclude`](/admin/code_hosts/gitlab#configuration): A list of projects to exclude which takes precedence over the `projects`, and `projectQuery` fields. It has the same format as `projects`. +- [`exclude`](/admin/code-hosts/gitlab#configuration): A list of projects to exclude which takes precedence over the `projects`, and `projectQuery` fields. It has the same format as `projects`. ### Troubleshooting @@ -179,11 +179,11 @@ When Sourcegraph hits a rate limit imposed by GitLab, Sourcegraph waits the appr ### Internal rate limits -See [Internal rate limits](/admin/code_hosts/rate_limits#internal-rate-limits). +See [Internal rate limits](/admin/code-hosts/rate-limits#internal-rate-limits). ## Configuration -{/*
[View page on our docs](/admin/code_hosts/gitlab) to see rendered content.
*/} +{/*
[View page on our docs](/admin/code-hosts/gitlab) to see rendered content.
*/} ### admin/code_hosts/gitlab.schema.json @@ -332,9 +332,9 @@ See [Internal rate limits](/admin/code_hosts/rate_limits#internal-rate-limits). ## Native integration -To provide out-of-the-box code navigation features to your users on GitLab, you will need to [configure your GitLab instance](https://docs.gitlab.com/ee/integration/sourcegraph.html). If you are using an HTTPS connection to GitLab, you will need to [configure HTTPS](/self-hosted/http_https_configuration) for your Sourcegraph instance. +To provide out-of-the-box code navigation features to your users on GitLab, you will need to [configure your GitLab instance](https://docs.gitlab.com/ee/integration/sourcegraph.html). If you are using an HTTPS connection to GitLab, you will need to [configure HTTPS](/self-hosted/http-https-configuration) for your Sourcegraph instance. -The Sourcegraph instance's site admin must [update the `corsOrigin` site config property](/admin/config/site_config) to allow the GitLab instance to communicate with the Sourcegraph instance. For example: +The Sourcegraph instance's site admin must [update the `corsOrigin` site config property](/admin/config/site-config) to allow the GitLab instance to communicate with the Sourcegraph instance. For example: ```json { diff --git a/docs/admin/code_hosts/gitolite.mdx b/docs/admin/code-hosts/gitolite.mdx similarity index 97% rename from docs/admin/code_hosts/gitolite.mdx rename to docs/admin/code-hosts/gitolite.mdx index 3d5b1be21..c2b81f0e4 100644 --- a/docs/admin/code_hosts/gitolite.mdx +++ b/docs/admin/code-hosts/gitolite.mdx @@ -19,7 +19,7 @@ To connect Gitolite to Sourcegraph: ## Configuration -{/*
[View page on sourcegraph.com/docs](/admin/code_hosts/gitolite) to see rendered content.
*/} +{/*
[View page on sourcegraph.com/docs](/admin/code-hosts/gitolite) to see rendered content.
*/} ### admin/code_hosts/gitolite.schema.json diff --git a/docs/admin/code_hosts/index.mdx b/docs/admin/code-hosts/index.mdx similarity index 89% rename from docs/admin/code_hosts/index.mdx rename to docs/admin/code-hosts/index.mdx index e6edce526..bc466b25d 100644 --- a/docs/admin/code_hosts/index.mdx +++ b/docs/admin/code-hosts/index.mdx @@ -37,29 +37,29 @@ Tier 1 code hosts are our highest level of support for code hosts. When leveragi ## Tier 2: Code Hosts -We recognize there are other code hosts including CVS, SVN, and many more. Today, we do not offer native integrations with these code hosts and customers are advised to leverage [Src-srv-git](/admin/code_hosts/non-git) and the [explicit permissions API](/admin/permissions/api) as a way to ingest code and permissions respectively into Sourcegraph. +We recognize there are other code hosts including CVS, SVN, and many more. Today, we do not offer native integrations with these code hosts and customers are advised to leverage [Src-srv-git](/admin/code-hosts/non-git) and the [explicit permissions API](/admin/permissions/api) as a way to ingest code and permissions respectively into Sourcegraph. -[Src-srv-git](/admin/code_hosts/non-git) and the [explicit permissions API](/admin/permissions/api) follow the same scale guidance shared above (up to 100k repos and 10k users). +[Src-srv-git](/admin/code-hosts/non-git) and the [explicit permissions API](/admin/permissions/api) follow the same scale guidance shared above (up to 100k repos and 10k users). ## Configure a code host connection **Site admins** can configure Sourcegraph to sync code from the following code hosts: -- [GitHub](/admin/code_hosts/github) -- [GitLab](/admin/code_hosts/gitlab) -- [Bitbucket Cloud](/admin/code_hosts/bitbucket_cloud) -- [Bitbucket Server / Bitbucket Data Center](/admin/code_hosts/bitbucket_server) -- [Azure DevOps](/admin/code_hosts/azuredevops) -- [Gerrit](/admin/code_hosts/gerrit) -- [AWS CodeCommit](/admin/code_hosts/aws_codecommit) -- [Other Git code hosts (using a Git URL)](/admin/code_hosts/other) -- [Non-Git code hosts](/admin/code_hosts/non-git) +- [GitHub](/admin/code-hosts/github) +- [GitLab](/admin/code-hosts/gitlab) +- [Bitbucket Cloud](/admin/code-hosts/bitbucket-cloud) +- [Bitbucket Server / Bitbucket Data Center](/admin/code-hosts/bitbucket-server) +- [Azure DevOps](/admin/code-hosts/azuredevops) +- [Gerrit](/admin/code-hosts/gerrit) +- [AWS CodeCommit](/admin/code-hosts/aws-codecommit) +- [Other Git code hosts (using a Git URL)](/admin/code-hosts/other) +- [Non-Git code hosts](/admin/code-hosts/non-git) - [Perforce](/admin/repo/perforce) - [Plastic SCM](/admin/repo/plasticscm) ## Rate limits -For information on code host-related rate limits, see [rate limits](/admin/code_hosts/rate_limits). +For information on code host-related rate limits, see [rate limits](/admin/code-hosts/rate-limits). ## Temporarily disabling requests to code hosts diff --git a/docs/admin/code_hosts/non-git.mdx b/docs/admin/code-hosts/non-git.mdx similarity index 98% rename from docs/admin/code_hosts/non-git.mdx rename to docs/admin/code-hosts/non-git.mdx index d64f5b1cc..fb4b8705c 100644 --- a/docs/admin/code_hosts/non-git.mdx +++ b/docs/admin/code-hosts/non-git.mdx @@ -11,7 +11,7 @@ Sourcegraph natively supports all Git-based Version Control Systems (VCSs) and c ## Use `src serve-git` -Since Sourcegraph 3.19 we recommend users to use [`src serve-git`](/admin/code_hosts/src_serve_git). `src serve-git` only provides the serving of git repositories (no snapshotting). We found users generally wanted to control the git repos and snapshotting complicated the setup. Additionally `src serve-git` uses a fast and modern git transfer protocol. +Since Sourcegraph 3.19 we recommend users to use [`src serve-git`](/admin/code-hosts/src-serve-git). `src serve-git` only provides the serving of git repositories (no snapshotting). We found users generally wanted to control the git repos and snapshotting complicated the setup. Additionally `src serve-git` uses a fast and modern git transfer protocol. ## Installing `src-expose` diff --git a/docs/admin/code_hosts/other.mdx b/docs/admin/code-hosts/other.mdx similarity index 97% rename from docs/admin/code_hosts/other.mdx rename to docs/admin/code-hosts/other.mdx index 283cd5040..61b67cb62 100644 --- a/docs/admin/code_hosts/other.mdx +++ b/docs/admin/code-hosts/other.mdx @@ -5,7 +5,7 @@ Available via the Web app. -Site admins can sync Git repositories on any Git repository host (by Git clone URL) with Sourcegraph so that users can search and navigate the repositories. Use this method only when your repository host is not named as a supported [code host](/admin/code_hosts/). +Site admins can sync Git repositories on any Git repository host (by Git clone URL) with Sourcegraph so that users can search and navigate the repositories. Use this method only when your repository host is not named as a supported [code host](/admin/code-hosts/). To connect generic Git host to Sourcegraph: @@ -62,7 +62,7 @@ Repositories must be listed individually: ## Configuration -{/*
[View page on our docs](/admin/code_hosts/other) to see rendered content.
*/} +{/*
[View page on our docs](/admin/code-hosts/other) to see rendered content.
*/} ### admin/code_hosts/other_external_service.schema.json diff --git a/docs/admin/code_hosts/phabricator.mdx b/docs/admin/code-hosts/phabricator.mdx similarity index 96% rename from docs/admin/code_hosts/phabricator.mdx rename to docs/admin/code-hosts/phabricator.mdx index 18a92ba73..aefcd50d9 100644 --- a/docs/admin/code_hosts/phabricator.mdx +++ b/docs/admin/code-hosts/phabricator.mdx @@ -5,7 +5,7 @@ Available via the Web app. -Site admins can associate Git repositories on [Phabricator](https://phabricator.org) with Sourcegraph so that users can jump to the Phabricator repository from Sourcegraph and use the [Phabricator extension](#native-extension) and [browser extension](/integration/browser_extension) with Phabricator. +Site admins can associate Git repositories on [Phabricator](https://phabricator.org) with Sourcegraph so that users can jump to the Phabricator repository from Sourcegraph and use the [Phabricator extension](#native-extension) and [browser extension](/integration/browser-extension) with Phabricator. > ⚠️ NOTE: Sourcegraph support of Phabricator is limited ([learn more](/integration/phabricator)), and not expected to evolve due to the [announced](https://admin.phacility.com/phame/post/view/11/phacility_is_winding_down_operations/) cease of support for Phabricator. @@ -58,7 +58,7 @@ For production usage, we recommend installing the Sourcegraph Phabricator extens See the [phabricator-extension](https://github.com/sourcegraph/phabricator-extension) repository for installation instructions and configuration settings. -The Sourcegraph instance's site admin must [update the `corsOrigin` site config property](/admin/config/site_config) to allow the Phabricator extension to communicate with the Sourcegraph instance. For example: +The Sourcegraph instance's site admin must [update the `corsOrigin` site config property](/admin/config/site-config) to allow the Phabricator extension to communicate with the Sourcegraph instance. For example: ```json { @@ -70,7 +70,7 @@ The Sourcegraph instance's site admin must [update the `corsOrigin` site config ## Configuration -{/*
[View page on our docs](/admin/code_hosts/phabricator) to see rendered content.
*/} +{/*
[View page on our docs](/admin/code-hosts/phabricator) to see rendered content.
*/} ### admin/code_hosts/phabricator.schema.json diff --git a/docs/admin/code_hosts/rate_limits.mdx b/docs/admin/code-hosts/rate-limits.mdx similarity index 85% rename from docs/admin/code_hosts/rate_limits.mdx rename to docs/admin/code-hosts/rate-limits.mdx index 810189f84..269e8765c 100644 --- a/docs/admin/code_hosts/rate_limits.mdx +++ b/docs/admin/code-hosts/rate-limits.mdx @@ -5,7 +5,7 @@ Sourcegraph respects and enforces various rate limits to ensure optimal and reli - [External rate limits](#external-rate-limits) - [Internal rate limits](#internal-rate-limits) -For other ways to control repo update frequency, see [Repository update frequency](/admin/repo/update_frequency). +For other ways to control repo update frequency, see [Repository update frequency](/admin/repo/update-frequency). ## External rate limits @@ -21,16 +21,16 @@ If working with a self-hosted code host, consult the code host documentation to Sourcegraph monitors external rate limits for the following code hosts: -- [GitHub](/admin/code_hosts/github#rate-limits) -- [GitLab](/admin/code_hosts/gitlab#rate-limits) -- [Bitbucket Cloud](/admin/code_hosts/bitbucket_cloud#rate-limits) -- [Azure DevOps](/admin/code_hosts/azuredevops#rate-limits) +- [GitHub](/admin/code-hosts/github#rate-limits) +- [GitLab](/admin/code-hosts/gitlab#rate-limits) +- [Bitbucket Cloud](/admin/code-hosts/bitbucket-cloud#rate-limits) +- [Azure DevOps](/admin/code-hosts/azuredevops#rate-limits) ## Internal rate limits Internal rate limits refer to self-imposed rate limits within Sourcegraph. While Sourcegraph adheres to external rate limits, sometimes more control is necessary, or a code host might not have rate limit monitoring available or configured. In these cases, internal rate limits can be configured. -A [global default internal rate limit](/admin/config/site_config#defaultRateLimit) can be configured in the [site configuration](/admin/config/site_config). This limit applies to all code host connections that don't have a specific rate limit configured. +A [global default internal rate limit](/admin/config/site-config#defaultRateLimit) can be configured in the [site configuration](/admin/config/site-config). This limit applies to all code host connections that don't have a specific rate limit configured. > NOTE: This is the default rate limit _per code host connection_. It is not the total rate limit of all the code host connections. @@ -71,8 +71,8 @@ This entry tells us that a rate limit is configured for a GitHub external servic Sourcegraph supports internal rate limit configuration for the following connections: -- [GitHub](/admin/code_hosts/github#rateLimit) -- [GitLab](/admin/code_hosts/gitlab#rateLimit) -- [Bitbucket Cloud](/admin/code_hosts/bitbucket_cloud#rateLimit) -- [Bitbucket Server](/admin/code_hosts/bitbucket_server#rateLimit) +- [GitHub](/admin/code-hosts/github#rateLimit) +- [GitLab](/admin/code-hosts/gitlab#rateLimit) +- [Bitbucket Cloud](/admin/code-hosts/bitbucket-cloud#rateLimit) +- [Bitbucket Server](/admin/code-hosts/bitbucket-server#rateLimit) - [Perforce](/admin/repo/perforce#rateLimit) diff --git a/docs/admin/code_hosts/src_serve_git.mdx b/docs/admin/code-hosts/src-serve-git.mdx similarity index 96% rename from docs/admin/code_hosts/src_serve_git.mdx rename to docs/admin/code-hosts/src-serve-git.mdx index 083c9b834..a3e06695c 100644 --- a/docs/admin/code_hosts/src_serve_git.mdx +++ b/docs/admin/code-hosts/src-serve-git.mdx @@ -2,11 +2,11 @@ Sourcegraph is designed to abstract away all repository management operations from the user. However, we still often get the question: "how do I load local repositories?" -The instructions below (using the Sourcegraph CLI to act as a pseudo-code host for Sourcegraph to interact with) do enable this, but they can be quite complex. The root of the challenge is that Sourcegraph assumes that code will change over time. It has been intentionally designed to save the user from the manual effort of keeping repositories up to date (i.e., re-cloning or fetching the latest changes every time you want to search) by [automatically keeping repositories updated](/admin/repo/update_frequency), keeping the updated content indexed, and making the change history visible and explorable to users. +The instructions below (using the Sourcegraph CLI to act as a pseudo-code host for Sourcegraph to interact with) do enable this, but they can be quite complex. The root of the challenge is that Sourcegraph assumes that code will change over time. It has been intentionally designed to save the user from the manual effort of keeping repositories up to date (i.e., re-cloning or fetching the latest changes every time you want to search) by [automatically keeping repositories updated](/admin/repo/update-frequency), keeping the updated content indexed, and making the change history visible and explorable to users. And, practically, Sourcegraph was built with the assumption that certain tasks, such as getting a list of repositories and running git operations like clones, would be accessible over a network rather than on the same disk (i.e., that there would be HTTP API and git endpoints). -In both the short-term and the long-term, it is far easier for users to [connect Sourcegraph to a code host](/admin/code_hosts) than to try to load code from a local disk, and we strongly encourage users, where possible, to connect to their code host of choice instead of trying to follow the instructions below. +In both the short-term and the long-term, it is far easier for users to [connect Sourcegraph to a code host](/admin/code-hosts) than to try to load code from a local disk, and we strongly encourage users, where possible, to connect to their code host of choice instead of trying to follow the instructions below. When Sourcegraph is connected to a code host, none of that code is ever sent off of your local Sourcegraph deployment, and nobody that you haven't given access to (whether at Sourcegraph or anywhere else) has access to your code. Sourcegraph only maintains a local clone, and does all code analysis and indexing operations locally. Read more specifics about our policies and what we do collect in [our security overview](https://about.sourcegraph.com/security/#Sourcegraph-on-premise). @@ -52,4 +52,4 @@ To confirm this is working visit http://localhost:3434 ## src-expose -Before Sourcegraph 3.19 we recommend users to still use [`src-expose`](/admin/code_hosts/non-git). +Before Sourcegraph 3.19 we recommend users to still use [`src-expose`](/admin/code-hosts/non-git). diff --git a/docs/admin/config/authorization_and_authentication.mdx b/docs/admin/config/authorization-and-authentication.mdx similarity index 97% rename from docs/admin/config/authorization_and_authentication.mdx rename to docs/admin/config/authorization-and-authentication.mdx index e4d3c36b7..e2976070e 100644 --- a/docs/admin/config/authorization_and_authentication.mdx +++ b/docs/admin/config/authorization-and-authentication.mdx @@ -9,7 +9,7 @@ We suggest configuring both when using Sourcegraph Enterprise. If you do not con ## Authentication -Sourcegraph supports username/password auth by default and SAML, OAuth, HTTP Proxy auth, and OpenID Connect if configured. Changing a username in Sourcegraph will allow the user to escalate permissions, so if you are syncing permissions, you will need to add the following to your site config at `https://sourcegraph.yourdomain.com/siteadmin/configuration` ([Learn more about viewing and editing your site configuration.](/admin/config/site_config#view-and-edit-site-configuration)) +Sourcegraph supports username/password auth by default and SAML, OAuth, HTTP Proxy auth, and OpenID Connect if configured. Changing a username in Sourcegraph will allow the user to escalate permissions, so if you are syncing permissions, you will need to add the following to your site config at `https://sourcegraph.yourdomain.com/siteadmin/configuration` ([Learn more about viewing and editing your site configuration.](/admin/config/site-config#view-and-edit-site-configuration)) ```json { @@ -64,7 +64,7 @@ In this way, access to Sourcegraph will still be managed by your identity provid Follow these steps to [configure authentication with GitHub via OAuth](/admin/auth/#github). -Once authentication with GitHub via OAuth is configured, follow [these steps to configure access permissions](/admin/code_hosts/github#repository-permissions). Users will log into Sourcegraph using Github OAuth, and permissions will be synced in the background. +Once authentication with GitHub via OAuth is configured, follow [these steps to configure access permissions](/admin/code-hosts/github#repository-permissions). Users will log into Sourcegraph using Github OAuth, and permissions will be synced in the background. ### GitLab Enterprise or GitLab Cloud authentication and authorization @@ -75,13 +75,13 @@ We support both authentication and permissions syncing (through OAuth) for GitLa 1. Use SAML (or another auth mechanism) to log in to GitLab 2. Use GitLab OAuth to log in to Sourcegraph -In this way, access to Sourcegraph will still be managed by your identity provider, using the code host as a middle step. This option is the simplest to configure. To do so, [set up GitLab as an authentication option](/admin/auth/#gitlab), and then [enable permissions syncing](/admin/code_hosts/gitlab#oauth-application). +In this way, access to Sourcegraph will still be managed by your identity provider, using the code host as a middle step. This option is the simplest to configure. To do so, [set up GitLab as an authentication option](/admin/auth/#gitlab), and then [enable permissions syncing](/admin/code-hosts/gitlab#oauth-application). #### Option 2 Alternatively, you can configure SAML authentication in Sourcegraph, and use GitLab permissions syncing in the background to control access permissions. To implement this method, you will need to make sure that GitLab is able to return a value in `identities.provider` for the `GET /users` endpoint ([GitLab documentation](https://docs.gitlab.com/ee/api/users.html#for-admins)) that your identity provider is able to pass as the `nameID` in the SAML response. If that isn’t possible, you will need to use the first option. -To configure SAML auth with GitLab permissions, you will need to first [configure permissions from GitLab](/admin/code_hosts/gitlab#administrator-sudo-level-access-token). Then, [configure SAML authentication](/admin/auth/saml/). The `nameID` passed by the identity provider will need to match the value of `identities.provider`. +To configure SAML auth with GitLab permissions, you will need to first [configure permissions from GitLab](/admin/code-hosts/gitlab#administrator-sudo-level-access-token). Then, [configure SAML authentication](/admin/auth/saml/). The `nameID` passed by the identity provider will need to match the value of `identities.provider`. For example, if the GitLab API returns: diff --git a/docs/admin/config/batch_changes.mdx b/docs/admin/config/batch-changes.mdx similarity index 99% rename from docs/admin/config/batch_changes.mdx rename to docs/admin/config/batch-changes.mdx index f533c5de3..80031b00a 100644 --- a/docs/admin/config/batch_changes.mdx +++ b/docs/admin/config/batch-changes.mdx @@ -1,10 +1,10 @@ # Batch Changes site admin configuration reference -Batch Changes is generally configured through the same [site configuration](/admin/config/site_config) and [code host configuration](/admin/code_hosts/) as the rest of Sourcegraph. However, Batch Changes features may require specific configuration, and those are documented here. +Batch Changes is generally configured through the same [site configuration](/admin/config/site-config) and [code host configuration](/admin/code-hosts/) as the rest of Sourcegraph. However, Batch Changes features may require specific configuration, and those are documented here. ## Access control -Batch Changes is [RBAC-enabled](/admin/access_control/) Beta. By default, all users have full read and write access for Batch Changes, but this can be restricted by changing the default role permissions, or by creating new custom roles. +Batch Changes is [RBAC-enabled](/admin/access-control/) Beta. By default, all users have full read and write access for Batch Changes, but this can be restricted by changing the default role permissions, or by creating new custom roles. ### Enable organization members to administer @@ -16,7 +16,7 @@ By default, Sourcegraph attempts to reconcile (create, update, or close) changes Configuring rollout windows allows changesets to be reconciled at a slower or faster rate based on the time of day and/or the day of the week. These windows are applied to changesets across all code hosts, but they only affect the rate at which changesets are created/published, updated, or closed, as well as some other internal operations like importing and detaching. Bulk operations to publish changesets also respect the rollout window; however, bulk commenting, merging, and closing will happen all at once. -Rollout windows are configured through the `batchChanges.rolloutWindows` [site configuration option](/admin/config/site_config). If specified, this option contains an array of rollout window objects that are used to schedule changesets. The format of these objects [is given below](#rollout-window-object). +Rollout windows are configured through the `batchChanges.rolloutWindows` [site configuration option](/admin/config/site-config). If specified, this option contains an array of rollout window objects that are used to schedule changesets. The format of these objects [is given below](#rollout-window-object). ### Behavior @@ -225,7 +225,7 @@ At present, only GitHub code hosts (both Cloud and Enterprise) are supported, an to be enabled. Otherwise commits from GitHub apps will be unverified. -GitHub Apps are also the recommended way to [sync repositories on GitHub](/admin/code_hosts/github#using-a-github-app). However, **they are not a replacement for [PATs](/batch-changes/configuring-credentials#personal-access-tokens) in Batch Changes**. It is **also** necessary to create a separate GitHub App for Batch Changes commit signing even if you already have an App connected for the same code host for repository syncing because the Apps require different permissions. The process for creating each type of GitHub App is almost identical. +GitHub Apps are also the recommended way to [sync repositories on GitHub](/admin/code-hosts/github#using-a-github-app). However, **they are not a replacement for [PATs](/batch-changes/configuring-credentials#personal-access-tokens) in Batch Changes**. It is **also** necessary to create a separate GitHub App for Batch Changes commit signing even if you already have an App connected for the same code host for repository syncing because the Apps require different permissions. The process for creating each type of GitHub App is almost identical. To create a GitHub App for commit signing and connect it to Sourcegraph: diff --git a/docs/admin/config/index.mdx b/docs/admin/config/index.mdx index 8aba0448f..3d3720977 100644 --- a/docs/admin/config/index.mdx +++ b/docs/admin/config/index.mdx @@ -4,12 +4,12 @@ Supported on [Enterprise](/pricing/plans/enterprise) plans. -- [Site configuration](/admin/config/site_config) +- [Site configuration](/admin/config/site-config) - [Global and user settings](/admin/config/settings) -- [Code host configuration](/admin/code_hosts/) +- [Code host configuration](/admin/code-hosts/) - [Search configuration](/admin/search) -- [Configuring Authorization and Authentication](/admin/config/authorization_and_authentication) -- [Batch Changes configuration](/admin/config/batch_changes) +- [Configuring Authorization and Authentication](/admin/config/authorization-and-authentication) +- [Batch Changes configuration](/admin/config/batch-changes) ## Common tasks @@ -20,5 +20,5 @@ - [Add organizations](/admin/organizations) - [Add teams](/admin/teams) (Experimental) - [Configuring webhooks](/admin/webhooks/) -- [Configuring rate limits](/admin/code_hosts/rate_limits) +- [Configuring rate limits](/admin/code-hosts/rate-limits) - [Configuring command recording](/admin/repo/recording) diff --git a/docs/admin/config/settings.mdx b/docs/admin/config/settings.mdx index 84cc72c90..b5c29dc18 100644 --- a/docs/admin/config/settings.mdx +++ b/docs/admin/config/settings.mdx @@ -1,6 +1,6 @@ # Settings -Settings provide the ability to customize and control the Sourcegraph UI and user-specific features. They do not configure operational aspects of the instance (which are set in the [site configuration](/admin/config/site_config)). +Settings provide the ability to customize and control the Sourcegraph UI and user-specific features. They do not configure operational aspects of the instance (which are set in the [site configuration](/admin/config/site-config)). Settings can be set at the global level (by site admins), the organization level (by organization members), and at the individual user level. diff --git a/docs/admin/config/site_config.mdx b/docs/admin/config/site-config.mdx similarity index 99% rename from docs/admin/config/site_config.mdx rename to docs/admin/config/site-config.mdx index fc41233ae..2dcde8570 100644 --- a/docs/admin/config/site_config.mdx +++ b/docs/admin/config/site-config.mdx @@ -131,7 +131,7 @@ All site configuration options and their default values are shown below. // Enable or disable Cody instance-wide. When Cody is disabled, all Cody endpoints and GraphQL queries will return errors, Cody will not show up in the site-admin sidebar, and Cody in the global navbar will only show a call-to-action for site-admins to enable Cody. "cody.enabled": false, - // Whether to enable Cody role-based access controls. Only respected if cody.restrictUsersFeatureFlag is not set. See https://sourcegraph.com/docs/admin/access_control + // Whether to enable Cody role-based access controls. Only respected if cody.restrictUsersFeatureFlag is not set. See https://sourcegraph.com/docs/admin/access-control "cody.permissions": true, // DEPRECATED; see cody.permissions instead. PRIOR DESCRIPTION: Cody to only be enabled for users that have a feature flag labeled "cody" set to true. You must create a feature flag with this ID after enabling this setting: https://www.notion.so/sourcegraph/How-to-use-feature-flags-70f42bcacd9045d4a55de22f5dd87df0?source=copy_link. This setting only has an effect if cody.enabled is true. diff --git a/docs/admin/enterprise_getting_started_guide.mdx b/docs/admin/enterprise-getting-started-guide.mdx similarity index 86% rename from docs/admin/enterprise_getting_started_guide.mdx rename to docs/admin/enterprise-getting-started-guide.mdx index 17ef74301..a25a2e4a1 100644 --- a/docs/admin/enterprise_getting_started_guide.mdx +++ b/docs/admin/enterprise-getting-started-guide.mdx @@ -7,9 +7,9 @@ If you're deploying a new Enterprise instance, this page covers our most frequen ### General - [Deployment overview](/self-hosted/deploy/) -- [Resource estimator](/self-hosted/deploy/resource_estimator) +- [Resource estimator](/self-hosted/deploy/resource-estimator) - [SAML config](/admin/auth/saml/) -- [Configuring authorization and authentication](/admin/config/authorization_and_authentication) - We recommend starting here for access and permissions configuration before moving on to the more specific pages on these topics. +- [Configuring authorization and authentication](/admin/config/authorization-and-authentication) - We recommend starting here for access and permissions configuration before moving on to the more specific pages on these topics. - [Built-in password authentication](/admin/auth/#builtin-password-authentication) - [GitHub authentication](/admin/auth/#github) - [GitLab authentication](/admin/auth/#gitlab) @@ -18,7 +18,7 @@ If you're deploying a new Enterprise instance, this page covers our most frequen - [GitLab integration](/integration/gitlab) - [GitHub integration](/integration/github) - [All code host integrations (not GitLab or GitHub)](/integration/#integrations) -- [Full guide to site config options](/admin/config/site_config#auth-sessionExpiry) +- [Full guide to site config options](/admin/config/site-config#auth-sessionExpiry) - [Changelog](https://sourcegraph.com/changelog) to track releases and updates ### Docker-compose @@ -26,11 +26,11 @@ If you're deploying a new Enterprise instance, this page covers our most frequen - [Basic installation guide](/self-hosted/deploy/docker-compose/) - [AWS installation](/self-hosted/deploy/docker-compose/aws) - [Digital Ocean installation](/self-hosted/deploy/docker-compose/digitalocean) -- [Google Cloud installation](/self-hosted/deploy/docker-compose/google_cloud) +- [Google Cloud installation](/self-hosted/deploy/docker-compose/google-cloud) ## User articles - [Search syntax](/code-search/queries) - [Search filters](/code-search/queries#filters-all-searches) - [Example batch changes](/batch-changes/examples) -- [Sourcegraph browser extension](/integration/browser_extension) +- [Sourcegraph browser extension](/integration/browser-extension) diff --git a/docs/admin/executors/executor_secrets.mdx b/docs/admin/executors/executor-secrets.mdx similarity index 100% rename from docs/admin/executors/executor_secrets.mdx rename to docs/admin/executors/executor-secrets.mdx diff --git a/docs/admin/executors/index.mdx b/docs/admin/executors/index.mdx index 9e28084e6..9486ccce4 100644 --- a/docs/admin/executors/index.mdx +++ b/docs/admin/executors/index.mdx @@ -7,12 +7,12 @@ Executors are Sourcegraph's solution for isolating and running workloads in a secure and controllable way. Executors provide a sandbox that can run resource-intensive or untrusted tasks on behalf of the Sourcegraph instance, such as: -- [Automatically indexing a repository for precise code navigation](/code-navigation/auto_indexing) +- [Automatically indexing a repository for precise code navigation](/code-navigation/auto-indexing) - [Running batch changes](/batch-changes/server-side) ## Why use executors? -Running untrusted code is a core requirement of features such as precise code navigation [auto-indexing](/code-navigation/auto_indexing), and [running batch changes server-side](/batch-changes/server-side). +Running untrusted code is a core requirement of features such as precise code navigation [auto-indexing](/code-navigation/auto-indexing), and [running batch changes server-side](/batch-changes/server-side). Auto-indexing jobs, in particular, require the invocation of arbitrary and untrusted code to support the resolution of project dependencies. Invocation of post-install hooks, use of insecure [package management tools](https://github.com/golang/go/issues/29230), and package manager proxy attacks can create opportunities in which an adversary can gain unlimited use of compute or exfiltrate data. The latter outcome is particularly dangerous for on-premise installations of Sourcegraph, which is the chosen option for companies wanting to maintain strict privacy of their code property. diff --git a/docs/admin/faq.mdx b/docs/admin/faq.mdx index 5e77e2eec..826766af3 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/other#experimental-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 @@ -18,7 +18,7 @@ method by modifying the `auth.providers` field in site configuration. However, t administrator may themselves be unable to sign in. If this is the case, then a site administrator can update the configuration if they have direct `docker exec` or `kubectl exec` access to the Sourcegraph instance. Follow the [instructions to update the site config if the web UI is -inaccessible](/admin/config/site_config#editing-your-site-configuration-if-you-cannot-access-the-web-ui). +inaccessible](/admin/config/site-config#editing-your-site-configuration-if-you-cannot-access-the-web-ui). ## Sourcegraph is making unauthorized requests to the git server @@ -27,7 +27,7 @@ makes a request without the password included. If a 401 Unauthorized is returned More information can be found [here](https://confluence.atlassian.com/bitbucketserverkb/two-401-responses-for-every-git-opperation-938854756.html). -If this behaviour is undesired, the `gitURLType` in the [external service configuration](/admin/code_hosts/github#configuration) +If this behaviour is undesired, the `gitURLType` in the [external service configuration](/admin/code-hosts/github#configuration) should be set to `ssh` instead of `http`. This will also require [ssh keys to be set up](/admin/repo/auth#repositories-that-need-http-s-or-ssh-authentication). ## Sourcegraph is not returning results from a repository unless "repo:" is included diff --git a/docs/admin/how-to/enable-experimental-feature.mdx b/docs/admin/how-to/enable-experimental-feature.mdx index b1c13e53f..e08a707e5 100644 --- a/docs/admin/how-to/enable-experimental-feature.mdx +++ b/docs/admin/how-to/enable-experimental-feature.mdx @@ -29,5 +29,5 @@ This document will take you through how to add, enable, or disable an experiment ## Further resources - [Sourcegraph - Configuration Settings](/admin/config/settings) -- [Sourcegraph - Site configuration](/admin/config/site_config) +- [Sourcegraph - Site configuration](/admin/config/site-config) - Learn more about new experimental features on our [Blog](https://about.sourcegraph.com/blog) or Twitter [@sourcegraph](https://twitter.com/sourcegraph/) diff --git a/docs/admin/how-to/index.mdx b/docs/admin/how-to/index.mdx index 4ee32f3a3..40ff7c80e 100644 --- a/docs/admin/how-to/index.mdx +++ b/docs/admin/how-to/index.mdx @@ -6,9 +6,9 @@ - [How to troubleshoot a repository that is not being updated](/admin/how-to/repo-not-updated) - [How to configure submodules](/admin/how-to/submodule-configuration) - [How to remove users or edit users with the GraphQL API](/admin/how-to/mutate-user-api) -- [How to troubleshoot a failure to update repositories when new repositories are added](/admin/how-to/update_repo_failure) +- [How to troubleshoot a failure to update repositories when new repositories are added](/admin/how-to/update-repo-failure) - [How to purge deleted repository data from Sourcegraph](/admin/how-to/remove-repo#manually-purge-deleted-repository-data-from-disk) - [How to address common monorepo problems](/admin/how-to/monorepo-issues) -- [How to import a set of internal repositories to Sourcegraph](/admin/how-to/internal_github_repos) -- [Migrating code intelligence data from LSIF to SCIP (Sourcegraph 4.5 -> 4.6)](/admin/how-to/lsif_scip_migration) +- [How to import a set of internal repositories to Sourcegraph](/admin/how-to/internal-github-repos) +- [Migrating code intelligence data from LSIF to SCIP (Sourcegraph 4.5 -> 4.6)](/admin/how-to/lsif-scip-migration) - [How to export search results](/admin/how-to/export-search-results) diff --git a/docs/admin/how-to/internal_github_repos.mdx b/docs/admin/how-to/internal-github-repos.mdx similarity index 94% rename from docs/admin/how-to/internal_github_repos.mdx rename to docs/admin/how-to/internal-github-repos.mdx index 490febbe2..78ce63ab1 100644 --- a/docs/admin/how-to/internal_github_repos.mdx +++ b/docs/admin/how-to/internal-github-repos.mdx @@ -12,7 +12,7 @@ This document assumes that you have: ## Steps to import internal GitHub repositories -1. Using the [repositoryQuery](/admin/code_hosts/github#repositoryQuery) configuration option, pass the `org` flag to specify the name of the organization the internal repositories belong to and; +1. Using the [repositoryQuery](/admin/code-hosts/github#repositoryQuery) configuration option, pass the `org` flag to specify the name of the organization the internal repositories belong to and; 2. Add `is : internal` to the same line. For example: diff --git a/docs/admin/how-to/lsif_scip_migration.mdx b/docs/admin/how-to/lsif-scip-migration.mdx similarity index 91% rename from docs/admin/how-to/lsif_scip_migration.mdx rename to docs/admin/how-to/lsif-scip-migration.mdx index bb98e6418..8fbcabbeb 100644 --- a/docs/admin/how-to/lsif_scip_migration.mdx +++ b/docs/admin/how-to/lsif-scip-migration.mdx @@ -2,12 +2,12 @@ > WARNING: The migration from LSIF -> SCIP is **destructive and irreversible**. A downgrade from 4.6 to a previous version will result in the inability to access migrated code intelligence data (powering precise code navigation features). -Sourcegraph 4.5 introduced an [out-of-band migration](/self-hosted/how-to/unfinished_migration#checking-progress) that re-encodes LSIF code intelligence data as SCIP in the `codeintel-db`. This migration is required to complete prior to a subsequent upgrade to 4.6, as support for reading LSIF-encoded data has been removed as of this version. +Sourcegraph 4.5 introduced an [out-of-band migration](/self-hosted/how-to/unfinished-migration#checking-progress) that re-encodes LSIF code intelligence data as SCIP in the `codeintel-db`. This migration is required to complete prior to a subsequent upgrade to 4.6, as support for reading LSIF-encoded data has been removed as of this version. As of [src-cli 4.5](https://github.com/sourcegraph/src-cli/releases/tag/4.5.0), LSIF indexes will be converted to SCIP prior to upload. This ensures that only _existing_ data needs to be migrated in the background. Using an older version of src-cli to upload code intelligence to your index may continue to feed additional LSIF data that needs to be subsequently migrated. This will ultimately block the ability to upgrade to the next version as the migration will never reach 100% (and remain there). -Once the migration has completed, Postgres may continue to hold on to disk space that was previously occupied by LSIF data. Future versions of Sourcegraph will drop these tables completely, freeing this space. Heavier users of precise code intelligence may wish to reclaim this disk space earlier. Once the migration is complete, you can [truncate the LSIF data tables](/self-hosted/how-to/clear_codeintel_data#clearing-lsif-data) to immediately reclaim this space. +Once the migration has completed, Postgres may continue to hold on to disk space that was previously occupied by LSIF data. Future versions of Sourcegraph will drop these tables completely, freeing this space. Heavier users of precise code intelligence may wish to reclaim this disk space earlier. Once the migration is complete, you can [truncate the LSIF data tables](/self-hosted/how-to/clear-codeintel-data#clearing-lsif-data) to immediately reclaim this space. --- -If you wish to take the scorched earth route and clear all existing code intelligence data from your instance and start fresh, follow the entire guide on [clearing code intelligence data](/self-hosted/how-to/clear_codeintel_data). +If you wish to take the scorched earth route and clear all existing code intelligence data from your instance and start fresh, follow the entire guide on [clearing code intelligence data](/self-hosted/how-to/clear-codeintel-data). diff --git a/docs/admin/how-to/mutate-user-api.mdx b/docs/admin/how-to/mutate-user-api.mdx index 222b1611e..04a2d5f27 100644 --- a/docs/admin/how-to/mutate-user-api.mdx +++ b/docs/admin/how-to/mutate-user-api.mdx @@ -146,5 +146,5 @@ You can also use the documentation explorer on the right-hand side of the `API c ## Further resources -- [Sourcegraph - User data deletion](/admin/user_data_deletion) +- [Sourcegraph - User data deletion](/admin/user-data-deletion) - [Sourcegraph GraphQL API](/api/graphql) diff --git a/docs/admin/how-to/repo-not-updated.mdx b/docs/admin/how-to/repo-not-updated.mdx index 257b14a57..18fc3d6bd 100644 --- a/docs/admin/how-to/repo-not-updated.mdx +++ b/docs/admin/how-to/repo-not-updated.mdx @@ -11,7 +11,7 @@ This document assumes that you are a [site admin](/admin) and **do not** have `d 1. First of all, you should identify how long has it been since the repo was last updated on Sourcegraph by going to the repository page > Settings > Mirroring 2. From there you can check: 1. Last refreshed: Time when the repo was last synced - 2. Next scheduled update: Estimated time of when the repo will be updated next (this could change as it is determined by a [smart heuristic](/admin/repo/update_frequency#repository-update-frequency)) + 2. Next scheduled update: Estimated time of when the repo will be updated next (this could change as it is determined by a [smart heuristic](/admin/repo/update-frequency#repository-update-frequency)) 3. Queued for update: Its position in queue to be updated next 4. Connection: Connection status to the repository 5. Last sync log: Output from the most recent sync event @@ -19,7 +19,7 @@ This document assumes that you are a [site admin](/admin) and **do not** have `d 4. If clicking on the `Refresh Now` button does not work for you, try using webhooks following the instructions detailed in our [Repository Webhooks Docs](/admin/repo/webhooks#webhook-for-manually-telling-sourcegraph-to-update-a-repository) 5. Look for errors related to this repository in gitserver logs, which should help you to determine the next best course of action. 6. Check the size of the repository. If it's a large repository, it may take a long time to sync and update. To find the size of your .git directory where the repository resides, you may use our [`git-stats` script](/admin/monorepo#statistics). -7. Check the allocated resources to see if the instance has enough resources to process the repository sync using our [Resource Estimator](/self-hosted/deploy/resource_estimator) +7. Check the allocated resources to see if the instance has enough resources to process the repository sync using our [Resource Estimator](/self-hosted/deploy/resource-estimator) 8. Check the code host connection from your Sourcegraph instance. If there is any issue, it needs to be resolved for the repository to sync and update. ## FAQs: diff --git a/docs/admin/how-to/site-admin-quickstart.mdx b/docs/admin/how-to/site-admin-quickstart.mdx index cc6ac6423..eb774f371 100644 --- a/docs/admin/how-to/site-admin-quickstart.mdx +++ b/docs/admin/how-to/site-admin-quickstart.mdx @@ -12,7 +12,7 @@ We recommend Docker Compose for most initial production deployments. You can [mi If you need a deployment option that offers a higher level of scalability and availability, the [Kubernetes deployment](/self-hosted/deploy/kubernetes/) is recommended. -To help give you a starting point on choosing a deployment option and allocating resources to it, check out our [resource estimator](/self-hosted/deploy/resource_estimator). +To help give you a starting point on choosing a deployment option and allocating resources to it, check out our [resource estimator](/self-hosted/deploy/resource-estimator). For a comphrensive deployment guide for each option, check out our in-depth documentation for both [Docker Compose](/self-hosted/deploy/docker-compose/) and [Kubernetes](/self-hosted/deploy/kubernetes/). @@ -50,7 +50,7 @@ If you need to add additional site admins, you can do so on the `/site-admin/use Sourcegraph supports connections to and repository syncing from any Git code host. Once connected, Sourcegraph will clone and index your repos so that users can search and navigate across them. To get started, go to **User menu > Site Admin > Manage code hosts > Add code host**. -Please reference the code host [documentation](/admin/code_hosts/) for detailed instructions on connecting to your code host. +Please reference the code host [documentation](/admin/code-hosts/) for detailed instructions on connecting to your code host. ### Setting up user authentication and repository permissions @@ -72,7 +72,7 @@ For more info, check out our complete [repository permissions documentation.](/a By default, Sourcegraph bundles the services it needs to operate into installations. These services include PostgreSQL, Redis, and blobstore. -Your Sourcegraph instance can also be configured to use existing external services if you wish. For more information on configuring Sourcegraph to use your external services, please reference this [documentation.](/self-hosted/external_services/) +Your Sourcegraph instance can also be configured to use existing external services if you wish. For more information on configuring Sourcegraph to use your external services, please reference this [documentation.](/self-hosted/external-services/) ## Observability diff --git a/docs/admin/how-to/unknown-error-login.mdx b/docs/admin/how-to/unknown-error-login.mdx index 7cdbedbc0..95bd5d9c5 100644 --- a/docs/admin/how-to/unknown-error-login.mdx +++ b/docs/admin/how-to/unknown-error-login.mdx @@ -31,4 +31,4 @@ This document will attempt to identify a common reason for an `Unknown Error` wh ## Further resources -- [Sourcegraph - Site configuration](/admin/config/site_config) +- [Sourcegraph - Site configuration](/admin/config/site-config) diff --git a/docs/admin/how-to/update_repo_failure.mdx b/docs/admin/how-to/update-repo-failure.mdx similarity index 100% rename from docs/admin/how-to/update_repo_failure.mdx rename to docs/admin/how-to/update-repo-failure.mdx diff --git a/docs/admin/index.mdx b/docs/admin/index.mdx index f0159d9bb..e2d3fe247 100644 --- a/docs/admin/index.mdx +++ b/docs/admin/index.mdx @@ -9,15 +9,15 @@ Sourcegraph administration is primarily managed by site administrators, who are ## Features - [Batch Changes](/batch-changes/) -- [Beta and experimental features](/admin/beta_and_experimental_features) +- [Beta and experimental features](/admin/beta-and-experimental-features) - [Code navigation](/code-navigation/) - [Pings](/admin/pings) - [Telemetry](/admin/telemetry) - [Enterprise pricing and licenses](/admin/subscriptions/) - [Search](/admin/search) -- [User feedback surveys](/admin/user_surveys) +- [User feedback surveys](/admin/user-surveys) - [Analytics](/analytics) -- [Audit logs](/admin/audit_log) +- [Audit logs](/admin/audit-log) ## [Configure Sourcegraph](/admin/config/) @@ -27,9 +27,9 @@ Sourcegraph administration is primarily managed by site administrators, who are - [Monorepo](/admin/monorepo) - [Repository webhooks](/admin/repo/webhooks) - [User authentication](/admin/auth/) - - [User data deletion](/admin/user_data_deletion) + - [User data deletion](/admin/user-data-deletion) - [Provision users through SCIM](/admin/scim) (Beta) -- [Access control](/admin/access_control/) (Beta) +- [Access control](/admin/access-control/) (Beta) - [Repository permissions](/admin/permissions/) - [Batch Changes](/batch-changes/site-admin-configuration) - [Configure webhooks](/admin/webhooks/) diff --git a/docs/admin/licensing.mdx b/docs/admin/licensing.mdx index 6512845b5..cd045671c 100644 --- a/docs/admin/licensing.mdx +++ b/docs/admin/licensing.mdx @@ -17,7 +17,7 @@ Sourcegraph will continue to function as normal, but all users will be signed ou ### How can we update our license key? -Any current Site Admin can update your license key by going to Site Admin -> [Site configuration](/admin/config/site_config) +Any current Site Admin can update your license key by going to Site Admin -> [Site configuration](/admin/config/site-config) These settings live in the JSON object, and you will need to navigate to the _licenseKey_ section of that object. diff --git a/docs/admin/migration/opengrok.mdx b/docs/admin/migration/opengrok.mdx index e8fe7894f..4513ba9b7 100644 --- a/docs/admin/migration/opengrok.mdx +++ b/docs/admin/migration/opengrok.mdx @@ -63,7 +63,7 @@ Sourcegraph's "active" model lets it: - synchronize the list of repositories on the code host (so that newly added repositories are searchable/browseable) - offer code host integrations and "View file on code host" links -Sourcegraph also partially supports the "passive" model like OpenGrok, but it's not recommended because you lose these benefits. To use it anyway, see "[Add repositories already cloned to disk](/admin/repo/pre_load_from_local_disk)". +Sourcegraph also partially supports the "passive" model like OpenGrok, but it's not recommended because you lose these benefits. To use it anyway, see "[Add repositories already cloned to disk](/admin/repo/pre-load-from-local-disk)". To configure which repositories Sourcegraph will make available for searching and browsing: @@ -79,7 +79,7 @@ Like Oracle OpenGrok, Sourcegraph is self-hosted. You control who can access it. - [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) -- [TLS/SSL and other HTTP/HTTPS configuration](/self-hosted/http_https_configuration) +- [TLS/SSL and other HTTP/HTTPS configuration](/self-hosted/http-https-configuration) ### Rolling out Sourcegraph organization-wide @@ -97,8 +97,8 @@ After you've set Sourcegraph up, it's time to share it with your organization. S > [Include screenshots of your Sourcegraph instance here] - Create an internal document based on the [Sourcegraph tour](/getting-started/tour), substituting links to and names of your organization's code. This explains how Sourcegraph helps developers perform common tasks better. -- Encourage installation of the [browser extension](/integration/browser_extension) to get Sourcegraph code navigation and search in your organization's existing code host. -- Roll out the Chrome extension using [Google Workspace automatic installation](/integration/browser_extension/how-tos/google_workspace) to everyone in your organization. +- Encourage installation of the [browser extension](/integration/browser-extension) to get Sourcegraph code navigation and search in your organization's existing code host. +- Roll out the Chrome extension using [Google Workspace automatic installation](/integration/browser-extension/how-tos/google-workspace) to everyone in your organization. - Check the access logs for OpenGrok to see what users search for. Try searching for the same things on Sourcegraph, and ensure that you get the expected results. (Note: Sourcegraph's [search query syntax](/code-search/queries) differs from OpenGrok's.) - Monitor your Sourcegraph instance's site admin "Analytics" page to see who's using it. Ask them for specific feedback. Also seek feedback from the most frequent users of OpenGrok. diff --git a/docs/admin/oauth_apps.mdx b/docs/admin/oauth-apps.mdx similarity index 98% rename from docs/admin/oauth_apps.mdx rename to docs/admin/oauth-apps.mdx index 55aee4739..22c700090 100644 --- a/docs/admin/oauth_apps.mdx +++ b/docs/admin/oauth-apps.mdx @@ -11,7 +11,7 @@ This makes OAuth the preferred choice for any multi-user integration like browse OAuth Apps are in compliance with standards including [RFC 6749](https://tools.ietf.org/html/rfc6749), [RFC 7636 (PKCE)](https://tools.ietf.org/html/rfc7636), and [RFC 8628 (Device Authorization Grant)](https://tools.ietf.org/html/rfc8628). -Consider using **M2M (client-credentials) service-account tokens** or traditional [access tokens](/cli/how-tos/creating_an_access_token) for server-to-server communication, automated scripts, CI/CD pipelines, or single-user applications that do not require per-user permission checks. See [service accounts](/admin/service_accounts#m2m-oauth-credentials-client-credentials-flow) for details. +Consider using **M2M (client-credentials) service-account tokens** or traditional [access tokens](/cli/how-tos/creating-an-access-token) for server-to-server communication, automated scripts, CI/CD pipelines, or single-user applications that do not require per-user permission checks. See [service accounts](/admin/service-accounts#m2m-oauth-credentials-client-credentials-flow) for details. ## Creating an OAuth App diff --git a/docs/admin/organizations.mdx b/docs/admin/organizations.mdx index bf4c016ae..e28be0699 100644 --- a/docs/admin/organizations.mdx +++ b/docs/admin/organizations.mdx @@ -6,7 +6,7 @@ To create an organization, go to `http(s)://[hostname]/organizations/new` on you You (and any other organization members, and any site admin) may add or remove members from the organization's members page at `http(s)://[hostname]/organizations/[org-name]/members`. -To automatically join all users on your instance to a specific organization, create the organization first and then set the `auth.userOrgMap` [site configuration](/admin/config/site_config) option: +To automatically join all users on your instance to a specific organization, create the organization first and then set the `auth.userOrgMap` [site configuration](/admin/config/site-config) option: ```json { diff --git a/docs/admin/outbound-request-log.mdx b/docs/admin/outbound-request-log.mdx index 314f43693..5e3340ce5 100644 --- a/docs/admin/outbound-request-log.mdx +++ b/docs/admin/outbound-request-log.mdx @@ -10,7 +10,7 @@ This document assumes you are a [site admin](/admin/). ## Enabling the logs -This feature is off by default. You can enable it by setting `outboundRequestLogLimit` to a non-zero value in the [site config](/admin/config/site_config#outboundRequestLogLimit). The recommended value is `50`. +This feature is off by default. You can enable it by setting `outboundRequestLogLimit` to a non-zero value in the [site config](/admin/config/site-config#outboundRequestLogLimit). The recommended value is `50`. You can later disable it by setting `outboundRequestLogLimit` to `0`, or by removing the setting entirely. @@ -40,10 +40,10 @@ To recreate a request for debugging, you can copy the cURL command for any reque Keep in mind that some headers might be redacted (you'll see the word "REDACTED" in their place), in which case you'll need to add the missing pieces manually. -Note: You can set the `redactOutboundRequestHeaders` [site config](/admin/config/site_config#redactOutboundRequestHeaders) option to `false` to disable the redaction of headers and make the "Copy curl" function more convenient. But for security reasons, this setting is only respected in development environments. +Note: You can set the `redactOutboundRequestHeaders` [site config](/admin/config/site-config#redactOutboundRequestHeaders) option to `false` to disable the redaction of headers and make the "Copy curl" function more convenient. But for security reasons, this setting is only respected in development environments. ## Troubleshooting ### Page failing to load, or loading slowly -If the Outbound Request Log page is failing to load, or loading slowly, you may need to allocate more resources to Redis. To confirm, please check the charts for Redis under the `provisioning indicators` dropdown in grafana. If these charts show that your CPU usage is consistently over the threshold, allocate more resources to Redis. You can use our [resource estimator](/self-hosted/deploy/resource_estimator) as a guide. +If the Outbound Request Log page is failing to load, or loading slowly, you may need to allocate more resources to Redis. To confirm, please check the charts for Redis under the `provisioning indicators` dropdown in grafana. If these charts show that your CPU usage is consistently over the threshold, allocate more resources to Redis. You can use our [resource estimator](/self-hosted/deploy/resource-estimator) as a guide. diff --git a/docs/admin/permissions/api.mdx b/docs/admin/permissions/api.mdx index 03bff0b0c..45287d839 100644 --- a/docs/admin/permissions/api.mdx +++ b/docs/admin/permissions/api.mdx @@ -28,7 +28,7 @@ Keeping the permissions in sync and fresh is the responsibility of the site admi ## Configuration -To enable the permissions API, add the following to the [site configuration](/admin/config/site_config): +To enable the permissions API, add the following to the [site configuration](/admin/config/site-config): ```json "permissions.userMapping": { @@ -100,7 +100,7 @@ You can call `setRepositoryPermissionsForUsers` repeatedly to set permissions fo Sourcegraph supports permissions on a per-file/directory basis. -To enable the sub-repo permissions API, add the following to the [site configuration](/admin/config/site_config): +To enable the sub-repo permissions API, add the following to the [site configuration](/admin/config/site-config): ```json "experimentalFeatures": { diff --git a/docs/admin/permissions/index.mdx b/docs/admin/permissions/index.mdx index 2b262b1d8..409533924 100644 --- a/docs/admin/permissions/index.mdx +++ b/docs/admin/permissions/index.mdx @@ -5,7 +5,7 @@ Available via the Web app. -> NOTE: This page refers to repository access permissions synced between Sourcegraph and your code host, which has also historically been referred to as "authorization", "repository permissions", and "code host permissions". This is _not_ the same as [in-product permissions](/admin/access_control/), which determine who can, for example, create a batch change or who is a site admin. +> NOTE: This page refers to repository access permissions synced between Sourcegraph and your code host, which has also historically been referred to as "authorization", "repository permissions", and "code host permissions". This is _not_ the same as [in-product permissions](/admin/access-control/), which determine who can, for example, create a batch change or who is a site admin. Sourcegraph can be configured to enforce the same access to repositories and underlying source files as your code host. If configured, Sourcegraph will allow the user to only @@ -26,7 +26,7 @@ Same for `bob`, the search results or any other feature will not show him the ex ## Getting started -To set up permissions by [syncing them from a code host](/admin/permissions/syncing) you need two things: [an authentication provider](/admin/auth/) that can tell which users should see which repositories and [a code host connection](/admin/code_hosts/) with authorization enabled. +To set up permissions by [syncing them from a code host](/admin/permissions/syncing) you need two things: [an authentication provider](/admin/auth/) that can tell which users should see which repositories and [a code host connection](/admin/code-hosts/) with authorization enabled. 1. Configure an authentication provider for the code host from which you want to sync permissions: - [GitHub](/admin/auth/#github) @@ -34,17 +34,17 @@ To set up permissions by [syncing them from a code host](/admin/permissions/sync - [Bitbucket Cloud](/admin/auth/#bitbucket-cloud) - [Bitbucket Server](/admin/auth/#bitbucket-server) - [Gerrit](/admin/auth/#gerrit) - - Bitbucket Server doesn't require an authentication provider, but has [other prerequisites](/admin/code_hosts/bitbucket_server#prerequisites) + - Bitbucket Server doesn't require an authentication provider, but has [other prerequisites](/admin/code-hosts/bitbucket-server#prerequisites) - Perforce doesn't need a separate authentication provider - - [Azure DevOps](/admin/code_hosts/azuredevops) + - [Azure DevOps](/admin/code-hosts/azuredevops) 2. Configure the code host connection to use authorization: - - [GitHub](/admin/code_hosts/github#repository-permissions) - - [GitLab](/admin/code_hosts/gitlab#repository-permissions) - - [Bitbucket Cloud](/admin/code_hosts/bitbucket_cloud#repository-permissions) - - [Bitbucket Server](/admin/code_hosts/bitbucket_server#repository-permissions) - - [Gerrit](/admin/code_hosts/gerrit#add-gerrit-as-an-authentication-provider) + - [GitHub](/admin/code-hosts/github#repository-permissions) + - [GitLab](/admin/code-hosts/gitlab#repository-permissions) + - [Bitbucket Cloud](/admin/code-hosts/bitbucket-cloud#repository-permissions) + - [Bitbucket Server](/admin/code-hosts/bitbucket-server#repository-permissions) + - [Gerrit](/admin/code-hosts/gerrit#add-gerrit-as-an-authentication-provider) - [Perforce](/admin/repo/perforce#repository-permissions) - - [Azure DevOps](/admin/code_hosts/azuredevops#permissions-syncing) + - [Azure DevOps](/admin/code-hosts/azuredevops#permissions-syncing) It's also possible to use other methods to get permission data from a code host into the Sourcegraph instance. @@ -136,7 +136,7 @@ of `alice` are the following union set: [`horsegraph/global`, `horsegraph/hay-v1 1. Go to **Site Admin > Migrations** page. There is a migration called `Migrate data from user_permissions table to unified user_repo_permissions.`. Make sure that it finished migrating all the data (it reports as 100%). Contact support if the migration does not seem to complete for a long time (multiple days). -1. (Not required for Sourcegraph 5.1+) Enable the experimental feature in the [site configuration](/admin/config/site_config): +1. (Not required for Sourcegraph 5.1+) Enable the experimental feature in the [site configuration](/admin/config/site-config): ```json { diff --git a/docs/admin/permissions/webhooks.mdx b/docs/admin/permissions/webhooks.mdx index 88f41e39a..ff5c7c719 100644 --- a/docs/admin/permissions/webhooks.mdx +++ b/docs/admin/permissions/webhooks.mdx @@ -2,7 +2,7 @@ Sourcegraph allows customers to use webhooks to react to events that modify user permissions on the code host. Currently the only supported code host for webhooks -is [Github](/admin/code_hosts/github). +is [Github](/admin/code-hosts/github). > NOTE: Using webhooks is the _recommended_ way to get code host permissions to Sourcegraph. It's important to also note that when you have webhooks configured, it override Sourcegraph's default heuristics for fetching repository permissions. This is because webhooks and explicit configurations are intended to enforce specific permissions from external services, while the default heuristics act as a fallback when no explicit permissions are provided. diff --git a/docs/admin/pings.mdx b/docs/admin/pings.mdx index 31834ab63..4b9cdba33 100644 --- a/docs/admin/pings.mdx +++ b/docs/admin/pings.mdx @@ -256,7 +256,7 @@ Sourcegraph telemetry pings are handled by a goroutine running on Sourcegraphs f ### Misconfigured update.channel -The most common scenario in which Sourcegraph stops sending pings is a change to the `update.channel` setting in an instance's [site config](https://sourcegraph.com/docs/admin/config/site_config) +The most common scenario in which Sourcegraph stops sending pings is a change to the `update.channel` setting in an instance's [site config](https://sourcegraph.com/docs/admin/config/site-config) ``` "update.channel": "release", diff --git a/docs/admin/repo/add.mdx b/docs/admin/repo/add.mdx index 0f1d8aa93..be7c5cb5d 100644 --- a/docs/admin/repo/add.mdx +++ b/docs/admin/repo/add.mdx @@ -1,16 +1,16 @@ # Add repositories (from code hosts) to Sourcegraph -- [Add repositories from a code host](/admin/code_hosts/) (GitHub (Cloud or Self-hosted), GitLab (Cloud or Self-hosted), Bitbucket Server, Bitbucket Data Center, or Perforce) +- [Add repositories from a code host](/admin/code-hosts/) (GitHub (Cloud or Self-hosted), GitLab (Cloud or Self-hosted), Bitbucket Server, Bitbucket Data Center, or Perforce) - - [GitHub](/admin/code_hosts/github) - - [GitLab](/admin/code_hosts/gitlab) - - [Bitbucket Cloud](/admin/code_hosts/bitbucket_cloud) - - [Bitbucket Server / Bitbucket Data Center](/admin/code_hosts/bitbucket_server) or Bitbucket Data Center + - [GitHub](/admin/code-hosts/github) + - [GitLab](/admin/code-hosts/gitlab) + - [Bitbucket Cloud](/admin/code-hosts/bitbucket-cloud) + - [Bitbucket Server / Bitbucket Data Center](/admin/code-hosts/bitbucket-server) or Bitbucket Data Center -- [Add repositories by Git clone URLs](/admin/code_hosts/other) -- [Add repositories from non-Git code hosts](/admin/code_hosts/non-git) +- [Add repositories by Git clone URLs](/admin/code-hosts/other) +- [Add repositories from non-Git code hosts](/admin/code-hosts/non-git) - [Add Perforce repositories](/admin/repo/perforce) -- [Pre-load repositories from the local disk](/admin/repo/pre_load_from_local_disk) +- [Pre-load repositories from the local disk](/admin/repo/pre-load-from-local-disk) ## Troubleshooting diff --git a/docs/admin/repo/auth.mdx b/docs/admin/repo/auth.mdx index cb9a19260..10da2cb75 100644 --- a/docs/admin/repo/auth.mdx +++ b/docs/admin/repo/auth.mdx @@ -27,7 +27,7 @@ In supported code hosts configuration, you can provide the credentials in the JS } ``` -Some providers may require additional configuration, consult the [code host specific documentation](/admin/code_hosts/) for more information. +Some providers may require additional configuration, consult the [code host specific documentation](/admin/code-hosts/) for more information. ## Mounting SSH keys into the container @@ -55,7 +55,7 @@ StrictHostKeyChecking no AddKeysToAgent yes ``` -See [git configuration](/admin/repo/git_config) for more details. +See [git configuration](/admin/repo/git-config) for more details. ### Error: `sign_and_send_pubkey: no mutual signature supported` @@ -63,7 +63,7 @@ In Sourcegraph 5.1.0 and later, the insecure SSH rsa-sha1 signature algorithm is If you use an RSA SSH key to authenticate to your code host, you should ensure that your code host runs OpenSSL 7.2 or newer. -If it is not possible to update the code host, you should generate a new ed25519 SSH key to use for authentication. This can be achieved by running `ssh-keygen -t ed25519`, and [configuring Sourcegraph](https://sourcegraph.com/docs/admin/repo/git_config) to use this new key. +If it is not possible to update the code host, you should generate a new ed25519 SSH key to use for authentication. This can be achieved by running `ssh-keygen -t ed25519`, and [configuring Sourcegraph](https://sourcegraph.com/docs/admin/repo/git-config) to use this new key. ### Error: `Host key verification failed` diff --git a/docs/admin/repo/git_config.mdx b/docs/admin/repo/git-config.mdx similarity index 100% rename from docs/admin/repo/git_config.mdx rename to docs/admin/repo/git-config.mdx diff --git a/docs/admin/repo/index.mdx b/docs/admin/repo/index.mdx index aa384aec2..c65072f1a 100644 --- a/docs/admin/repo/index.mdx +++ b/docs/admin/repo/index.mdx @@ -1,11 +1,11 @@ # Repositories - [Adding Git repositories](/admin/repo/add) -- [Repository update frequency](/admin/repo/update_frequency) +- [Repository update frequency](/admin/repo/update-frequency) - [Repository webhooks](/admin/repo/webhooks) - [Repository authentication](/admin/repo/auth) -- [Custom git config](/admin/repo/git_config) -- [Adding non-Git repositories](/admin/code_hosts/non-git) +- [Custom git config](/admin/repo/git-config) +- [Adding non-Git repositories](/admin/code-hosts/non-git) - [Adding Perforce repositories](/admin/repo/perforce) - [Configure repository permissions](/admin/repo/permissions) - [Configure repository metadata](/admin/repo/metadata) diff --git a/docs/admin/repo/metadata.mdx b/docs/admin/repo/metadata.mdx index d9ccef195..bbdf170df 100644 --- a/docs/admin/repo/metadata.mdx +++ b/docs/admin/repo/metadata.mdx @@ -22,7 +22,7 @@ Another way this could be used is to associate repos with a maintenance status. There are three ways to add metadata to a repository: via web UI, Sourcegraph's GraphQL API, and the [`src-cli` command line tool](https://github.com/sourcegraph/src-cli). -**NOTE:** That user needs to have `Repository metadata / Write` [RBAC permission](/admin/access_control/) to be able to edit repo metadata. +**NOTE:** That user needs to have `Repository metadata / Write` [RBAC permission](/admin/access-control/) to be able to edit repo metadata. ### Limitations diff --git a/docs/admin/repo/perforce.mdx b/docs/admin/repo/perforce.mdx index 8fe344afb..f6e729985 100644 --- a/docs/admin/repo/perforce.mdx +++ b/docs/admin/repo/perforce.mdx @@ -6,7 +6,7 @@ Sourcegraph supports [Perforce Helix](https://www.perforce.com/solutions/version ## Add a Perforce code host connection -Perforce depots can be added to a Sourcegraph instance by adding the appropriate [code host connection](/admin/code_hosts/). +Perforce depots can be added to a Sourcegraph instance by adding the appropriate [code host connection](/admin/code-hosts/). To enable Perforce code host connections, a site admin must: @@ -178,7 +178,7 @@ To ensure Sourcegraph handles host rules according to your requirements, you hav ##### Enforcing host rules -If you want Sourcegraph to enforce host-specific permissions, you need to enable IP restriction enforcement in your [site configuration](https://sourcegraph.com/docs/admin/config/site_config): +If you want Sourcegraph to enforce host-specific permissions, you need to enable IP restriction enforcement in your [site configuration](https://sourcegraph.com/docs/admin/config/site-config): ```json { @@ -300,13 +300,13 @@ We are actively working to significantly improve Sourcegraph's Perforce support. ## Configure experimental features -As of Sourcegraph 5.1, there are the following experimental features for Perforce depots. These are merely for providing feedback and have [limited support](/admin/beta_and_experimental_features#experimental-features). +As of Sourcegraph 5.1, there are the following experimental features for Perforce depots. These are merely for providing feedback and have [limited support](/admin/beta-and-experimental-features#experimental-features). ### Changelist ID in URLs Note: When enabling changelist IDs in URLs for the first time, Perforce depots can be unavailable for a few minutes on the Sourcegraph instance, due to the initial mapping of changelist IDs to generated commit ID happening in the background. If you have a large number of Perforce depots, we recommend proceeding with the following steps in a maintenance window in which you don't expect large amounts of traffic on your Sourcegraph instance. -Add `"perforceChangelistMapping": "enabled",` to `experimentalFeatures` in the [site configuration](/admin/config/site_config): +Add `"perforceChangelistMapping": "enabled",` to `experimentalFeatures` in the [site configuration](/admin/config/site-config): ```json { @@ -350,7 +350,7 @@ Additionally, while removing a depot from a code host config will mark it as "de ### Batch Changes support for Perforce depots -Add `"batchChanges.enablePerforce": true` to `experimentalFeatures` in the [site configuration](/admin/config/site_config): +Add `"batchChanges.enablePerforce": true` to `experimentalFeatures` in the [site configuration](/admin/config/site-config): ```json { diff --git a/docs/admin/repo/plasticscm.mdx b/docs/admin/repo/plasticscm.mdx index b03f2f324..7bbdb18ec 100644 --- a/docs/admin/repo/plasticscm.mdx +++ b/docs/admin/repo/plasticscm.mdx @@ -1,3 +1,3 @@ # Using Sourcegraph with Plastic SCM -Plastic SCM servers expose a Git API, called [GitServer](https://www.plasticscm.com/gitserver), which can be indexed by Sourcegraph using the [generic Git host indexer](/admin/code_hosts/other). +Plastic SCM servers expose a Git API, called [GitServer](https://www.plasticscm.com/gitserver), which can be indexed by Sourcegraph using the [generic Git host indexer](/admin/code-hosts/other). diff --git a/docs/admin/repo/pre_load_from_local_disk.mdx b/docs/admin/repo/pre-load-from-local-disk.mdx similarity index 94% rename from docs/admin/repo/pre_load_from_local_disk.mdx rename to docs/admin/repo/pre-load-from-local-disk.mdx index c7a4d4656..9799e6f8f 100644 --- a/docs/admin/repo/pre_load_from_local_disk.mdx +++ b/docs/admin/repo/pre-load-from-local-disk.mdx @@ -2,7 +2,7 @@ > NOTE: This page describes how to use a local copy of a repository to speed up the initial clone that Sourcegraph must do. This does not replace [adding a code host connection](/admin/repo/add). You still must add the code host connection in order for Sourcegraph to recognize that this repository exists and to view it. > -> Sourcegraph's [`src-expose` tool](/admin/code_hosts/non-git) can be used to serve local repositories without a dedicated code host. +> Sourcegraph's [`src-expose` tool](/admin/code-hosts/non-git) can be used to serve local repositories without a dedicated code host. You can use repositories that are already cloned to disk on the host machine to speed up Sourcegraph's cloning. This is useful for very large repositories on which cloning exceeds the resources available to the Docker container. This is not intended for individual users who want to set up a personal Sourcegraph instance just for searching code on their own local disk; we recommend either using a CLI tool such as ripgrep instead, or simply connecting Sourcegraph to your code host with a limited set of repositories. @@ -15,7 +15,7 @@ The steps documented here are intended for [single-container Sourcegraph instanc If you're using the default `--volume $HOME/.sourcegraph/data:/var/opt/sourcegraph` argument to run the `sourcegraph/server` Docker image, and the repository you want to add is named `github.com/my/repo`, then follow these steps: -1. Ensure that the added repository is included in [a code host configuration on Sourcegraph](/admin/code_hosts/). +1. Ensure that the added repository is included in [a code host configuration on Sourcegraph](/admin/code-hosts/). 2. Stop Sourcegraph if it is running. This is to ensure it doesn't interfere with the clone. @@ -33,4 +33,4 @@ If you're using the default `--volume $HOME/.sourcegraph/data:/var/opt/sourcegra git clone --mirror --reference PATH-TO-YOUR-EXISTING-LOCAL-CLONE --dissociate YOUR-REPOSITORY-CLONE-URL $HOME/.sourcegraph/repos/github.com/my/repo/.git ``` -If this repository exists on a code host that Sourcegraph integrates with, then use that code host's configuration (as described in the [code host documentation](/admin/code_hosts/)). After updating the code host configuration, if you used the correct repository path, Sourcegraph will detect and reuse the existing clone. (For example, if you're working with a repository on GitHub.com, ensure that the repository path name you used is of the form `github.com/my/repo`.) +If this repository exists on a code host that Sourcegraph integrates with, then use that code host's configuration (as described in the [code host documentation](/admin/code-hosts/)). After updating the code host configuration, if you used the correct repository path, Sourcegraph will detect and reuse the existing clone. (For example, if you're working with a repository on GitHub.com, ensure that the repository path name you used is of the form `github.com/my/repo`.) diff --git a/docs/admin/repo/recording.mdx b/docs/admin/repo/recording.mdx index 68171ecae..53d28771d 100644 --- a/docs/admin/repo/recording.mdx +++ b/docs/admin/repo/recording.mdx @@ -19,7 +19,7 @@ This provides visibility into git operations performed by Sourcegraph on a repos To enable command recording: -- Go to [**Site Admin > Site Configuration**](/admin/config/site_config) +- Go to [**Site Admin > Site Configuration**](/admin/config/site-config) - Add a `gitRecorder` object to the configuration object ```json diff --git a/docs/admin/repo/update_frequency.mdx b/docs/admin/repo/update-frequency.mdx similarity index 90% rename from docs/admin/repo/update_frequency.mdx rename to docs/admin/repo/update-frequency.mdx index 127985e9e..e839f8af3 100644 --- a/docs/admin/repo/update_frequency.mdx +++ b/docs/admin/repo/update-frequency.mdx @@ -14,16 +14,16 @@ If you wish to control how frequently repositories are discovered or how frequen ### Limiting the number of Code host API requests -- Code host configuration: see [Rate limits](/admin/code_hosts/rate_limits) +- Code host configuration: see [Rate limits](/admin/code-hosts/rate-limits) -- Site configuration: [repoListUpdateInterval](/admin/config/site_config#repoListUpdateInterval) controls how frequently we check the code host _for new repositories_ in minutes. +- Site configuration: [repoListUpdateInterval](/admin/config/site-config#repoListUpdateInterval) controls how frequently we check the code host _for new repositories_ in minutes. > NOTE: Internal rate limiting is currently only enforced for HTTP requests to code hosts. That means it's used when, for example, syncing changesets in [batch changes](/batch-changes/), repository permissions and repository metadata from code hosts. ### Limiting the number of Code host Git requests -- [gitMaxCodehostRequestsPerSecond](/admin/config/site_config#gitMaxCodehostRequestsPerSecond) controls how many code host git operations can be run against a code host per second, per gitserver. -- [gitMaxConcurrentClones](/admin/config/site_config#gitMaxConcurrentClones) controls the maximum number of _concurrent_ cloning/pulling operations per gitserver that Sourcegraph will perform. +- [gitMaxCodehostRequestsPerSecond](/admin/config/site-config#gitMaxCodehostRequestsPerSecond) controls how many code host git operations can be run against a code host per second, per gitserver. +- [gitMaxConcurrentClones](/admin/config/site-config#gitMaxConcurrentClones) controls the maximum number of _concurrent_ cloning/pulling operations per gitserver that Sourcegraph will perform. You may also choose to disable automatic Git updates entirely and instead [configure repository webhooks](/admin/repo/webhooks). diff --git a/docs/admin/repo/webhooks.mdx b/docs/admin/repo/webhooks.mdx index 7238e0efb..19ad2111b 100644 --- a/docs/admin/repo/webhooks.mdx +++ b/docs/admin/repo/webhooks.mdx @@ -16,9 +16,9 @@ curl -XPOST -H 'Authorization: token $ACCESS_TOKEN' $SOURCEGRAPH_ORIGIN/.api/rep ## Disabling built-in repo updating -Sourcegraph will periodically ask your code-host to list its repositories (e.g. via its HTTP API) to _discover repositories_. You can control how often this occurs by changing [`repoListUpdateInterval`](/admin/config/site_config) in the site config. +Sourcegraph will periodically ask your code-host to list its repositories (e.g. via its HTTP API) to _discover repositories_. You can control how often this occurs by changing [`repoListUpdateInterval`](/admin/config/site-config) in the site config. -For repositories that Sourcegraph is already aware of, it will periodically perform background Git repository updates. You can disable this if you wish by setting [`disableAutoGitUpdates`](/admin/config/site_config) to `true`. In which case, the repository will only update when the webhook is used or, e.g., if a user visits the repository directly. This may be desirable in cases where you wish to rely solely on the repository update webhook, for example. +For repositories that Sourcegraph is already aware of, it will periodically perform background Git repository updates. You can disable this if you wish by setting [`disableAutoGitUpdates`](/admin/config/site-config) to `true`. In which case, the repository will only update when the webhook is used or, e.g., if a user visits the repository directly. This may be desirable in cases where you wish to rely solely on the repository update webhook, for example. ## Code host webhooks diff --git a/docs/admin/scim.mdx b/docs/admin/scim.mdx index b21b6b309..f8d797132 100644 --- a/docs/admin/scim.mdx +++ b/docs/admin/scim.mdx @@ -50,7 +50,7 @@ To configure: (This command generates a random base64 string with more characters than required (342 characters) and then filters out non-alphanumeric characters. Finally, it trims the output to 255 characters. The reason we generate a longer string is to account for the fact that the base64 encoding has non-alphanumeric characters, which are removed by the tr command.) -2. Add the following line to your [site configuration](/admin/config/site_config): +2. Add the following line to your [site configuration](/admin/config/site-config): ``` "scim.authToken": "{your token}" diff --git a/docs/admin/search.mdx b/docs/admin/search.mdx index bf7e8ba12..ce33b3320 100644 --- a/docs/admin/search.mdx +++ b/docs/admin/search.mdx @@ -6,7 +6,7 @@ See "[Code search overview](/code-search/)" for general information about Source ### Maximum file size -By default, files larger than 1 MB are excluded from search results. Use the [search.largeFiles](/admin/config/site_config#search-largeFiles) keyword to specify files to be indexed and searched regardless of size. Regardless of where you set the `search.largeFiles` environment variable, Sourcegraph will continue to ignore binary files, even if the size of the file is less than the limit you set. +By default, files larger than 1 MB are excluded from search results. Use the [search.largeFiles](/admin/config/site-config#search-largeFiles) keyword to specify files to be indexed and searched regardless of size. Regardless of where you set the `search.largeFiles` environment variable, Sourcegraph will continue to ignore binary files, even if the size of the file is less than the limit you set. ### Maximum timeout @@ -101,7 +101,7 @@ You can configure indexed branches in site configuration under the `experimental } ``` -Indexing multiple branches will add additional resource requirements to Sourcegraph (particularly memory). The indexer will deduplicate documents between branches. So the size of your index will grow in relation to the number of unique documents. Refer to our [resource estimator](/self-hosted/deploy/resource_estimator) to estimate whether additional resources are required. +Indexing multiple branches will add additional resource requirements to Sourcegraph (particularly memory). The indexer will deduplicate documents between branches. So the size of your index will grow in relation to the number of unique documents. Refer to our [resource estimator](/self-hosted/deploy/resource-estimator) to estimate whether additional resources are required. {' '} diff --git a/docs/admin/security_event_logs.mdx b/docs/admin/security-event-logs.mdx similarity index 97% rename from docs/admin/security_event_logs.mdx rename to docs/admin/security-event-logs.mdx index 800a8695c..7db2cb09d 100644 --- a/docs/admin/security_event_logs.mdx +++ b/docs/admin/security-event-logs.mdx @@ -2,7 +2,7 @@ This guide goes into the details of Security Event Logging in Sourcegraph -> Note: You can find more information about our audit logs setup [here](./audit_log) +> Note: You can find more information about our audit logs setup [here](./audit-log) > > [Here](https://docs-legacy.sourcegraph.com/dev/how-to/add_logging) is a guide on how to add logging to Sourcegraph backend @@ -12,7 +12,7 @@ This guide goes into the details of Security Event Logging in Sourcegraph - Getting a full picture of how a user moves through the application, in a single location, is crucial for many reasons. - When a user takes an action on sensitive information within the application, this should be logged to make sure it can be retraced to the user and time. - In Sourcegraph application, these sensitive actions are logged as "security event" with relevant information included in the log output. -- These logs can be enabled/disabled as well as the location can be set via the [site config settings](./audit_log#configuring) +- These logs can be enabled/disabled as well as the location can be set via the [site config settings](./audit-log#configuring) - Previously, we were logging a very selective set of actions. However, through various analyses, it was determined that there were some gaps in creating a full picture. - New event types are constantly being added to fill these gaps. @@ -112,7 +112,7 @@ This guide goes into the details of Security Event Logging in Sourcegraph ### What if I don't want these events to be logged? -- To turn off all security event logs, you can [set the variable](/admin/audit_log#excessive-audit-logging) in the site config +- To turn off all security event logs, you can [set the variable](/admin/audit-log#excessive-audit-logging) in the site config ### How can I correlate the actorID or userID to a user in the application? diff --git a/docs/admin/service_accounts.mdx b/docs/admin/service-accounts.mdx similarity index 89% rename from docs/admin/service_accounts.mdx rename to docs/admin/service-accounts.mdx index 90e54be61..022a2188f 100644 --- a/docs/admin/service_accounts.mdx +++ b/docs/admin/service-accounts.mdx @@ -30,9 +30,9 @@ Service accounts can authenticate using either traditional access tokens or M2M For detailed information about creating, managing, and using traditional access tokens, see: -- [Creating an access token](/cli/how-tos/creating_an_access_token) -- [Managing access tokens](/cli/how-tos/managing_access_tokens) -- [Revoking an access token](/cli/how-tos/revoking_an_access_token) +- [Creating an access token](/cli/how-tos/creating-an-access-token) +- [Managing access tokens](/cli/how-tos/managing-access-tokens) +- [Revoking an access token](/cli/how-tos/revoking-an-access-token) ### M2M OAuth Credentials (Client Credentials Flow) @@ -65,13 +65,13 @@ curl -H "Authorization: Bearer ACCESS_TOKEN" \ https://sourcegraph.example.com/.api/graphql ``` -See [OAuth Apps → Client Credentials Flow](/admin/oauth_apps#oauth-flow-examples) for more details on the client credentials flow. +See [OAuth Apps → Client Credentials Flow](/admin/oauth-apps#oauth-flow-examples) for more details on the client credentials flow. -Both authentication methods can be used to access Sourcegraph's [GraphQL API](/api/graphql) and [Stream API](/api/stream_api). +Both authentication methods can be used to access Sourcegraph's [GraphQL API](/api/graphql) and [Stream API](/api/stream-api). ## Role-Based Access Control (RBAC) -Service accounts integrate with Sourcegraph's [role-based access control](/admin/access_control) to provide fine-grained permission control. +Service accounts integrate with Sourcegraph's [role-based access control](/admin/access-control) to provide fine-grained permission control. ### System Roles @@ -81,9 +81,9 @@ Service accounts are automatically assigned the **Service Account** system role, Administrators can assign additional roles to service accounts through the user management interface. For detailed information on managing roles and permissions, see: -- [Managing roles and permissions](/admin/access_control#managing-roles-and-permissions) -- [Managing user roles](/admin/access_control#managing-user-roles) -- [Creating custom roles](/admin/access_control#creating-a-new-role-and-assigning-it-permissions) +- [Managing roles and permissions](/admin/access-control#managing-roles-and-permissions) +- [Managing user roles](/admin/access-control#managing-user-roles) +- [Creating custom roles](/admin/access-control#creating-a-new-role-and-assigning-it-permissions) ![service-account-roles](https://storage.googleapis.com/sourcegraph-assets/Docs/service-accounts-manage-roles-0625.png) diff --git a/docs/admin/user_data_deletion.mdx b/docs/admin/user-data-deletion.mdx similarity index 100% rename from docs/admin/user_data_deletion.mdx rename to docs/admin/user-data-deletion.mdx diff --git a/docs/admin/user_surveys.mdx b/docs/admin/user-surveys.mdx similarity index 100% rename from docs/admin/user_surveys.mdx rename to docs/admin/user-surveys.mdx diff --git a/docs/admin/webhooks/incoming.mdx b/docs/admin/webhooks/incoming.mdx index 87b2849ca..19fbdaba7 100644 --- a/docs/admin/webhooks/incoming.mdx +++ b/docs/admin/webhooks/incoming.mdx @@ -36,7 +36,7 @@ In order to continue using webhooks you need to follow the steps below to [add a ## Adding an incoming webhook -Before adding an incoming webhook you should ensure that you have at least one [code host connection](/admin/code_hosts/) configured for the code host you want to set up incoming webhooks for. +Before adding an incoming webhook you should ensure that you have at least one [code host connection](/admin/code-hosts/) configured for the code host you want to set up incoming webhooks for. The incoming webhook will be configured to accept events from a specific code host based on its type and URN. @@ -134,11 +134,11 @@ Done! Sourcegraph will now receive webhook events to sync data with lower latenc ### Bitbucket server -The [Sourcegraph Bitbucket Server plugin](/integration/bitbucket_server#sourcegraph-bitbucket-server-plugin) enables the Bitbucket Server / Bitbucket Data Center instance to send webhooks to Sourcegraph. +The [Sourcegraph Bitbucket Server plugin](/integration/bitbucket-server#sourcegraph-bitbucket-server-plugin) enables the Bitbucket Server / Bitbucket Data Center instance to send webhooks to Sourcegraph. Webhooks with the plugin can be installed globally, which is recommended to cover for all repositories. -1. Install the latest version of the [Sourcegraph Bitbucket Server plugin](/integration/bitbucket_server#sourcegraph-bitbucket-server-plugin) on your Bitbucket Server / Bitbucket Data Center instance. +1. Install the latest version of the [Sourcegraph Bitbucket Server plugin](/integration/bitbucket-server#sourcegraph-bitbucket-server-plugin) on your Bitbucket Server / Bitbucket Data Center instance. 1. On your Bitbucket Server / Bitbucket Data Center instance, go to **Administration > Add-ons > Sourcegraph** 1. Fill in the **Add a webhook** form - **Name**: A unique name representing your Sourcegraph instance. diff --git a/docs/api/graphql/index.mdx b/docs/api/graphql/index.mdx index 15358a3fb..517d63116 100644 --- a/docs/api/graphql/index.mdx +++ b/docs/api/graphql/index.mdx @@ -31,7 +31,7 @@ https://sourcegraph.example.com/.api/graphql ### OAuth Tokens -If you have an [OAuth app](/admin/oauth_apps) configured with the `user:all` scope, you can use OAuth Bearer tokens: +If you have an [OAuth app](/admin/oauth-apps) configured with the `user:all` scope, you can use OAuth Bearer tokens: ```bash curl -H 'Authorization: Bearer YOUR_OAUTH_TOKEN' @@ -51,7 +51,7 @@ Both authentication methods will return a response like this: proactively. -For automated scripts, CI/CD pipelines, and production integrations, use [service accounts](/admin/service_accounts) instead of personal access tokens. Service accounts are designed specifically for programmatic API access and provide better security and audit capabilities. +For automated scripts, CI/CD pipelines, and production integrations, use [service accounts](/admin/service-accounts) instead of personal access tokens. Service accounts are designed specifically for programmatic API access and provide better security and audit capabilities. ## Documentation & tooling diff --git a/docs/api/graphql/managing-code-insights-with-api.mdx b/docs/api/graphql/managing-code-insights-with-api.mdx index 0306bf8c0..aaaa122d8 100644 --- a/docs/api/graphql/managing-code-insights-with-api.mdx +++ b/docs/api/graphql/managing-code-insights-with-api.mdx @@ -1,6 +1,6 @@ # Managing Code Insights with the API -Learn how to manage [Code Insights](/code_insights/) on private Sourcegraph instances with the API. If you haven't used the API before, learn more about [the GraphQL API and how to use it](/api/graphql/). +Learn how to manage [Code Insights](/code-insights/) on private Sourcegraph instances with the API. If you haven't used the API before, learn more about [the GraphQL API and how to use it](/api/graphql/). This page is meant as a guide for common use cases. You can find all of GraphQL documentation in the [API Console](/api/graphql/#api-console). @@ -14,7 +14,7 @@ Note: If Code Insights setting storage is enabled, (`ENABLE_CODE_INSIGHTS_SETTIN Note: there are no separate read/write permissions at this time, so if a user has permission to view an insight they can also edit and delete it. -When a user creates a Code Insight, that user will automatically be granted permission to view that insight. Besides this one case of insight-level permissions, all permissions exist on [dashboards](/code_insights/explanations/viewing_code_insights#insights-dashboards). This means that in order for another user to view an insight via the API, that insight must first be attached to a dashboard with either organization or global permissions. +When a user creates a Code Insight, that user will automatically be granted permission to view that insight. Besides this one case of insight-level permissions, all permissions exist on [dashboards](/code-insights/explanations/viewing-code-insights#insights-dashboards). This means that in order for another user to view an insight via the API, that insight must first be attached to a dashboard with either organization or global permissions. See [Managing Dashboards](#managing-dashboards) below for more information. diff --git a/docs/api/graphql/managing-search-contexts-with-api.mdx b/docs/api/graphql/managing-search-contexts-with-api.mdx index da77dc368..1734ea750 100644 --- a/docs/api/graphql/managing-search-contexts-with-api.mdx +++ b/docs/api/graphql/managing-search-contexts-with-api.mdx @@ -1,6 +1,6 @@ # Managing search contexts with the API -Learn how to manage [search contexts](/code-search/working/search_contexts) on private Sourcegraph instances with the API. If you haven't used the API before, learn more about [the GraphQL API and how to use it](/api/graphql/). +Learn how to manage [search contexts](/code-search/working/search-contexts) on private Sourcegraph instances with the API. If you haven't used the API before, learn more about [the GraphQL API and how to use it](/api/graphql/). ## Prerequisites diff --git a/docs/api/graphql/search.mdx b/docs/api/graphql/search.mdx index 4bdf3c027..d55f71f8c 100644 --- a/docs/api/graphql/search.mdx +++ b/docs/api/graphql/search.mdx @@ -6,7 +6,7 @@ This page adds some additional depth and context to Sourcegraph's search GraphQL Sourcegraph does not support pagination for search results when using the GraphQL search API due to the dynamic nature of search queries. The order of results may vary each time you run a search, making traditional pagination unreliable. -Instead, we recommend using the [stream search API](/api/stream_api/) for scenarios where you need to run a long query and receive continuous results. This enables you to execute long-running queries. +Instead, we recommend using the [stream search API](/api/stream-api/) for scenarios where you need to run a long query and receive continuous results. This enables you to execute long-running queries. ## `src` CLI usage (easier than GraphQL) diff --git a/docs/api/index.mdx b/docs/api/index.mdx index 9bb680f7e..770610103 100644 --- a/docs/api/index.mdx +++ b/docs/api/index.mdx @@ -3,5 +3,5 @@ Sourcegraph exposes the following APIs: - [Sourcegraph GraphQL API](/api/graphql/), for accessing data stored or computed by Sourcegraph -- [Sourcegraph Stream API](/api/stream_api/), for consuming search results as a stream of events +- [Sourcegraph Stream API](/api/stream-api/), for consuming search results as a stream of events - [Sourcegraph MCP Server](/api/mcp/), for connecting AI agents and applications to Sourcegraph's code search capabilities diff --git a/docs/api/mcp/index.mdx b/docs/api/mcp/index.mdx index d92001cdc..08f1c19a0 100644 --- a/docs/api/mcp/index.mdx +++ b/docs/api/mcp/index.mdx @@ -11,7 +11,7 @@ This feature is - [experimental](/admin/beta_and_experimental_features#experimental-features) + [experimental](/admin/beta-and-experimental-features#experimental-features) and might change or be removed in the future. @@ -35,7 +35,7 @@ For programmatic access without storing credentials, use OAuth 2.0 with device f #### Prerequisites -Before using OAuth, you must create an OAuth application in your Sourcegraph instance. Follow the instructions [here](/admin/oauth_apps#creating-an-oauth-app). (Note: you will need the `user:all` scope) +Before using OAuth, you must create an OAuth application in your Sourcegraph instance. Follow the instructions [here](/admin/oauth-apps#creating-an-oauth-app). (Note: you will need the `user:all` scope) #### Registering the MCP Server @@ -84,7 +84,7 @@ The Sourcegraph MCP server can be integrated with various AI tools and IDEs that To create an access token, visit [Creating an access - token](/cli/how-tos/creating_an_access_token). + token](/cli/how-tos/creating-an-access-token). You can add the Sourcegraph MCP server to [Amp](https://ampcode.com) in two ways: diff --git a/docs/api/stream_api/index.mdx b/docs/api/stream-api/index.mdx similarity index 98% rename from docs/api/stream_api/index.mdx rename to docs/api/stream-api/index.mdx index 398c968fe..e3061b223 100644 --- a/docs/api/stream_api/index.mdx +++ b/docs/api/stream-api/index.mdx @@ -42,7 +42,7 @@ curl --header "Accept: text/event-stream" \ | Parameter | Description | | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| access token / oauth token | [Sourcegraph access token](/cli/how-tos/creating_an_access_token) or [OAuth token](/admin/oauth_apps) with `user:all` scope. See [GraphQL API authentication](/api/graphql#quickstart) for details on token refresh and expiration handling. | +| access token / oauth token | [Sourcegraph access token](/cli/how-tos/creating-an-access-token) or [OAuth token](/admin/oauth-apps) with `user:all` scope. See [GraphQL API authentication](/api/graphql#quickstart) for details on token refresh and expiration handling. | | Sourcegraph URL | The URL of your Sourcegraph instance, or https://sourcegraph.com. | | query | A Sourcegraph query string, see our [search query syntax](/code-search/queries) | | version (optional) | The version of the search query syntax. We recommend to explicitly set the version. The latest version is "V3". (Default: "V3") | diff --git a/docs/batch-changes/batch-spec-yaml-reference.mdx b/docs/batch-changes/batch-spec-yaml-reference.mdx index 70a9d7821..5a28ebdfd 100644 --- a/docs/batch-changes/batch-spec-yaml-reference.mdx +++ b/docs/batch-changes/batch-spec-yaml-reference.mdx @@ -228,7 +228,7 @@ In this case, `steps.env` is an array. Each array item is either: - An object with a single property, in which case the key is used as the environment variable name and the value the value, or - **For src-cli execution**: A string that defines an environment variable to include from the environment `src` is being run within. This is useful to define secrets that you don't want to include in the spec file, but this makes the spec dependent on your environment, which means that the local execution cache will be invalidated each time the environment variable changes, and means that the batch spec file is no longer [the sole source of truth intended by the Batch Changes design](/batch-changes/design) -- **For server-side execution**: A string that defines a secret value to expose as an environment variable. Follow [the guide on executor secrets](/admin/executors/executor_secrets) to set them up. The editor will suggest available secrets. This is useful to use secret values you don't want to include in the spec file. The execution cache will be invalidated each time the secret value changes, and this means that the batch spec file is no longer [the sole source of truth intended by the Batch Changes design](/batch-changes/design) +- **For server-side execution**: A string that defines a secret value to expose as an environment variable. Follow [the guide on executor secrets](/admin/executors/executor-secrets) to set them up. The editor will suggest available secrets. This is useful to use secret values you don't want to include in the spec file. The execution cache will be invalidated each time the secret value changes, and this means that the batch spec file is no longer [the sole source of truth intended by the Batch Changes design](/batch-changes/design) ### Examples @@ -776,7 +776,7 @@ changesetTemplate: Whether or not each changeset should be created on a fork of the upstream repository in the namespace of the user publishing them (or the namespace of the service account if [global credentials](/batch-changes/configuring-credentials#global-service-account-tokens) are used). -This value will override the setting if the site config setting [`batchChanges.enforceForks`](/admin/config/batch_changes#forks) is enabled. For example, explicitly setting `fork: false` when the site config setting is enabled will publish changesets directly to the target repos. If omitted, the site config setting will be used. +This value will override the setting if the site config setting [`batchChanges.enforceForks`](/admin/config/batch-changes#forks) is enabled. For example, explicitly setting `fork: false` when the site config setting is enabled will publish changesets directly to the target repos. If omitted, the site config setting will be used. The name of the fork Sourcegraph creates will be prefixed with the name of the original repo's namespace to prevent potential repo name collisions. For example, a batch spec targeting `github.com/my-org/project` would create or use any existing fork named `github.com/user/my-org-project`. diff --git a/docs/batch-changes/configuring-credentials.mdx b/docs/batch-changes/configuring-credentials.mdx index 697028912..684245b12 100644 --- a/docs/batch-changes/configuring-credentials.mdx +++ b/docs/batch-changes/configuring-credentials.mdx @@ -99,9 +99,9 @@ Global credentials are usable by all users of the Sourcegraph instance who have However, a global service account token is currently required for [importing existing changesets](/batch-changes/tracking-existing-changesets) on your code hosts into batch changes. -Additionally, if you have not [configured webhooks](/admin/config/batch_changes#incoming-webhooks) from your code host, Sourcegraph requires a global service account to keep changesets up to date. +Additionally, if you have not [configured webhooks](/admin/config/batch-changes#incoming-webhooks) from your code host, Sourcegraph requires a global service account to keep changesets up to date. -If [forks are enabled](/admin/config/batch_changes#forks), then note that repositories will also be forked into the service account. +If [forks are enabled](/admin/config/batch-changes#forks), then note that repositories will also be forked into the service account. ### Adding a global service token diff --git a/docs/batch-changes/faq.mdx b/docs/batch-changes/faq.mdx index 66a8da64f..06d53b8a4 100644 --- a/docs/batch-changes/faq.mdx +++ b/docs/batch-changes/faq.mdx @@ -220,7 +220,7 @@ They can! Each changeset that is computed can be assigned to a separate executor ### What additional resources do I need to provision to run batch changes server-side? -See [deploying executors](/self-hosted/executors/deploy_executors) page. You'll require little as a single compute instance and a docker registry mirror if you just want to process batch changes at a small scale; an autoscaling group of instances if you want to process large batch changes very fast. +See [deploying executors](/self-hosted/executors/deploy-executors) page. You'll require little as a single compute instance and a docker registry mirror if you just want to process batch changes at a small scale; an autoscaling group of instances if you want to process large batch changes very fast. ### Can someone accidentally take down the Sourcegraph instance if they run too big a batch change? diff --git a/docs/batch-changes/permissions-in-batch-changes.mdx b/docs/batch-changes/permissions-in-batch-changes.mdx index fe1326ddd..a12cd6fdd 100644 --- a/docs/batch-changes/permissions-in-batch-changes.mdx +++ b/docs/batch-changes/permissions-in-batch-changes.mdx @@ -24,7 +24,7 @@ Site admins have admin permissions on all batch changes. However, other users ca ### Namespaces -Batch changes can be created under the user's or an organization's namespace. If the organization is configured to allow [member administration of organization-namespaced batch changes](/admin/config/batch_changes#enable-organization-members-to-administer), all organization users have admin access to the batch change if it is placed under an organization namespace. +Batch changes can be created under the user's or an organization's namespace. If the organization is configured to allow [member administration of organization-namespaced batch changes](/admin/config/batch-changes#enable-organization-members-to-administer), all organization users have admin access to the batch change if it is placed under an organization namespace. ### Batch Change access for each permission level @@ -85,8 +85,8 @@ If you are not permitted to view a repository on Sourcegraph, you won't be able ## Disabling Batch Changes -A site admin can disable Batch Changes for a Sourcegraph instance by setting the [site configuration](/admin/config/site_config) property `"batch-changes.enabled"` to `false`. +A site admin can disable Batch Changes for a Sourcegraph instance by setting the [site configuration](/admin/config/site-config) property `"batch-changes.enabled"` to `false`. ## Disabling Batch Changes for non-site-admin users -A site admin can disable batch changes for regular users by setting the [site configuration](/admin/config/site_config) property `"batch-changes.restrictToAdmins"` to `true`. +A site admin can disable batch changes for regular users by setting the [site configuration](/admin/config/site-config) property `"batch-changes.restrictToAdmins"` to `true`. diff --git a/docs/batch-changes/publishing-changesets.mdx b/docs/batch-changes/publishing-changesets.mdx index 23dbe2843..dc7a04281 100644 --- a/docs/batch-changes/publishing-changesets.mdx +++ b/docs/batch-changes/publishing-changesets.mdx @@ -123,7 +123,7 @@ changesetTemplate: Then run the `src batch preview` command again or `src batch apply` to publish the changesets immediately. Publishing a changeset will: - Create a commit with the changes from the patches for that repository -- Push a branch using the branch name you defined in the batch spec with [`changesetTemplate.branch`](/batch-changes/batch-spec-yaml-reference#changesettemplatebranch). If [forks are enabled](/admin/config/batch_changes#forks), then the branch will be pushed to a fork of the repository +- Push a branch using the branch name you defined in the batch spec with [`changesetTemplate.branch`](/batch-changes/batch-spec-yaml-reference#changesettemplatebranch). If [forks are enabled](/admin/config/batch-changes#forks), then the branch will be pushed to a fork of the repository - Create a changeset (e.g., GitHub pull request) on the code host for review and merging diff --git a/docs/batch-changes/requirements.mdx b/docs/batch-changes/requirements.mdx index 9d368695b..2358cadc4 100644 --- a/docs/batch-changes/requirements.mdx +++ b/docs/batch-changes/requirements.mdx @@ -39,11 +39,11 @@ For each changeset, Sourcegraph periodically makes API requests to its code host It's **highly recommended** to enable the webhooks on code hosts where batch change changesets are created. Doing so removes the lag time in updating the status of a changeset and reduces the API requests associated with large batch changes. We have instructions for each supported code host: -- [GitHub](/admin/code_hosts/github#webhooks) -- [Bitbucket/Bitbucket Data Center](/admin/code_hosts/bitbucket_server#webhooks) -- [GitLab](/admin/code_hosts/gitlab#webhooks) +- [GitHub](/admin/code-hosts/github#webhooks) +- [Bitbucket/Bitbucket Data Center](/admin/code-hosts/bitbucket-server#webhooks) +- [GitLab](/admin/code-hosts/gitlab#webhooks) -If you are unable to enable webhooks, you can disable the warning Sourcegraph displays when viewing batch changes by setting the `batchChanges.disableWebhooksWarning` [site configuration setting](/admin/config/site_config) to `true`. +If you are unable to enable webhooks, you can disable the warning Sourcegraph displays when viewing batch changes by setting the `batchChanges.disableWebhooksWarning` [site configuration setting](/admin/config/site-config) to `true`. ### Batch Changes effect on CI systems diff --git a/docs/batch-changes/server-side.mdx b/docs/batch-changes/server-side.mdx index 32fd476d4..24c9c69ab 100644 --- a/docs/batch-changes/server-side.mdx +++ b/docs/batch-changes/server-side.mdx @@ -11,7 +11,7 @@ By default, Batch Changes uses a command line interface in your local environment to [compute diffs](/batch-changes/how-src-executes-a-batch-spec) and create changesets. This can be impractical for creating batch changes affecting hundreds or thousands of repositories, with large numbers of workspaces, or if the batch change steps require CPU, memory, or disk resources that are unavailable locally. -Instead of computing Batch Changes locally using `src-cli`, you can offload this task to one or many remote server called an [executor](/self-hosted/executors/deploy_executors). Executors are also required to enable code navigation [auto-indexing](/code-navigation/auto_indexing). +Instead of computing Batch Changes locally using `src-cli`, you can offload this task to one or many remote server called an [executor](/self-hosted/executors/deploy-executors). Executors are also required to enable code navigation [auto-indexing](/code-navigation/auto-indexing). This allows to: @@ -23,7 +23,7 @@ This allows to: This is a one-time process. Once a site-admin of the Sourcegraph instance sets up executors and enables running batch changes server-side, all users of the Sourcegraph instance can get started with no additional setup required. -Make sure that [executors are deployed and are online](/self-hosted/executors/deploy_executors). +Make sure that [executors are deployed and are online](/self-hosted/executors/deploy-executors). It's recommended to read [Getting started with running batch changes @@ -35,7 +35,7 @@ Make sure that [executors are deployed and are online](/self-hosted/executors/de - Running batch changes server-side requires setting up executors. Executors are configured ready-to-use on Sourcegraph Cloud - Running batch changes server-side is limited to user namespaces - The newly introduced APIs for server-side are still experimental and will likely change -- Executors can only be deployed using Terraform (AWS or GCP) or using pre-built binaries (see [deploying executors](/self-hosted/executors/deploy_executors)). +- Executors can only be deployed using Terraform (AWS or GCP) or using pre-built binaries (see [deploying executors](/self-hosted/executors/deploy-executors)). Running batch changes server-side has been tested to run a simple **45K changeset batch change**. Actual performance and setup requirements depend on the complexity of the batch change. diff --git a/docs/batch-changes/site-admin-configuration.mdx b/docs/batch-changes/site-admin-configuration.mdx index df9d7f9c2..084499ae1 100644 --- a/docs/batch-changes/site-admin-configuration.mdx +++ b/docs/batch-changes/site-admin-configuration.mdx @@ -4,22 +4,22 @@ Learn what configuration permissions site admins have with Batch Changes.

-Using Batch Changes requires a [code host connection](/admin/code_hosts/) to a supported code host (currently GitHub, Bitbucket Server/Bitbucket Data Center, GitLab, and Bitbucket Cloud). Site admins can configure the following when setting and disabling Batch Changes: +Using Batch Changes requires a [code host connection](/admin/code-hosts/) to a supported code host (currently GitHub, Bitbucket Server/Bitbucket Data Center, GitLab, and Bitbucket Cloud). Site admins can configure the following when setting and disabling Batch Changes: ## Set up Batch Changes -- [Configure which users have access to Batch Changes](/admin/access_control/batch_changes) (Beta): By default, all users can create and view batch changes, but only the batch change's author or a site admin can administer a given batch change - - Additionally, you can also [customize org settings](/admin/config/batch_changes#enable-organization-members-to-administer) to allow members of an organization to share administration privileges over batch changes created in that organization +- [Configure which users have access to Batch Changes](/admin/access-control/batch-changes) (Beta): By default, all users can create and view batch changes, but only the batch change's author or a site admin can administer a given batch change + - Additionally, you can also [customize org settings](/admin/config/batch-changes#enable-organization-members-to-administer) to allow members of an organization to share administration privileges over batch changes created in that organization - (Optional) [Configure repository permissions](/admin/permissions/), that Batch Changes will follow - [Configure credentials](/batch-changes/configuring-credentials) - [Setup incoming webhooks](/admin/webhooks/incoming) to make sure changesets sync fast. Learn more about [Batch Changes effect on code host rate limits](/batch-changes/requirements#batch-changes-effect-on-code-host-rate-limits) - Configure any desired optional features, such as: - - [Rollout windows](/admin/config/batch_changes#rollout-windows), which control the rate at which Batch Changes will publish changesets on code hosts - - [Forks](/admin/config/batch_changes#forks), which push branches created by Batch Changes onto forks of the upstream repository instead of the repository itself + - [Rollout windows](/admin/config/batch-changes#rollout-windows), which control the rate at which Batch Changes will publish changesets on code hosts + - [Forks](/admin/config/batch-changes#forks), which push branches created by Batch Changes onto forks of the upstream repository instead of the repository itself - [Outgoing webhooks](/admin/webhooks/outgoing), which publish events related to batch changes and changesets to enable deeper integrations with your other tools and systems - - [Auto-delete branch on merge/close](/admin/config/batch_changes#automatically-delete-branches-on-merge-close), which automatically deletes branches created by Batch Changes when changesets are merged or closed - - [Commit signing for GitHub](/admin/config/batch_changes#commit-signing-for-github), which signs commits created by Batch Changes via a GitHub App (Beta) - - [Batch spec library](/admin/config/batch_changes#batch-spec-library), which help your users write batch specs and follow best practices + - [Auto-delete branch on merge/close](/admin/config/batch-changes#automatically-delete-branches-on-merge-close), which automatically deletes branches created by Batch Changes when changesets are merged or closed + - [Commit signing for GitHub](/admin/config/batch-changes#commit-signing-for-github), which signs commits created by Batch Changes via a GitHub App (Beta) + - [Batch spec library](/admin/config/batch-changes#batch-spec-library), which help your users write batch specs and follow best practices ## Disable Batch Changes diff --git a/docs/cli/explanations/env.mdx b/docs/cli/explanations/env.mdx index 62fea3072..9449c40c4 100644 --- a/docs/cli/explanations/env.mdx +++ b/docs/cli/explanations/env.mdx @@ -20,7 +20,7 @@ If the environment variable is not set, it'll default to "https://sourcegraph.co `src` uses an access token to authenticate as you to your Sourcegraph instance. This token needs to be in the `SRC_ACCESS_TOKEN` environment variable. -To create an access token, please refer to "[Creating an access token](/cli/how-tos/creating_an_access_token)". +To create an access token, please refer to "[Creating an access token](/cli/how-tos/creating-an-access-token)". ## Adding request headers with `SRC_HEADER_` (Proxy Authentication with `src`) diff --git a/docs/cli/how-tos/creating_an_access_token.mdx b/docs/cli/how-tos/creating-an-access-token.mdx similarity index 100% rename from docs/cli/how-tos/creating_an_access_token.mdx rename to docs/cli/how-tos/creating-an-access-token.mdx diff --git a/docs/cli/how-tos/fetch_sboms.mdx b/docs/cli/how-tos/fetch-sboms.mdx similarity index 100% rename from docs/cli/how-tos/fetch_sboms.mdx rename to docs/cli/how-tos/fetch-sboms.mdx diff --git a/docs/cli/how-tos/index.mdx b/docs/cli/how-tos/index.mdx index 8abbefb65..c32c04c73 100644 --- a/docs/cli/how-tos/index.mdx +++ b/docs/cli/how-tos/index.mdx @@ -2,8 +2,8 @@ The following how-tos apply to the `src` command line interface to Sourcegraph: -- [Creating an access token](/cli/how-tos/creating_an_access_token) -- [Revoking an access token](/cli/how-tos/revoking_an_access_token) -- [Managing access tokens](/cli/how-tos/managing_access_tokens) -- [How to fetch SBOMs for Sourcegraph](/cli/how-tos/fetch_sboms) -- [How to verify container signatures for Sourcegraph releases](/cli/how-tos/verify_container_signatures) +- [Creating an access token](/cli/how-tos/creating-an-access-token) +- [Revoking an access token](/cli/how-tos/revoking-an-access-token) +- [Managing access tokens](/cli/how-tos/managing-access-tokens) +- [How to fetch SBOMs for Sourcegraph](/cli/how-tos/fetch-sboms) +- [How to verify container signatures for Sourcegraph releases](/cli/how-tos/verify-container-signatures) diff --git a/docs/cli/how-tos/managing_access_tokens.mdx b/docs/cli/how-tos/managing-access-tokens.mdx similarity index 100% rename from docs/cli/how-tos/managing_access_tokens.mdx rename to docs/cli/how-tos/managing-access-tokens.mdx diff --git a/docs/cli/how-tos/revoking_an_access_token.mdx b/docs/cli/how-tos/revoking-an-access-token.mdx similarity index 100% rename from docs/cli/how-tos/revoking_an_access_token.mdx rename to docs/cli/how-tos/revoking-an-access-token.mdx diff --git a/docs/cli/how-tos/verify_container_signatures.mdx b/docs/cli/how-tos/verify-container-signatures.mdx similarity index 100% rename from docs/cli/how-tos/verify_container_signatures.mdx rename to docs/cli/how-tos/verify-container-signatures.mdx diff --git a/docs/cli/references/serve-git.mdx b/docs/cli/references/serve-git.mdx index ec46e8dd5..32aa819d5 100644 --- a/docs/cli/references/serve-git.mdx +++ b/docs/cli/references/serve-git.mdx @@ -22,7 +22,7 @@ By default 'src serve-git' will recursively serve your current directory on the 'src serve-git -list' will not start up the server. Instead it will write to stdout a list of repository names it would serve. -Documentation at https://sourcegraph.com/docs/admin/code_hosts/src_serve_git +Documentation at https://sourcegraph.com/docs/admin/code-hosts/src-serve-git ``` \ No newline at end of file diff --git a/docs/cloud/index.mdx b/docs/cloud/index.mdx index 0223b1c2d..b18b3c999 100644 --- a/docs/cloud/index.mdx +++ b/docs/cloud/index.mdx @@ -27,10 +27,10 @@ As part of this service you will receive a number of benefits from our team, inc - Initial resource estimations based on your organization & code size. - Putting forward a transparent deployment & cost estimate plan. -- Your own `example.sourcegraphcloud.com` domain with fully managed [DNS & HTTPS](/self-hosted/http_https_configuration). Optionally, you can [bring your own domain](#custom-domain). +- Your own `example.sourcegraphcloud.com` domain with fully managed [DNS & HTTPS](/self-hosted/http-https-configuration). Optionally, you can [bring your own domain](#custom-domain). - Hardware provisioning, software installation, and kernel configuration done for you. - Direct assistance in: - - [Adding repositories from all of your code hosts to Sourcegraph](/admin/code_hosts/) + - [Adding repositories from all of your code hosts to Sourcegraph](/admin/code-hosts/) - [Integrating your single sign-on provider with Sourcegraph](/admin/auth/) - [Configuring Sourcegraph](/admin/config/) @@ -41,9 +41,9 @@ All of Sourcegraph's features are available on Sourcegraph Cloud instances out-o - [Cody](/cody) - [Deep Search](/deep-search) - [Server-side Batch Changes](/batch-changes/server-side) -- [Precise code navigation powered by auto-indexing](/code-navigation/auto_indexing) -- [Code Monitoring](/code_monitoring/) -- [Code Insights](/code_insights/) +- [Precise code navigation powered by auto-indexing](/code-navigation/auto-indexing) +- [Code Monitoring](/code-monitoring/) +- [Code Insights](/code-insights/) ### Access restrictions @@ -105,14 +105,14 @@ Sourcegraph Cloud can connect to resources that are publicly accessible or prote Private Connectivity enables customers to privately connect Private Resources to the Sourcegraph Cloud instance. Private Resources refer to services that are not publicly accessible, such as self-hosted GitHub Enterprise servers, self-hosted GitLab instances, self-hosted Nexus instance, or Jira Data Center deployed in a private network that are only accessible through VPN. Learn more about Private Connectivity support below: -- [Private Resources on AWS via AWS Private Link](/cloud/private_connectivity_aws) -- [Private Resources on GCP via GCP Private Service Connect](/cloud/private_connectivity_gcp) -- [Private Resources on on-prem data center via Sourcegraph Connect agent](/cloud/private_connectivity_sourcegraph_connect) +- [Private Resources on AWS via AWS Private Link](/cloud/private-connectivity-aws) +- [Private Resources on GCP via GCP Private Service Connect](/cloud/private-connectivity-gcp) +- [Private Resources on on-prem data center via Sourcegraph Connect agent](/cloud/private-connectivity-sourcegraph-connect) - Private Resources on Azure are not supported yet, please reach out to your account manager if you are interested in this feature. For unsupported private connectivity methods, Sourcegraph offers connectivity via customer-managed alternate public load balancers: -- [Private Resources exposed via alternate public load balancers](/cloud/private_connectivity_public_lb) +- [Private Resources exposed via alternate public load balancers](/cloud/private-connectivity-public-lb) ### Health monitoring, support, and SLAs @@ -145,7 +145,7 @@ As with any Sourcegraph enterprise customer, you will also receive support from All Sourcegraph Cloud instances are provisioned with a Sourcegraph-managed SMTP server through a [third-party provider](https://about.sourcegraph.com/terms/subprocessors) for transactional email delivery. Email capabilities power features like: -- [Code Monitoring](/code_monitoring/) notifications +- [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 @@ -158,7 +158,7 @@ To learn more about how the Sourcegraph team operates managed SMTP internally, r ### Audit Logs -Our Cloud instances provide [audit logs](/admin/audit_log#cloud) to help you monitor and investigate actions taken by users and the system. These logs are available to download by request and are also sent to a [centralized logging service](https://about.sourcegraph.com/security#logging) for 30 day retention. Should you wish to extend this period, please be aware that additional charges will apply. +Our Cloud instances provide [audit logs](/admin/audit-log#cloud) to help you monitor and investigate actions taken by users and the system. These logs are available to download by request and are also sent to a [centralized logging service](https://about.sourcegraph.com/security#logging) for 30 day retention. Should you wish to extend this period, please be aware that additional charges will apply. To request an extension, please contact your assigned Customer Engineer (CE) or send an email to Sourcegraph Support at support@sourcegraph.com. #### Download audit logs @@ -171,8 +171,8 @@ Sourcegraph LogPush is an optional add-on to deliver audit logs to a customer pr Supported destinations: -- [Google Cloud Storage (GCS)](/cloud/logpush_gcs) -- [Amazon Web Services S3 (AWS)](/cloud/logpush_s3) +- [Google Cloud Storage (GCS)](/cloud/logpush-gcs) +- [Amazon Web Services S3 (AWS)](/cloud/logpush-s3) ## Requirements @@ -185,7 +185,7 @@ Supported destinations: ### Technical - A dedicated technical point of contact for the installation process. -- [Tokens with read access to your code hosts](/admin/code_hosts/) (we will direct you on how to enter them). +- [Tokens with read access to your code hosts](/admin/code-hosts/) (we will direct you on how to enter them). - [Keys, access tokens, or any other setup required to integrate your SSO (single sign-on) provider with Sourcegraph](/admin/auth/), as well as support from a member of your team with administrator access to your SSO provider to help set up and test the integration. ### Limitation diff --git a/docs/cloud/logpush_gcs.mdx b/docs/cloud/logpush-gcs.mdx similarity index 100% rename from docs/cloud/logpush_gcs.mdx rename to docs/cloud/logpush-gcs.mdx diff --git a/docs/cloud/logpush_s3.mdx b/docs/cloud/logpush-s3.mdx similarity index 100% rename from docs/cloud/logpush_s3.mdx rename to docs/cloud/logpush-s3.mdx diff --git a/docs/cloud/private_connectivity_aws.mdx b/docs/cloud/private-connectivity-aws.mdx similarity index 95% rename from docs/cloud/private_connectivity_aws.mdx rename to docs/cloud/private-connectivity-aws.mdx index 33c0bd9aa..f6bcc097b 100644 --- a/docs/cloud/private_connectivity_aws.mdx +++ b/docs/cloud/private-connectivity-aws.mdx @@ -45,11 +45,11 @@ Upon receiving the details, Sourcegraph will create a connection to the customer ### Create the private resource connection -Once the connection to private code host is established, the customer can create the [code host connection](/admin/code_hosts/) on their Sourcegraph Cloud instance. +Once the connection to private code host is established, the customer can create the [code host connection](/admin/code-hosts/) on their Sourcegraph Cloud instance. ### Verify artifact registries are working -Once the connection to private artifact registry is established, customer might then verify that auto-indexing is working with the private artifact registry by [configuring auto-indexing](/code-navigation/auto_indexing#configure-auto-indexing) +Once the connection to private artifact registry is established, customer might then verify that auto-indexing is working with the private artifact registry by [configuring auto-indexing](/code-navigation/auto-indexing#configure-auto-indexing) ## FAQ @@ -76,12 +76,12 @@ The customer has full control over the exposed service and they may terminate th Only if the private artifact registry is protected by authentication, the customer will need to: -- create executor secrets containing credentials for Sourcegraph to access the private artifact registry - [how to configure executor secrets](/admin/executors/executor_secrets#executor-secrets) -- update auto-indexing inference configuration to create additional files from executor secrets for given programming language - [how to configure auto-indexing](/code-navigation/inference_configuration) +- create executor secrets containing credentials for Sourcegraph to access the private artifact registry - [how to configure executor secrets](/admin/executors/executor-secrets#executor-secrets) +- update auto-indexing inference configuration to create additional files from executor secrets for given programming language - [how to configure auto-indexing](/code-navigation/inference-configuration) ### Can I use self-signed TLS certificate for my private resources? -Yes. Please work with your account team to add the certificate chain of your internal CA to [site configuration](/admin/config/site_config) at `tls.external.certificates`. +Yes. Please work with your account team to add the certificate chain of your internal CA to [site configuration](/admin/config/site-config) at `tls.external.certificates`. ### What is the disaster recovery plan? diff --git a/docs/cloud/private_connectivity_gcp.mdx b/docs/cloud/private-connectivity-gcp.mdx similarity index 95% rename from docs/cloud/private_connectivity_gcp.mdx rename to docs/cloud/private-connectivity-gcp.mdx index b7f8f64db..3f778f5a0 100644 --- a/docs/cloud/private_connectivity_gcp.mdx +++ b/docs/cloud/private-connectivity-gcp.mdx @@ -52,11 +52,11 @@ Upon receiving the Service Attachment URI, Sourcegraph will create a connection ### Create the code host connection -Once the connection is established, the customer can create the [code host connection](/admin/code_hosts) on their Sourcegraph Cloud instance. +Once the connection is established, the customer can create the [code host connection](/admin/code-hosts) on their Sourcegraph Cloud instance. ### Verify artifact registries are working -Once the connection to private artifact registry is established, customer might then verify that auto-indexing is working with private registry dependencies by [configuring auto-indexing](/code-navigation/auto_indexing#configure-auto-indexing) +Once the connection to private artifact registry is established, customer might then verify that auto-indexing is working with private registry dependencies by [configuring auto-indexing](/code-navigation/auto-indexing#configure-auto-indexing) ## FAQ @@ -80,9 +80,9 @@ All traffic between the producer and consumer is encrypted in transit. You may l Only if the private artifact registry is protected by authentication, the customer will need to: -- Create executor secrets containing credentials for Sourcegraph to access the private artifact registry - [how to configure executor secrets](/admin/executors/executor_secrets#executor-secrets) -- Update auto-indexing inference configuration to create additional files from executor secrets for the given programming language - [how to configure auto-indexing](/code-navigation/inference_configuration) +- Create executor secrets containing credentials for Sourcegraph to access the private artifact registry - [how to configure executor secrets](/admin/executors/executor-secrets#executor-secrets) +- Update auto-indexing inference configuration to create additional files from executor secrets for the given programming language - [how to configure auto-indexing](/code-navigation/inference-configuration) ### Can I use self-signed TLS certificate for my private resources? -Yes. Please work with your account team to add the certificate chain of your internal CA to [site configuration](/admin/config/site_config) at `tls.external.certificates`. +Yes. Please work with your account team to add the certificate chain of your internal CA to [site configuration](/admin/config/site-config) at `tls.external.certificates`. diff --git a/docs/cloud/private_connectivity_public_lb.mdx b/docs/cloud/private-connectivity-public-lb.mdx similarity index 94% rename from docs/cloud/private_connectivity_public_lb.mdx rename to docs/cloud/private-connectivity-public-lb.mdx index f10efaf2a..eed665b16 100644 --- a/docs/cloud/private_connectivity_public_lb.mdx +++ b/docs/cloud/private-connectivity-public-lb.mdx @@ -61,15 +61,15 @@ In transit, these resources are encrypted via the TLS certificate. ### What are the next steps when code host connectivity is working? -Once the connection is established, the customer can create the [code host connection](/admin/code_hosts/) on their Sourcegraph Cloud instance using private dns name. +Once the connection is established, the customer can create the [code host connection](/admin/code-hosts/) on their Sourcegraph Cloud instance using private dns name. ### What are the next steps when artifact registry connectivity is working? If private artifact registry is protected by authentication, the customer will need to: -- Create executor secrets containing credentials for Sourcegraph to access the private artifact registry - [how to configure executor secrets](/admin/executors/executor_secrets#executor-secrets) -- Update auto-indexing inference configuration to create additional files from executor secrets for given programming language - [how to configure auto-indexing](/code-navigation/inference_configuration) +- Create executor secrets containing credentials for Sourcegraph to access the private artifact registry - [how to configure executor secrets](/admin/executors/executor-secrets#executor-secrets) +- Update auto-indexing inference configuration to create additional files from executor secrets for given programming language - [how to configure auto-indexing](/code-navigation/inference-configuration) ### Can I use self-signed TLS certificate for my private resources? -Yes. Please work with your account team to add the certificate chain of your internal CA to [site configuration](/admin/config/site_config) at `tls.external.certificates`. +Yes. Please work with your account team to add the certificate chain of your internal CA to [site configuration](/admin/config/site-config) at `tls.external.certificates`. diff --git a/docs/cloud/private_connectivity_sourcegraph_connect.mdx b/docs/cloud/private-connectivity-sourcegraph-connect.mdx similarity index 98% rename from docs/cloud/private_connectivity_sourcegraph_connect.mdx rename to docs/cloud/private-connectivity-sourcegraph-connect.mdx index cb5c2daf8..49d1839d4 100644 --- a/docs/cloud/private_connectivity_sourcegraph_connect.mdx +++ b/docs/cloud/private-connectivity-sourcegraph-connect.mdx @@ -66,7 +66,7 @@ The customer installs the agent in their private network, following the instruct ### Configure the code host connection -Once the tunnel is established between the agent and server, the customer can configure the [code host connection](/admin/code_hosts/) on their Sourcegraph Cloud instance. +Once the tunnel is established between the agent and server, the customer can configure the [code host connection](/admin/code-hosts/) on their Sourcegraph Cloud instance. ## FAQ @@ -138,7 +138,7 @@ The tunnel from the agent to the server is encrypted and authenticated by mTLS o ### Can I use Internal PKI or self-signed TLS certificates for my private resources? -Yes. Please work with your account team to add the public certificate chain of your internal CAs, and / or your private resources' self-signed certs, under `tls.external.certificates` in your instance's [site configuration](/admin/config/site_config). +Yes. Please work with your account team to add the public certificate chain of your internal CAs, and / or your private resources' self-signed certs, under `tls.external.certificates` in your instance's [site configuration](/admin/config/site-config). ### Is this connection highly available? diff --git a/docs/code_insights/explanations/administration_and_security_of_code_insights.mdx b/docs/code-insights/explanations/administration-and-security-of-code-insights.mdx similarity index 100% rename from docs/code_insights/explanations/administration_and_security_of_code_insights.mdx rename to docs/code-insights/explanations/administration-and-security-of-code-insights.mdx diff --git a/docs/code_insights/explanations/automatically_generated_data_series.mdx b/docs/code-insights/explanations/automatically-generated-data-series.mdx similarity index 96% rename from docs/code_insights/explanations/automatically_generated_data_series.mdx rename to docs/code-insights/explanations/automatically-generated-data-series.mdx index f99ffb774..b657944c5 100644 --- a/docs/code_insights/explanations/automatically_generated_data_series.mdx +++ b/docs/code-insights/explanations/automatically-generated-data-series.mdx @@ -60,5 +60,5 @@ Any matches that return values over a 100 characters will be truncated. This is ### Regular expression capture group resources -- [Example regular expressions for common use cases](/code_insights/references/common_use_cases#automatic-version-and-pattern-tracking) +- [Example regular expressions for common use cases](/code-insights/references/common-use-cases#automatic-version-and-pattern-tracking) - [General additional capture groups documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions/Groups_and_Ranges) diff --git a/docs/code_insights/explanations/code_insights_filters.mdx b/docs/code-insights/explanations/code-insights-filters.mdx similarity index 98% rename from docs/code_insights/explanations/code_insights_filters.mdx rename to docs/code-insights/explanations/code-insights-filters.mdx index 67a9bb017..cd1d0d236 100644 --- a/docs/code_insights/explanations/code_insights_filters.mdx +++ b/docs/code-insights/explanations/code-insights-filters.mdx @@ -21,7 +21,7 @@ If you combine both filters, the inclusion pattern will be applied first, then t ### `context:` Query-based search context filters -You can use a [query-based search context](/code-search/working/search_contexts#beta-query-based-search-contexts) to filter your insights to only results matching repositories that match the `repo:` or `-repo:` filter of the query-based context. +You can use a [query-based search context](/code-search/working/search-contexts#beta-query-based-search-contexts) to filter your insights to only results matching repositories that match the `repo:` or `-repo:` filter of the query-based context. You can use this to filter multiple insights to a group of repositories that need only be maintained in one location. When you update a context that's being used as a filter, the next time you load the page, the filtered insight will reflect the updated context. As with explicit `repo:` filters, only repository regex expressions are allowed: you cannot specify repository revisions or predicate filters. diff --git a/docs/code_insights/explanations/current_limitations_of_code_insights.mdx b/docs/code-insights/explanations/current-limitations-of-code-insights.mdx similarity index 95% rename from docs/code_insights/explanations/current_limitations_of_code_insights.mdx rename to docs/code-insights/explanations/current-limitations-of-code-insights.mdx index 14e096f19..1484686eb 100644 --- a/docs/code_insights/explanations/current_limitations_of_code_insights.mdx +++ b/docs/code-insights/explanations/current-limitations-of-code-insights.mdx @@ -34,7 +34,7 @@ Language insights become faster as the internal cache populates, but depending o By default the dashboard attempts three queries that take up to 5 minutes. It will automatically retry until the three attempts are exhausted. -Apart from waiting and retrying you may also reach out to your Sourcegraph administrator to [increase the number of concurrent queries or increase the timeout for the query](/code_insights/explanations/administration_and_security_of_code_insights). +Apart from waiting and retrying you may also reach out to your Sourcegraph administrator to [increase the number of concurrent queries or increase the timeout for the query](/code-insights/explanations/administration-and-security-of-code-insights). ## Creating insights over very large repositories @@ -43,7 +43,7 @@ Apart from waiting and retrying you may also reach out to your Sourcegraph admin In some cases, depending on the size of the Sourcegraph instance and the size of the repo, you may see odd behavior or timeout errors if you try to create a code insight running over a single large repository. In this case, it's best to try: 1. Create the insight, but check the box to "run over all repositories." (This sends the Insight backfilling jobs to the backend Sourcegraph instance worker which will handle them datapoint-by-datapoint. Running over an individual repository otherwise currently runs the jobs in bulk to generate its live preview.) -2. After the insight has finished running, [filter the insight](/code_insights/explanations/code_insights_filters#filter-options) to the specific repo you originally wanted to use. The filter resolves instantly. +2. After the insight has finished running, [filter the insight](/code-insights/explanations/code-insights-filters#filter-options) to the specific repo you originally wanted to use. The filter resolves instantly. If this does not solve your problem, please reach out directly to your Sourcegraph contact or in your shared slack channel, as there are experimental solutions we are currently working on to further improve our handling of large repositories. @@ -101,7 +101,7 @@ If desired, a Sourcegraph admin can enable Code Insights access to repositories ### Features currently available only on insights over all your repositories -- **[Filtering insights](/code_insights/explanations/code_insights_filters)**: available in 3.41+ ~~we do not yet allow filtering for insights that run over explicitly defined lists of repositories, except for "detect and track" insights.~~ +- **[Filtering insights](/code-insights/explanations/code-insights-filters)**: available in 3.41+ ~~we do not yet allow filtering for insights that run over explicitly defined lists of repositories, except for "detect and track" insights.~~ ### Features currently available only on insights over explicitly defined repository lists @@ -116,11 +116,11 @@ Because these insights need to run dramatically fewer queries than insights over ### Limitations specific to "Detect and track patterns" insights (automatically generated data series) -Please see [Current limitations of automatically generated data series](/code_insights/explanations/automatically_generated_data_series#current-limitations). +Please see [Current limitations of automatically generated data series](/code-insights/explanations/automatically-generated-data-series#current-limitations). ## In certain cases, chart datapoints don't match the result count of a Sourcegraph search -There are currently a few subtle differences in how code insights and Sourcegraph web app searches handle defaults when searching over all repositories. Refer to [Common reasons code insights may not match search results](/code_insights/references/common_reasons_code_insights_may_not_match_search_results). +There are currently a few subtle differences in how code insights and Sourcegraph web app searches handle defaults when searching over all repositories. Refer to [Common reasons code insights may not match search results](/code-insights/references/common-reasons-code-insights-may-not-match-search-results). ## Older versions' limitations diff --git a/docs/code_insights/explanations/data_retention.mdx b/docs/code-insights/explanations/data-retention.mdx similarity index 100% rename from docs/code_insights/explanations/data_retention.mdx rename to docs/code-insights/explanations/data-retention.mdx diff --git a/docs/code-insights/explanations/index.mdx b/docs/code-insights/explanations/index.mdx new file mode 100644 index 000000000..dad06d810 --- /dev/null +++ b/docs/code-insights/explanations/index.mdx @@ -0,0 +1,11 @@ +# Explanations + +The following articles explain different parts of Sourcegraph Code Insights in depth: + +- [Administration and Security of Code Insights](/code-insights/explanations/administration-and-security-of-code-insights) +- [Automatically generated data series for version or pattern tracking](/code-insights/explanations/automatically-generated-data-series) +- [Code Insights filters](/code-insights/explanations/code-insights-filters) +- [Current limitations of Code Insights](/code-insights/explanations/current-limitations-of-code-insights) +- [Search-screen search results aggregations](/code-insights/explanations/search-results-aggregations) +- [Viewing code insights](/code-insights/explanations/viewing-code-insights) +- [Data retention](/code-insights/explanations/data-retention) diff --git a/docs/code_insights/explanations/search_results_aggregations.mdx b/docs/code-insights/explanations/search-results-aggregations.mdx similarity index 97% rename from docs/code_insights/explanations/search_results_aggregations.mdx rename to docs/code-insights/explanations/search-results-aggregations.mdx index dc61fbac5..441ab41aa 100644 --- a/docs/code_insights/explanations/search_results_aggregations.mdx +++ b/docs/code-insights/explanations/search-results-aggregations.mdx @@ -2,7 +2,7 @@ In version 4.0 and later, Code Insights provides aggregations shown on the search screen. -This lets you track version and license spread, library adoption, common commit messages, lengths of specific files, usage frequencies, and the [many common use case examples here](/code_insights/references/search_aggregations_use_cases). +This lets you track version and license spread, library adoption, common commit messages, lengths of specific files, usage frequencies, and the [many common use case examples here](/code-insights/references/search-aggregations-use-cases). ## Available aggregations: diff --git a/docs/code_insights/explanations/viewing_code_insights.mdx b/docs/code-insights/explanations/viewing-code-insights.mdx similarity index 92% rename from docs/code_insights/explanations/viewing_code_insights.mdx rename to docs/code-insights/explanations/viewing-code-insights.mdx index d341b6d1b..c52f8e8b9 100644 --- a/docs/code_insights/explanations/viewing_code_insights.mdx +++ b/docs/code-insights/explanations/viewing-code-insights.mdx @@ -22,7 +22,7 @@ The share link box will indicate which other users will be able to view the insi A default "dashboard" of all insights visible to a user appears as the homepage for the Insights navigation bar item. -To add insights to your own custom dashboard, see [Creating a custom dashboard of code insights](/code_insights/how-tos/creating_a_custom_dashboard_of_code_insights). +To add insights to your own custom dashboard, see [Creating a custom dashboard of code insights](/code-insights/how-tos/creating-a-custom-dashboard-of-code-insights). ### Dashboard visibility @@ -32,7 +32,7 @@ If you create an insight directly on the create page or from the default dashboa ### Insights still enforce individual permissions regardless of dashboard visibility -The dashboard visibility levels have no impact on the data in the insight itself that is displayed to an individual user: insights [enforce the viewer's permissions](/code_insights/explanations/administration_and_security_of_code_insights#code-insights-enforce-user-permissions). +The dashboard visibility levels have no impact on the data in the insight itself that is displayed to an individual user: insights [enforce the viewer's permissions](/code-insights/explanations/administration-and-security-of-code-insights#code-insights-enforce-user-permissions). This means that two organization users with different repo read permission sets might see different values for the same insights on the same dashboards, if it contains results from a repository only one user can view. diff --git a/docs/code_insights/how-tos/Troubleshooting.mdx b/docs/code-insights/how-tos/Troubleshooting.mdx similarity index 100% rename from docs/code_insights/how-tos/Troubleshooting.mdx rename to docs/code-insights/how-tos/Troubleshooting.mdx diff --git a/docs/code_insights/how-tos/creating_a_custom_dashboard_of_code_insights.mdx b/docs/code-insights/how-tos/creating-a-custom-dashboard-of-code-insights.mdx similarity index 92% rename from docs/code_insights/how-tos/creating_a_custom_dashboard_of_code_insights.mdx rename to docs/code-insights/how-tos/creating-a-custom-dashboard-of-code-insights.mdx index 7f18081e7..1b3fdda25 100644 --- a/docs/code_insights/how-tos/creating_a_custom_dashboard_of_code_insights.mdx +++ b/docs/code-insights/how-tos/creating-a-custom-dashboard-of-code-insights.mdx @@ -1,6 +1,6 @@ # Creating a custom dashboard of code insights -This how-to assumes that you already have created some code insights to add to a dashboard. If you have yet to create any code insights, start with the [quickstart](/code_insights/quickstart) guide. +This how-to assumes that you already have created some code insights to add to a dashboard. If you have yet to create any code insights, start with the [quickstart](/code-insights/quickstart) guide. ## 1. Navigate to the Code Insights page @@ -12,7 +12,7 @@ Click "Create new dashboard" in the top right corner and name your dashboard. Da ## 3. Select a visibility level -Set a visibility level for your dashboard. Dashboards [respect insights' permissions](/code_insights/explanations/viewing_code_insights#dashboard-visibility-respects-insights-visibility), so don't create an organization-shared dashboard if you have private insights you want to attach to it. +Set a visibility level for your dashboard. Dashboards [respect insights' permissions](/code-insights/explanations/viewing-code-insights#dashboard-visibility-respects-insights-visibility), so don't create an organization-shared dashboard if you have private insights you want to attach to it. - Private: visible only to you - Shared with [an organization](/admin/organizations): visible to everyone in the organization diff --git a/docs/code_insights/how-tos/filtering_an_insight.mdx b/docs/code-insights/how-tos/filtering-an-insight.mdx similarity index 92% rename from docs/code_insights/how-tos/filtering_an_insight.mdx rename to docs/code-insights/how-tos/filtering-an-insight.mdx index 468d06c38..10f1b0b4e 100644 --- a/docs/code_insights/how-tos/filtering_an_insight.mdx +++ b/docs/code-insights/how-tos/filtering-an-insight.mdx @@ -1,6 +1,6 @@ # Filtering a code insight -This how-to assumes that you already have [created some search insights](/code_insights/quickstart). +This how-to assumes that you already have [created some search insights](/code-insights/quickstart). > NOTE: filters are not yet available on language statistics insights. @@ -12,7 +12,7 @@ While viewing the insight you want to filter, click the filter icon in the upper The filter popover gives you two inputs that allow you to to filter the repositories contributing to the insight, either via inclusion with `repo:` or exclusion with `-repo:`. -Enter a regular expression for repository names that you'd like to include or exclude. Inclusion filters limit your insight to show data from only given repository matches. Exclusion filters filter out results from the repository matches. ([More details on how repo filters are applied](/code_insights/explanations/code_insights_filters#repo-repo-filters).) +Enter a regular expression for repository names that you'd like to include or exclude. Inclusion filters limit your insight to show data from only given repository matches. Exclusion filters filter out results from the repository matches. ([More details on how repo filters are applied](/code-insights/explanations/code-insights-filters#repo-repo-filters).) The regular expression to filter for a repository works the same as the [`repo:` filter in the search box](/code-search/queries#filters-all-searches). @@ -28,13 +28,13 @@ Examples: ### 3. Or, filter to include a reusable group of repositories using a query-based search context -In the `context:` field of the filter panel, you can use a [query-based search context](/code-search/working/search_contexts#beta-query-based-search-contexts) to filter your insights to only results matching repositories that match the query-based context's `repo:` filter. +In the `context:` field of the filter panel, you can use a [query-based search context](/code-search/working/search-contexts#beta-query-based-search-contexts) to filter your insights to only results matching repositories that match the query-based context's `repo:` filter. -First, if you haven't already created a search context, create a [query-based search context](/code-search/working/search_contexts#beta-query-based-search-contexts). You can define any group of repos using the syntax `repo:(^github\.com/sourcegraph/sourcegraph$|^github\.com/sourcegraph/about$...)`. +First, if you haven't already created a search context, create a [query-based search context](/code-search/working/search-contexts#beta-query-based-search-contexts). You can define any group of repos using the syntax `repo:(^github\.com/sourcegraph/sourcegraph$|^github\.com/sourcegraph/about$...)`. Then, in the context field, reference the search context's name, usually `@owner/name-of-context`. -([More details on using search contexts as filters, and currently supported search filters](/code_insights/explanations/code_insights_filters#context-query-based-search-context-filters).) +([More details on using search contexts as filters, and currently supported search filters](/code-insights/explanations/code-insights-filters#context-query-based-search-context-filters).) ### 4. Close the filter panel diff --git a/docs/code-insights/how-tos/index.mdx b/docs/code-insights/how-tos/index.mdx new file mode 100644 index 000000000..11c1231ba --- /dev/null +++ b/docs/code-insights/how-tos/index.mdx @@ -0,0 +1,7 @@ +# How-tos + +The following is a list of how-tos that show how to use Code Insights. + +- [Creating a dashboard of Code Insights](/code-insights/how-tos/creating-a-custom-dashboard-of-code-insights) +- [Filtering an Insight](/code-insights/how-tos/filtering-an-insight) +- [Troubleshooting Code Insights](/code-insights/how-tos/Troubleshooting) diff --git a/docs/code_insights/index.mdx b/docs/code-insights/index.mdx similarity index 84% rename from docs/code_insights/index.mdx rename to docs/code-insights/index.mdx index 2e843c436..4b0b6e67c 100644 --- a/docs/code_insights/index.mdx +++ b/docs/code-insights/index.mdx @@ -6,16 +6,16 @@

Anything you can search, you can track and analyze

- + Code Insights reveals high-level information about your codebase, based on both how your code changes over time and its current state. Code Insights is based on our universal code search, making it precise and configurable. Track anything that can be expressed with a Sourcegraph search query: migrations, package use, version adoption, code smells, codebase size and much more, across 1,000s of repositories. Code Insights will backfill years of historical data from your version control, so you can immediately reveal current trends and baselines. - - + + - + diff --git a/docs/code_insights/language_insight_quickstart.mdx b/docs/code-insights/language-insight-quickstart.mdx similarity index 89% rename from docs/code_insights/language_insight_quickstart.mdx rename to docs/code-insights/language-insight-quickstart.mdx index 49a031c46..d54ebfee1 100644 --- a/docs/code_insights/language_insight_quickstart.mdx +++ b/docs/code-insights/language-insight-quickstart.mdx @@ -1,17 +1,17 @@ # Quickstart for Language Code Insights -Get started and create your first [language code insight](/code_insights/) in 5 minutes or less. +Get started and create your first [language code insight](/code-insights/) in 5 minutes or less. ## Introduction -> This quickstart guide assumes that **you have already completed [step 1, enabling the feature flag](/code_insights/quickstart#1-enable-the-experimental-feature-flag)**, on the main code insights quickstart guide. +> This quickstart guide assumes that **you have already completed [step 1, enabling the feature flag](/code-insights/quickstart#1-enable-the-experimental-feature-flag)**, on the main code insights quickstart guide. In this guide, you'll create a Sourcegraph language code insight that shows the percentage of lines of code in a repository by language. -For more information about Code Insights see the [Code Insights](/code_insights/) documentation. +For more information about Code Insights see the [Code Insights](/code-insights/) documentation. @@ -23,7 +23,7 @@ If you don't see the /Insights page you need to [enable code insights](quickstar This creates a code insight tracking how many lines of code you have in each language. -If you are more interested tracking the historical or future result count of an arbitrary Sourcegraph search, [follow this tutorial](/code_insights/quickstart) instead. +If you are more interested tracking the historical or future result count of an arbitrary Sourcegraph search, [follow this tutorial](/code-insights/quickstart) instead. ### 3. Once on the "Set up new language usage insight" form fields page, enter the repository you want to analyze. diff --git a/docs/code_insights/quickstart.mdx b/docs/code-insights/quickstart.mdx similarity index 88% rename from docs/code_insights/quickstart.mdx rename to docs/code-insights/quickstart.mdx index 137737e31..cd7a94551 100644 --- a/docs/code_insights/quickstart.mdx +++ b/docs/code-insights/quickstart.mdx @@ -1,15 +1,15 @@ # Quickstart for Code Insights -Get started and create your first [code insight](/code_insights/) in 5 minutes or less. +Get started and create your first [code insight](/code-insights/) in 5 minutes or less. ## Introduction In this guide, you'll create a Sourcegraph code insight that tracks the number of `TODOs` that appear in parts of your codebase. -For more information about Code Insights see the [Code Insights](/code_insights/) documentation. +For more information about Code Insights see the [Code Insights](/code-insights/) documentation. @@ -47,8 +47,8 @@ This creates a code insight tracking an arbitrary input that you could run a Sou Your other options are to: -- [create a "Detect and track" insight](/code_insights/explanations/automatically_generated_data_series) to automatically generate your data series according to capture group matching (3.35+). -- [create a language-based insight](/code_insights/language_insight_quickstart) to show you language breakdown in your repositories. +- [create a "Detect and track" insight](/code-insights/explanations/automatically-generated-data-series) to automatically generate your data series according to capture group matching (3.35+). +- [create a language-based insight](/code-insights/language-insight-quickstart) to show you language breakdown in your repositories. ### 4. Select the repositories you want to search @@ -57,7 +57,7 @@ Separate multiple repositories with a comma. The form field will validate that y If you want to run an insight over all repositories, instead check the box to do so (available in Sourcegraph 3.31.1 and later). If you otherwise want to exclude specific repositories, you can do so after creating the insight by using filters (step 10). -From Sourcegraph 4.5 you are able to define the repositories you want your insight to run over using a Sourcegraph search query. [Read the reference to learn more](/code_insights/references/repository_scope). +From Sourcegraph 4.5 you are able to define the repositories you want your insight to run over using a Sourcegraph search query. [Read the reference to learn more](/code-insights/references/repository-scope). ### 5. Define a data series to track the incidence of `TODO` @@ -84,4 +84,4 @@ You'll be taken to the `example.sourcegraph.com/insights` page and can view your ### 9. Filter your insight to explore it further Click the filter button in the top right of an insight card to open the filters panel. This allows you to filter the insight down to a subset of repositories through inclusion or exclusion using regular expressions. -For more details, see [How to filter an insight](/code_insights/how-tos/filtering_an_insight). +For more details, see [How to filter an insight](/code-insights/how-tos/filtering-an-insight). diff --git a/docs/code_insights/references/common_reasons_code_insights_may_not_match_search_results.mdx b/docs/code-insights/references/common-reasons-code-insights-may-not-match-search-results.mdx similarity index 100% rename from docs/code_insights/references/common_reasons_code_insights_may_not_match_search_results.mdx rename to docs/code-insights/references/common-reasons-code-insights-may-not-match-search-results.mdx diff --git a/docs/code_insights/references/common_use_cases.mdx b/docs/code-insights/references/common-use-cases.mdx similarity index 92% rename from docs/code_insights/references/common_use_cases.mdx rename to docs/code-insights/references/common-use-cases.mdx index 031d049e7..5d97ae84c 100644 --- a/docs/code_insights/references/common_use_cases.mdx +++ b/docs/code-insights/references/common-use-cases.mdx @@ -2,9 +2,9 @@ Here are some common use cases for Code Insights and example data series queries you could use. -For all use cases, you can also explore your insight by [filtering repositories in real time](/code_insights/how-tos/filtering_an_insight) or add any [Sourcegraph search filter](/code-search/queries/language#search-pattern) to the data series query to filter by language, directory, or content. Currently, the sample queries using commit and diff searches are only supported for insights running over explicit lists of specific repositories. +For all use cases, you can also explore your insight by [filtering repositories in real time](/code-insights/how-tos/filtering-an-insight) or add any [Sourcegraph search filter](/code-search/queries/language#search-pattern) to the data series query to filter by language, directory, or content. Currently, the sample queries using commit and diff searches are only supported for insights running over explicit lists of specific repositories. -_The sample queries below make the assumption you [do not want to search fork or archived](/code_insights/references/common_reasons_code_insights_may_not_match_search_results#not-including-fork-no-and-archived-no-in-your-insight-query) repositories. You can include those flags if you do._ +_The sample queries below make the assumption you [do not want to search fork or archived](/code-insights/references/common-reasons-code-insights-may-not-match-search-results#not-including-fork-no-and-archived-no-in-your-insight-query) repositories. You can include those flags if you do._ ## Popular @@ -56,7 +56,7 @@ select:repo file:yarn.lock Detect and track which Java versions are most popular in your codebase -_Uses the [detect and track](/code_insights/explanations/automatically_generated_data_series) capture groups insight type_ +_Uses the [detect and track](/code-insights/explanations/automatically-generated-data-series) capture groups insight type_ ```sgquery file:pom\.xml$ (.*) @@ -262,7 +262,7 @@ from 'enzyme' ## Versions and patterns -These examples are all for use with the [automatically generated data series](/code_insights/explanations/automatically_generated_data_series) of "Detect and track" Code Insights, using regular expression capture groups. +These examples are all for use with the [automatically generated data series](/code-insights/explanations/automatically-generated-data-series) of "Detect and track" Code Insights, using regular expression capture groups. ### Java versions @@ -460,7 +460,7 @@ patternType:regexp case:yes \b(it|test)\( f:/integration/.*\.test\.ts$ See the most common reasons for why secuirty checks in checkov are skipped -_Uses the [detect and track](/code_insights/explanations/automatically_generated_data_series) capture groups insight type_ +_Uses the [detect and track](/code-insights/explanations/automatically-generated-data-series) capture groups insight type_ ```sgquery patterntype:regexp file:.tf #checkov:skip=(.*) @@ -500,7 +500,7 @@ file:mobileTeam newAPI.call file:webappTeam newAPI.call ``` -_Or [filter teams by repositories](/code_insights/how-tos/filtering_an_insight) in real time_ +_Or [filter teams by repositories](/code-insights/how-tos/filtering-an-insight) in real time_ ### Problematic API by Team @@ -514,7 +514,7 @@ problemAPI file:teamOneDirectory problemAPI file:teamTwoDirectory ``` -_Or [filter teams by repositories](/code_insights/how-tos/filtering_an_insight) in real time_ +_Or [filter teams by repositories](/code-insights/how-tos/filtering-an-insight) in real time_ ### Data fetching from GraphQL diff --git a/docs/code_insights/references/incomplete_data_points.mdx b/docs/code-insights/references/incomplete-data-points.mdx similarity index 98% rename from docs/code_insights/references/incomplete_data_points.mdx rename to docs/code-insights/references/incomplete-data-points.mdx index 94eeae695..1411feb5a 100644 --- a/docs/code_insights/references/incomplete_data_points.mdx +++ b/docs/code-insights/references/incomplete-data-points.mdx @@ -77,7 +77,7 @@ In addition: 1. Timeout errors on points that have been backfilled before the creation date of the insight are more likely to occur on single, large repositories, because backfill points are calculated by running many searches, repository by repository, individually. 1. Timeout errors on points that have been snapshot after the creation date of the insight are more likely to occur on insights running complex searches over large numbers of repositories, because snapshot points are calculated by running a single global search against the current index. - You can read more about this case in our [limitations](/code_insights/explanations/current_limitations_of_code_insights#accuracy-considerations-for-an-insight-query-returning-a-large-result-set). + You can read more about this case in our [limitations](/code-insights/explanations/current-limitations-of-code-insights#accuracy-considerations-for-an-insight-query-returning-a-large-result-set). If the data is available, the error alert will inform you which times the search has timed out. diff --git a/docs/code-insights/references/index.mdx b/docs/code-insights/references/index.mdx new file mode 100644 index 000000000..e60269b27 --- /dev/null +++ b/docs/code-insights/references/index.mdx @@ -0,0 +1,11 @@ +# References + +The following is a list of reference documents for Code Insights: + +- [Common use cases and recipes](/code-insights/references/common-use-cases) +- [Common reasons code insights may not match search results](/code-insights/references/common-reasons-code-insights-may-not-match-search-results) +- [Incomplete data points](/code-insights/references/incomplete-data-points) +- [Licensing and limited access](/code-insights/references/license) +- [Managing code insights with the API](/api/graphql/managing-code-insights-with-api) +- [Requirements](/code-insights/references/requirements) +- [Code Insight repository scope](/code-insights/references/repository-scope) diff --git a/docs/code_insights/references/license.mdx b/docs/code-insights/references/license.mdx similarity index 100% rename from docs/code_insights/references/license.mdx rename to docs/code-insights/references/license.mdx diff --git a/docs/code_insights/references/repository_scope.mdx b/docs/code-insights/references/repository-scope.mdx similarity index 97% rename from docs/code_insights/references/repository_scope.mdx rename to docs/code-insights/references/repository-scope.mdx index 8825c9f7b..f30e477cc 100644 --- a/docs/code_insights/references/repository_scope.mdx +++ b/docs/code-insights/references/repository-scope.mdx @@ -10,7 +10,7 @@ A Code Insight runs on a list of repositories as specified on insight creation. ## Using the repository search query box -![Code Insights repository search box with a query for repo:sourcegraph](https://storage.googleapis.com/sourcegraph-assets/docs/images/code_insights/create_insight_repo_selection.png) +![Code Insights repository search box with a query for repo:sourcegraph](https://storage.googleapis.com/sourcegraph-assets/docs/images/code-insights/create_insight_repo_selection.png) The repository search query box allows you to search for repositories on your Sourcegraph instance using standard Sourcegraph `repo` filters, as well as boolean operators. diff --git a/docs/code_insights/references/requirements.mdx b/docs/code-insights/references/requirements.mdx similarity index 100% rename from docs/code_insights/references/requirements.mdx rename to docs/code-insights/references/requirements.mdx diff --git a/docs/code_insights/references/search_aggregations_use_cases.mdx b/docs/code-insights/references/search-aggregations-use-cases.mdx similarity index 98% rename from docs/code_insights/references/search_aggregations_use_cases.mdx rename to docs/code-insights/references/search-aggregations-use-cases.mdx index 6924a1da7..24e4a0788 100644 --- a/docs/code_insights/references/search_aggregations_use_cases.mdx +++ b/docs/code-insights/references/search-aggregations-use-cases.mdx @@ -1,6 +1,6 @@ # Search results aggregations use cases and recipes -Here are some common use cases for the [in-search-results aggregations](/code_insights/explanations/search_results_aggregations) powered by code insights. +Here are some common use cases for the [in-search-results aggregations](/code-insights/explanations/search-results-aggregations) powered by code insights. ## Popular diff --git a/docs/code_insights/types/inventory-stats.mdx b/docs/code-insights/types/inventory-stats.mdx similarity index 100% rename from docs/code_insights/types/inventory-stats.mdx rename to docs/code-insights/types/inventory-stats.mdx diff --git a/docs/code_monitoring/campaigns-icon.svg b/docs/code-monitoring/campaigns-icon.svg similarity index 100% rename from docs/code_monitoring/campaigns-icon.svg rename to docs/code-monitoring/campaigns-icon.svg diff --git a/docs/code_monitoring/file-icon.svg b/docs/code-monitoring/file-icon.svg similarity index 100% rename from docs/code_monitoring/file-icon.svg rename to docs/code-monitoring/file-icon.svg diff --git a/docs/code_monitoring/index.mdx b/docs/code-monitoring/index.mdx similarity index 100% rename from docs/code_monitoring/index.mdx rename to docs/code-monitoring/index.mdx diff --git a/docs/code-navigation/auto_indexing_configuration.mdx b/docs/code-navigation/auto-indexing-configuration.mdx similarity index 99% rename from docs/code-navigation/auto_indexing_configuration.mdx rename to docs/code-navigation/auto-indexing-configuration.mdx index 1adf5a352..f2e06f115 100644 --- a/docs/code-navigation/auto_indexing_configuration.mdx +++ b/docs/code-navigation/auto-indexing-configuration.mdx @@ -4,7 +4,7 @@ This feature is in beta for self-hosted customers. -This document details the expected contents of [explicit index job configuration](/code-navigation/auto_indexing#explicit-index-job-configuration) for a particular repository. Depending on how this configuration is supplied, it may be encoded as JSON. +This document details the expected contents of [explicit index job configuration](/code-navigation/auto-indexing#explicit-index-job-configuration) for a particular repository. Depending on how this configuration is supplied, it may be encoded as JSON. ## Keys diff --git a/docs/code-navigation/auto_indexing.mdx b/docs/code-navigation/auto-indexing.mdx similarity index 93% rename from docs/code-navigation/auto_indexing.mdx rename to docs/code-navigation/auto-indexing.mdx index 39865c9ed..ce1bd23a7 100644 --- a/docs/code-navigation/auto_indexing.mdx +++ b/docs/code-navigation/auto-indexing.mdx @@ -7,13 +7,13 @@

Learn and understand how auto-indexing works.

-With Sourcegraph deployments supporting [executors](/admin/executors/), your repository contents can be automatically analyzed to produce a code graph index file. Once [auto-indexing is enabled](/code-navigation/auto_indexing#enable-auto-indexing) and [auto-indexing policies are configured](/code-navigation/auto_indexing#configure-auto-indexing), repositories will be periodically cloned into an executor sandbox, analyzed, and the resulting index file will be uploaded back to the Sourcegraph instance. +With Sourcegraph deployments supporting [executors](/admin/executors/), your repository contents can be automatically analyzed to produce a code graph index file. Once [auto-indexing is enabled](/code-navigation/auto-indexing#enable-auto-indexing) and [auto-indexing policies are configured](/code-navigation/auto-indexing#configure-auto-indexing), repositories will be periodically cloned into an executor sandbox, analyzed, and the resulting index file will be uploaded back to the Sourcegraph instance. Auto-indexing is currently available for Go, TypeScript, JavaScript, Python, Ruby and JVM repositories. See also [dependency navigation](/code-navigation/features#dependency-navigation) for instructions on how to setup cross-dependency navigation depending on what language ecosystem you use. ## Enable auto-indexing -The following docs explains how to turn on [auto-indexing](/code-navigation/auto_indexing) on your Sourcegraph instance to enable [precise code navigation](/code-navigation/precise_code_navigation). +The following docs explains how to turn on [auto-indexing](/code-navigation/auto-indexing) on your Sourcegraph instance to enable [precise code navigation](/code-navigation/precise-code-navigation). ### Deploy executors @@ -21,7 +21,7 @@ The following docs explains how to turn on [auto-indexing](/code-navigation/auto This step is only required if you are on self-hosted Sourcegraph. -First, [deploy the executor service](/self-hosted/executors/deploy_executors) targeting your Sourcegraph instance. This will provide the necessary compute resources that clone the target Git repository, securely analyze the code to produce a code graph data index, then upload that index to your Sourcegraph instance for processing. +First, [deploy the executor service](/self-hosted/executors/deploy-executors) targeting your Sourcegraph instance. This will provide the necessary compute resources that clone the target Git repository, securely analyze the code to produce a code graph data index, then upload that index to your Sourcegraph instance for processing. ### Enable index job scheduling @@ -48,21 +48,21 @@ The frequency of index job scheduling can be tuned via the following environment This feature is in beta for self-hosted customers. -Precise code navigation [auto-indexing](/code-navigation/auto_indexing) jobs are scheduled based on two fronts of configuration. +Precise code navigation [auto-indexing](/code-navigation/auto-indexing) jobs are scheduled based on two fronts of configuration. The first front selects the set of repositories and commits within those repositories that are candidates for auto-indexing. These candidates are controlled by [configuring auto-indexing policies](#configure-auto-indexing-policies). -The second front determines the set of index jobs that can run over candidate commits. By default, index jobs are [inferred](/code-navigation/inference_configuration) from the repository structure's on disk. Index job inference uses heuristics such as the presence or contents of particular files to determine the paths and commands required to index a repository. +The second front determines the set of index jobs that can run over candidate commits. By default, index jobs are [inferred](/code-navigation/inference-configuration) from the repository structure's on disk. Index job inference uses heuristics such as the presence or contents of particular files to determine the paths and commands required to index a repository. Alternatively, index job configuration [can be supplied explicitly](#explicit-index-job-configuration) for a repository when the inference heuristics are not powerful enough to create an index job that produces the correct results. This might be necessary for projects that have non-standard or complex dependency resolution or pre-compilation steps, for example. ### Configure auto-indexing policies -Let's learn how to configure policies to control the scheduling of precise code navigation indexing jobs. An indexing jobs [produces a code graph data index](/code-navigation/precise_code_navigation) and uploads it to your Sourcegraph instance for use with code navigation. +Let's learn how to configure policies to control the scheduling of precise code navigation indexing jobs. An indexing jobs [produces a code graph data index](/code-navigation/precise-code-navigation) and uploads it to your Sourcegraph instance for use with code navigation. See the [best practices - guide](/code-navigation/how-to/policies_resource_usage_best_practices) for + guide](/code-navigation/how-to/policies-resource-usage-best-practices) for additional details on how policies affect resource usage. @@ -112,7 +112,7 @@ In this example, we create an indexing policy that applies to all _versioned_ ta ### Explicit index job configuration -For projects that have non-standard or complex dependency resolution or pre-compilation steps, inference heuristics might not be powerful enough to create an index job that produces the correct results. In these cases, explicit index job configuration can be supplied to a repository in two ways (listed below in order of decreasing precedence). Both methods of configuration share a common expected schema. See the [reference documentation](/code-navigation/auto_indexing_configuration) for additional information on the shape and content of the configuration. +For projects that have non-standard or complex dependency resolution or pre-compilation steps, inference heuristics might not be powerful enough to create an index job that produces the correct results. In these cases, explicit index job configuration can be supplied to a repository in two ways (listed below in order of decreasing precedence). Both methods of configuration share a common expected schema. See the [reference documentation](/code-navigation/auto-indexing-configuration) for additional information on the shape and content of the configuration. 1. Configure index jobs by committing a `sourcegraph.yaml` file to the root of the target repository. If you're new to YAML and want a short introduction, see [Learn YAML in five minutes](https://learnxinyminutes.com/docs/yaml/). Note that YAML is a strict superset of JSON, therefore the file contents can also be encoded as valid JSON (despite the file extension). @@ -120,7 +120,7 @@ For projects that have non-standard or complex dependency resolution or pre-comp ![Repository index page](https://storage.googleapis.com/sourcegraph-assets/docs/images/code-intelligence/sg-3.33/repository-page.png) -From there you can view or edit the repository's configuration. We use a superset of JSON that allows for comments and trailing commas. The set of index jobs that would be [inferred](/code-navigation/explanations/auto_indexing_inference) from the content of the repository (at the current tip of the default branch) can be viewed and may often be useful as a starting point to define more elaborate indexing jobs. +From there you can view or edit the repository's configuration. We use a superset of JSON that allows for comments and trailing commas. The set of index jobs that would be [inferred](/code-navigation/explanations/auto-indexing-inference) from the content of the repository (at the current tip of the default branch) can be viewed and may often be useful as a starting point to define more elaborate indexing jobs. ![Auto-indexing configuration editor](https://storage.googleapis.com/sourcegraph-assets/docs/images/code-intelligence/renamed/configuration.png) @@ -172,7 +172,7 @@ The detail page of an index job will show its current state as well as detailed ![Upload in processing state](https://storage.googleapis.com/sourcegraph-assets/docs/images/code-intelligence/renamed/indexes-processing.png) -The stdout and stderr of each command run during pre-indexing and indexing steps are viewable as the index job is processed. This information is valuable when troubleshooting a [custom index configuration](/code-navigation/auto_indexing_configuration) for your repository. +The stdout and stderr of each command run during pre-indexing and indexing steps are viewable as the index job is processed. This information is valuable when troubleshooting a [custom index configuration](/code-navigation/auto-indexing-configuration) for your repository. ![Detailed look at index job logs](https://storage.googleapis.com/sourcegraph-assets/docs/images/code-intelligence/renamed/indexes-processing-detail.png) @@ -186,13 +186,13 @@ Once the index job completes, a code graph data file has been uploaded to the So This feature is in beta for self-hosted customers. -When a commit of a repository is selected as a candidate for [auto-indexing](/code-navigation/auto_indexing) but does not have an explicitly supplied index job configuration, index jobs are inferred from the content of the repository at that commit. +When a commit of a repository is selected as a candidate for [auto-indexing](/code-navigation/auto-indexing) but does not have an explicitly supplied index job configuration, index jobs are inferred from the content of the repository at that commit. The site-config setting `codeIntelAutoIndexing.indexerMap` can be used to update the indexer image that is (globally) used on inferred jobs. For example, `"codeIntelAutoIndexing.indexerMap": {"go": "lsif-go:alternative-tag"}` will cause inferred jobs indexing Go code to use the specified container (with an alternative tag). This can also be useful for specifying alternative Docker registries. -This document describes the heuristics used to determine the set of index jobs to schedule. See [configuration reference](/code-navigation/auto_indexing_configuration) for additional documentation on how index jobs are configured. +This document describes the heuristics used to determine the set of index jobs to schedule. See [configuration reference](/code-navigation/auto-indexing-configuration) for additional documentation on how index jobs are configured. -As a general rule of thumb, an indexer can be invoked successfully if the source code to index can be compiled successfully. The heuristics below attempt to cover the common cases of dependency resolution, but may not be sufficient if the target code requires additional steps such as code generation, header file linking, or installation of system dependencies to compile from a fresh clone of the repository. For such cases, we recommend using the inferred job as a starting point to [explicitly supply index job configuration](/code-navigation/auto_indexing#explicit-index-job-configuration). +As a general rule of thumb, an indexer can be invoked successfully if the source code to index can be compiled successfully. The heuristics below attempt to cover the common cases of dependency resolution, but may not be sufficient if the target code requires additional steps such as code generation, header file linking, or installation of system dependencies to compile from a fresh clone of the repository. For such cases, we recommend using the inferred job as a starting point to [explicitly supply index job configuration](/code-navigation/auto-indexing#explicit-index-job-configuration). ### Go @@ -291,35 +291,35 @@ If the repository contains both a `lsif-java.json` file as well as `*.java`, `*. -When a commit of a repository is selected as a candidate for [auto-indexing](/code-navigation/auto_indexing) but does not have an explicitly supplied index job configuration, index jobs are inferred from the content of the repository at that commit. +When a commit of a repository is selected as a candidate for [auto-indexing](/code-navigation/auto-indexing) but does not have an explicitly supplied index job configuration, index jobs are inferred from the content of the repository at that commit. The site-config setting `codeIntelAutoIndexing.indexerMap` can be used to update the indexer image that is (globally) used on inferred jobs. For example, `"codeIntelAutoIndexing.indexerMap": {"go": "scip-go:alternative-tag"}` will cause inferred jobs indexing Go code to use the specified container (with an alternative tag). This can also be useful for specifying alternative Docker registries. -This document describes the heuristics used to determine the set of index jobs to schedule. See [configuration reference](/code-navigation/auto_indexing_configuration) for additional documentation on how index jobs are configured. +This document describes the heuristics used to determine the set of index jobs to schedule. See [configuration reference](/code-navigation/auto-indexing-configuration) for additional documentation on how index jobs are configured. -As a general rule of thumb, an indexer can be invoked successfully if the source code to index can be compiled successfully. The heuristics below attempt to cover the common cases of dependency resolution, but may not be sufficient if the target code requires additional steps such as code generation, header file linking, or installation of system dependencies to compile from a fresh clone of the repository. For such cases, we recommend using the inferred job as a starting point to [explicitly supply index job configuration](/code-navigation/auto_indexing#explicit-index-job-configuration). +As a general rule of thumb, an indexer can be invoked successfully if the source code to index can be compiled successfully. The heuristics below attempt to cover the common cases of dependency resolution, but may not be sufficient if the target code requires additional steps such as code generation, header file linking, or installation of system dependencies to compile from a fresh clone of the repository. For such cases, we recommend using the inferred job as a starting point to [explicitly supply index job configuration](/code-navigation/auto-indexing#explicit-index-job-configuration). ## Go diff --git a/docs/code-navigation/explanations/uploads.mdx b/docs/code-navigation/explanations/uploads.mdx index 1a4643857..dc8baa9d6 100644 --- a/docs/code-navigation/explanations/uploads.mdx +++ b/docs/code-navigation/explanations/uploads.mdx @@ -4,7 +4,7 @@ How Code Graph indexers analyze code and generate and index file.

-[Code graph indexers](/code-navigation/writing_an_indexer) analyze source code and generate an index file, which is subsequently [uploaded to a Sourcegraph instance](/code-navigation/how-to/index_other_languages#upload-scip-data) using [Sourcegraph CLI](/cli/) for processing. Once processed, this data becomes available for [precise code navigation queries](/code-navigation/precise_code_navigation). +[Code graph indexers](/code-navigation/writing-an-indexer) analyze source code and generate an index file, which is subsequently [uploaded to a Sourcegraph instance](/code-navigation/how-to/index-other-languages#upload-scip-data) using [Sourcegraph CLI](/cli/) for processing. Once processed, this data becomes available for [precise code navigation queries](/code-navigation/precise-code-navigation). ## Lifecycle of an upload diff --git a/docs/code-navigation/features.mdx b/docs/code-navigation/features.mdx index 96f069949..c4fb8bcd9 100644 --- a/docs/code-navigation/features.mdx +++ b/docs/code-navigation/features.mdx @@ -42,7 +42,7 @@ For example, the animation below demonstrates how to trigger **Find references** ![dependency-navigation](https://storage.googleapis.com/sourcegraph-assets/docs/images/code-intelligence/dependency-nav.gif) -The instructions to set up dependency navigation require you to set up auto-indexing. For more information on how to set up auto-indexing, please refer to our [auto-indexing documentation](/code-navigation/auto_indexing). +The instructions to set up dependency navigation require you to set up auto-indexing. For more information on how to set up auto-indexing, please refer to our [auto-indexing documentation](/code-navigation/auto-indexing). ## Find implementations @@ -51,7 +51,7 @@ If precise code navigation is enabled for your repositories, you can click **Fin ![find-implementations](https://storage.googleapis.com/sourcegraph-assets/docs/images/code-intelligence/find-impl.gif) - Read [here](/code-navigation/writing_an_indexer#quick-reference) for an + Read [here](/code-navigation/writing-an-indexer#quick-reference) for an overview of which languages support this feature. @@ -91,7 +91,7 @@ When viewing a file in Sourcegraph, you can open it in your editor of choice to When you click the Open in Editor button, Sourcegraph will detect which editor you have configured and open the file in a new tab in that editor. If you have not configured a default editor, Sourcegraph will prompt you to select an editor before opening the file. -You can read more about this [here](/integration/open_in_editor). +You can read more about this [here](/integration/open-in-editor). ### View History diff --git a/docs/code-navigation/how-to/adding_scip_to_workflows.mdx b/docs/code-navigation/how-to/adding-scip-to-workflows.mdx similarity index 96% rename from docs/code-navigation/how-to/adding_scip_to_workflows.mdx rename to docs/code-navigation/how-to/adding-scip-to-workflows.mdx index 244185a5c..439680885 100644 --- a/docs/code-navigation/how-to/adding_scip_to_workflows.mdx +++ b/docs/code-navigation/how-to/adding-scip-to-workflows.mdx @@ -10,7 +10,7 @@ Setting up a source code indexing job in your CI build provides you with fast co ## Using indexer containers -We're working on creating containers that bundle indexers and the [Sourcegraph CLI (`src`)](https://github.com/sourcegraph/src-cli). All the languages in our [language-specific guides](/code-navigation/precise_code_navigation#setting-up-code-navigation-for-your-codebase) are supported, and this section provides a general guide to using those containers. We've pinned the containers to the `latest` tag in these samples so they stay up to date, but make sure you pin them before going live to ensure reproducibility. +We're working on creating containers that bundle indexers and the [Sourcegraph CLI (`src`)](https://github.com/sourcegraph/src-cli). All the languages in our [language-specific guides](/code-navigation/precise-code-navigation#setting-up-code-navigation-for-your-codebase) are supported, and this section provides a general guide to using those containers. We've pinned the containers to the `latest` tag in these samples so they stay up to date, but make sure you pin them before going live to ensure reproducibility. ### Basic usage @@ -175,19 +175,19 @@ The following projects have example Travis CI configurations to generate and upl ## CI from scratch -If you're indexing a language we haven't documented yet in our [language-specific guides](/code-navigation/precise_code_navigation#setting-up-code-navigation-for-your-codebase), follow the instructions in this section. We want to have containers available for every language with a robust indexer, so please [contact](https://help.sourcegraph.com/hc/en-us/requests/new) to let us know we're missing one. +If you're indexing a language we haven't documented yet in our [language-specific guides](/code-navigation/precise-code-navigation#setting-up-code-navigation-for-your-codebase), follow the instructions in this section. We want to have containers available for every language with a robust indexer, so please [contact](https://help.sourcegraph.com/hc/en-us/requests/new) to let us know we're missing one. ### Set up your CI machines Your CI machines will need two command-line tools installed. Depending on your build system setup, you can do this as part of the CI step, or you can add it directly to your CI machines for use by the build. 1. The [Sourcegraph CLI (`src`)](https://github.com/sourcegraph/src-cli). -2. The [indexer](/code-navigation/writing_an_indexer) for your language. +2. The [indexer](/code-navigation/writing-an-indexer) for your language. ### Add steps to your CI 1. **Generate an index** for a project within your repository by running the indexer in the project directory (consult your indexer's docs). -1. **[Upload that generated index](/code-navigation/precise_code_navigation#setting-up-code-navigation-for-your-codebase)** to your Sourcegraph instance. +1. **[Upload that generated index](/code-navigation/precise-code-navigation#setting-up-code-navigation-for-your-codebase)** to your Sourcegraph instance. ## Recommended upload frequency @@ -199,6 +199,6 @@ With periodic jobs, you should still receive precise code navigation on non-inde ## Uploading indexes to Sourcegraph.com -Indexes can be uploaded to a self-hosted Sourcegraph instance or to [Sourcegraph.com](https://sourcegraph.com). Using the [Sourcegraph.com](https://sourcegraph.com) endpoint will surface code navigation for your public repositories directly on GitHub via the [Sourcegraph browser extension](/integration/browser_extension) and at `https://sourcegraph.com/github.com//`. +Indexes can be uploaded to a self-hosted Sourcegraph instance or to [Sourcegraph.com](https://sourcegraph.com). Using the [Sourcegraph.com](https://sourcegraph.com) endpoint will surface code navigation for your public repositories directly on GitHub via the [Sourcegraph browser extension](/integration/browser-extension) and at `https://sourcegraph.com/github.com//`. Using the [Sourcegraph.com](https://sourcegraph.com) endpoint is free and your index is treated as User-Generated Content (you own it, as covered in our [Sourcegraph.com terms of service](https://about.sourcegraph.com/terms-dotcom#3-proprietary-rights-and-licenses)). If you run into trouble, or a situation arises where you need all of your index expunged, please reach out to us at [support@sourcegraph.com](mailto:support@sourcegraph.com). diff --git a/docs/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing.mdx b/docs/code-navigation/how-to/combining-scip-uploads-from-ci-cd-and-auto-indexing.mdx similarity index 82% rename from docs/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing.mdx rename to docs/code-navigation/how-to/combining-scip-uploads-from-ci-cd-and-auto-indexing.mdx index dd2148cf4..070b3a094 100644 --- a/docs/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing.mdx +++ b/docs/code-navigation/how-to/combining-scip-uploads-from-ci-cd-and-auto-indexing.mdx @@ -2,13 +2,13 @@ Sourcegraph Enterprise instances can serve many profiles of repository size and build complexity, and therefore provides multiple methods precise SCIP index data for your team's repositories. We currently support: -1. Uploading [SCIP data yourself](/code-navigation/how-to/index_other_languages#upload-scip-data) directly from an already-configured build or continuous integration server, as well as -2. [Auto-indexing](/code-navigation/auto_indexing), which schedules index creation within the Sourcegraph instance. +1. Uploading [SCIP data yourself](/code-navigation/how-to/index-other-languages#upload-scip-data) directly from an already-configured build or continuous integration server, as well as +2. [Auto-indexing](/code-navigation/auto-indexing), which schedules index creation within the Sourcegraph instance. There is nothing preventing users from mix-and-matching these methods (we do it ourselves), but we do have some tips for doing so successfully. -First and foremost, try to that auto-indexing is disabled on repositories that will receive manually configured uploads. This can be done by ensuring that no [auto-indexing policies](/code-navigation/auto_indexing#configure-auto-indexing-policies) exist for the target repo. Even if one is not created explicitly for this repo, it may still be covered under a global policy with a matching repository pattern. +First and foremost, try to that auto-indexing is disabled on repositories that will receive manually configured uploads. This can be done by ensuring that no [auto-indexing policies](/code-navigation/auto-indexing#configure-auto-indexing-policies) exist for the target repo. Even if one is not created explicitly for this repo, it may still be covered under a global policy with a matching repository pattern. -If covering policies can't be changed to exclude a repo (or if you want _partially_ auto-indexed coverage), then the repository can be [explicitly configured](/code-navigation/auto_indexing#explicit-index-job-configuration) with a set of auto-indexing jobs to schedule. Simply delete the job configuration that conflicts the explicitly configured project (the directory and indexer's target language should match). +If covering policies can't be changed to exclude a repo (or if you want _partially_ auto-indexed coverage), then the repository can be [explicitly configured](/code-navigation/auto-indexing#explicit-index-job-configuration) with a set of auto-indexing jobs to schedule. Simply delete the job configuration that conflicts the explicitly configured project (the directory and indexer's target language should match). Once an explicit set of jobs are configured, auto-inference will not update it. If the repository shape changes frequently (new index targets are added or removed). Therefore, this configuration should be manually refreshed as necessary. diff --git a/docs/code-navigation/how-to/index_a_go_repository.mdx b/docs/code-navigation/how-to/index-a-go-repository.mdx similarity index 100% rename from docs/code-navigation/how-to/index_a_go_repository.mdx rename to docs/code-navigation/how-to/index-a-go-repository.mdx diff --git a/docs/code-navigation/how-to/index_a_typescript_and_javascript_repository.mdx b/docs/code-navigation/how-to/index-a-typescript-and-javascript-repository.mdx similarity index 100% rename from docs/code-navigation/how-to/index_a_typescript_and_javascript_repository.mdx rename to docs/code-navigation/how-to/index-a-typescript-and-javascript-repository.mdx diff --git a/docs/code-navigation/how-to/index_other_languages.mdx b/docs/code-navigation/how-to/index-other-languages.mdx similarity index 93% rename from docs/code-navigation/how-to/index_other_languages.mdx rename to docs/code-navigation/how-to/index-other-languages.mdx index 74e4674e2..804ddfb5b 100644 --- a/docs/code-navigation/how-to/index_other_languages.mdx +++ b/docs/code-navigation/how-to/index-other-languages.mdx @@ -20,7 +20,7 @@ chmod +x /usr/local/bin/src An SCIP indexer is a command line tool that performs code analysis of source code and outputs a file with metadata containing all the definitions, references, and hover documentation in a project in SCIP. The SCIP file is then uploaded to Sourcegraph to power code navigation features. -Install the [indexer](/code-navigation/writing_an_indexer) for the required programming language of your repository by following the instructions in the indexer's README +Install the [indexer](/code-navigation/writing-an-indexer) for the required programming language of your repository by following the instructions in the indexer's README ## Generate SCIP data @@ -46,7 +46,7 @@ The `src-cli` upload command will try to infer the repository and git commit by If you're using Sourcegraph.com or have enabled - [`lsifEnforceAuth`](/admin/config/site_config#lsifEnforceAuth) you need to + [`lsifEnforceAuth`](/admin/config/site-config#lsifEnforceAuth) you need to [supply a GitHub token](#proving-ownership-of-a-github-repository) supplied via the `-github-token` flag in the command above. @@ -57,7 +57,7 @@ Successful output will appear similar to the following example. ## Automate code indexing -Now that you have successfully enabled code navigation for your repository, you can automate source code indexing to ensure precise code navigation stays up to date with the most recent code changes in the repository. See our [continuous integration guide](/code-navigation/how-to/adding_scip_to_workflows) to setup automation. +Now that you have successfully enabled code navigation for your repository, you can automate source code indexing to ensure precise code navigation stays up to date with the most recent code changes in the repository. See our [continuous integration guide](/code-navigation/how-to/adding-scip-to-workflows) to setup automation. ## Troubleshooting @@ -66,7 +66,7 @@ Now that you have successfully enabled code navigation for your repository, you Make sure you have configured your Sourcegraph instance and [enabled precise code - navigation](/code-navigation/precise_code_navigation#setting-up-code-navigation-for-your-codebase). + navigation](/code-navigation/precise-code-navigation#setting-up-code-navigation-for-your-codebase). Once LSIF data has uploaded, open the Sourcegraph UI or your code host (i.e. GitHub) and navigate to any code file that was part of the repository that was analyzed by the LSIF indexer. Hover over a symbol, variable or function name in the file, you should now see rich LSIF metadata as the source for hover-tooltips, definitions, and references. @@ -82,5 +82,5 @@ Possible errors that can happen during upload include: - Clone in progress: the instance doesn't have the necessary data to process your upload yet, retry in a few minutes - Unknown repository (404): check your `-endpoint` and make sure you can view the repository on your Sourcegraph instance - Invalid commit (404): try visiting the repository at that commit on your Sourcegraph instance to trigger an update -- Invalid auth when using Sourcegraph.com or when [`lsifEnforceAuth`](/admin/config/site_config#lsifEnforceAuth) is `true` (401 for an invalid token or 404 if the repository cannot be found on GitHub.com): make sure your GitHub token is valid and that the repository is correct +- Invalid auth when using Sourcegraph.com or when [`lsifEnforceAuth`](/admin/config/site-config#lsifEnforceAuth) is `true` (401 for an invalid token or 404 if the repository cannot be found on GitHub.com): make sure your GitHub token is valid and that the repository is correct - Unexpected errors (500s): reach out to your Sourcegraph support team for assistance diff --git a/docs/code-navigation/how-to/index.mdx b/docs/code-navigation/how-to/index.mdx index e02e5e003..d6ba7665e 100644 --- a/docs/code-navigation/how-to/index.mdx +++ b/docs/code-navigation/how-to/index.mdx @@ -1,8 +1,8 @@ # How-to guides -- [Adding precise code navigation to CI/CD workflows](/code-navigation/how-to/adding_scip_to_workflows) -- [Combining SCIP uploads from CI/CD and auto-indexing](/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing) -- [Go SCIP indexing](/code-navigation/how-to/index_a_go_repository) -- [Index a TypeScript or JavaScript repository](/code-navigation/how-to/index_a_typescript_and_javascript_repository) -- [Index other languages](/code-navigation/how-to/index_other_languages) -- [Code intelligence policies resource usage best practices](/code-navigation/how-to/policies_resource_usage_best_practices) +- [Adding precise code navigation to CI/CD workflows](/code-navigation/how-to/adding-scip-to-workflows) +- [Combining SCIP uploads from CI/CD and auto-indexing](/code-navigation/how-to/combining-scip-uploads-from-ci-cd-and-auto-indexing) +- [Go SCIP indexing](/code-navigation/how-to/index-a-go-repository) +- [Index a TypeScript or JavaScript repository](/code-navigation/how-to/index-a-typescript-and-javascript-repository) +- [Index other languages](/code-navigation/how-to/index-other-languages) +- [Code intelligence policies resource usage best practices](/code-navigation/how-to/policies-resource-usage-best-practices) diff --git a/docs/code-navigation/how-to/policies_resource_usage_best_practices.mdx b/docs/code-navigation/how-to/policies-resource-usage-best-practices.mdx similarity index 98% rename from docs/code-navigation/how-to/policies_resource_usage_best_practices.mdx rename to docs/code-navigation/how-to/policies-resource-usage-best-practices.mdx index 034190630..f7412c1a7 100644 --- a/docs/code-navigation/how-to/policies_resource_usage_best_practices.mdx +++ b/docs/code-navigation/how-to/policies-resource-usage-best-practices.mdx @@ -1,6 +1,6 @@ # Code intelligence policies resource usage best practices -This guide gives an overview of best practices when defining [auto-index scheduling](/code-navigation/auto_indexing#configure-auto-indexing) and data retention policies as it relates to resource usage (particular the disk requirement for Postgres). +This guide gives an overview of best practices when defining [auto-index scheduling](/code-navigation/auto-indexing#configure-auto-indexing) and data retention policies as it relates to resource usage (particular the disk requirement for Postgres). **Auto-index scheduling policies** define the _cadence_ at which particular repositories will be subject to have indexing jobs scheduled (depending on the repository's configuration and contents). These policies define when a commit of a repository should be marked as an auto-index job candidate. diff --git a/docs/code-navigation/index.mdx b/docs/code-navigation/index.mdx index e79695135..f388b2881 100644 --- a/docs/code-navigation/index.mdx +++ b/docs/code-navigation/index.mdx @@ -36,21 +36,21 @@ Code Navigation helps you quickly understand your code, its dependencies, and sy description="See how Code Navigation works on public code." /> -This document details how a site administrator can supply a Lua script to customize the way [Sourcegraph detects precise code intelligence indexing jobs from repository contents](/code-navigation/explanations/auto_indexing_inference). +This document details how a site administrator can supply a Lua script to customize the way [Sourcegraph detects precise code intelligence indexing jobs from repository contents](/code-navigation/explanations/auto-indexing-inference). By default, Sourcegraph will attempt to infer index jobs for the following languages: -- [`Go`](/code-navigation/explanations/auto_indexing_inference#go) -- [`Java`/`Scala`/`Kotlin`](/code-navigation/explanations/auto_indexing_inference#java) +- [`Go`](/code-navigation/explanations/auto-indexing-inference#go) +- [`Java`/`Scala`/`Kotlin`](/code-navigation/explanations/auto-indexing-inference#java) - `Python` - `Ruby` -- [`Rust`](/code-navigation/explanations/auto_indexing_inference#rust) -- [`TypeScript`/`JavaScript`](/code-navigation/explanations/auto_indexing_inference#typescript) +- [`Rust`](/code-navigation/explanations/auto-indexing-inference#rust) +- [`TypeScript`/`JavaScript`](/code-navigation/explanations/auto-indexing-inference#typescript) Inference logic can be disabled or altered in the case when the target repositories do not conform to a pattern that the Sourcegraph default inference logic recognizes. Inference logic is controlled by a **Lua override script** that can be supplied in the UI under `Admin > Code graph > Inference`. @@ -44,7 +44,7 @@ return require("sg.autoindex.config").new({ To **add** additional behaviors, you can create and register a new **recognizer**. A recognizer is an interface that requests some set of files from a repository, and returns a set of auto-indexing job configurations that could produce a precise code intelligence index. -A _path recognizer_ is a concrete recognizer that advertises a set of path _globs_ it is interested in, then invokes its `generate` function with matching paths from a repository. In the following, all files matching `Snek.module` (`Snek.module`, `proj/Snek.module`, `proj/sub/Snek.module`, etc) are passed to a call to `generate` (if non-empty). The generate function will then return a list of indexing job descriptions. The [guide for auto-indexing jobs configuration](/code-navigation/auto_indexing_configuration#keys-1) gives detailed descriptions on the fields of this object. +A _path recognizer_ is a concrete recognizer that advertises a set of path _globs_ it is interested in, then invokes its `generate` function with matching paths from a repository. In the following, all files matching `Snek.module` (`Snek.module`, `proj/Snek.module`, `proj/sub/Snek.module`, etc) are passed to a call to `generate` (if non-empty). The generate function will then return a list of indexing job descriptions. The [guide for auto-indexing jobs configuration](/code-navigation/auto-indexing-configuration#keys-1) gives detailed descriptions on the fields of this object. The ordering of paths and limits are defined in the [Ordering guarantees and limits](#ordering-guarantees-and-limits) section. diff --git a/docs/code-navigation/precise_code_navigation.mdx b/docs/code-navigation/precise-code-navigation.mdx similarity index 92% rename from docs/code-navigation/precise_code_navigation.mdx rename to docs/code-navigation/precise-code-navigation.mdx index 679a5fb6a..adab86ec6 100644 --- a/docs/code-navigation/precise_code_navigation.mdx +++ b/docs/code-navigation/precise-code-navigation.mdx @@ -24,7 +24,7 @@ Precise code navigation relies on the open source [SCIP Code Intelligence Protoc There are several options for setting up precise code navigation listed below. However, we always recommend you start by manually indexing your repo locally using the [approriate - indexer](/code-navigation/writing_an_indexer#quick-reference) for your + indexer](/code-navigation/writing-an-indexer#quick-reference) for your language. Code and build systems can vary by project and ensuring you can first succesfully run the indexer locally leads to a smoother experience since it is vastly easier to debug and iterate on any issues locally before @@ -33,18 +33,18 @@ Precise code navigation relies on the open source [SCIP Code Intelligence Protoc 1. **Manual indexing**. Index a repository and upload it to your Sourcegraph instance: - - [Index a Go repository](/code-navigation/how-to/index_a_go_repository#manual-indexing) - - [Index a TypeScript or JavaScript repository](/code-navigation/how-to/index_a_typescript_and_javascript_repository#manual-indexing) + - [Index a Go repository](/code-navigation/how-to/index-a-go-repository#manual-indexing) + - [Index a TypeScript or JavaScript repository](/code-navigation/how-to/index-a-typescript-and-javascript-repository#manual-indexing) - [Index a Java, Scala, or Kotlin repository](https://sourcegraph.github.io/scip-java/docs/getting-started.html) - [Index a Python repository](https://sourcegraph.com/github.com/sourcegraph/scip-python) - [Index a Ruby repository](https://sourcegraph.com/github.com/sourcegraph/scip-ruby) -2. [**Automate indexing via CI**](/code-navigation/how-to/adding_scip_to_workflows): Add indexing and uploading to your CI setup. -3. [**Auto-indexing**](/code-navigation/auto_indexing#enable-auto-indexing): Sourcegraph will automatically index your repositories and enable precise code navigation for them. +2. [**Automate indexing via CI**](/code-navigation/how-to/adding-scip-to-workflows): Add indexing and uploading to your CI setup. +3. [**Auto-indexing**](/code-navigation/auto-indexing#enable-auto-indexing): Sourcegraph will automatically index your repositories and enable precise code navigation for them. ## Supported languages and indexers -Precise Code Navigation requires language-specific indexes to be generated and uploaded to your Sourcegraph instance. We currently have precise code navigation support for the languages below. See the [indexers page](/code-navigation/writing_an_indexer) for a detailed breakdown of each indexer's status. +Precise Code Navigation requires language-specific indexes to be generated and uploaded to your Sourcegraph instance. We currently have precise code navigation support for the languages below. See the [indexers page](/code-navigation/writing-an-indexer) for a detailed breakdown of each indexer's status. | Language | Indexer | Status | | ---------------------- | --------------------------------------------------------------------------------- | ---------------------- | @@ -57,7 +57,7 @@ Precise Code Navigation requires language-specific indexes to be generated and u | Ruby | [scip-ruby](https://sourcegraph.com/github.com/sourcegraph/scip-ruby) | 🟢 Generally available | | C#, Visual Basic | [scip-dotnet](https://github.com/sourcegraph/scip-dotnet) | 🟢 Generally available | -The easiest way to configure precise code navigation is with [auto-indexing](/code-navigation/auto_indexing). This feature uses [Sourcegraph executors](/admin/executors/) to automatically create indexes for the code, keeping precise code navigation available and up-to-date. +The easiest way to configure precise code navigation is with [auto-indexing](/code-navigation/auto-indexing). This feature uses [Sourcegraph executors](/admin/executors/) to automatically create indexes for the code, keeping precise code navigation available and up-to-date. ## Precise navigation examples @@ -79,14 +79,14 @@ The following repositories have precise code navigation enabled: To enable precise code navigation for your repository, see our [docs - here](/code-navigation/precise_code_navigation#setting-up-code-navigation-for-your-codebase). + here](/code-navigation/precise-code-navigation#setting-up-code-navigation-for-your-codebase). ## More resources diff --git a/docs/code-navigation/syntactic_code_navigation.mdx b/docs/code-navigation/syntactic-code-navigation.mdx similarity index 98% rename from docs/code-navigation/syntactic_code_navigation.mdx rename to docs/code-navigation/syntactic-code-navigation.mdx index 79860ce8b..d109d9bf4 100644 --- a/docs/code-navigation/syntactic_code_navigation.mdx +++ b/docs/code-navigation/syntactic-code-navigation.mdx @@ -9,7 +9,7 @@ Syntactic code navigation is a zero configuration feature that improves code navigation for certain languages in the absence of -[Precise code navigation](./precise_code_navigation) set up. It works by periodically indexing repositories for which it is [enabled](#enabling-syntactic-code-navigation), using high level syntax analysis heuristics. +[Precise code navigation](./precise-code-navigation) set up. It works by periodically indexing repositories for which it is [enabled](#enabling-syntactic-code-navigation), using high level syntax analysis heuristics. This mechanism is more robust than search-based navigation, but less powerful than Precise code navigation. When syntactic indexing data is available for a given file and repository, it will be selected over search-based navigation automatically, diff --git a/docs/code-navigation/troubleshooting.mdx b/docs/code-navigation/troubleshooting.mdx index c8979f985..3fa74214a 100644 --- a/docs/code-navigation/troubleshooting.mdx +++ b/docs/code-navigation/troubleshooting.mdx @@ -7,7 +7,7 @@ ## When are issues related to code intelligence? -Issues are related to Sourcegraph code navigation when the [indexer](/code-navigation/writing_an_indexer) is one that we build and maintain. +Issues are related to Sourcegraph code navigation when the [indexer](/code-navigation/writing-an-indexer) is one that we build and maintain. A customer issue should **definitely** be routed to code navigation if any of the following are true. diff --git a/docs/code-navigation/writing_an_indexer.mdx b/docs/code-navigation/writing-an-indexer.mdx similarity index 98% rename from docs/code-navigation/writing_an_indexer.mdx rename to docs/code-navigation/writing-an-indexer.mdx index 173454ed4..b7131e927 100644 --- a/docs/code-navigation/writing_an_indexer.mdx +++ b/docs/code-navigation/writing-an-indexer.mdx @@ -154,7 +154,7 @@ This table is maintained as an authoritative resource for users, Sales, and Cust Requires enabling and setting up Sourcegraph's auto-indexing feature. Read - more about [Auto-indexing](/code-navigation/auto_indexing). + more about [Auto-indexing](/code-navigation/auto-indexing). ### Status definitions @@ -196,21 +196,21 @@ We may lack the language expertise or bandwidth to implement certain features on @@ -90,7 +90,7 @@ Code Search main features include: - Narrow your search by repository and file pattern - Use [search contexts](/code-search/features#search-contexts) to search across a set of repositories at specific revisions - Curate [saved searches](/code-search/features#saved-searches) for yourself or your org -- Use [code monitoring](/code_monitoring/) to set up notifications for code changes that match a query +- Use [code monitoring](/code-monitoring/) to set up notifications for code changes that match a query - View [language statistics](/code-search/features#statistics) for search results diff --git a/docs/code-search/queries/index.mdx b/docs/code-search/queries/index.mdx index ff8e0fc94..4d0cfa43e 100644 --- a/docs/code-search/queries/index.mdx +++ b/docs/code-search/queries/index.mdx @@ -113,7 +113,7 @@ Returns results for files containing matches on the left _and_ right side of the | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `or`, `OR` | [`conf.Get( or log15.Error(`](https://sourcegraph.com/search?q=repo:%5Egithub%5C.com/sourcegraph/sourcegraph%24+conf.Get%28+or+log15.Error%28&patternType=regexp), [conf.Get( or log15.Error( or after ](https://sourcegraph.com/search?q=repo:%5Egithub%5C.com/sourcegraph/sourcegraph%24+conf.Get%28+or+log15.Error%28+or+after&patternType=regexp) | -Returns file content matching either on the left or right side, or both (set union). The number of results reports the number of matches of both strings. Note the regex or operator `|` may not work as expected with certain operators for example `file:(internal/repos)|(internal/gitserver)`, to receive the expected results use [subexpressions](/code-search/working/search_subexpressions), `(file:internal/repos or file:internal/gitserver)` +Returns file content matching either on the left or right side, or both (set union). The number of results reports the number of matches of both strings. Note the regex or operator `|` may not work as expected with certain operators for example `file:(internal/repos)|(internal/gitserver)`, to receive the expected results use [subexpressions](/code-search/working/search-subexpressions), `(file:internal/repos or file:internal/gitserver)` | **Operator** | **Example** | | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -149,7 +149,7 @@ To apply the scope of the `file` filter to the entire subexpression, fully group Browse the [search subexpressions - examples](/code-search/working/search_subexpressions) to learn more about + examples](/code-search/working/search-subexpressions) to learn more about use cases. diff --git a/docs/code-search/types/search-jobs.mdx b/docs/code-search/types/search-jobs.mdx index 440ebc071..1efb3cad9 100644 --- a/docs/code-search/types/search-jobs.mdx +++ b/docs/code-search/types/search-jobs.mdx @@ -28,7 +28,7 @@ To use Search Jobs, you need to: ## Search results format The downloaded results are formatted as [JSON lines](https://jsonlines.org). -The JSON objects have the same format as the (event-type) matches served by the [Stream API](/api/stream_api#event-types). +The JSON objects have the same format as the (event-type) matches served by the [Stream API](/api/stream-api#event-types). Here is an example of a JSON lines results file for a search job that ran the query `r:github.com/sourcegraph/sourcegraph handlePanic`. The search returned 4 results in 2 files: @@ -44,7 +44,7 @@ Search Jobs requires an object storage to store the results of your search jobs. By default, Search Jobs stores results using our bundled `blobstore` service. If the `blobstore` service is deployed, and you want to use it to store results from Search Jobs, you don't need to configure anything. -To use a third party managed object storage service, see instructions in [externalizing object storage](/self-hosted/external_services/object_storage#search-job-results). +To use a third party managed object storage service, see instructions in [externalizing object storage](/self-hosted/external-services/object-storage#search-job-results). ### Environment Variables diff --git a/docs/code-search/types/symbol.mdx b/docs/code-search/types/symbol.mdx index 6930c1886..18d9cf71f 100644 --- a/docs/code-search/types/symbol.mdx +++ b/docs/code-search/types/symbol.mdx @@ -24,7 +24,7 @@ Here is the query path for symbol searches: - **Zoekt**: if [indexed search](/admin/search#indexed-search) is enabled and the search is for the tip commit of an indexed branch, then Zoekt will service the query and it should respond quickly. Zoekt indexes the default branch (usually `master` or `main`) and can be configured for [multi-branch indexing](/code-search/features#multi-branch-indexing-experimental). The high commit frequency of monorepos reduces the likelihood that Zoekt will be able to respond to symbol searches. Zoekt **eagerly** indexes by listening to repository updates, whereas the searcher service **lazily** indexes the commit being searched. - **Searcher service with Rockskip enabled**: if [Rockskip](/code-navigation/rockskip) is enabled, it'll search for symbols stored in Postgres. After initial indexing, queries should be resolved quickly. -- **Searcher service with an index for the commit**: if the searcher service has already indexed this commit (i.e. someone has visited the commit before) then the query should be resolved quickly. Indexes are deleted in LRU fashion to remain under the configured maximum disk usage which [defaults to 100GB](/code-navigation/search_based_code_navigation#what-configuration-settings-can-i-apply). +- **Searcher service with an index for the commit**: if the searcher service has already indexed this commit (i.e. someone has visited the commit before) then the query should be resolved quickly. Indexes are deleted in LRU fashion to remain under the configured maximum disk usage which [defaults to 100GB](/code-navigation/search-based-code-navigation#what-configuration-settings-can-i-apply). - **Searcher service with an index for a different commit**: if the searcher service has already indexed a **different** commit in the same repository, then it will make a copy of the previous index on disk then run [ctags](https://github.com/universal-ctags/ctags#readme) on the files that changed between the two commits and update the symbols in the new index. This process takes roughly 20 seconds on a monorepo with 40M LOC and 400K files. - **Searcher service without any indexes (cold start)**: if the searcher service has never seen this repository before, then it needs to run ctags on all symbols and construct the index from scratch. This process takes roughly 20 minutes on a monorepo with 40M LOC and 400K files. diff --git a/docs/code-search/working/saved_searches.mdx b/docs/code-search/working/saved-searches.mdx similarity index 100% rename from docs/code-search/working/saved_searches.mdx rename to docs/code-search/working/saved-searches.mdx diff --git a/docs/code-search/working/search_contexts.mdx b/docs/code-search/working/search-contexts.mdx similarity index 100% rename from docs/code-search/working/search_contexts.mdx rename to docs/code-search/working/search-contexts.mdx diff --git a/docs/code-search/working/search_filters.mdx b/docs/code-search/working/search-filters.mdx similarity index 100% rename from docs/code-search/working/search_filters.mdx rename to docs/code-search/working/search-filters.mdx diff --git a/docs/code-search/working/search_subexpressions.mdx b/docs/code-search/working/search-subexpressions.mdx similarity index 100% rename from docs/code-search/working/search_subexpressions.mdx rename to docs/code-search/working/search-subexpressions.mdx diff --git a/docs/code_insights/explanations/index.mdx b/docs/code_insights/explanations/index.mdx deleted file mode 100644 index 5992a7892..000000000 --- a/docs/code_insights/explanations/index.mdx +++ /dev/null @@ -1,11 +0,0 @@ -# Explanations - -The following articles explain different parts of Sourcegraph Code Insights in depth: - -- [Administration and Security of Code Insights](/code_insights/explanations/administration_and_security_of_code_insights) -- [Automatically generated data series for version or pattern tracking](/code_insights/explanations/automatically_generated_data_series) -- [Code Insights filters](/code_insights/explanations/code_insights_filters) -- [Current limitations of Code Insights](/code_insights/explanations/current_limitations_of_code_insights) -- [Search-screen search results aggregations](/code_insights/explanations/search_results_aggregations) -- [Viewing code insights](/code_insights/explanations/viewing_code_insights) -- [Data retention](/code_insights/explanations/data_retention) diff --git a/docs/code_insights/how-tos/index.mdx b/docs/code_insights/how-tos/index.mdx deleted file mode 100644 index 42f8ea45f..000000000 --- a/docs/code_insights/how-tos/index.mdx +++ /dev/null @@ -1,7 +0,0 @@ -# How-tos - -The following is a list of how-tos that show how to use Code Insights. - -- [Creating a dashboard of Code Insights](/code_insights/how-tos/creating_a_custom_dashboard_of_code_insights) -- [Filtering an Insight](/code_insights/how-tos/filtering_an_insight) -- [Troubleshooting Code Insights](/code_insights/how-tos/Troubleshooting) diff --git a/docs/code_insights/references/index.mdx b/docs/code_insights/references/index.mdx deleted file mode 100644 index 39403e838..000000000 --- a/docs/code_insights/references/index.mdx +++ /dev/null @@ -1,11 +0,0 @@ -# References - -The following is a list of reference documents for Code Insights: - -- [Common use cases and recipes](/code_insights/references/common_use_cases) -- [Common reasons code insights may not match search results](/code_insights/references/common_reasons_code_insights_may_not_match_search_results) -- [Incomplete data points](/code_insights/references/incomplete_data_points) -- [Licensing and limited access](/code_insights/references/license) -- [Managing code insights with the API](/api/graphql/managing-code-insights-with-api) -- [Requirements](/code_insights/references/requirements) -- [Code Insight repository scope](/code_insights/references/repository_scope) diff --git a/docs/cody/capabilities/supported-models.mdx b/docs/cody/capabilities/supported-models.mdx index e8f45bfa3..90bfbb2e7 100644 --- a/docs/cody/capabilities/supported-models.mdx +++ b/docs/cody/capabilities/supported-models.mdx @@ -53,7 +53,7 @@ Cody supports a variety of cutting-edge large language models for use in chat an Site admins can configure vision support using the [`chatVision` - setting](/admin/config/site_config) in site configuration and by adding the + setting](/admin/config/site-config) in site configuration and by adding the `vision` capability to model configurations. See [Model Configuration](/cody/enterprise/model-configuration) for more details. diff --git a/docs/cody/prompts-guide.mdx b/docs/cody/prompts-guide.mdx index 75008a37f..70092aaf8 100644 --- a/docs/cody/prompts-guide.mdx +++ b/docs/cody/prompts-guide.mdx @@ -104,7 +104,7 @@ You can learn more about context [here](/cody/core-concepts/context). @-mention local and current repositories are only available if you have your repository indexed. Enterprise and Enterprise Starter users can request their admins to add their local project for indexing to get access to @-mention context. -Repository indexing is only available to supported [Code Hosts](https://sourcegraph.com/docs/admin/code_hosts), please reach out to your admins if you require assistance with indexing. +Repository indexing is only available to supported [Code Hosts](https://sourcegraph.com/docs/admin/code-hosts), please reach out to your admins if you require assistance with indexing. ## Selecting the right LLM diff --git a/docs/dotcom/index.mdx b/docs/dotcom/index.mdx index d89cef788..dc69b5437 100644 --- a/docs/dotcom/index.mdx +++ b/docs/dotcom/index.mdx @@ -4,7 +4,7 @@ To use Sourcegraph on your own (private) code, [use Sourcegraph Cloud](/cloud/) or [deploy self-hosted Sourcegraph](/self-hosted/deploy/). -- [Indexing open source code in Sourcegraph.com](/dotcom/indexing_open_source_code) +- [Indexing open source code in Sourcegraph.com](/dotcom/indexing-open-source-code) > Note: Sourcegraph.com is a special instance of Sourcegraph with some different behavior compared to that on Sourcegraph Cloud and self-hosted instances. If you're curious about the differences, search our codebase for [`envvar.SourcegraphDotComMode()`](https://sourcegraph.com/search?q=context:global+repo:%5Egithub%5C.com/sourcegraph/sourcegraph%24+envvar.SourcegraphDotComMode%28%29&patternType=keyword). > diff --git a/docs/dotcom/indexing_open_source_code.mdx b/docs/dotcom/indexing-open-source-code.mdx similarity index 100% rename from docs/dotcom/indexing_open_source_code.mdx rename to docs/dotcom/indexing-open-source-code.mdx diff --git a/docs/getting-started/cloud-instance.mdx b/docs/getting-started/cloud-instance.mdx index e814f658e..53ee69666 100644 --- a/docs/getting-started/cloud-instance.mdx +++ b/docs/getting-started/cloud-instance.mdx @@ -8,12 +8,12 @@ Sourcegraph is nothing without your code, so connecting your code hosts is cruci How to connect to… -- [GitHub](/admin/code_hosts/github) -- [GitLab](/admin/code_hosts/gitlab) -- [Bitbucket Cloud](/admin/code_hosts/bitbucket_cloud) -- [Bitbucket Server / Bitbucket Data Center](/admin/code_hosts/bitbucket_server) -- [Other Git code hosts (using a Git URL)](/admin/code_hosts/other) -- [Non git hosts](/admin/code_hosts) +- [GitHub](/admin/code-hosts/github) +- [GitLab](/admin/code-hosts/gitlab) +- [Bitbucket Cloud](/admin/code-hosts/bitbucket-cloud) +- [Bitbucket Server / Bitbucket Data Center](/admin/code-hosts/bitbucket-server) +- [Other Git code hosts (using a Git URL)](/admin/code-hosts/other) +- [Non git hosts](/admin/code-hosts) ## Inviting users and SSO diff --git a/docs/getting-started/github-vs-sourcegraph.mdx b/docs/getting-started/github-vs-sourcegraph.mdx index df96e704c..107639077 100644 --- a/docs/getting-started/github-vs-sourcegraph.mdx +++ b/docs/getting-started/github-vs-sourcegraph.mdx @@ -38,7 +38,7 @@ Sourcegraph integrates with multiple code hosts to provide universal code search - Bitbucket Cloud and Bitbucket Server / Bitbucket Data Center - Perforce -You can also integrate Sourcegraph with other Git-based code hosts using [these](/admin/code_hosts/other) instructions or use the [Sourcegraph CLI (src)](/admin/code_hosts/src_serve_git) to load local repositories without a code host into Sourcegraph. Sourcegraph is continuously adding [Tier 1](/admin/code_hosts) support for additional code hosts. +You can also integrate Sourcegraph with other Git-based code hosts using [these](/admin/code-hosts/other) instructions or use the [Sourcegraph CLI (src)](/admin/code-hosts/src-serve-git) to load local repositories without a code host into Sourcegraph. Sourcegraph is continuously adding [Tier 1](/admin/code-hosts) support for additional code hosts. @@ -111,7 +111,7 @@ GitHub code search supports searching across issues, pull requests, and discussi Sourcegraph allows you to search both indexed and unindexed code. Sourcegraph’s [current limitations](/admin/search) on indexed code are: -- Files larger than 1 MB are excluded unless you explicitly specify them in [search.largeFiles](/admin/config/site_config#search-largeFile) to be indexed and searched regardless of size +- Files larger than 1 MB are excluded unless you explicitly specify them in [search.largeFiles](/admin/config/site-config#search-largeFile) to be indexed and searched regardless of size - Binary files are excluded - Files other than UTF-8 are excluded @@ -166,9 +166,9 @@ Sourcegraph’s [symbol search](/code-navigation/features#symbol-search) is avai GitHub only returns the first 10 pages of search results. You cannot currently go past the 10th page or retrieve all search results. -Sourcegraph can retrieve all search results. By default, Sourcegraph returns 500 search results, but this number can be increased by increasing the ‘count’ value. Sourcegraph can display a maximum of 1,500 results, but all matches can be fetched using the [src CLI](/cli/quickstart), the [Stream API](/api/stream_api), or [GraphQL API](/api/graphql). You can also export the results via CSV. +Sourcegraph can retrieve all search results. By default, Sourcegraph returns 500 search results, but this number can be increased by increasing the ‘count’ value. Sourcegraph can display a maximum of 1,500 results, but all matches can be fetched using the [src CLI](/cli/quickstart), the [Stream API](/api/stream-api), or [GraphQL API](/api/graphql). You can also export the results via CSV. -GitHub code search includes suggestions, completions, and the ability to save your searches. Sourcegraph offers suggestions through search query examples and [saved searches](/code-search/working/saved_searches#creating-saved-searches). +GitHub code search includes suggestions, completions, and the ability to save your searches. Sourcegraph offers suggestions through search query examples and [saved searches](/code-search/working/saved-searches#creating-saved-searches). GitHub code search returns a list of repositories and files. Sourcegraph results can include repositories, files, diffs, commits, and symbols; however, you must use the ‘type’ filter to return anything outside of repositories and files. @@ -201,7 +201,7 @@ When submitting a search query, the quality of a match is scored based on langua To help you understand and refine search results, Sourcegraph’s search results also include visual search aggregation charts. These charts help you answer unique questions about the overall results set that individual search results cannot, like how many different versions of a library or package are present in your code, which repositories in a given library are most used, and more. They can also help you quickly refine your search by seeing which files, repositories, authors, or capture group returned the most results, and then clicking a result in the chart to add a filter to your query. -You can group your search results by location (repository or file), author, or arbitrary capture group pattern. Example search aggregations can be found [here](/code_insights/references/search_aggregations_use_cases). +You can group your search results by location (repository or file), author, or arbitrary capture group pattern. Example search aggregations can be found [here](/code-insights/references/search-aggregations-use-cases). GitHub code search does not currently offer this functionality. @@ -221,7 +221,7 @@ Search contexts are an alternative way to narrow down the scope of your search t You can create custom search contexts to be simple or advanced with GitHub. Simple search contexts are things such as repository or organization name, and advanced search contexts can mix multiple attributes, including languages. GitHub’s search contexts allow for more personalization than Sourcegraph. -With Sourcegraph, a [search context](/code-search/working/search_contexts) represents the body of code that will be searched. Search contexts can be private to the user who creates it or shared with other users on the same Sourcegraph instance. [Query-based ](/code-search/working/search_contexts#beta-query-based-search-contexts)search contexts (beta) are an additional way to create search contexts based on variables like repository, rev, file, lang, case, fork, and visibility. Both [OR] and [AND] expressions are allowed to help further narrow the scope of query-based search contexts. +With Sourcegraph, a [search context](/code-search/working/search-contexts) represents the body of code that will be searched. Search contexts can be private to the user who creates it or shared with other users on the same Sourcegraph instance. [Query-based ](/code-search/working/search-contexts#beta-query-based-search-contexts)search contexts (beta) are an additional way to create search contexts based on variables like repository, rev, file, lang, case, fork, and visibility. Both [OR] and [AND] expressions are allowed to help further narrow the scope of query-based search contexts. | **Features** | **GitHub** | **Sourcegraph** | | --------------- | ----------------------- | ------------------------------------ | @@ -236,12 +236,12 @@ With Sourcegraph, a [search context](/code-search/working/search_contexts) repre Both GitHub and Sourcegraph offer out-of-the-box, search-based code navigation. This version of code navigation uses search-based heuristics to find references and definitions across a codebase without any setup required. It is powerful and convenient, but it can sometimes present inaccurate results. For example, it can return false positive references for symbols with common names. It is limited to returning definitions and references within a single repository (it won’t track references across multiple repositories). -GitHub’s [search-based code navigation](https://docs.github.com/en/repositories/working-with-files/using-files/navigating-code-on-github) officially supports 10 languages according to the documentation, but more languages are supported in the latest beta preview. Sourcegraph’s [search-based code navigation](/code-navigation/search_based_code_navigation) supports 40 languages. +GitHub’s [search-based code navigation](https://docs.github.com/en/repositories/working-with-files/using-files/navigating-code-on-github) officially supports 10 languages according to the documentation, but more languages are supported in the latest beta preview. Sourcegraph’s [search-based code navigation](/code-navigation/search-based-code-navigation) supports 40 languages. | **Features** | **GitHub** | **Sourcegraph** | | ------------------------ | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | Technical implementation | Heuristic-based | Heuristic-based | -| Language support | 10 languages (C#, CodeQL, Elixir, Go, Java, JavaScript,TypeScript, PHP, Python, Ruby) | 40 languages (The full list of supported languages can be found [here](/code-navigation/search_based_code_navigation)) | +| Language support | 10 languages (C#, CodeQL, Elixir, Go, Java, JavaScript,TypeScript, PHP, Python, Ruby) | 40 languages (The full list of supported languages can be found [here](/code-navigation/search-based-code-navigation)) | | Setup | No setup required | No setup required | | Accuracy | Moderate (some false positives) | Moderate (some false positives) | | Cross-repository | ✗ | ✗ | @@ -252,11 +252,11 @@ GitHub and Sourcegraph both offer precise code navigation as well. Despite havin GitHub’s [precise code navigation](https://docs.github.com/en/repositories/working-with-files/using-files/navigating-code-on-github#precise-and-search-based-navigation) is an improved form of heuristic-based code navigation which uses syntax trees to offer higher accuracy for references and definitions and cross-repository navigation. It is more accurate than GitHub’s search-based code navigation, but it can still present inaccuracies. It is available out-of-the-box on GitHub and is automatically used over search-based code navigation when available. It is supported for 1 language, Python. -Sourcegraph’s [precise code navigation](/code-navigation/precise_code_navigation) is not heuristic-based. Instead, it uses SCIP and LSIF data to deliver precomputed code navigation, meaning that it is fast and compiler-accurate. It is the only 100% accurate solution for code navigation between Sourcegraph’s and GitHub’s offerings. +Sourcegraph’s [precise code navigation](/code-navigation/precise-code-navigation) is not heuristic-based. Instead, it uses SCIP and LSIF data to deliver precomputed code navigation, meaning that it is fast and compiler-accurate. It is the only 100% accurate solution for code navigation between Sourcegraph’s and GitHub’s offerings. Because precise code navigation uses code graph (SCIP) data, it is not susceptible to false positives or other potential errors (such as those caused by symbols with the same name). It also supports cross-repository navigation, which shows symbol usage across repositories and [transitive dependencies](/code-navigation/features#beta-dependency-navigation). It also has a unique feature, “Find implementations,” which allows you to navigate to a symbol’s interface definition or find all the places an interface is being implemented. -Sourcegraph’s precise code navigation is opt-in and requires you to upload code graph data (LSIF or SCIP) to Sourcegraph. This data can be automatically generated and uploaded to Sourcegraph via [auto-indexing](/code-navigation/auto_indexing). For repositories without SCIP or LSIF data, Sourcegraph automatically falls back to search-based code navigation. +Sourcegraph’s precise code navigation is opt-in and requires you to upload code graph data (LSIF or SCIP) to Sourcegraph. This data can be automatically generated and uploaded to Sourcegraph via [auto-indexing](/code-navigation/auto-indexing). For repositories without SCIP or LSIF data, Sourcegraph automatically falls back to search-based code navigation. Sourcegraph’s precise code navigation supports 11 languages. @@ -265,7 +265,7 @@ Sourcegraph’s precise code navigation supports 11 languages. | Technical implementation | Heuristic-based | SCIP-based (code graph data) | | Accuracy | High (some false positives) | Perfect (compiler-accurate) | | Language support | 1 language (Python) | 11 languages (Go, TypeScript, JavaScript, C, C++, Java, Scala, Kotlin, Rust, Python, Ruby) | -| Setup | No setup required | Opt-in (Must set up LSIF/SCIP indexing. [Auto-indexing](/code-navigation/auto_indexing) available.) | +| Setup | No setup required | Opt-in (Must set up LSIF/SCIP indexing. [Auto-indexing](/code-navigation/auto-indexing) available.) | | Cross-repository | ✓ | ✓ | ## Codebase insights and analytics @@ -276,7 +276,7 @@ GitHub and Sourcegraph have offerings that are called “insights,” but they d GitHub does not offer comprehensive insights that account for the content of the code itself. Rather, GitHub’s insights are based primarily on GitHub’s product-level data. GitHub offers [dependency insights](https://docs.github.com/en/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-dependency-insights-in-your-enterprise) that show all the packages your organization’s repositories depend on, e.g. aggregated information about security advisories and licenses. -[Sourcegraph’s Code Insights](/code_insights) is based on codebase-level data: aggregation of lines, patterns, and other search targets in the codebase. It reveals high-level information about the entire codebase, accounting for all of your repositories and code hosts. With Code Insights, you can track anything that can be expressed with a Sourcegraph search query and turn it into customizable dashboards. Code Insights can be used to track migrations, package use, version adoption, code smells, vulnerability remediation, codebase size, and more. +[Sourcegraph’s Code Insights](/code-insights) is based on codebase-level data: aggregation of lines, patterns, and other search targets in the codebase. It reveals high-level information about the entire codebase, accounting for all of your repositories and code hosts. With Code Insights, you can track anything that can be expressed with a Sourcegraph search query and turn it into customizable dashboards. Code Insights can be used to track migrations, package use, version adoption, code smells, vulnerability remediation, codebase size, and more. ### App activity insights @@ -304,11 +304,11 @@ With Sourcegraph’s [Batch Changes](/batch-changes), you can make any large-sca Both GitHub and Sourcegraph offer integrations to help optimize your workflow. GitHub’s owned integrations are built and managed by GitHub, and they have a marketplace with nearly a thousand third-party applications spanning across categories such as code quality, code review, IDEs, monitoring, security, and more. These integrations are available for GitHub overall, but there aren’t any integrations related to GitHub code search. For example, the [VS Code integration](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github) allows you to review and manage pull requests, but it does not let you use GitHub code search in VS Code. -Sourcegraph’s [editor integrations](/integration/editor) let you search and navigate across all of your repositories from all your code hosts and across all GitHub instances and organizations without leaving your IDE. Sourcegraph currently integrates with VS Code, JetBrains IDEs, and Gitpod. You can also add Sourcegraph to your preferred [browser](/integration/browser_extension/how-tos/browser_search_engine) to quickly search across your entire codebase from within your browser. +Sourcegraph’s [editor integrations](/integration/editor) let you search and navigate across all of your repositories from all your code hosts and across all GitHub instances and organizations without leaving your IDE. Sourcegraph currently integrates with VS Code, JetBrains IDEs, and Gitpod. You can also add Sourcegraph to your preferred [browser](/integration/browser-extension/how-tos/browser-search-engine) to quickly search across your entire codebase from within your browser. ### API -GitHub has a REST API for web clients, but it is not yet documented. On the other hand, Sourcegraph offers different APIs that help you access code-related data available on a Sourcegraph instance. The [GraphQL API](/api/graphql) accesses data stored and computed by Sourcegraph. This API can [fetch](/api/graphql/examples) file contents without cloning a repository or search for a new API and determine all of the repositories that haven’t migrated to it yet. The [Stream API](/api/stream_api) supports consuming search results as a stream of events and it can be used to [search](/api/stream_api#example-curl) over all indexed repositories. Lastly, use the [interactive API explorer](https://sourcegraph.com/api/console#%7B%22query%22%3A%22%23%20Type%20queries%20here%2C%20with%20completion%2C%20validation%2C%20and%20hovers.%5Cn%23%5Cn%23%20Here's%20an%20example%20query%20to%20get%20you%20started%3A%5Cn%5Cnquery%20%7B%5Cn%20%20currentUser%20%7B%5Cn%20%20%20%20username%5Cn%20%20%7D%5Cn%20%20repositories%28first%3A%201%29%20%7B%5Cn%20%20%20%20nodes%20%7B%5Cn%20%20%20%20%20%20name%5Cn%20%20%20%20%7D%5Cn%20%20%7D%5Cn%7D%5Cn%22%7D) to build and test your API queries. +GitHub has a REST API for web clients, but it is not yet documented. On the other hand, Sourcegraph offers different APIs that help you access code-related data available on a Sourcegraph instance. The [GraphQL API](/api/graphql) accesses data stored and computed by Sourcegraph. This API can [fetch](/api/graphql/examples) file contents without cloning a repository or search for a new API and determine all of the repositories that haven’t migrated to it yet. The [Stream API](/api/stream-api) supports consuming search results as a stream of events and it can be used to [search](/api/stream-api#example-curl) over all indexed repositories. Lastly, use the [interactive API explorer](https://sourcegraph.com/api/console#%7B%22query%22%3A%22%23%20Type%20queries%20here%2C%20with%20completion%2C%20validation%2C%20and%20hovers.%5Cn%23%5Cn%23%20Here's%20an%20example%20query%20to%20get%20you%20started%3A%5Cn%5Cnquery%20%7B%5Cn%20%20currentUser%20%7B%5Cn%20%20%20%20username%5Cn%20%20%7D%5Cn%20%20repositories%28first%3A%201%29%20%7B%5Cn%20%20%20%20nodes%20%7B%5Cn%20%20%20%20%20%20name%5Cn%20%20%20%20%7D%5Cn%20%20%7D%5Cn%7D%5Cn%22%7D) to build and test your API queries. | **Features** | **GitHub** | **Sourcegraph** | | --------------------------------------- | ------------------------------------------------------------------------------------------------ | ---------------------------------------------- | @@ -325,7 +325,7 @@ Code scanning is applied at the repository level and can be used to alert on bot GitHub also offers [Dependabot alerts](https://docs.github.com/en/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts). Dependabot detects insecure dependencies of repositories and triggers alerts when a new advisory is added to the [GitHub Advisory Database](https://docs.github.com/en/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/browsing-security-advisories-in-the-github-advisory-database) or the [dependency graph](https://docs.github.com/en/enterprise-cloud@latest/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph) for a repository changes. GitHub can also review and alert on dependency changes in pull requests made against the default branch of a repository. These alerts are viewable by admins in each repository, and admins can make them viewable to other users as well. These alerts can be sent to you via several channels: email, web interface, command line, and/or GitHub Mobile. -Sourcegraph offers [code monitors](/code_monitoring), which continuously monitor the results of a specific search query and generate alerts when new results are returned. Code monitors only look at merged code, and they can be used to trigger alerts when undesirable code is added to a codebase. This can include known vulnerabilities, bad patterns, file changes, or consumption of deprecated endpoints (anything that can be queried via Sourcegraph). +Sourcegraph offers [code monitors](/code-monitoring), which continuously monitor the results of a specific search query and generate alerts when new results are returned. Code monitors only look at merged code, and they can be used to trigger alerts when undesirable code is added to a codebase. This can include known vulnerabilities, bad patterns, file changes, or consumption of deprecated endpoints (anything that can be queried via Sourcegraph). Each code monitor can span any scope of your choosing, such as a single repository, multiple repositories, or multiple code hosts. They can also be scoped to specific branches of a repository. Code monitor alerts can be configured to send notifications via email, Slack message, or webhook. Most queries used for a code monitor can also be reused for a Code Insights chart or a fix with Batch Changes. diff --git a/docs/getting-started/index.mdx b/docs/getting-started/index.mdx index 7411e8011..e8a75a7e6 100644 --- a/docs/getting-started/index.mdx +++ b/docs/getting-started/index.mdx @@ -51,7 +51,7 @@ Sourcegraph's main features are: ## How do I start using Sourcegraph? 1. [Deploy and Configure Sourcegraph](/self-hosted/deploy/) inside your organization on your internal code if nobody else has yet -1. Install and configure the [web browser code host integrations](/integration/browser_extension) (recommended) +1. Install and configure the [web browser code host integrations](/integration/browser-extension) (recommended) 1. Start searching and browsing code on Sourcegraph by visiting the URL of your organization's internal Sourcegraph instance 1. [Personalize Sourcegraph](/getting-started/personalization/) with themes, quick links, and badges! @@ -74,7 +74,7 @@ Sourcegraph code search is fast, works across all your repositories at any commi - [Commit message search](/code-search/features#commit-message-search) - [Saved search scopes](/code-search/features#search-scopes) - [Search contexts to search across a set of repositories at specific revisions](/code-search/features#search-contexts) -- [Saved search monitoring](/code_monitoring/) +- [Saved search monitoring](/code-monitoring/) Read the [code search documentation](/code-search/) to learn more and discover the complete feature set. Here's a video to help you get started: @@ -134,7 +134,7 @@ Read the [batch changes documentation](/batch-changes/) to learn more, including Sourcegraph lets you understand and analyze code trends by visualizing how the codebase changes. Measure and act on engineering goals such as migration and component deprecation. -Read the [code insights documentation](/code_insights/) to learn more, including helpful how-to guides. +Read the [code insights documentation](/code-insights/) to learn more, including helpful how-to guides. ## Integrations @@ -146,4 +146,4 @@ Sourcegraph's editor integrations allow you to search and navigate across all of ### Browser extension -Our browser extension directly adds code navigation within your code hosts (GitHub, GitLab, Bitbucket, and Phabricator) via Chrome, Safari, and Firefox browsers. Learn more about how to set up the browser extension [here](/integration/browser_extension/). +Our browser extension directly adds code navigation within your code hosts (GitHub, GitLab, Bitbucket, and Phabricator) via Chrome, Safari, and Firefox browsers. Learn more about how to set up the browser extension [here](/integration/browser-extension/). diff --git a/docs/integration/aws_codecommit.mdx b/docs/integration/aws-codecommit.mdx similarity index 73% rename from docs/integration/aws_codecommit.mdx rename to docs/integration/aws-codecommit.mdx index 39ab13895..46eb9ef9b 100644 --- a/docs/integration/aws_codecommit.mdx +++ b/docs/integration/aws-codecommit.mdx @@ -4,13 +4,13 @@ You can use Sourcegraph with Git repositories hosted on [AWS CodeCommit](https:/ | Feature | Supported? | | ------------------------------------------------------ | ---------- | -| [Repository syncing](/admin/code_hosts/aws_codecommit) | ✅ | -| [Browser extension](/integration/browser_extension) | ❌ | +| [Repository syncing](/admin/code-hosts/aws-codecommit) | ✅ | +| [Browser extension](/integration/browser-extension) | ❌ | ## Repository syncing -Site admins can [add AWS CodeCommit repositories to Sourcegraph](/admin/code_hosts/aws_codecommit). +Site admins can [add AWS CodeCommit repositories to Sourcegraph](/admin/code-hosts/aws-codecommit). ## Browser extension -The [Sourcegraph browser extension](/integration/browser_extension) does not yet support AWS CodeCommit. This means that you won't get hovers, go-to-definition, and find-references from Sourcegraph when viewing your code on AWS CodeCommit's web interface. +The [Sourcegraph browser extension](/integration/browser-extension) does not yet support AWS CodeCommit. This means that you won't get hovers, go-to-definition, and find-references from Sourcegraph when viewing your code on AWS CodeCommit's web interface. diff --git a/docs/integration/bitbucket_cloud.mdx b/docs/integration/bitbucket-cloud.mdx similarity index 83% rename from docs/integration/bitbucket_cloud.mdx rename to docs/integration/bitbucket-cloud.mdx index 679674ab1..4a6dfce1d 100644 --- a/docs/integration/bitbucket_cloud.mdx +++ b/docs/integration/bitbucket-cloud.mdx @@ -4,16 +4,16 @@ You can use Sourcegraph with Git repositories hosted on [Bitbucket Cloud](https: | Feature | Supported? | | ---------------------------------------------------------------------------------- | --------------------------------- | -| [Repository syncing](/admin/code_hosts/bitbucket_cloud) | ✅ | -| [Repository permissions](/admin/code_hosts/bitbucket_cloud#repository-permissions) | ✅ | +| [Repository syncing](/admin/code-hosts/bitbucket-cloud) | ✅ | +| [Repository permissions](/admin/code-hosts/bitbucket-cloud#repository-permissions) | ✅ | | Browser extension | ✅ | | Native extension | ❌ Not supported on Bitbucket.org | ## Repository syncing -Site admins can [add Bitbucket Cloud repositories to Sourcegraph](/admin/code_hosts/bitbucket_cloud). +Site admins can [add Bitbucket Cloud repositories to Sourcegraph](/admin/code-hosts/bitbucket-cloud). ## User authorization Site admins can [add Bitbucket Cloud as an authentication provider to Sourcegraph](/admin/auth#bitbucket-cloud). -This will allow users to sign into Sourcegraph using their Bitbucket Cloud accounts. Site admins can then also [enable repository permissions](/admin/code_hosts/bitbucket_cloud#repository-permissions) on their Bitbucket Cloud code host connections. +This will allow users to sign into Sourcegraph using their Bitbucket Cloud accounts. Site admins can then also [enable repository permissions](/admin/code-hosts/bitbucket-cloud#repository-permissions) on their Bitbucket Cloud code host connections. diff --git a/docs/integration/bitbucket_server.mdx b/docs/integration/bitbucket-server.mdx similarity index 93% rename from docs/integration/bitbucket_server.mdx rename to docs/integration/bitbucket-server.mdx index f36921620..9c806e9e6 100644 --- a/docs/integration/bitbucket_server.mdx +++ b/docs/integration/bitbucket-server.mdx @@ -4,19 +4,19 @@ You can use Sourcegraph with Git repositories hosted on [Bitbucket Server](https | Feature | Supported? | | ----------------------------------------------------------------------------------- | ---------- | -| [Repository syncing](/admin/code_hosts/bitbucket_server) | ✅ | -| [Webhooks](/admin/code_hosts/bitbucket_server#webhooks) | ✅ | -| [Repository permissions](/admin/code_hosts/bitbucket_server#repository-permissions) | ✅ | +| [Repository syncing](/admin/code-hosts/bitbucket-server) | ✅ | +| [Webhooks](/admin/code-hosts/bitbucket-server#webhooks) | ✅ | +| [Repository permissions](/admin/code-hosts/bitbucket-server#repository-permissions) | ✅ | | [Sourcegraph Bitbucket Server plugin](#sourcegraph-bitbucket-server-plugin) | ✅ | | [Browser extension](#browser-extension) | ✅ | ## Repository syncing -Site admins can [add Bitbucket Server / Bitbucket Data Center repositories to Sourcegraph](/admin/code_hosts/bitbucket_server). +Site admins can [add Bitbucket Server / Bitbucket Data Center repositories to Sourcegraph](/admin/code-hosts/bitbucket-server). ## Repository permissions -Site admins can [configure Sourcegraph to respect Bitbucket Server / Bitbucket Data Center's repository access permissions](/admin/code_hosts/bitbucket_server#repository-permissions). +Site admins can [configure Sourcegraph to respect Bitbucket Server / Bitbucket Data Center's repository access permissions](/admin/code-hosts/bitbucket-server#repository-permissions). ## Sourcegraph Bitbucket Plugin @@ -29,7 +29,7 @@ We recommend installing the Sourcegraph Bitbucket plugin which adds the followin Install the Sourcegraph plugin for Bitbucket from the [Atlassian Marketplace](https://marketplace.atlassian.com/apps/1231975/sourcegraph-for-bitbucket?tab=overview&hosting=datacenter) or see the [bitbucket-server-plugin](https://github.com/sourcegraph/bitbucket-server-plugin) repository for instructions on how to manually install the plugin on your Bitbucket Server / Bitbucket Data Center instance. -For the Bitbucket Server plugin to then communicate with the Sourcegraph instance, the Sourcegraph site configuration must be updated to include the [`corsOrigin` property](/admin/config/site_config) with the Bitbucket Server / Bitbucket Data Center URL +For the Bitbucket Server plugin to then communicate with the Sourcegraph instance, the Sourcegraph site configuration must be updated to include the [`corsOrigin` property](/admin/config/site-config) with the Bitbucket Server / Bitbucket Data Center URL ```json { @@ -73,7 +73,7 @@ When the Sourcegraph instance connected to the Bitbucket Server plugin is update Once the plugin is installed, go to **Administration > Add-ons > Sourcegraph** to see a list of all configured webhooks and to create a new one. -To configure a webhook, follow [these steps](/admin/code_hosts/bitbucket_server#webhooks). +To configure a webhook, follow [these steps](/admin/code-hosts/bitbucket-server#webhooks). Disabling the webhook is as easy as removing the `"webhooks"` property from the `"plugin"` section and deleting the webhook pointing to your Sourcegraph instance under **Administration > Add-ons > Sourcegraph**. @@ -83,7 +83,7 @@ Disabling the webhook is as easy as removing the `"webhooks"` property from the The plugin also supports an optional method of faster ACL permissions syncing that aims to improve the speed of fetching a user's permissions from Bitbucket (which can reduce the time a user has to wait to run a search if their permissions data has expired). -You can enable this feature when [configuring the connection to your Bitbucket Server / Bitbucket Data Center instance on Sourcegraph](/admin/code_hosts/bitbucket_server#repository-permissions). For more information on when permissions are fetched, how long they're cached and how to configure that behavior, see our documentation on [Repository permissions](/admin/permissions/). +You can enable this feature when [configuring the connection to your Bitbucket Server / Bitbucket Data Center instance on Sourcegraph](/admin/code-hosts/bitbucket-server#repository-permissions). For more information on when permissions are fetched, how long they're cached and how to configure that behavior, see our documentation on [Repository permissions](/admin/permissions/). The speed improvements are most important on larger Bitbucket Server / Bitbucket Data Center instances with thousands of repositories. When connected to these instances, Sourcegraph would have to make many wasteful requests to fetch permission data if the plugin is not installed. @@ -109,11 +109,11 @@ Once the plugin is installed it registers an asynchronous listener (see [`Webhoo In order to persist the configured webhooks across restarts of the Bitbucket Server / Bitbucket Data Center instance the plugin uses the [Active Objects ORM](https://developer.atlassian.com/server/framework/atlassian-sdk/active-objects/) of the Atlassian SDK. It registers two Active Objects: [`WebhookEntity` and `EventEntity`](https://github.com/sourcegraph/bitbucket-server-plugin/blob/94e4be96b57286429cc543205164586af03e9b9b/src/main/resources/atlassian-plugin.xml#L10-L14). -If Sourcegraph is configured to make use of the Bitbucket Server plugin webhooks (which is done by setting the [`"plugin.webhooks"` property in the Bitbucket Server / Bitbucket Data Center configuration](/admin/code_hosts/bitbucket_server#webhooks)), it sends a request to the Bitbucket Server / Bitbucket Data Center instance, every minute, to make sure that a webhook on the Bitbucket Server / Bitbucket Data Center instance exists and points to the Sourcegraph instance. +If Sourcegraph is configured to make use of the Bitbucket Server plugin webhooks (which is done by setting the [`"plugin.webhooks"` property in the Bitbucket Server / Bitbucket Data Center configuration](/admin/code-hosts/bitbucket-server#webhooks)), it sends a request to the Bitbucket Server / Bitbucket Data Center instance, every minute, to make sure that a webhook on the Bitbucket Server / Bitbucket Data Center instance exists and points to the Sourcegraph instance. #### Fast permission syncing -When Sourcegraph is configured to use [Bitbucket Server / Bitbucket Data Center's repository permissions](/admin/code_hosts/bitbucket_server#repository-permissions) to control access to repositories on Sourcegraph, it needs to fetch permissions for each user. +When Sourcegraph is configured to use [Bitbucket Server / Bitbucket Data Center's repository permissions](/admin/code-hosts/bitbucket-server#repository-permissions) to control access to repositories on Sourcegraph, it needs to fetch permissions for each user. The Bitbucket Server / Bitbucket Data Center REST API only provides **paginated** endpoints to fetch either the list of repositories a given user has access to, or the list of users that have access to a given repository. Both endpoints return the **full representation of the entities**. @@ -140,10 +140,10 @@ The plugin uses `RepositoryService`, `UserManager`, `UserService` and `SecurityS ## Browser extension -The [Sourcegraph browser extension](/integration/browser_extension) supports Bitbucket Server / Bitbucket Data Center. When installed in your web browser, it adds hover tooltips, go-to-definition, find-references, and code search to files and pull requests viewed on Bitbucket Server / Bitbucket Data Center. +The [Sourcegraph browser extension](/integration/browser-extension) supports Bitbucket Server / Bitbucket Data Center. When installed in your web browser, it adds hover tooltips, go-to-definition, find-references, and code search to files and pull requests viewed on Bitbucket Server / Bitbucket Data Center. -1. Install the [Sourcegraph browser extension](/integration/browser_extension). -1. [Configure the browser extension](/integration/browser_extension#configuring-the-sourcegraph-instance-to-use) to use your Sourcegraph instance. +1. Install the [Sourcegraph browser extension](/integration/browser-extension). +1. [Configure the browser extension](/integration/browser-extension#configuring-the-sourcegraph-instance-to-use) to use your Sourcegraph instance. 1. To allow the browser extension to work on your Bitbucket Server / Bitbucket Data Center instance: - Navigate to any page on Bitbucket Server / Bitbucket Data Center. - Right-click the Sourcegraph icon in the browser extension toolbar. diff --git a/docs/integration/browser_extension/how-tos/browser_search_engine.mdx b/docs/integration/browser-extension/how-tos/browser-search-engine.mdx similarity index 98% rename from docs/integration/browser_extension/how-tos/browser_search_engine.mdx rename to docs/integration/browser-extension/how-tos/browser-search-engine.mdx index 28e8c52f9..4a685841c 100644 --- a/docs/integration/browser_extension/how-tos/browser_search_engine.mdx +++ b/docs/integration/browser-extension/how-tos/browser-search-engine.mdx @@ -10,7 +10,7 @@ You can add Sourcegraph as a browser search engine to quickly search Sourcegraph ### With the Sourcegraph browser extension (recommended) -The easiest way is to install the [Sourcegraph browser extension](/integration/browser_extension/quickstart), which automatically configures the location bar `src` shortcut to search Sourcegraph. +The easiest way is to install the [Sourcegraph browser extension](/integration/browser-extension/quickstart), which automatically configures the location bar `src` shortcut to search Sourcegraph. ### Google Chrome diff --git a/docs/integration/browser_extension/how-tos/google_workspace.mdx b/docs/integration/browser-extension/how-tos/google-workspace.mdx similarity index 98% rename from docs/integration/browser_extension/how-tos/google_workspace.mdx rename to docs/integration/browser-extension/how-tos/google-workspace.mdx index 2dfe60d95..5767cd086 100644 --- a/docs/integration/browser_extension/how-tos/google_workspace.mdx +++ b/docs/integration/browser-extension/how-tos/google-workspace.mdx @@ -6,7 +6,7 @@ You can install and preconfigure the Sourcegraph Chrome extension for all member By default, the browser extension only has access to github.com. Access to additional sites is granted by the user, on a site-by-site basis. -The Sourcegraph browser extension is open source and never sends any logs, pings, usage statistics or telemetry to Sourcegraph.com. Read more about browser extension privacy [here](/integration/browser_extension/references/privacy). +The Sourcegraph browser extension is open source and never sends any logs, pings, usage statistics or telemetry to Sourcegraph.com. Read more about browser extension privacy [here](/integration/browser-extension/references/privacy). ## Automatically install with Google Workspace diff --git a/docs/integration/browser-extension/how-tos/index.mdx b/docs/integration/browser-extension/how-tos/index.mdx new file mode 100644 index 000000000..d39410638 --- /dev/null +++ b/docs/integration/browser-extension/how-tos/index.mdx @@ -0,0 +1,7 @@ +# How-tos + +The following is a list of how-to documents for Browser Extensions: + +- [Install across all Google Workspace users](/integration/browser-extension/how-tos/google-workspace) +- [Troubleshooting](/integration/browser-extension/how-tos/troubleshooting) +- [Add browser search engine shortcuts](/integration/browser-extension/how-tos/browser-search-engine) diff --git a/docs/integration/browser_extension/how-tos/troubleshooting.mdx b/docs/integration/browser-extension/how-tos/troubleshooting.mdx similarity index 97% rename from docs/integration/browser_extension/how-tos/troubleshooting.mdx rename to docs/integration/browser-extension/how-tos/troubleshooting.mdx index fc56a45cf..0409f5fc9 100644 --- a/docs/integration/browser_extension/how-tos/troubleshooting.mdx +++ b/docs/integration/browser-extension/how-tos/troubleshooting.mdx @@ -44,7 +44,7 @@ If that still doesn't help, take a screenshot of the console and network activit ## Unable to connect to `http://...` Ensure the URL is correct and you are logged in -The Sourcegraph browser extension can only authenticate with Sourcegraph instances that have [HTTPS](/self-hosted/http_https_configuration) configured. +The Sourcegraph browser extension can only authenticate with Sourcegraph instances that have [HTTPS](/self-hosted/http-https-configuration) configured. ## `The string did not match the expected pattern` error in Safari diff --git a/docs/integration/browser_extension/index.mdx b/docs/integration/browser-extension/index.mdx similarity index 80% rename from docs/integration/browser_extension/index.mdx rename to docs/integration/browser-extension/index.mdx index b56687748..1e54ea774 100644 --- a/docs/integration/browser_extension/index.mdx +++ b/docs/integration/browser-extension/index.mdx @@ -21,13 +21,13 @@ The Sourcegraph browser extension allows you to open repos, compare revisions an NOTE: If you were using our self-hosted version of Firefox Extension and are looking to upgrade, please check our [migration guide](/integration/migrating_firefox_extension). +> NOTE: If you were using our self-hosted version of Firefox Extension and are looking to upgrade, please check our [migration guide](/integration/migrating-firefox-extension). ## Configure to use your Sourcegraph instance diff --git a/docs/integration/browser_extension/references/features.mdx b/docs/integration/browser-extension/references/features.mdx similarity index 95% rename from docs/integration/browser_extension/references/features.mdx rename to docs/integration/browser-extension/references/features.mdx index 8b489d927..a8e2f2a4d 100644 --- a/docs/integration/browser_extension/references/features.mdx +++ b/docs/integration/browser-extension/references/features.mdx @@ -30,4 +30,4 @@ The Sourcegraph extension adds a search engine shortcut to your web browser that 2. Start typing your search query. 3. Select an instant search suggestion or press Enter to see all results. -To install this search engine shortcut manually, and for more information, see "[Browser search engine shortcuts](/integration/browser_extension/how-tos/browser_search_engine)". +To install this search engine shortcut manually, and for more information, see "[Browser search engine shortcuts](/integration/browser-extension/how-tos/browser-search-engine)". diff --git a/docs/integration/browser-extension/references/index.mdx b/docs/integration/browser-extension/references/index.mdx new file mode 100644 index 000000000..402135ba4 --- /dev/null +++ b/docs/integration/browser-extension/references/index.mdx @@ -0,0 +1,6 @@ +# References + +The following is a list of reference documents for Browser Extensions: + +- [Features](/integration/browser-extension/references/features) +- [Privacy](/integration/browser-extension/references/privacy) diff --git a/docs/integration/browser_extension/references/privacy.mdx b/docs/integration/browser-extension/references/privacy.mdx similarity index 100% rename from docs/integration/browser_extension/references/privacy.mdx rename to docs/integration/browser-extension/references/privacy.mdx diff --git a/docs/integration/browser_extension/how-tos/index.mdx b/docs/integration/browser_extension/how-tos/index.mdx deleted file mode 100644 index 0cae9e7f2..000000000 --- a/docs/integration/browser_extension/how-tos/index.mdx +++ /dev/null @@ -1,7 +0,0 @@ -# How-tos - -The following is a list of how-to documents for Browser Extensions: - -- [Install across all Google Workspace users](/integration/browser_extension/how-tos/google_workspace) -- [Troubleshooting](/integration/browser_extension/how-tos/troubleshooting) -- [Add browser search engine shortcuts](/integration/browser_extension/how-tos/browser_search_engine) diff --git a/docs/integration/browser_extension/references/index.mdx b/docs/integration/browser_extension/references/index.mdx deleted file mode 100644 index 18033494d..000000000 --- a/docs/integration/browser_extension/references/index.mdx +++ /dev/null @@ -1,6 +0,0 @@ -# References - -The following is a list of reference documents for Browser Extensions: - -- [Features](/integration/browser_extension/references/features) -- [Privacy](/integration/browser_extension/references/privacy) diff --git a/docs/integration/github.mdx b/docs/integration/github.mdx index 539b2ffb0..ba4fc0476 100644 --- a/docs/integration/github.mdx +++ b/docs/integration/github.mdx @@ -4,29 +4,29 @@ You can use Sourcegraph with [GitHub.com](https://github.com) and [GitHub Enterp | Feature | Supported? | | ----------------------------------------------------------------------------- | ---------- | -| [Repository syncing](/admin/code_hosts/github#selecting-repositories-to-sync) | ✅ | -| [Repository permissions](/admin/code_hosts/github#repository-permissions) | ✅ | -| [User authentication](/admin/code_hosts/github#user-authentication) | ✅ | +| [Repository syncing](/admin/code-hosts/github#selecting-repositories-to-sync) | ✅ | +| [Repository permissions](/admin/code-hosts/github#repository-permissions) | ✅ | +| [User authentication](/admin/code-hosts/github#user-authentication) | ✅ | | [Browser extension](#browser-extension) | ✅ | ## Repository syncing -Site admins can [add GitHub repositories to Sourcegraph](/admin/code_hosts/github#selecting-repositories-to-sync). +Site admins can [add GitHub repositories to Sourcegraph](/admin/code-hosts/github#selecting-repositories-to-sync). ## Repository permissions -Site admins can [configure Sourcegraph to respect GitHub repository access permissions](/admin/code_hosts/github#repository-permissions). +Site admins can [configure Sourcegraph to respect GitHub repository access permissions](/admin/code-hosts/github#repository-permissions). ## User authentication -Site admins can [configure Sourcegraph to allow users to sign in via GitHub](/admin/code_hosts/github#user-authentication). +Site admins can [configure Sourcegraph to allow users to sign in via GitHub](/admin/code-hosts/github#user-authentication). ## Browser extension -The [Sourcegraph browser extension](/integration/browser_extension) supports GitHub. When installed in your web browser, it adds hover tooltips, go-to-definition, find-references, and code search to files and pull requests viewed on GitHub and GitHub Enterprise. +The [Sourcegraph browser extension](/integration/browser-extension) supports GitHub. When installed in your web browser, it adds hover tooltips, go-to-definition, find-references, and code search to files and pull requests viewed on GitHub and GitHub Enterprise. -1. Install the [Sourcegraph browser extension](/integration/browser_extension). -1. [Configure the browser extension](/integration/browser_extension#configuring-the-sourcegraph-instance-to-use) to use your Sourcegraph instance. +1. Install the [Sourcegraph browser extension](/integration/browser-extension). +1. [Configure the browser extension](/integration/browser-extension#configuring-the-sourcegraph-instance-to-use) to use your Sourcegraph instance. - You can also use [`https://sourcegraph.com`](https://sourcegraph.com) for public code only. diff --git a/docs/integration/gitlab.mdx b/docs/integration/gitlab.mdx index 6bcb30313..89b60cc4a 100644 --- a/docs/integration/gitlab.mdx +++ b/docs/integration/gitlab.mdx @@ -4,36 +4,36 @@ You can use Sourcegraph with [GitLab.com](https://gitlab.com) and GitLab CE/EE. | Feature | Supported? | | ------------------------------------------------------------------------- | ---------- | -| [Repository syncing](/admin/code_hosts/gitlab#repository-syncing) | ✅ | -| [Repository permissions](/admin/code_hosts/gitlab#repository-permissions) | ✅ | -| [User authentication](/admin/code_hosts/gitlab#user-authentication) | ✅ | +| [Repository syncing](/admin/code-hosts/gitlab#repository-syncing) | ✅ | +| [Repository permissions](/admin/code-hosts/gitlab#repository-permissions) | ✅ | +| [User authentication](/admin/code-hosts/gitlab#user-authentication) | ✅ | | [GitLab UI native integration](#gitlab-ui-native-integration) | ✅ | | [Browser extension](#browser-extension) | ✅ | ## Repository syncing -Site admins can [add GitLab repositories to Sourcegraph](/admin/code_hosts/gitlab#repository-syncing). +Site admins can [add GitLab repositories to Sourcegraph](/admin/code-hosts/gitlab#repository-syncing). ## Repository permissions -Site admins can [configure Sourcegraph to respect GitLab repository access permissions](/admin/code_hosts/gitlab#repository-permissions). +Site admins can [configure Sourcegraph to respect GitLab repository access permissions](/admin/code-hosts/gitlab#repository-permissions). ## User authentication -Site admins can [configure Sourcegraph to allow users to sign in via GitLab](/admin/code_hosts/gitlab#user-authentication). +Site admins can [configure Sourcegraph to allow users to sign in via GitLab](/admin/code-hosts/gitlab#user-authentication). ## GitLab UI native integration -GitLab instances can be configured to show Sourcegraph code navigation natively. See the [GitLab integration docs](/admin/code_hosts/gitlab#native-integration) for how to enable this on your GitLab instance. +GitLab instances can be configured to show Sourcegraph code navigation natively. See the [GitLab integration docs](/admin/code-hosts/gitlab#native-integration) for how to enable this on your GitLab instance. ![GitLab native integration](img/gitlab-code-intel.gif) ## Browser extension -The [Sourcegraph browser extension](/integration/browser_extension) supports GitLab. When installed in your web browser, it adds hover tooltips, go-to-definition, find-references, and code search to files and merge requests viewed on GitLab. +The [Sourcegraph browser extension](/integration/browser-extension) supports GitLab. When installed in your web browser, it adds hover tooltips, go-to-definition, find-references, and code search to files and merge requests viewed on GitLab. -1. Install the [Sourcegraph browser extension](/integration/browser_extension). -1. [Configure the browser extension](/integration/browser_extension#configuring-the-sourcegraph-instance-to-use) to use your Sourcegraph instance. +1. Install the [Sourcegraph browser extension](/integration/browser-extension). +1. [Configure the browser extension](/integration/browser-extension#configuring-the-sourcegraph-instance-to-use) to use your Sourcegraph instance. - You can also use [`https://sourcegraph.com`](https://sourcegraph.com) for public code from GitLab.com only. diff --git a/docs/integration/gitolite.mdx b/docs/integration/gitolite.mdx index 6ff7f8df5..1ac9de9d3 100644 --- a/docs/integration/gitolite.mdx +++ b/docs/integration/gitolite.mdx @@ -4,13 +4,13 @@ You can use Sourcegraph with [Gitolite](http://gitolite.com/). | Feature | Supported? | | ------------------------------------------------------------------- | ---------- | -| [Repository syncing](/admin/code_hosts/gitolite#repository-syncing) | ✅ | +| [Repository syncing](/admin/code-hosts/gitolite#repository-syncing) | ✅ | | [Browser extension](#browser-extension) | ❌ | ## Repository syncing -Site admins can [sync Gitolite repositories to Sourcegraph](/admin/code_hosts/gitolite#repository-syncing). +Site admins can [sync Gitolite repositories to Sourcegraph](/admin/code-hosts/gitolite#repository-syncing). ## Browser extension -The [Sourcegraph browser extension](/integration/browser_extension) does not support Gitolite because Gitolite has no web interface. If your Gitolite repositories are also available on another code host (such as GitHub or Phabricator), you can use the browser extension with those services. +The [Sourcegraph browser extension](/integration/browser-extension) does not support Gitolite because Gitolite has no web interface. If your Gitolite repositories are also available on another code host (such as GitHub or Phabricator), you can use the browser extension with those services. diff --git a/docs/integration/index.mdx b/docs/integration/index.mdx index 3fa60e816..60f8247d3 100644 --- a/docs/integration/index.mdx +++ b/docs/integration/index.mdx @@ -3,16 +3,16 @@ Sourcegraph integrates with your other tools to help you search, navigate, and review your code. - [GraphQL API](/api/graphql/): create custom tools using Sourcegraph data -- [Browser extension](/integration/browser_extension/): go-to-definitions and hovers in your code host and code reviews +- [Browser extension](/integration/browser-extension/): go-to-definitions and hovers in your code host and code reviews - Code hosts - [GitHub](/integration/github) - [GitLab](/integration/gitlab) - - [Bitbucket Cloud](/integration/bitbucket_cloud) - - [Bitbucket Server / Bitbucket Data Center](/integration/bitbucket_server) - - [Other Git repository hosts](/admin/code_hosts/other) + - [Bitbucket Cloud](/integration/bitbucket-cloud) + - [Bitbucket Server / Bitbucket Data Center](/integration/bitbucket-server) + - [Other Git repository hosts](/admin/code-hosts/other) - [Editor plugins](/integration/editor): jump to Sourcegraph from your editor - - [Open in Editor](/integration/open_in_editor): jump to your editor from Sourcegraph - - [Search shortcuts](/integration/browser_extension/how-tos/browser_search_engine): quickly search from your browser + - [Open in Editor](/integration/open-in-editor): jump to your editor from Sourcegraph + - [Search shortcuts](/integration/browser-extension/how-tos/browser-search-engine): quickly search from your browser - Launcher extensions - [Sourcegraph for Raycast](https://www.raycast.com/bobheadxi/sourcegraph) (unofficial): search code, browse notebooks, and manage batch changes from the Raycast launcher diff --git a/docs/integration/migrating_firefox_extension.mdx b/docs/integration/migrating-firefox-extension.mdx similarity index 100% rename from docs/integration/migrating_firefox_extension.mdx rename to docs/integration/migrating-firefox-extension.mdx diff --git a/docs/integration/open_in_editor.mdx b/docs/integration/open-in-editor.mdx similarity index 100% rename from docs/integration/open_in_editor.mdx rename to docs/integration/open-in-editor.mdx diff --git a/docs/integration/phabricator.mdx b/docs/integration/phabricator.mdx index 326f48cc9..64331e99e 100644 --- a/docs/integration/phabricator.mdx +++ b/docs/integration/phabricator.mdx @@ -2,27 +2,27 @@ > ⚠️ NOTE: Sourcegraph support of Phabricator is limited, and not expected to evolve due to the [announced](https://admin.phacility.com/phame/post/view/11/phacility_is_winding_down_operations/) cease of support for Phabricator. -This Phabricator integration does not support listing and mirroring Phabricator repositories (as it does for repositories on other code hosts). It is intended for use when your repositories are hosted somewhere else (such as GitHub), and Phabricator mirrors repositories from that code host. If your repositories are hosted on Phabricator, you must follow the steps in "[Other Git repository hosts](/admin/code_hosts/other)" to add the repositories so that they are mirrored to Sourcegraph in addition to the steps outlined here to power the integration. Sourcegraph does not currently support using the repository permissions you've set in Phabricator for repositories hosted on Phabricator. +This Phabricator integration does not support listing and mirroring Phabricator repositories (as it does for repositories on other code hosts). It is intended for use when your repositories are hosted somewhere else (such as GitHub), and Phabricator mirrors repositories from that code host. If your repositories are hosted on Phabricator, you must follow the steps in "[Other Git repository hosts](/admin/code-hosts/other)" to add the repositories so that they are mirrored to Sourcegraph in addition to the steps outlined here to power the integration. Sourcegraph does not currently support using the repository permissions you've set in Phabricator for repositories hosted on Phabricator. | Feature | Supported? | | ------------------------------------------------------------------------------------------------ | ---------- | -| [Repository syncing and mirroring](/admin/code_hosts/phabricator#repository-linking-and-syncing) | ❌ | -| [Repository association](/admin/code_hosts/phabricator#repository-linking-and-syncing) | ✅ | +| [Repository syncing and mirroring](/admin/code-hosts/phabricator#repository-linking-and-syncing) | ❌ | +| [Repository association](/admin/code-hosts/phabricator#repository-linking-and-syncing) | ✅ | | [Repository permission syncing](/admin/permissions/syncing) | ❌ | | [User authentication](/admin/auth/) | ❌ | | [Browser extension](#browser-extension) | ✅ | -| [Native extension](/admin/code_hosts/phabricator#native-extension) | ✅ | +| [Native extension](/admin/code-hosts/phabricator#native-extension) | ✅ | ## Repository association -Site admins can [associate Phabricator repositories with Sourcegraph](/admin/code_hosts/phabricator#repository-syncing-and-linking). +Site admins can [associate Phabricator repositories with Sourcegraph](/admin/code-hosts/phabricator#repository-syncing-and-linking). ## Browser extension -The [Sourcegraph browser extension](/integration/browser_extension) supports Phabricator. When installed in your web browser, it adds hover tooltips, go-to-definition, find-references, and code search to files and diffs viewed on Phabricator. +The [Sourcegraph browser extension](/integration/browser-extension) supports Phabricator. When installed in your web browser, it adds hover tooltips, go-to-definition, find-references, and code search to files and diffs viewed on Phabricator. -1. Install the [Sourcegraph browser extension](/integration/browser_extension). -1. [Configure the browser extension](/integration/browser_extension#configuring-the-sourcegraph-instance-to-use) to use your Sourcegraph instance. +1. Install the [Sourcegraph browser extension](/integration/browser-extension). +1. [Configure the browser extension](/integration/browser-extension#configuring-the-sourcegraph-instance-to-use) to use your Sourcegraph instance. 1. To allow the browser extension to work on your Phabricator instance: - Navigate to any page on Phabricator. - Right-click the Sourcegraph icon in the browser extension toolbar. @@ -30,4 +30,4 @@ The [Sourcegraph browser extension](/integration/browser_extension) supports Pha - Click "Allow" in the permissions request popup. 1. Visit any file or diff on Phabricator. Hover over code or click the "View file" and "View repository" buttons. -> NOTE: Site admins can also install the [native Phabricator extension](/admin/code_hosts/phabricator#native-extension) to avoid needing each user to install the browser extension. +> NOTE: Site admins can also install the [native Phabricator extension](/admin/code-hosts/phabricator#native-extension) to avoid needing each user to install the browser extension. diff --git a/docs/model-provider/index.mdx b/docs/model-provider/index.mdx index 55da222d5..16f74d261 100644 --- a/docs/model-provider/index.mdx +++ b/docs/model-provider/index.mdx @@ -20,7 +20,7 @@ The Sourcegraph Model Provider is the default and recommended way to configure A manager. -To enable inference provided by the Sourcegraph Model Provider on your Sourcegraph Enterprise instance, all you need to do is ensure your license key and your model provider is set to `"sourcegraph"` in your [site configuration](/admin/config/site_config): +To enable inference provided by the Sourcegraph Model Provider on your Sourcegraph Enterprise instance, all you need to do is ensure your license key and your model provider is set to `"sourcegraph"` in your [site configuration](/admin/config/site-config): ```jsonc { diff --git a/docs/own/assigned_ownership.mdx b/docs/own/assigned-ownership.mdx similarity index 97% rename from docs/own/assigned_ownership.mdx rename to docs/own/assigned-ownership.mdx index 803f030ba..f68f08638 100644 --- a/docs/own/assigned_ownership.mdx +++ b/docs/own/assigned-ownership.mdx @@ -10,8 +10,8 @@ Assigned ownership propagates in a top-down manner: e.g. ## Who can assign ownership -Only site admins can assign ownership by default. For other users, [RBAC should be used](/admin/access_control/ownership) to grant assign ownership right. -[More](/admin/access_control) about RBAC in Sourcegraph. +Only site admins can assign ownership by default. For other users, [RBAC should be used](/admin/access-control/ownership) to grant assign ownership right. +[More](/admin/access-control) about RBAC in Sourcegraph. ## How to assign ownership diff --git a/docs/own/codeowners_format.mdx b/docs/own/codeowners-format.mdx similarity index 96% rename from docs/own/codeowners_format.mdx rename to docs/own/codeowners-format.mdx index f9943280c..5eced2c79 100644 --- a/docs/own/codeowners_format.mdx +++ b/docs/own/codeowners-format.mdx @@ -65,6 +65,6 @@ Searches at specific commits will return any `CODEOWNERS` data that exists at th > Use this approach if you don't want to commit `CODEOWNERS` files to your repos, or if you have an existing system that tracks ownership data and want to sync that data with Sourcegraph. -Read more on how to [manually ingest `CODEOWNERS` data](/own/codeowners_ingestion) into your Sourcegraph instance. +Read more on how to [manually ingest `CODEOWNERS` data](/own/codeowners-ingestion) into your Sourcegraph instance. -The [docs](/own/codeowners_ingestion) detail how to use the UI or `src-cli` to upload `CODEOWNERS` files to Sourcegraph. +The [docs](/own/codeowners-ingestion) detail how to use the UI or `src-cli` to upload `CODEOWNERS` files to Sourcegraph. diff --git a/docs/own/codeowners_ingestion.mdx b/docs/own/codeowners-ingestion.mdx similarity index 100% rename from docs/own/codeowners_ingestion.mdx rename to docs/own/codeowners-ingestion.mdx diff --git a/docs/own/configuration_reference.mdx b/docs/own/configuration-reference.mdx similarity index 97% rename from docs/own/configuration_reference.mdx rename to docs/own/configuration-reference.mdx index 6dae591d4..a19ae0e3b 100644 --- a/docs/own/configuration_reference.mdx +++ b/docs/own/configuration-reference.mdx @@ -44,7 +44,7 @@ This is because the process can become computationally expensive. ## Assigned ownership access control -In order to grant users the ability to assign ownership, please use [ownership permission](/admin/access_control/ownership) in role-based access control. +In order to grant users the ability to assign ownership, please use [ownership permission](/admin/access-control/ownership) in role-based access control. This is a coarse-grained permission, allowing users to assign ownership throughout the instance. At this point there is no finer-grained ownership assigning access control. diff --git a/docs/own/index.mdx b/docs/own/index.mdx index baa77e9a7..04dcfc919 100644 --- a/docs/own/index.mdx +++ b/docs/own/index.mdx @@ -20,8 +20,8 @@ A _team_ is a group of Sourcegraph users represented by a common handle, which i Code ownership is set in 2 different ways: -- [The `CODEOWNERS` format](/own/codeowners_format) -- [Assigned ownership](/own/assigned_ownership) +- [The `CODEOWNERS` format](/own/codeowners-format) +- [Assigned ownership](/own/assigned-ownership) ## Limitations @@ -94,5 +94,5 @@ If memory issues persist after disabling ownership features, consider whether Ow In order to learn more please check out our references: -- [CODEOWNERS format](/own/codeowners_format) - Guide to using the CODEOWNERS file format to define ownership -- [Configuration](/own/configuration_reference) - Full list of ownership configuration options +- [CODEOWNERS format](/own/codeowners-format) - Guide to using the CODEOWNERS file format to define ownership +- [Configuration](/own/configuration-reference) - Full list of ownership configuration options diff --git a/docs/self-hosted/advanced_config_file.mdx b/docs/self-hosted/advanced-config-file.mdx similarity index 97% rename from docs/self-hosted/advanced_config_file.mdx rename to docs/self-hosted/advanced-config-file.mdx index 93f7afdb5..93372bcf3 100644 --- a/docs/self-hosted/advanced_config_file.mdx +++ b/docs/self-hosted/advanced-config-file.mdx @@ -29,7 +29,7 @@ Set `SITE_CONFIG_FILE=site.json` and mount the config on: containers - [Single-container](/self-hosted/deploy/docker-single-container/): the `sourcegraph/server` container -Where `site.json` is a file that contains the [site configuration](/admin/config/site_config), which you would otherwise edit +Where `site.json` is a file that contains the [site configuration](/admin/config/site-config), which you would otherwise edit through the in-app site configuration editor. If you want to _allow_ edits to be made through the web UI (which will be overwritten with what is in the file on a @@ -129,9 +129,9 @@ metadata: deploy: sourcegraph name: frontend-config-files data: - # IMPORTANT: see https://sourcegraph.com/docs/admin/config/advanced_config_file for details on how this works. + # IMPORTANT: see https://sourcegraph.com/docs/admin/config/advanced-config-file for details on how this works. - # Global user settings, see: https://sourcegraph.com/docs/admin/config/advanced_config_file#global-settings + # Global user settings, see: https://sourcegraph.com/docs/admin/config/advanced-config-file#global-settings global-settings.json: | { "search.scopes": [ @@ -149,7 +149,7 @@ data: } } - # Site configuration, see: https://sourcegraph.com/docs/admin/config/advanced_config_file#site-configuration + # Site configuration, see: https://sourcegraph.com/docs/admin/config/advanced-config-file#site-configuration site.json: | { "auth.providers": [ @@ -163,7 +163,7 @@ data: } } - # Code host configuration, see: https://sourcegraph.com/docs/admin/config/advanced_config_file#code-host-configuration + # Code host configuration, see: https://sourcegraph.com/docs/admin/config/advanced-config-file#code-host-configuration extsvc.json: | { "GITHUB": [ diff --git a/docs/self-hosted/deploy/docker-compose/aws.mdx b/docs/self-hosted/deploy/docker-compose/aws.mdx index 685fdc1d1..61bf6e588 100644 --- a/docs/self-hosted/deploy/docker-compose/aws.mdx +++ b/docs/self-hosted/deploy/docker-compose/aws.mdx @@ -18,7 +18,7 @@ Click **Launch Instance** from the [EC2 dashboard](https://console.aws.amazon.co #### Instance type -1. Select an appropriate instance type using our [resource estimator](/self-hosted/deploy/resource_estimator) as reference +1. Select an appropriate instance type using our [resource estimator](/self-hosted/deploy/resource-estimator) as reference #### Key pair (login) @@ -167,5 +167,5 @@ Use [AWS RDS for PostgreSQL](https://aws.amazon.com/rds/) instead of the Dockeri ## Other resources -[HTTP and HTTPS/SSL configuration](/self-hosted/http_https_configuration#sourcegraph-via-docker-compose-caddy-2) +[HTTP and HTTPS/SSL configuration](/self-hosted/http-https-configuration#sourcegraph-via-docker-compose-caddy-2) [Site Administration Quickstart](/admin/how-to/site-admin-quickstart) diff --git a/docs/self-hosted/deploy/docker-compose/azure.mdx b/docs/self-hosted/deploy/docker-compose/azure.mdx index 41834a7d9..27e0684a4 100644 --- a/docs/self-hosted/deploy/docker-compose/azure.mdx +++ b/docs/self-hosted/deploy/docker-compose/azure.mdx @@ -12,7 +12,7 @@ In the [Azure Quickstart Center](https://portal.azure.com/?quickstart=true#view/ - `Availability options:` No infrastructure redundancy required - `Image:` Ubuntu Server 18.04 LTS - Gen2 - `VM architecture:` x64 -- `Size:` Select an appropriate instance type using our [resource estimator](/self-hosted/deploy/resource_estimator) as reference +- `Size:` Select an appropriate instance type using our [resource estimator](/self-hosted/deploy/resource-estimator) as reference - `Authentication type:` Select one that works best for you. SSH Key is recommended. - `Inbound port rules:` Allowed selected ports - `Select inbound ports:` HTTP (80), HTTPS (443), SSH (22) @@ -190,5 +190,5 @@ Postgres service will get Sourcegraph back to its previous state. ## Other resources -[HTTP and HTTPS/SSL configuration](/self-hosted/http_https_configuration#sourcegraph-via-docker-compose-caddy-2) +[HTTP and HTTPS/SSL configuration](/self-hosted/http-https-configuration#sourcegraph-via-docker-compose-caddy-2) [Site Administration Quickstart](/admin/how-to/site-admin-quickstart) diff --git a/docs/self-hosted/deploy/docker-compose/configuration.mdx b/docs/self-hosted/deploy/docker-compose/configuration.mdx index d5e737767..f5fab4958 100644 --- a/docs/self-hosted/deploy/docker-compose/configuration.mdx +++ b/docs/self-hosted/deploy/docker-compose/configuration.mdx @@ -34,7 +34,7 @@ services: The Docker Compose configuration has its own internal PostgreSQL and Redis databases. -You can alternatively configure Sourcegraph to [use external services](/self-hosted/external_services/). +You can alternatively configure Sourcegraph to [use external services](/self-hosted/external-services/). ## Set environment variables diff --git a/docs/self-hosted/deploy/docker-compose/digitalocean.mdx b/docs/self-hosted/deploy/docker-compose/digitalocean.mdx index 6e391a211..b1471fb2f 100644 --- a/docs/self-hosted/deploy/docker-compose/digitalocean.mdx +++ b/docs/self-hosted/deploy/docker-compose/digitalocean.mdx @@ -19,7 +19,7 @@ This guide will take you through how to deploy a Sourcegraph instance to a singl #### Choose a plan -1. Select an appropriate droplet size using our [resource estimator](/self-hosted/deploy/resource_estimator) as reference +1. Select an appropriate droplet size using our [resource estimator](/self-hosted/deploy/resource-estimator) as reference #### Add block storage @@ -160,7 +160,7 @@ After the initial deployment has been completed, it is strongly recommended to s - Restrict the accessibility of ports other than `80` and `443` via [Cloud Firewalls](https://www.digitalocean.com/docs/networking/firewalls/quickstart/). -- Set up [TLS/SSL](/self-hosted/http_https_configuration#sourcegraph-via-docker-compose-caddy-2) in the Docker Compose deployment +- Set up [TLS/SSL](/self-hosted/http-https-configuration#sourcegraph-via-docker-compose-caddy-2) in the Docker Compose deployment > NOTE: If you have configured a DNS entry for the IP, please ensure to update `externalURL` in your Sourcegraph instance's Site Configuration to reflect that @@ -188,5 +188,5 @@ get Sourcegraph back to its previous state. ## Other resources -[HTTP and HTTPS/SSL configuration](/self-hosted/http_https_configuration#sourcegraph-via-docker-compose-caddy-2) +[HTTP and HTTPS/SSL configuration](/self-hosted/http-https-configuration#sourcegraph-via-docker-compose-caddy-2) [Site Administration Quickstart](/admin/how-to/site-admin-quickstart) diff --git a/docs/self-hosted/deploy/docker-compose/google_cloud.mdx b/docs/self-hosted/deploy/docker-compose/google-cloud.mdx similarity index 98% rename from docs/self-hosted/deploy/docker-compose/google_cloud.mdx rename to docs/self-hosted/deploy/docker-compose/google-cloud.mdx index d4692f159..d6579be0b 100644 --- a/docs/self-hosted/deploy/docker-compose/google_cloud.mdx +++ b/docs/self-hosted/deploy/docker-compose/google-cloud.mdx @@ -8,7 +8,7 @@ Click **Create Instance** in your [Google Cloud Compute Engine Console](https:// #### Machine configuration -1. Select an appropriate machine type using our [resource estimator](/self-hosted/deploy/resource_estimator) as reference +1. Select an appropriate machine type using our [resource estimator](/self-hosted/deploy/resource-estimator) as reference #### Boot disk @@ -168,5 +168,5 @@ the old external Postgres service will get Sourcegraph back to its previous stat ## Other resources -[HTTP and HTTPS/SSL configuration](/self-hosted/http_https_configuration#sourcegraph-via-docker-compose-caddy-2) +[HTTP and HTTPS/SSL configuration](/self-hosted/http-https-configuration#sourcegraph-via-docker-compose-caddy-2) [Site Administration Quickstart](/admin/how-to/site-admin-quickstart) diff --git a/docs/self-hosted/deploy/docker-compose/index.mdx b/docs/self-hosted/deploy/docker-compose/index.mdx index 72d8bff18..61217be84 100644 --- a/docs/self-hosted/deploy/docker-compose/index.mdx +++ b/docs/self-hosted/deploy/docker-compose/index.mdx @@ -16,7 +16,7 @@ This guide will take you through how to install Sourcegraph with Docker Compose @@ -26,7 +26,7 @@ This guide will take you through how to install Sourcegraph with Docker Compose - Install [Docker Compose](https://docs.docker.com/compose/) on the server - Minimum Docker [v20.10.0](https://docs.docker.com/engine/release-notes/#20100) and Docker Compose [v1.29.0](https://docs.docker.com/compose/release-notes/#1290) - Docker Swarm mode is **not** supported -- Check the [resource estimator](/self-hosted/deploy/resource_estimator) for resource requirements +- Check the [resource estimator](/self-hosted/deploy/resource-estimator) for resource requirements - Obtain a [Sourcegraph license](https://about.sourcegraph.com/pricing/) - License is required for instances with **more than 10 users** - optional Configure ingress firewall rules @@ -189,5 +189,5 @@ Once the server is ready, navigate to the `sourcegraph-frontend-0` hostname or I - [Upgrade](/self-hosted/deploy/docker-compose/upgrade) - [Management Operations](/self-hosted/deploy/docker-compose/operations) -- [HTTP and HTTPS/SSL configuration](/self-hosted/http_https_configuration#sourcegraph-via-docker-compose-caddy-2) +- [HTTP and HTTPS/SSL configuration](/self-hosted/http-https-configuration#sourcegraph-via-docker-compose-caddy-2) - [Site Administration Quickstart](/admin/how-to/site-admin-quickstart) diff --git a/docs/self-hosted/deploy/docker-compose/migrate.mdx b/docs/self-hosted/deploy/docker-compose/migrate.mdx index 7f240dfd0..5af5976ec 100644 --- a/docs/self-hosted/deploy/docker-compose/migrate.mdx +++ b/docs/self-hosted/deploy/docker-compose/migrate.mdx @@ -85,7 +85,7 @@ scp example_user@example_docker_host.com:/tmp/*.out Follow your cloud provider's installation guide to create the new Docker Compose instance: - [Deploy Sourcegraph with Docker Compose on AWS](/self-hosted/deploy/docker-compose/aws) -- [Deploy Sourcegraph with Docker Compose on Google Cloud](/self-hosted/deploy/docker-compose/google_cloud) +- [Deploy Sourcegraph with Docker Compose on Google Cloud](/self-hosted/deploy/docker-compose/google-cloud) - [Deploy Sourcegraph with Docker Compose on DigitalOcean](/self-hosted/deploy/docker-compose/digitalocean) Once you have finished the above, come back here for directions on how to copy over the database from your old `sourcegraph/server` instance. diff --git a/docs/self-hosted/deploy/docker-compose/operations.mdx b/docs/self-hosted/deploy/docker-compose/operations.mdx index b0ce888e5..7e48e0102 100644 --- a/docs/self-hosted/deploy/docker-compose/operations.mdx +++ b/docs/self-hosted/deploy/docker-compose/operations.mdx @@ -10,7 +10,7 @@ Guides for managing cloud storage and backups are available in our cloud-specifi - [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 Google Cloud](/self-hosted/deploy/docker-compose/google_cloud#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) ## Access the database @@ -44,7 +44,7 @@ The following instructions are specific to backing up and restoring the Sourcegr ### Back up Sourcegraph databases -These instructions will back up the primary `sourcegraph` database, the [codeintel](/code-navigation/) database, and the [codeinsights](/code_insights/) database. +These instructions will back up the primary `sourcegraph` database, the [codeintel](/code-navigation/) database, and the [codeinsights](/code-insights/) database. 1\. `ssh` from your local machine into the machine hosting the `sourcegraph` deployment diff --git a/docs/self-hosted/deploy/docker-compose/upgrade.mdx b/docs/self-hosted/deploy/docker-compose/upgrade.mdx index e7b373ebe..c9613db80 100644 --- a/docs/self-hosted/deploy/docker-compose/upgrade.mdx +++ b/docs/self-hosted/deploy/docker-compose/upgrade.mdx @@ -5,7 +5,7 @@ import {CURRENT_VERSION_STRING} from 'src/components/PreCodeBlock'; This document describes the process to update a Docker Compose Sourcegraph instance. If you are unfamiliar with sourcegraph versioning or releases see our [general concepts documentation](/self-hosted/updates/). > -> Always consult the [release notes](/self-hosted/updates/docker_compose) for the +> Always consult the [release notes](/self-hosted/updates/docker-compose) for the > versions your upgrade will pass over and end on. > @@ -74,7 +74,7 @@ To perform a multi-version upgrade via migrators [upgrade](/self-hosted/updates/ 1. **Check Upgrade Readiness**: - - Check the [upgrade notes](/self-hosted/updates/docker_compose#docker-compose-upgrade-notes) for the version range you're passing through. + - Check the [upgrade notes](/self-hosted/updates/docker-compose#docker-compose-upgrade-notes) for the version range you're passing through. - Check the `Site Admin > Updates` page to determine [upgrade readiness](/self-hosted/updates/#upgrade-readiness). 2. **Pull and merge upstream changes**: diff --git a/docs/self-hosted/deploy/docker-single-container/aws.mdx b/docs/self-hosted/deploy/docker-single-container/aws.mdx index 4b1f3e716..de47f5ab5 100644 --- a/docs/self-hosted/deploy/docker-single-container/aws.mdx +++ b/docs/self-hosted/deploy/docker-single-container/aws.mdx @@ -44,7 +44,7 @@ This tutorial shows you how to deploy [single-container Sourcegraph with Docker] - Select **Next: ...** until you get to the **Configure Security Group** page. Then add the following rules: - Default **HTTP** rule: port range `80`, source `0.0.0.0/0, ::/0` - Default **HTTPS** rule: port range `443`, source `0.0.0.0/0, ::/0` - - (NOTE: additional work will be required later on to [configure NGINX to support SSL](/self-hosted/http_https_configuration#nginx-ssl-https-configuration)) + - (NOTE: additional work will be required later on to [configure NGINX to support SSL](/self-hosted/http-https-configuration#nginx-ssl-https-configuration)) - Launch your instance, then navigate to its public IP in your browser. (This can be found by navigating to the instance page on EC2 and looking in the "Description" panel for the "IPv4 Public IP" value.) You may have to wait a minute or two for the instance to finish initializing before Sourcegraph becomes accessible. You can monitor the status by SSHing into the EC2 instance and viewing the logs: ``` @@ -69,6 +69,6 @@ docker run docker run -d --publish 80:7080 --publish 443:7080 --restart unless-s ## Using an external database for persistence -The Docker container has its own internal PostgreSQL and Redis databases. To preserve this data when you kill and recreate the container, you can [use external services](/self-hosted/external_services/) for persistence, such as [AWS RDS for PostgreSQL](https://aws.amazon.com/rds/), [Amazon ElastiCache](https://aws.amazon.com/elasticache/redis/), and [S3](https://aws.amazon.com/s3/) for storing user uploads. +The Docker container has its own internal PostgreSQL and Redis databases. To preserve this data when you kill and recreate the container, you can [use external services](/self-hosted/external-services/) for persistence, such as [AWS RDS for PostgreSQL](https://aws.amazon.com/rds/), [Amazon ElastiCache](https://aws.amazon.com/elasticache/redis/), and [S3](https://aws.amazon.com/s3/) for storing user uploads. > NOTE: Use of external databases requires [Sourcegraph Enterprise](https://about.sourcegraph.com/pricing). diff --git a/docs/self-hosted/deploy/docker-single-container/digitalocean.mdx b/docs/self-hosted/deploy/docker-single-container/digitalocean.mdx index eaa7fea5b..a07304326 100644 --- a/docs/self-hosted/deploy/docker-single-container/digitalocean.mdx +++ b/docs/self-hosted/deploy/docker-single-container/digitalocean.mdx @@ -33,7 +33,7 @@ After initial setup, we recommend you do the following: - Restrict the accessibility of ports other than `80` and `443` via [Cloud Firewalls](https://www.digitalocean.com/docs/networking/firewalls/quickstart/). -- Set up [TLS/SSL](/self-hosted/http_https_configuration#nginx-ssl-https-configuration) in the NGINX configuration. +- Set up [TLS/SSL](/self-hosted/http-https-configuration#nginx-ssl-https-configuration) in the NGINX configuration. --- diff --git a/docs/self-hosted/deploy/docker-single-container/google_cloud.mdx b/docs/self-hosted/deploy/docker-single-container/google-cloud.mdx similarity index 95% rename from docs/self-hosted/deploy/docker-single-container/google_cloud.mdx rename to docs/self-hosted/deploy/docker-single-container/google-cloud.mdx index c22652ada..699ac996f 100644 --- a/docs/self-hosted/deploy/docker-single-container/google_cloud.mdx +++ b/docs/self-hosted/deploy/docker-single-container/google-cloud.mdx @@ -7,7 +7,7 @@ import { This tutorial shows you how to deploy [single-container Sourcegraph with Docker](/self-hosted/deploy/docker-single-container/) to a single node running on Google Cloud. -> NOTE: We _do not_ recommend using this method for a production instance. If deploying a production instance, see [our recommendations](/self-hosted/deploy/) for how to choose a deployment type that suits your needs. We recommend [Docker Compose](/self-hosted/deploy/docker-compose/google_cloud) for most initial production deployments. +> NOTE: We _do not_ recommend using this method for a production instance. If deploying a production instance, see [our recommendations](/self-hosted/deploy/) for how to choose a deployment type that suits your needs. We recommend [Docker Compose](/self-hosted/deploy/docker-compose/google-cloud) for most initial production deployments. --- @@ -51,6 +51,6 @@ docker run -d ... sourcegraph/server:X.Y.Z ## Using an external database for persistence -The Docker container has its own internal PostgreSQL and Redis databases. To preserve this data when you kill and recreate the container, you can [use external services](/self-hosted/external_services/) for persistence, such as Google Cloud's [Cloud SQL for PostgreSQL](https://cloud.google.com/sql/docs/postgres/), [Cloud Memorystore](https://cloud.google.com/memorystore/), and [Cloud Storage](https://cloud.google.com/storage) for storing user uploads. +The Docker container has its own internal PostgreSQL and Redis databases. To preserve this data when you kill and recreate the container, you can [use external services](/self-hosted/external-services/) for persistence, such as Google Cloud's [Cloud SQL for PostgreSQL](https://cloud.google.com/sql/docs/postgres/), [Cloud Memorystore](https://cloud.google.com/memorystore/), and [Cloud Storage](https://cloud.google.com/storage) for storing user uploads. > NOTE: Use of external databases requires [Sourcegraph Enterprise](https://about.sourcegraph.com/pricing). diff --git a/docs/self-hosted/deploy/docker-single-container/index.mdx b/docs/self-hosted/deploy/docker-single-container/index.mdx index d9f5fbe94..772dd19ab 100644 --- a/docs/self-hosted/deploy/docker-single-container/index.mdx +++ b/docs/self-hosted/deploy/docker-single-container/index.mdx @@ -7,7 +7,7 @@ import { The Docker Single Container deployment type is a way to very quickly get an instance of Sourcegraph set up locally to experiment with many of its features. However, it is **not recommended** for a production instance, and **has limitations** depending on the OS you are deploying to, as well as the associated resources. See the [troubleshooting section](#troubleshooting) for additional information. -[Code Insights](/code_insights/) is not supported in Single Container deployments. To try Code Insights you must deploy using [Docker Compose](/self-hosted/deploy/docker-compose/) or [Kubernetes](/self-hosted/deploy/kubernetes/). [Tracing](/self-hosted/observability/tracing) is disabled by default, and if you intend to enable it, you will have to deploy and configure the [OpenTelemetry Collector](/self-hosted/observability/opentelemetry). The Single Container deployment does not ship with this service included. It is strongly recommended to use one of the aforementioned deployment methods if tracing support is a requirement. +[Code Insights](/code-insights/) is not supported in Single Container deployments. To try Code Insights you must deploy using [Docker Compose](/self-hosted/deploy/docker-compose/) or [Kubernetes](/self-hosted/deploy/kubernetes/). [Tracing](/self-hosted/observability/tracing) is disabled by default, and if you intend to enable it, you will have to deploy and configure the [OpenTelemetry Collector](/self-hosted/observability/opentelemetry). The Single Container deployment does not ship with this service included. It is strongly recommended to use one of the aforementioned deployment methods if tracing support is a requirement. ## Installation @@ -61,7 +61,7 @@ RUN find /root/.ssh -type d -exec chmod 700 '{}' ';' This approach can also be used for `sourcegraph/gitserver` images in cluster environments. -Learn more about Git [configuration](/admin/repo/git_config) and [authentication](/admin/repo/auth). +Learn more about Git [configuration](/admin/repo/git-config) and [authentication](/admin/repo/auth). #### SSH authentication (config, keys, `known_hosts`) @@ -143,7 +143,7 @@ SELECT * FROM users; ### Postgresql 16 -> Warning: The 5.11 release updates the database container images from Postgres 12 to Postgres 16. Customers are advised to have a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! +> Warning: The 5.11 release updates the database container images from Postgres 12 to Postgres 16. Customers are advised to have a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12-end-of-life-notice#postgres-12-end-of-life) notice! From sourcegraph version 5.11 onwards, the Sourcegraph single container Docker image uses Postgresql 16. Upgrading from Postgresql 12 to Postgresql 16 is a manual process, that is similar to the one outlined below for multi-version upgrades, but migrator has been merged into the container, allowing for a simpler upgrade. @@ -209,7 +209,7 @@ A [multi-version upgrade](/self-hosted/updates/#multi-version-upgrades) is a dow To perform a multi-version upgrade on a Sourcegraph instance running on Docker Single Container: 1. Stop the running Sourcegraph container via `docker stop [CONTAINER]`. -1. Start a temporary Postgres container on top of the Postgres data directory used by the old `sourcegraph/server` image. This Postgres instance will be used by the following upgrade migration. If using an [external database](/self-hosted/external_services/postgres), the database is already accessible from the `migrator` so no action is needed. Otherwise, start the new Postgres container by following the steps [described below](#running-temporary-postgres-containers). +1. Start a temporary Postgres container on top of the Postgres data directory used by the old `sourcegraph/server` image. This Postgres instance will be used by the following upgrade migration. If using an [external database](/self-hosted/external-services/postgres), the database is already accessible from the `migrator` so no action is needed. Otherwise, start the new Postgres container by following the steps [described below](#running-temporary-postgres-containers). 1. Follow the instructions on [how to run the migrator job in Docker](/self-hosted/updates/migrator/migrator-operations#docker-compose) to perform the upgrade migratiohn. For specific documentation on the `upgrade` command, see the [command documentation](/self-hosted/updates/migrator/migrator-operations#upgrade). The following specific steps are an easy way to run the upgrade command:

@@ -339,7 +339,7 @@ To fix this, run: Cloud specific Sourcegraph installation guides for AWS, Google Cloud and Digital Ocean. - [Install Sourcegraph with Docker on AWS](/self-hosted/deploy/docker-single-container/aws) -- [Install Sourcegraph with Docker on Google Cloud](/self-hosted/deploy/docker-single-container/google_cloud) +- [Install Sourcegraph with Docker on Google Cloud](/self-hosted/deploy/docker-single-container/google-cloud) - [Install Sourcegraph with Docker on DigitalOcean](/self-hosted/deploy/docker-single-container/digitalocean) ### Insiders build diff --git a/docs/self-hosted/deploy/instance-size.mdx b/docs/self-hosted/deploy/instance-size.mdx index ef0af453e..6ce234b55 100644 --- a/docs/self-hosted/deploy/instance-size.mdx +++ b/docs/self-hosted/deploy/instance-size.mdx @@ -65,4 +65,4 @@ table. ## Resources -Please refer to our [resource estimator](/self-hosted/deploy/resource_estimator) for more information regarding resources allocation for your Sourcegraph deployment. +Please refer to our [resource estimator](/self-hosted/deploy/resource-estimator) for more information regarding resources allocation for your Sourcegraph deployment. diff --git a/docs/self-hosted/deploy/kubernetes/configure.mdx b/docs/self-hosted/deploy/kubernetes/configure.mdx index 8fd6ca32e..e7aae1c6e 100644 --- a/docs/self-hosted/deploy/kubernetes/configure.mdx +++ b/docs/self-hosted/deploy/kubernetes/configure.mdx @@ -82,7 +82,7 @@ components: This will allow the frontend service to discover endpoints for each service replica and communicate with them through the Kubernetes API. Note that this component should only be added if RBAC is enabled in your cluster. -If you are not using Kubernetes service discovery (for example, if you are running without RBAC or outside Kubernetes), you must manually configure service endpoints for the frontend. See [Running Sourcegraph Without Kubernetes Service Discovery](/self-hosted/deploy/without_service_discovery) for instructions. +If you are not using Kubernetes service discovery (for example, if you are running without RBAC or outside Kubernetes), you must manually configure service endpoints for the frontend. See [Running Sourcegraph Without Kubernetes Service Discovery](/self-hosted/deploy/without-service-discovery) for instructions. --- @@ -1020,7 +1020,7 @@ patches: ## External services -You can use an external or managed version of PostgreSQL and Redis with your Sourcegraph instance. For detailed information as well as the requirements for each service, please see our docs on [using external services with Sourcegraph](/self-hosted/external_services/). +You can use an external or managed version of PostgreSQL and Redis with your Sourcegraph instance. For detailed information as well as the requirements for each service, please see our docs on [using external services with Sourcegraph](/self-hosted/external-services/). ### External Secrets @@ -1149,7 +1149,7 @@ components: **Step 4:** Update code host configuration -Update your [code host configuration file](/admin/code_hosts/#full-code-host-docs) to enable ssh cloning. For example, set [gitURLType](/admin/code_hosts/github#gitURLType) to `ssh` for [GitHub](/admin/code_hosts/github). See the [external service docs](/admin/code_hosts/) for the correct setting for your code host. +Update your [code host configuration file](/admin/code-hosts/#full-code-host-docs) to enable ssh cloning. For example, set [gitURLType](/admin/code-hosts/github#gitURLType) to `ssh` for [GitHub](/admin/code-hosts/github). See the [external service docs](/admin/code-hosts/) for the correct setting for your code host. --- @@ -1172,7 +1172,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 [site configuration](/admin/config/site_config). +Once you have a license key, add it to your [site configuration](/admin/config/site-config). --- diff --git a/docs/self-hosted/deploy/kubernetes/index.mdx b/docs/self-hosted/deploy/kubernetes/index.mdx index 013be9fcc..4189e8551 100644 --- a/docs/self-hosted/deploy/kubernetes/index.mdx +++ b/docs/self-hosted/deploy/kubernetes/index.mdx @@ -33,7 +33,7 @@ Our Helm chart has a lot of sensible defaults baked into the values.yaml so that 1. Prepare any required customizations - Most environments will likely require some customizations to the default Helm chart values. See _[Configuration](#configuration)_ for more information. -- Additionally, resource allocations for individual services may need to be adjusted. See our _[Resource Estimator](/self-hosted/deploy/resource_estimator)_ for more information. +- Additionally, resource allocations for individual services may need to be adjusted. See our _[Resource Estimator](/self-hosted/deploy/resource-estimator)_ for more information. 2. Review the customized Helm chart @@ -107,7 +107,7 @@ When making configuration changes, it's recommended to review the changes that w #### Using external PostgreSQL databases -To use external PostgreSQL databases, first review our [general recommendations](/self-hosted/external_services/postgres#using-your-own-postgresql-server) and [required postgres permissions](/self-hosted/external_services/postgres#postgres-permissions-and-database-migrations). +To use external PostgreSQL databases, first review our [general recommendations](/self-hosted/external-services/postgres#using-your-own-postgresql-server) and [required postgres permissions](/self-hosted/external-services/postgres#postgres-permissions-and-database-migrations). We recommend storing the credentials in [Secrets] created outside the helm chart and managed in a secure manner. Each database requires its own Secret and should follow the following format. The Secret name can be customized as desired: @@ -191,7 +191,7 @@ pgsql: #### Using external Redis instances -To use external Redis instances, first review our [general recommendations](/self-hosted/external_services/redis). +To use external Redis instances, first review our [general recommendations](/self-hosted/external-services/redis). If your external Redis instances do not require authentication, you can configure access in your [override.yaml](https://github.com/sourcegraph/deploy-sourcegraph-helm/blob/main/charts/sourcegraph/examples/external-redis/override.yaml) with the `endpoint` settings: @@ -245,14 +245,14 @@ The [using your own Redis](https://github.com/sourcegraph/deploy-sourcegraph-hel #### Using external Object Storage -To use an external Object Storage service (S3-compatible services, or GCS), first review our [general recommendations](/self-hosted/external_services/object_storage). Then review the following example and adjust to your use case. +To use an external Object Storage service (S3-compatible services, or GCS), first review our [general recommendations](/self-hosted/external-services/object-storage). Then review the following example and adjust to your use case. See [override.yaml](https://github.com/sourcegraph/deploy-sourcegraph-helm/tree/main/charts/sourcegraph/examples/external-object-storage/override.yaml) for an example override file. The example assumes the use of AWS S3. You may configure the environment variables accordingly for your own use case based - on our [general recommendations](/self-hosted/external_services/object_storage). + on our [general recommendations](/self-hosted/external-services/object-storage). If you provide credentials with an access key / secret key, we recommend storing the credentials in [Secrets] created outside the helm chart and managed in a secure manner. An example Secret is shown here: @@ -1115,7 +1115,7 @@ You can revert to a previous version with the following command: $ helm rollback sourcegraph ``` -If you are rolling back more than a single version, then you must also [roll back your database](/self-hosted/how-to/rollback_database), as database migrations (which may have run at some point during the upgrade) are guaranteed to be compatible with one previous minor version. +If you are rolling back more than a single version, then you must also [roll back your database](/self-hosted/how-to/rollback-database), as database migrations (which may have run at some point during the upgrade) are guaranteed to be compatible with one previous minor version. ### Database Migrations diff --git a/docs/self-hosted/deploy/kubernetes/operations.mdx b/docs/self-hosted/deploy/kubernetes/operations.mdx index e67c5abb5..12015d14e 100644 --- a/docs/self-hosted/deploy/kubernetes/operations.mdx +++ b/docs/self-hosted/deploy/kubernetes/operations.mdx @@ -234,7 +234,7 @@ The following instructions are specific to backing up and restoring the sourcegr ### Back up Sourcegraph databases -These instructions will back up the primary `sourcegraph` database, the [codeintel](/code-navigation/) database, and the [codeinsights](/code_insights/) database. +These instructions will back up the primary `sourcegraph` database, the [codeintel](/code-navigation/) database, and the [codeinsights](/code-insights/) database. A. Verify deployment running diff --git a/docs/self-hosted/deploy/kubernetes/scale.mdx b/docs/self-hosted/deploy/kubernetes/scale.mdx index 26c739117..db343dbea 100644 --- a/docs/self-hosted/deploy/kubernetes/scale.mdx +++ b/docs/self-hosted/deploy/kubernetes/scale.mdx @@ -6,7 +6,7 @@ Increase resources according to the [Scaling Overview per Service](/self-hosted/ ## Cluster resource guidelines -For production environments, we recommend allocate resources based on your [instance size](/self-hosted/deploy/instance-size). See our [resource estimator](/self-hosted/deploy/resource_estimator) for estimates. +For production environments, we recommend allocate resources based on your [instance size](/self-hosted/deploy/instance-size). See our [resource estimator](/self-hosted/deploy/resource-estimator) for estimates. --- diff --git a/docs/self-hosted/deploy/kubernetes/upgrade.mdx b/docs/self-hosted/deploy/kubernetes/upgrade.mdx index 2d2f7671d..b4f01dd9f 100644 --- a/docs/self-hosted/deploy/kubernetes/upgrade.mdx +++ b/docs/self-hosted/deploy/kubernetes/upgrade.mdx @@ -204,7 +204,7 @@ Admins upgrading a Sourcegraph instance older than `v4.5.0` and migrating from o You can rollback by resetting your `release` branch to the old state before redeploying the instance. -If you are rolling back more than a single version, then you must also [rollback your database](/self-hosted/how-to/rollback_database), as database migrations (which may have run at some point during the upgrade) are guaranteed to be compatible with one previous minor version. +If you are rolling back more than a single version, then you must also [rollback your database](/self-hosted/how-to/rollback-database), as database migrations (which may have run at some point during the upgrade) are guaranteed to be compatible with one previous minor version. ### Rollback with Kustomize diff --git a/docs/self-hosted/deploy/machine-images/aws-ami.mdx b/docs/self-hosted/deploy/machine-images/aws-ami.mdx index 19e773afa..a150e7191 100644 --- a/docs/self-hosted/deploy/machine-images/aws-ami.mdx +++ b/docs/self-hosted/deploy/machine-images/aws-ami.mdx @@ -62,9 +62,9 @@ To configure SSL, and lock down the instance from the public internet, see the [ ### Executors -Executors are supported using [native kubernetes executors](/self-hosted/executors/deploy_executors_kubernetes). +Executors are supported using [native kubernetes executors](/self-hosted/executors/deploy-executors-kubernetes). -Executors support [auto-indexing](/code-navigation/auto_indexing) and [server-side batch changes](/batch-changes/server-side). +Executors support [auto-indexing](/code-navigation/auto-indexing) and [server-side batch changes](/batch-changes/server-side). To enable executors you must do the following: diff --git a/docs/self-hosted/deploy/machine-images/aws-oneclick.mdx b/docs/self-hosted/deploy/machine-images/aws-oneclick.mdx index 2c047fafa..d43df9f7e 100644 --- a/docs/self-hosted/deploy/machine-images/aws-oneclick.mdx +++ b/docs/self-hosted/deploy/machine-images/aws-oneclick.mdx @@ -70,9 +70,9 @@ Find the URL of your Sourcegraph instance in the **Outputs** section of the AWS ### Executors -Executors are supported using [native kubernetes executors](/self-hosted/executors/deploy_executors_kubernetes). +Executors are supported using [native kubernetes executors](/self-hosted/executors/deploy-executors-kubernetes). -Executors support [auto-indexing](/code-navigation/auto_indexing) and [server-side batch changes](/batch-changes/server-side). +Executors support [auto-indexing](/code-navigation/auto-indexing) and [server-side batch changes](/batch-changes/server-side). To enable executors you must do the following: diff --git a/docs/self-hosted/deploy/machine-images/gce.mdx b/docs/self-hosted/deploy/machine-images/gce.mdx index 0ca8f792b..c058fc230 100644 --- a/docs/self-hosted/deploy/machine-images/gce.mdx +++ b/docs/self-hosted/deploy/machine-images/gce.mdx @@ -119,9 +119,9 @@ $ sudo su sourcegraph ### Executors -Executors are supported using [native kubernetes executors](/self-hosted/executors/deploy_executors_kubernetes). +Executors are supported using [native kubernetes executors](/self-hosted/executors/deploy-executors-kubernetes). -Executors support [auto-indexing](/code-navigation/auto_indexing) and [server-side batch changes](/batch-changes/server-side). +Executors support [auto-indexing](/code-navigation/auto-indexing) and [server-side batch changes](/batch-changes/server-side). To enable executors you must do the following: @@ -252,7 +252,7 @@ We **strongly recommend** taking [snapshots of the entire data volume](https://c ## Manual deploy on GCE -Click [here](../docker-compose/google_cloud) to view install instructions for deploying on GCE manually. +Click [here](../docker-compose/google-cloud) to view install instructions for deploying on GCE manually. ## Additional resources diff --git a/docs/self-hosted/deploy/machine-images/index.mdx b/docs/self-hosted/deploy/machine-images/index.mdx index 3a019bb80..54da4417f 100644 --- a/docs/self-hosted/deploy/machine-images/index.mdx +++ b/docs/self-hosted/deploy/machine-images/index.mdx @@ -31,7 +31,7 @@ All Sourcegraph machine images are free to download, and we encourage you to spi - [Executors](../executors) are not included in machine images and need to be deployed separately - The use of [external services](../external_services/) such as managed + The use of [external services](../external-services/) such as managed Postgres databases or third party object storage services is not supported when using Sourcegraph Machine Images. diff --git a/docs/self-hosted/deploy/migrate-backup.mdx b/docs/self-hosted/deploy/migrate-backup.mdx index 50e185d89..2dd8e2a3e 100644 --- a/docs/self-hosted/deploy/migrate-backup.mdx +++ b/docs/self-hosted/deploy/migrate-backup.mdx @@ -18,8 +18,8 @@ These files are the most essential pieces of information required for a migratio | Data | Can it be recreated without a backup? | Notes | | --------------------------------------------------------------------------------- | ------------------------------------- | --------------------------------------------------------------------------------- | -| [Site configuration](/admin/config/site_config) | No | This file contains key configuration that defines how the product works. | -| [Code host connection configuration(s)](/admin/code_hosts/) | No | Each connection to an external code host has its own short configuration file. | +| [Site configuration](/admin/config/site-config) | No | This file contains key configuration that defines how the product works. | +| [Code host connection configuration(s)](/admin/code-hosts/) | No | Each connection to an external code host has its own short configuration file. | | [Global settings](/admin/config/settings#editing-global-settings-for-site-admins) | No | Default settings can be set by administrators for all users by editing this file. | Backing up this data is as simple as copy-pasting the text from the files described above on the old Sourcegraph instance into the new one. @@ -37,11 +37,11 @@ This list is not guaranteed to be complete, but rather representative of the typ | [Repository permissions](/admin/permissions/) | Yes | | | [Organizations](/admin/organizations) | No | | | [User and org settings](/admin/config/settings) | No | Global settings can be backed up as described above, but user-level and org-level settings cannot. | -| [Saved searches](/code-search/working/saved_searches) | No | | +| [Saved searches](/code-search/working/saved-searches) | No | | | User-generated access tokens | No | | | [Batch Changes](/batch-changes/) | No | | -| [Code graph metadata](/code-navigation/precise_code_navigation) | Yes (if manually regenerated) | This can be regenerated by re-running the indexing and upload process for affected repositories and revisions, but will not be regenerated by default. | -| [User survey responses](/admin/user_surveys) | No | | +| [Code graph metadata](/code-navigation/precise-code-navigation) | Yes (if manually regenerated) | This can be regenerated by re-running the indexing and upload process for affected repositories and revisions, but will not be regenerated by default. | +| [User survey responses](/admin/user-surveys) | No | | ### Data stored on disk @@ -53,7 +53,7 @@ This list is not guaranteed to be complete, but rather representative of the typ | ----------------------------------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | Repository (git) data | Yes | | | Search indexes | Yes | | -| [Code graph data](/code-navigation/precise_code_navigation) | No | This can be regenerated by re-running the indexing and upload process for affected repositories and revisions, but will not be regenerated by default. | +| [Code graph data](/code-navigation/precise-code-navigation) | No | This can be regenerated by re-running the indexing and upload process for affected repositories and revisions, but will not be regenerated by default. | | [Prometheus metrics](/self-hosted/observability/metrics) | No | | | blobstore | Yes | This is where unprocessed uploads are stored. | @@ -63,7 +63,7 @@ Short-lived data, including session data and some usage statistics, are stored i ### External data -Certain categories of data can be stored outside the Sourcegraph deployment. For example, [configuration JSON files can be loaded from disk](/self-hosted/advanced_config_file), and Sourcegraph can connect to [external services (PostgreSQL, Redis, S3/GCS)](/self-hosted/external_services/) instead of using PostgreSQL, Redis, and blobstore internally. +Certain categories of data can be stored outside the Sourcegraph deployment. For example, [configuration JSON files can be loaded from disk](/self-hosted/advanced-config-file), and Sourcegraph can connect to [external services (PostgreSQL, Redis, S3/GCS)](/self-hosted/external-services/) instead of using PostgreSQL, Redis, and blobstore internally. In these cases, no migration should be necessary, simply re-use the existing external data sources on the new Sourcegraph instance. diff --git a/docs/self-hosted/deploy/resource_estimator.mdx b/docs/self-hosted/deploy/resource-estimator.mdx similarity index 100% rename from docs/self-hosted/deploy/resource_estimator.mdx rename to docs/self-hosted/deploy/resource-estimator.mdx diff --git a/docs/self-hosted/deploy/scale.mdx b/docs/self-hosted/deploy/scale.mdx index 463415971..6dd0ef427 100644 --- a/docs/self-hosted/deploy/scale.mdx +++ b/docs/self-hosted/deploy/scale.mdx @@ -38,7 +38,7 @@ Here is a list of components you can find in a typical Sourcegraph deployment: ### External Services -A list of services that can be externalized. See our docs on [Using external services with Sourcegraph](/admin/code_hosts/) for detailed instruction. +A list of services that can be externalized. See our docs on [Using external services with Sourcegraph](/admin/code-hosts/) for detailed instruction. | | | | :------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/self-hosted/deploy/without_service_discovery.mdx b/docs/self-hosted/deploy/without-service-discovery.mdx similarity index 100% rename from docs/self-hosted/deploy/without_service_discovery.mdx rename to docs/self-hosted/deploy/without-service-discovery.mdx diff --git a/docs/self-hosted/deployment_best_practices.mdx b/docs/self-hosted/deployment-best-practices.mdx similarity index 96% rename from docs/self-hosted/deployment_best_practices.mdx rename to docs/self-hosted/deployment-best-practices.mdx index be7f99485..4c68eae1e 100644 --- a/docs/self-hosted/deployment_best_practices.mdx +++ b/docs/self-hosted/deployment-best-practices.mdx @@ -10,7 +10,7 @@ Sourcegraph is a highly scalable and configurable application. As an open source - user's engagement level - number and size of code repositories synced to Sourcegraph. -_To get a better idea of your resource requirements for your instance use our [resource estimator](/self-hosted/deploy/resource_estimator)._ +_To get a better idea of your resource requirements for your instance use our [resource estimator](/self-hosted/deploy/resource-estimator)._ ## Deployment Best Practices @@ -51,7 +51,7 @@ _It is possible to migrate your data to a Docker-Compose or Kubernetes deploymen ### Precise code navigation and Batch Changes -- The list of languages currently supported for precise code navigation can be found [here](/code-navigation/auto_indexing) +- The list of languages currently supported for precise code navigation can be found [here](/code-navigation/auto-indexing) - Requirements to set-up Batch Changes can be found [here](/batch-changes/requirements) ### Browser extensions diff --git a/docs/self-hosted/email.mdx b/docs/self-hosted/email.mdx index a7fea0c6e..12985fad1 100644 --- a/docs/self-hosted/email.mdx +++ b/docs/self-hosted/email.mdx @@ -2,7 +2,7 @@ Sourcegraph uses an SMTP server of your choosing to send emails for: -- [Code Monitoring](/code_monitoring/) notifications +- [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 diff --git a/docs/self-hosted/executors/deploy_executors_binary_offline.mdx b/docs/self-hosted/executors/deploy-executors-binary-offline.mdx similarity index 95% rename from docs/self-hosted/executors/deploy_executors_binary_offline.mdx rename to docs/self-hosted/executors/deploy-executors-binary-offline.mdx index e6f44d666..9ea5b293c 100644 --- a/docs/self-hosted/executors/deploy_executors_binary_offline.mdx +++ b/docs/self-hosted/executors/deploy-executors-binary-offline.mdx @@ -5,7 +5,7 @@ When running in an air-gap environment, the executor binary can be deployed with ## Initial Dependencies Executors -require [initial dependencies](/self-hosted/executors/deploy_executors_binary#dependencies) to +require [initial dependencies](/self-hosted/executors/deploy-executors-binary#dependencies) to be installed on the host machine. The minimum dependencies (when not using [Firecracker](/admin/executors/#firecracker) Isolation) are: @@ -31,7 +31,7 @@ pull the images. ## Environment Variables -See [deploy executors binary](/self-hosted/executors/deploy_executors_binary#step-2-setup-environment-variables) for a list of environment +See [deploy executors binary](/self-hosted/executors/deploy-executors-binary#step-2-setup-environment-variables) for a list of environment variables that are configurable. ## Batch Changes @@ -83,7 +83,7 @@ If you are not using Firecracker, ensure the environment variable `EXECUTOR_USE_ ### Initial Dependencies Executors running Firecracker Isolation -require [initial dependencies](/self-hosted/executors/deploy_executors_binary#dependencies) to +require [initial dependencies](/self-hosted/executors/deploy-executors-binary#dependencies) to be installed on the host machine. - `dmsetup` diff --git a/docs/self-hosted/executors/deploy_executors_binary.mdx b/docs/self-hosted/executors/deploy-executors-binary.mdx similarity index 98% rename from docs/self-hosted/executors/deploy_executors_binary.mdx rename to docs/self-hosted/executors/deploy-executors-binary.mdx index 23f4f7c5e..465dbfaed 100644 --- a/docs/self-hosted/executors/deploy_executors_binary.mdx +++ b/docs/self-hosted/executors/deploy-executors-binary.mdx @@ -2,7 +2,7 @@ ## Installation -> Note: See [offline installation guide](/self-hosted/executors/deploy_executors_binary_offline) for instructions on how to install executors in an air-gapped environment. +> Note: See [offline installation guide](/self-hosted/executors/deploy-executors-binary-offline) for instructions on how to install executors in an air-gapped environment. The following steps will guide you through the process of installing executors on a linux machine. @@ -76,7 +76,7 @@ mv executor /usr/local/bin The executor Linux binary is configured through environment variables which need to be passed to it when you run it (including for the `install`, `validate` and `test-vm` comamnds). You can add these to your shell profile, or an environment file. The `EXECUTOR_FRONTEND_URL`, `EXECUTOR_FRONTEND_PASSWORD` and `EXECUTOR_QUEUE_NAME` **or** `EXECUTOR_QUEUE_NAMES` are _required_ and will need to be set prior to running the executor service for the first time. -See [Executor configuration](/self-hosted/executors/executors_config) for a full list of configuration options for the executor service. +See [Executor configuration](/self-hosted/executors/executors-config) for a full list of configuration options for the executor service. ```bash # Example: diff --git a/docs/self-hosted/executors/deploy_executors_dind.mdx b/docs/self-hosted/executors/deploy-executors-dind.mdx similarity index 92% rename from docs/self-hosted/executors/deploy_executors_dind.mdx rename to docs/self-hosted/executors/deploy-executors-dind.mdx index 2e489794d..de42b8d1c 100644 --- a/docs/self-hosted/executors/deploy_executors_dind.mdx +++ b/docs/self-hosted/executors/deploy-executors-dind.mdx @@ -30,7 +30,7 @@ To specifically deploy Executors, 1. Create an overrides file, `override.yaml`, with any other customizations you may require. 1. See [details on configurations](/self-hosted/deploy/kubernetes#configuration) - 2. See [here](/self-hosted/executors/executors_config) for a full list of executor environment variables + 2. See [here](/self-hosted/executors/executors-config) for a full list of executor environment variables 2. Run the following command: ```bash @@ -42,4 +42,4 @@ To specifically deploy Executors, Executors deployed in kubernetes do not use [Firecracker](/admin/executors/#how-it-works), meaning they require [privileged access](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) to the docker daemon running in a sidecar alongside the executor pod. -If you have security concerns, consider deploying via [terraform](/self-hosted/executors/deploy_executors_terraform) or [installing the binary](/self-hosted/executors/deploy_executors_binary) directly. +If you have security concerns, consider deploying via [terraform](/self-hosted/executors/deploy-executors-terraform) or [installing the binary](/self-hosted/executors/deploy-executors-binary) directly. diff --git a/docs/self-hosted/executors/deploy_executors_docker.mdx b/docs/self-hosted/executors/deploy-executors-docker.mdx similarity index 89% rename from docs/self-hosted/executors/deploy_executors_docker.mdx rename to docs/self-hosted/executors/deploy-executors-docker.mdx index 5eed44983..9aae38d86 100644 --- a/docs/self-hosted/executors/deploy_executors_docker.mdx +++ b/docs/self-hosted/executors/deploy-executors-docker.mdx @@ -18,11 +18,11 @@ Privileged containers are required to run executors in docker-compose. This is b - Minimum Docker [v20.10.0](https://docs.docker.com/engine/release-notes/#20100) and Docker Compose [v1.29.0](https://docs.docker.com/compose/release-notes/#1290) - Docker Swarm mode is **not** supported - Clone the [deploy-sourcegraph-docker](https://github.com/sourcegraph/deploy-sourcegraph-docker) -- Edit the `deploy-sourcegraph-docker/docker-compose/executors/executor.docker-compose.yaml` and update the [environment variables](/self-hosted/executors/executors_config) +- Edit the `deploy-sourcegraph-docker/docker-compose/executors/executor.docker-compose.yaml` and update the [environment variables](/self-hosted/executors/executors-config) - Follow the instructions in the `README` for more specific deployment instructions. ## Note Executors deployed via docker-compose do not use [Firecracker](/admin/executors/#how-it-works), meaning they require [privileged access](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) to the docker daemon running on the host. -If you have security concerns, consider deploying via [terraform](/self-hosted/executors/deploy_executors_terraform) or [installing the binary](/self-hosted/executors/deploy_executors_binary) directly. +If you have security concerns, consider deploying via [terraform](/self-hosted/executors/deploy-executors-terraform) or [installing the binary](/self-hosted/executors/deploy-executors-binary) directly. diff --git a/docs/self-hosted/executors/deploy_executors_kubernetes.mdx b/docs/self-hosted/executors/deploy-executors-kubernetes.mdx similarity index 96% rename from docs/self-hosted/executors/deploy_executors_kubernetes.mdx rename to docs/self-hosted/executors/deploy-executors-kubernetes.mdx index 2b60121e7..7ff0999e4 100644 --- a/docs/self-hosted/executors/deploy_executors_kubernetes.mdx +++ b/docs/self-hosted/executors/deploy-executors-kubernetes.mdx @@ -4,7 +4,7 @@ This feature is in beta and is available in Sourcegraph 5.1.0 and later. -The native Kubernetes Executors have a master Executor pod that schedules worker pods via the Kubernetes API. The master Executor pod manages the lifecycle of jobs, while the worker pods process the actual [batch change](/batch-changes/server-side) or [precise auto indexing](/code-navigation/auto_indexing) job specs. For more details, see [how it works](/admin/executors#native-kubernetes). +The native Kubernetes Executors have a master Executor pod that schedules worker pods via the Kubernetes API. The master Executor pod manages the lifecycle of jobs, while the worker pods process the actual [batch change](/batch-changes/server-side) or [precise auto indexing](/code-navigation/auto-indexing) job specs. For more details, see [how it works](/admin/executors#native-kubernetes). ## Requirements @@ -74,7 +74,7 @@ Native Kubernetes Executors can be deployed via either the `sourcegraph-executor Additional environment variables may need to be configured for your - Executors deployment. See [here](/self-hosted/executors/executors_config) for + Executors deployment. See [here](/self-hosted/executors/executors-config) for a complete list. @@ -89,8 +89,8 @@ Native Kubernetes Executors can be deployed via either the `sourcegraph-executor Executors deployed on Kubernetes do not use [Firecracker](/admin/executors/#how-it-works). -If you have security concerns, consider deploying via [terraform](/self-hosted/executors/deploy_executors_terraform) -or [installing the binary](/self-hosted/executors/deploy_executors_binary) directly. +If you have security concerns, consider deploying via [terraform](/self-hosted/executors/deploy-executors-terraform) +or [installing the binary](/self-hosted/executors/deploy-executors-binary) directly. ### Job Scheduling diff --git a/docs/self-hosted/executors/deploy_executors_terraform.mdx b/docs/self-hosted/executors/deploy-executors-terraform.mdx similarity index 98% rename from docs/self-hosted/executors/deploy_executors_terraform.mdx rename to docs/self-hosted/executors/deploy-executors-terraform.mdx index 4e64ceefa..dab9ed0ac 100644 --- a/docs/self-hosted/executors/deploy_executors_terraform.mdx +++ b/docs/self-hosted/executors/deploy-executors-terraform.mdx @@ -43,8 +43,8 @@ module "executors" { | `zone` | The **Google** zone to provision the executor resources in. | | `executor_sourcegraph_external_url` | The public URL of your Sourcegraph instance. This corresponds to the `externalURL` value in your Sourcegraph instance’s site configuration and must be resolvable from the provisioned executor compute resources. | | `executor_sourcegraph_executor_proxy_password` | The access token corresponding to the `executors.accessToken` in your Sourcegraph instance's site configuration. | -| `executor_queue_name` | The single queue from which the executor should pull jobs - [`codeintel`](/code-navigation/auto_indexing) or [`batches`](/batch-changes/server-side). Either this or `executor_queue_names` must be set. | -| `executor_queue_names` | The multiple queues from which the executor should pull jobs - one or more of [`codeintel`](/code-navigation/auto_indexing) and [`batches`](/batch-changes/server-side). Either this or `executor_queue_name` must be set. | +| `executor_queue_name` | The single queue from which the executor should pull jobs - [`codeintel`](/code-navigation/auto-indexing) or [`batches`](/batch-changes/server-side). Either this or `executor_queue_names` must be set. | +| `executor_queue_names` | The multiple queues from which the executor should pull jobs - one or more of [`codeintel`](/code-navigation/auto-indexing) and [`batches`](/batch-changes/server-side). Either this or `executor_queue_name` must be set. | | `executor_instance_tag` | A label tag to add to all the executors; can be used for filtering out the right instances in stackdriver monitoring | | `executor_metrics_environment_label` | The value for environment by which to filter the custom metrics. | @@ -286,7 +286,7 @@ you@sourcegraph-executor-h0rv:~$ curl ## Auto-scaling > NOTE: Auto scaling is currently not supported -> when [downloading and running executor binaries yourself](/self-hosted/executors/deploy_executors_binary), +> when [downloading and running executor binaries yourself](/self-hosted/executors/deploy-executors-binary), > and on managed instances when using self-hosted executors, since it requires deployment adjustments. Auto-scaling of executor instances can help to increase concurrency of jobs, without paying for unused resources. With auto-scaling, you can scale down to 0 instances when no workload exist and scale up as far as you like and your cloud provider can support. Auto-scaling needs to be configured separately. @@ -410,7 +410,7 @@ Next, you can test whether the number of executors rises and shrinks as load spi ## Upgrading executors Upgrading executors is relatively uninvolved. Simply follow the instructions below. -Also, check the [changelog](https://sourcegraph.com/changelog) for any Executors related breaking changes or new features or flags that you might want to configure. See [Executors maintenance](/self-hosted/executors/deploy_executors#Maintaining-and-upgrading-executors) for version compatability. +Also, check the [changelog](https://sourcegraph.com/changelog) for any Executors related breaking changes or new features or flags that you might want to configure. See [Executors maintenance](/self-hosted/executors/deploy-executors#Maintaining-and-upgrading-executors) for version compatability. ### **Step 1:** Update the source version of the terraform modules diff --git a/docs/self-hosted/executors/deploy_executors.mdx b/docs/self-hosted/executors/deploy-executors.mdx similarity index 91% rename from docs/self-hosted/executors/deploy_executors.mdx rename to docs/self-hosted/executors/deploy-executors.mdx index ef557a957..c73678feb 100644 --- a/docs/self-hosted/executors/deploy_executors.mdx +++ b/docs/self-hosted/executors/deploy-executors.mdx @@ -2,11 +2,11 @@ Executors can be deployed in a variety of manners. The supported deployment options are: -- [Linux Binary Service](/self-hosted/executors/deploy_executors_binary) ([Firecracker](./firecracker) compatible) -- [Terraform on AWS or GCP](/self-hosted/executors/deploy_executors_terraform) ([Firecracker](./firecracker) compatible) -- [Native Kubernetes](/self-hosted/executors/deploy_executors_kubernetes) -- [Docker-in-Docker on Kubernetes](/self-hosted/executors/deploy_executors_dind) -- [Docker-Compose](/self-hosted/executors/deploy_executors_docker) +- [Linux Binary Service](/self-hosted/executors/deploy-executors-binary) ([Firecracker](./firecracker) compatible) +- [Terraform on AWS or GCP](/self-hosted/executors/deploy-executors-terraform) ([Firecracker](./firecracker) compatible) +- [Native Kubernetes](/self-hosted/executors/deploy-executors-kubernetes) +- [Docker-in-Docker on Kubernetes](/self-hosted/executors/deploy-executors-dind) +- [Docker-Compose](/self-hosted/executors/deploy-executors-docker) See [deciding which executor deployment method to use ](../executors#deciding-which-executor-deployment-method-to-use) for more information on these different deployment options. @@ -46,7 +46,7 @@ The maximum number of Jobs an Executor instance can run in parallel is configure The CPU and Memory usage of an individual Job is configured by the Environment Variables `EXECUTOR_JOB_NUM_CPUS` and `EXECUTOR_JOB_MEMORY`. -See [executor configuration](/self-hosted/executors/executors_config) for a full list of configuration options. +See [executor configuration](/self-hosted/executors/executors-config) for a full list of configuration options. Note: changing CPU and Memory for jobs will affect the overall requirements @@ -68,7 +68,7 @@ It is recommended to add the following **Disk** configuration in AWS. #### Firecracker requirements To run Executors with Firecracker enabled requires the machine to support [Kernel-based Virtual Machine](https://en.wikipedia.org/wiki/Kernel-based_Virtual_Machine). -See [deploying Executors binary](/self-hosted/executors/deploy_executors_binary) for additional information on configuring Linux Machines. +See [deploying Executors binary](/self-hosted/executors/deploy-executors-binary) for additional information on configuring Linux Machines. #### Cloud providers @@ -85,7 +85,7 @@ Executors must be run separately from your Sourcegraph instance. Since they must still be able to reach the Sourcegraph instance in order to dequeue and perform work, requests between the Sourcegraph instance and the executors are authenticated via a shared secret. -Before starting any executors, generate an arbitrary secret string (with at least 20 characters) and [set it as the `executors.accessToken` key in your Sourcegraph instance's site-config](/admin/config/site_config#view-and-edit-site-configuration). The `EXECUTOR_FRONTEND_PASSWORD` environment variable on the executor instance will need to be configured with the same secret string. +Before starting any executors, generate an arbitrary secret string (with at least 20 characters) and [set it as the `executors.accessToken` key in your Sourcegraph instance's site-config](/admin/config/site-config#view-and-edit-site-configuration). The `EXECUTOR_FRONTEND_PASSWORD` environment variable on the executor instance will need to be configured with the same secret string. ## Executor installation @@ -97,31 +97,31 @@ Once the shared secret is set in Sourcegraph, you can start setting up executors @@ -138,7 +138,7 @@ If you want to use docker images stored in a private registry that requires auth Depending on the executor runtime that is being used, different options exist for provisioning access to private container registries: -- Through a special secret called `DOCKER_AUTH_CONFIG`, set in [executor secrets](/admin/executors/executor_secrets) in Sourcegraph. +- Through a special secret called `DOCKER_AUTH_CONFIG`, set in [executor secrets](/admin/executors/executor-secrets) in Sourcegraph. - Through the `EXECUTOR_DOCKER_AUTH_CONFIG` environment variable (also available as a variable in the terraform modules for executors). - Through the [`config.json` file in `~/.docker`](https://docs.docker.com/engine/reference/commandline/login/). **If using executors with firecracker enabled (recommended) this option is not available.** @@ -204,7 +204,7 @@ For Google Container Registry, [follow this guide](https://cloud.google.com/cont ### Configuring the auth config for use in executors -Now that the config has been obtained, it can be used for the `EXECUTOR_DOCKER_AUTH_CONFIG` environment variable (and terraform variable `docker_auth_config`) or you can create an [executor secret](/admin/executors/executor_secrets#creating-a-new-secret) called `DOCKER_AUTH_CONFIG`. Global executor secrets will be available to every execution, while user and organization level executor secrets will only be available to the namespaces executions. +Now that the config has been obtained, it can be used for the `EXECUTOR_DOCKER_AUTH_CONFIG` environment variable (and terraform variable `docker_auth_config`) or you can create an [executor secret](/admin/executors/executor-secrets#creating-a-new-secret) called `DOCKER_AUTH_CONFIG`. Global executor secrets will be available to every execution, while user and organization level executor secrets will only be available to the namespaces executions. ## Using custom certificates with executors @@ -226,9 +226,9 @@ If your environment makes use of custom certificates, you can add them to one of ### Adding certificates to a binary deployment -> NOTE: see the [troubleshooting guide](/self-hosted/executors/executors_troubleshooting#connecting-to-cloud-provider-executor-instances) for instructions on how to connect to cloud provider VMs. +> NOTE: see the [troubleshooting guide](/self-hosted/executors/executors-troubleshooting#connecting-to-cloud-provider-executor-instances) for instructions on how to connect to cloud provider VMs. -After successfully [deploying binaries](/self-hosted/executors/deploy_executors_binary), follow these steps: +After successfully [deploying binaries](/self-hosted/executors/deploy-executors-binary), follow these steps: 1. Copy your certificates to `/etc/ssl/certs`. 1. If you are using systemd, run `systemctl restart executor`. If not, proceed to the next step. diff --git a/docs/self-hosted/executors/executors_config.mdx b/docs/self-hosted/executors/executors-config.mdx similarity index 100% rename from docs/self-hosted/executors/executors_config.mdx rename to docs/self-hosted/executors/executors-config.mdx diff --git a/docs/self-hosted/executors/executors_troubleshooting.mdx b/docs/self-hosted/executors/executors-troubleshooting.mdx similarity index 98% rename from docs/self-hosted/executors/executors_troubleshooting.mdx rename to docs/self-hosted/executors/executors-troubleshooting.mdx index d1db17000..d6a0e790c 100644 --- a/docs/self-hosted/executors/executors_troubleshooting.mdx +++ b/docs/self-hosted/executors/executors-troubleshooting.mdx @@ -21,7 +21,7 @@ You can now run `executor validate`, which will inform you about any configurati The next step is to create a temporary Firecracker VM for debugging purposes. -> NOTE: if the host VM is provisioned with the [Sourcegraph terraform modules](/self-hosted/executors/deploy_executors_terraform), the VMs may be configured to stop automatically. Refer to [Disabling the auto-deletion of Executor VMs](#disabling-the-auto-deletion-of-executor-vms) for information to prevent this. +> NOTE: if the host VM is provisioned with the [Sourcegraph terraform modules](/self-hosted/executors/deploy-executors-terraform), the VMs may be configured to stop automatically. Refer to [Disabling the auto-deletion of Executor VMs](#disabling-the-auto-deletion-of-executor-vms) for information to prevent this. Run one of the following commands `executor test-vm` to generate a test firecracker VM: @@ -44,7 +44,7 @@ Execute the generated `ignite attach ` command to gain a shell to the Firecr ## Disabling the auto-deletion of Executor VMs -> NOTE: These instructions are for users using the VMs deployed via the [Terraform Modules](/self-hosted/executors/deploy_executors_terraform) +> NOTE: These instructions are for users using the VMs deployed via the [Terraform Modules](/self-hosted/executors/deploy-executors-terraform) The Executor host VMs are configured to automatically tear themselves down once all jobs in the queue are completed. While this is desired behaviour under regular circumstances, it complicates debugging issues in the executor configuration or connections. To prevent the VMs from automatically stopping: @@ -58,7 +58,7 @@ The VM should now persist after all jobs are satisfied. If a server-side batch change fails unexpectedly, it's possible to recreate the generated Firecracker VM from the batch change execution. -> NOTE: if the host VM is provisioned with the [Sourcegraph terraform modules](/self-hosted/executors/deploy_executors_terraform), the VMs may be configured to stop automatically. Refer to [Disabling the auto-deletion of Executor VMs](#disabling-the-auto-deletion-of-executor-vms) for information to prevent this. +> NOTE: if the host VM is provisioned with the [Sourcegraph terraform modules](/self-hosted/executors/deploy-executors-terraform), the VMs may be configured to stop automatically. Refer to [Disabling the auto-deletion of Executor VMs](#disabling-the-auto-deletion-of-executor-vms) for information to prevent this. 1. Navigate to the failed execution page of the Batch Change 1. Select a failed Workspace on the left and click the `Diagnostics` link on the right pane @@ -188,7 +188,7 @@ This section lists some common mistakes with environment variables. Some of thes ## Verify Firecracker support -The VM instance must [support KVM](/self-hosted/executors/deploy_executors#firecracker-requirements). In effect, this means the instance must meet certain requirements depending on the Cloud provider in use. +The VM instance must [support KVM](/self-hosted/executors/deploy-executors#firecracker-requirements). In effect, this means the instance must meet certain requirements depending on the Cloud provider in use. ### GCP diff --git a/docs/self-hosted/executors/firecracker.mdx b/docs/self-hosted/executors/firecracker.mdx index aed377a36..d56b68d74 100644 --- a/docs/self-hosted/executors/firecracker.mdx +++ b/docs/self-hosted/executors/firecracker.mdx @@ -1,6 +1,6 @@ # Firecracker -[Executors](/admin/executors/), by design, are services that run arbitrary code supplied by a user. The executor jobs produced by precise code intelligence [auto-indexing](/code-navigation/auto_indexing) and [server-side batch changes](/batch-changes/server-side) are built to invoke _templated_ execution plans, where some parts of execution may invoke code configured by a Sourcegraph administrator or user. Generating a precise index requires invoking an indexer for that language. Batch changes are configured to run arbitrary tooling over the contents of a repository. +[Executors](/admin/executors/), by design, are services that run arbitrary code supplied by a user. The executor jobs produced by precise code intelligence [auto-indexing](/code-navigation/auto-indexing) and [server-side batch changes](/batch-changes/server-side) are built to invoke _templated_ execution plans, where some parts of execution may invoke code configured by a Sourcegraph administrator or user. Generating a precise index requires invoking an indexer for that language. Batch changes are configured to run arbitrary tooling over the contents of a repository. Because Sourcegraph has access to your code and credentials to external tools, we've designed executors to be able to run separately from the Sourcegraph instance (on a raw compute node) with the minimum API surface area and user code exposed to the job required to meet its objective. This effectively reduces the blast radius of a misconfiguration or insecure configuration. @@ -20,7 +20,7 @@ For companies with very high security consciousness, Firecracker isolation is st To use Firecracker, the host machine has to support KVM. When deploying on an AWS, that means the compute node must run on a [metal instance (`.metal`)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html). When deploying on GCP, that means the compute node must have [nested virtualization enabled](https://cloud.google.com/compute/docs/instances/nested-virtualization/enabling). -See [deploying Executors binary](/self-hosted/executors/deploy_executors_binary) for additional information on configuring Linux Machines. +See [deploying Executors binary](/self-hosted/executors/deploy-executors-binary) for additional information on configuring Linux Machines. ### AWS Bare Metal diff --git a/docs/self-hosted/executors/index.mdx b/docs/self-hosted/executors/index.mdx index e601fba8f..8d4b8677f 100644 --- a/docs/self-hosted/executors/index.mdx +++ b/docs/self-hosted/executors/index.mdx @@ -7,16 +7,16 @@ Executors are Sourcegraph's solution for running untrusted code in a secure and controllable way. Executors provide a sandbox that can run resource-intensive or untrusted tasks on behalf of the Sourcegraph instance, such as: -- [Automatically indexing a repository for precise code navigation](/code-navigation/auto_indexing) +- [Automatically indexing a repository for precise code navigation](/code-navigation/auto-indexing) - [Running batch changes](/batch-changes/server-side) ## Installation -To deploy executors for your Sourcegraph instance, follow our [executor deployment guide](executors/deploy_executors). +To deploy executors for your Sourcegraph instance, follow our [executor deployment guide](executors/deploy-executors). ## Why use executors? -Running untrusted code is a core requirement of features such as precise code navigation [auto-indexing](/code-navigation/auto_indexing), and [running batch changes server-side](/batch-changes/server-side). +Running untrusted code is a core requirement of features such as precise code navigation [auto-indexing](/code-navigation/auto-indexing), and [running batch changes server-side](/batch-changes/server-side). Auto-indexing jobs, in particular, require the invocation of arbitrary and untrusted code to support the resolution of project dependencies. Invocation of post-install hooks, use of insecure [package management tools](https://github.com/golang/go/issues/29230), and package manager proxy attacks can create opportunities in which an adversary can gain unlimited use of compute or exfiltrate data. The latter outcome is particularly dangerous for on-premise installations of Sourcegraph, which is the chosen option for companies wanting to maintain strict privacy of their code property. @@ -186,4 +186,4 @@ Executor instances are capable of being deployed in a variety of ways. Each runt ## Troubleshooting -Refer to the [Troubleshooting Executors](/self-hosted/executors/executors_troubleshooting) document for common debugging operations. +Refer to the [Troubleshooting Executors](/self-hosted/executors/executors-troubleshooting) document for common debugging operations. diff --git a/docs/self-hosted/external_services/index.mdx b/docs/self-hosted/external-services/index.mdx similarity index 93% rename from docs/self-hosted/external_services/index.mdx rename to docs/self-hosted/external-services/index.mdx index 0ba457e33..180141684 100644 --- a/docs/self-hosted/external_services/index.mdx +++ b/docs/self-hosted/external-services/index.mdx @@ -18,9 +18,9 @@ Your Sourcegraph instance can be configured to use an external or managed versio See the following guides to use an external or managed version of each service type. -- See [Using your own PostgreSQL server](/self-hosted/external_services/postgres) to replace the bundled PostgreSQL instances. -- See [Using your own Redis server](/self-hosted/external_services/redis) to replace the bundled Redis instances. -- See [Using a managed object storage service (S3 or GCS)](/self-hosted/external_services/object_storage) to replace the bundled blobstore instance. +- See [Using your own PostgreSQL server](/self-hosted/external-services/postgres) to replace the bundled PostgreSQL instances. +- See [Using your own Redis server](/self-hosted/external-services/redis) to replace the bundled Redis instances. +- See [Using a managed object storage service (S3 or GCS)](/self-hosted/external-services/object-storage) to replace the bundled blobstore instance. - See [Using an external Jaeger instance](/self-hosted/observability/tracing#Use-an-external-Jaeger-instance) to replace the bundled Jaeger instance. > NOTE: Using Sourcegraph with an external service is a [paid feature](https://about.sourcegraph.com/pricing). [Contact us](https://about.sourcegraph.com/contact/sales) to get a trial license. diff --git a/docs/self-hosted/external_services/object_storage.mdx b/docs/self-hosted/external-services/object-storage.mdx similarity index 98% rename from docs/self-hosted/external_services/object_storage.mdx rename to docs/self-hosted/external-services/object-storage.mdx index db24d144a..d78b4591a 100644 --- a/docs/self-hosted/external_services/object_storage.mdx +++ b/docs/self-hosted/external-services/object-storage.mdx @@ -1,12 +1,12 @@ # Using a managed object storage service (S3 or GCS) -By default, Sourcegraph will use a `sourcegraph/blobstore` server bundled with the instance to temporarily store [code graph indexes](../../code-navigation/precise_code_navigation) uploaded by users as well as the results of [search jobs](../../code-search/types/search-jobs). +By default, Sourcegraph will use a `sourcegraph/blobstore` server bundled with the instance to temporarily store [code graph indexes](../../code-navigation/precise-code-navigation) uploaded by users as well as the results of [search jobs](../../code-search/types/search-jobs). You can alternatively configure your instance to instead store this data in an S3 or GCS bucket. Doing so may decrease your hosting costs as persistent volumes are often more expensive than the same storage space in an object store service. ## Code Graph Indexes -To target a managed object storage service for storing [code graph index uploads](../../code-navigation/precise_code_navigation), you will need to set a handful of environment variables for configuration and authentication to the target service. +To target a managed object storage service for storing [code graph index uploads](../../code-navigation/precise-code-navigation), you will need to set a handful of environment variables for configuration and authentication to the target service. - If you are running a `sourcegraph/server` deployment, set the environment variables on the server container - If you are running via Docker-compose or Kubernetes, set the environment variables on the `frontend`, `worker`, and `precise-code-intel-worker` containers diff --git a/docs/self-hosted/external_services/postgres.mdx b/docs/self-hosted/external-services/postgres.mdx similarity index 99% rename from docs/self-hosted/external_services/postgres.mdx rename to docs/self-hosted/external-services/postgres.mdx index 160df042f..346679567 100644 --- a/docs/self-hosted/external_services/postgres.mdx +++ b/docs/self-hosted/external-services/postgres.mdx @@ -346,7 +346,7 @@ CREATE extension intarray; After the database is configured, Sourcegraph will attempt to run migrations. There are a few migrations that may fail as they attempt to run actions that require `SUPERUSER` permissions. -These failures must be interpreted by the database administrator and resolved using guidance from [How to Troubleshoot a Dirty Database](/self-hosted/how-to/dirty_database). Generally-speaking this will involve looking up the migration source code and manually applying the necessary SQL code. +These failures must be interpreted by the database administrator and resolved using guidance from [How to Troubleshoot a Dirty Database](/self-hosted/how-to/dirty-database). Generally-speaking this will involve looking up the migration source code and manually applying the necessary SQL code. **Initial Schema Creation** @@ -356,7 +356,7 @@ The first migration fails since it attempts to add `COMMENT`s to installed exten failed to run migration for schema "frontend": failed upgrade migration 1528395834: ERROR: current transaction is aborted, commands ignored until end of transaction block (SQLSTATE 25P02) ``` -In this case, locate the UP migration 1528395834 and apply all SQL after the final `COMMENT ON EXTENSION` command following the [dirty database procedure](/self-hosted/how-to/dirty_database). +In this case, locate the UP migration 1528395834 and apply all SQL after the final `COMMENT ON EXTENSION` command following the [dirty database procedure](/self-hosted/how-to/dirty-database). **Dropping the `sg_service` role** @@ -407,7 +407,7 @@ CREATE extension intarray; After the database is configured, Sourcegraph will attempt to run migrations, this time using the CodeIntel DB. There are a few migrations that may fail as they attempt to run actions that require `SUPERUSER` permissions. -These failures must be intepreted by the database administrator and resolved using guidance from [How to Troubleshoot a Dirty Database](/self-hosted/how-to/dirty_database). Generally-speaking this will involve looking up the migration source code and manually applying the necessary SQL code. The `codeintel_schema_migrations` table should be consulted for dirty migrations in this case. +These failures must be intepreted by the database administrator and resolved using guidance from [How to Troubleshoot a Dirty Database](/self-hosted/how-to/dirty-database). Generally-speaking this will involve looking up the migration source code and manually applying the necessary SQL code. The `codeintel_schema_migrations` table should be consulted for dirty migrations in this case. **Initial CodeIntel schema creation** diff --git a/docs/self-hosted/external_services/redis.mdx b/docs/self-hosted/external-services/redis.mdx similarity index 97% rename from docs/self-hosted/external_services/redis.mdx rename to docs/self-hosted/external-services/redis.mdx index d980b8596..393136aab 100644 --- a/docs/self-hosted/external_services/redis.mdx +++ b/docs/self-hosted/external-services/redis.mdx @@ -24,4 +24,4 @@ If using Docker for Desktop, `host.docker.internal` will resolve to the host IP ### Kubernetes without Helm - See our documentation for Kubernetes [here](/self-hosted/deploy/kubernetes/configure#external-redis) -- **Related:** [How to Set a Password for Redis using a ConfigMap](/self-hosted/how-to/redis_configmap) +- **Related:** [How to Set a Password for Redis using a ConfigMap](/self-hosted/how-to/redis-configmap) diff --git a/docs/self-hosted/faq.mdx b/docs/self-hosted/faq.mdx index 9aa9e3867..cf08c73b9 100644 --- a/docs/self-hosted/faq.mdx +++ b/docs/self-hosted/faq.mdx @@ -79,7 +79,7 @@ More advanced users can also refer to [our FAQ item about custom consumption of ### Can I consume Sourcegraph's metrics in my own monitoring system (Datadog, New Relic, etc.)? -Sourcegraph provides [high-level alerting metrics](/self-hosted/observability/metrics#high-level-alerting-metrics) which you can integrate into your own monitoring system—see the [alerting custom consumption guide](/self-hosted/observability/alerting_custom_consumption) for more details. +Sourcegraph provides [high-level alerting metrics](/self-hosted/observability/metrics#high-level-alerting-metrics) which you can integrate into your own monitoring system—see the [alerting custom consumption guide](/self-hosted/observability/alerting-custom-consumption) for more details. While it is technically possible to consume all of Sourcegraph's metrics in an external system, our recommendation is to utilize the builtin monitoring tools and configure Sourcegraph to [send alerts to your own PagerDuty, Slack, email, etc.](/self-hosted/observability/alerting). Metrics and thresholds can change with each release, therefore manually defining the alerts required to monitor Sourcegraph's health is not recommended. Sourcegraph automatically updates the dashboards and alerts on each release to ensure the displayed information is up-to-date. diff --git a/docs/self-hosted/how-to/blobstore_debugging.mdx b/docs/self-hosted/how-to/blobstore-debugging.mdx similarity index 96% rename from docs/self-hosted/how-to/blobstore_debugging.mdx rename to docs/self-hosted/how-to/blobstore-debugging.mdx index 3a938d103..802e49496 100644 --- a/docs/self-hosted/how-to/blobstore_debugging.mdx +++ b/docs/self-hosted/how-to/blobstore-debugging.mdx @@ -1,6 +1,6 @@ # Blobstore debugging tips -If you recently updated to Sourcegraph v4.2.1+, please be sure to look at the [blobstore update notes](/self-hosted/how-to/blobstore_update_notes) +If you recently updated to Sourcegraph v4.2.1+, please be sure to look at the [blobstore update notes](/self-hosted/how-to/blobstore-update-notes) This page provides more tips on debugging why blobstore may not be working properly. @@ -8,7 +8,7 @@ This page provides more tips on debugging why blobstore may not be working prope ## Can I disable blobstore? -Today, Sourcegraph uses blobstore for storing precise code intel (LSIF/SCIP) uploads. You can also configure Sourcegraph to use [S3 or GCS for object storage](/self-hosted/external_services/object_storage) if you prefer. +Today, Sourcegraph uses blobstore for storing precise code intel (LSIF/SCIP) uploads. You can also configure Sourcegraph to use [S3 or GCS for object storage](/self-hosted/external-services/object-storage) if you prefer. In the near future, other Sourcegraph features like Batch Changes may also rely on object storage and so, if possible, it's best to make sure it is working. diff --git a/docs/self-hosted/how-to/blobstore_update_notes.mdx b/docs/self-hosted/how-to/blobstore-update-notes.mdx similarity index 97% rename from docs/self-hosted/how-to/blobstore_update_notes.mdx rename to docs/self-hosted/how-to/blobstore-update-notes.mdx index 668748d8f..6b100ce24 100644 --- a/docs/self-hosted/how-to/blobstore_update_notes.mdx +++ b/docs/self-hosted/how-to/blobstore-update-notes.mdx @@ -8,7 +8,7 @@ Sourcegraph is committed to only distributing open-source software that is permi As a result, Sourcegraph v4.2.1+ and v4.3+ no longer use or distribute _any_ minio or AGPL-licensed software. -If your Sourcegraph instance is already configured to use [external object storage](/self-hosted/external_services/object_storage), or you use `DISABLE_MINIO=true` in `sourcegraph/server` deployments, then this change should not affect you (there would already be no Minio software running as part of Sourcegraph). It is also safe to remove any minio specific env variables from your deployment. +If your Sourcegraph instance is already configured to use [external object storage](/self-hosted/external-services/object-storage), or you use `DISABLE_MINIO=true` in `sourcegraph/server` deployments, then this change should not affect you (there would already be no Minio software running as part of Sourcegraph). It is also safe to remove any minio specific env variables from your deployment. **If you are on running a proxy with the `NO_PROXY` env variable, you'll need to make sure that minio is removed from this list, and blobstore is added.** diff --git a/docs/self-hosted/how-to/clear_codeintel_data.mdx b/docs/self-hosted/how-to/clear-codeintel-data.mdx similarity index 96% rename from docs/self-hosted/how-to/clear_codeintel_data.mdx rename to docs/self-hosted/how-to/clear-codeintel-data.mdx index 8d02d5294..84cd76155 100644 --- a/docs/self-hosted/how-to/clear_codeintel_data.mdx +++ b/docs/self-hosted/how-to/clear-codeintel-data.mdx @@ -4,7 +4,7 @@ Clear all precise code intelligence data from your instance and start fresh. ## Clearing the `frontend` database -The following commands assume a connection to the `frontend` database. Refer to our guide on [`psql`](/self-hosted/how-to/run-psql) if you do not use an [external database](/self-hosted/external_services/). +The following commands assume a connection to the `frontend` database. Refer to our guide on [`psql`](/self-hosted/how-to/run-psql) if you do not use an [external database](/self-hosted/external-services/). If you are clearing **all** code intelligence data, then you will need to clear the metadata information in the frontend database. This will clear the high-level information about code intelligence indexes, but the raw data will remain in the `codeintel-db` database, which will also need to be cleared (see the next section). @@ -27,13 +27,13 @@ COMMIT; ## Clearing the `codeintel-db` database -The following commands assume a connection to the `codeintel-db` database. Refer to our guide on [`psql`](/self-hosted/how-to/run-psql) if you do not use an [external database](/self-hosted/external_services/). +The following commands assume a connection to the `codeintel-db` database. Refer to our guide on [`psql`](/self-hosted/how-to/run-psql) if you do not use an [external database](/self-hosted/external-services/). ### Clearing LSIF data Truncate the following tables to clear all LSIF-encoded information from the database. This command can be run when clearing **all** data from the instance, in which case the associated records in the `frontend` database must also be cleared. -This command can also be run after a completed [migration from LSIF to SCIP](/admin/how-to/lsif_scip_migration), in which case these tables should be empty but may retain a number of blocks containing a large number of dead tuples. Truncating these _empty_ tables acts like a `VACUUM FULL` and releases the previously used disk space. +This command can also be run after a completed [migration from LSIF to SCIP](/admin/how-to/lsif-scip-migration), in which case these tables should be empty but may retain a number of blocks containing a large number of dead tuples. Truncating these _empty_ tables acts like a `VACUUM FULL` and releases the previously used disk space. ```sql BEGIN; diff --git a/docs/self-hosted/how-to/dirty_database_pre_3_37.mdx b/docs/self-hosted/how-to/dirty-database-pre-3-37.mdx similarity index 99% rename from docs/self-hosted/how-to/dirty_database_pre_3_37.mdx rename to docs/self-hosted/how-to/dirty-database-pre-3-37.mdx index d6dcdd085..9e521e658 100644 --- a/docs/self-hosted/how-to/dirty_database_pre_3_37.mdx +++ b/docs/self-hosted/how-to/dirty-database-pre-3-37.mdx @@ -1,6 +1,6 @@ # How to troubleshoot a dirty database -> NOTE: This document refers to Sourcegraph instances with a version **strictly lower than** 3.37.0. For instructions on dealing with a dirty database for newer Sourcegraph instances, see [the updated documentation](/self-hosted/how-to/dirty_database). +> NOTE: This document refers to Sourcegraph instances with a version **strictly lower than** 3.37.0. For instructions on dealing with a dirty database for newer Sourcegraph instances, see [the updated documentation](/self-hosted/how-to/dirty-database). This document will take you through how to resolve a 'dirty database' error. During an upgrade, the `pgsql`, `codeintel-db`, and `codeinsights-db` databases must be migrated. If the upgrade was interrupted during the migration, this can result in a 'dirty database' error. diff --git a/docs/self-hosted/how-to/dirty_database.mdx b/docs/self-hosted/how-to/dirty-database.mdx similarity index 99% rename from docs/self-hosted/how-to/dirty_database.mdx rename to docs/self-hosted/how-to/dirty-database.mdx index f07870ad0..b5dfecf2f 100644 --- a/docs/self-hosted/how-to/dirty_database.mdx +++ b/docs/self-hosted/how-to/dirty-database.mdx @@ -1,6 +1,6 @@ # How to troubleshoot a dirty database -> NOTE: If you are on a version **strictly lower than** Sourcegraph 3.37.0, see the [legacy dirty database documentation](/self-hosted/how-to/dirty_database_pre_3_37). The following documentation applies only to Sourcegraph instances version 3.37.0 and above. +> NOTE: If you are on a version **strictly lower than** Sourcegraph 3.37.0, see the [legacy dirty database documentation](/self-hosted/how-to/dirty-database-pre-3-37). The following documentation applies only to Sourcegraph instances version 3.37.0 and above. This document will take you through how to resolve a 'dirty database' error. diff --git a/docs/self-hosted/how-to/index.mdx b/docs/self-hosted/how-to/index.mdx index c2241d38b..a9b6256e0 100644 --- a/docs/self-hosted/how-to/index.mdx +++ b/docs/self-hosted/how-to/index.mdx @@ -3,10 +3,10 @@ - [How to manually execute database migrations with `migrator`](/self-hosted/updates/migrator/migrator-operations) - Commands: [up](/self-hosted/updates/migrator/migrator-operations#up), [upto](/self-hosted/updates/migrator/migrator-operations#upto), [downto](/self-hosted/updates/migrator/migrator-operations#downto), [validate](/self-hosted/updates/migrator/migrator-operations#validate), [add-log](/self-hosted/updates/migrator/migrator-operations#add-log) - Environments: [Kubernetes](/self-hosted/updates/migrator/migrator-operations#kubernetes), [Docker compose](/self-hosted/updates/migrator/migrator-operations#docker--docker-compose), [Local development](/self-hosted/updates/migrator/migrator-operations#local-development) -- [How to troubleshoot a dirty database](/self-hosted/how-to/dirty_database) -- [How to rollback the Postgres database](/self-hosted/how-to/rollback_database) -- [How to apply privileged migrations](/self-hosted/how-to/privileged_migrations) -- [How to troubleshoot an unfinished migration](/self-hosted/how-to/unfinished_migration) +- [How to troubleshoot a dirty database](/self-hosted/how-to/dirty-database) +- [How to rollback the Postgres database](/self-hosted/how-to/rollback-database) +- [How to apply privileged migrations](/self-hosted/how-to/privileged-migrations) +- [How to troubleshoot an unfinished migration](/self-hosted/how-to/unfinished-migration) - [How to enable or disable an experimental feature](/admin/how-to/enable-experimental-feature) - [How to diagnose an `Unknown Error` during login to your Sourcegraph instance](/admin/how-to/unknown-error-login) - [How to convert version contexts to search contexts](/admin/how-to/converting-version-contexts-to-search-contexts) @@ -18,14 +18,14 @@ - [How to setup HTTPS connection with Ingress controller on your Kubernetes instance](/self-hosted/how-to/setup-https) - [How to rebuild corrupt Postgres indexes after upgrading to 3.30 or 3.30.1](/self-hosted/how-to/rebuild-corrupt-postgres-indexes) - [How to determine cause for Precise-code-intel-worker in CrashLoopBackOff status](/self-hosted/how-to/precise-code-intel-worker-crashloopbackoff) -- [How to troubleshoot a failure to update repositories when new repositories are added](/admin/how-to/update_repo_failure) +- [How to troubleshoot a failure to update repositories when new repositories are added](/admin/how-to/update-repo-failure) - [How to run postgres queries in your Sourcegraph instance](/self-hosted/how-to/run-psql) - [How to purge deleted repository data from Sourcegraph](/admin/how-to/remove-repo#manually-purge-deleted-repository-data-from-disk) - [How to address common monorepo problems](/admin/how-to/monorepo-issues) -- [How to Set a password for Redis using a ConfigMap](/self-hosted/how-to/redis_configmap) -- [How to import a set of internal repositories to Sourcegraph](/admin/how-to/internal_github_repos) +- [How to Set a password for Redis using a ConfigMap](/self-hosted/how-to/redis-configmap) +- [How to import a set of internal repositories to Sourcegraph](/admin/how-to/internal-github-repos) - [How to identify and resolve index corruption in postgres 14](/self-hosted/how-to/postgres14-index-corruption) -- [Migrating code intelligence data from LSIF to SCIP (Sourcegraph 4.5 -> 4.6)](/admin/how-to/lsif_scip_migration) +- [Migrating code intelligence data from LSIF to SCIP (Sourcegraph 4.5 -> 4.6)](/admin/how-to/lsif-scip-migration) - [How to export search results](/admin/how-to/export-search-results) -- [How to debug / confirm blobstore is healthy](/self-hosted/how-to/blobstore_debugging) -- [How to handle postgresql 12 to 16 drift](/self-hosted/how-to/postgres_12_to_16_drift) +- [How to debug / confirm blobstore is healthy](/self-hosted/how-to/blobstore-debugging) +- [How to handle postgresql 12 to 16 drift](/self-hosted/how-to/postgres-12-to-16-drift) diff --git a/docs/self-hosted/how-to/postgres_12_to_16_drift.mdx b/docs/self-hosted/how-to/postgres-12-to-16-drift.mdx similarity index 100% rename from docs/self-hosted/how-to/postgres_12_to_16_drift.mdx rename to docs/self-hosted/how-to/postgres-12-to-16-drift.mdx diff --git a/docs/self-hosted/how-to/privileged_migrations.mdx b/docs/self-hosted/how-to/privileged-migrations.mdx similarity index 94% rename from docs/self-hosted/how-to/privileged_migrations.mdx rename to docs/self-hosted/how-to/privileged-migrations.mdx index 57c8196cd..83db0bd0b 100644 --- a/docs/self-hosted/how-to/privileged_migrations.mdx +++ b/docs/self-hosted/how-to/privileged-migrations.mdx @@ -17,4 +17,4 @@ The migration runner is currently being run with -unprivileged-only. The indicat This option is used to fail-fast upgrades that require manual user intervention. To allow the migrator to make additional progress, the privileged query/queries must be applied manually with a superuser (most commonly via a psql shell attached to the Postgres instance). -You can manually [find and apply the target privileged migrations](/self-hosted/how-to/dirty_database#2-run-the-sql-queries-to-finish-incomplete-migrations) and [manually add a migration log entry](/self-hosted/how-to/dirty_database#3-add-a-migration-log-entry). +You can manually [find and apply the target privileged migrations](/self-hosted/how-to/dirty-database#2-run-the-sql-queries-to-finish-incomplete-migrations) and [manually add a migration log entry](/self-hosted/how-to/dirty-database#3-add-a-migration-log-entry). diff --git a/docs/self-hosted/how-to/redis_configmap.mdx b/docs/self-hosted/how-to/redis-configmap.mdx similarity index 99% rename from docs/self-hosted/how-to/redis_configmap.mdx rename to docs/self-hosted/how-to/redis-configmap.mdx index 0283a14f0..f6c269f74 100644 --- a/docs/self-hosted/how-to/redis_configmap.mdx +++ b/docs/self-hosted/how-to/redis-configmap.mdx @@ -14,7 +14,7 @@ The Redis Docker image does not expose a dedicated environment variable to set a Reference Materials - [Docs: Configure custom Redis](/self-hosted/deploy/kubernetes/configure#external-redis) -- [Docs: Using your own Redis server](/self-hosted/external_services/redis) +- [Docs: Using your own Redis server](/self-hosted/external-services/redis) ## Conventions diff --git a/docs/self-hosted/how-to/rollback_database.mdx b/docs/self-hosted/how-to/rollback-database.mdx similarity index 97% rename from docs/self-hosted/how-to/rollback_database.mdx rename to docs/self-hosted/how-to/rollback-database.mdx index 3554cebe5..69793cdec 100644 --- a/docs/self-hosted/how-to/rollback_database.mdx +++ b/docs/self-hosted/how-to/rollback-database.mdx @@ -17,4 +17,4 @@ A database schema downgrade will not always be enough. If a newer version was ru The `migrator` can be used to run both schema and data migrations (in the appropriate order) so that the old version of Sourcegraph can start and run without broken features. See the [command documentation](/self-hosted/updates/migrator/migrator-operations#downgrade) for additional details. -The log output of the `migrator` should include `INFO`-level logs and successfully terminate with `migrator exited with code 0`. If you see an error message or any of the databases have been flagged as "dirty", please follow ["How to troubleshoot a dirty database"](/self-hosted/how-to/dirty_database). A dirty database at this stage requires manual intervention. Please contact support at `mailto:support@sourcegraph.com` or via your enterprise support channel for further assistance. +The log output of the `migrator` should include `INFO`-level logs and successfully terminate with `migrator exited with code 0`. If you see an error message or any of the databases have been flagged as "dirty", please follow ["How to troubleshoot a dirty database"](/self-hosted/how-to/dirty-database). A dirty database at this stage requires manual intervention. Please contact support at `mailto:support@sourcegraph.com` or via your enterprise support channel for further assistance. diff --git a/docs/self-hosted/how-to/unfinished_migration.mdx b/docs/self-hosted/how-to/unfinished-migration.mdx similarity index 100% rename from docs/self-hosted/how-to/unfinished_migration.mdx rename to docs/self-hosted/how-to/unfinished-migration.mdx diff --git a/docs/self-hosted/http_https_configuration.mdx b/docs/self-hosted/http-https-configuration.mdx similarity index 97% rename from docs/self-hosted/http_https_configuration.mdx rename to docs/self-hosted/http-https-configuration.mdx index 1050cfeae..ebf0dfd4c 100644 --- a/docs/self-hosted/http_https_configuration.mdx +++ b/docs/self-hosted/http-https-configuration.mdx @@ -114,7 +114,7 @@ There are a few options: docker logs $(docker ps | grep sourcegraph/server | awk '{ print $1 }') ``` -**[2. Generate a self-signed certificate](/self-hosted/ssl_https_self_signed_cert_nginx)**
+**[2. Generate a self-signed certificate](/self-hosted/ssl-https-self-signed-cert-nginx)**
_This step can be skipped if you already have a certificate from a [globally trusted Certificate Authority (CA) provider](https://en.wikipedia.org/wiki/Certificate_authority#Providers)._ @@ -128,7 +128,7 @@ more details. ### Redirect to external HTTPS URL -The URL that clients should use to access Sourcegraph is defined in the `externalURL` property in [site configuration](/admin/config/site_config). To enforce that clients access Sourcegraph via this URL (and not some other URL, such as an IP address or other non-`https` URL), add the following to `nginx.conf` (replacing `https://sourcegraph.example.com` with your external URL): +The URL that clients should use to access Sourcegraph is defined in the `externalURL` property in [site configuration](/admin/config/site-config). To enforce that clients access Sourcegraph via this URL (and not some other URL, such as an IP address or other non-`https` URL), add the following to `nginx.conf` (replacing `https://sourcegraph.example.com` with your external URL): ```nginx # Redirect non-HTTPS traffic to HTTPS. @@ -158,7 +158,7 @@ See the [NGINX SSL Termination](https://docs.nginx.com/nginx/admin-guide/securit ### Next steps -You should configure Sourcegraph's `externalURL` in the [site configuration](/admin/config/site_config) (and restart the frontend instances) so that Sourcegraph knows its URL. +You should configure Sourcegraph's `externalURL` in the [site configuration](/admin/config/site-config) (and restart the frontend instances) so that Sourcegraph knows its URL. ## Sourcegraph via Docker Compose: Caddy 2 diff --git a/docs/self-hosted/index.mdx b/docs/self-hosted/index.mdx index 259db312b..a098bc00b 100644 --- a/docs/self-hosted/index.mdx +++ b/docs/self-hosted/index.mdx @@ -19,18 +19,18 @@ Get started running Sourcegraph on-prem. - [Machine images](/self-hosted/deploy/machine-images/) - [Docker single container](/self-hosted/deploy/docker-single-container/) - [Instance sizing](/self-hosted/deploy/instance-size) -- [Resource estimator](/self-hosted/deploy/resource_estimator) +- [Resource estimator](/self-hosted/deploy/resource-estimator) - [Scaling](/self-hosted/deploy/scale) -- [Best practices](/self-hosted/deployment_best_practices) +- [Best practices](/self-hosted/deployment-best-practices) - [Validate a Sourcegraph deployment](/self-hosted/validation) (experimental) ## [Upgrade Sourcegraph](/self-hosted/updates) - [Upgrade Overview](/self-hosted/updates/) - [Automatic upgrades](/self-hosted/updates/automatic) -- [Docker Compose upgrades](/self-hosted/updates/docker_compose) +- [Docker Compose upgrades](/self-hosted/updates/docker-compose) - [Kubernetes upgrades](/self-hosted/updates/kubernetes) -- [Pure Docker upgrades](/self-hosted/updates/pure_docker) +- [Pure Docker upgrades](/self-hosted/updates/pure-docker) - [Server upgrades](/self-hosted/updates/server) - [Migrator](/self-hosted/updates/migrator/) - [Migrate to Sourcegraph](/admin/migration/) @@ -43,12 +43,12 @@ Get started running Sourcegraph on-prem. - [Add Git repositories](/admin/repo/add) (from a code host or clone URL) - [Monorepo](/admin/monorepo) - [Repository webhooks](/admin/repo/webhooks) -- [HTTP and HTTPS/SSL configuration](/self-hosted/http_https_configuration) - - [Adding SSL (HTTPS) to Sourcegraph with a self-signed certificate](/self-hosted/ssl_https_self_signed_cert_nginx) +- [HTTP and HTTPS/SSL configuration](/self-hosted/http-https-configuration) + - [Adding SSL (HTTPS) to Sourcegraph with a self-signed certificate](/self-hosted/ssl-https-self-signed-cert-nginx) - [User authentication](/admin/auth/) - - [User data deletion](/admin/user_data_deletion) + - [User data deletion](/admin/user-data-deletion) - [Provision users through SCIM](/admin/scim) (Beta) -- [Access control](/admin/access_control/) (Beta) +- [Access control](/admin/access-control/) (Beta) - [Setting the URL for your instance](/self-hosted/url) - [Configure email sending / SMTP server](/self-hosted/email) - [Repository permissions](/admin/permissions/) @@ -57,37 +57,37 @@ Get started running Sourcegraph on-prem. - [Scaling workers](/self-hosted/workers) - [PostgreSQL configuration](/self-hosted/postgres-conf) -## [Using external services](/self-hosted/external_services/) +## [Using external services](/self-hosted/external-services/) -- [External services overview](/self-hosted/external_services/) -- [PostgreSQL](/self-hosted/external_services/postgres) -- [Redis](/self-hosted/external_services/redis) -- [Object storage (S3/GCS)](/self-hosted/external_services/object_storage) +- [External services overview](/self-hosted/external-services/) +- [PostgreSQL](/self-hosted/external-services/postgres) +- [Redis](/self-hosted/external-services/redis) +- [Object storage (S3/GCS)](/self-hosted/external-services/object-storage) ## [Executors](/self-hosted/executors/) - [Executors overview](/self-hosted/executors/) -- [Deploy executors](/self-hosted/executors/deploy_executors) -- [Kubernetes deployment](/self-hosted/executors/deploy_executors_kubernetes) -- [Terraform deployment](/self-hosted/executors/deploy_executors_terraform) -- [Docker deployment](/self-hosted/executors/deploy_executors_docker) -- [Binary deployment](/self-hosted/executors/deploy_executors_binary) -- [Binary deployment (offline)](/self-hosted/executors/deploy_executors_binary_offline) -- [Docker-in-Docker](/self-hosted/executors/deploy_executors_dind) +- [Deploy executors](/self-hosted/executors/deploy-executors) +- [Kubernetes deployment](/self-hosted/executors/deploy-executors-kubernetes) +- [Terraform deployment](/self-hosted/executors/deploy-executors-terraform) +- [Docker deployment](/self-hosted/executors/deploy-executors-docker) +- [Binary deployment](/self-hosted/executors/deploy-executors-binary) +- [Binary deployment (offline)](/self-hosted/executors/deploy-executors-binary-offline) +- [Docker-in-Docker](/self-hosted/executors/deploy-executors-dind) - [Firecracker](/self-hosted/executors/firecracker) -- [Configuration](/self-hosted/executors/executors_config) -- [Troubleshooting](/self-hosted/executors/executors_troubleshooting) +- [Configuration](/self-hosted/executors/executors-config) +- [Troubleshooting](/self-hosted/executors/executors-troubleshooting) ## Advanced tasks -- [Loading configuration via the file system](/self-hosted/advanced_config_file) +- [Loading configuration via the file system](/self-hosted/advanced-config-file) - [Restore postgres database from snapshot](/self-hosted/restore/) - [Enabling database encryption for sensitive data](/self-hosted/encryption) - [Configuring Sourcegraph in private networks](/self-hosted/private-network) - [Restricting outgoing connections](/self-hosted/network-filtering) - [PostgreSQL](/self-hosted/postgres) -- [PostgreSQL 12 end of life notice](/self-hosted/postgres12_end_of_life_notice) -- [PostgreSQL collation version mismatch resolution](/self-hosted/postgresql_collation_version_mismatch_resolution) +- [PostgreSQL 12 end of life notice](/self-hosted/postgres12-end-of-life-notice) +- [PostgreSQL collation version mismatch resolution](/self-hosted/postgresql-collation-version-mismatch-resolution) - [Profiling (pprof)](/self-hosted/pprof) ## [Observability](/self-hosted/observability) @@ -96,33 +96,33 @@ Get started running Sourcegraph on-prem. - [Metrics and dashboards](/self-hosted/observability/metrics) - [Dashboards reference](/self-hosted/observability/dashboards) - [Alerting](/self-hosted/observability/alerting) -- [Custom alerting consumption](/self-hosted/observability/alerting_custom_consumption) +- [Custom alerting consumption](/self-hosted/observability/alerting-custom-consumption) - [Alerts reference](/self-hosted/observability/alerts) - [Tracing](/self-hosted/observability/tracing) - [Logs](/self-hosted/observability/logs) - [Outbound request log](/admin/outbound-request-log) - [OpenTelemetry](/self-hosted/observability/opentelemetry) -- [Health checks](/self-hosted/observability/health_checks) +- [Health checks](/self-hosted/observability/health-checks) - [Troubleshooting guide](/self-hosted/observability/troubleshooting) ## [How-to Guides](/self-hosted/how-to/) -- [Blobstore debugging](/self-hosted/how-to/blobstore_debugging) -- [Blobstore update notes](/self-hosted/how-to/blobstore_update_notes) -- [Clear code intelligence data](/self-hosted/how-to/clear_codeintel_data) -- [Dirty database (pre 3.37)](/self-hosted/how-to/dirty_database_pre_3_37) -- [Dirty database](/self-hosted/how-to/dirty_database) -- [PostgreSQL 12 to 16 drift](/self-hosted/how-to/postgres_12_to_16_drift) +- [Blobstore debugging](/self-hosted/how-to/blobstore-debugging) +- [Blobstore update notes](/self-hosted/how-to/blobstore-update-notes) +- [Clear code intelligence data](/self-hosted/how-to/clear-codeintel-data) +- [Dirty database (pre 3.37)](/self-hosted/how-to/dirty-database-pre-3-37) +- [Dirty database](/self-hosted/how-to/dirty-database) +- [PostgreSQL 12 to 16 drift](/self-hosted/how-to/postgres-12-to-16-drift) - [PostgreSQL 14 index corruption](/self-hosted/how-to/postgres14-index-corruption) - [Precise code intel worker crashloopbackoff](/self-hosted/how-to/precise-code-intel-worker-crashloopbackoff) -- [Privileged migrations](/self-hosted/how-to/privileged_migrations) +- [Privileged migrations](/self-hosted/how-to/privileged-migrations) - [Rebuild corrupt PostgreSQL indexes](/self-hosted/how-to/rebuild-corrupt-postgres-indexes) -- [Redis ConfigMap](/self-hosted/how-to/redis_configmap) -- [Rollback database](/self-hosted/how-to/rollback_database) +- [Redis ConfigMap](/self-hosted/how-to/redis-configmap) +- [Rollback database](/self-hosted/how-to/rollback-database) - [Run psql](/self-hosted/how-to/run-psql) - [Setup HTTPS](/self-hosted/how-to/setup-https) - [Troubleshoot pod eviction](/self-hosted/how-to/troubleshoot-pod-eviction) -- [Unfinished migration](/self-hosted/how-to/unfinished_migration) +- [Unfinished migration](/self-hosted/how-to/unfinished-migration) - [Upgrade PostgreSQL 12 to 16 (builtin DBs)](/self-hosted/how-to/upgrade-postgres-12-16-builtin-dbs) ## [FAQs](/self-hosted/faq) diff --git a/docs/self-hosted/observability/alerting_custom_consumption.mdx b/docs/self-hosted/observability/alerting-custom-consumption.mdx similarity index 100% rename from docs/self-hosted/observability/alerting_custom_consumption.mdx rename to docs/self-hosted/observability/alerting-custom-consumption.mdx diff --git a/docs/self-hosted/observability/alerting.mdx b/docs/self-hosted/observability/alerting.mdx index 510740643..de560eacd 100644 --- a/docs/self-hosted/observability/alerting.mdx +++ b/docs/self-hosted/observability/alerting.mdx @@ -29,7 +29,7 @@ Learn more about metrics, dashboards, and alert labels in our [metrics guide](/s ## Setting up alerting -Visit your site configuration (e.g. `https://sourcegraph.example.com/site-admin/configuration`) to configure alerts using the [`observability.alerts`](/admin/config/site_config#observability-alerts) field. As always, you can use `Ctrl+Space` at any time to get hints about allowed fields as well as relevant documentation inside the configuration editor. +Visit your site configuration (e.g. `https://sourcegraph.example.com/site-admin/configuration`) to configure alerts using the [`observability.alerts`](/admin/config/site-config#observability-alerts) field. As always, you can use `Ctrl+Space` at any time to get hints about allowed fields as well as relevant documentation inside the configuration editor. Once configured, Sourcegraph alerts will automatically be routed to the appropriate notification channels by severity level. @@ -162,7 +162,7 @@ For the complete set of fields, please refer to the [Alertmanager webhook docume #### Email -Note that to receive email notifications, the [`email.address`](/admin/config/site_config#email-address) and [`email.smtp`](/admin/config/site_config#email-smtp) fields must be configured in site configuration. +Note that to receive email notifications, the [`email.address`](/admin/config/site-config#email-address) and [`email.smtp`](/admin/config/site-config#email-smtp) fields must be configured in site configuration. ```json "observability.alerts": [ @@ -201,7 +201,7 @@ The test alert may take up to a minute to fire. The triggered alert will automat ### Silencing alerts -If there is an alert you are aware of and you wish to silence notifications (from the notification channels you have set up) for it, add an entry to the [`observability.silenceAlerts`](/admin/config/site_config#observability-silenceAlerts)field. For example: +If there is an alert you are aware of and you wish to silence notifications (from the notification channels you have set up) for it, add an entry to the [`observability.silenceAlerts`](/admin/config/site-config#observability-silenceAlerts)field. For example: ```json { diff --git a/docs/self-hosted/observability/alerts.mdx b/docs/self-hosted/observability/alerts.mdx index 028b516c7..99021b488 100644 --- a/docs/self-hosted/observability/alerts.mdx +++ b/docs/self-hosted/observability/alerts.mdx @@ -1582,7 +1582,7 @@ Generated query for critical alert: `max((sum by (container_label_io_kubernetes_ - **Check if the problem may be an intermittent and temporary peak** using the "Container monitoring" section at the bottom of the Git Server dashboard. - **Single container deployments:** Consider upgrading to a [Docker Compose deployment](../deploy/docker-compose/migrate) which offers better scalability and resource isolation. -- **Kubernetes and Docker Compose:** Check that you are running a similar number of git server replicas and that their CPU/memory limits are allocated according to what is shown in the [Sourcegraph resource estimator](../deploy/resource_estimator). +- **Kubernetes and Docker Compose:** Check that you are running a similar number of git server replicas and that their CPU/memory limits are allocated according to what is shown in the [Sourcegraph resource estimator](../deploy/resource-estimator). - More help interpreting this metric is available in the [dashboards reference](dashboards#gitserver-running-git-commands). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -1617,7 +1617,7 @@ Generated query for critical alert: `max((sum by (instance, cmd) (src_gitserver_ **Next steps** - **Single container deployments:** Upgrade to a [Docker Compose deployment](../deploy/docker-compose/migrate) which offers better scalability and resource isolation. -- **Kubernetes and Docker Compose:** Check that you are running a similar number of git server replicas and that their CPU/memory limits are allocated according to what is shown in the [Sourcegraph resource estimator](../deploy/resource_estimator). +- **Kubernetes and Docker Compose:** Check that you are running a similar number of git server replicas and that their CPU/memory limits are allocated according to what is shown in the [Sourcegraph resource estimator](../deploy/resource-estimator). - If your persistent volume is slow, you may want to provision more IOPS, usually by increasing the volume size. - More help interpreting this metric is available in the [dashboards reference](dashboards#gitserver-echo-command-duration-test). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -4613,7 +4613,7 @@ Generated query for critical alert: `min((max by (name) (src_gitlab_rate_limit_r **Next steps** - **Enabled permissions for the first time:** Wait for few minutes and see if the number goes down. -- **Otherwise:** Increase the API rate limit to [GitHub](https://sourcegraph.com/docs/admin/code_hosts/github#github-com-rate-limits), [GitLab](https://sourcegraph.com/docs/admin/code_hosts/gitlab#internal-rate-limits) or [Bitbucket Server](https://sourcegraph.com/docs/admin/code_hosts/bitbucket_server#internal-rate-limits). +- **Otherwise:** Increase the API rate limit to [GitHub](https://sourcegraph.com/docs/admin/code-hosts/github#github-com-rate-limits), [GitLab](https://sourcegraph.com/docs/admin/code-hosts/gitlab#internal-rate-limits) or [Bitbucket Server](https://sourcegraph.com/docs/admin/code-hosts/bitbucket-server#internal-rate-limits). - Learn more about the related dashboard panel in the [dashboards reference](dashboards#worker-perms-syncer-outdated-perms). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: diff --git a/docs/self-hosted/observability/health_checks.mdx b/docs/self-hosted/observability/health-checks.mdx similarity index 100% rename from docs/self-hosted/observability/health_checks.mdx rename to docs/self-hosted/observability/health-checks.mdx diff --git a/docs/self-hosted/observability/index.mdx b/docs/self-hosted/observability/index.mdx index fcce0b116..b76dce93e 100644 --- a/docs/self-hosted/observability/index.mdx +++ b/docs/self-hosted/observability/index.mdx @@ -37,7 +37,7 @@ Sourcegraph is designed, and ships with, a number of observability tools and cap - [Logs](/self-hosted/observability/logs) - [Outbound request log](/admin/outbound-request-log) - [OpenTelemetry](/self-hosted/observability/opentelemetry) -- [Health checks](/self-hosted/observability/health_checks) +- [Health checks](/self-hosted/observability/health-checks) - [Troubleshooting guide](/self-hosted/observability/troubleshooting) - [Monitoring guide](/self-hosted/how-to/monitoring-guide) diff --git a/docs/self-hosted/observability/troubleshooting.mdx b/docs/self-hosted/observability/troubleshooting.mdx index d92d1d9b2..1fa1d878b 100644 --- a/docs/self-hosted/observability/troubleshooting.mdx +++ b/docs/self-hosted/observability/troubleshooting.mdx @@ -32,7 +32,7 @@ If this is the case, this could indicate high gitserver load. To confirm, take t metric) and "Commands running concurrently" dashboard (tracks the `src_gitserver_exec_running` metric). If either of these is high (> 1s echo duration or 100s simultaneous execs), then this indicates gitserver is under heavy load and likely the bottleneck. -1. Confirm your gitserver is not under-provisioned, by e.g. comparing its allocated resources with what the [resource estimator](/self-hosted/deploy/resource_estimator) shows. +1. Confirm your gitserver is not under-provisioned, by e.g. comparing its allocated resources with what the [resource estimator](/self-hosted/deploy/resource-estimator) shows. Solution: set `USE_ENHANCED_LANGUAGE_DETECTION=false` in the Sourcegraph runtime environment. diff --git a/docs/self-hosted/postgres.mdx b/docs/self-hosted/postgres.mdx index 3b17b9cca..848f04bb2 100644 --- a/docs/self-hosted/postgres.mdx +++ b/docs/self-hosted/postgres.mdx @@ -10,7 +10,7 @@ Sourcegraph uses several PostgreSQL databases to support various functionality. ### Version requirements -We support Postgres 16 and above. Older versions of Sourcegraph supported 12 see our [Postgres 12 deprecation notice](/self-hosted/postgres12_end_of_life_notice) for more details. Starting in Sourcegraph 6.0.0, sourcegraph services will no longer connect to a PostgreSQL 12 or lower database. Instead, it will display an error message in container logs for services attempting to connect to a PostgreSQL database below version 16. +We support Postgres 16 and above. Older versions of Sourcegraph supported 12 see our [Postgres 12 deprecation notice](/self-hosted/postgres12-end-of-life-notice) for more details. Starting in Sourcegraph 6.0.0, sourcegraph services will no longer connect to a PostgreSQL 12 or lower database. Instead, it will display an error message in container logs for services attempting to connect to a PostgreSQL database below version 16. ``` migrator | ✱ Sourcegraph migrator 6.0.0 @@ -70,7 +70,7 @@ These images contain an entry script that will detect and upgrade Postgres insta We have the following advisements to admins: - Container orchestration management systems (e.g. Kubernetes) may restart containers at any time, **it is recommended that you take a backup of your database before starting the upgrade process.** -- Review your deployment types [upgrade notes](/self-hosted/updates#upgrades-index) before upgrading. The PostgreSQL upgrade process mutates the database schema in a way that may Sourcegraph `v5.10.0` and `v5.11.0` may not recognize. [Learn more about pg12 to pg16 schema drift here](/self-hosted/how-to/postgres_12_to_16_drift). +- Review your deployment types [upgrade notes](/self-hosted/updates#upgrades-index) before upgrading. The PostgreSQL upgrade process mutates the database schema in a way that may Sourcegraph `v5.10.0` and `v5.11.0` may not recognize. [Learn more about pg12 to pg16 schema drift here](/self-hosted/how-to/postgres-12-to-16-drift). For additional assistance with PostgreSQL upgrades, please contact support@sourcegraph.com. @@ -86,7 +86,7 @@ The `PG_UPGRADE_EXTRA_ARGS` environment variable allows you to customize the `pg ### Upgrading external PostgreSQL instances -When running an [external PostgreSQL instance](/self-hosted/external_services/postgres), please do the following: +When running an [external PostgreSQL instance](/self-hosted/external-services/postgres), please do the following: 1. Back up the Postgres DB so that you can restore to the old version should anything go wrong. 2. Turn off Sourcegraph entirely (bring down all containers and pods so they cannot talk to Postgres.) diff --git a/docs/self-hosted/postgres12_end_of_life_notice.mdx b/docs/self-hosted/postgres12-end-of-life-notice.mdx similarity index 100% rename from docs/self-hosted/postgres12_end_of_life_notice.mdx rename to docs/self-hosted/postgres12-end-of-life-notice.mdx diff --git a/docs/self-hosted/postgresql_collation_version_mismatch_resolution.mdx b/docs/self-hosted/postgresql-collation-version-mismatch-resolution.mdx similarity index 100% rename from docs/self-hosted/postgresql_collation_version_mismatch_resolution.mdx rename to docs/self-hosted/postgresql-collation-version-mismatch-resolution.mdx diff --git a/docs/self-hosted/private-network.mdx b/docs/self-hosted/private-network.mdx index 88d92ca7a..5ad309831 100644 --- a/docs/self-hosted/private-network.mdx +++ b/docs/self-hosted/private-network.mdx @@ -16,10 +16,10 @@ The following is a list of Sourcegraph services that initiate outbound connectio - **frontend**: The frontend service communicates externally when connecting to: - External [auth providers](/admin/auth/) - Sending [telemetry data](/admin/pings) - - Testing [code host connections](/admin/code_hosts/) - - Connecting to [externally hosted](/self-hosted/external_services/) Sourcegraph services + - Testing [code host connections](/admin/code-hosts/) + - Connecting to [externally hosted](/self-hosted/external-services/) Sourcegraph services - Connecting to external [LLM providers](/cody/capabilities/supported-models) with Cody -- **gitserver**: Executes git commands against externally hosted [code hosts](/admin/code_hosts/) +- **gitserver**: Executes git commands against externally hosted [code hosts](/admin/code-hosts/) - **migrator**: Connects to Postgres instances (which may be [externally hosted](/self-hosted/postgres)) to process database migrations - **worker**: Sourcegraph Worker background jobs that may require establishing connections to services hosted within an organization's private network diff --git a/docs/self-hosted/ssl_https_self_signed_cert_nginx.mdx b/docs/self-hosted/ssl-https-self-signed-cert-nginx.mdx similarity index 96% rename from docs/self-hosted/ssl_https_self_signed_cert_nginx.mdx rename to docs/self-hosted/ssl-https-self-signed-cert-nginx.mdx index 132e96570..d19fdbb59 100644 --- a/docs/self-hosted/ssl_https_self_signed_cert_nginx.mdx +++ b/docs/self-hosted/ssl-https-self-signed-cert-nginx.mdx @@ -148,8 +148,8 @@ This is largely the same as step 5, except easier. For other developer machines ## Next steps -- [Configure Sourcegraph's `externalURL`](/admin/config/site_config) -- [Redirect to external HTTPS URL](/self-hosted/http_https_configuration#redirect-to-external-https-url) -- [NGINX HTTP Strict Transport Security](/self-hosted/http_https_configuration#redirect-to-external-https-url) +- [Configure Sourcegraph's `externalURL`](/admin/config/site-config) +- [Redirect to external HTTPS URL](/self-hosted/http-https-configuration#redirect-to-external-https-url) +- [NGINX HTTP Strict Transport Security](/self-hosted/http-https-configuration#redirect-to-external-https-url) - [NGINX SSL Termination guide](https://docs.nginx.com/nginx/admin-guide/security-controls/terminating-ssl-http/) - [NGINX HTTPS Servers guide](https://nginx.org/en/docs/http/configuring_https_servers.html). diff --git a/docs/self-hosted/updates/automatic.mdx b/docs/self-hosted/updates/automatic.mdx index 79e5abc80..7e101faa8 100644 --- a/docs/self-hosted/updates/automatic.mdx +++ b/docs/self-hosted/updates/automatic.mdx @@ -1,12 +1,12 @@ # Automatic multi-version upgrades -> Warning: Automatic upgrades to v5.10.0 will fail please upgrade to a v5.9.x version and perform a standard upgrade instead! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! This is one of the reasons the "Auto Upgrade" toggle is automatically turned off after a version change. This behavior is intentional—it’s designed to prevent users from unintentionally performing multi-version upgrades (MVUs) that span critical changes, such as major infrastructure updates like a PostgreSQL version upgrade. +> Warning: Automatic upgrades to v5.10.0 will fail please upgrade to a v5.9.x version and perform a standard upgrade instead! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12-end-of-life-notice#postgres-12-end-of-life) notice! This is one of the reasons the "Auto Upgrade" toggle is automatically turned off after a version change. This behavior is intentional—it’s designed to prevent users from unintentionally performing multi-version upgrades (MVUs) that span critical changes, such as major infrastructure updates like a PostgreSQL version upgrade. From **Sourcegraph 5.1 and later**, multi-version upgrades can be performed **automatically** as if they were a standard upgrade for the same deployment type. Automatic multi-version upgrades take the following general form: 1. Determine if your instance is ready to Upgrade: 1. Check your Sourcegraph instances `Site admin > Updates` page. ([more info](/self-hosted/updates/#upgrade-readiness)) - 2. Consult upgrade notes for your deployment type accross the range of your upgrade. ([Kubernetes](/self-hosted/updates/kubernetes), [Docker-compose](/self-hosted/updates/docker_compose), [Server](/self-hosted/updates/server)) + 2. Consult upgrade notes for your deployment type accross the range of your upgrade. ([Kubernetes](/self-hosted/updates/kubernetes), [Docker-compose](/self-hosted/updates/docker-compose), [Server](/self-hosted/updates/server)) 2. Merge the latest Sourcegraph release into your deployment manifests. 3. With upstream changes to your manifests merged, start the new instance. diff --git a/docs/self-hosted/updates/docker_compose.mdx b/docs/self-hosted/updates/docker-compose.mdx similarity index 97% rename from docs/self-hosted/updates/docker_compose.mdx rename to docs/self-hosted/updates/docker-compose.mdx index 5b99021c2..d10c3c90b 100644 --- a/docs/self-hosted/updates/docker_compose.mdx +++ b/docs/self-hosted/updates/docker-compose.mdx @@ -40,11 +40,11 @@ Only self-hosted customers using the Sourcegraph provided PostgreSQL container i Self-hosted customers using external databases, such as AWS RDS, GCP CloudSQL, or another self-managed solution are NOT affected. -See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgresql_collation_version_mismatch_resolution) notes for more details. +See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgresql-collation-version-mismatch-resolution) notes for more details. ## v6.0.0 -- Sourcegraph 6.0.0 no longer supports PostgreSQL 12, admins must upgrade to PostgreSQL 16. See our [postgres 12 end of life](/self-hosted/postgres12_end_of_life_notice) notice! As well as [supporting documentation](/self-hosted/postgres) and advisements on how to upgrade. +- Sourcegraph 6.0.0 no longer supports PostgreSQL 12, admins must upgrade to PostgreSQL 16. See our [postgres 12 end of life](/self-hosted/postgres12-end-of-life-notice) notice! As well as [supporting documentation](/self-hosted/postgres) and advisements on how to upgrade. ## v5.9.0 ➔ v5.10.1164 @@ -54,7 +54,7 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgres > Warning: Admins are advised to upgrade directly to v5.10.1164 circumventing this release. > -> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to take a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! +> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to take a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12-end-of-life-notice#postgres-12-end-of-life) notice! > > Warning: `automatic` and migrator `upgrade` command will not work for this release, please upgrade directly to `v5.10.1164`, or to a 5.9 version and conduct a standard upgrade using migrator's default `up` command! @@ -124,7 +124,7 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgres #### Notes: -This release introduces a background job that will convert all LSIF data into SCIP. **This migration is irreversible** and a rollback from this version may result in loss of precise code intelligence data. Please see the [migration notes](/admin/how-to/lsif_scip_migration) for more details. +This release introduces a background job that will convert all LSIF data into SCIP. **This migration is irreversible** and a rollback from this version may result in loss of precise code intelligence data. Please see the [migration notes](/admin/how-to/lsif-scip-migration) for more details. ## v4.3 ➔ v4.4.1 @@ -224,7 +224,7 @@ This release introduces a background job that will convert all LSIF data into SC - Target the tag [`v3.35.1`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.35.1/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. - The `query-runner` service has been decommissioned in the 3.35 release and will be removed during the upgrade. To delete the `query-runner` service, specify `--remove-orphans` to your `docker-compose` command. -- There is a [known issue](/code_insights/how-tos/Troubleshooting#oob-migration-has-made-progress-but-is-stuck-before-reaching-100) with the Code Insights out-of-band settings migration not reaching 100% complete when encountering deleted users or organizations. +- There is a [known issue](/code-insights/how-tos/Troubleshooting#oob-migration-has-made-progress-but-is-stuck-before-reaching-100) with the Code Insights out-of-band settings migration not reaching 100% complete when encountering deleted users or organizations. ## v3.33 ➔ v3.34 @@ -317,11 +317,11 @@ This release introduces a background job that will convert all LSIF data into SC - Target the tag [`v3.22.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.22.0/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. - This upgrade removes the `code intel bundle manager`. This service has been deprecated and all references to it have been removed. -- This upgrade also adds a MinIO container that doesn't require any custom configuration. You can find more detailed documentation [here](/self-hosted/external_services/object_storage). +- This upgrade also adds a MinIO container that doesn't require any custom configuration. You can find more detailed documentation [here](/self-hosted/external-services/object-storage). ## v3.20 ➔ v3.21 #### Notes: - Target the tag [`v3.21.1`](https://github.com/sourcegraph/deploy-sourcegraph-docker/tree/v3.21.1/docker-compose) when fetching upstream from `deploy-sourcegraph-docker`. -- This release introduces a second database instance, `codeintel-db`. If you have configured Sourcegraph with an external database, then update the `CODEINTEL_PG*` environment variables to point to a new external database as described in the [external database documentation](/self-hosted/external_services/postgres). Again, these must not point to the same database or the Sourcegraph instance will refuse to start. +- This release introduces a second database instance, `codeintel-db`. If you have configured Sourcegraph with an external database, then update the `CODEINTEL_PG*` environment variables to point to a new external database as described in the [external database documentation](/self-hosted/external-services/postgres). Again, these must not point to the same database or the Sourcegraph instance will refuse to start. diff --git a/docs/self-hosted/updates/index.mdx b/docs/self-hosted/updates/index.mdx index 23a2409e3..dfefd64ef 100644 --- a/docs/self-hosted/updates/index.mdx +++ b/docs/self-hosted/updates/index.mdx @@ -116,7 +116,7 @@ If your instance has schema drift or unfinished oob migrations you may need to a - **Sourcegraph with Docker Compose** - [Standard Upgrade Operations](/self-hosted/deploy/docker-compose/upgrade#standard-upgrades) - [Multiversion Upgrade Operations](/self-hosted/deploy/docker-compose/upgrade#multi-version-upgrades) - - [Upgrade Notes](/self-hosted/updates/docker_compose) + - [Upgrade Notes](/self-hosted/updates/docker-compose) - **Sourcegraph with Kubernetes** - **Kustomize** - [Standard Upgrade Operations](/self-hosted/deploy/kubernetes/upgrade#standard-upgrades) @@ -129,13 +129,13 @@ If your instance has schema drift or unfinished oob migrations you may need to a - [Standard Upgrade Operations](/self-hosted/deploy/docker-single-container/#standard-upgrades) - [Multiversion Upgrade Operations](/self-hosted/deploy/docker-single-container/#multi-version-upgrades) - [Upgrade Notes](/self-hosted/updates/server) -- [**Pure-docker custom deployments**](/self-hosted/updates/pure_docker) +- [**Pure-docker custom deployments**](/self-hosted/updates/pure-docker) - [**Sourcegraph AWS AMI instances**](/self-hosted/deploy/machine-images/aws-ami#upgrade) ## Other helpful links -- [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgresql_collation_version_mismatch_resolution) -- [Postgres 12 End Of Life Notice](/self-hosted/postgres12_end_of_life_notice) +- [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgresql-collation-version-mismatch-resolution) +- [Postgres 12 End Of Life Notice](/self-hosted/postgres12-end-of-life-notice) - [Migrator operations](/self-hosted/updates/migrator/migrator-operations) - [Upgrading Early Versions](/self-hosted/updates/migrator/upgrading-early-versions) - [Troubleshooting upgrades](/self-hosted/updates/migrator/troubleshooting-upgrades) diff --git a/docs/self-hosted/updates/kubernetes.mdx b/docs/self-hosted/updates/kubernetes.mdx index ae6451e52..1b73e730a 100644 --- a/docs/self-hosted/updates/kubernetes.mdx +++ b/docs/self-hosted/updates/kubernetes.mdx @@ -46,11 +46,11 @@ Only self-hosted customers using the Sourcegraph provided PostgreSQL container i Self-hosted customers using external databases, such as AWS RDS, GCP CloudSQL, or another self-managed solution are NOT affected. -See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgresql_collation_version_mismatch_resolution) notes for more details. +See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgresql-collation-version-mismatch-resolution) notes for more details. ## v6.0.0 -- Sourcegraph 6.0.0 no longer supports PostgreSQL 12, admins must upgrade to PostgreSQL 16. See our [postgres 12 end of life](/self-hosted/postgres12_end_of_life_notice) notice! As well as [supporting documentation](/self-hosted/postgres) and advisements on how to upgrade. +- Sourcegraph 6.0.0 no longer supports PostgreSQL 12, admins must upgrade to PostgreSQL 16. See our [postgres 12 end of life](/self-hosted/postgres12-end-of-life-notice) notice! As well as [supporting documentation](/self-hosted/postgres) and advisements on how to upgrade. - The Kubernetes Helm deployment type does not support MVU from Sourcegraph `v5.9.45` versions and earlier to Sourcegraph `v6.0.0`. @@ -69,7 +69,7 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgres > Warning: Admins are advised to upgrade directly to v5.10.1164 circumventing this release. > -> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to take a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! +> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to take a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12-end-of-life-notice#postgres-12-end-of-life) notice! > > Warning: `automatic` and migrator `upgrade` command will not work for this release, please upgrade directly to `v5.10.1164`, or to a 5.9 version and conduct a standard upgrade using migrator's default `up` command! @@ -106,7 +106,7 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgres - **See our [note](/self-hosted/deploy/kubernetes/upgrade#using-mvu-to-migrate-to-kustomize) on multiversion upgrades coinciding with this migration. Admins are advised to stop at this version, [migrate](/self-hosted/deploy/kubernetes/kustomize/migrate), and then proceed with upgrading.** -- This release introduces a background job that will convert all LSIF data into SCIP. **This migration is irreversible** and a rollback from this version may result in loss of precise code intelligence data. Please see the [migration notes](/admin/how-to/lsif_scip_migration) for more details. +- This release introduces a background job that will convert all LSIF data into SCIP. **This migration is irreversible** and a rollback from this version may result in loss of precise code intelligence data. Please see the [migration notes](/admin/how-to/lsif-scip-migration) for more details. **Kubernetes with Helm** @@ -131,7 +131,7 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgres #### Notes: - The `worker-executors` Service object is now included in manifests generated using `kustomize`. This object was already introduced in the base manifest, but omitted from manifests generated using `kustomize`. Its purpose is to enable ingested executor metrics to be scraped by Prometheus. It should have no impact on behavior. -- `minio` has been replaced with `blobstore`. Please see the update notes [here](/self-hosted/how-to/blobstore_update_notes) +- `minio` has been replaced with `blobstore`. Please see the update notes [here](/self-hosted/how-to/blobstore-update-notes) - This upgrade adds a [node-exporter](https://github.com/prometheus/node_exporter) DaemonSet, which collects crucial machine-level metrics that help Sourcegraph scale your deployment. - **Note**: Similarly to `cadvisor`, `node-exporter`: @@ -190,7 +190,7 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgres - The query-runner deployment has been removed, so if you deploy with a method other than the `kubectl-apply-all.sh`, a manual removal of the deployment may be necessary. Follow the [standard upgrade procedure](/self-hosted/deploy/kubernetes/upgrade) to upgrade your deployment. -- There is a [known issue](/code_insights/how-tos/Troubleshooting#oob-migration-has-made-progress-but-is-stuck-before-reaching-100) with the Code Insights out-of-band settings migration not reaching 100% complete when encountering deleted users or organizations. +- There is a [known issue](/code-insights/how-tos/Troubleshooting#oob-migration-has-made-progress-but-is-stuck-before-reaching-100) with the Code Insights out-of-band settings migration not reaching 100% complete when encountering deleted users or organizations. ## v3.30 ➔ v3.31 @@ -249,13 +249,13 @@ See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgres #### Notes: - This upgrade removes the `code intel bundle manager`. This service has been deprecated and all references to it have been removed. -- This upgrade also adds a MinIO container that doesn't require any custom configuration. You can find more detailed documentation in [here](/self-hosted/external_services/object_storage). +- This upgrade also adds a MinIO container that doesn't require any custom configuration. You can find more detailed documentation in [here](/self-hosted/external-services/object-storage). ## v3.20 ➔ v3.21 #### Notes: -- This release introduces a second database instance, `codeintel-db`. If you have configured Sourcegraph with an external database, then update the `CODEINTEL_PG*` environment variables to point to a new external database as described in the [external database documentation](/self-hosted/external_services/postgres). Again, these must not point to the same database or the Sourcegraph instance will refuse to start. +- This release introduces a second database instance, `codeintel-db`. If you have configured Sourcegraph with an external database, then update the `CODEINTEL_PG*` environment variables to point to a new external database as described in the [external database documentation](/self-hosted/external-services/postgres). Again, these must not point to the same database or the Sourcegraph instance will refuse to start. ## v3.18 ➔ v3.19 diff --git a/docs/self-hosted/updates/migrator/migrator-operations.mdx b/docs/self-hosted/updates/migrator/migrator-operations.mdx index 2bb180b17..de77005b0 100644 --- a/docs/self-hosted/updates/migrator/migrator-operations.mdx +++ b/docs/self-hosted/updates/migrator/migrator-operations.mdx @@ -93,7 +93,7 @@ upgrade \ - `--disable-animation`: Print plain log messages instead of an animated progress bar. - `--skip-version-check`: Skip comparing the current instance version against `--from`. - `--skip-drift-check`: Skip comparing the database schema shape against the schema defined by `--from`. -- `--unprivileged-only` and `--noop-privileged`: Controls behavior of schema migrations the presence of [privileged definitions](/self-hosted/how-to/privileged_migrations). +- `--unprivileged-only` and `--noop-privileged`: Controls behavior of schema migrations the presence of [privileged definitions](/self-hosted/how-to/privileged-migrations). - `--ignore-migrator-update`: Controls whether to hard- or soft-fail if a newer migrator version is available. It is recommended to use the latest migrator version. **Notes**: @@ -151,7 +151,7 @@ downgrade \ - `--disable-animation`: Print plain log messages instead of an animated progress bar. - `--skip-version-check`: Skip comparing the current instance version against `--from`. - `--skip-drift-check`: Skip comparing the database schema shape against the schema defined by `--from`. -- `--unprivileged-only`: Controls behavior of schema migrations the presence of [privileged definitions](/self-hosted/how-to/privileged_migrations). +- `--unprivileged-only`: Controls behavior of schema migrations the presence of [privileged definitions](/self-hosted/how-to/privileged-migrations). - `--ignore-migrator-update`: Controls whether to hard- or soft-fail if a newer migrator version is available. It is recommended to use the latest migrator version. **Notes**: @@ -161,7 +161,7 @@ downgrade \ ### add-log -The `add-log` command adds an entry to the `migration_logs` table after a site administrator has explicitly applied the contents of a migration definition. This command may be performed by a site-administrator as part of [repairing a dirty database](/self-hosted/how-to/dirty_database#3-add-a-migration-log-entry). +The `add-log` command adds an entry to the `migration_logs` table after a site administrator has explicitly applied the contents of a migration definition. This command may be performed by a site-administrator as part of [repairing a dirty database](/self-hosted/how-to/dirty-database#3-add-a-migration-log-entry). ```sh add-log \ @@ -220,8 +220,8 @@ up \ - `--db`: The target schema(s) to modify. Comma-separated values are allowed. - `--skip-upgrade-validation`: Skip asserting that the [standard upgrade policy](/self-hosted/updates/#upgrade-types) is being followed. - `--skip-oobmigration-validation`: Skip reading the progress of out-of-band migrations to assert completion of newly deprecated migrations. -- `--ignore-single-dirty-log` and `--ignore-single-pending-log`: Re-attempt to apply the **next** migration that was marked as errored or as incomplete (respectively). See [how to troubleshoot a dirty database](/self-hosted/how-to/dirty_database#0-attempt-re-application). -- `--unprivileged-only`: Controls behavior of schema migrations the presence of [privileged definitions](/self-hosted/how-to/privileged_migrations). +- `--ignore-single-dirty-log` and `--ignore-single-pending-log`: Re-attempt to apply the **next** migration that was marked as errored or as incomplete (respectively). See [how to troubleshoot a dirty database](/self-hosted/how-to/dirty-database#0-attempt-re-application). +- `--unprivileged-only`: Controls behavior of schema migrations the presence of [privileged definitions](/self-hosted/how-to/privileged-migrations). **Notes**: @@ -229,7 +229,7 @@ up \ ### run-out-of-band-migrations -The `run-out-of-band-migrations` command runs out-of-band migrations within the `migrator`. This command may be performed by a site-administrator as part of [repairing an unfinished migration](/self-hosted/how-to/unfinished_migration). +The `run-out-of-band-migrations` command runs out-of-band migrations within the `migrator`. This command may be performed by a site-administrator as part of [repairing an unfinished migration](/self-hosted/how-to/unfinished-migration). ```sh run-out-of-band-migrations \ @@ -417,7 +417,7 @@ Observe the output of the `migrator` container via: $ docker logs migrator_$SOURCEGRAPH_VERSION ``` -The log output of the `migrator` should include `INFO`-level logs and successfully terminate with `migrator exited with code 0`. If you see an error message or any of the databases have been flagged as "dirty", please follow ["How to troubleshoot a dirty database"](/self-hosted/how-to/dirty_database). A dirty database will not affect your ability to use Sourcegraph however it will need to be resolved to upgrade further. If you are unable to resolve the issues, contact support at `mailto:support@sourcegraph.com` for further assistance. Otherwise, you are now safe to upgrade Sourcegraph. +The log output of the `migrator` should include `INFO`-level logs and successfully terminate with `migrator exited with code 0`. If you see an error message or any of the databases have been flagged as "dirty", please follow ["How to troubleshoot a dirty database"](/self-hosted/how-to/dirty-database). A dirty database will not affect your ability to use Sourcegraph however it will need to be resolved to upgrade further. If you are unable to resolve the issues, contact support at `mailto:support@sourcegraph.com` for further assistance. Otherwise, you are now safe to upgrade Sourcegraph. ### Local development diff --git a/docs/self-hosted/updates/migrator/troubleshooting-upgrades.mdx b/docs/self-hosted/updates/migrator/troubleshooting-upgrades.mdx index 08974629c..00848b247 100644 --- a/docs/self-hosted/updates/migrator/troubleshooting-upgrades.mdx +++ b/docs/self-hosted/updates/migrator/troubleshooting-upgrades.mdx @@ -24,4 +24,4 @@ In order to retrieve the error message printed by the migrator on startup, you'l Error from server (BadRequest): container "frontend" in pod "sourcegraph-frontend-69f4b68d75-w98lx" is waiting to start: PodInitializing ``` -Once a failing migration error message can be found, follow the guide on [how to troubleshoot a dirty database](/self-hosted/how-to/dirty_database). +Once a failing migration error message can be found, follow the guide on [how to troubleshoot a dirty database](/self-hosted/how-to/dirty-database). diff --git a/docs/self-hosted/updates/pure_docker.mdx b/docs/self-hosted/updates/pure-docker.mdx similarity index 99% rename from docs/self-hosted/updates/pure_docker.mdx rename to docs/self-hosted/updates/pure-docker.mdx index 103a00daf..dbc176290 100644 --- a/docs/self-hosted/updates/pure_docker.mdx +++ b/docs/self-hosted/updates/pure-docker.mdx @@ -32,7 +32,7 @@ Only self-hosted customers using the Sourcegraph provided PostgreSQL container i Self-hosted customers using external databases, such as AWS RDS, GCP CloudSQL, or another self-managed solution are NOT affected. -See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgresql_collation_version_mismatch_resolution) notes for more details. +See our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgresql-collation-version-mismatch-resolution) notes for more details. ## v5.2.6 ➔ v5.2.7 @@ -302,7 +302,7 @@ For non-standard replica builds: #### Notes: -- This release introduces a background job that will convert all LSIF data into SCIP. **This migration is irreversible** and a rollback from this version may result in loss of precise code intelligence data. Please see the [migration notes](/admin/how-to/lsif_scip_migration) for more details. +- This release introduces a background job that will convert all LSIF data into SCIP. **This migration is irreversible** and a rollback from this version may result in loss of precise code intelligence data. Please see the [migration notes](/admin/how-to/lsif-scip-migration) for more details. ## v4.4.1 ➔ v4.4.2 @@ -340,7 +340,7 @@ As a template, perform the same actions as the following diffs in your own deplo ## v4.1 ➔ v4.2.1 -- `minio` has been replaced with `blobstore`. Please see the update notes [here](/self-hosted/how-to/blobstore_update_notes) +- `minio` has been replaced with `blobstore`. Please see the update notes [here](/self-hosted/how-to/blobstore-update-notes) As a template, perform the same actions as the following diffs in your own deployment: @@ -482,7 +482,7 @@ As a template, perform the same actions as the following diffs in your own deplo **Notes**: - The `query-runner` service has been decomissioned in the 3.35.0 release. You can safely remove the `query-runner` service from your installation. -- There is a [known issue](/code_insights/how-tos/Troubleshooting#oob-migration-has-made-progress-but-is-stuck-before-reaching-100) with the Code Insights out-of-band settings migration not reaching 100% complete when encountering deleted users or organizations. +- There is a [known issue](/code-insights/how-tos/Troubleshooting#oob-migration-has-made-progress-but-is-stuck-before-reaching-100) with the Code Insights out-of-band settings migration not reaching 100% complete when encountering deleted users or organizations. ## v3.33 ➔ v3.34 @@ -617,7 +617,7 @@ As a template, perform the same actions as the following diffs in your own deplo **Notes**: - This upgrade removes the `code intel bundle manager`. This service has been deprecated and all references to it have been removed. -- This upgrade also adds a MinIO container that doesn't require any custom configuration. You can find more detailed documentation [here](/self-hosted/external_services/object_storage). +- This upgrade also adds a MinIO container that doesn't require any custom configuration. You can find more detailed documentation [here](/self-hosted/external-services/object-storage). ## v3.20 ➔ v3.21 diff --git a/docs/self-hosted/updates/server.mdx b/docs/self-hosted/updates/server.mdx index 0e75c29b1..a59a15cd3 100644 --- a/docs/self-hosted/updates/server.mdx +++ b/docs/self-hosted/updates/server.mdx @@ -44,13 +44,13 @@ For upgrade procedures or general info about sourcegraph versioning see the link #### Notes: -- This release introduces a background job that will convert all LSIF data into SCIP. **This migration is irreversible** and a rollback from this version may result in loss of precise code intelligence data. Please see the [migration notes](/admin/how-to/lsif_scip_migration) for more details. +- This release introduces a background job that will convert all LSIF data into SCIP. **This migration is irreversible** and a rollback from this version may result in loss of precise code intelligence data. Please see the [migration notes](/admin/how-to/lsif-scip-migration) for more details. ## v3.34 ➔ v3.35 #### Notes: -- There is a [known issue](/code_insights/how-tos/Troubleshooting#oob-migration-has-made-progress-but-is-stuck-before-reaching-100) with the Code Insights out-of-band settings migration not reaching 100% complete when encountering deleted users or organizations. +- There is a [known issue](/code-insights/how-tos/Troubleshooting#oob-migration-has-made-progress-but-is-stuck-before-reaching-100) with the Code Insights out-of-band settings migration not reaching 100% complete when encountering deleted users or organizations. ## v3.30 ➔ v3.31 @@ -91,5 +91,5 @@ No upgrade notes. #### Notes: -- This release introduces a second database instance, `codeintel-db`. If you have configured Sourcegraph with an external database, then update the `CODEINTEL_PG*` environment variables to point to a new external database as described in the [external database documentation](/self-hosted/external_services/postgres). Again, these must not point to the same database or the Sourcegraph instance will refuse to start. +- This release introduces a second database instance, `codeintel-db`. If you have configured Sourcegraph with an external database, then update the `CODEINTEL_PG*` environment variables to point to a new external database as described in the [external database documentation](/self-hosted/external-services/postgres). Again, these must not point to the same database or the Sourcegraph instance will refuse to start. - **Turn off database secrets encryption**. In Sourcegraph version 3.20, we would automatically generate a secret key file (`/var/lib/sourcegraph/token`) inside the container for encrypting secrets stored in the database. However, it is not yet ready for general use and format of the secret key file might change. Therefore, it is best to delete the secret key file (`/var/lib/sourcegraph/token`) and turn off the database secrets encryption. diff --git a/docs/self-hosted/url.mdx b/docs/self-hosted/url.mdx index 888ae3200..b874398ad 100644 --- a/docs/self-hosted/url.mdx +++ b/docs/self-hosted/url.mdx @@ -2,7 +2,7 @@ It is highly recommended that you do NOT make any of the nodes running Sourcegraph directly accessible to the Internet. Instead, configure an [Internet Gateway](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Internet_Gateway.html) or equivalent to forward traffic to `httpNodePort` or `httpsNodePort` on any of the nodes in your cluster. -When that is done, update your DNS records to point to your gateway's external IP, and change the following line in your [site configuration](/admin/config/site_config): +When that is done, update your DNS records to point to your gateway's external IP, and change the following line in your [site configuration](/admin/config/site-config): ```json { diff --git a/docs/self-hosted/workers.mdx b/docs/self-hosted/workers.mdx index 44d007a0e..c87a6e5a6 100644 --- a/docs/self-hosted/workers.mdx +++ b/docs/self-hosted/workers.mdx @@ -30,7 +30,7 @@ This job periodically updates the set of code graph data indexes that are visibl #### `codeintel-autoindexing-scheduler` -This job periodically checks for repositories that can be auto-indexed and queues indexing jobs for a remote executor instance to perform. Read how to [enable](/code-navigation/auto_indexing#enable-auto-indexing) and [configure](/code-navigation/auto_indexing#configure-auto-indexing) auto-indexing. +This job periodically checks for repositories that can be auto-indexed and queues indexing jobs for a remote executor instance to perform. Read how to [enable](/code-navigation/auto-indexing#enable-auto-indexing) and [configure](/code-navigation/auto-indexing#configure-auto-indexing) auto-indexing. #### `codeintel-autoindexing-summary-builder` @@ -38,7 +38,7 @@ This job periodically checks for auto-indexability on repositories in the backgr #### `codeintel-autoindexing-dependency-scheduler` -This job periodically checks for dependency packages that can be auto-indexed and queues indexing jobs for a remote executor instance to perform. Read how to [enable](/code-navigation/auto_indexing#enable-auto-indexing) and [configure](/code-navigation/auto_indexing#configure-auto-indexing) auto-indexing. +This job periodically checks for dependency packages that can be auto-indexed and queues indexing jobs for a remote executor instance to perform. Read how to [enable](/code-navigation/auto-indexing#enable-auto-indexing) and [configure](/code-navigation/auto-indexing#configure-auto-indexing) auto-indexing. #### `codeintel-metrics-reporter` diff --git a/docs/sla/index.mdx b/docs/sla/index.mdx index 1ee21db7b..ee34676ef 100644 --- a/docs/sla/index.mdx +++ b/docs/sla/index.mdx @@ -7,7 +7,7 @@ ## Service Level Agreements (SLAs) -Our service level agreements (SLAs) are designed for products that are generally available and exclude [beta and experimental features](/admin/beta_and_experimental_features). SLA response times indicate how quickly we aim to provide an initial response to your inquiries or concerns. Our team will resolve all issues as quickly as possible. However, it's important to understand that SLA times differ from guaranteed resolution times. +Our service level agreements (SLAs) are designed for products that are generally available and exclude [beta and experimental features](/admin/beta-and-experimental-features). SLA response times indicate how quickly we aim to provide an initial response to your inquiries or concerns. Our team will resolve all issues as quickly as possible. However, it's important to understand that SLA times differ from guaranteed resolution times. While we always strive to respond to your issues as quickly as possible, our SLAs are specifically applicable from Monday through Friday. @@ -115,7 +115,7 @@ Premium SLAs give customers access to our Support team 24x7 for Severity 0 and 1 First response times remain the same according to our SLAs. However, Emergency and Severe Impact issues are supported 24x7 with Premium Support (versus 24x5 without Premium Support). -This service is provided for all GA products Sourcegraph offers, not for any [Experimental or Beta features](/admin/beta_and_experimental_features). +This service is provided for all GA products Sourcegraph offers, not for any [Experimental or Beta features](/admin/beta-and-experimental-features). > NOTE: This package includes access to Slack Support diff --git a/docs/technical-changelog.mdx b/docs/technical-changelog.mdx index 2f5236ca6..f584f0f95 100644 --- a/docs/technical-changelog.mdx +++ b/docs/technical-changelog.mdx @@ -3152,7 +3152,7 @@ There were no reverts for this release - [kustomize](https://github.com/sourcegraph/deploy-sourcegraph-k8s/releases/tag/v6.2.2553) > Attention - This patch contains a known issue for self-hosted customers upgrading from previous versions of Sourcegraph whom are using the Sourcegraph provided PostgreSQL container images. -> Please see our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgresql_collation_version_mismatch_resolution) notes for more details. +> Please see our [PostgreSQL Collation Version Mismatch Resolution](/self-hosted/postgresql-collation-version-mismatch-resolution) notes for more details. ### Features @@ -4926,7 +4926,7 @@ There were no reverts for this release > If you are required to continue on 6.0 release series, please upgrade to 6.0 Patch 2. > Attention - Postgres 12 is no longer supported! If upgrading from Sourcegraph version 5.9 or earlier, this release will update our included database container images from Postgres 12 to Postgres 16. -> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. +> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12-end-of-life-notice#postgres-12-end-of-life) notice for more information. > > Also be sure to check your deployment type's [upgrade notes](http://sourcegraph.com/docs/admin/updates#instance-specific-procedures)! @@ -5619,7 +5619,7 @@ The following PRs were merged onto the previous release branch but could not be # 5.11 Patch 5 > Attention - If upgrading from Sourcegraph version 5.9 or earlier, this release will update our included database container images from Postgres 12 to Postgres 16. -> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. +> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12-end-of-life-notice#postgres-12-end-of-life) notice for more information. > > Also be sure to check your deployment type's [upgrade notes](http://sourcegraph.com/docs/admin/updates#instance-specific-procedures)! @@ -5652,7 +5652,7 @@ There were no reverts for this release # 5.11 Patch 4 > Attention - If upgrading from Sourcegraph version 5.9 or earlier, this release will update our included database container images from Postgres 12 to Postgres 16. -> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. +> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12-end-of-life-notice#postgres-12-end-of-life) notice for more information. > > Also be sure to check your deployment type's [upgrade notes](http://sourcegraph.com/docs/admin/updates#instance-specific-procedures)! @@ -5694,7 +5694,7 @@ There were no reverts for this release # 5.11 Patch 3 > Attention - If upgrading from Sourcegraph version 5.9 or earlier, this release will update our included database container images from Postgres 12 to Postgres 16. -> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. +> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12-end-of-life-notice#postgres-12-end-of-life) notice for more information. > > Also be sure to check your deployment type's [upgrade notes](http://sourcegraph.com/docs/admin/updates#instance-specific-procedures)! @@ -5745,7 +5745,7 @@ There were no reverts for this release # 5.11 Patch 2 > Attention - If upgrading from Sourcegraph version 5.9 or earlier, this release will update our included database container images from Postgres 12 to Postgres 16. -> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. +> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12-end-of-life-notice#postgres-12-end-of-life) notice for more information. > > Also be sure to check your deployment type's [upgrade notes](http://sourcegraph.com/docs/admin/updates#instance-specific-procedures)! @@ -5774,7 +5774,7 @@ There were no reverts for this release # 5.11 Patch 1 > Attention - If upgrading from Sourcegraph version 5.9 or earlier, this release will update our included database container images from Postgres 12 to Postgres 16. -> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. +> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12-end-of-life-notice#postgres-12-end-of-life) notice for more information. > > Also be sure to check your deployment type's [upgrade notes](http://sourcegraph.com/docs/admin/updates#instance-specific-procedures)! @@ -5811,7 +5811,7 @@ There were no reverts for this release # 5.11 Patch 0 > Attention - If upgrading from Sourcegraph version 5.9 or earlier, this release will update our included database container images from Postgres 12 to Postgres 16. -> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice for more information. +> Customers are advised to have a database backup before upgrading. See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12-end-of-life-notice#postgres-12-end-of-life) notice for more information. > > Also be sure to check your deployment type's [upgrade notes](http://sourcegraph.com/docs/admin/updates#instance-specific-procedures)! @@ -6365,7 +6365,7 @@ The following PRs were merged onto the previous release branch but could not be # 5.10 Patch 3 -> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to have a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! +> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to have a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12-end-of-life-notice#postgres-12-end-of-life) notice! > > Also be sure to check your deployment type's [upgrade notes](http://sourcegraph.com/docs/admin/updates#instance-specific-procedures)! @@ -6402,7 +6402,7 @@ There were no reverts for this release # 5.10 Patch 2 -> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to have a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! +> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to have a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12-end-of-life-notice#postgres-12-end-of-life) notice! > > Also be sure to check your deployment type's [upgrade notes](http://sourcegraph.com/docs/admin/updates#instance-specific-procedures)! @@ -6466,7 +6466,7 @@ There were no reverts for this release # 5.10 Patch 1 -> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to take a database backup before upgrading! See our [Postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! +> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to take a database backup before upgrading! See our [Postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12-end-of-life-notice#postgres-12-end-of-life) notice! > > Warning: `automatic` upgrades will require setting the environment variable `SRC_AUTOUPGRADE_IGNORE_DRIFT=true` on the `sourcegraph-frontend` deployment/container. > @@ -6510,7 +6510,7 @@ There were no reverts for this release > Warning: Admins are advised to upgrade directly to v5.10.1164 circumventing this release. > -> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to have a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12_end_of_life_notice#postgres-12-end-of-life) notice! +> Warning: This release updates the database container images from Postgres 12 to Postgres 16, and begins using Wolfi based images. Customers are advised to have a database backup before upgrading! See our [postgres 12 end of life](https://sourcegraph.com/docs/self-hosted/postgres12-end-of-life-notice#postgres-12-end-of-life) notice! > > Warning: `automatic` and migrator `upgrade` command will not work for this release, please upgrade directly to `v5.10.1164`, or to a 5.9 version and conduct a standard upgrade using migrator's default `up` command! > @@ -9399,7 +9399,7 @@ The following PRs were merged onto the previous release branch but could not be - Consolidate mocks for dbworker/store.Store type [#64294](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/64294) - Consolidate mocks for uploads's Store type [#64286](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/64286) - Move cmd/frontend/oneclickexport to cmd/frontend/internal/oneclickexport [#64069](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/64069) -- Move authn into cmd/frontend [#63648](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/63648)GitLab code host connections were [able to sync permissions by mapping Sourcegraph users to GitLab users via the username property of an external OIDC or SAML provider](https://sourcegraph.com/docs/admin/code_hosts/gitlab#administrator-sudo-level-access-token) that is shared across Sourcegraph and GitLab. This integration stopped working a long time ago, and it has been removed in this release. +- Move authn into cmd/frontend [#63648](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/63648)GitLab code host connections were [able to sync permissions by mapping Sourcegraph users to GitLab users via the username property of an external OIDC or SAML provider](https://sourcegraph.com/docs/admin/code-hosts/gitlab#administrator-sudo-level-access-token) that is shared across Sourcegraph and GitLab. This integration stopped working a long time ago, and it has been removed in this release. - Replace calls to deprecated ioutil.TempFile [#64177](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/64177) #### Svelte @@ -11546,7 +11546,7 @@ The following PRs were merged onto the previous release branch but could not be - The LLM completions endpoint is now exposed through a GraphQL query in addition to the streaming endpoint [#50455](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/50455) - Permissions center statistics pane is added. Stats include numbers of queued jobs, users/repos with failed jobs, no permissions, and outdated permissions. [#50535](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/50535) - SCIM user provisioning support for Deactivate/Reactivation of users. [#50533](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/50533) -- Login form can now be configured with ordering and limit of auth providers. [See docs](/admin/auth/login_form). [#50586](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/50586), [50284](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/50284) and [#50705](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/50705) +- Login form can now be configured with ordering and limit of auth providers. [See docs](/admin/auth/login-form). [#50586](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/50586), [50284](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/50284) and [#50705](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/50705) - OOM reaper events affecting `p4-fusion` jobs on `gitserver` are better detected and handled. Error (non-zero) exit status is used, and the resource (CPU, memory) usage of the job process is appended to the job output so that admins can infer possible OOM activity and take steps to address it. [#51284](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/51284) - When creating a new batch change, spaces are automatically replaced with dashes in the name field. [#50825](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/50825) and [51071](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/51071) - Support for custom HTML injection behind an environment variable (`ENABLE_INJECT_HTML`). This allows users to enable or disable HTML customization as needed, which is now disabled by default. [#51400](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/51400) @@ -11575,7 +11575,7 @@ The following PRs were merged onto the previous release branch but could not be - Access tokens now begin with the prefix `sgp_` to make them identifiable as secrets. You can also prepend `sgp_` to previously generated access tokens, although they will continue to work as-is without that prefix. - The commit message defined in a batch spec will now be quoted when git is invoked, i.e. `git commit -m "commit message"`, to improve how the message is interpreted by the shell in certain edge cases, such as when the commit message begins with a dash. This may mean that previous escaping strategies will behave differently. - 429 errors from external services Sourcegraph talks to are only retried automatically if the Retry-After header doesn't indicate that a retry would be useless. The time grace period can be configured using `SRC_HTTP_CLI_EXTERNAL_RETRY_AFTER_MAX_DURATION` and `SRC_HTTP_CLI_INTERNAL_RETRY_AFTER_MAX_DURATION`. [#51743](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/51743) -- Security Events NO LONGER write to database by default - Instead, they will be written in the [audit log format](/admin/audit_log) to console. There is a new site config setting `log.securityEventLogs` that can be used to configure security event logs to write to database if the old behaviour is desired. This new default will significantly improve performance for large instances. In addition, the old environment variable `SRC_DISABLE_LOG_PRIVATE_REPO_ACCESS` no longer does anything. [#51686](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/51686) +- Security Events NO LONGER write to database by default - Instead, they will be written in the [audit log format](/admin/audit-log) to console. There is a new site config setting `log.securityEventLogs` that can be used to configure security event logs to write to database if the old behaviour is desired. This new default will significantly improve performance for large instances. In addition, the old environment variable `SRC_DISABLE_LOG_PRIVATE_REPO_ACCESS` no longer does anything. [#51686](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/51686) - Audit Logs & Security Events are written with the same severity level as `SRC_LOG_LEVEL`. This prevents a misconfiguration issue when `log.AuditLogs.SeverityLevel` was set below the overall instance log level. `log.AuditLogs.SeverityLevel` has been marked as deprecated and will be removed in a future release [#52566](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/52566) @@ -11725,7 +11725,7 @@ The following PRs were merged onto the previous release branch but could not be - The environment variable `TELEMETRY_HTTP_PROXY` can be set on the `sourcegraph-frontend` service, to use an HTTP proxy for telemetry and update check requests. [#47466](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/47466) - Kubernetes Deployments: Introduced a new Kubernetes deployment option ([deploy-sourcegraph-k8s](https://github.com/sourcegraph/deploy-sourcegraph-k8s)) to deploy Sourcegraph with Kustomize. [#46755](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/46755) - Kubernetes Deployments: The new Kustomize deployment ([deploy-sourcegraph-k8s](https://github.com/sourcegraph/deploy-sourcegraph-k8s)) introduces a new base cluster that runs all Sourcegraph services as non-root users with limited privileges and eliminates the need to create RBAC resources. [#4213](https://github.com/sourcegraph/deploy-sourcegraph/pull/4213) -- Added the `other.exclude` setting to [Other external service config](/admin/code_hosts/other#configuration). It can be configured to exclude mirroring of repositories matching a pattern similar to other external services. This is useful when you want to exclude repositories discovered via `src serve-git`. [#48168](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/48168) +- Added the `other.exclude` setting to [Other external service config](/admin/code-hosts/other#configuration). It can be configured to exclude mirroring of repositories matching a pattern similar to other external services. This is useful when you want to exclude repositories discovered via `src serve-git`. [#48168](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/48168) - The **Site admin > Updates** Page displays the upgrade readiness information about schema drift and out-of-band migrations. [#48046](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/48046) - Pings now contain ownership search and file-view activity counts. [#47062](https://github.com/sourcegraph/sourcegraph-public-snapshot/47062) - Greatly improves keyboard handling and accessibility of the files and symbol tree on the repository pages. [#12916](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/12916) @@ -11738,8 +11738,8 @@ The following PRs were merged onto the previous release branch but could not be - Added Azure DevOps Services as a Tier 1 Code Host, including: repository syncing, permissions syncing, and Batch Changes support. [#46265](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/46265) - Added feature to disable some fields on user profiles for SCIM-controlled users. [#48816](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/48816) - Native support for ingesting and searching GitHub topics with `repo:has.topic()` [#48875](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/48875) -- [Role- Access Control](/admin/access_control) is now available as an enterprise feature (in Beta). It is currently only supported for Batch Changes functionality. [#43276](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/43276) -- Site admins can now [restrict creation of batch changes to certain u[sers](/admin/access_control/batch_changes) by tailoring their roles and the permissions granted to those )roles. [#34491](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/34491) +- [Role- Access Control](/admin/access-control) is now available as an enterprise feature (in Beta). It is currently only supported for Batch Changes functionality. [#43276](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/43276) +- Site admins can now [restrict creation of batch changes to certain u[sers](/admin/access-control/batch-changes) by tailoring their roles and the permissions granted to those )roles. [#34491](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/34491) - Site admins can now [configure outgoing webh[ooks](/admin/webhooks/outgoing) for Batch Changes to inform external tools of events related to Sourceg)raph batch changes and their changesets. [#38278](https://github.com/sourcegraph/sourcegraph-public-snapshot/issues/38278) - [Sourcegraph[ Own](/own) is now available as an experimental enterprise feature. Enable the `search-ownership` fe)ature flag to use it. - Gitserver supports a new `COURSIER_CACHE_DIR` env var to configure the cache location for coursier JVM package repos. @@ -11786,7 +11786,7 @@ The following PRs were merged onto the previous release branch but could not be - Endpoint environment variables (`SEARCHER_URL`, `SYMBOLS_URL`, `INDEXED_SEARCH_SERVERS`, `SRC_GIT_SERVERS`) now can be set to replica count values in Kubernetes, Kustomize, Helm and Docker Compose environments. This avoids the need to use service discovery or generating the respective list of addresses in those environments. [#45862](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/45862) - The default author and email for changesets will now be pulled from user account details when possible. [#46385](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/46385) - Code Insights has a new display option: "Max number of series points to display". This setting controls the number of data points you see per series on an insight. [#46653](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/46653) -- Added out-of-band migration that will migrate all existing data from LSIF to SCIP (see additional [migration documenta[tion](/admin/how-to/lsif_scip_migration)). [#45106](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/45106)) +- Added out-of-band migration that will migrate all existing data from LSIF to SCIP (see additional [migration documenta[tion](/admin/how-to/lsif-scip-migration)). [#45106](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/45106)) - Code Insights has a new search-powered repositories field that allows you to select repositories with Sourcegraph search syntax. [#45687](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/45687) - You can now export all data for a Code Insight from the card menu or the standalone page. [#46795](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/46795), [#46694](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/46694) - Added Gerrit as an officially supported code host with permissions syncing. [#46763](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/46763) @@ -11927,10 +11927,10 @@ The following PRs were merged onto the previous release branch but could not be - A new status message now reports how many repositories have already been indexed for search. [#45246](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/45246) - Search contexts can now be starred (favorited) in the search context management page. Starred search contexts will appear before other contexts in the context dropdown menu next to the search box. [#45230](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/45230) - Search contexts now let you set a context as your default. The default will be selected every time you open Sourcegraph and will appear near the top in the context dropdown menu next to the search box. [#45387](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/45387) -- [search.largeF[iles](/admin/config/site_config#search-largeFiles) accepts an optional prefix `!` to negate a pattern. The o)rder of the patterns within search.largeFiles is honored such that the last pattern matching overrides preceding patterns. For patterns that begin with a literal `!` prefix with a backslash, for example, `\!fileNameStartsWithExcl!.txt`. Previously indexed files that become excluded due to this change will remain in the index until the next reindex [#45318](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/45318) +- [search.largeF[iles](/admin/config/site-config#search-largeFiles) accepts an optional prefix `!` to negate a pattern. The o)rder of the patterns within search.largeFiles is honored such that the last pattern matching overrides preceding patterns. For patterns that begin with a literal `!` prefix with a backslash, for example, `\!fileNameStartsWithExcl!.txt`. Previously indexed files that become excluded due to this change will remain in the index until the next reindex [#45318](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/45318) - [Webh[ooks](/admin/webhooks/incoming) have been overhauled completely and can now be found under **Site admin >) Repositories > Incoming webhooks**. Webhooks that were added via code host configuration are [deprec[ated](/admin/webhooks/incoming#deprecation-notice) and will be removed in 5.1.0. - Added support fo)r receiving webhook `push` events from GitHub which will trigger Sourcegraph to fetch the latest commit rather than relying on polling. -- Added support for private container registries in Sourcegraph executors. [Using private registries](/self-hosted/executors/deploy_executors#using-private-registries) +- Added support for private container registries in Sourcegraph executors. [Using private registries](/self-hosted/executors/deploy-executors#using-private-registries) ### Changed @@ -11960,7 +11960,7 @@ The following PRs were merged onto the previous release branch but could not be # v4.2.1 -- `minio` has been replaced with `blobstore`. Please see the update notes [here](/self-hosted/how-to/blobstore_update_notes) +- `minio` has been replaced with `blobstore`. Please see the update notes [here](/self-hosted/how-to/blobstore-update-notes) # v4.2.0 @@ -11971,7 +11971,7 @@ The following PRs were merged onto the previous release branch but could not be - Code Insights data points that do not contain any results will display zero instead of being omitted from the visualization. Only applies to insight data created after 4.2. [#43166](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/43166) - Sourcegraph ships with node-exporter, a Prometheus tool that provides hardware / OS metrics that helps Sourcegraph scale your deployment. See your deployment update for more information: - [Kubernetes](/self-hosted/updates/kubernetes) - - [Docker Compose](/self-hosted/updates/docker_compose) + - [Docker Compose](/self-hosted/updates/docker-compose) - A structural search diagnostic to warn users when a language filter is not set. [#43835](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/43835) - GitHub/GitLab OAuth success/fail attempts are now a part of the audit log. [#43886](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/43886) - When rendering a file which is backed by Git LFS, we show a page informing the file is LFS and linking to the file on the codehost. Previously we rendered the LFS pointer. [#43686](https://github.com/sourcegraph/sourcegraph-public-snapshot/pull/43686) diff --git a/docs/tutorials/index.mdx b/docs/tutorials/index.mdx index c57f4d10f..bcec44236 100644 --- a/docs/tutorials/index.mdx +++ b/docs/tutorials/index.mdx @@ -45,8 +45,8 @@ Full [search query syntax](/code-search/queries). | [Search Results Page Overview](https://www.loom.com/share/c713baea045c40bdba9bc2f524ae4387?sid=8f6e3242-032c-40ec-9fa8-2006ad3c30f9) | Tutorial (video) | Navigating the search results page. | | [Intro to Search Filters](https://www.loom.com/share/f48295092e7f4a9b874bfd8f81595a87?sid=dd05c740-be70-4374-b890-219a48c8d9f2) | Tutorial (video) | An overview of the most commonly-used search filters such as Language, Repo, and File. | | [Search Types](https://www.loom.com/share/2484f5b47fec47c68369399a26a18150?sid=52b5df3f-35d4-4ea0-b009-cd64946d1d38) | Tutorial (video) | Searching against Code, Repo, Path, Symbol, Commit, and Diff data. | -| [Saving Searches](https://www.loom.com/share/5728c5fc9ac14a11aa9ca875c6eaa406?sid=eb6112d7-5f3e-45fb-ae89-a990355f0ab8) | Tutorial (video) | [Saving](/code-search/working/saved_searches) commonly-used searches. | -| [Search Contexts](https://www.loom.com/share/0b2ebb0a96154a87bad3c3c451f2ffcd?sid=dd211b02-6d7b-4c52-86fd-bebccc4a63d9) | Tutorial (video) | Intro to [Search Contexts](/code-search/working/search_contexts) and how to manage them. | +| [Saving Searches](https://www.loom.com/share/5728c5fc9ac14a11aa9ca875c6eaa406?sid=eb6112d7-5f3e-45fb-ae89-a990355f0ab8) | Tutorial (video) | [Saving](/code-search/working/saved-searches) commonly-used searches. | +| [Search Contexts](https://www.loom.com/share/0b2ebb0a96154a87bad3c3c451f2ffcd?sid=dd211b02-6d7b-4c52-86fd-bebccc4a63d9) | Tutorial (video) | Intro to [Search Contexts](/code-search/working/search-contexts) and how to manage them. | ### Advanced Searching @@ -82,9 +82,9 @@ Full [search query syntax](/code-search/queries). | Topic | Content Type | Description | | --------------------------------------------------------------------------------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------- | | [Code Insights Overview](https://www.youtube.com/watch?v=HdQIFuUzGFI) | Explanation (video) | Learn about common Code Insights use cases and see how to create an insight. | -| [Quickstart Guide](/code_insights/quickstart) | Tutorial | Get started and create your first code insight in 5 minutes or less. | -| [Common Use Cases](/code_insights/references/common_use_cases) | Reference | A list of common use cases for Code Insights and example data series queries you could use. | -| [Code Insights](https://www.loom.com/share/7066ac1ef33a41638793ac8f468b8ab8?sid=35b001df-84f8-4221-90c4-2ba46e03b9fc) | Tutorial (video) | Intro to [Code Insights](/code_insights). | +| [Quickstart Guide](/code-insights/quickstart) | Tutorial | Get started and create your first code insight in 5 minutes or less. | +| [Common Use Cases](/code-insights/references/common-use-cases) | Reference | A list of common use cases for Code Insights and example data series queries you could use. | +| [Code Insights](https://www.loom.com/share/7066ac1ef33a41638793ac8f468b8ab8?sid=35b001df-84f8-4221-90c4-2ba46e03b9fc) | Tutorial (video) | Intro to [Code Insights](/code-insights). | ## Batch Changes @@ -100,7 +100,7 @@ Full [search query syntax](/code-search/queries). | Topic | Content Type | Description | | ----------------------------------------------------------------------------------------------------------------------- | ---------------- | --------------------------------------------- | -| [Code Monitoring](https://www.loom.com/share/99b8302e832a4341bc98916219fe8418?sid=261fc431-67e7-4df2-9cfa-306bcf003911) | Tutorial (video) | Intro to [Code Monitoring](/code_monitoring). | +| [Code Monitoring](https://www.loom.com/share/99b8302e832a4341bc98916219fe8418?sid=261fc431-67e7-4df2-9cfa-306bcf003911) | Tutorial (video) | Intro to [Code Monitoring](/code-monitoring). | ## The Sourcegraph API @@ -108,7 +108,7 @@ Full [search query syntax](/code-search/queries). | ------------------------------------------------------------------ | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [GraphQL API](/api/graphql/) | Reference | The Sourcegraph GraphQL API is a rich API that exposes data related to the code available on a Sourcegraph instance. | | [GraphQL Examples](/api/graphql/managing-search-contexts-with-api) | Reference | This page demonstrates a few example GraphQL queries for the Sourcegraph GraphQL API. | -| [Streaming API](/api/stream_api/) | Reference | With the Stream API you can consume search results and related metadata as a stream of events. The Sourcegraph UI calls the Stream API for all interactive searches. Compared to our GraphQL API, it offers shorter times to first results and supports running exhaustive searches returning a large volume of results without putting pressure on the backend. | +| [Streaming API](/api/stream-api/) | Reference | With the Stream API you can consume search results and related metadata as a stream of events. The Sourcegraph UI calls the Stream API for all interactive searches. Compared to our GraphQL API, it offers shorter times to first results and supports running exhaustive searches returning a large volume of results without putting pressure on the backend. | ## Search Notebooks @@ -121,5 +121,5 @@ Full [search query syntax](/code-search/queries). | Topic | Content Type | Description | | -------------------------------------------------------------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Using Sourcegraph with your IDE](/integration/editor) | How-To-Guide | Sourcegraph's editor integrations allow you search and navigate across all of your repositories without ever leaving your IDE or checking them out locally. We have built-in integrations with VS Code and JetBrains. | -| [Using the Sourcegraph Browser Extension](/integration/browser_extension/) | How-To-Guide | The open-source Sourcegraph browser extension adds code navigation to files and diffs on GitHub, GitHub Enterprise, GitLab, Phabricator, Bitbucket Server and Bitbucket Data Center. | +| [Using the Sourcegraph Browser Extension](/integration/browser-extension/) | How-To-Guide | The open-source Sourcegraph browser extension adds code navigation to files and diffs on GitHub, GitHub Enterprise, GitLab, Phabricator, Bitbucket Server and Bitbucket Data Center. | | [Using the Sourcegraph CLI](/cli/quickstart) | How-To-Guide | `src` is a command line interface to Sourcegraph that allows you to search code from your terminal, create and apply batch changes, and manage and administrate repositories, users, and more. | diff --git a/src/data/navigation.ts b/src/data/navigation.ts index b14ab0778..79c9841b8 100644 --- a/src/data/navigation.ts +++ b/src/data/navigation.ts @@ -37,7 +37,7 @@ export const navigation: NavigationItem[] = [ subsections: [ { title: 'Search Filters Panel', - href: '/code-search/working/search_filters' + href: '/code-search/working/search-filters' }, { title: 'Search Examples', @@ -55,7 +55,7 @@ export const navigation: NavigationItem[] = [ }, { title: 'Advanced Features', - href: '/code-search/working/saved_searches', + href: '/code-search/working/saved-searches', subsections: [ { title: 'Fuzzy Finder', @@ -63,7 +63,7 @@ export const navigation: NavigationItem[] = [ }, { title: 'Search Contexts', - href: '/code-search/working/search_contexts' + href: '/code-search/working/search-contexts' }, { title: 'Search Jobs', @@ -75,11 +75,11 @@ export const navigation: NavigationItem[] = [ }, { title: 'Search Subexpressions', - href: '/code-search/working/search_subexpressions' + href: '/code-search/working/search-subexpressions' }, { title: 'Saved Searches', - href: '/code-search/working/saved_searches' + href: '/code-search/working/saved-searches' }, { title: 'Structural Search', @@ -108,19 +108,19 @@ export const navigation: NavigationItem[] = [ }, { title: 'Search-based code navigation', - href: '/code-navigation/search_based_code_navigation' + href: '/code-navigation/search-based-code-navigation' }, { title: 'Precise code navigation', - href: '/code-navigation/precise_code_navigation' + href: '/code-navigation/precise-code-navigation' }, { title: 'Syntactic code navigation', - href: '/code-navigation/syntactic_code_navigation' + href: '/code-navigation/syntactic-code-navigation' }, { title: 'Auto-indexing', - href: '/code-navigation/auto_indexing' + href: '/code-navigation/auto-indexing' }, { title: 'Environment Variables', @@ -396,7 +396,7 @@ export const navigation: NavigationItem[] = [ }, { title: 'Code Monitoring', - href: '/code_monitoring' + href: '/code-monitoring' }, { title: 'Code Ownership', @@ -404,33 +404,33 @@ export const navigation: NavigationItem[] = [ sections: [ { title: 'CODEOWNERS Format', - href: '/own/codeowners_format' + href: '/own/codeowners-format' }, { title: 'CODEOWNERS Ingestion', - href: '/own/codeowners_ingestion' + href: '/own/codeowners-ingestion' }, { title: 'Configuration Reference', - href: '/own/configuration_reference' + href: '/own/configuration-reference' }, { title: 'Assigned Ownership', - href: '/own/assigned_ownership' + href: '/own/assigned-ownership' } ] }, { title: 'Code Insights', - href: '/code_insights', + href: '/code-insights', sections: [ - {title: 'Quickstart', href: '/code_insights/quickstart'}, + {title: 'Quickstart', href: '/code-insights/quickstart'}, { title: 'Explanations', - href: '/code_insights/explanations' + href: '/code-insights/explanations' }, - {title: 'How-to Guides', href: '/code_insights/how-tos'}, - {title: 'References', href: '/code_insights/references'} + {title: 'How-to Guides', href: '/code-insights/how-tos'}, + {title: 'References', href: '/code-insights/references'} ] } ] @@ -448,20 +448,20 @@ export const navigation: NavigationItem[] = [ title: 'Enterprise Portal', href: '/admin/enterprise-portal' }, - {title: 'Codehosts', href: '/admin/code_hosts'}, + {title: 'Codehosts', href: '/admin/code-hosts'}, {title: 'User Authentication', href: '/admin/auth'}, - {title: 'Access Control', href: '/admin/access_control'}, + {title: 'Access Control', href: '/admin/access-control'}, { title: 'Repository Permissions', href: '/admin/permissions' }, - {title: 'OAuth Apps', href: '/admin/oauth_apps'}, + {title: 'OAuth Apps', href: '/admin/oauth-apps'}, {title: 'Executors', href: '/admin/executors'}, {title: 'FAQs', href: '/admin/faq'}, {title: 'How-to Guides', href: '/admin/how-to'}, { title: 'Enterprise Getting Started', - href: '/admin/enterprise_getting_started_guide' + href: '/admin/enterprise-getting-started-guide' }, {title: 'Architecture', href: '/admin/architecture'} ] @@ -478,22 +478,37 @@ export const navigation: NavigationItem[] = [ title: 'Deploy', href: '/self-hosted/deploy', subsections: [ - {title: 'Single-node', href: '/self-hosted/deploy/single-node'}, - {title: 'Docker Compose', href: '/self-hosted/deploy/docker-compose'}, - {title: 'Kubernetes', href: '/self-hosted/deploy/kubernetes'}, - {title: 'Machine Images', href: '/self-hosted/deploy/machine-images'} + { + title: 'Single-node', + href: '/self-hosted/deploy/single-node' + }, + { + title: 'Docker Compose', + href: '/self-hosted/deploy/docker-compose' + }, + { + title: 'Kubernetes', + href: '/self-hosted/deploy/kubernetes' + }, + { + title: 'Machine Images', + href: '/self-hosted/deploy/machine-images' + } ] }, { title: 'Upgrade', href: '/self-hosted/updates', subsections: [ - {title: 'Migrator', href: '/self-hosted/updates/migrator'} + { + title: 'Migrator', + href: '/self-hosted/updates/migrator' + } ] }, { title: 'External Services', - href: '/self-hosted/external_services' + href: '/self-hosted/external-services' }, { title: 'Executors', @@ -531,12 +546,12 @@ export const navigation: NavigationItem[] = [ sections: [ { title: 'Browser Extension', - href: '/integration/browser_extension' + href: '/integration/browser-extension' }, {title: 'Editors', href: '/integration/editor'}, { title: 'Browser Search Engine', - href: '/integration/browser_extension/how-tos/browser_search_engine' + href: '/integration/browser-extension/how-tos/browser-search-engine' } ] } @@ -562,7 +577,7 @@ export const navigation: NavigationItem[] = [ }, { title: 'Sourcegraph Stream API', - href: '/api/stream_api' + href: '/api/stream-api' }, { title: 'Sourcegraph MCP Server', diff --git a/src/data/redirects.ts b/src/data/redirects.ts index eddd33369..86554ba60 100644 --- a/src/data/redirects.ts +++ b/src/data/redirects.ts @@ -1,7 +1,12 @@ const redirectsData = [ { source: '/admin/tls_ssl', - destination: '/admin/http_https_configuration', + destination: '/self-hosted/http-https-configuration', + permanent: true + }, + { + source: '/admin/http_https_configuration', + destination: '/self-hosted/http-https-configuration', permanent: true }, { @@ -6383,6 +6388,672 @@ const redirectsData = [ source: '/admin/workers', destination: '/self-hosted/workers', permanent: true + }, + // Underscore to hyphen redirects (added for URL consistency) + { + source: '/admin/access_control', + destination: '/admin/access-control', + permanent: true + }, + { + source: '/admin/access_control/batch_changes', + destination: '/admin/access-control/batch-changes', + permanent: true + }, + { + source: '/admin/audit_log', + destination: '/admin/audit-log', + permanent: true + }, + { + source: '/admin/auth/login_form', + destination: '/admin/auth/login-form', + permanent: true + }, + { + source: '/admin/auth/saml/azure_ad', + destination: '/admin/auth/saml/azure-ad', + permanent: true + }, + { + source: '/admin/auth/saml/jump_cloud', + destination: '/admin/auth/saml/jump-cloud', + permanent: true + }, + { + source: '/admin/auth/saml/microsoft_adfs', + destination: '/admin/auth/saml/microsoft-adfs', + permanent: true + }, + { + source: '/admin/auth/saml/one_login', + destination: '/admin/auth/saml/one-login', + permanent: true + }, + { + source: '/admin/beta_and_experimental_features', + destination: '/admin/beta-and-experimental-features', + permanent: true + }, + { + source: '/admin/code_hosts', + destination: '/admin/code-hosts', + permanent: true + }, + { + source: '/admin/code_hosts/aws_codecommit', + destination: '/admin/code-hosts/aws-codecommit', + permanent: true + }, + { + source: '/admin/code_hosts/bitbucket_cloud', + destination: '/admin/code-hosts/bitbucket-cloud', + permanent: true + }, + { + source: '/admin/code_hosts/bitbucket_server', + destination: '/admin/code-hosts/bitbucket-server', + permanent: true + }, + { + source: '/admin/code_hosts/rate_limits', + destination: '/admin/code-hosts/rate-limits', + permanent: true + }, + { + source: '/admin/code_hosts/src_serve_git', + destination: '/admin/code-hosts/src-serve-git', + permanent: true + }, + { + source: '/admin/config/authorization_and_authentication', + destination: '/admin/config/authorization-and-authentication', + permanent: true + }, + { + source: '/admin/config/batch_changes', + destination: '/admin/config/batch-changes', + permanent: true + }, + { + source: '/admin/config/site_config', + destination: '/admin/config/site-config', + permanent: true + }, + { + source: '/admin/enterprise_getting_started_guide', + destination: '/admin/enterprise-getting-started-guide', + permanent: true + }, + { + source: '/admin/executors/executor_secrets', + destination: '/admin/executors/executor-secrets', + permanent: true + }, + { + source: '/admin/how-to/internal_github_repos', + destination: '/admin/how-to/internal-github-repos', + permanent: true + }, + { + source: '/admin/how-to/lsif_scip_migration', + destination: '/admin/how-to/lsif-scip-migration', + permanent: true + }, + { + source: '/admin/how-to/update_repo_failure', + destination: '/admin/how-to/update-repo-failure', + permanent: true + }, + { + source: '/admin/oauth_apps', + destination: '/admin/oauth-apps', + permanent: true + }, + { + source: '/admin/repo/git_config', + destination: '/admin/repo/git-config', + permanent: true + }, + { + source: '/admin/repo/pre_load_from_local_disk', + destination: '/admin/repo/pre-load-from-local-disk', + permanent: true + }, + { + source: '/admin/repo/update_frequency', + destination: '/admin/repo/update-frequency', + permanent: true + }, + { + source: '/admin/security_event_logs', + destination: '/admin/security-event-logs', + permanent: true + }, + { + source: '/admin/service_accounts', + destination: '/admin/service-accounts', + permanent: true + }, + { + source: '/admin/user_data_deletion', + destination: '/admin/user-data-deletion', + permanent: true + }, + { + source: '/admin/user_surveys', + destination: '/admin/user-surveys', + permanent: true + }, + { + source: '/api/stream_api', + destination: '/api/stream-api', + permanent: true + }, + { + source: '/cli/how-tos/creating_an_access_token', + destination: '/cli/how-tos/creating-an-access-token', + permanent: true + }, + { + source: '/cli/how-tos/fetch_sboms', + destination: '/cli/how-tos/fetch-sboms', + permanent: true + }, + { + source: '/cli/how-tos/managing_access_tokens', + destination: '/cli/how-tos/managing-access-tokens', + permanent: true + }, + { + source: '/cli/how-tos/revoking_an_access_token', + destination: '/cli/how-tos/revoking-an-access-token', + permanent: true + }, + { + source: '/cli/how-tos/verify_container_signatures', + destination: '/cli/how-tos/verify-container-signatures', + permanent: true + }, + { + source: '/cloud/logpush_gcs', + destination: '/cloud/logpush-gcs', + permanent: true + }, + { + source: '/cloud/logpush_s3', + destination: '/cloud/logpush-s3', + permanent: true + }, + { + source: '/cloud/private_connectivity_aws', + destination: '/cloud/private-connectivity-aws', + permanent: true + }, + { + source: '/cloud/private_connectivity_gcp', + destination: '/cloud/private-connectivity-gcp', + permanent: true + }, + { + source: '/cloud/private_connectivity_public_lb', + destination: '/cloud/private-connectivity-public-lb', + permanent: true + }, + { + source: '/cloud/private_connectivity_sourcegraph_connect', + destination: '/cloud/private-connectivity-sourcegraph-connect', + permanent: true + }, + { + source: '/code_insights', + destination: '/code-insights', + permanent: true + }, + { + source: '/code_insights/quickstart', + destination: '/code-insights/quickstart', + permanent: true + }, + { + source: '/code_insights/explanations', + destination: '/code-insights/explanations', + permanent: true + }, + { + source: '/code_insights/explanations/administration_and_security_of_code_insights', + destination: + '/code-insights/explanations/administration-and-security-of-code-insights', + permanent: true + }, + { + source: '/code_insights/explanations/automatically_generated_data_series', + destination: + '/code-insights/explanations/automatically-generated-data-series', + permanent: true + }, + { + source: '/code_insights/explanations/code_insights_filters', + destination: '/code-insights/explanations/code-insights-filters', + permanent: true + }, + { + source: '/code_insights/explanations/current_limitations_of_code_insights', + destination: + '/code-insights/explanations/current-limitations-of-code-insights', + permanent: true + }, + { + source: '/code_insights/explanations/data_retention', + destination: '/code-insights/explanations/data-retention', + permanent: true + }, + { + source: '/code_insights/explanations/search_results_aggregations', + destination: '/code-insights/explanations/search-results-aggregations', + permanent: true + }, + { + source: '/code_insights/explanations/viewing_code_insights', + destination: '/code-insights/explanations/viewing-code-insights', + permanent: true + }, + { + source: '/code_insights/how-tos', + destination: '/code-insights/how-tos', + permanent: true + }, + { + source: '/code_insights/how-tos/creating_a_custom_dashboard_of_code_insights', + destination: + '/code-insights/how-tos/creating-a-custom-dashboard-of-code-insights', + permanent: true + }, + { + source: '/code_insights/how-tos/filtering_an_insight', + destination: '/code-insights/how-tos/filtering-an-insight', + permanent: true + }, + { + source: '/code_insights/language_insight_quickstart', + destination: '/code-insights/language-insight-quickstart', + permanent: true + }, + { + source: '/code_insights/references', + destination: '/code-insights/references', + permanent: true + }, + { + source: '/code_insights/references/common_reasons_code_insights_may_not_match_search_results', + destination: + '/code-insights/references/common-reasons-code-insights-may-not-match-search-results', + permanent: true + }, + { + source: '/code_insights/references/common_use_cases', + destination: '/code-insights/references/common-use-cases', + permanent: true + }, + { + source: '/code_insights/references/incomplete_data_points', + destination: '/code-insights/references/incomplete-data-points', + permanent: true + }, + { + source: '/code_insights/references/repository_scope', + destination: '/code-insights/references/repository-scope', + permanent: true + }, + { + source: '/code_insights/references/search_aggregations_use_cases', + destination: '/code-insights/references/search-aggregations-use-cases', + permanent: true + }, + { + source: '/code_monitoring', + destination: '/code-monitoring', + permanent: true + }, + { + source: '/code-navigation/auto_indexing', + destination: '/code-navigation/auto-indexing', + permanent: true + }, + { + source: '/code-navigation/auto_indexing_configuration', + destination: '/code-navigation/auto-indexing-configuration', + permanent: true + }, + { + source: '/code-navigation/explanations/auto_indexing_inference', + destination: '/code-navigation/explanations/auto-indexing-inference', + permanent: true + }, + { + source: '/code-navigation/how-to/adding_scip_to_workflows', + destination: '/code-navigation/how-to/adding-scip-to-workflows', + permanent: true + }, + { + source: '/code-navigation/how-to/combining_scip_uploads_from_ci_cd_and_auto_indexing', + destination: + '/code-navigation/how-to/combining-scip-uploads-from-ci-cd-and-auto-indexing', + permanent: true + }, + { + source: '/code-navigation/how-to/index_a_go_repository', + destination: '/code-navigation/how-to/index-a-go-repository', + permanent: true + }, + { + source: '/code-navigation/how-to/index_a_typescript_and_javascript_repository', + destination: + '/code-navigation/how-to/index-a-typescript-and-javascript-repository', + permanent: true + }, + { + source: '/code-navigation/how-to/index_other_languages', + destination: '/code-navigation/how-to/index-other-languages', + permanent: true + }, + { + source: '/code-navigation/how-to/policies_resource_usage_best_practices', + destination: + '/code-navigation/how-to/policies-resource-usage-best-practices', + permanent: true + }, + { + source: '/code-navigation/inference_configuration', + destination: '/code-navigation/inference-configuration', + permanent: true + }, + { + source: '/code-navigation/precise_code_navigation', + destination: '/code-navigation/precise-code-navigation', + permanent: true + }, + { + source: '/code-navigation/search_based_code_navigation', + destination: '/code-navigation/search-based-code-navigation', + permanent: true + }, + { + source: '/code-navigation/syntactic_code_navigation', + destination: '/code-navigation/syntactic-code-navigation', + permanent: true + }, + { + source: '/code-navigation/writing_an_indexer', + destination: '/code-navigation/writing-an-indexer', + permanent: true + }, + { + source: '/code-search/how-to/create_search_context_graphql', + destination: '/code-search/how-to/create-search-context-graphql', + permanent: true + }, + { + source: '/code-search/working/saved_searches', + destination: '/code-search/working/saved-searches', + permanent: true + }, + { + source: '/code-search/working/search_contexts', + destination: '/code-search/working/search-contexts', + permanent: true + }, + { + source: '/code-search/working/search_filters', + destination: '/code-search/working/search-filters', + permanent: true + }, + { + source: '/code-search/working/search_subexpressions', + destination: '/code-search/working/search-subexpressions', + permanent: true + }, + { + source: '/dotcom/indexing_open_source_code', + destination: '/dotcom/indexing-open-source-code', + permanent: true + }, + { + source: '/integration/aws_codecommit', + destination: '/integration/aws-codecommit', + permanent: true + }, + { + source: '/integration/bitbucket_cloud', + destination: '/integration/bitbucket-cloud', + permanent: true + }, + { + source: '/integration/bitbucket_server', + destination: '/integration/bitbucket-server', + permanent: true + }, + { + source: '/integration/browser_extension', + destination: '/integration/browser-extension', + permanent: true + }, + { + source: '/integration/browser_extension/how-tos/browser_search_engine', + destination: + '/integration/browser-extension/how-tos/browser-search-engine', + permanent: true + }, + { + source: '/integration/browser_extension/how-tos/google_workspace', + destination: '/integration/browser-extension/how-tos/google-workspace', + permanent: true + }, + { + source: '/integration/migrating_firefox_extension', + destination: '/integration/migrating-firefox-extension', + permanent: true + }, + { + source: '/integration/open_in_editor', + destination: '/integration/open-in-editor', + permanent: true + }, + { + source: '/own/assigned_ownership', + destination: '/own/assigned-ownership', + permanent: true + }, + { + source: '/own/codeowners_format', + destination: '/own/codeowners-format', + permanent: true + }, + { + source: '/own/codeowners_ingestion', + destination: '/own/codeowners-ingestion', + permanent: true + }, + { + source: '/own/configuration_reference', + destination: '/own/configuration-reference', + permanent: true + }, + { + source: '/self-hosted/advanced_config_file', + destination: '/self-hosted/advanced-config-file', + permanent: true + }, + { + source: '/self-hosted/deploy/docker-compose/google_cloud', + destination: '/self-hosted/deploy/docker-compose/google-cloud', + permanent: true + }, + { + source: '/self-hosted/deploy/docker-single-container/google_cloud', + destination: '/self-hosted/deploy/docker-single-container/google-cloud', + permanent: true + }, + { + source: '/self-hosted/deploy/resource_estimator', + destination: '/self-hosted/deploy/resource-estimator', + permanent: true + }, + { + source: '/self-hosted/deploy/without_service_discovery', + destination: '/self-hosted/deploy/without-service-discovery', + permanent: true + }, + { + source: '/self-hosted/deployment_best_practices', + destination: '/self-hosted/deployment-best-practices', + permanent: true + }, + { + source: '/self-hosted/executors/deploy_executors', + destination: '/self-hosted/executors/deploy-executors', + permanent: true + }, + { + source: '/self-hosted/executors/deploy_executors_binary', + destination: '/self-hosted/executors/deploy-executors-binary', + permanent: true + }, + { + source: '/self-hosted/executors/deploy_executors_binary_offline', + destination: '/self-hosted/executors/deploy-executors-binary-offline', + permanent: true + }, + { + source: '/self-hosted/executors/deploy_executors_dind', + destination: '/self-hosted/executors/deploy-executors-dind', + permanent: true + }, + { + source: '/self-hosted/executors/deploy_executors_docker', + destination: '/self-hosted/executors/deploy-executors-docker', + permanent: true + }, + { + source: '/self-hosted/executors/deploy_executors_kubernetes', + destination: '/self-hosted/executors/deploy-executors-kubernetes', + permanent: true + }, + { + source: '/self-hosted/executors/deploy_executors_terraform', + destination: '/self-hosted/executors/deploy-executors-terraform', + permanent: true + }, + { + source: '/self-hosted/executors/executors_config', + destination: '/self-hosted/executors/executors-config', + permanent: true + }, + { + source: '/self-hosted/executors/executors_troubleshooting', + destination: '/self-hosted/executors/executors-troubleshooting', + permanent: true + }, + { + source: '/self-hosted/external_services', + destination: '/self-hosted/external-services', + permanent: true + }, + { + source: '/self-hosted/external_services/object_storage', + destination: '/self-hosted/external-services/object-storage', + permanent: true + }, + { + source: '/self-hosted/how-to/blobstore_debugging', + destination: '/self-hosted/how-to/blobstore-debugging', + permanent: true + }, + { + source: '/self-hosted/how-to/blobstore_update_notes', + destination: '/self-hosted/how-to/blobstore-update-notes', + permanent: true + }, + { + source: '/self-hosted/how-to/clear_codeintel_data', + destination: '/self-hosted/how-to/clear-codeintel-data', + permanent: true + }, + { + source: '/self-hosted/how-to/dirty_database', + destination: '/self-hosted/how-to/dirty-database', + permanent: true + }, + { + source: '/self-hosted/how-to/dirty_database_pre_3_37', + destination: '/self-hosted/how-to/dirty-database-pre-3-37', + permanent: true + }, + { + source: '/self-hosted/how-to/postgres_12_to_16_drift', + destination: '/self-hosted/how-to/postgres-12-to-16-drift', + permanent: true + }, + { + source: '/self-hosted/how-to/privileged_migrations', + destination: '/self-hosted/how-to/privileged-migrations', + permanent: true + }, + { + source: '/self-hosted/how-to/redis_configmap', + destination: '/self-hosted/how-to/redis-configmap', + permanent: true + }, + { + source: '/self-hosted/how-to/rollback_database', + destination: '/self-hosted/how-to/rollback-database', + permanent: true + }, + { + source: '/self-hosted/how-to/unfinished_migration', + destination: '/self-hosted/how-to/unfinished-migration', + permanent: true + }, + { + source: '/self-hosted/http_https_configuration', + destination: '/self-hosted/http-https-configuration', + permanent: true + }, + { + source: '/self-hosted/observability/alerting_custom_consumption', + destination: '/self-hosted/observability/alerting-custom-consumption', + permanent: true + }, + { + source: '/self-hosted/observability/health_checks', + destination: '/self-hosted/observability/health-checks', + permanent: true + }, + { + source: '/self-hosted/postgres12_end_of_life_notice', + destination: '/self-hosted/postgres12-end-of-life-notice', + permanent: true + }, + { + source: '/self-hosted/postgresql_collation_version_mismatch_resolution', + destination: + '/self-hosted/postgresql-collation-version-mismatch-resolution', + permanent: true + }, + { + source: '/self-hosted/ssl_https_self_signed_cert_nginx', + destination: '/self-hosted/ssl-https-self-signed-cert-nginx', + permanent: true + }, + { + source: '/self-hosted/updates/docker_compose', + destination: '/self-hosted/updates/docker-compose', + permanent: true + }, + { + source: '/self-hosted/updates/pure_docker', + destination: '/self-hosted/updates/pure-docker', + permanent: true } ]; From 7d3d3f9832cc15545fc5acc8ca4cce64e4a6f5d9 Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 23:12:21 +0100 Subject: [PATCH 15/21] Consolidate multiple link collection pages, and drop the Enterprise Getting Started page --- docs/admin/config/index.mdx | 24 ----------- docs/admin/config/site-config.mdx | 29 +++---------- .../enterprise-getting-started-guide.mdx | 36 ---------------- docs/admin/index.mdx | 42 ++++++++++++++++--- docs/cloud/index.mdx | 4 +- .../how-to/create-search-context-graphql.mdx | 2 +- .../browser-extension/quickstart.mdx | 4 +- .../deploy/docker-compose/configuration.mdx | 2 +- .../deploy/docker-single-container/index.mdx | 2 +- docs/self-hosted/deploy/kubernetes/index.mdx | 13 +++--- docs/self-hosted/index.mdx | 20 +++------ src/data/navigation.ts | 4 -- src/data/redirects.ts | 10 +++++ 13 files changed, 70 insertions(+), 122 deletions(-) delete mode 100644 docs/admin/config/index.mdx delete mode 100644 docs/admin/enterprise-getting-started-guide.mdx diff --git a/docs/admin/config/index.mdx b/docs/admin/config/index.mdx deleted file mode 100644 index 3d3720977..000000000 --- a/docs/admin/config/index.mdx +++ /dev/null @@ -1,24 +0,0 @@ -# Configuring Sourcegraph - - - Supported on [Enterprise](/pricing/plans/enterprise) plans. - - -- [Site configuration](/admin/config/site-config) -- [Global and user settings](/admin/config/settings) -- [Code host configuration](/admin/code-hosts/) -- [Search configuration](/admin/search) -- [Configuring Authorization and Authentication](/admin/config/authorization-and-authentication) -- [Batch Changes configuration](/admin/config/batch-changes) - -## Common tasks - -- [Add Git repositories from your code host](/admin/repo/add) -- [Add user authentication providers (SSO)](/admin/auth/) -- [Configure search scopes](/code-search/working/snippets) -- [Integrate with Phabricator](/integration/phabricator) -- [Add organizations](/admin/organizations) -- [Add teams](/admin/teams) (Experimental) -- [Configuring webhooks](/admin/webhooks/) -- [Configuring rate limits](/admin/code-hosts/rate-limits) -- [Configuring command recording](/admin/repo/recording) diff --git a/docs/admin/config/site-config.mdx b/docs/admin/config/site-config.mdx index 2dcde8570..896ef8448 100644 --- a/docs/admin/config/site-config.mdx +++ b/docs/admin/config/site-config.mdx @@ -4,7 +4,7 @@ Site configuration defines how various Sourcegraph features behave. See the [ful ## Configuration overview -[Go here](/admin/config/) for an overview of configuring Sourcegraph. +[Go here](/admin/) for an overview of configuring Sourcegraph. ## View and edit site configuration @@ -22,9 +22,9 @@ All site configuration options and their default values are shown below. {/* SCHEMA_SYNC_START: admin/config/site.schema.json */} {/* WARNING: This section is auto-generated during releases. Do not edit manually. */} {/* Last updated: 2025-12-08T20:10:31Z via sourcegraph/sourcegraph@v6.11.0 */} + ```json { - ////////////////////////////////////////////////////////////// // General Configuration ////////////////////////////////////////////////////////////// @@ -658,7 +658,6 @@ All site configuration options and their default values are shown below. "retention": "72h" }, - ////////////////////////////////////////////////////////////// // Authentication & Authorization ////////////////////////////////////////////////////////////// @@ -705,13 +704,7 @@ All site configuration options and their default values are shown below. "allow": "all-users-create", "allowNoExpiration": false, "defaultExpirationDays": 90, - "expirationOptionDays": [ - 7, - 14, - 30, - 60, - 90 - ] + "expirationOptionDays": [7, 14, 30, 60, 90] }, // IP allowlist for access to the Sourcegraph instance. If set, only requests from these IP addresses will be allowed. By default client IP is infered connected client IP address, and you may configure to use a request header to determine the user IP. @@ -803,7 +796,6 @@ All site configuration options and their default values are shown below. // When true, site admins will only be able to see private code they have access to via our authz system. "authz.enforceForSiteAdmins": false, - ////////////////////////////////////////////////////////////// // Security & Encryption ////////////////////////////////////////////////////////////// @@ -835,7 +827,6 @@ All site configuration options and their default values are shown below. "webhookLogKey": null }, - ////////////////////////////////////////////////////////////// // AI & Completions ////////////////////////////////////////////////////////////// @@ -872,7 +863,6 @@ All site configuration options and their default values are shown below. "user": null }, - ////////////////////////////////////////////////////////////// // Executors ////////////////////////////////////////////////////////////// @@ -922,7 +912,6 @@ All site configuration options and their default values are shown below. // - "4.1.0" "executors.srcCLIImageTag": null, - ////////////////////////////////////////////////////////////// // Git & Repository Management ////////////////////////////////////////////////////////////// @@ -986,13 +975,7 @@ All site configuration options and their default values are shown below. // "size": 1000 // } "gitRecorder": { - "ignoredGitCommands": [ - "show", - "rev-parse", - "log", - "diff", - "ls-tree" - ], + "ignoredGitCommands": ["show", "rev-parse", "log", "diff", "ls-tree"], "repos": null, "size": 10000 }, @@ -1015,7 +998,6 @@ All site configuration options and their default values are shown below. // Disk usage threshold at which to display warning notification. Value is a percentage. "gitserver.diskUsageWarningThreshold": 90, - ////////////////////////////////////////////////////////////// // Branding & UI ////////////////////////////////////////////////////////////// @@ -1042,7 +1024,6 @@ All site configuration options and their default values are shown below. "light": null }, - ////////////////////////////////////////////////////////////// // Observability & Monitoring ////////////////////////////////////////////////////////////// @@ -1150,9 +1131,9 @@ All site configuration options and their default values are shown below. "type": "opentelemetry", "urlTemplate": null } - } ``` + {/* SCHEMA_SYNC_END: admin/config/site.schema.json */} #### Known bugs diff --git a/docs/admin/enterprise-getting-started-guide.mdx b/docs/admin/enterprise-getting-started-guide.mdx deleted file mode 100644 index a25a2e4a1..000000000 --- a/docs/admin/enterprise-getting-started-guide.mdx +++ /dev/null @@ -1,36 +0,0 @@ -# Resources for Sourcegraph Enterprise Instance - -If you're deploying a new Enterprise instance, this page covers our most frequently referenced pieces of documentation. Admins will be interested in the documentation for their specific deployment method; users will want to check out info on our search syntax, operators, batch changes, and browser extension. - -## Admin articles - -### General - -- [Deployment overview](/self-hosted/deploy/) -- [Resource estimator](/self-hosted/deploy/resource-estimator) -- [SAML config](/admin/auth/saml/) -- [Configuring authorization and authentication](/admin/config/authorization-and-authentication) - We recommend starting here for access and permissions configuration before moving on to the more specific pages on these topics. -- [Built-in password authentication](/admin/auth/#builtin-password-authentication) -- [GitHub authentication](/admin/auth/#github) -- [GitLab authentication](/admin/auth/#gitlab) -- [OpenID connect](/admin/auth/#openid-connect) -- [HTTP authentication proxy](/admin/auth/#http-authentication-proxies) -- [GitLab integration](/integration/gitlab) -- [GitHub integration](/integration/github) -- [All code host integrations (not GitLab or GitHub)](/integration/#integrations) -- [Full guide to site config options](/admin/config/site-config#auth-sessionExpiry) -- [Changelog](https://sourcegraph.com/changelog) to track releases and updates - -### Docker-compose - -- [Basic installation guide](/self-hosted/deploy/docker-compose/) -- [AWS installation](/self-hosted/deploy/docker-compose/aws) -- [Digital Ocean installation](/self-hosted/deploy/docker-compose/digitalocean) -- [Google Cloud installation](/self-hosted/deploy/docker-compose/google-cloud) - -## User articles - -- [Search syntax](/code-search/queries) -- [Search filters](/code-search/queries#filters-all-searches) -- [Example batch changes](/batch-changes/examples) -- [Sourcegraph browser extension](/integration/browser-extension) diff --git a/docs/admin/index.mdx b/docs/admin/index.mdx index e2d3fe247..53f981444 100644 --- a/docs/admin/index.mdx +++ b/docs/admin/index.mdx @@ -15,21 +15,51 @@ Sourcegraph administration is primarily managed by site administrators, who are - [Telemetry](/admin/telemetry) - [Enterprise pricing and licenses](/admin/subscriptions/) - [Search](/admin/search) +- [Search syntax](/code-search/queries) +- [Search filters](/code-search/queries#filters-all-searches) +- [Sourcegraph browser extension](/integration/browser-extension) - [User feedback surveys](/admin/user-surveys) - [Analytics](/analytics) - [Audit logs](/admin/audit-log) -## [Configure Sourcegraph](/admin/config/) +## Configure Sourcegraph - [Site Administrator Quickstart](/admin/how-to/site-admin-quickstart) -- [Integrations](/integration/) -- [Add Git repositories](/admin/repo/add) (from a code host or clone URL) - - [Monorepo](/admin/monorepo) - - [Repository webhooks](/admin/repo/webhooks) +- [Site configuration](/admin/config/site-config) +- [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) + - [GitHub authentication](/admin/auth/#github) + - [GitLab authentication](/admin/auth/#gitlab) + - [OpenID connect](/admin/auth/#openid-connect) + - [HTTP authentication proxy](/admin/auth/#http-authentication-proxies) + - [SAML config](/admin/auth/saml/) - [User data deletion](/admin/user-data-deletion) - [Provision users through SCIM](/admin/scim) (Beta) -- [Access control](/admin/access-control/) (Beta) +- [Code host configuration](/admin/code-hosts/) +- [Add Git repositories](/admin/repo/add) (from a code host or clone URL) + - [Monorepo](/admin/monorepo) + - [Repository webhooks](/admin/repo/webhooks) - [Repository permissions](/admin/permissions/) +- [Search configuration](/admin/search) +- [Batch Changes configuration](/admin/config/batch-changes) - [Batch Changes](/batch-changes/site-admin-configuration) +- [Integrations](/integration/) + - [GitLab integration](/integration/gitlab) + - [GitHub integration](/integration/github) + - [All code host integrations (not GitLab or GitHub)](/integration/#integrations) +- [Access control](/admin/access-control/) (Beta) + +## Additional resources + +- [Migrate to Sourcegraph](/admin/migration/) +- [Full guide to site config options](/admin/config/site-config#auth-sessionExpiry) +- [Changelog](https://sourcegraph.com/changelog) to track releases and updates - [Configure webhooks](/admin/webhooks/) +- [Configure search scopes](/code-search/working/snippets) +- [Integrate with Phabricator](/integration/phabricator) +- [Add organizations](/admin/organizations) +- [Add teams](/admin/teams) (Experimental) +- [Configuring rate limits](/admin/code-hosts/rate-limits) +- [Configuring command recording](/admin/repo/recording) diff --git a/docs/cloud/index.mdx b/docs/cloud/index.mdx index b18b3c999..2ec3377bd 100644 --- a/docs/cloud/index.mdx +++ b/docs/cloud/index.mdx @@ -32,7 +32,7 @@ As part of this service you will receive a number of benefits from our team, inc - Direct assistance in: - [Adding repositories from all of your code hosts to Sourcegraph](/admin/code-hosts/) - [Integrating your single sign-on provider with Sourcegraph](/admin/auth/) - - [Configuring Sourcegraph](/admin/config/) + - [Configuring Sourcegraph](/admin/) ### Access to all Sourcegraph features @@ -195,7 +195,7 @@ Supported destinations: - The Sourcegraph instance can only be accessible via a public IP. Running it in a private network and pairing it with your private network via site-to-site VPN or VPC Peering is not yet supported. - Code hosts or user authentication providers running in a private network are not yet supported. They have to be publicly available or they must allow incoming traffic from Sourcegraph-owned static IP addresses. We do not have proper support for other connectivity methods, e.g. site-to-site VPN, VPC peering, tunneling. - Instances currently run only on Google Cloud Platform in the [chosen regions](#multiple-region-availability). Other regions and cloud providers (such as AWS or Azure) are not yet supported. -- Some [configuration options](/admin/config/) are managed by Sourcegraph and cannot be overridden by customers, e.g. feature flags, experimental features, and auto-indexing policy. Please reach out to your account team if you would like to make changes to these settings. +- Some [configuration options](/admin/) are managed by Sourcegraph and cannot be overridden by customers, e.g. feature flags, experimental features, and auto-indexing policy. Please reach out to your account team if you would like to make changes to these settings. ## Security diff --git a/docs/code-search/how-to/create-search-context-graphql.mdx b/docs/code-search/how-to/create-search-context-graphql.mdx index 606c2d1ac..1cb153cb2 100644 --- a/docs/code-search/how-to/create-search-context-graphql.mdx +++ b/docs/code-search/how-to/create-search-context-graphql.mdx @@ -109,4 +109,4 @@ Step 9: Go to the main search page and you should see the new Search context as ## Further resources - [Using and creating search contexts](/code-search/working/search-contexts) -- [Sourcegraph - Administration Config](/admin/config) +- [Sourcegraph - Administration Config](/admin) diff --git a/docs/integration/browser-extension/quickstart.mdx b/docs/integration/browser-extension/quickstart.mdx index f02ff256a..f679f61d0 100644 --- a/docs/integration/browser-extension/quickstart.mdx +++ b/docs/integration/browser-extension/quickstart.mdx @@ -27,11 +27,11 @@ Use one of the following links to install the Sourcegraph Browser Extension for By default, the browser extension communicates with [sourcegraph.com](https://sourcegraph.com), which has only public code. -To use the browser extension with your private repositories, you need to set up a private Sourcegraph instance and connect the extension to it. +To use the browser extension with your private repositories, you need to have access to a private Sourcegraph instance and connect the extension to it. Follow these instructions: -1. [Install Sourcegraph](/self-hosted/deploy/). Skip this step if you already have a private Sourcegraph instance. +1. [Set up Sourcegraph](/code-search#getting-started). Skip this step if you already have a private Sourcegraph instance. 2. Click the Sourcegraph extension icon in the browser toolbar on the browser tab for your private Sourcegraph instance then open the settings page. 3. Enter the URL (including the protocol) of your Sourcegraph instance (such as `https://sourcegraph.example.com`) 4. Make sure the connection status shows "Looks good!" diff --git a/docs/self-hosted/deploy/docker-compose/configuration.mdx b/docs/self-hosted/deploy/docker-compose/configuration.mdx index f5fab4958..c1602205d 100644 --- a/docs/self-hosted/deploy/docker-compose/configuration.mdx +++ b/docs/self-hosted/deploy/docker-compose/configuration.mdx @@ -4,7 +4,7 @@ You can find the default base [docker-compose.yaml](https://github.com/sourcegraph/deploy-sourcegraph-docker/blob/master/docker-compose/docker-compose.yaml) file inside the [deploy-sourcegraph-docker](https://github.com/sourcegraph/deploy-sourcegraph-docker/blob/master/docker-compose) repository. We strongly recommend using an override file, instead of modifying the base docker-compose.yaml file. -To configure your Sourcegraph instance, see Sourcegraph's [configuration](/admin/config/) docs. +To configure your Sourcegraph instance, see Sourcegraph's [configuration](/admin/) docs. ## What is an override file? diff --git a/docs/self-hosted/deploy/docker-single-container/index.mdx b/docs/self-hosted/deploy/docker-single-container/index.mdx index 772dd19ab..fdfd486b9 100644 --- a/docs/self-hosted/deploy/docker-single-container/index.mdx +++ b/docs/self-hosted/deploy/docker-single-container/index.mdx @@ -23,7 +23,7 @@ sourcegraph/server:{CURRENT_VERSION_NO_V} Once the server is ready (logo is displayed in the terminal), navigate to the hostname or IP address on port `7080`. Create the admin account, then you'll be guided through setting up Sourcegraph for code searching and navigation. -For next steps and further configuration options, review the high-level configuration items below, or visit the [detailed configuration documentation](/admin/config/). +For next steps and further configuration options, review the high-level configuration items below, or visit the [detailed configuration documentation](/admin/). > WARNING: **We do not recommend using this method for a production instance.** If deploying a production instance, see [our recommendations](/self-hosted/deploy/) for how to choose a deployment type that suits your needs. We recommend [Docker Compose](/self-hosted/deploy/docker-compose/) for most initial production deployments. diff --git a/docs/self-hosted/deploy/kubernetes/index.mdx b/docs/self-hosted/deploy/kubernetes/index.mdx index 4189e8551..fca9e2fd3 100644 --- a/docs/self-hosted/deploy/kubernetes/index.mdx +++ b/docs/self-hosted/deploy/kubernetes/index.mdx @@ -71,7 +71,7 @@ $ helm install --version {CURRENT_VERSION_NO_V} sourcegraph sourcegraph/sourcegr Sourcegraph should now be available via the address set. Browsing to the url should now provide access to the Sourcegraph UI to create the initial administrator account. More information on configuring the Sourcegraph application can be found here: -[Configuring Sourcegraph](/admin/config/) +[Configuring Sourcegraph](/admin/) ## Configuration @@ -252,7 +252,8 @@ To use an external Object Storage service (S3-compatible services, or GCS), firs [override.yaml](https://github.com/sourcegraph/deploy-sourcegraph-helm/tree/main/charts/sourcegraph/examples/external-object-storage/override.yaml) for an example override file. The example assumes the use of AWS S3. You may configure the environment variables accordingly for your own use case based - on our [general recommendations](/self-hosted/external-services/object-storage). + on our [general + recommendations](/self-hosted/external-services/object-storage). If you provide credentials with an access key / secret key, we recommend storing the credentials in [Secrets] created outside the helm chart and managed in a secure manner. An example Secret is shown here: @@ -632,7 +633,7 @@ Browsing to the url should now provide access to the Sourcegraph UI to create th **Step 6** – Further configuration Now the deployment is complete. More information on configuring the Sourcegraph application can be found here: -[Configuring Sourcegraph](/admin/config/) +[Configuring Sourcegraph](/admin/) ### Configure Sourcegraph on Elastic Kubernetes Service (EKS) @@ -727,7 +728,7 @@ Browsing to the url should now provide access to the Sourcegraph UI to create th **Step 5:** – Further configuration Now the deployment is complete. More information on configuring the Sourcegraph application can be found here: -[Configuring Sourcegraph](/admin/config/) +[Configuring Sourcegraph](/admin/) #### References @@ -823,7 +824,7 @@ Browsing to the url should now provide access to the Sourcegraph UI to create th **Step 5:** – Further configuration Now the deployment is complete. More information on configuring the Sourcegraph application can be found here: -[Configuring Sourcegraph](/admin/config/) +[Configuring Sourcegraph](/admin/) #### References @@ -960,7 +961,7 @@ Browsing to the url should now provide access to the Sourcegraph UI to create th **Step 5:** – Further configuration Now the deployment is complete. More information on configuring the Sourcegraph application can be found here: -[Configuring Sourcegraph](/admin/config/) +[Configuring Sourcegraph](/admin/) ## Upgrading Sourcegraph diff --git a/docs/self-hosted/index.mdx b/docs/self-hosted/index.mdx index a098bc00b..835d28cae 100644 --- a/docs/self-hosted/index.mdx +++ b/docs/self-hosted/index.mdx @@ -15,6 +15,9 @@ Get started running Sourcegraph on-prem. - [Deployment overview](/self-hosted/deploy/) - [Single-node deployment](/self-hosted/deploy/single-node/) - [Docker Compose](/self-hosted/deploy/docker-compose/) + - [AWS installation](/self-hosted/deploy/docker-compose/aws) + - [Digital Ocean installation](/self-hosted/deploy/docker-compose/digitalocean) + - [Google Cloud installation](/self-hosted/deploy/docker-compose/google-cloud) - [Kubernetes](/self-hosted/deploy/kubernetes/) - [Machine images](/self-hosted/deploy/machine-images/) - [Docker single container](/self-hosted/deploy/docker-single-container/) @@ -33,27 +36,15 @@ Get started running Sourcegraph on-prem. - [Pure Docker upgrades](/self-hosted/updates/pure-docker) - [Server upgrades](/self-hosted/updates/server) - [Migrator](/self-hosted/updates/migrator/) -- [Migrate to Sourcegraph](/admin/migration/) - [Upgrading PostgreSQL](/self-hosted/postgres#upgrading-postgresql) -## [Configure Sourcegraph](/admin/config) +## Configure Sourcegraph -- [Site Administrator Quickstart](/admin/how-to/site-admin-quickstart) -- [Integrations](/integration/) -- [Add Git repositories](/admin/repo/add) (from a code host or clone URL) - - [Monorepo](/admin/monorepo) - - [Repository webhooks](/admin/repo/webhooks) +- For general admin tasks, see [Sourcegraph Admin](/admin) - [HTTP and HTTPS/SSL configuration](/self-hosted/http-https-configuration) - [Adding SSL (HTTPS) to Sourcegraph with a self-signed certificate](/self-hosted/ssl-https-self-signed-cert-nginx) -- [User authentication](/admin/auth/) - - [User data deletion](/admin/user-data-deletion) -- [Provision users through SCIM](/admin/scim) (Beta) -- [Access control](/admin/access-control/) (Beta) - [Setting the URL for your instance](/self-hosted/url) - [Configure email sending / SMTP server](/self-hosted/email) -- [Repository permissions](/admin/permissions/) -- [Batch Changes](/batch-changes/site-admin-configuration) -- [Configure webhooks](/admin/webhooks/) - [Scaling workers](/self-hosted/workers) - [PostgreSQL configuration](/self-hosted/postgres-conf) @@ -100,7 +91,6 @@ Get started running Sourcegraph on-prem. - [Alerts reference](/self-hosted/observability/alerts) - [Tracing](/self-hosted/observability/tracing) - [Logs](/self-hosted/observability/logs) -- [Outbound request log](/admin/outbound-request-log) - [OpenTelemetry](/self-hosted/observability/opentelemetry) - [Health checks](/self-hosted/observability/health-checks) - [Troubleshooting guide](/self-hosted/observability/troubleshooting) diff --git a/src/data/navigation.ts b/src/data/navigation.ts index 79c9841b8..7c61d32ff 100644 --- a/src/data/navigation.ts +++ b/src/data/navigation.ts @@ -459,10 +459,6 @@ export const navigation: NavigationItem[] = [ {title: 'Executors', href: '/admin/executors'}, {title: 'FAQs', href: '/admin/faq'}, {title: 'How-to Guides', href: '/admin/how-to'}, - { - title: 'Enterprise Getting Started', - href: '/admin/enterprise-getting-started-guide' - }, {title: 'Architecture', href: '/admin/architecture'} ] }, diff --git a/src/data/redirects.ts b/src/data/redirects.ts index 86554ba60..0e7290c78 100644 --- a/src/data/redirects.ts +++ b/src/data/redirects.ts @@ -7054,6 +7054,16 @@ const redirectsData = [ source: '/self-hosted/updates/pure_docker', destination: '/self-hosted/updates/pure-docker', permanent: true + }, + { + source: '/admin/enterprise-getting-started-guide', + destination: '/admin', + permanent: true + }, + { + source: '/admin/config', + destination: '/admin', + permanent: true } ]; From ace4c9abac3b3b219da5af506a6751522ec6b047 Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 23:15:01 +0100 Subject: [PATCH 16/21] Update system dependencies --- .tool-versions | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.tool-versions b/.tool-versions index fcfaa7659..a5252f7be 100644 --- a/.tool-versions +++ b/.tool-versions @@ -1,2 +1,2 @@ -nodejs 20.8.1 -pnpm 8.13.1 +nodejs 24.12.0 +pnpm 10.25.0 From bad960ad4b268508b6dfa65fc374d1112677560e Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 23:17:37 +0100 Subject: [PATCH 17/21] Cleanup README a bit --- README.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 697821a6f..4078500b5 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,5 @@ - - # Sourcegraph Docs - - > [!IMPORTANT] > For support, please reach out to your account team or contact [support@sourcegraph.com](mailto:support@sourcegraph.com) @@ -25,8 +21,8 @@ cd docs Before the dependencies are installed make sure your local machine has the following versions of `node` and `pnpm` installed: -- node: `v20.8.1` -- pnpm: `8.13.1` +- node: `v24.12.0` +- pnpm: `10.25.0` **Note**: If you have `mise` available you can install the above versions for only this repository by running the following command from your terminal in the root folder: @@ -74,7 +70,7 @@ git switch -c BRANCH_NAME_HERE ### Folder structure -The folder structure is exactly the same here. All the docs reside within the `/docs` folder. Here you'll find separate folders for every docs section like `cody`, `code_search`, `cli`, etc. +The folder structure is exactly the same here. All the docs reside within the `/docs` folder. Here you'll find separate folders for every docs section like `cody`, `code-search`, `cli`, etc. - Navigate to the relevant relevant section for your contribution - If you're adding a new page, create a new MDX file (e.g., `my-new-page.mdx`) in the appropriate folder @@ -113,7 +109,7 @@ For example the cards layout appears by using the `` component that can You can use this component within your content as follows: ```js -Cody is currently in Beta for all users. +This feature is currently in Beta for all users. ``` This snippet creates a single `` titled as "Get Cody". You can add as many cards you want while filling out all the relevant details. @@ -164,7 +160,6 @@ When you open a PR Vercel deploys and provides you with a preview deployment lin Once you're satisfied with your changes, follow these steps: - Commit your changes -- Create a pull request to the [Sourcegraph documentation repository](https://github.com/sourcegraph/docs). -- Tag `@maedahbatool` in `#docs` channel through Slack to get a quick review +- Create a pull request to the [Sourcegraph documentation repository](https://github.com/sourcegraph/docs), and tag the appropriate reviewers. Thank you for contributing to Sourcegraph documentation! Your efforts help us provide top-notch learning experiences for our users. If you have any questions or need assistance, feel free to reach out. From b36d563804dc4975e1c3f539293f63ed61096c47 Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 23:22:22 +0100 Subject: [PATCH 18/21] Add some extra validations to the next build process Verify no dead links and no underscores are used in URLs. --- dev/check-filenames.mjs | 55 ++++++++ dev/check-links.mjs | 290 ++++++++++++++++++++++++++++++++++++++++ next.config.js | 3 + package.json | 2 + 4 files changed, 350 insertions(+) create mode 100644 dev/check-filenames.mjs create mode 100644 dev/check-links.mjs diff --git a/dev/check-filenames.mjs b/dev/check-filenames.mjs new file mode 100644 index 000000000..6e3e96400 --- /dev/null +++ b/dev/check-filenames.mjs @@ -0,0 +1,55 @@ +#!/usr/bin/env node + +/** + * Filename convention checker for documentation files. + * + * Ensures no underscores are used in folder or file names, + * as URLs should only use hyphens. + * + * Usage: node dev/check-filenames.mjs + */ + +import path from 'path'; +import { glob } from 'glob'; +import { fileURLToPath } from 'url'; + +const __filename = fileURLToPath(import.meta.url); +const __dirname = path.dirname(__filename); + +const DOCS_DIR = path.join(path.dirname(__dirname), 'docs'); + +async function main() { + console.log('🔍 Checking for underscores in docs filenames...\n'); + + const files = await glob('**/*', { cwd: DOCS_DIR }); + const errors = []; + + for (const file of files) { + const parts = file.split('/'); + for (const part of parts) { + if (part.includes('_')) { + errors.push(file); + break; + } + } + } + + if (errors.length === 0) { + console.log('✅ No underscores found in filenames!'); + process.exit(0); + } + + console.log(`❌ Found ${errors.length} path(s) with underscores:\n`); + + for (const file of errors) { + console.log(` docs/${file}`); + } + + console.log('\n Please use hyphens (-) instead of underscores (_) in file and folder names.\n'); + process.exit(1); +} + +main().catch(err => { + console.error('Error running filename checker:', err); + process.exit(1); +}); diff --git a/dev/check-links.mjs b/dev/check-links.mjs new file mode 100644 index 000000000..2a8b24093 --- /dev/null +++ b/dev/check-links.mjs @@ -0,0 +1,290 @@ +#!/usr/bin/env node + +/** + * Dead link checker for MDX documentation files. + * Transparency note; This is AI generated, if it doesn't detect things correctly + * please blame this script, and use AI to improve its detection. It's proven massively + * helpful during larger docs refactors so far. + * + * Checks for: + * - Broken internal links (markdown and JSX/HTML style) + * - Missing anchor/heading references + * - Invalid file paths + * + * Usage: node dev/check-links.mjs [--check-anchors] + */ + +import fs from 'fs'; +import path from 'path'; +import { glob } from 'glob'; +import GithubSlugger from 'github-slugger'; +import { fileURLToPath } from 'url'; + +const __filename = fileURLToPath(import.meta.url); +const __dirname = path.dirname(__filename); + +const DOCS_DIR = path.join(path.dirname(__dirname), 'docs'); + +// Parse CLI flags +const args = process.argv.slice(2); +const CHECK_ANCHORS = args.includes('--check-anchors'); + +// Regex patterns for extracting links +const MARKDOWN_LINK_REGEX = /\[([^\]]*)\]\(([^)]+)\)/g; +const JSX_HREF_REGEX = /href=["']([^"']+)["']/g; +const SRC_ATTR_REGEX = /src=["']([^"']+)["']/g; + +// Extract headings from MDX content to build anchor map +function extractHeadings(content) { + const slugger = new GithubSlugger(); + const headingRegex = /^#{1,6}\s+(.+)$/gm; + const headings = new Set(); + + // Remove code blocks to avoid false positives + const contentWithoutCode = content.replace(/```[\s\S]*?```/g, ''); + + let match; + while ((match = headingRegex.exec(contentWithoutCode)) !== null) { + // Handle headings with links: [Text](/path) -> Text + const linkMatch = match[1].match(/\[([^\]]+)\]\([^)]+\)/); + const title = linkMatch ? linkMatch[1] : match[1]; + headings.add(slugger.slug(title.trim())); + } + + return headings; +} + +// Get all MDX files and build a map of valid paths +async function buildPathMap() { + const files = await glob('**/*.mdx', { cwd: DOCS_DIR }); + const pathMap = new Map(); + const headingsMap = new Map(); + + for (const file of files) { + const fullPath = path.join(DOCS_DIR, file); + const content = fs.readFileSync(fullPath, 'utf-8'); + + // Route path (without .mdx extension) + const routePath = '/' + file.replace(/\.mdx$/, '').replace(/\/index$/, ''); + + // Also allow trailing slash variant + pathMap.set(routePath, fullPath); + pathMap.set(routePath + '/', fullPath); + + // Handle index files + if (file.endsWith('index.mdx')) { + const dirPath = '/' + file.replace(/\/index\.mdx$/, ''); + pathMap.set(dirPath, fullPath); + pathMap.set(dirPath + '/', fullPath); + } + + // Extract headings for anchor validation + const headings = extractHeadings(content); + headingsMap.set(routePath, headings); + headingsMap.set(routePath + '/', headings); + } + + return { pathMap, headingsMap }; +} + +// Check if a path exists in public directory +function checkPublicPath(linkPath) { + const publicPath = path.join(path.dirname(__dirname), 'public', linkPath); + return fs.existsSync(publicPath); +} + +// Check if a path exists in docs directory (for images in docs/) +function checkDocsPath(linkPath) { + const docsPath = path.join(DOCS_DIR, linkPath); + return fs.existsSync(docsPath); +} + +// Parse and validate links in a single file +function extractLinks(content, filePath) { + const links = []; + + // Remove code blocks to avoid checking links in code examples + const contentWithoutCode = content.replace(/```[\s\S]*?```/g, (match) => { + // Replace with same number of newlines to preserve line numbers + return match.replace(/[^\n]/g, ' '); + }); + + // Extract markdown links [text](url) + let match; + while ((match = MARKDOWN_LINK_REGEX.exec(contentWithoutCode)) !== null) { + const url = match[2].trim(); + const lineNumber = contentWithoutCode.substring(0, match.index).split('\n').length; + links.push({ url, lineNumber, type: 'markdown' }); + } + + // Reset lastIndex for href regex + JSX_HREF_REGEX.lastIndex = 0; + while ((match = JSX_HREF_REGEX.exec(contentWithoutCode)) !== null) { + const url = match[1].trim(); + const lineNumber = contentWithoutCode.substring(0, match.index).split('\n').length; + links.push({ url, lineNumber, type: 'href' }); + } + + // Reset lastIndex for src regex + SRC_ATTR_REGEX.lastIndex = 0; + while ((match = SRC_ATTR_REGEX.exec(contentWithoutCode)) !== null) { + const url = match[1].trim(); + const lineNumber = contentWithoutCode.substring(0, match.index).split('\n').length; + links.push({ url, lineNumber, type: 'src' }); + } + + return links; +} + +// Check if a link is valid +function validateLink(link, currentFile, pathMap, headingsMap) { + const { url } = link; + + // Skip external links, mailto, tel, javascript, etc. + if (url.startsWith('http://') || url.startsWith('https://') || + url.startsWith('mailto:') || url.startsWith('tel:') || + url.startsWith('javascript:') || url.startsWith('data:') || + url.startsWith('command:')) { + return null; + } + + // Skip angle-bracket URLs like + if (url.startsWith(' 0) { + errors.push({ + file: `docs/${file}`, + errors: fileErrors + }); + totalErrors += fileErrors.length; + } + } + + // Output results + if (errors.length === 0) { + console.log('✅ No dead links found!'); + process.exit(0); + } + + console.log(`❌ Found ${totalErrors} dead link(s) in ${errors.length} file(s):\n`); + + for (const { file, errors: fileErrors } of errors) { + console.log(`\n📄 ${file}`); + for (const { line, url, error } of fileErrors) { + console.log(` Line ${line}: ${url}`); + console.log(` └─ ${error}`); + } + } + + console.log('\n'); + process.exit(1); +} + +main().catch(err => { + console.error('Error running link checker:', err); + process.exit(1); +}); diff --git a/next.config.js b/next.config.js index b0b4aa4d9..2c19cf53c 100644 --- a/next.config.js +++ b/next.config.js @@ -1,5 +1,6 @@ const {withContentlayer} = require('next-contentlayer'); const {generateRssFeed} = require('./dev/rss'); +const {execSync} = require('child_process'); /** @type {import('next').NextConfig} */ const nextConfig = { @@ -20,6 +21,8 @@ const nextConfig = { module.exports = async () => { // placing this here so its part of nextjs's build process + execSync('node dev/check-links.mjs', {stdio: 'inherit'}); + execSync('node dev/check-filenames.mjs', {stdio: 'inherit'}); await generateRssFeed(); return withContentlayer(nextConfig); }; diff --git a/package.json b/package.json index 1ff5873f2..cac00d290 100644 --- a/package.json +++ b/package.json @@ -7,6 +7,8 @@ "build": "next build", "start": "next start", "lint": "next lint", + "check-links": "node dev/check-links.mjs", + "check-filenames": "node dev/check-filenames.mjs", "baseai": "baseai", "sync": "npx baseai@latest deploy -m memory-sg-docs-live", "format": "prettier --config ./prettier.config.js --cache --cache-strategy metadata --write=true '**/{*.{js?(on),ts?(x),md,mdx,s?css},.*.js?(on)}'" From c8673eccd7872b61662e5530e46838d1e42fea51 Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 23:28:13 +0100 Subject: [PATCH 19/21] Fixup image path --- .../browser-extension/how-tos/google-workspace.mdx | 2 +- ...{disable_extension.png => disable-extension.png} | Bin src/data/redirects.ts | 5 +++++ 3 files changed, 6 insertions(+), 1 deletion(-) rename docs/integration/img/{disable_extension.png => disable-extension.png} (100%) diff --git a/docs/integration/browser-extension/how-tos/google-workspace.mdx b/docs/integration/browser-extension/how-tos/google-workspace.mdx index 5767cd086..9c9be1ed1 100644 --- a/docs/integration/browser-extension/how-tos/google-workspace.mdx +++ b/docs/integration/browser-extension/how-tos/google-workspace.mdx @@ -42,6 +42,6 @@ Users may also need to grant additional permissions to the Sourcegraph browser e Users can disable Sourcegraph at any time by using the toggle in the extension settings: disable_extension diff --git a/docs/integration/img/disable_extension.png b/docs/integration/img/disable-extension.png similarity index 100% rename from docs/integration/img/disable_extension.png rename to docs/integration/img/disable-extension.png diff --git a/src/data/redirects.ts b/src/data/redirects.ts index 0e7290c78..a4131cecb 100644 --- a/src/data/redirects.ts +++ b/src/data/redirects.ts @@ -1,4 +1,9 @@ const redirectsData = [ + { + source: '/integration/img/disable_extension.png', + destination: '/integration/img/disable-extension.png', + permanent: true + }, { source: '/admin/tls_ssl', destination: '/self-hosted/http-https-configuration', From 24a5b1135cf01041231c4fd364e26888cf0882e5 Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 23:34:08 +0100 Subject: [PATCH 20/21] Fix image path --- docs/code-insights/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/code-insights/index.mdx b/docs/code-insights/index.mdx index 4b0b6e67c..604a5180b 100644 --- a/docs/code-insights/index.mdx +++ b/docs/code-insights/index.mdx @@ -6,7 +6,7 @@

Anything you can search, you can track and analyze

- + Code Insights reveals high-level information about your codebase, based on both how your code changes over time and its current state. From 212fb0930dfa66b07d337e7b57e74a80b4f96659 Mon Sep 17 00:00:00 2001 From: Erik Seliger Date: Sun, 14 Dec 2025 23:36:02 +0100 Subject: [PATCH 21/21] executors: Remove self-hosted specific info Redundant with content in self-hosted section. --- docs/admin/executors/index.mdx | 9 --------- 1 file changed, 9 deletions(-) diff --git a/docs/admin/executors/index.mdx b/docs/admin/executors/index.mdx index 9486ccce4..346bb53f1 100644 --- a/docs/admin/executors/index.mdx +++ b/docs/admin/executors/index.mdx @@ -25,15 +25,6 @@ This requires executors to be run on machines capable of running Linux KVM exten Optionally, executors can be run without using KVM-based isolation, which is less secure but might be easier to run on common machines. -## Deciding which executor deployment method to use - -Deciding how to deploy the executor depends on your use case. For users that wish to process their untrusted compute in the most secure manner, we recommend leveraging the [Firecracker](/self-hosted/executors/firecracker) isolation method. For users that have constraints around running nested virtualization, the following flowchart can help you decide which deployment option is best for your environment: - -Executor Deployment Flowchart - ## How it works Executor instances are capable of being deployed in a variety of ways. Each runtime varies in how jobs are executed.