docs/Tips-and-Tricks: Include Formulae API in Homebrew caching proxy instructions #21212
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
Contributor
Author
|
In draft until I've proven it works once my Artifactory team livens the formulae API remote for me. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR expands the documentation for configuring Homebrew to use a caching proxy or mirror. The changes add instructions for proxying the Formulae API (in addition to bottles), update the section heading, and include guidance for setting up an internal Git mirror of Homebrew/brew.
Key changes:
- Added configuration instructions for the Formulae API alongside existing bottle caching instructions
- Added the
HOMEBREW_API_DOMAINenvironment variable to the example configuration - Added documentation for using
HOMEBREW_BREW_GIT_REMOTEto mirror the Homebrew/brew repository
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…instructions Expanded section on configuring Homebrew to use a caching proxy or mirror for both bottles and the Formulae API, including setup instructions. Include HOMEBREW_BREW_GIT_REMOTE in caching proxy/mirror instructions. This is specifically _not_ included in the Artifactory example because I cannot confirm that Artifactory can mirror VCS repos itself. It can only act as effectively an API to its refs; it doesn't provide a clone-able URL. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
MikeMcQuaid
approved these changes
Dec 12, 2025
Member
MikeMcQuaid
left a comment
There was a problem hiding this comment.
Thanks! Looks good with a few tweaks.
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
MikeMcQuaid
approved these changes
Dec 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Expanded section on configuring Homebrew to use a caching proxy or mirror for both bottles and the Formulae API, including setup instructions.
brew lgtm(style, typechecking and tests) with your changes locally?