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
4 changes: 2 additions & 2 deletions docs/admin/auth/saml/one-login.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## 1. Create a SAML app in OneLogin

1. Go to https://mycompany.onelogin.com/apps/find (replace "mycompany" with your company's OneLogin
1. Go to https://example.onelogin.com/apps/find (replace "example" with your company's OneLogin
ID).
1. Type "saml" in the search field and select `SAML Custom Connector (Advanced)`, which uses the SAML 2.0 version. Click "Save".
1. Under the "Configuration" tab, set the following properties (replacing `https://sourcegraph.example.com` with your Sourcegraph URL):
Expand All @@ -17,7 +17,7 @@
- - login: AD user name Include in SAML Assertion: ✓
1. Save the app in OneLogin.
1. Find the Issuer URL in the OneLogin app configuration page, under the "SSO" tab, under "Issuer
URL". It should look something like `https://mycompany.onelogin.com/saml/metadata/123456` or
URL". It should look something like `https://example.onelogin.com/saml/metadata/123456` or
`https://app.onelogin.com/saml/metadata/123456`. Record this for the next section.

## 2. Add the SAML auth provider to Sourcegraph site config
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/code-hosts/bitbucket-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Once a user has connected their Bitbucket Server account, either by signing-in v

This section walks you through the process of setting up an _Application Link between Sourcegraph and Bitbucket Server / Bitbucket Data Center_ and configuring the Sourcegraph Bitbucket Server / Bitbucket Data Center configuration with `authorization` settings. It assumes the above prerequisites are met.

