git-annex-updateproxy(1)

💅 git-annex-updateproxy — the glow-up your proxy config deserves

okay bestie, welcome to the git-annex-updateproxy(1) page from the General Commands Manual, and honestly? it's giving "quiet little command that does one specific thing extremely well". let's get into it 🎀

✨ NAME ✨

git-annex-updateproxy — update records with proxy configuration

🌸 SYNOPSIS 🌸

git annex updateproxy

that's it. that's the whole vibe. no flags, no drama, just run it 💅

🦋 DESCRIPTION 🦋

so here's the tea ☕ — a git-annex repository can act as a proxy for its remotes. that means annexed content can be stored and removed from the proxy's remotes by repositories that do not have a direct connection to those remotes. the proxy is basically the main character doing the introvert friends a solid 🫶

By default, no proxying is done. nope, zero, nada, the proxy era has not begun. to configure the local repository to act as a proxy for its remote named "foo", run:

git config remote.foo.annex-proxy true

After setting or unsetting remote.<name>.annex-proxy git configurations, run git-annex updateproxy to record the proxy configuration in the git-annex branch. that's the step that tells other repositories about the proxy configuration — like posting it in the group chat so everyone knows what's up 📣

Suppose, for example, that remote "work" has had this command run in it. Then after pulling from "work", git-annex will know about an additional remote, "work-foo". That remote will be accessed using "work" as a proxy. not me casually spawning a whole new remote through a pull 😭 iconic behavior honestly.

Proxies can only be accessed via ssh or by an annex+http url. that's the vibe check, no other doors are open 🚪✨

To set up proxying to a special remote that is configured with exporttree=yes, its necessary for it to also be configured with annexobjects=yes. And, remote.<name>.annex-tracking-branch needs to be configured to the branch that will be exported to the special remote. When that branch is pushed to the proxy, it will update the tree exported to the special remote. When files are copied to the remote via the proxy, it will also update the exported tree. so many moving parts but they all slay in harmony 🌈

Note that proxying for a special remote can temporarily use disk space in the repository, to temporarily hold the content of annexed files. yes bestie, it needs a lil scratch space for a sec. it's temporary, it's fine, it's just how the magic works 💾

🎀 OPTIONS 🎀

• The git-annex-common-options(1) can be used. so like, the usual suspects apply, no cap 👑

💖 SEE ALSO 💖

• git-annex(1)
• git-annex-updatecluster(1)
• git-annex-export(1)

👑 AUTHOR 👑

Joey Hess <id@joeyh.name> — the legend, the blueprint, the moment fr fr 🫶

and that's the page bestie!! this whole thing lives in the General Commands Manual, and the footer on the original is literally just git-annex-updateproxy(1) — same name, same manual, no extra date energy attached 💜 anyway ily, go configure your proxies, mwah 💋✨