Skip to content
Closed
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: 0 additions & 2 deletions docs/admin/auth/login-form.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ The login form allows users to sign in to Sourcegraph using [configured auth pro

## Configuration

<Callout type="info">Supported for Sourcegraph versions 5.1 or more.</Callout>

These options do not apply to [`builtin`](/admin/auth/#builtin-password-authentication) and
[`http-header`](/admin/auth/#http-authentication-proxies) auth providers.

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/auth/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Basic principles

As of 3.20, Sourcegraph supports 6 authentication methods as listed in our [User authentication (SSO)](/admin/auth) page, details about how to configure those methods should refer to the relevant document pages.
Sourcegraph supports 6 authentication methods as listed in our [User authentication (SSO)](/admin/auth) page, details about how to configure those methods should refer to the relevant document pages.

Among these authentication methods, there are 4 that require Sourcegraph to send requests to the authentication provider, including GitHub OAuth, GitLab OAuth, OpenID Connect and SAML.

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/code-hosts/aws-codecommit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To connect AWS CodeCommit to Sourcegraph:

## AWS CodeCommit Git credentials

Since version **3.4** of Sourcegraph, the AWS CodeCommit service **requires** [Git credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html#git-credentials-code-commit) in order to clone repositories via HTTPS. Git credentials consist of a username and a password that you can create in AWS IAM.
The AWS CodeCommit service **requires** [Git credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html#git-credentials-code-commit) in order to clone repositories via HTTPS. Git credentials consist of a username and a password that you can create in AWS IAM.

For detailed instructions on how to create the credentials in IAM, see: [Setup for HTTPS Users Using Git Credentials](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html)

Expand Down
4 changes: 1 addition & 3 deletions docs/admin/code-hosts/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@ There are 2 ways to connect with GitHub:

## Using a GitHub App

<span class="badge badge-note">Sourcegraph 5.1+</span>

{/* <!-- NOTE: The instructions in the following sections closely mirror those in doc/admin/config/batch-changes under "Commit signing for GitHub". When making changes here, be sure to consider if those changes should also be made over there! --> */}

There are two ways to connect a GitHub App:
Expand Down Expand Up @@ -378,7 +376,7 @@ Follow the link to [configure webhooks for permissions for Github](/admin/webhoo

> 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/webhooks/incoming#user-permissions)
> WARNING: The following section is experimental and might not work properly. 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.

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 @@ -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.
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`

Expand Down
4 changes: 0 additions & 4 deletions docs/admin/code-hosts/src-serve-git.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,3 @@ docker run \
```

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).
3 changes: 1 addition & 2 deletions docs/admin/config/batch-changes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -206,8 +206,7 @@ To enable **commit signing as a site admin**, navigate to **Site Admin > Section
### Commit signing with GitHub apps

<Callout type="note">
Commit signing with GitHub apps is currently in Beta and is supported with
Sourcegraph v5.1 or more.
Commit signing with GitHub apps is currently in Beta.
</Callout>

Sourcegraph can be configured to [sign commits pushed to GitHub](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) using a GitHub App. Commit signing prevents tampering by unauthorized parties and provides a way to ensure that commits pushed to branches created by Batch Changes actually do come from Sourcegraph. Enabling commit signing for Batch Changes can also help pass checks in build systems or CI/CD pipelines that require that all commits are signed and verified before they can be merged.
Expand Down

This file was deleted.

2 changes: 0 additions & 2 deletions docs/admin/how-to/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

- [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 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)
Expand All @@ -11,5 +10,4 @@
- [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 export search results](/admin/how-to/export-search-results)
13 changes: 0 additions & 13 deletions docs/admin/how-to/lsif-scip-migration.mdx

This file was deleted.

6 changes: 0 additions & 6 deletions docs/admin/permissions/syncing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,6 @@ to Sourcegraph is the same as the [lag-time](#lag-time) defined below. So as lon

### Verify via UI

<span class="badge badge-note">Sourcegraph 5.0+</span>

The state of user or repository permissions can be checked directly in the Sourcegraph UI.

**User permissions**
Expand All @@ -132,8 +130,6 @@ The state of user or repository permissions can be checked directly in the Sourc

### Verify the state via API calls

<span class="badge badge-note">before Sourcegraph 5.0</span>

The GraphQL API can also be used:

```graphql
Expand Down Expand Up @@ -325,8 +321,6 @@ In some cases, user-centric and repo-centric permission sync can conflict. This

### Disable repo-centric permission sync

> IMPORTANT: This feature is only supported in Sourcegraph 5.0.4 and later.

> IMPORTANT: Disabling repo-centric permission sync can break your permission setup depending on your code host and user authentication method. Contact Sourcegraph support before disabling repo-centric permission sync.

To completely disable repo-centric permission sync scheduling, use this site configuration:
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/repo/auth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ See [git configuration](/admin/repo/git-config) for more details.

### Error: `sign_and_send_pubkey: no mutual signature supported`

In Sourcegraph 5.1.0 and later, the insecure SSH rsa-sha1 signature algorithm is no longer supported when fetching data from code hosts.
The insecure SSH rsa-sha1 signature algorithm is not supported when fetching data from code hosts.

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.

Expand Down
4 changes: 2 additions & 2 deletions docs/admin/repo/perforce.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ 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](/beta-and-experimental#experimental-features).
The following experimental features are available for Perforce depots. These are merely for providing feedback and have [limited support](/beta-and-experimental#experimental-features).

### Changelist ID in URLs

Expand All @@ -325,7 +325,7 @@ When enabled, URLs for Perforce code hosts will use the Changelist (CL) ID inste

### Searching within a specific changelist

As of Sourcegraph 5.5, you can search within a specific changelist by referring to the changelist as a reference path like `changelist/123` where 123 is the changelist id. For example, given a repo path of `Talkhouse/main` and a changelist id of `123`, you can search within that changelist by using the following query:
You can search within a specific changelist by referring to the changelist as a reference path like `changelist/123` where 123 is the changelist id. For example, given a repo path of `Talkhouse/main` and a changelist id of `123`, you can search within that changelist by using the following query:

```
repo:^Talkhouse/main$@changelist/123 text to find
Expand Down
4 changes: 0 additions & 4 deletions docs/admin/telemetry/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,10 @@ You can reach out to support@sourcegraph.com for additional information about ho

## Allowlist IPs / CIDR ranges for Sourcegraph

Starting 5.2.0:

- For `pings.sourcegraph.com`, allowlist the IP address: `34.36.231.254`
- For `telemetry-gateway.sourcegraph.com`, allowlist the IP address: `34.107.157.31`
- For `sourcegraph.com`, allowlist the full [Cloudflare IP ranges](https://www.cloudflare.com/ips/)

Prior to 5.2.0, allowlist the full [Cloudflare IP ranges](https://www.cloudflare.com/ips/).

## Architecture

To learn more about how telemetry data is processed, refer to the [Architecture page](/admin/architecture#analytics-and-telemetry).
10 changes: 4 additions & 6 deletions docs/admin/webhooks/incoming.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,14 @@ To receive webhooks both Sourcegraph and the code host need to be configured. To

## Deprecation notice

As of Sourcegraph 4.3.0 webhooks added via code host configuration are deprecated and support will be removed in release 5.1.0.

This includes any webhooks pointed at URLs starting with the following:
Webhooks added via code host configuration are no longer supported. This includes any webhooks pointed at URLs starting with the following:

- `.api/github-webhooks`
- `.api/gitlab-webhooks`
- `.api/bitbucket-server-webhooks`
- `.api/bitbucket-cloud-webhooks`

In order to continue using webhooks you need to follow the steps below to [add an incoming webhook](#adding-an-incoming-webhook) and then update the webhook configured on your code host with the new webhook url which will look something like `https://sourcegraph-instance/.api/webhooks/{UUID}`
If your code host still points at one of these URLs, follow the steps below to [add an incoming webhook](#adding-an-incoming-webhook) and then update the webhook configured on your code host with the new webhook url which will look something like `https://sourcegraph-instance/.api/webhooks/{UUID}`

## Adding an incoming webhook

Expand Down Expand Up @@ -240,8 +238,8 @@ Done! Sourcegraph will now receive webhook events to sync data with lower latenc
### Azure DevOps

<Callout type="note">
Experimental webhook support for Azure DevOps was added in Sourcegraph 5.0,
and does not currently support secrets. Please{' '}
Webhook support for Azure DevOps is experimental and does not currently
support secrets. Please{' '}
<a href="https://about.sourcegraph.com/contact">contact us</a> with any
issues found while using webhooks.
</Callout>
Expand Down
4 changes: 2 additions & 2 deletions docs/analytics/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Enterprise customers can use Sourcegraph Analytics to get a clear view of usage,
Our managed [Sourcegraph Analytics service](https://analytics.sourcegraph.com) for Cody and Code Search usage data is available for:

- [Sourcegraph Cloud](/cloud) customers
- Self-hosted customers that have fully enabled usage telemetry and are running a supported version of Sourcegraph (5.9+)
- Self-hosted customers that have fully enabled usage telemetry and are running a supported version of Sourcegraph
- [Sourcegraph workspaces](https://workspaces.sourcegraph.com)

To get started, follow our [enablement instructions](#enablement-instructions).
Expand Down Expand Up @@ -163,7 +163,7 @@ Cody-specific user metrics with slightly different user definitions:

#### Commands

_As of Sourcegraph version 5.10, commands are being deprecated in favor of chat prompts. If your Sourcegraph instance is running version 5.10 or later, you may see decreased command usage._
_Commands are deprecated in favor of chat prompts, so you may see decreased command usage._

| **Metric** | **Description** |
| ----------------------- | ----------------------------------------------------------------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion docs/batch-changes/batch-spec-templating.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ The following template variables are available in the fields under `changesetTem
| `steps.deleted_files` | `list of strings` | List of files deleted by the `steps`. Empty list if no files have been deleted |
| `steps.path` | `string` | Path (relative to the root of the directory, no leading `/` or `.`) in which the `steps` have been executed. Empty if no workspaces have been used and the `steps` were executed in the root of the repository |
| `outputs.<name>` | depends on `outputs.<name>.format`, default: `string` | Value of an [`output`](batch-spec-yaml-reference#stepsoutputs) set by `steps`. If the [`outputs.<name>.format`](batch-spec-yaml-reference#stepsoutputsnameformat) is `yaml` or `json` and the `value` a data structure (i.e., array, object, ...), then subfields can be accessed too. See [Templating Examples](#templating-examples) below |
| `batch_change_link` | `string` | <strong><small>Only available in `changesetTemplate.body`</small></strong><br />Link back to the batch change that produced the changeset on Sourcegraph. If omitted, the link will be automatically appended to the end of the body. <br />Requires [Sourcegraph CLI](/cli/) 3.40.9 or later |
| `batch_change_link` | `string` | <strong><small>Only available in `changesetTemplate.body`</small></strong><br />Link back to the batch change that produced the changeset on Sourcegraph. If omitted, the link will be automatically appended to the end of the body. |

## Template helper functions

Expand Down
Loading
Loading