Skip to content

Document Network Broker private key environment variables - #2843

Merged
semgrep-jamie merged 5 commits into
mainfrom
jr/network-broker-private-key-env-var
Sep 21, 2026
Merged

semgrep-jamie merged 5 commits into
mainfrom
jr/network-broker-private-key-env-var

Conversation

@semgrep-jamie

@semgrep-jamie semgrep-jamie commented Sep 19, 2026 •

Copy link
Copy Markdown
Contributor

Sister PR to semgrep/semgrep-network-broker#170, which adds two environment variables for supplying the private key outside the config file:

  • SEMGREP_NETWORK_BROKER_PRIVATE_KEY: the base64 key directly
  • SEMGREP_NETWORK_BROKER_PRIVATE_KEY_PATH: a file containing the key, for mounted secrets

This adds a Provide the private key through the environment section to the Network Broker page, placed after the keypair steps and before the SCM configuration. It covers Docker (env var and mounted file) and Kubernetes (secretKeyRef and mounted secret) examples, precedence rules, and the new 32-byte key length validation.

Thanks for improving Semgrep Docs

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
  • Any redirects are in docs/docs.json if URLs changed
  • If you edited docs/extensions/pre-commit.md.template.mdx, CI regenerates pre-commit.mdx on this PR (no manual run-build-scripts needed)
  • Check the Mintlify bot preview link on this PR (requires PR to main)

@mintlify

mintlify Bot commented Sep 19, 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 21, 2026, 9:41 PM

Covers SEMGREP_NETWORK_BROKER_PRIVATE_KEY and
SEMGREP_NETWORK_BROKER_PRIVATE_KEY_PATH, added in
semgrep/semgrep-network-broker#170, with Docker and Kubernetes examples,
precedence rules and the key length check.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@semgrep-jamie
semgrep-jamie force-pushed the jr/network-broker-private-key-env-var branch from b055f78 to df12caf Compare September 19, 2026 00:22
@semgrep-jamie
semgrep-jamie marked this pull request as ready for review September 19, 2026 15:17
@semgrep-jamie
semgrep-jamie enabled auto-merge (squash) September 19, 2026 18:07

@abhijna abhijna left a comment

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.

@semgrep-jamie I started with inline suggestions, then realized halfway through that it would've been much easier if I'd just made the edits locally. 😅 Sorry for the extra clunkiness! Happy to take another look or redo if necessary.

Comment thread docs/semgrep-ci/network-broker.mdx Outdated
Comment thread docs/semgrep-ci/network-broker.mdx Outdated
Comment thread docs/semgrep-ci/network-broker.mdx Outdated
Comment thread docs/semgrep-ci/network-broker.mdx
Comment thread docs/semgrep-ci/network-broker.mdx Outdated
Comment thread docs/semgrep-ci/network-broker.mdx
Comment thread docs/semgrep-ci/network-broker.mdx Outdated
Comment thread docs/semgrep-ci/network-broker.mdx Outdated
Comment thread docs/semgrep-ci/network-broker.mdx Outdated
Co-authored-by: Abhijna Parigi <abhijna@semgrep.com>
Co-authored-by: Abhijna Parigi <abhijna@semgrep.com>
Define the broker Deployment and link the sample manifest on first
mention, remove a stray numbered fragment and duplicate intro, and
label the two secret-injection options explicitly.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@semgrep-jamie
semgrep-jamie merged commit 1fc3474 into main Sep 21, 2026
5 of 6 checks passed
@semgrep-jamie
semgrep-jamie deleted the jr/network-broker-private-key-env-var branch September 21, 2026 21:41

This branch was successfully deployed

1 active deployment
staging - docs — 4d9067ea Deployed Sep 21, 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