Add custom package registries documentation #327
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
| The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the custom package registries feature in ToolHive, allowing enterprise users to configure environment variables for private package registries and mirrors. The documentation explains how to set, view, and remove build environment variables that are injected into Dockerfiles during protocol scheme builds.
- Documents three new CLI commands:
thv config set-build-env,get-build-env, andunset-build-env - Provides a reference table of common environment variables for npm, Go, and pip/uv package managers
- Adds troubleshooting guidance for custom registry configuration issues
eleftherias reviewed Nov 27, 2025
Comment on lines 384 to 401
| #### View configured variables | ||
| | ||
| To see all configured build environment variables: | ||
| | ||
| ```bash | ||
| thv config get-build-env | ||
| ``` | ||
| | ||
| To view a specific variable: | ||
| | ||
| ```bash | ||
| thv config get-build-env NPM_CONFIG_REGISTRY | ||
| ``` | ||
| | ||
| #### Remove build environment variables | ||
| | ||
| To remove a specific variable: | ||
| | ||
| ```bash | ||
| thv config unset-build-env NPM_CONFIG_REGISTRY | ||
| ``` | ||
| | ||
| To remove all configured build environment variables: | ||
| | ||
| ```bash | ||
| thv config unset-build-env --all | ||
| ``` | ||
| |
Member
There was a problem hiding this comment.
nit: This probably isn't needed in this section.
JAORMX force-pushed the docs/build-env-config branch from 8ac5613 to abf1ca5 Compare 
Document the build environment configuration feature for custom package registries (toolhive#2742). This allows enterprise environments to configure environment variables like NPM_CONFIG_REGISTRY, GOPROXY, and PIP_INDEX_URL that are injected into Dockerfiles during protocol scheme builds. Adds: - New "Custom package registries" section in build-containers guide - CLI commands: set-build-env, get-build-env, unset-build-env - Table of common environment variables for npm, Go, and pip/uv - Troubleshooting section for custom registry issues 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
JAORMX force-pushed the docs/build-env-config branch from abf1ca5 to 3d1b9b9 Compare eleftherias approved these changes Nov 27, 2025
jhrozek pushed a commit that referenced this pull request Dec 1, 2025
Document the build environment configuration feature for custom package registries (toolhive#2742). This allows enterprise environments to configure environment variables like NPM_CONFIG_REGISTRY, GOPROXY, and PIP_INDEX_URL that are injected into Dockerfiles during protocol scheme builds. Adds: - New "Custom package registries" section in build-containers guide - CLI commands: set-build-env, get-build-env, unset-build-env - Table of common environment variables for npm, Go, and pip/uv - Troubleshooting section for custom registry issues 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Summary
thv config set-build-env,get-build-env,unset-build-envThis allows enterprise environments to configure environment variables like
NPM_CONFIG_REGISTRY,GOPROXY, andPIP_INDEX_URLthat are injected into Dockerfiles during protocol scheme builds.Test plan
npm run buildpassesnpm run prettierpasses🤖 Generated with Claude Code