Add GitHub integration recipe (community)#82
Open
tienou wants to merge 2 commits into
Open
Conversation
Author
|
Bumped the recipe to v0.2.0, which adds GitHub App authentication (app_id + private key → auto-refreshed installation tokens): org-owned, read-only, non-expiring credentials instead of personal PATs — the way commercial GitHub backup products authenticate. PAT and anonymous access unchanged. Details in the README. |
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
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.
What
This PR adds a recipe for a new community integration: github — a source connector that backs up all repositories of a GitHub organization or user (or a single repository) as bare git mirrors, i.e. the full history with every branch, tag and ref, plus a JSON dump of each repository's API metadata.
Integration repository: https://github.com/tienou/integration-github (ISC, tagged v0.1.0)
Why
Plakar has connectors for databases, mailboxes, object stores, Notion… but nothing yet for git forges, while « back up our GitHub org » is a very common need (ransomware/offboarding/compliance). This fills that gap with an org-wide, incremental, agent-less approach.
Design highlights
github://<org>orgithub://<org>/<repo>locations; config keys:token(falls back to $GITHUB_TOKEN),api_url(GitHub Enterprise Server support),cache_dir(persistent mirror cache → only new git objects are fetched on subsequent runs),include_forks,include_archived,metadatagitbinary needed at runtime, CGO-free static buildtmp_pack_*,*.lock) are excluded from snapshotsplakar restorethengit push --mirrorgit fsck --stricton every mirrorNotes
checksumuses the same placeholder value as the other community recipes — happy to provide a real sha256 if you tell me what it should cover.PlakarKorp/integrationsmonorepo, I'm happy to send it there instead — just tell me the preferred contribution path.🤖 Generated with Claude Code