diff --git a/AGENTS.md b/AGENTS.md index c3e779f50..be535fa11 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -40,6 +40,19 @@ Add product names and identifiers to `cspell-allow-list.txt`, in alphabetical order; the check reports out-of-order entries. CSpell is not a project dependency: `npx cspell@10 --no-progress ` to run it locally +- **Placeholder hostnames**: in prose and config samples write + `sourcegraph.example.com` for the reader's instance + (`https://sourcegraph.example.com` where a whole URL is meant) and + `github.example.com` for a code host; never ``, `[hostname]`, or a + `$VARIABLE` the reader has to guess. In a shell snippet a `$VARIABLE` is + fine only when the same snippet exports it with an example value. Example + URLs use `https://`, except loopback, in-cluster, proxy, and XML-namespace + addresses. The `🤖 Sync generated docs` PRs overwrite the + `SCHEMA_SYNC_START`…`SCHEMA_SYNC_END` blocks and whole pages + (`self-hosted/observability/{alerts,dashboards}.mdx`, `cli/references/`, + `ai/models.mdx`, `cody/capabilities/supported-models.mdx`, + `admin/telemetry/`); fix those in sourcegraph/sourcegraph instead. + `git log --author=sourcegraph-buildkite -- ` shows whether a page is one ### Links diff --git a/docs/admin/auth/saml/microsoft-adfs.mdx b/docs/admin/auth/saml/microsoft-adfs.mdx index 95319b158..da716e3e2 100644 --- a/docs/admin/auth/saml/microsoft-adfs.mdx +++ b/docs/admin/auth/saml/microsoft-adfs.mdx @@ -179,7 +179,7 @@ This section covers troubleshooting tips if the following is true: 1. Find the event corresponding to the failed login. This should have Level "Error". The error log message will indicate something about the root cause of the error. A common error -message is `The requested relying party trust '' is unspecified or unsupported`. If this is the +message is `The requested relying party trust 'https://sourcegraph.example.com' is unspecified or unsupported`. If this is the error, double-check the relying party identifiers of the Relying Party Trust entry in ADFS: - Open **AD FS Management**. diff --git a/docs/admin/auth/saml/okta.mdx b/docs/admin/auth/saml/okta.mdx index b7bb1eb6e..7800b6f08 100644 --- a/docs/admin/auth/saml/okta.mdx +++ b/docs/admin/auth/saml/okta.mdx @@ -6,11 +6,11 @@ 2. On the left hand side, click on the “Applications” menu, and then select the “Applications” item. 3. Click on “Create App Integration”. Another screen should pop-up, listing sign-in methods. Choose “SAML 2.0”. Click "Next". 4. You should now see “Create SAML Integration” on this page, and you will be on “General Settings”. Specify a name for “App name” (example: “Sourcegraph”) and the [logo](https://sourcegraphstatic.com/sourcegraph-logo-asterisk-color-1024px.png). Click “Next”. -5. Now you should be on “Configure SAML”. On this page, you will need your Sourcegraph URL (Ex: `https://sourcegraph.example.com`). Follow along with the following instructions, replacing `` with your Sourcegraph URL: +5. Now you should be on “Configure SAML”. On this page, you will need your Sourcegraph URL. Follow along with the following instructions, replacing `https://sourcegraph.example.com` with your Sourcegraph URL: - In section A ("SAML Settings"), under "General": - - For “Single sign on URL”, set the value to ``/.auth/saml/acs + - For “Single sign on URL”, set the value to `https://sourcegraph.example.com/.auth/saml/acs` - Under this box, there should be a checkbox labeled “Use this for Recipient URL and Destination URL”. Check the box if it is not already selected. - - For “Audience URI (SP Entity ID)”, set the value to ``/.auth/saml/metadata + - For “Audience URI (SP Entity ID)”, set the value to `https://sourcegraph.example.com/.auth/saml/metadata` - For "Name ID format", choose "EmailAddress" - In the section titled “Attribute Statements (optional)”: - Set the following Name and Values, leaving the Name format to “Unspecified” diff --git a/docs/admin/auth/saml/one-login.mdx b/docs/admin/auth/saml/one-login.mdx index 0c9eed0a3..7f49136dd 100644 --- a/docs/admin/auth/saml/one-login.mdx +++ b/docs/admin/auth/saml/one-login.mdx @@ -32,7 +32,7 @@ { "type": "saml", "configID": "onelogin", - "identityProviderMetadataURL": "" + "identityProviderMetadataURL": "https://example.onelogin.com/saml/metadata/123456" } ] } diff --git a/docs/admin/config/settings.mdx b/docs/admin/config/settings.mdx index a20cbef5e..c928cf5e8 100644 --- a/docs/admin/config/settings.mdx +++ b/docs/admin/config/settings.mdx @@ -204,7 +204,7 @@ Notices can be added in global, organization, or user settings. The `notices` se ```json "notices": [ { - "message": "Your important message here! [Include a link for more information](http://example.com).", + "message": "Your important message here! [Include a link for more information](https://example.com).", "location": "top", "dismissible": true, "variant": "danger", diff --git a/docs/admin/organizations.mdx b/docs/admin/organizations.mdx index e28be0699..c3fe3719d 100644 --- a/docs/admin/organizations.mdx +++ b/docs/admin/organizations.mdx @@ -2,9 +2,9 @@ Organizations are named groups of users with an associated JSON settings file (with search scopes, saved queries, etc.). These settings take effect for all users who are members of the organization. -To create an organization, go to `http(s)://[hostname]/organizations/new` on your Sourcegraph instance (or, from any page, click your username and then **New organization**). +To create an organization, go to `https://sourcegraph.example.com/organizations/new` on your Sourcegraph instance (or, from any page, click your username and then **New organization**). -You (and any other organization members, and any site admin) may add or remove members from the organization's members page at `http(s)://[hostname]/organizations/[org-name]/members`. +You (and any other organization members, and any site admin) may add or remove members from the organization's members page at `https://sourcegraph.example.com/organizations/[org-name]/members`. To automatically join all users on your instance to a specific organization, create the organization first and then set the `auth.userOrgMap` [site configuration](/admin/config/site-config) option: diff --git a/docs/admin/repo/webhooks.mdx b/docs/admin/repo/webhooks.mdx index 19ad2111b..ca559d51f 100644 --- a/docs/admin/repo/webhooks.mdx +++ b/docs/admin/repo/webhooks.mdx @@ -6,19 +6,23 @@ By default, Sourcegraph polls code hosts to keep repository contents up to date. Polling, however, falls short in cases where immediate updates are desired or when the number of repositories causes significant load on the code host. -To address this, there is a repository update webhook that triggers a repository update on Sourcegraph within minutes. The webhook is authenticated using access tokens (which you can create at e.g. `https://sourcegraph.example.com/site-admin/tokens`). +To address this, there is a repository update webhook endpoint which adds a high priority job to the repo fetch queue. -Here's an example using curl. +The webhook endpoint is authenticated using access tokens which you can create at `https://sourcegraph.example.com/site-admin/tokens` + +Here's an example using curl: ```bash -curl -XPOST -H 'Authorization: token $ACCESS_TOKEN' $SOURCEGRAPH_ORIGIN/.api/repos/$REPO_NAME/-/refresh +curl -XPOST \ + -H 'Authorization: token $SRC_ACCESS_TOKEN' \ + https://sourcegraph.example.com/.api/repos/$REPO_NAME/-/refresh ``` ## Disabling built-in repo updating -Sourcegraph will periodically ask your code-host to list its repositories (e.g. via its HTTP API) to _discover repositories_. You can control how often this occurs by changing [`repoListUpdateInterval`](/admin/config/site-config) in the site config. +Sourcegraph will periodically ask your code host to list its repositories via its HTTP API to _discover repositories_. You can control how often this occurs by changing [`repoListUpdateInterval`](/admin/config/site-config) in the site config. -For repositories that Sourcegraph is already aware of, it will periodically perform background Git repository updates. You can disable this if you wish by setting [`disableAutoGitUpdates`](/admin/config/site-config) to `true`. In which case, the repository will only update when the webhook is used or, e.g., if a user visits the repository directly. This may be desirable in cases where you wish to rely solely on the repository update webhook, for example. +For repositories that Sourcegraph is already aware of, it will periodically perform background git repository updates. You can disable this if needed by setting [`disableAutoGitUpdates`](/admin/config/site-config) to `true`, then the repository will only be updated when the webhook is used or when a user visits the repository directly. ## Code host webhooks diff --git a/docs/analytics/api.mdx b/docs/analytics/api.mdx index 168ea89b8..83f59a0e4 100644 --- a/docs/analytics/api.mdx +++ b/docs/analytics/api.mdx @@ -6,7 +6,7 @@ The Sourcegraph Analytics API is an API that provides programmatic access to you For Sourcegraph Analytics, you can generate an access token for programmatic access. Tokens are long-lived with an optional expiry and have the same permissions to access instance data as the user who created them. -To get started, visit the [Sourcegraph Analytics access tokens management page](http://analytics.sourcegraph.com/access-tokens). From here, you can create, view, and revoke access tokens for your Sourcegraph Account. +To get started, visit the [Sourcegraph Analytics access tokens management page](https://analytics.sourcegraph.com/access-tokens). From here, you can create, view, and revoke access tokens for your Sourcegraph Account. ## API reference diff --git a/docs/batch-changes/how-src-executes-a-batch-spec.mdx b/docs/batch-changes/how-src-executes-a-batch-spec.mdx index fda4a96b0..25e540762 100644 --- a/docs/batch-changes/how-src-executes-a-batch-spec.mdx +++ b/docs/batch-changes/how-src-executes-a-batch-spec.mdx @@ -100,7 +100,7 @@ Downloads the archive of a repository. It's equivalent to: ```bash curl -L -v -X GET -H 'Accept: application/zip' \ -H 'Authorization: token ' \ -'http://sourcegraph.example.com/github.com/my-org/my-repo@refs/heads/master/-/raw' \ +'https://sourcegraph.example.com/github.com/my-org/my-repo@refs/heads/master/-/raw' \ --output ~/tmp/my-repo.zip ``` diff --git a/docs/cli/explanations/env.mdx b/docs/cli/explanations/env.mdx index 875622496..c39917d8c 100644 --- a/docs/cli/explanations/env.mdx +++ b/docs/cli/explanations/env.mdx @@ -58,7 +58,7 @@ If your instance is behind an authenticating proxy that requires additional head Example passing env vars src command: ```bash -SRC_HEADER_AUTHORIZATION="Bearer $(curl http://service.example.com)" SRC_HEADER_EXTRA=metadata src search 'foobar' +SRC_HEADER_AUTHORIZATION="Bearer $(curl https://service.example.com)" SRC_HEADER_EXTRA=metadata src search 'foobar' ``` In the above example, the headers `authorization: Bearer my-generated-token` and `extra: metadata` will be threaded to all HTTP requests to your instance. Multiple such headers can be supplied. diff --git a/docs/code-navigation/auto-indexing.mdx b/docs/code-navigation/auto-indexing.mdx index 2a2fe0b28..5bd9368cb 100644 --- a/docs/code-navigation/auto-indexing.mdx +++ b/docs/code-navigation/auto-indexing.mdx @@ -133,7 +133,7 @@ For auto-indexing jobs to be able to build your projects that use private reposi For Go resolver to access private Git repositories, you need to configure a `NETRC_DATA` secret with the following contents: ```text -machine login password +machine github.example.com login password ``` Under the hood, this information will be used to write the [.netrc](https://www.gnu.org/software/inetutils/manual/html_node/The-_002enetrc-file.html) file that is respected by Git and Go. diff --git a/docs/cody/capabilities/proxy-setup.mdx b/docs/cody/capabilities/proxy-setup.mdx index 38a81ab12..9b163b505 100644 --- a/docs/cody/capabilities/proxy-setup.mdx +++ b/docs/cody/capabilities/proxy-setup.mdx @@ -93,8 +93,8 @@ VS Code supports HTTP, HTTPS, and SOCKS proxies. The `http.proxy` setting in `se ### Using the Proxy with Cody 1. Open Cody settings within your JetBrains IDE -2. Connect to the Sourcegraph instance using the provided instance IP and token: - - **Instance IP:** `http://instance_ip` +2. Connect to the Sourcegraph instance using the provided instance URL and token: + - **Instance URL:** `https://sourcegraph.example.com` - **Token:** `your_token` 3. Click `Apply`, then `OK`, and test the connection @@ -115,10 +115,10 @@ JetBrains supports HTTP and SOCKS proxies. The `Manual Proxy Configuration` in t ### Basic Connectivity Test -To verify that your proxy setup works, use the following `curl` command in your terminal, replacing `proxy_ip` and `instance_ip` with your actual proxy and instance IP addresses: +To verify that your proxy setup works, use the following `curl` command in your terminal, replacing `proxy_ip:port` and `sourcegraph.example.com` with your actual proxy address and instance URL: ```bash -curl -x http://proxy_ip:port http://instance_ip +curl -x http://proxy_ip:port https://sourcegraph.example.com ``` This command should return a response from the instance, confirming that the proxy is correctly routing your requests. diff --git a/docs/cody/clients/install-neovim.mdx b/docs/cody/clients/install-neovim.mdx index d10ff958d..4833ab226 100644 --- a/docs/cody/clients/install-neovim.mdx +++ b/docs/cody/clients/install-neovim.mdx @@ -96,7 +96,7 @@ The `sg.nvim` extension supports the following features for Sourcegraph Search: | **Feature** | **Description** | | ---------------------------- | --------------------------------------------------------------------------------------------- | -| **Read files** | Directly from sourcegraph links: `:edit ` | +| **Read files** | Directly from sourcegraph links: `:edit https://sourcegraph.example.com/github.com/tjdevries/sam.py/-/blob/src/sam.py` | | | Automatically adds protocols for `https://sourcegraph.com/*` links | | | Directly from buffer names `:edit sg://github.com/tjdevries/sam.py/-/src/sam.py` | | **Read non-files** | Repository roots, folders (both expanded and non-expanded), open file from folder | diff --git a/docs/cody/enterprise/model-configuration.mdx b/docs/cody/enterprise/model-configuration.mdx index fc992ec5c..17d47d9bf 100644 --- a/docs/cody/enterprise/model-configuration.mdx +++ b/docs/cody/enterprise/model-configuration.mdx @@ -204,8 +204,8 @@ Sourcegraph natively supports several types of LLM API providers. The current se | `"azureOpenAI"` | [Microsoft Azure OpenAI](https://azure.microsoft.com/en-us/products/ai-services/openai-service/) | | `"anthropic"` | [Anthropic](https://www.anthropic.com) | | `"fireworks"` | [Fireworks AI](https://fireworks.ai) | -| `"google"` | [Google Gemini](http://cloud.google.com/gemini) and [Vertex](https://cloud.google.com/vertex-ai/) | -| `"openai"` | [OpenAI](http://platform.openai.com) | +| `"google"` | [Google Gemini](https://cloud.google.com/gemini) and [Vertex](https://cloud.google.com/vertex-ai/) | +| `"openai"` | [OpenAI](https://platform.openai.com) | | `"huggingface-tgi"` | [Hugging Face Text Generation Interface](https://huggingface.co/docs/text-generation-inference/en/index) | The configuration for `serverSideConfig` varies by provider type. diff --git a/docs/cody/faq.mdx b/docs/cody/faq.mdx index 991c942f5..003b6116d 100644 --- a/docs/cody/faq.mdx +++ b/docs/cody/faq.mdx @@ -198,19 +198,19 @@ Starting June 25, you cannot sign up for new Cody Free or Cody Pro accounts, and If you're a Cody Free user: - You will have access to Cody Free until July 23, 2025. After this, you'll no longer be able to use Cody. -- Instead, you can sign up with Amp and receive **$10 in free credits** at [ampcode.com](http://ampcode.com/). +- Instead, you can sign up with Amp and receive **$10 in free credits** at [ampcode.com](https://ampcode.com/). If you're a Cody Pro user: - You will have access to Cody Pro until July 23, 2025. After this, you'll no longer be able to use Cody. - You **will not be charged for Cody Pro** between now and July 23, 2025. -- Cody Pro customers can sign up with Amp today at [ampcode.com](http://ampcode.com) and receive **$10 in free credits** **plus $30 additional free credits** as a thank you for using Cody Pro. +- Cody Pro customers can sign up with Amp today at [ampcode.com](https://ampcode.com) and receive **$10 in free credits** **plus $30 additional free credits** as a thank you for using Cody Pro. If you're on Enterprise Starter: - Your workspaces will have Cody access until \*July 23, 2025, after which Cody's access will be removed. - Your Enterprise Starter subscription remains fully supported for Code Search, with upcoming improvements like Deep Search. -- Enterprise Starter customers can sign up with Amp today at [ampcode.com](http://ampcode.com) and receive **$10 in free credits** **plus $30 additional free credits** as a thank you for using Enterprise Starter. +- Enterprise Starter customers can sign up with Amp today at [ampcode.com](https://ampcode.com) and receive **$10 in free credits** **plus $30 additional free credits** as a thank you for using Enterprise Starter. If you're an Enterprise user: diff --git a/docs/integration/gitolite.mdx b/docs/integration/gitolite.mdx index 1ac9de9d3..a5a2fc986 100644 --- a/docs/integration/gitolite.mdx +++ b/docs/integration/gitolite.mdx @@ -1,6 +1,6 @@ # Gitolite integration with Sourcegraph -You can use Sourcegraph with [Gitolite](http://gitolite.com/). +You can use Sourcegraph with [Gitolite](https://gitolite.com/). | Feature | Supported? | | ------------------------------------------------------------------- | ---------- | diff --git a/docs/self-hosted/deploy/kubernetes/configure.mdx b/docs/self-hosted/deploy/kubernetes/configure.mdx index 4282bc50a..08c40119a 100644 --- a/docs/self-hosted/deploy/kubernetes/configure.mdx +++ b/docs/self-hosted/deploy/kubernetes/configure.mdx @@ -921,7 +921,7 @@ Learn more about [Google Cloud Platform Firewall rules](https://cloud.google.com Sourcegraph should now be accessible at `$EXTERNAL_ADDR:30080`, where `$EXTERNAL_ADDR` is the address of _any_ node in the cluster. -Learn more about [AWS Security Group rules](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html). +Learn more about [AWS Security Group rules](https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html). ### Rancher Kubernetes Engine @@ -1063,7 +1063,7 @@ Similar changes will be required for other pods and services, depending on the s For optimal performance and resilience, it is recommended to use an external database when deploying Sourcegraph. For more information on database requirements, please refer to the [Postgres guide](/self-hosted/postgres). -To connect Sourcegraph to an existing PostgreSQL instance, add the relevant environment variables ([such as PGHOST, PGPORT, PGUSER, etc.](http://www.postgresql.org/docs/current/static/libpq-envars.html)) to the frontend ConfigMap by adding the new environment variables to the end of the _FRONTEND ENV VARS_ section at the bottom of your [kustomization file](/self-hosted/deploy/kubernetes/kustomize/#kustomizationyaml). For example: +To connect Sourcegraph to an existing PostgreSQL instance, add the relevant environment variables ([such as PGHOST, PGPORT, PGUSER, etc.](https://www.postgresql.org/docs/current/static/libpq-envars.html)) to the frontend ConfigMap by adding the new environment variables to the end of the _FRONTEND ENV VARS_ section at the bottom of your [kustomization file](/self-hosted/deploy/kubernetes/kustomize/#kustomizationyaml). For example: ```yaml # instances/$INSTANCE_NAME/kustomization.yaml @@ -1311,7 +1311,7 @@ components: ## Outbound Traffic -When working with an [Internet Gateway](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Internet_Gateway.html) or VPC it may be necessary to expose ports for outbound network traffic. Sourcegraph must open port 443 for outbound traffic to code hosts, and to enable [telemetry](/admin/pings) with Sourcegraph.com. Port 22 must also be opened to enable git SSH cloning by Sourcegraph. In addition, please make sure to apply other required changes to secure your cluster in a manner that meets your organization's security requirements. +When working with an [Internet Gateway](https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Internet_Gateway.html) or VPC it may be necessary to expose ports for outbound network traffic. Sourcegraph must open port 443 for outbound traffic to code hosts, and to enable [telemetry](/admin/pings) with Sourcegraph.com. Port 22 must also be opened to enable git SSH cloning by Sourcegraph. In addition, please make sure to apply other required changes to secure your cluster in a manner that meets your organization's security requirements. --- diff --git a/docs/self-hosted/deploy/kubernetes/index.mdx b/docs/self-hosted/deploy/kubernetes/index.mdx index bd5eba6e6..b8e6dc7a8 100644 --- a/docs/self-hosted/deploy/kubernetes/index.mdx +++ b/docs/self-hosted/deploy/kubernetes/index.mdx @@ -396,7 +396,7 @@ openTelemetry: gateway: env: JAEGER_HOST: - value: 'http://your.jaeger.endpoint' + value: 'https://jaeger.example.com' config: traces: exporters: @@ -429,7 +429,7 @@ openTelemetry: gateway: env: JAEGER_HOST: - value: 'http://your.jaeger.endpoint' + value: 'https://jaeger.example.com' config: traces: exportersTlsSecretName: otel-collector-exporters-tls diff --git a/docs/self-hosted/email.mdx b/docs/self-hosted/email.mdx index 633240f3c..e976d313a 100644 --- a/docs/self-hosted/email.mdx +++ b/docs/self-hosted/email.mdx @@ -120,7 +120,7 @@ A few helpful tips: - `email.address` is the email Sourcegraph will send email `FROM`. Make sure your account has privilege to send mail from that address. - You should use a TLS/SSL enabled port, either `587` or `2525`. Any port number is allowed, though. - The following `authentication` types are allowed: `PLAIN` (default), `CRAM-MD5`, and `none` -- If a `HELO` domain is required, simply add `"domain": "",` under `email.smtp` +- If a `HELO` domain is required, simply add `"domain": "example.com",` under `email.smtp` - TLS certificate verification can be disabled if your SMTP server does not have a valid TLS cert. To do so, set `"noVerifyTLS": true,` (this is not recommended and may be a security risk) [Send a test email](#sending-a-test-email) to verify it is configured properly. diff --git a/docs/self-hosted/executors/deploy-executors-binary.mdx b/docs/self-hosted/executors/deploy-executors-binary.mdx index 7af6e3f47..257c3bb2c 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.example.com +export EXECUTOR_FRONTEND_URL=https://sourcegraph.example.com export EXECUTOR_FRONTEND_PASSWORD=SUPER_SECRET_SHARED_TOKEN export EXECUTOR_QUEUE_NAMES=batches,batches-hooks,codeintel ``` diff --git a/docs/self-hosted/executors/deploy-executors-terraform-aws.mdx b/docs/self-hosted/executors/deploy-executors-terraform-aws.mdx index fa9d4ce3d..9d032f450 100644 --- a/docs/self-hosted/executors/deploy-executors-terraform-aws.mdx +++ b/docs/self-hosted/executors/deploy-executors-terraform-aws.mdx @@ -34,7 +34,7 @@ module "executors" { availability_zone = "" - executor_sourcegraph_external_url = "" + executor_sourcegraph_external_url = "https://sourcegraph.example.com" executor_sourcegraph_executor_proxy_password = "" # Either a single queue: @@ -139,8 +139,8 @@ The following is a step-by-step guide on provisioning a single `codeintel` execu 3. Expand the **Configuration** section 4. Select **Site configuration** 5. Set the following, - - `"externalURL": ""` - - A URL that is accessible from the EC2 instance (e.g. a public URL such as `https://sourcegraph.example.com`) + - `"externalURL": "https://sourcegraph.example.com"` + - Replace with a URL that is accessible from the EC2 instance - `"executors.accessToken": ""` - Can be generated by running `cat /dev/random | base64 | head -c 20` - The secret will be displayed as `REDACTED` once it's saved. @@ -208,7 +208,7 @@ cat /etc/systemd/system/executor.env Ensure the instance can reach your `externalURL`: ```shell -ubuntu@ip-10-0-1-42:~$ curl +ubuntu@ip-10-0-1-42:~$ curl https://sourcegraph.example.com Found ``` @@ -338,7 +338,7 @@ module "executors" { availability_zone = "" - executor_sourcegraph_external_url = "" + executor_sourcegraph_external_url = "https://sourcegraph.example.com" executor_sourcegraph_executor_proxy_password = "" # Either a single queue: diff --git a/docs/self-hosted/executors/deploy-executors-terraform-gcp.mdx b/docs/self-hosted/executors/deploy-executors-terraform-gcp.mdx index 9926747ad..60ada84d3 100644 --- a/docs/self-hosted/executors/deploy-executors-terraform-gcp.mdx +++ b/docs/self-hosted/executors/deploy-executors-terraform-gcp.mdx @@ -35,7 +35,7 @@ module "executors" { region = "" zone = "" - executor_sourcegraph_external_url = "" + executor_sourcegraph_external_url = "https://sourcegraph.example.com" executor_sourcegraph_executor_proxy_password = "" # Either a single queue: @@ -155,8 +155,8 @@ The following is a step-by-step guide on provisioning a single `codeintel` execu 3. Expand the **Configuration** section 4. Select **Site configuration** 5. Set the following, - - `"externalURL": ""` - - A URL that is accessible from the GCP VM (e.g. a public URL such as `https://sourcegraph.example.com`) + - `"externalURL": "https://sourcegraph.example.com"` + - Replace with a URL that is accessible from the GCP VM - `"executors.accessToken": ""` - Can be generated by running `cat /dev/random | base64 | head -c 20` - The secret will be displayed as `REDACTED` once it's saved. @@ -229,7 +229,7 @@ cat /etc/systemd/system/executor.env Ensure the VM can hit your `externalURL`: ```shell -you@sourcegraph-executor-h0rv:~$ curl +you@sourcegraph-executor-h0rv:~$ curl https://sourcegraph.example.com Found ``` @@ -358,7 +358,7 @@ module "executors" { region = "" zone = "" - executor_sourcegraph_external_url = "" + executor_sourcegraph_external_url = "https://sourcegraph.example.com" executor_sourcegraph_executor_proxy_password = "" # Either a single queue: diff --git a/docs/self-hosted/executors/executors-config.mdx b/docs/self-hosted/executors/executors-config.mdx index 652958139..a5c685291 100644 --- a/docs/self-hosted/executors/executors-config.mdx +++ b/docs/self-hosted/executors/executors-config.mdx @@ -25,7 +25,7 @@ An executor that should handle every job type uses `EXECUTOR_QUEUE_NAMES=batches | Configuration Key | Description | Example value | | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| `EXECUTOR_FRONTEND_URL` | The external URL of the Sourcegraph instance. **required** | `http://sourcegraph.example.com` | +| `EXECUTOR_FRONTEND_URL` | The external URL of the Sourcegraph instance. **required** | `https://sourcegraph.example.com` | | `EXECUTOR_FRONTEND_PASSWORD` | The shared secret configured in the Sourcegraph instance site config under `executors.accessToken`. **required** | `our-shared-secret` | | `EXECUTOR_QUEUE_NAME` | The name of a single queue to pull jobs from. See [Queues](#queues) for possible values. **required: either this or `EXECUTOR_QUEUE_NAMES`** | `codeintel` | | `EXECUTOR_QUEUE_NAMES` | The names of multiple queues to pull jobs from, comma-separated. See [Queues](#queues) for possible values. **required: either this or `EXECUTOR_QUEUE_NAME`** | `batches,batches-hooks` | diff --git a/docs/self-hosted/external-services/postgres.mdx b/docs/self-hosted/external-services/postgres.mdx index 32377ae8b..3736ac318 100644 --- a/docs/self-hosted/external-services/postgres.mdx +++ b/docs/self-hosted/external-services/postgres.mdx @@ -108,7 +108,7 @@ Please refer to our [Postgres](/self-hosted/postgres) documentation to learn abo instead of `PGSSLMODE=require`. Note that this is potentially insecure. -Most standard PostgreSQL environment variables may be specified (`PGPORT`, etc). See http://www.postgresql.org/docs/current/static/libpq-envars.html for a full list. +Most standard PostgreSQL environment variables may be specified (`PGPORT`, etc). See https://www.postgresql.org/docs/current/static/libpq-envars.html for a full list. On Mac/Windows, if trying to connect to a PostgreSQL server on the same host diff --git a/docs/self-hosted/faq.mdx b/docs/self-hosted/faq.mdx index 8f5a2b81a..27076c89d 100644 --- a/docs/self-hosted/faq.mdx +++ b/docs/self-hosted/faq.mdx @@ -96,7 +96,7 @@ frontend: GRAFANA_SERVER_URL: value: https://grafana.example.com PROMETHEUS_URL: - value: http://prometheus.example.com + value: https://prometheus.example.com ``` You can then access your dashboards directly through your Grafana instance URL. diff --git a/docs/self-hosted/observability/alerting-custom-consumption.mdx b/docs/self-hosted/observability/alerting-custom-consumption.mdx index c96ab3c14..97fc0f395 100644 --- a/docs/self-hosted/observability/alerting-custom-consumption.mdx +++ b/docs/self-hosted/observability/alerting-custom-consumption.mdx @@ -19,7 +19,7 @@ sum(max by (service_name,name,description)(max_over_time(alert_count{level="crit Example `curl` query: ```sh -curl 'http://prometheus.example.com/api/v1/query?query=sum%28max%20by%20%28service_name%2Cname%2Cdescription%29%28max_over_time%28alert_count%7Blevel%3D%22critical%22%2Cname%21%3D%22%22%7D%5B1m%5D%29%29%29 +curl 'https://prometheus.example.com/api/v1/query?query=sum%28max%20by%20%28service_name%2Cname%2Cdescription%29%28max_over_time%28alert_count%7Blevel%3D%22critical%22%2Cname%21%3D%22%22%7D%5B1m%5D%29%29%29 ``` Example response: @@ -52,7 +52,7 @@ sum by (service_name)(max by (service_name,name,description)(max_over_time(alert Example `curl` query: ```sh -curl 'http://prometheus.example.com/api/v1/query?query=sum%20by%20%28service_name%29%28max%20by%20%28service_name%2Cname%2Cdescription%29%28max_over_time%28alert_count%7Blevel%3D%22critical%22%2Cname%21%3D%22%22%7D%5B1m%5D%29%29%29' +curl 'https://prometheus.example.com/api/v1/query?query=sum%20by%20%28service_name%29%28max%20by%20%28service_name%2Cname%2Cdescription%29%28max_over_time%28alert_count%7Blevel%3D%22critical%22%2Cname%21%3D%22%22%7D%5B1m%5D%29%29%29' ``` Example response: @@ -100,7 +100,7 @@ max by (service_name,name,description)(max_over_time(alert_count{level="critical Example `curl` query: ```sh -curl 'http://prometheus.example.com/api/v1/query?query=max%20by%20%28service_name%2Cname%2Cdescription%29%28max_over_time%28alert_count%7Blevel%3D%22critical%22%2Cname%21%3D%22%22%7D%5B1m%5D%29%29' +curl 'https://prometheus.example.com/api/v1/query?query=max%20by%20%28service_name%2Cname%2Cdescription%29%28max_over_time%28alert_count%7Blevel%3D%22critical%22%2Cname%21%3D%22%22%7D%5B1m%5D%29%29' ``` Example response: diff --git a/docs/self-hosted/observability/metrics.mdx b/docs/self-hosted/observability/metrics.mdx index 84889df0e..f4a30870f 100644 --- a/docs/self-hosted/observability/metrics.mdx +++ b/docs/self-hosted/observability/metrics.mdx @@ -87,10 +87,10 @@ If Sourcegraph is deployed to a remote server, then access via an SSH tunnel usi To access the remote server using `sshuttle` from your local machine: ```bash -sshuttle -r user@host 0/0 +sshuttle -r user@sourcegraph.example.com 0/0 ``` -Grafana will be available at http://host:3370/-/debug/grafana. +Grafana will be available at http://sourcegraph.example.com:3370/-/debug/grafana. ### Grafana security diff --git a/docs/self-hosted/postgres.mdx b/docs/self-hosted/postgres.mdx index 16aa1c279..42280ce8b 100644 --- a/docs/self-hosted/postgres.mdx +++ b/docs/self-hosted/postgres.mdx @@ -106,7 +106,7 @@ When running an [external PostgreSQL instance](/self-hosted/external-services/po - [Azure DB](https://docs.microsoft.com/en-us/azure/postgresql/concepts-supported-versions#managing-updates-and-upgrades) - [Heroku](https://devcenter.heroku.com/articles/upgrading-heroku-postgres-databases) - [EnterpriseDB](https://www.enterprisedb.com/docs/en/9.6/pg/upgrading.html) -- [Citus](http://docs.citusdata.com/en/v8.1/admin_guide/upgrading_citus.html) +- [Citus](https://docs.citusdata.com/en/v8.1/admin_guide/upgrading_citus.html) - [Aiven PostgreSQL](https://aiven.io/docs/platform/concepts/maintenance-window#related-pages) - [Your own PostgreSQL](https://www.postgresql.org/docs/16/pgupgrade.html) diff --git a/docs/self-hosted/url.mdx b/docs/self-hosted/url.mdx index 3ed05f7a2..1a5bf53f0 100644 --- a/docs/self-hosted/url.mdx +++ b/docs/self-hosted/url.mdx @@ -1,6 +1,6 @@ # Configuring the external URL -It is highly recommended that you do NOT make any of the nodes running Sourcegraph directly accessible to the Internet. Instead, configure an [Internet Gateway](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Internet_Gateway.html) or equivalent to forward traffic to `httpNodePort` or `httpsNodePort` on any of the nodes in your cluster. +It is highly recommended that you do NOT make any of the nodes running Sourcegraph directly accessible to the Internet. Instead, configure an [Internet Gateway](https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Internet_Gateway.html) or equivalent to forward traffic to `httpNodePort` or `httpsNodePort` on any of the nodes in your cluster. When that is done, update your DNS records to point to your gateway's external IP, and change the following line in your [site configuration](/admin/config/site-config):