A tool to mount and browse a Kopia repo using Apple FileProvider
Files
README.md

Overview #

This is a browser for a Kopia repository using Apple FileProvider framework. It permits mounting sub-trees of a repository in both r/o and r/w modes. The r/w mode will push new snapshots to the backing repository reflecting local edits.

See prompts/design.md for all gory details

The consequence: you get a deduplicated encrypted cloud storage scheme where you can pick the backend provider from any backend that Kopia provides. This is not yet a stand-alone project from Kopia: you'll still need to configure a repo and snapshot something with the kopia command.

Contributing #

Patches are welcome with some caveats:

  • Please don't send me AI-written patches. This is very vibey so no need to add more.
  • Human rewrites of obvious slop is welcome but I'd encourage you to not waste your time and make me do that.

Instead:

  • Write issues like the ones in prompts and submit as PRs and I'll make the AI do them if they seem sensible.
  • Or file bugs in the Tangled webapp.

Installation and Use #

Easiest way to get up and running:

  • download latest release
  • copy it to Applications. Should be signed etc.
  • get a Kopia repository token from somewhere else.
  • launch the KopiaBrowser
  • get a token (i.e. kopia repo status -st) and put it in the UI (little icon in the top right of the window)
  • mount a subtree

Issues #

To the best of my knowledge (and testing) (see the issues around reconciliation), FileProvider has an O(n) runtime cost over the n files in the (sub)tree. A mounted tree of 10k files works great. A mounted tree of 6m was unusable. So mount disjoint subtrees of large repositories. All changes to subtrees are (at least suppose to) end up in the same backing domain.

Building without a paid Apple Developer account #

The project owner's builds use a paid Apple Developer Program account (team L3UL39T9CD); the official release (Developer ID signed, notarized, Keychain-backed) needs one. Anyone else can still build and run it from source on their own Mac, with these differences:

  • A free account ("Personal Team": Xcode > Settings > Accounts, sign in with an Apple ID) signs an Apple Development build for that Mac only. It cannot notarize or produce a Developer ID build, and the result will not run on other Macs.
  • Use your own team. Replace DEVELOPMENT_TEAM = L3UL39T9CD in app/KopiaBrowser.xcodeproj/project.pbxproj, and the App Group string L3UL39T9CD.org.liqui.kopiabrowser in app/KopiaBrowser/*.entitlements, app/Provider/*.entitlements, app/Shared/SharedConstants.swift and KeychainBackend.accessGroup (app/KopiaExtension/KeychainBackend.swift). Bundle IDs (org.liqui.*) belong to another team and may need your own prefix.
  • Keychain-only storage (prompts/095). The repository connection (storage credentials and password) lives only in the Keychain, shared between the app and the extension through the keychain-access-groups entitlement; there is no config file and no file fallback. So the app needs that entitlement to hold any repository. Try the default build (make app): whether a free Personal Team's provisioning profile carries keychain-access-groups is unverified. There is no build variant without it.
  • Details and troubleshooting: prompts/runbook.md §8.1.

License #

GPLv3 (see LICENSE), except kopia/ — a vendored copy of the kopia fork this project builds against (prompts/runbook.md §7.1) — which keeps its own Apache License 2.0 (kopia/LICENSE).