diff --git a/docs/admin/auth/saml/one-login.mdx b/docs/admin/auth/saml/one-login.mdx index 90671da3e..0c9eed0a3 100644 --- a/docs/admin/auth/saml/one-login.mdx +++ b/docs/admin/auth/saml/one-login.mdx @@ -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): @@ -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 diff --git a/docs/admin/code-hosts/bitbucket-server.mdx b/docs/admin/code-hosts/bitbucket-server.mdx index f6d34d502..f53e68d73 100644 --- a/docs/admin/code-hosts/bitbucket-server.mdx +++ b/docs/admin/code-hosts/bitbucket-server.mdx @@ -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: diff --git a/docs/admin/code-hosts/github.mdx b/docs/admin/code-hosts/github.mdx index a63419b0c..cbe67ed7a 100644 --- a/docs/admin/code-hosts/github.mdx +++ b/docs/admin/code-hosts/github.mdx @@ -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. diff --git a/docs/admin/code-hosts/gitlab.mdx b/docs/admin/code-hosts/gitlab.mdx index 0522c4c83..0064bed93 100644 --- a/docs/admin/code-hosts/gitlab.mdx +++ b/docs/admin/code-hosts/gitlab.mdx @@ -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" // ... } ``` diff --git a/docs/admin/code-hosts/phabricator.mdx b/docs/admin/code-hosts/phabricator.mdx index 38e40ad28..40427dd5f 100644 --- a/docs/admin/code-hosts/phabricator.mdx +++ b/docs/admin/code-hosts/phabricator.mdx @@ -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" // ... } ``` diff --git a/docs/admin/config/authorization-and-authentication.mdx b/docs/admin/config/authorization-and-authentication.mdx index e2976070e..c0392aa3a 100644 --- a/docs/admin/config/authorization-and-authentication.mdx +++ b/docs/admin/config/authorization-and-authentication.mdx @@ -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 { @@ -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:///.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. diff --git a/docs/admin/how-to/converting-version-contexts-to-search-contexts.mdx b/docs/admin/how-to/converting-version-contexts-to-search-contexts.mdx index 850c917c7..af4b27d81 100644 --- a/docs/admin/how-to/converting-version-contexts-to-search-contexts.mdx +++ b/docs/admin/how-to/converting-version-contexts-to-search-contexts.mdx @@ -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. diff --git a/docs/admin/how-to/internal-github-repos.mdx b/docs/admin/how-to/internal-github-repos.mdx index 78ce63ab1..01fea5915 100644 --- a/docs/admin/how-to/internal-github-repos.mdx +++ b/docs/admin/how-to/internal-github-repos.mdx @@ -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{ diff --git a/docs/admin/how-to/manage-feature-flags-with-graphql.mdx b/docs/admin/how-to/manage-feature-flags-with-graphql.mdx index 4a3ce5a88..27f27be56 100644 --- a/docs/admin/how-to/manage-feature-flags-with-graphql.mdx +++ b/docs/admin/how-to/manage-feature-flags-with-graphql.mdx @@ -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 diff --git a/docs/admin/how-to/unknown-error-login.mdx b/docs/admin/how-to/unknown-error-login.mdx index 95bd5d9c5..a64411ff4 100644 --- a/docs/admin/how-to/unknown-error-login.mdx +++ b/docs/admin/how-to/unknown-error-login.mdx @@ -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 diff --git a/docs/admin/scim.mdx b/docs/admin/scim.mdx index de73c43b8..212d7f7dc 100644 --- a/docs/admin/scim.mdx +++ b/docs/admin/scim.mdx @@ -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 diff --git a/docs/api/mcp/authentication.mdx b/docs/api/mcp/authentication.mdx index e7238b06e..877337219 100644 --- a/docs/api/mcp/authentication.mdx +++ b/docs/api/mcp/authentication.mdx @@ -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\"}", @@ -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 diff --git a/docs/api/mcp/client-integrations.mdx b/docs/api/mcp/client-integrations.mdx index ae63571c6..85ee5b377 100644 --- a/docs/api/mcp/client-integrations.mdx +++ b/docs/api/mcp/client-integrations.mdx @@ -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" } @@ -206,7 +206,7 @@ You can add the Sourcegraph MCP server to Google Gemini Code Assist by configuri ``` - 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. @@ -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. @@ -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": [] @@ -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" @@ -268,7 +268,7 @@ code --add-mcp "{ \"name\": \"sourcegraph\", \"type\": \"remote\", \"url\": \"ht ``` - 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. @@ -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" @@ -292,7 +292,7 @@ code --add-mcp "{ \"name\": \"sourcegraph\", \"type\": \"remote\", \"url\": \"ht ``` - 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. diff --git a/docs/api/mcp/index.mdx b/docs/api/mcp/index.mdx index 32ecd48d4..578457c0c 100644 --- a/docs/api/mcp/index.mdx +++ b/docs/api/mcp/index.mdx @@ -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 diff --git a/docs/api/stream-api/index.mdx b/docs/api/stream-api/index.mdx index 86261c829..246d30059 100644 --- a/docs/api/stream-api/index.mdx +++ b/docs/api/stream-api/index.mdx @@ -20,7 +20,7 @@ putting pressure on the backend. curl --header "Accept: text/event-stream" \ --header "Authorization: token " \ --get \ - --url "/.api/search/stream" \ + --url "https://sourcegraph.example.com/.api/search/stream" \ --data-urlencode "q=" \ --data-urlencode "v=" \ --data-urlencode "t=" \ @@ -33,7 +33,7 @@ curl --header "Accept: text/event-stream" \ curl --header "Accept: text/event-stream" \ --header "Authorization: Bearer " \ --get \ - --url "/.api/search/stream" \ + --url "https://sourcegraph.example.com/.api/search/stream" \ --data-urlencode "q=" \ --data-urlencode "v=" \ --data-urlencode "t=" \ diff --git a/docs/batch-changes/quickstart.mdx b/docs/batch-changes/quickstart.mdx index 6e95b65fd..75d9e143b 100644 --- a/docs/batch-changes/quickstart.mdx +++ b/docs/batch-changes/quickstart.mdx @@ -20,14 +20,14 @@ Next, install the version of `src` that is compatible with your Sourcegraph inst ### For macOS ```bash -curl -L https:///.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:///.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 ``` diff --git a/docs/batch-changes/tracking-existing-changesets.mdx b/docs/batch-changes/tracking-existing-changesets.mdx index cfad94d92..8892c66ca 100644 --- a/docs/batch-changes/tracking-existing-changesets.mdx +++ b/docs/batch-changes/tracking-existing-changesets.mdx @@ -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] diff --git a/docs/cloud/index.mdx b/docs/cloud/index.mdx index 04864de2c..7448d9bda 100644 --- a/docs/cloud/index.mdx +++ b/docs/cloud/index.mdx @@ -62,7 +62,7 @@ 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. @@ -70,18 +70,18 @@ Please reach out to your Sourcegraph account team to request a custom domain to #### 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. diff --git a/docs/cloud/private-connectivity-aws.mdx b/docs/cloud/private-connectivity-aws.mdx index fe8531729..d12f58665 100644 --- a/docs/cloud/private-connectivity-aws.mdx +++ b/docs/cloud/private-connectivity-aws.mdx @@ -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..`. Learn more from [create the VPC Endpoint Service](#create-the-vpc-endpoint-service). diff --git a/docs/cloud/private-connectivity-gcp.mdx b/docs/cloud/private-connectivity-gcp.mdx index 3f778f5a0..4c588a7b0 100644 --- a/docs/cloud/private-connectivity-gcp.mdx +++ b/docs/cloud/private-connectivity-gcp.mdx @@ -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. diff --git a/docs/cloud/private-connectivity-public-lb.mdx b/docs/cloud/private-connectivity-public-lb.mdx index eed665b16..35440fc39 100644 --- a/docs/cloud/private-connectivity-public-lb.mdx +++ b/docs/cloud/private-connectivity-public-lb.mdx @@ -28,8 +28,8 @@ Sourcegraph Cloud is a managed service hosted on GCP. Customers will expose priv Customer 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 private DNS name of the private resource, e.g. `github.internal.company.net`. Note: this is the DNS name customer users interact on a daily basis. -- The public DNS name of the network load balancer exposing the private resource, e.g. `github-public-nlb.company.net`. +- The private DNS name of the private resource, e.g. `github.internal.example.com`. Note: this is the DNS name customer users interact on a daily basis. +- The public DNS name of the network load balancer exposing the private resource, e.g. `github-public-nlb.example.com`. Sourcegraph will provide 2 static IPs for customer to allowlist ingress traffic for load balancer. @@ -47,7 +47,7 @@ In the event you need to use a proxy network load balancer or an application (L7 Assuming your private resource is a web service listening at port `443`, you can validate your setup: ```sh -curl --connect-to github.internal.company.net:443:github-public-nlb.company.net:443 https://github.internal.company.net +curl --connect-to github.internal.example.com:443:github-public-nlb.example.com:443 https://github.internal.example.com ``` ### Can I use my internal DNS name for artifact registry? diff --git a/docs/cloud/private-connectivity-sourcegraph-connect.mdx b/docs/cloud/private-connectivity-sourcegraph-connect.mdx index 1292fc0fa..f20770be4 100644 --- a/docs/cloud/private-connectivity-sourcegraph-connect.mdx +++ b/docs/cloud/private-connectivity-sourcegraph-connect.mdx @@ -14,7 +14,7 @@ The customer reaches out to their account manager to request this feature be ena The account manager collects the required information from the customer, including but not limited to: -- The DNS names of the needed private resources (e.g. `gitlab.internal.company.net`, `artifactory.internal.company.net`) +- The DNS names of the needed private resources (e.g. `gitlab.internal.example.com`, `artifactory.internal.example.com`) - The ports of the private resources (e.g. `443`, `80`, `22`) - The type of TLS certificates used by the private resources (e.g. self-signed, internal PKI, or issued by a public CA) diff --git a/docs/code-insights/explanations/data-retention.mdx b/docs/code-insights/explanations/data-retention.mdx index 896b28531..ae3f7a9ea 100644 --- a/docs/code-insights/explanations/data-retention.mdx +++ b/docs/code-insights/explanations/data-retention.mdx @@ -33,7 +33,7 @@ You can download all data for a Code Insight, including data that has been archi ```shell curl \ -H 'Authorization: token {SOURCEGRAPH_TOKEN}' \ -https://yourinstance.sourcegraph.com/.api/insights/export/{YOUR_INSIGHT_ID} -O -J +https://sourcegraph.example.com/.api/insights/export/{YOUR_INSIGHT_ID} -O -J ``` The data will be exported as a CSV file. diff --git a/docs/code-insights/quickstart.mdx b/docs/code-insights/quickstart.mdx index 2f2533c09..649b053a6 100644 --- a/docs/code-insights/quickstart.mdx +++ b/docs/code-insights/quickstart.mdx @@ -36,7 +36,7 @@ If you put this in your organization settings, everyone on your Sourcegraph insi (Enabling code insights organization-wide doesn't mean that other users can automatically see the code insights you create, however – you can control that visibility per individual insight.) -### 2. Visit your example.sourcegraph.com/insights page and select "+ Create insight" +### 2. Visit your sourcegraph.example.com/insights page and select "+ Create insight" ### 3. On the insight type selection page, select "Track changes" @@ -76,7 +76,7 @@ Code insights give you twelve datapoints for each data series on insight creatio ### 8. Click "create code insight" and view your insight. -You'll be taken to the `example.sourcegraph.com/insights` page and can view your insight. +You'll be taken to the `sourcegraph.example.com/insights` page and can view your insight. ### 9. Filter your insight to explore it further diff --git a/docs/code-insights/references/common-reasons-code-insights-may-not-match-search-results.mdx b/docs/code-insights/references/common-reasons-code-insights-may-not-match-search-results.mdx index 315243947..8a29e9f05 100644 --- a/docs/code-insights/references/common-reasons-code-insights-may-not-match-search-results.mdx +++ b/docs/code-insights/references/common-reasons-code-insights-may-not-match-search-results.mdx @@ -46,7 +46,7 @@ query debug { } ``` -where `INSIGHT_ID` can be found in the "edit" page for the insight (selectable from the three-dot dropdown on the insight) after `...edit/`. It will look like `https://yourdomain.sourcegraph.com/insights/edit/INSIGHT_ID?dashboardId=all`. The `INSIGHT_ID` can also be found in the url of the single insight view found by clicking on the title of the insight. The ID will be in the url, for example, `https://sourcegraph.yourdomain.com/insights/insight/{INSIGHT_ID}` +where `INSIGHT_ID` can be found in the "edit" page for the insight (selectable from the three-dot dropdown on the insight) after `...edit/`. It will look like `https://sourcegraph.example.com/insights/edit/INSIGHT_ID?dashboardId=all`. The `INSIGHT_ID` can also be found in the url of the single insight view found by clicking on the title of the insight. The ID will be in the url, for example, `https://sourcegraph.example.com/insights/insight/{INSIGHT_ID}` If there are `failedJobs`, there may be timeouts or similar issues affecting your insight. `insightViewDebug` was added in 4.2 to give you more raw information on your insight. diff --git a/docs/code-navigation/how-to/index-a-go-repository.mdx b/docs/code-navigation/how-to/index-a-go-repository.mdx index f3fa4c720..0be56de8a 100644 --- a/docs/code-navigation/how-to/index-a-go-repository.mdx +++ b/docs/code-navigation/how-to/index-a-go-repository.mdx @@ -86,7 +86,7 @@ go install github.com/sourcegraph/scip-go/cmd/scip-go@latest 2. Upload the data to a Sourcegraph instance with: ```shell -export SRC_ENDPOINT="YOUR_SOURCEGRAPH_URL" +export SRC_ENDPOINT="https://sourcegraph.example.com" export SRC_ACCESS_TOKEN="YOUR_SOURCEGRAPH_API_TOKEN" cd path/to/index.scip diff --git a/docs/code-navigation/how-to/index-other-languages.mdx b/docs/code-navigation/how-to/index-other-languages.mdx index 804ddfb5b..61b03e28f 100644 --- a/docs/code-navigation/how-to/index-other-languages.mdx +++ b/docs/code-navigation/how-to/index-other-languages.mdx @@ -33,7 +33,7 @@ The upload step is the same for all languages. Make sure the current working dir ### To a private Sourcegraph instance (on prem) ```sh -SRC_ENDPOINT=https://sourcegraph.mycompany.com src code-intel upload -file=index.scip +SRC_ENDPOINT=https://sourcegraph.example.com src code-intel upload -file=index.scip ``` ### To cloud based Sourcegraph.com diff --git a/docs/code-search/types/structural.mdx b/docs/code-search/types/structural.mdx index 90f1dc43b..e066adaa1 100644 --- a/docs/code-search/types/structural.mdx +++ b/docs/code-search/types/structural.mdx @@ -130,7 +130,7 @@ Matches all parts of a JSON document that have a member `"exclude"` where the va Structural search behaves differently to plain text search in key ways. We are continually improving the functionality of this new feature, so please note the following: -- **Only indexed repos.** Structural search can currently only be performed on _indexed_ repositories. See [configuration](/admin/search) for more details if you host your own Sourcegraph installation. Our service hosted at [sourcegraph.com](https://sourcegraph.com/search) indexes approximately 200,000 of the most popular repositories on GitHub. Other repositories are currently unsupported. To see whether a repository on your instance is indexed, visit `https://.com/repo-org/repo-name/-/settings/index`. +- **Only indexed repos.** Structural search can currently only be performed on _indexed_ repositories. See [configuration](/admin/search) for more details if you host your own Sourcegraph installation. Our service hosted at [sourcegraph.com](https://sourcegraph.com/search) indexes approximately 200,000 of the most popular repositories on GitHub. Other repositories are currently unsupported. To see whether a repository on your instance is indexed, visit `https://sourcegraph.example.com/repo-org/repo-name/-/settings/index`. - **The `lang` filter is semantically significant.** Adding the `lang` [filter](/code-search/queries) informs the parser about language-specific syntax for comments, strings, and code. This makes structural search more accurate for that language. For example, `fmt.Sprintf(...) lang:go`. If `lang` is omitted, Sourcegraph will attempt a best-effort inference of the language based on matching file extensions or fall back to a generic structural matcher. - **Saved searches are not supported.** It is not currently possible to save structural searches. - **Matching blocks in indentation-sensitive languages.** It's not currently possible to match blocks of code that are indentation-sensitive. This is a feature planned for future work. diff --git a/docs/cody/enterprise/model-configuration.mdx b/docs/cody/enterprise/model-configuration.mdx index 11d66a0a5..fc992ec5c 100644 --- a/docs/cody/enterprise/model-configuration.mdx +++ b/docs/cody/enterprise/model-configuration.mdx @@ -357,7 +357,7 @@ Refer to the [examples page](/cody/enterprise/model-config-examples) for additio To view the current model configuration, run the following command: ```bash -export INSTANCE_URL="https://sourcegraph.test:3443" # Replace with your Sourcegraph instance URL +export INSTANCE_URL="https://sourcegraph.example.com" # Replace with your Sourcegraph instance URL export ACCESS_TOKEN="your access token" curl --location "${INSTANCE_URL}/.api/modelconfig/supported-models.json" \ diff --git a/docs/cody/troubleshooting.mdx b/docs/cody/troubleshooting.mdx index 3baf0c456..deba5d161 100644 --- a/docs/cody/troubleshooting.mdx +++ b/docs/cody/troubleshooting.mdx @@ -139,7 +139,7 @@ Failed to execute 'setItem' on 'Storage': Setting the value of 'user-history:$us This error indicates that the chat history size surpasses the capacity of your browser's local storage. Cody stores comprehensive context data with each chat message, contributing to this limitation. -To fix this, navigate to https://sourcegraph.your-domain.com/cody/chat and click `Clear Chat History` if your instance is on v5.2.3+. For older versions, clear your browsing data or browser history. +To fix this, navigate to https://sourcegraph.example.com/cody/chat and click `Clear Chat History` if your instance is on v5.2.3+. For older versions, clear your browsing data or browser history. ### Record performance traces for Cody diff --git a/docs/deep-search/api.mdx b/docs/deep-search/api.mdx index 7dd199432..884744f28 100644 --- a/docs/deep-search/api.mdx +++ b/docs/deep-search/api.mdx @@ -113,7 +113,7 @@ export SRC_ACCESS_TOKEN="your-token-here" All Deep Search API endpoints are prefixed with `/.api/deepsearch/v1` and require the `X-Requested-With` header to identify the client: ```bash -curl 'https://your-sourcegraph-instance.com/.api/deepsearch/v1' \ +curl 'https://sourcegraph.example.com/.api/deepsearch/v1' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H "Authorization: token $SRC_ACCESS_TOKEN" \ @@ -132,7 +132,7 @@ All Deep Search conversations are processed asynchronously. When you create a co Create a new Deep Search conversation by asking a question: ```bash -curl 'https://your-sourcegraph-instance.com/.api/deepsearch/v1' \ +curl 'https://sourcegraph.example.com/.api/deepsearch/v1' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H "Authorization: token $SRC_ACCESS_TOKEN" \ @@ -178,14 +178,14 @@ The API returns a conversation object with the question initially in `processing "updated_at": "2025-09-24T08:14:06Z", "user_id": 1, "read_token": "caebeb05-7755-4f89-834f-e3ee4a6acb25", - "share_url": "https://your-sourcegraph-instance.com/deepsearch/caebeb05-7755-4f89-834f-e3ee4a6acb25" + "share_url": "https://sourcegraph.example.com/deepsearch/caebeb05-7755-4f89-834f-e3ee4a6acb25" } ``` To get the completed answer, poll the conversation endpoint: ```bash -curl 'https://your-sourcegraph-instance.com/.api/deepsearch/v1/140' \ +curl 'https://sourcegraph.example.com/.api/deepsearch/v1/140' \ -H 'Accept: application/json' \ -H "Authorization: token $SRC_ACCESS_TOKEN" \ -H 'X-Requested-With: my-client 1.0.0' @@ -205,7 +205,7 @@ Once processing is complete, the response will include the answer: "updated_at": "2025-09-24T08:14:15Z", "status": "completed", "title": "GitHub README check", - "answer": "Yes, [github.com/sourcegraph/sourcegraph](https://sourcegraph.test:3443/github.com/sourcegraph/sourcegraph) has a [README.md](https://sourcegraph.test:3443/github.com/sourcegraph/sourcegraph/-/blob/README.md) file in the root directory.", + "answer": "Yes, [github.com/sourcegraph/sourcegraph](https://sourcegraph.example.com/github.com/sourcegraph/sourcegraph) has a [README.md](https://sourcegraph.example.com/github.com/sourcegraph/sourcegraph/-/blob/README.md) file in the root directory.", "sources": [ { "type": "Repository", @@ -240,7 +240,7 @@ Once processing is complete, the response will include the answer: "quota_limit": -1, "reset_time": "2025-10-01T00:00:00Z" }, - "share_url": "https://sourcegraph.test:3443/deepsearch/caebeb05-7755-4f89-834f-e3ee4a6acb25" + "share_url": "https://sourcegraph.example.com/deepsearch/caebeb05-7755-4f89-834f-e3ee4a6acb25" } ``` @@ -249,7 +249,7 @@ Once processing is complete, the response will include the answer: Continue a conversation by adding follow-up questions. The `conversation_id` in the request body must match the conversation ID in the URL: ```bash -curl 'https://your-sourcegraph-instance.com/.api/deepsearch/v1/140/questions' \ +curl 'https://sourcegraph.example.com/.api/deepsearch/v1/140/questions' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H "Authorization: token $SRC_ACCESS_TOKEN" \ @@ -263,13 +263,13 @@ Get all your conversations with optional filtering: ```bash # List all conversations -curl 'https://your-sourcegraph-instance.com/.api/deepsearch/v1' \ +curl 'https://sourcegraph.example.com/.api/deepsearch/v1' \ -H 'Accept: application/json' \ -H "Authorization: token $SRC_ACCESS_TOKEN" \ -H 'X-Requested-With: my-client 1.0.0' # List with pagination and filtering -curl 'https://your-sourcegraph-instance.com/.api/deepsearch/v1?page_first=10&sort=created_at' \ +curl 'https://sourcegraph.example.com/.api/deepsearch/v1?page_first=10&sort=created_at' \ -H 'Accept: application/json' \ -H "Authorization: token $SRC_ACCESS_TOKEN" \ -H 'X-Requested-With: my-client 1.0.0' @@ -290,7 +290,7 @@ Available query parameters: **Get a specific conversation:** ```bash -curl 'https://your-sourcegraph-instance.com/.api/deepsearch/v1/140' \ +curl 'https://sourcegraph.example.com/.api/deepsearch/v1/140' \ -H 'Accept: application/json' \ -H "Authorization: token $SRC_ACCESS_TOKEN" \ -H 'X-Requested-With: my-client 1.0.0' @@ -299,7 +299,7 @@ curl 'https://your-sourcegraph-instance.com/.api/deepsearch/v1/140' \ **Delete a conversation:** ```bash -curl 'https://your-sourcegraph-instance.com/.api/deepsearch/v1/140' \ +curl 'https://sourcegraph.example.com/.api/deepsearch/v1/140' \ -X DELETE \ -H "Authorization: token $SRC_ACCESS_TOKEN" \ -H 'X-Requested-With: my-client 1.0.0' @@ -308,7 +308,7 @@ curl 'https://your-sourcegraph-instance.com/.api/deepsearch/v1/140' \ **Cancel a processing question:** ```bash -curl 'https://your-sourcegraph-instance.com/.api/deepsearch/v1/140/questions/163/cancel' \ +curl 'https://sourcegraph.example.com/.api/deepsearch/v1/140/questions/163/cancel' \ -X POST \ -H 'Accept: application/json' \ -H "Authorization: token $SRC_ACCESS_TOKEN" \ @@ -324,7 +324,7 @@ The read token is also visible in the web client URL and in the `share_url` fiel Note that you can only access other users' conversations via read tokens if sharing is enabled on your Sourcegraph instance. ```bash -curl 'https://your-sourcegraph-instance.com/.api/deepsearch/v1?filter_read_token=5d9aa113-c511-4687-8b71-dbc2dd733c03' \ +curl 'https://sourcegraph.example.com/.api/deepsearch/v1?filter_read_token=5d9aa113-c511-4687-8b71-dbc2dd733c03' \ -H 'Accept: application/json' \ -H "Authorization: token $SRC_ACCESS_TOKEN" \ -H 'X-Requested-With: my-client 1.0.0' diff --git a/docs/integration/bitbucket-server.mdx b/docs/integration/bitbucket-server.mdx index 9c806e9e6..757dc1abb 100644 --- a/docs/integration/bitbucket-server.mdx +++ b/docs/integration/bitbucket-server.mdx @@ -34,7 +34,7 @@ For the Bitbucket Server plugin to then communicate with the Sourcegraph instanc ```json { // ... - "corsOrigin": "https://my-bitbucket.example.com" + "corsOrigin": "https://bitbucket.example.com" // ... } ``` @@ -103,7 +103,7 @@ Sourcegraph's Bitbucket Server / Bitbucket Data Center adds support for webhooks The motivation behind this added functionality is to more efficiently react to updates to Bitbucket Server / Bitbucket Data Center pull requests when using [batch changes](/batch-changes/) by requiring only a single webhook to receive events for hundreds or thousands of pull requests across projects and repositories. -The plugin adds a `/webhook` endpoint that accepts `GET`, `POST` and `DELETE` HTTP request to list, create and delete webhooks respectively. The full URL for this endpoint would be something like `https://your-bbs-instance.example.com/rest/sourcegraph-admin/1.0/webhook`. See the [webhooks README](https://github.com/sourcegraph/bitbucket-server-plugin/blob/master/src/main/java/com/sourcegraph/webhook/README) for detailed information on which payloads this endpoint accepts. +The plugin adds a `/webhook` endpoint that accepts `GET`, `POST` and `DELETE` HTTP request to list, create and delete webhooks respectively. The full URL for this endpoint would be something like `https://bitbucket.example.com/rest/sourcegraph-admin/1.0/webhook`. See the [webhooks README](https://github.com/sourcegraph/bitbucket-server-plugin/blob/master/src/main/java/com/sourcegraph/webhook/README) for detailed information on which payloads this endpoint accepts. Once the plugin is installed it registers an asynchronous listener (see [`WebhookListener.java`](https://github.com/sourcegraph/bitbucket-server-plugin/blob/master/src/main/java/com/sourcegraph/webhook/WebhookListener.java)) that listens to `PullRequestEvent`s and `BuildStatusEvent`s. When an event is dispatched to the listener it checks whether a webhook has been registered for the scope and type of the event and if so, it enqueues the sending of a request to the webhook's endpoint in a thread pool. (See [`WebhookListener.handle`](https://github.com/sourcegraph/bitbucket-server-plugin/blob/master/src/main/java/com/sourcegraph/webhook/WebhookListener.java#L62-L76) and [`Dispatcher.java`](https://github.com/sourcegraph/bitbucket-server-plugin/blob/master/src/main/java/com/sourcegraph/webhook/Dispatcher.java).) diff --git a/docs/self-hosted/deploy/kubernetes/configure.mdx b/docs/self-hosted/deploy/kubernetes/configure.mdx index 40ddd61be..89cb6df8d 100644 --- a/docs/self-hosted/deploy/kubernetes/configure.mdx +++ b/docs/self-hosted/deploy/kubernetes/configure.mdx @@ -705,7 +705,7 @@ Example: # instances/$INSTANCE_NAME/buildConfig.yaml data: # [ACTION] Set values below - TLS_HOST: sourcegraph.company.com + TLS_HOST: sourcegraph.example.com TLS_INGRESS_CLASS_NAME: example-ingress-class-name TLS_CLUSTER_ISSUER: letsencrypt ``` @@ -789,7 +789,7 @@ To configure the hostname for your Sourcegraph ingress, follow these steps: # instances/$INSTANCE_NAME/buildConfig.yaml data: # [ACTION] Set values below - HOST_DOMAIN: sourcegraph.company.com + HOST_DOMAIN: sourcegraph.example.com ``` **Step 2**: Include the hostname component in your components. diff --git a/docs/self-hosted/deploy/kubernetes/index.mdx b/docs/self-hosted/deploy/kubernetes/index.mdx index a517c408d..b2077adb8 100644 --- a/docs/self-hosted/deploy/kubernetes/index.mdx +++ b/docs/self-hosted/deploy/kubernetes/index.mdx @@ -177,7 +177,7 @@ pgsql: enabled: false # Disable internal pgsql database auth: database: 'custom-db' - host: pgsql.database.company.com # External pgsql host + host: pgsql.database.example.com # External pgsql host user: 'new-user' password: 'new-password' port: '5432' @@ -463,7 +463,7 @@ This section is aimed at providing high-level guidance on deploying Sourcegraph - A working Kubernetes cluster, v1.19 or higher - The ability to provision persistent volumes, e.g. have Block Storage [CSI storage driver](https://kubernetes-csi.github.io/docs/drivers.html) installed - An Ingress Controller installed, e.g. platform native ingress controller, [NGINX Ingress Controller]. -- The ability to create DNS records for Sourcegraph, e.g. `sourcegraph.company.com` +- The ability to create DNS records for Sourcegraph, e.g. `sourcegraph.example.com` Sourcegraph uses [Server-Sent Events (SSE)](https://en.wikipedia.org/wiki/Server-sent_events) @@ -558,7 +558,7 @@ It will take around 10 minutes for the load balancer to be fully ready, you may $ kubectl describe ingress sourcegraph-frontend ``` -**Step 3:** – Upon obtaining the allocated IP address of the load balancer, you should create a DNS A record for the `sourcegraph.company.com` domain. Finally, it is recommended to enable TLS and you may consider using [Google-managed certificate](https://cloud.google.com/kubernetes-engine/docs/how-to/managed-certs) in GKE or your own certificate. +**Step 3:** – Upon obtaining the allocated IP address of the load balancer, you should create a DNS A record for the `sourcegraph.example.com` domain. Finally, it is recommended to enable TLS and you may consider using [Google-managed certificate](https://cloud.google.com/kubernetes-engine/docs/how-to/managed-certs) in GKE or your own certificate. If using a GKE manage certificate, add the following annotations to Ingress: @@ -605,7 +605,7 @@ frontend: kubernetes.io/ingress.class: gce tlsSecret: sourcegraph-frontend-tls # reference the created TLS Secret # replace with your actual domain - host: sourcegraph.company.com + host: sourcegraph.example.com ``` **Step 5** – Validate the deployment @@ -660,7 +660,7 @@ frontend: # additional aws alb ingress controller supported annotations # ... # replace with your actual domain - host: sourcegraph.company.com + host: sourcegraph.example.com storageClass: create: true @@ -690,7 +690,7 @@ It will take some time for the load balancer to be fully ready, use the followin $ kubectl describe ingress sourcegraph-frontend ``` -**Step 3:** – Upon obtaining the allocated address of the load balancer, you should create a DNS record for the `sourcegraph.company.com` domain that resolves to the load balancer address. +**Step 3:** – Upon obtaining the allocated address of the load balancer, you should create a DNS record for the `sourcegraph.example.com` domain that resolves to the load balancer address. It is recommended to enable TLS and configure a certificate properly on your load balancer. You may consider using an [AWS-managed certificate](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) and add the following annotations to Ingress. @@ -755,7 +755,7 @@ frontend: # additional azure application gateway supported annotations # ... # replace with your actual domain - host: sourcegraph.company.com + host: sourcegraph.example.com storageClass: create: true @@ -786,7 +786,7 @@ It will take some time for the load balancer to be fully ready, you can check on $ kubectl describe ingress sourcegraph-frontend ``` -**Step 3:** – Upon obtaining the allocated address of the load balancer, you should create a DNS record for the `sourcegraph.company.com` domain that resolves to the load balancer address. +**Step 3:** – Upon obtaining the allocated address of the load balancer, you should create a DNS record for the `sourcegraph.example.com` domain that resolves to the load balancer address. It is recommended to enable TLS and configure the certificate properly on your load balancer. You may consider using an [Azure-managed certificate](https://azure.github.io/application-gateway-kubernetes-ingress/features/appgw-ssl-certificate/) and add the following annotations to Ingress. @@ -848,7 +848,7 @@ frontend: # additional ingress controller supported annotations # ... # replace with your actual domain - host: sourcegraph.company.com + host: sourcegraph.example.com storageClass: create: true @@ -878,7 +878,7 @@ It may take some time before your ingress is up and ready to proceed. Depending $ kubectl describe ingress sourcegraph-frontend ``` -**Step 3:** – You should create a DNS record for the `sourcegraph.company.com` domain that resolves to the Ingress public address. +**Step 3:** – You should create a DNS record for the `sourcegraph.example.com` domain that resolves to the Ingress public address. It is recommended to enable TLS and configure a certificate properly on your Ingress. You can utilize managed certificate solutions provided by Cloud providers, or your own method. @@ -896,7 +896,7 @@ frontend: cert-manager.io/cluster-issuer: letsencrypt # replace with actual cluster-issuer name tlsSecret: sourcegraph-frontend-tls # cert-manager will store the created certificate in this secret. # replace with your actual domain - host: sourcegraph.company.com + host: sourcegraph.example.com ``` You also have the option to manually configure TLS certificate via [TLS Secrets](https://kubernetes.io/docs/concepts/configuration/secret/#tls-secrets). @@ -933,7 +933,7 @@ frontend: # ... tlsSecret: sourcegraph-frontend-tls # reference the created TLS Secret # replace with your actual domain - host: sourcegraph.company.com + host: sourcegraph.example.com ``` **Step 4:** – Validate the deployment diff --git a/docs/self-hosted/email.mdx b/docs/self-hosted/email.mdx index f8b28259f..633240f3c 100644 --- a/docs/self-hosted/email.mdx +++ b/docs/self-hosted/email.mdx @@ -109,7 +109,7 @@ Once you have an SMTP account, simply navigate to your site configuration (e.g. "authentication": "PLAIN", "username": "test@example.com", "password": "", - "host": "smtp-server.example.com", + "host": "smtp.example.com", "port": 587 } } diff --git a/docs/self-hosted/executors/custom-certificates.mdx b/docs/self-hosted/executors/custom-certificates.mdx index 552f7fcec..2d376ee10 100644 --- a/docs/self-hosted/executors/custom-certificates.mdx +++ b/docs/self-hosted/executors/custom-certificates.mdx @@ -49,7 +49,7 @@ the `codeIntelAutoIndexing.indexerMap` to use the custom image. For example, ```json "codeIntelAutoIndexing.indexerMap": { - "go": "myregistry.company.com/scip-go:custom" + "go": "myregistry.example.com/scip-go:custom" } ``` diff --git a/docs/self-hosted/executors/deploy-executors-binary.mdx b/docs/self-hosted/executors/deploy-executors-binary.mdx index e754752ee..8333847eb 100644 --- a/docs/self-hosted/executors/deploy-executors-binary.mdx +++ b/docs/self-hosted/executors/deploy-executors-binary.mdx @@ -92,7 +92,7 @@ See [Executor configuration](/self-hosted/executors/executors-config) for a full ```bash # Example: -export EXECUTOR_FRONTEND_URL=http://sourcegraph.yourcompany.com +export EXECUTOR_FRONTEND_URL=http://sourcegraph.example.com export EXECUTOR_FRONTEND_PASSWORD=SUPER_SECRET_SHARED_TOKEN export EXECUTOR_QUEUE_NAMES=batches,codeintel ``` @@ -154,7 +154,7 @@ EOF # Create environment file (this can also be sourced in your shell) cat </etc/systemd/system/executor.env -EXECUTOR_FRONTEND_URL="https://sourcegraph.yourcompany.com" +EXECUTOR_FRONTEND_URL="https://sourcegraph.example.com" EXECUTOR_FRONTEND_PASSWORD="SUPER_SECRET_SHARED_TOKEN" EXECUTOR_QUEUE_NAMES="batches,codeintel" EOF diff --git a/docs/self-hosted/external-services/postgres.mdx b/docs/self-hosted/external-services/postgres.mdx index ecd3c1ae6..32377ae8b 100644 --- a/docs/self-hosted/external-services/postgres.mdx +++ b/docs/self-hosted/external-services/postgres.mdx @@ -55,12 +55,12 @@ Add the following to your `docker run` command: ```shell docker run [...] --e PGHOST=psql1.mycompany.org +-e PGHOST=psql1.example.com -e PGUSER=sourcegraph -e PGPASSWORD=secret -e PGDATABASE=sourcegraph -e PGSSLMODE=require --e CODEINTEL_PGHOST=psql2.mycompany.org +-e CODEINTEL_PGHOST=psql2.example.com -e CODEINTEL_PGUSER=sourcegraph -e CODEINTEL_PGPASSWORD=secret -e CODEINTEL_PGDATABASE=sourcegraph-codeintel @@ -75,12 +75,12 @@ sourcegraph/server:{CURRENT_VERSION_NO_V} ```yaml sourcegraph-frontend-0: environment: - - 'PGHOST=psql1.mycompany.org' + - 'PGHOST=psql1.example.com' - 'PGUSER=sourcegraph' - 'PGPASSWORD=secret' - 'PGDATABASE=sourcegraph' - 'PGSSLMODE=require' - - 'CODEINTEL_PGHOST=psql2.mycompany.org' + - 'CODEINTEL_PGHOST=psql2.example.com' - 'CODEINTEL_PGUSER=sourcegraph' - 'CODEINTEL_PGPASSWORD=secret' - 'CODEINTEL_PGDATABASE=sourcegraph-codeintel' @@ -169,7 +169,7 @@ Configure the following environment variables for the **`sourcegraph-frontend`** [PgBouncer] is a lightweight connections pooler for PostgreSQL. It allows more clients to connect with the PostgreSQL database without running into connection limits. -When [PgBouncer] is used, we need to include `statement_cache_mode=describe` in the PostgreSQL connection url. This can be done by configuring the `PGDATASOURCE` and `CODEINSIGHTS_PGDATASOURCE` environment variables to `postgres://username:password@pgbouncer.mycompany.com:5432/sg?statement_cache_mode=describe` +When [PgBouncer] is used, we need to include `statement_cache_mode=describe` in the PostgreSQL connection url. This can be done by configuring the `PGDATASOURCE` and `CODEINSIGHTS_PGDATASOURCE` environment variables to `postgres://username:password@pgbouncer.example.com:5432/sg?statement_cache_mode=describe` ### sourcegraph/server @@ -177,8 +177,8 @@ Add the following to your `docker run` command:
 	
