Skip to content

Commit bf47b4d

Browse files
committed
Added comment about http proxy
1 parent 8088616 commit bf47b4d

1 file changed

Lines changed: 13 additions & 9 deletions

File tree

tutorials/cli_and_http_proxy.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -70,23 +70,27 @@ All subsequent CLI commands will now route through the proxy automatically.
7070

7171
## Scope of `--http-proxy`
7272

73-
The `--http-proxy` flag only applies to traffic between the CLI and the Kosli API. Commands that integrate with third-party services (GitHub, GitLab, Jira, SonarCloud/SonarQube, Azure, AWS) use separate HTTP clients that are **not** affected by this flag. To proxy that traffic, set the standard `HTTPS_PROXY` environment variable separately.
73+
The `--http-proxy` flag only applies to traffic between the CLI and the Kosli API. Commands that integrate with third-party services (GitHub, GitLab, Jira, SonarCloud/SonarQube, Azure, AWS) use separate HTTP clients that are **not** affected by this flag. To proxy that traffic, set the standard `HTTPS_PROXY` / `HTTP_PROXY` / `NO_PROXY` environment variables separately.
7474

7575
The table below shows every external endpoint the CLI may contact and how to proxy each one:
7676

7777
| Destination | Endpoint | Commands | Proxy method |
7878
|---|---|---|---|
7979
| Kosli API | `https://app.kosli.com` (configurable via `--host`) | All commands | `--http-proxy` or `HTTPS_PROXY` |
80-
| GitHub | `https://api.github.com` (configurable via `--github-base-url`) | PR/commit attestations | `HTTPS_PROXY` only |
81-
| GitLab | `https://gitlab.com` (configurable via `--gitlab-base-url`) | PR attestations | `HTTPS_PROXY` only |
82-
| Jira | Configured via `--jira-base-url` | Jira attestations | `HTTPS_PROXY` only |
83-
| SonarCloud/SonarQube | `https://sonarcloud.io` (configurable via `--sonar-server-url`) | Sonar attestations | `HTTPS_PROXY` only |
84-
| Azure DevOps | Configured via `--azure-org-url` | Azure PR attestations | `HTTPS_PROXY` only |
85-
| Azure management APIs | Azure ARM/IMDS endpoints | Azure app snapshots | `HTTPS_PROXY` only |
86-
| AWS APIs | Regional AWS endpoints | ECS / Lambda / S3 snapshots | `HTTPS_PROXY` only |
87-
| Container registries | OCI registries (ECR, GCR, DockerHub, etc.) | Artifact fingerprinting (`--artifact-type oci`) | `HTTPS_PROXY` only |
80+
| GitHub | `https://api.github.com` (configurable via `--github-base-url`) | PR/commit attestations | `HTTPS_PROXY` env |
81+
| GitLab | `https://gitlab.com` (configurable via `--gitlab-base-url`) | PR attestations | `HTTPS_PROXY` env |
82+
| Jira | Configured via `--jira-base-url` | Jira attestations | `HTTPS_PROXY` env |
83+
| SonarCloud/SonarQube | `https://sonarcloud.io` (configurable via `--sonar-server-url`) | Sonar attestations | `HTTPS_PROXY` env |
84+
| Azure DevOps | Configured via `--azure-org-url` | Azure PR attestations | `HTTPS_PROXY` env |
85+
| Azure management APIs | Azure ARM/IMDS endpoints | Azure app snapshots | `HTTPS_PROXY` env |
86+
| AWS APIs | Regional AWS endpoints | ECS / Lambda / S3 snapshots | `HTTPS_PROXY` env |
87+
| Container registries | OCI registries (ECR, GCR, DockerHub, etc.) | Artifact fingerprinting (`--artifact-type oci`) | `HTTPS_PROXY` env |
8888
| Kubernetes API server | In-cluster or via kubeconfig | `snapshot k8s` | kubeconfig `proxy-url` or `HTTPS_PROXY` |
8989

90+
### Corporate proxies requiring Kerberos or NTLM
91+
92+
Go's HTTP client only supports Basic authentication for proxies. If your corporate proxy requires Kerberos or NTLM (common in large enterprises), run a local auth-handling proxy such as [cntlm](https://cntlm.sourceforge.net/) or [px](https://github.com/genotrance/px), then point `HTTPS_PROXY` at `http://127.0.0.1:<local-port>`.
93+
9094
## Kubernetes reporter
9195

9296
The `snapshot k8s` command makes two independent outbound connections:

0 commit comments

Comments
 (0)