Skip to content

Document private Git repository authentication for Registry Server#513

Open
ChrisJBurns wants to merge 5 commits intomainfrom
document-private-git-registry-auth
Open

Document private Git repository authentication for Registry Server#513
ChrisJBurns wants to merge 5 commits intomainfrom
document-private-git-registry-auth

Conversation

@ChrisJBurns
Copy link
Contributor

@ChrisJBurns ChrisJBurns commented Feb 3, 2026

Summary

  • Add documentation for configuring authentication when using private Git repositories as a registry source
  • Document auth.username and auth.passwordFile configuration options
  • Include Kubernetes deployment example showing how to mount secrets for credential management

Closes stacklok/toolhive-registry-server#439

Test plan

  • Verify build passes (npm run build)
  • Review rendered documentation on preview deployment

stacklok/toolhive-registry-server#439

🤖 Generated with Claude Code

Add documentation for configuring authentication when using private Git
repositories as a registry source. Includes configuration options for
username and passwordFile, along with a Kubernetes deployment example
showing how to mount secrets.

Closes stacklok/toolhive-registry-server#439

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings February 3, 2026 17:04
@vercel
Copy link

vercel bot commented Feb 3, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-website Ready Ready Preview, Comment Feb 4, 2026 7:42pm

Request Review

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds documentation describing how to configure authentication when using private Git repositories as a ToolHive Registry Server registry source.

Changes:

  • Documents the git.auth configuration block for private repos, including auth.username and auth.passwordFile.
  • Adds a Kubernetes example demonstrating mounting a Secret and referencing the mounted token file.

Signed-off-by: Chris Burns <29541485+ChrisJBurns@users.noreply.github.com>
Signed-off-by: Chris Burns <29541485+ChrisJBurns@users.noreply.github.com>
danbarr
danbarr previously approved these changes Feb 3, 2026
Comment on lines +188 to +190
- name: data
mountPath: /data
readOnly: false
Copy link
Collaborator

Choose a reason for hiding this comment

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

Side note for future improvement: the /data path is used a bunch of times in this doc, but never actually explained.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've added a note for this 👍 give it a look and let me know what you think

Copy link
Collaborator

@danbarr danbarr Feb 5, 2026

Choose a reason for hiding this comment

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

Hmm, it feels kind of random there (also the grammar is off - "in order to storage").

But looking at it again, I guess this IS the first time mounting a volume as /data is done. This begs the question, why isn't it introduced above in the main "Git repository source" section? Then, having it appear again in the authenticated example would make sense without an extra note.

Is it required (must not be since I don't have it in my config)? If not, why/when use it?

Signed-off-by: Chris Burns <29541485+ChrisJBurns@users.noreply.github.com>
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.

Follow ups on private git-based registries

2 participants