-		docker run [...] -e PGDATASOURCE="postgres://username:password@sourcegraph-pgbouncer.mycompany.com:5432/sg?statement_cache_mode=describe"
-		 -e CODEINSIGHTS_PGDATASOURCE="postgres://username:password@sourcegraph-codeintel-pgbouncer.mycompany.com:5432/sg?statement_cache_mode=describe"
+		docker run [...] -e PGDATASOURCE="postgres://username:password@sourcegraph-pgbouncer.example.com:5432/sg?statement_cache_mode=describe"
+		 -e CODEINSIGHTS_PGDATASOURCE="postgres://username:password@sourcegraph-codeintel-pgbouncer.example.com:5432/sg?statement_cache_mode=describe"
 		 sourcegraph/server:
 	
 
@@ -190,8 +190,8 @@ Add the following to your `docker run` command: ```yaml sourcegraph-frontend-0: environment: - - 'PGDATASOURCE=postgres://username:password@sourcegraph-pgbouncer.mycompany.com:5432/sg?statement_cache_mode=describe' - - 'CODEINSIGHTS_PGDATASOURCE=postgres://username:password@sourcegraph-codeintel-pgbouncer.mycompany.com:5432/sg?statement_cache_mode=describe' + - 'PGDATASOURCE=postgres://username:password@sourcegraph-pgbouncer.example.com:5432/sg?statement_cache_mode=describe' + - 'CODEINSIGHTS_PGDATASOURCE=postgres://username:password@sourcegraph-codeintel-pgbouncer.example.com:5432/sg?statement_cache_mode=describe' ``` See ["Environment variables in Compose"](https://docs.docker.com/compose/environment-variables/) for other ways to pass these environment variables to the relevant services (including from the command line, a `.env` file, etc.). @@ -253,7 +253,7 @@ spec: - name: CODEINTEL_PGDATABASE value: sg-codeintel - name: CODEINTEL_PGHOST - value: sourcegraph-codeintel-pgbouncer.mycompany.com + value: sourcegraph-codeintel-pgbouncer.example.com - name: CODEINTEL_PGPORT value: '5432' - name: CODEINTEL_PGSSLMODE diff --git a/docs/self-hosted/external-services/redis.mdx b/docs/self-hosted/external-services/redis.mdx index 393136aab..bd7a47933 100644 --- a/docs/self-hosted/external-services/redis.mdx +++ b/docs/self-hosted/external-services/redis.mdx @@ -11,7 +11,7 @@ or follow the [IANA specification for Redis URLs](https://www.iana.org/assignmen ``` docker run [...] - -e REDIS_ENDPOINT=redis.mycompany.org:6379 + -e REDIS_ENDPOINT=redis.example.com:6379 sourcegraph/server:{CURRENT_VERSION} ``` diff --git a/docs/self-hosted/faq.mdx b/docs/self-hosted/faq.mdx index cf08c73b9..808d3341f 100644 --- a/docs/self-hosted/faq.mdx +++ b/docs/self-hosted/faq.mdx @@ -94,9 +94,9 @@ Ensure your configuration in values.yaml is correct: frontend: env: GRAFANA_SERVER_URL: - value: https://grafana.mycompany.com + value: https://grafana.example.com PROMETHEUS_URL: - value: http://prometheus.mycompany.com + value: http://prometheus.example.com ``` You can then access your dashboards directly through your Grafana instance URL.