Skip to content
Draft
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/builtin.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Builtin password authentication

The [`builtin` auth provider](/admin/config/site-config#builtin-password-authentication) manages user accounts inside Sourcegraph. It supports user signup, login, and password reset. This is the simplest provider type to set up, and is the default auth provider on a fresh installation for the first user so they can create an account and become site admin.
The [`builtin` auth provider](/admin/auth/builtin) manages user accounts inside Sourcegraph. It supports user signup, login, and password reset. This is the simplest provider type to set up, and is the default auth provider on a fresh installation for the first user so they can create an account and become site admin.

Use this auth provider, if you have no organizational requirements to use a SSO provider.

Expand Down
10 changes: 5 additions & 5 deletions docs/admin/auth/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ If you are unsure which auth provider is right for you, we recommend applying th
order:

- If you have no external identity providers (i.e., not SSO) or are just trying to spin Sourcegraph
up as quickly as possible to try, use [`builtin`](#builtin-password-authentication) authentication. You can
up as quickly as possible to try, use [`builtin`](/admin/auth/builtin) authentication. You can
always change the auth configuration later, and user identities from external providers will be
linked automatically to existing Sourcegraph accounts using verified email addresses.
- If you are deploying Sourcegraph behind a HTTP authentication proxy service, use the
Expand Down Expand Up @@ -405,7 +405,7 @@ Users can then add Gerrit credentials by visiting their **Settings** > **Account

## OpenID Connect

The [`openidconnect` auth provider](/admin/config/site-config#openid-connect-including-google-workspace) authenticates users via OpenID Connect, which is supported by many external services, including:
The [`openidconnect` auth provider](/admin/auth#openid-connect) authenticates users via OpenID Connect, which is supported by many external services, including:

- [Google Workspace (Google accounts)](#google-workspace-google-accounts)
- [Okta](https://developer.okta.com/docs/api/resources/oidc.html)
Expand All @@ -427,7 +427,7 @@ To configure Sourcegraph to authenticate users via OpenID Connect:
1. Provide the OpenID Connect client's issuer, client ID, and client secret in the Sourcegraph site configuration shown below.
1. (Optional) Require users to have a specific email domain name to authenticate (e.g., to limit users to only those from your organization).

Example [`openidconnect` auth provider](/admin/config/site-config#openid-connect-including-google-workspace) configuration:
Example [`openidconnect` auth provider](/admin/auth#openid-connect) configuration:

```json
{
Expand All @@ -449,7 +449,7 @@ Example [`openidconnect` auth provider](/admin/config/site-config#openid-connect

Sourcegraph supports the OpenID Connect Discovery standard for configuring the auth provider (using the values provided in the document at, e.g., `https://oidc.example.com/.well-known/openid-configuration`).

See the [`openid` auth provider documentation](/admin/config/site-config#openid-connect-including-google-workspace) for the full set of configuration options.
See the [`openid` auth provider documentation](/admin/auth#openid-connect) for the full set of configuration options.

### How to control user sign-up with OpenID auth provider

Expand Down Expand Up @@ -478,7 +478,7 @@ Google's Workspace (formerly known as G Suite) supports OpenID Connect, which is
1. Use the **client ID** and **client secret** values in Sourcegraph site configuration (as shown in the example below).
1. Set your Google Workspace domain in `requireEmailDomain` to prevent users outside your organization from signing in.

Example [`openidconnect` auth provider](/admin/config/site-config#openid-connect-including-google-workspace) configuration for Google Workspace:
Example [`openidconnect` auth provider](/admin/auth#openid-connect) configuration for Google Workspace:

```json
{
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/auth/login-form.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The login form allows users to sign in to Sourcegraph using [configured auth pro

<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
These options do not apply to [`builtin`](/admin/auth/builtin) and
[`http-header`](/admin/auth/#http-authentication-proxies) auth providers.

- The builtin auth provider has its own login form.
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/auth/saml/azure-ad.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

## 2. Add the SAML auth provider to Sourcegraph site config

[Add a SAML auth provider](/admin/auth/#add-a-saml-provider) with `identityProviderMetadataURL` set to the "App Federation Metadata Url" you recorded in the previous section. Here is an example of what your site configuration should look like:
[Add a SAML auth provider](/admin/auth/saml#add-a-saml-provider) with `identityProviderMetadataURL` set to the "App Federation Metadata Url" you recorded in the previous section. Here is an example of what your site configuration should look like:

```json
{
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/auth/saml/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Select your SAML identity provider for setup instructions:
- [JumpCloud](/admin/auth/saml/jump-cloud)
- [Other](/admin/auth/saml/generic)

For advanced SAML configuration options, see the [`saml` auth provider documentation](/admin/config/site-config#saml).
For advanced SAML configuration options, see the [`saml` auth provider documentation](/admin/auth/saml).

> NOTE: Sourcegraph currently supports at most 1 SAML auth provider at a time (but you can configure additional auth providers of other types). This should not be an issue for 99% of customers.

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 @@ -137,7 +137,7 @@ To add CodeCommit repositories in Docker Container:
### Mounting SSH keys into the container

1. Copy all the files at your `$HOME/.ssh directory` to `$HOME/.sourcegraph/config/ssh` directory.
1. Read our [guide here](/self-hosted/deploy/docker-compose/#git-ssh-configuration) for Docker Compose deployments
1. Read our [guide here](/self-hosted/deploy/docker-compose/configuration#git-ssh-configuration) for Docker Compose deployments
1. Read our [guide here](/self-hosted/deploy/kubernetes/configure#ssh-for-cloning) for Kubernetes deployments
1. Start (or restart) the container.
1. Connect Sourcegraph to AWS CodeCommit by going to **Sourcegraph > Site Admin > Manage code hosts > Generic Git host** and add the following:
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/code-hosts/gitlab.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ In this case, a user's OAuth token will be used to get a list of repositories th

This method requires administrator access to GitLab so that Sourcegraph can access the [admin GitLab Users API endpoint](https://docs.gitlab.com/ee/api/users.html#for-admins). For each GitLab user, this endpoint provides the user ID that comes from the authentication provider, so Sourcegraph can associate a user in its system to a user in GitLab.

Prerequisite: Add the [SAML](/admin/auth/#saml) or [OpenID Connect](/admin/auth/#openid-connect)
Prerequisite: Add the [SAML](/admin/auth/saml) or [OpenID Connect](/admin/auth/#openid-connect)
authentication provider you use to sign into GitLab.

Then, [add or edit a GitLab connection](#repository-syncing) using an administrator (sudo-level) personal access token, and include the `authorization` field:
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/config/authorization-and-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Built-in username/password authentication is Sourcegraph’s default authenticat

Set `allowSignup` to `false` if you want to create user accounts instead of allowing the user to create their own.

Learn more about [built-in password authentication](/admin/auth/#builtin-password-authentication).
Learn more about [built-in password authentication](/admin/auth/builtin).

### GitHub Enterprise or GitHub Cloud authentication and authorization

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Does Sourcegraph support SVN?

For Subversion and other non-Git code hosts, the recommended way to make these accessible in
Sourcegraph is through [`src-expose`](/admin/code-hosts/other#experimental-src-expose).
Sourcegraph is through [`src-expose`](/admin/code-hosts/non-git#installing-src-expose).

Alternatively, you can use [`git-svn`](https://git-scm.com/docs/git-svn) or
[`svg2git`](https://github.com/svn-all-fast-export/svn2git) to convert Subversion repositories to
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/how-to/monorepo-issues.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Here's an example of a diff to improve symbols performance in a k8s deployment:
+ memory: 8G
```

_Learn more about managing resources in [docker-compose](/self-hosted/deploy/docker-compose/#operations) and [kubernetes](/self-hosted/deploy/kubernetes/operations)_
_Learn more about managing resources in [docker-compose](/self-hosted/deploy/docker-compose/configuration#adjust-resources) and [kubernetes](/self-hosted/deploy/kubernetes/operations)_

## Slow hover tooltip results

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Sourcegraph administration is primarily managed by site administrators, who are
- [Global and user settings](/admin/config/settings)
- [Configuring Authorization and Authentication](/admin/config/authorization-and-authentication)
- [User authentication](/admin/auth/)
- [Built-in password authentication](/admin/auth/#builtin-password-authentication)
- [Built-in password authentication](/admin/auth/builtin)
- [GitHub authentication](/admin/auth/#github)
- [GitLab authentication](/admin/auth/#gitlab)
- [OpenID connect](/admin/auth/#openid-connect)
Expand Down
6 changes: 3 additions & 3 deletions docs/admin/migration/opengrok.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The following sections guide you through the migration process.

### Deploying Sourcegraph

We offer several methods for deploying Sourcegraph for various requirements—see [Getting started](/#getting-started) to learn more about how to get started with Sourcegraph.
We offer several methods for deploying Sourcegraph for various requirements—see [Getting started](/getting-started) to learn more about how to get started with Sourcegraph.

Choose a deployment option and follow the instructions. When you've signed into your Sourcegraph instance as a site admin, continue to the next section.

Expand Down Expand Up @@ -74,9 +74,9 @@ When you've added repositories and confirmed that you can search and browse them

Like Oracle OpenGrok, Sourcegraph is self-hosted. You control who can access it. Sourcegraph supports many user authentication and security options:

- [OpenID Connect user authentication](/admin/auth/#openid-connect) and [SAML user authentication](/admin/auth/#saml) (for Google/Google Workspace accounts, Okta, OneLogin, etc.)
- [OpenID Connect user authentication](/admin/auth/#openid-connect) and [SAML user authentication](/admin/auth/saml) (for Google/Google Workspace accounts, Okta, OneLogin, etc.)
- [HTTP user authentication proxies](/admin/auth/#http-authentication-proxies)
- [Builtin username-password authentication](/admin/auth/#builtin-authentication)
- [Builtin username-password authentication](/admin/auth/builtin)
- [TLS/SSL and other HTTP/HTTPS configuration](/self-hosted/http-https-configuration)

### Rolling out Sourcegraph organization-wide
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/permissions/syncing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ permissions. Both are on by default, resulting in double polling:

Sourcegraph collects this information and stores it in internal database.

To see which code hosts support permission syncing, please refer to [Supported code hosts table](/admin/#supported-code-hosts).
To see which code hosts support permission syncing, please refer to [Supported code hosts table](/admin/code-hosts).

## How it works

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 @@ -31,7 +31,7 @@ Some providers may require additional configuration, consult the [code host spec

## Mounting SSH keys into the container

- [Sourcegraph with Docker Compose](/self-hosted/deploy/docker-compose/): See [the Docker Compose git configuration guide](/self-hosted/deploy/docker-compose/#git-configuration).
- [Sourcegraph with Docker Compose](/self-hosted/deploy/docker-compose/): See [the Docker Compose git configuration guide](/self-hosted/deploy/docker-compose/configuration#git-configuration).
- [Sourcegraph with Kubernetes](/self-hosted/deploy/kubernetes/): See [Configure repository cloning via SSH](/self-hosted/deploy/kubernetes/configure#ssh-for-cloning).

## Troubleshooting
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/repo/git-config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Sourcegraph supports customising [git-config](https://git-scm.com/docs/git-confi

This guide documents how to configure git-config. To set up SSH and authentication for repositories, see [Repository authentication](/admin/repo/auth).

- [Sourcegraph with Docker Compose](/self-hosted/deploy/docker-compose/): See [the Docker Compose git configuration guide](/self-hosted/deploy/docker-compose/#git-configuration).
- [Sourcegraph with Docker Compose](/self-hosted/deploy/docker-compose/): See [the Docker Compose git configuration guide](/self-hosted/deploy/docker-compose/configuration#git-configuration).
- [Sourcegraph with Kubernetes](/self-hosted/deploy/kubernetes/): See [Configure repository cloning via SSH](/self-hosted/deploy/kubernetes/configure#ssh-for-cloning).

## Example: alternate clone URL for repos
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/repo/update-frequency.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ You may also choose to disable automatic Git updates entirely and instead [confi

## Repo Updater State

> NOTE: [Instrumentation](/admin/faq#i-am-getting-error-cluster-information-not-available-in-the-instrumentation-page-what-should-i-do) (where Repo Updater State resides) is only available for Kubernetes instances.
> NOTE: [Instrumentation](/self-hosted/faq#i-am-getting-error-cluster-information-not-available-in-the-instrumentation-page-what-should-i-do) (where Repo Updater State resides) is only available for Kubernetes instances.

**Repo Updater State** is a useful debugging tool for site admins to monitor:

Expand Down
4 changes: 2 additions & 2 deletions docs/admin/telemetry/protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ To learn more, refer to our [telemetry documentation](https://sourcegraph.com/do
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [string](#string) | | <p>Generated ID of the event, currently expected to be UUID v4.</p> |
| timestamp | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | <p>Timestamp of when the original event was recorded.</p> |
| timestamp | [google.protobuf.Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp) | | <p>Timestamp of when the original event was recorded.</p> |
| feature | [string](#string) | | <p>Feature associated with the event in camelCase, e.g. 'myFeature'.</p> |
| action | [string](#string) | | <p>Action associated with the event in camelCase, e.g. 'pageView'.</p> |
| source | [EventSource](#telemetrygateway-v1-EventSource) | | <p>Source of the event.</p> |
Expand Down Expand Up @@ -194,7 +194,7 @@ callsites, and is the primary means of recording product interaction metadata.
| version | [int32](#int32) | | <p>Version of the event parameters, used for indicating the "shape" of this</p><p>event's metadata, beginning at 0. Useful for denoting if the shape of</p><p>metadata has changed in any way.</p> |
| legacy_metadata | [EventParameters.LegacyMetadataEntry](#telemetrygateway-v1-EventParameters-LegacyMetadataEntry) | repeated | **Deprecated.** <p>DEPRECATED, legacy metadata format that only accepted int64 - use the new</p><p>'metadata' field instead, which accepts float values. Values sent through</p><p>this proto field will be merged into the new metadata attributes.</p> |
| metadata | [EventParameters.MetadataEntry](#telemetrygateway-v1-EventParameters-MetadataEntry) | repeated | <p>Strictly typed exported-by-default metadata, restricted to numeric values</p><p>to ensure no sensitive attributes are exported. Sourcegraph telemetry SDKs</p><p>must use programming language type-checking to ensure metadata keys are</p><p>statically known.</p> |
| private_metadata | [google.protobuf.Struct](#google-protobuf-Struct) | optional | <p>Additional potentially sensitive metadata - i.e. not restricted to numeric</p><p>values.</p><p>🚨 SECURITY: This metadata is NOT exported from instances by default, as it</p><p>can contain arbitrarily-shaped data that may accidentally contain sensitive</p><p>or private contents.</p><p>This metadata is only exported on an allowlist basis based on terms of</p><p>use agreements and combinations of event feature and action, alongside</p><p>careful audit of callsites. For the list of allowlisted properties, refer</p><p>to this generated page:</p><p>https://sourcegraph.com/docs/admin/telemetry/private-metadata-allowlist</p> |
| private_metadata | [google.protobuf.Struct](https://protobuf.dev/reference/protobuf/google.protobuf/#struct) | optional | <p>Additional potentially sensitive metadata - i.e. not restricted to numeric</p><p>values.</p><p>🚨 SECURITY: This metadata is NOT exported from instances by default, as it</p><p>can contain arbitrarily-shaped data that may accidentally contain sensitive</p><p>or private contents.</p><p>This metadata is only exported on an allowlist basis based on terms of</p><p>use agreements and combinations of event feature and action, alongside</p><p>careful audit of callsites. For the list of allowlisted properties, refer</p><p>to this generated page:</p><p>https://sourcegraph.com/docs/admin/telemetry/private-metadata-allowlist</p> |
| billing_metadata | [EventBillingMetadata](#telemetrygateway-v1-EventBillingMetadata) | optional | <p>Optional billing-related metadata.</p> |


Expand Down
2 changes: 1 addition & 1 deletion docs/batch-changes/rebasing-changesets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If your codehost requires changesets to be up to date with the main branch, you

## Requirements

- Sourcegraph instance with repositories in it. See the [Quickstart](/#quick-install) guide on how to set up a Sourcegraph instance
- Sourcegraph instance with repositories in it. See the [Quickstart](/self-hosted/deploy) guide on how to set up a Sourcegraph instance
- A [global service account token](/batch-changes/configuring-credentials#global-service-account-tokens) for Batch Changes (**a personal access token cannot currently be used for importing changesets**)

## Select changesets to rebase
Expand Down
2 changes: 1 addition & 1 deletion docs/batch-changes/tracking-existing-changesets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Batch Changes allow you not only to [publish changesets](/batch-changes/publishi

## Requirements

- Sourcegraph instance with repositories in it. See the [Quickstart](/#quick-install) guide on how to set up a Sourcegraph instance
- Sourcegraph instance with repositories in it. See the [Quickstart](/self-hosted/deploy) guide on how to set up a Sourcegraph instance
- A [global service account token](/batch-changes/configuring-credentials#global-service-account-tokens) for Batch Changes (**a personal access token cannot currently be used for importing changesets**)

## Importing changesets into a batch change
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ All Sourcegraph Cloud instances are provisioned with a Sourcegraph-managed SMTP
- [Code Monitoring](/code-monitoring/) notifications
- Inviting other users to a Sourcegraph instance, or to an organization/team on a Sourcegraph instance
- Important updates to user accounts (for example, creation of API keys)
- For [`builtin` authentication](/admin/auth/#builtin-password-authentication), password resets and email verification
- For [`builtin` authentication](/admin/auth/builtin), password resets and email verification

By default, emails will be sent from an `@cloud.sourcegraph.com` email address. To test email delivery, refer to [sending a test email](/self-hosted/email#sending-a-test-email).

Expand Down
2 changes: 1 addition & 1 deletion docs/code-insights/language-insight-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ For more information about Code Insights see the [Code Insights](/code-insights/

### 1. Visit your Sourcegraph instance /Insights page and select "+ Create new insight"

If you don't see the /Insights page you need to [enable code insights](quickstart#1-enable-the-experimental-feature-flag).
If you don't see the /Insights page you need to [enable code insights](/code-insights/quickstart#1-if-need-be-enable-the-experimental-feature-flag).

### 2. On the insight type selection page, select "Create language usage insight"

Expand Down
Loading