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
4 changes: 2 additions & 2 deletions docs/admin/auth/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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#selecting-repositories-to-sync).

### How to control user sign-up and sign-in with GitHub auth provider

Expand Down Expand Up @@ -556,7 +556,7 @@ Usernames in Sourcegraph are mutable, so a malicious user could change a usernam

Sourcegraph will automatically link accounts from multiple external auth providers, resulting in a single user account on Sourcegraph. That way a user can login with multiple auth methods and end up being logged in with the same Sourcegraph account. In general, to link accounts, the following condition needs to be met:

At the time of signing in with the new account, any of the email addresses configured on the user account on the auth provider must match any of the **verified** email addresses on the user account on the Sourcegraph side. If there is a match, the accounts are linked, [otherwise a new user account is created if auth provider is configured to support user sign ups](#how-to-control-user-sign-up).
At the time of signing in with the new account, any of the email addresses configured on the user account on the auth provider must match any of the **verified** email addresses on the user account on the Sourcegraph side. If there is a match, the accounts are linked, [otherwise a new user account is created if auth provider is configured to support user sign ups](#how-to-control-user-sign-up-and-sign-in-with-github-auth-provider).

## Username normalization

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 @@ -191,4 +191,4 @@ error, double-check the relying party identifiers of the Relying Party Trust ent

### Other troubleshooting

See [SAML troubleshooting](/admin/auth/saml/#saml-troubleshooting) for more tips.
See [SAML troubleshooting](/admin/auth/saml#troubleshooting) for more tips.
6 changes: 3 additions & 3 deletions docs/admin/code-hosts/bitbucket-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 <kbd>Cmd/Ctrl+Space</kbd> 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-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

Expand Down Expand Up @@ -163,11 +163,11 @@ By installing the [Bitbucket Server plugin](/integration/bitbucket-server), you

### 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-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-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:

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/code-hosts/gerrit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Users should now be able to authenticate their Sourcegraph accounts using their

## Have users authenticate their Sourcegraph accounts using their Gerrit HTTP credentials

After [configuring Gerrit as a code host connection](#configure-gerrit-as-code-host-connection) and [adding Gerrit as an authentication provider](#add-gerrit-as-an-authnetication-provider), users will be able to authenticate their Sourcegraph accounts using their Gerrit HTTP credentials:
After [configuring Gerrit as a code host connection](#configure-gerrit-as-a-code-host-connection) and [adding Gerrit as an authentication provider](#add-gerrit-as-an-authentication-provider), users will be able to authenticate their Sourcegraph accounts using their Gerrit HTTP credentials:

As a user:

Expand Down
10 changes: 5 additions & 5 deletions docs/admin/code-hosts/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,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-with-github-apps) (Beta).

#### Multiple installations

Expand Down Expand Up @@ -321,7 +321,7 @@ See [Internal rate limits](/admin/code-hosts/rate-limits#internal-rate-limits).

Prerequisite for configuring repository permission syncing: [Add GitHub as an authentication provider](/admin/auth/#github).

> NOTE: If your GitHub organization enforces SAML SSO, consider configuring [`requiredSsoOrgs`](/admin/auth/#requiredssoOrgs) in your GitHub auth provider to ensure users properly authorize the OAuth application during sign-in. This helps prevent permissions syncing issues caused by tokens that lack SSO authorization.
> NOTE: If your GitHub organization enforces SAML SSO, consider configuring [`requiredSsoOrgs`](/admin/auth#github) in your GitHub auth provider to ensure users properly authorize the OAuth application during sign-in. This helps prevent permissions syncing issues caused by tokens that lack SSO authorization.

Then, add or edit the GitHub connection as described above and include the `authorization` field:

Expand All @@ -338,7 +338,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/webhooks/incoming#user-permissions).
> IMPORTANT: Optional, but strongly recommended - [continue with configuring webhooks for permissions](/admin/webhooks/incoming#github).

<span class="virtual-br"></span>

Expand Down Expand Up @@ -372,13 +372,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/webhooks/incoming#user-permissions)
Follow the link to [configure webhooks for permissions for Github](/admin/webhooks/incoming#github)

### 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/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#github)

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/config/batch-changes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ However, if the user deletion is permanent, deleting both account and data, then

The Batch Spec Library offers curated examples and guided templates that make large-scale code modifications accessible to developers at every skill level. As a site admin you can manage the library.

The library distinguishes between [templates](#templates) and [examples](#library-examples). Examples are batch specs that are meant to be modified by power users who are comfortable with the batch spec syntax. Templates, on the other hand, are batch specs that contain variables that the user can provide data for through form fields without having to modify the batch spec code.
The library distinguishes between [templates](#templates) and [examples](#examples-2). Examples are batch specs that are meant to be modified by power users who are comfortable with the batch spec syntax. Templates, on the other hand, are batch specs that contain variables that the user can provide data for through form fields without having to modify the batch spec code.

Sourcegraph instances come with a couple of examples out of the box. You can use the GraphQL APIs to [manage the Batch Spec Library](#managing-the-batch-spec-library).

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/how-to/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
- [How to remove users or edit users with the GraphQL API](/admin/how-to/mutate-user-api)
- [How to manage feature flags with the GraphQL API](/admin/how-to/manage-feature-flags-with-graphql)
- [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 purge deleted repository data from Sourcegraph](/admin/how-to/remove-repo#remove-corrupted-repository-data-from-sourcegraph)
- [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)
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/permissions/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ To set up permissions by [syncing them from a code host](/admin/permissions/sync
- [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)
- [Perforce](/admin/repo/perforce#repository-permissions-beta)
- [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.
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/permissions/webhooks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ not be sent to Sourcegraph.

## Configuring webhooks

Please follow the link for [configuring permission syncing webhooks for GitHub](/admin/webhooks/incoming#user-permissions).
Please follow the link for [configuring permission syncing webhooks for GitHub](/admin/webhooks/incoming#github).
2 changes: 1 addition & 1 deletion docs/admin/scim.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Sourcegraph supports SCIM 2.0 for provisioning and de-provisioning _users_.

## How to use

To use SCIM, you must have an existing IdP configured as an auth provider on your Sourcegraph instance. For authenticating SCIM requests, we currently support Bearer token authentication. We have a guide for Okta setup [below](#setting-up-okta-as-the-idp).
To use SCIM, you must have an existing IdP configured as an auth provider on your Sourcegraph instance. For authenticating SCIM requests, we currently support Bearer token authentication. We have a guide for Okta setup [below](#configuring-scim-for-okta).

To configure:

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/security-event-logs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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#configuring) in the site config

### How can I correlate the actorID or userID to a user in the application?

Expand Down
4 changes: 2 additions & 2 deletions docs/admin/webhooks/incoming.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -133,11 +133,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-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-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.
Expand Down