Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/admin/auth/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -547,7 +547,7 @@ 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.
Usernames in Sourcegraph are mutable, so a malicious user could change a username, elevating their privileges.
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/auth/saml/microsoft-adfs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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](/self-hosted/http-https-configuration#nginx-ssl-https-configuration).
- Sourcegraph should be [configured to use HTTPS](/self-hosted/http-https-configuration#nginx-sslhttps-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).
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/code-hosts/non-git.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ In order to keep the code in the local repository up to date, you will need to r

In addition to serving a local directory, `src-expose` can periodically run a command of your choice to fetch changes from a remote and combine them into a single new Git commit.

For example, if your `src-expose` is using a [configuration YAML file](#next-steps--advanced-configuration) that contains the following:
For example, if your `src-expose` is using a [configuration YAML file](#next-steps-advanced-configuration) that contains the following:

```yaml
# before is a command run before sync. before is run from root.
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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](/self-hosted/observability/alerts#zoekt-memory-map-areas-percentage-used).
scenario and mitigation steps](/self-hosted/observability/alerts#zoekt-memory_map_areas_percentage_used).

### Shard merging

Expand Down
22 changes: 11 additions & 11 deletions docs/batch-changes/batch-spec-yaml-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ To match a branch other than the default, `branch` or `branches` can be used to

<Callout type="warning">
If multiple branches are matched for the same repository, then
[`changesetTemplate.branch`](#changesettemplate-branch) will need to have a
[`changesetTemplate.branch`](#changesettemplatebranch) will need to have a
different value for each branch.
</Callout>

Expand Down Expand Up @@ -299,7 +299,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.<name>` [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.
Output variables that are set after the [`steps.run`](#stepsrun) command has been executed. These variables are available in the global `outputs` namespace as `outputs.<name>` [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

Expand Down Expand Up @@ -596,7 +596,7 @@ The body (description) of the changeset on the code host. If the code supports M

The name of the Git branch to create or update each repository with the changes.

If multiple branches within the same repository are matched in [`on.repository`](#on-repository), then this value must be dynamic since creating multiple branches with the same name in the same repository is impossible. This is often most easily accomplished with the `repository.branch` template variable. For example, this will create `new-feature-3.34` and `new-feature-3.35` branches:
If multiple branches within the same repository are matched in [`on.repository`](#onrepository), then this value must be dynamic since creating multiple branches with the same name in the same repository is impossible. This is often most easily accomplished with the `repository.branch` template variable. For example, this will create `new-feature-3.34` and `new-feature-3.35` branches:

```yaml
on:
Expand Down Expand Up @@ -852,11 +852,11 @@ The name of the directory in which file diffs should be grouped together. The na

## `transformChanges.group.branch`

The branch that should be used for this additional changeset. This **overwrites the [`changesetTemplate.branch`](#changesettemplate-branch)** when creating the additional changeset.
The branch that should be used for this additional changeset. This **overwrites the [`changesetTemplate.branch`](#changesettemplatebranch)** when creating the additional changeset.

<Callout type="info">
The branch cannot be nested under the
[`changesetTemplate.branch`](#changesettemplate-branch), i.e. if the
[`changesetTemplate.branch`](#changesettemplatebranch), i.e. if the
`changesetTemplate.branch` is `my-batch-change` then this can _not_ be
`my-batch-change/my-subdirectory` since [git doesn't allow
that](https://stackoverflow.com/a/22630664). Additionally, branch names must
Expand All @@ -865,9 +865,9 @@ The branch that should be used for this additional changeset. This **overwrites

## `transformChanges.group.title`

(Optional) The title that should be used for this additional changeset. This **overwrites the [`changesetTemplate.title`](#changesettemplate-title)** when creating the additional changeset.
(Optional) The title that should be used for this additional changeset. This **overwrites the [`changesetTemplate.title`](#changesettemplatetitle)** when creating the additional changeset.

The title supports the same template variables as [`changesetTemplate.title`](#changesettemplate-title). When rendering the group title, `${{ steps.path }}` is set to this group's [`directory`](#transformchangesgroupdirectory).
The title supports the same template variables as [`changesetTemplate.title`](#changesettemplatetitle). When rendering the group title, `${{ steps.path }}` is set to this group's [`directory`](#transformchangesgroupdirectory).

## `transformChanges.group.repository`

Expand All @@ -877,13 +877,13 @@ The title supports the same template variables as [`changesetTemplate.title`](#c

The optional `workspaces` property allows users to define where projects are located in repositories and cause the [`steps`](#steps) to be executed for each project instead of once per repository. That allows easier creation of multiple changesets in large repositories.

For each repository yielded by [`on`](#on), a Sourcegraph search is used to get the locations of the `rootAtLocationOf` file. Each location serves as a workspace for executing the `steps` instead of the repository's root. Use the [`workspaces.in`](#workspaces-in) property to scope the definitions of workspaces. Omitting it is treated as `*`.
For each repository yielded by [`on`](#on), a Sourcegraph search is used to get the locations of the `rootAtLocationOf` file. Each location serves as a workspace for executing the `steps` instead of the repository's root. Use the [`workspaces.in`](#workspacesin) property to scope the definitions of workspaces. Omitting it is treated as `*`.

<Callout type="info">
Since multiple workspaces in the same repository can produce multiple
changesets, it's **required** to use templating to produce a unique
[`changesetTemplate.branch`](#changesettemplate-branch) for each produced
changeset. See the [examples](#workspaces-examples) below.
[`changesetTemplate.branch`](#changesettemplatebranch) for each produced
changeset. See the [examples](#examples-18) below.
</Callout>

### Examples
Expand Down Expand Up @@ -947,7 +947,7 @@ changesetTemplate:
branch: ${{ join_if "-" "my-multi-workspace-batch-change" (replace steps.path "/" "-") }}
```

Using [`steps.outputs`](#steps-outputs) to dynamically create unique branch names:
Using [`steps.outputs`](#stepsoutputs) to dynamically create unique branch names:

```yaml
# [...]
Expand Down
4 changes: 2 additions & 2 deletions docs/batch-changes/site-admin-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Using Batch Changes requires a [code host connection](/admin/code-hosts/) to a s
- [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)
- [Auto-delete branch on merge/close](/admin/config/batch-changes#automatically-delete-branches-on-mergeclose), which automatically deletes branches created by Batch Changes when changesets are merged or closed
- [Commit signing for GitHub](/admin/config/batch-changes#commit-signing-with-github-apps), 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Code Insights does not yet support running over specific revisions.

## VCS limitations

Code Insights by default can **not** query repositories that have [sub-repo permissions](/admin/permissions/api#Setting-sub-repository-permissions-for-users) configured. Note that some repositories can sync sub-repo permissions from the code host - Perforce depots currently (6.4).
Code Insights by default can **not** query repositories that have [sub-repo permissions](/admin/permissions/api#setting-sub-repository-permissions-for-users) configured. Note that some repositories can sync sub-repo permissions from the code host - Perforce depots currently (6.4).

The reason for that restriction is security concerns around exposing the code in those repositories to users who should not be able to access it.

Expand Down
2 changes: 1 addition & 1 deletion docs/code-insights/references/requirements.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ You can only use Code Insights on a [Docker Compose](/self-hosted/deploy/docker-

Sourcegraph Code Insights is compatible with any [Sourcegraph-compatible code host](/admin/repo/).

If the repo has [sub-repo permissions](/admin/permissions/api#Setting-sub-repository-permissions-for-users) configured, an admin will need to set `experimentalSettings.subRepoPermissions.allowCodeInsights` to `true` in site config to allow Code Insights to query that repo.
If the repo has [sub-repo permissions](/admin/permissions/api#setting-sub-repository-permissions-for-users) configured, an admin will need to set `experimentalSettings.subRepoPermissions.allowCodeInsights` to `true` in site config to allow Code Insights to query that repo.
2 changes: 1 addition & 1 deletion docs/code-navigation/auto-indexing-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This document details the expected contents of [explicit index job configuration

The root of the configuration has one top-level key, `index_jobs`, documented below.

### [`index_jobs`](#index-jobs)
### [`index_jobs`](#index_jobs)

The index jobs field defines a set of [index job objects](#index-job-object) describing the actions to perform to successfully index a fresh clone of a repository. Each index job is executed independently (and possibly in parallel) by an executor.

Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosted/deploy/kubernetes/troubleshoot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ SEARCHER_URL=http:searcher:3184
The issue described is related to the Code Intel hover feature, where it may get
stuck in a loading state or return a 502 error with the message `Squirrel.LocalCodeIntel
http status 502`. This is caused by the same issue described in [Symbols sidebar
and hovers are not working](#symbols-sidebar-and-hovers-are-not-working"). See that
and hovers are not working](#symbols-sidebar-and-hovers-are-not-working). See that
section for solution.

## Help request
Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosted/deploy/machine-images/aws-oneclick.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Prefer manually installing on AWS yourself? See our [AMI](/self-hosted/deploy/ma

## Prerequisites

- An AWS account (most regions are supported, see our [Launcher](#deploy-sourcegraph) below for a complete list)
- An AWS account (most regions are supported, see our [Launcher](#deploy-sourcegraph-) below for a complete list)
- General familiarity with AWS
- An [EC2 keypair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html) for SSH access
- (optional) A Sourcegraph license to unlock features ([view plans](https://sourcegraph.com/pricing) or [learn how licenses work](/admin/licensing/))
Expand Down
6 changes: 3 additions & 3 deletions docs/self-hosted/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Please refer to [Understanding alerts](/self-hosted/observability/alerting#under

### 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)).
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).

Expand All @@ -55,7 +55,7 @@ See [Alert solutions](/self-hosted/observability/alerts) to learn about each ale

### 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)).
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).

Expand All @@ -75,7 +75,7 @@ Please refer to our guide on [setting up alerting](/self-hosted/observability/al

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).
More advanced users can also refer to [our FAQ item about custom consumption of Sourcegraph metrics](#can-i-consume-sourcegraphs-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.)?

Expand Down
4 changes: 2 additions & 2 deletions docs/self-hosted/http-https-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Overview:

## Sourcegraph single Docker image and Sourcegraph Cluster (Kubernetes): NGINX

Sourcegraph's single Docker image and Kubernetes deployments use [NGINX](https://www.nginx.com/resources/glossary/nginx/) as a [reverse proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) for the Sourcegraph front-end server, meaning NGINX proxies external HTTP (and [HTTPS](#nginx-ssl-https-configuration)) requests to the Sourcegraph front-end.
Sourcegraph's single Docker image and Kubernetes deployments use [NGINX](https://www.nginx.com/resources/glossary/nginx/) as a [reverse proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) for the Sourcegraph front-end server, meaning NGINX proxies external HTTP (and [HTTPS](#nginx-sslhttps-configuration)) requests to the Sourcegraph front-end.

![NGINX and Sourcegraph architecture](https://storage.googleapis.com/sourcegraph-assets/Docs/sourcegraph-nginx.svg)

Expand All @@ -23,7 +23,7 @@ The first time Sourcegraph is run, it will create an [`nginx.conf`](https://gith

SSL support requires two things:

1. [Manual editing](#nginx-ssl-https-configuration) of the NGINX configuration file if using the [quickstart docker run command](/#quick-install) as it presumes local or internal usage.
1. [Manual editing](#nginx-sslhttps-configuration) of the NGINX configuration file if using the [quickstart docker run command](/self-hosted/deploy) as it presumes local or internal usage.
1. (Now that NGINX is listening on port 7443), we need to configure the Sourcegraph container to forward
443 to 7443 by adding `--publish 443:7443` to the `docker run` command:

Expand Down