Skip to content

Refine Semgrep proxy information - #2831

Draft
armchairlinguist wants to merge 2 commits into
mainfrom
armchairlinguist/proxy-handling-update
Draft

armchairlinguist wants to merge 2 commits into
mainfrom
armchairlinguist/proxy-handling-update

Conversation

@armchairlinguist

@armchairlinguist armchairlinguist commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

I'm making some changes to proxy handling, and need to reflect that in the docs.

The section title change also makes it clearer that a proxy is used/useful for any outside calls, not just the registry. The only link to this section is in past release notes (Oct 2022) so I haven't updated it but can.

Please ensure:

  • A subject matter expert reviews the content
  • A technical writer reviews the PR
  • This change has no security implications or else you have pinged the security team
  • Check the Mintlify bot preview link on this PR (requires PR to main)

I'm making some changes to proxy handling, and need to reflect that in the docs.
@mintlify

mintlify Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
semgrep-docs 🟢 Ready View Preview Sep 3, 2026, 6:13 PM

Comment thread docs/cli-reference.mdx Outdated
Comment thread docs/cli-reference.mdx
In addition to `.semgrepignore` there are several methods to set up ignore patterns. See [Ignoring files, folders, or code](/ignoring-files-folders-code).

## Connect to Semgrep Registry through a proxy
## Connect to Semgrep Registry and other endpoints through a proxy

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Connect to Semgrep Registry and other endpoints through a proxy
## Connect to Semgrep through a proxy

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wondering if perhaps dropping "Registry and other endpoints" achieves the same goal of making it clear that the proxy applies to all outbound requests.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine either way - the only reason I didn't delete it is that the registry is definitely the most common thing people see in terms of outbound requests.

Co-authored-by: Abhijna Parigi <abhijna@semgrep.com>
Comment thread docs/cli-reference.mdx
export HTTPS_PROXY="http://10.10.1.10:1080"
```

If the proxy environment variables are set but empty, Semgrep treats them as unset and makes direct HTTP requests. If a valid proxy is missing a protocol, Semgrep attempts to add one.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If the proxy environment variables are set but empty, Semgrep treats them as unset and makes direct HTTP requests. If a valid proxy is missing a protocol, Semgrep attempts to add one.
If the proxy environment variables are set but empty, Semgrep treats them as unset and makes direct HTTP requests. If an otherwise-valid proxy value is missing a protocol, Semgrep adds an appropriate protocol.

Waiting to accept this suggestion bc scheme vs protocol is potentially confusing, taking an informal poll :)

This branch was successfully deployed

1 active deployment
staging - docs 56dab6a7 Deployed Sep 3, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants