Skip to content

Comments

Document private Git repository authentication for Registry Server#513

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

Document private Git repository authentication for Registry Server#513
ChrisJBurns wants to merge 6 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

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 19, 2026 5:38pm

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.

danbarr
danbarr previously approved these changes Feb 3, 2026
ChrisJBurns and others added 5 commits February 18, 2026 18:26
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>
Signed-off-by: Chris Burns <29541485+ChrisJBurns@users.noreply.github.com>
Signed-off-by: Chris Burns <29541485+ChrisJBurns@users.noreply.github.com>
Signed-off-by: Chris Burns <29541485+ChrisJBurns@users.noreply.github.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
name: git-credentials
type: Opaque
stringData:
token: ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
token: ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
token: <YOUR_GITHUB_TOKEN>

- key: token
path: token
- name: data
emptyDir: {}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Above we recommend a persistent directory, then the example uses emptyDir; maybe add a quick comment here about using a PersistentVolumeClaim in production?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The empty dir is only for a clone which the registry ends up putting into a DB. The PVC in prod may be an overkill as the data is cloned on start up anyways

Copy link
Collaborator

Choose a reason for hiding this comment

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

Should we just nuke the note about it then? Since even the emptyDir was removed from the Helm chart as you found, and based on my environment it seems not necessary at all, I agree it seems overkill.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.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