As an admin user, go to the "Application Links" page. You can use the sidebar navigation in the admin dashboard, or go directly to [https://bitbucketserver.example.com/plugins/servlet/applinks/listApplicationLinks](https://bitbucketserver.example.com/plugins/servlet/applinks/listApplicationLinks).
As an admin user, go to the "Application Links" page. You can use the sidebar navigation in the admin dashboard, or go directly to [https://bitbucket.example.com/plugins/servlet/applinks/listApplicationLinks](https://bitbucket.example.com/plugins/servlet/applinks/listApplicationLinks).

> NOTE: There has been some [changes to the flow in Bitbucket v7.20](https://confluence.atlassian.com/bitbucketserver/bitbucket-data-center-and-server-7-20-release-notes-1101934428.html). Depending on your Bitbucket version, the setup is slightly different. Please follow the instructions for the correct version of Bitbucket below:

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/code-hosts/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ To add an existing GitHub App:
1. Go to **Site admin > Repositories > Github Apps** on Sourcegraph.
2. Click **Add an existing GitHub App**.
3. Enter the following details of your existing GitHub App:
- **GitHub URL**: The URL of your GitHub instance (e.g., `https://github.com` or `https://github-enterprise.example.com`)
- **GitHub URL**: The URL of your GitHub instance (e.g., `https://github.com` or `https://github.example.com`)
- **Client ID**: The unique identifier for your GitHub App
- **Private Key**: The private key generated for your GitHub App (in PEM format)
4. Click **Add GitHub App** to save the configuration.
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 @@ -340,7 +340,7 @@ The Sourcegraph instance's site admin must [update the `corsOrigin` site config
```json
{
// ...
"corsOrigin": "https://my-gitlab.example.com"
"corsOrigin": "https://gitlab.example.com"
// ...
}
```
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/code-hosts/phabricator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The Sourcegraph instance's site admin must [update the `corsOrigin` site config
```json
{
// ...
"corsOrigin": "https://my-phabricator.example.com"
"corsOrigin": "https://phabricator.example.com"
// ...
}
```
Expand Down
4 changes: 2 additions & 2 deletions docs/admin/config/authorization-and-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.example.com/siteadmin/configuration` ([Learn more about viewing and editing your site configuration.](/admin/config/site-config#view-and-edit-site-configuration))

```json
{
Expand Down Expand Up @@ -124,7 +124,7 @@ We support authentication through OAuth for [Azure DevOps Services (dev.azure.co

1. In the `Name` field pick a descriptive name for this connection
2. For `Supported account types` select `Accounts in this organizational directory only`
3. For `Redirect URI` pick `Web`(!) for the type and set the URL field to `https://<myinstance.sourcegraph.com>/.auth/azuredevops/callback` if your Sourcegraph instance URL is https://myinstance.sourcegraph.com
3. For `Redirect URI` pick `Web`(!) for the type and set the URL field to `https://sourcegraph.example.com/.auth/azuredevops/callback` if your Sourcegraph instance URL is https://sourcegraph.example.com
4. Click **Register**
5. Now go to the [Microsoft Entra admin center](https://entra.microsoft.com/) as at least an **Application Developer**.
6. Go to **App registrations** and select the one you just created.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ Reload after saving changes to see search contexts enabled.
## Steps to convert version contexts to search contexts

1. Log in to your private Sourcegraph instance as a site admin.
2. Navigate to `https://your_sourcegraph_instance.com/contexts`.
2. Navigate to `https://sourcegraph.example.com/contexts`.
3. Press `Convert version contexts`. A list of [existing version contexts](/code-search/features#version-contexts-sunsetting) found in the site configuration will be shown.
4. Convert either all version contexts at once, or specific individual version contexts as desired.
5. Navigate back to `https://your_sourcegraph_instance.com/contexts`. Converted version contexts will be listed.
5. Navigate back to `https://sourcegraph.example.com/contexts`. Converted version contexts will be listed.

Converted search contexts can be used immediately by users on the Sourcegraph instance. The contexts selector will be shown in the search input.

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/how-to/internal-github-repos.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ For example:

### How to check that you now have internal repositories

Confirm that you have cloned repositories in your instance by accessing your GraphQL console on `$your_sourcegraph_url/api/console` and running the following query;
Confirm that you have cloned repositories in your instance by accessing your GraphQL console on `https://sourcegraph.example.com/api/console` and running the following query;

```
query{
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/how-to/manage-feature-flags-with-graphql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Some Sourcegraph instances do not expose the feature flag admin UI. In those cas
- Sign in to your instance:

```bash
src login https://your-sourcegraph-instance.com
src login https://sourcegraph.example.com
```

## List all feature flags
Expand Down
4 changes: 2 additions & 2 deletions docs/admin/how-to/unknown-error-login.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ This document will attempt to identify a common reason for an `Unknown Error` wh

2. This is often a result of an `http/https` protocol mismatch between what is in the site configuration for `externalURL`, and what the user is trying to log in to

- For example, if the protocol in the site configuration is set to `https://sourcegraph.your_instance_name.com`
- And the user is trying to login at the `http://sourcegraph.your_instance_name.com`, then this error can be displayed
- For example, if the protocol in the site configuration is set to `https://sourcegraph.example.com`
- And the user is trying to login at the `http://sourcegraph.example.com`, then this error can be displayed

### Things to check

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/scim.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ To configure:
4. Set up your IdP to use our SCIM API. The API is at

```
https://sourcegraph.company.com/.api/scim/v2/
https://sourcegraph.example.com/.api/scim/v2/
```

## Configuring SCIM for Okta
Expand Down
4 changes: 2 additions & 2 deletions docs/api/mcp/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ If it does not, use [`mcp-remote`](https://www.npmjs.com/package/mcp-remote) as
"command": "npx",
"args": [
"mcp-remote",
"https://your-sourcegraph-instance.com/.api/mcp",
"https://sourcegraph.example.com/.api/mcp",
"3334",
"--static-oauth-client-info",
"{\"client_id\":\"YOUR_CLIENT_ID\"}",
Expand All @@ -64,7 +64,7 @@ If it does not, use [`mcp-remote`](https://www.npmjs.com/package/mcp-remote) as
}
```

Replace `your-sourcegraph-instance.com` with your Sourcegraph instance URL and `YOUR_CLIENT_ID` with the client ID you copied. Start the MCP client and complete authorization in your browser.
Replace `sourcegraph.example.com` with your Sourcegraph instance URL and `YOUR_CLIENT_ID` with the client ID you copied. Start the MCP client and complete authorization in your browser.

## Disable Dynamic Client Registration

Expand Down
16 changes: 8 additions & 8 deletions docs/api/mcp/client-integrations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ You can add the Sourcegraph MCP server to Google Gemini Code Assist by configuri
{
"mcpServers": {
"sourcegraph": {
"httpUrl": "https://your-sourcegraph-instance.com/.api/mcp",
"httpUrl": "https://sourcegraph.example.com/.api/mcp",
"headers": {
"Authorization": "token YOUR_ACCESS_TOKEN"
}
Expand All @@ -206,7 +206,7 @@ You can add the Sourcegraph MCP server to Google Gemini Code Assist by configuri
```

<Callout type="info">
Replace `your-sourcegraph-instance.com` with your Sourcegraph instance
Replace `sourcegraph.example.com` with your Sourcegraph instance
URL and `YOUR_ACCESS_TOKEN` with your access token.
</Callout>

Expand All @@ -222,7 +222,7 @@ You can add the Sourcegraph MCP server to VS Code in one of two ways:
1. Run the following command to add the MCP server to the global configuration

```bash
code --add-mcp "{ \"name\": \"sourcegraph\", \"type\": \"remote\", \"url\": \"https://your-sourcegraph-instance.com/.api/mcp\" }"
code --add-mcp "{ \"name\": \"sourcegraph\", \"type\": \"remote\", \"url\": \"https://sourcegraph.example.com/.api/mcp\" }"
```

2. Launch or restart VS Code to apply the new configuration.
Expand All @@ -237,7 +237,7 @@ code --add-mcp "{ \"name\": \"sourcegraph\", \"type\": \"remote\", \"url\": \"ht
"servers": {
"sourcegraph": {
"type": "http",
"url": "https://your-sourcegraph-instance.com/.api/mcp"
"url": "https://sourcegraph.example.com/.api/mcp"
}
},
"inputs": []
Expand All @@ -256,7 +256,7 @@ code --add-mcp "{ \"name\": \"sourcegraph\", \"type\": \"remote\", \"url\": \"ht
{
"servers": {
"sourcegraph": {
"url": "https://your-sourcegraph-instance.com/.api/mcp",
"url": "https://sourcegraph.example.com/.api/mcp",
"type": "http",
"headers": {
"Authorization": "token YOUR_ACCESS_TOKEN"
Expand All @@ -268,7 +268,7 @@ code --add-mcp "{ \"name\": \"sourcegraph\", \"type\": \"remote\", \"url\": \"ht
```

<Callout type="info">
Replace `your-sourcegraph-instance.com` with your Sourcegraph instance
Replace `sourcegraph.example.com` with your Sourcegraph instance
URL and `YOUR_ACCESS_TOKEN` with your access token.
</Callout>

Expand All @@ -281,7 +281,7 @@ code --add-mcp "{ \"name\": \"sourcegraph\", \"type\": \"remote\", \"url\": \"ht
{
"mcpServers": {
"sourcegraph": {
"serverUrl": "https://your-sourcegraph-instance.com/.api/mcp",
"serverUrl": "https://sourcegraph.example.com/.api/mcp",
"headers": {
"Authorization": "token YOUR_ACCESS_TOKEN",
"Content-Type": "application/json"
Expand All @@ -292,7 +292,7 @@ code --add-mcp "{ \"name\": \"sourcegraph\", \"type\": \"remote\", \"url\": \"ht
```

<Callout type="info">
Replace `your-sourcegraph-instance.com` with your Sourcegraph instance
Replace `sourcegraph.example.com` with your Sourcegraph instance
URL and `YOUR_ACCESS_TOKEN` with your access token.
</Callout>

Expand Down
2 changes: 1 addition & 1 deletion docs/api/mcp/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The MCP server provides different tool suites for various use cases:
Example URL:

```
https://your-sourcegraph-instance.com/.api/mcp
https://sourcegraph.example.com/.api/mcp
```

## Authentication
Expand Down
4 changes: 2 additions & 2 deletions docs/api/stream-api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ putting pressure on the backend.
curl --header "Accept: text/event-stream" \
--header "Authorization: token <access token>" \
--get \
--url "<Sourcegraph URL>/.api/search/stream" \
--url "https://sourcegraph.example.com/.api/search/stream" \
--data-urlencode "q=<query>" \
--data-urlencode "v=<version>" \
--data-urlencode "t=<pattern type>" \
Expand All @@ -33,7 +33,7 @@ curl --header "Accept: text/event-stream" \
curl --header "Accept: text/event-stream" \
--header "Authorization: Bearer <oauth token>" \
--get \
--url "<Sourcegraph URL>/.api/search/stream" \
--url "https://sourcegraph.example.com/.api/search/stream" \
--data-urlencode "q=<query>" \
--data-urlencode "v=<version>" \
--data-urlencode "t=<pattern type>" \
Expand Down
4 changes: 2 additions & 2 deletions docs/batch-changes/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ Next, install the version of `src` that is compatible with your Sourcegraph inst
### For macOS

```bash
curl -L https://<YOUR-SOURCEGRAPH-INSTANCE-URL>/.api/src-cli/src_darwin_amd64 -o /usr/local/bin/src
curl -L https://sourcegraph.example.com/.api/src-cli/src_darwin_amd64 -o /usr/local/bin/src
chmod +x /usr/local/bin/src
```

### For Linux

```bash
curl -L https://<YOUR-SOURCEGRAPH-INSTANCE-URL>/.api/src-cli/src_linux_amd64 -o /usr/local/bin/src
curl -L https://sourcegraph.example.com/.api/src-cli/src_linux_amd64 -o /usr/local/bin/src
chmod +x /usr/local/bin/src
```

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 @@ -30,7 +30,7 @@ importChangesets:
externalIDs: [15397, 15590, 15597, 15583, 15806, 15798]
- repository: github.com/sourcegraph/src-cli
externalIDs: [378, 373, 374, 369, 368, 361, 380]
- repository: bitbucket.sgdev.org/SOUR/vegeta
- repository: bitbucket.example.com/SOUR/vegeta
externalIDs: [8]
- repository: gitlab.sgdev.org/sourcegraph/src-cli
externalIDs: [113, 119]
Expand Down
12 changes: 6 additions & 6 deletions docs/cloud/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,26 +62,26 @@ All of Sourcegraph's features are available on Sourcegraph Cloud instances out-o
### Custom domains

Sourcegraph Cloud provides all customer instances a `customer.sourcegraphcloud.com` domain. This domain is fully managed by Sourcegraph, including DNS and HTTPS.
However, to provide better branding and a more seamless experience for your users, you may bring your own company domain, for example `sourcegraph.company.io`.
However, to provide better branding and a more seamless experience for your users, you may bring your own company domain, for example `sourcegraph.example.com`.

In order to use your own domain, you need to perform an one-time setup by adding DNS records at your authoritative DNS. These DNS records are necessary to ensure that your users can access your Sourcegraph instance via the custom domain, and also to ensure we can provide managed TLS certificates for your instance. See a [list of DNS records to be created by your organization](#dns-records-to-be-created-by-your-organization) below as an example. Additionally, your custom domain's [CAA records](https://blog.cloudflare.com/caa-of-the-wild/) should permit our upstream certificate authorities to issue certificates for your domain, follow the [instructions](#verify-caa-records) below to verify your CAA records.

Please reach out to your Sourcegraph account team to request a custom domain to be configured for your Sourcegraph Cloud instance.

#### DNS records to be created by your organization

Below is a list of the DNS records that are required to be created by your organization. This is for illustrative purposes only, and the actual records will be provided by your Sourcegraph account team. We use `src.acme.com` as an example custom domain.
Below is a list of the DNS records that are required to be created by your organization. This is for illustrative purposes only, and the actual records will be provided by your Sourcegraph account team. We use `sourcegraph.example.com` as an example custom domain.

- `CNAME` record for `src.acme.com` pointing to `acme.sourcegraphcloud.com`
- `TXT` record for `_cf-custom-hostname.src.acme.com` with value `$token`
- `CNAME` record for `_acme-challenge.src.acme.com` pointing to `src.acme.com.$token.dcv.cloudflare.com`
- `CNAME` record for `sourcegraph.example.com` pointing to `example.sourcegraphcloud.com`
- `TXT` record for `_cf-custom-hostname.sourcegraph.example.com` with value `$token`
- `CNAME` record for `_acme-challenge.sourcegraph.example.com` pointing to `sourcegraph.example.com.$token.dcv.cloudflare.com`

#### Verify CAA records

To verify that your CAA records are set correctly, you can use the following command:

```sh
dig acme.com caa +short
dig example.com caa +short
```

If the output is empty, you don't have to do anything. If the output is not empty, and it does not contain `letsencrypt.org` and `pki.goog`, you need to add them to your CAA records to the apex domain.
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/private-connectivity-aws.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Sourcegraph Cloud is a managed service hosted on GCP. Sourcegraph creates a secu

Customers should reach out to their account manager to initiate the process. The account manager will work with the customer to collect the required information and initiate the process, including but not limited to:

- The DNS name of the private code host, e.g. `github.internal.company.net` or private artifact registry, e.g. `artifactory.internal.company.net`.
- The DNS name of the private code host, e.g. `github.internal.example.com` or private artifact registry, e.g. `artifactory.internal.example.com`.
- The region of the private resource on AWS, e.g. `us-east-1`.
- The type of TLS certificate used by the private resource: either self-signed by an internal private CA or issued by a public CA.
- The VPC endpoint service name in the format of `com.amazonaws.vpce.<REGION>.<VPC_ENDPOINT_SERVICE_ID>`. Learn more from [create the VPC Endpoint Service](#create-the-vpc-endpoint-service).
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/private-connectivity-gcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Cross-region connectivity is not supported by Google Cloud for [Private Service

Customers should reach out to their account manager to initiate the process. The account manager will work with the customer to collect the required information and initiate the process, including but not limited to:

- The DNS name of the private code host, e.g., `gitlab.internal.company.net`.
- The DNS name of the private code host, e.g., `gitlab.internal.example.com`.
- The region of the private code host on GCP, e.g., `us-central1`.
- The type of TLS certificate used by the private resource: either self-signed by an internal private CA or issued by a public CA.
- The location of where the TLS connection is terminated, one of the load balancer, or the private code host node.
Expand Down
Loading
Loading