git-annex-webapp(1)

📦
version 10.20261026 · 3 versions
, in alpine 3.24, arch rolling, debian trixie, epel 10, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, opensuse-leap 16.0, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ git-annex-webapp ✨

okay bestie, so this is the git-annex-webapp(1) page from the General Commands Manual 💖 and it's literally the cutest little doorway into your whole annex setup, i promise.

🎀 NAME 🎀

git-annex-webapp — launch webapp 🦋

🌸 SYNOPSIS 🌸

git annex webapp

💅 DESCRIPTION 💅

It opens a web app, bestie. And not just any web app — this one lets you do easy setup of a git-annex repository ✨ and gives you control of the git-annex assistant. two for one, we love to see it.

And listen — if the assistant isn't already running? It gets started. no cap. Which means new files are gonna get added and syncing operations are gonna get performed. the webapp just pulls up and starts doing the work. main character energy fr fr 👑

By default, the webapp can only be accessed from localhost, and running it opens a browser window. cozy. local. just you and your repo 🫶

✨ OPTIONS ✨

  • --listen=address — okay so this one is for when you wanna use the webapp on a remote computer. It makes the webapp listen on the specified IP address. (Or on the address that a specified hostname resolves to.) 🌈
heads up: this disables running a local web browser, and instead outputs the url you can use to open the webapp. so you get a link instead of a pop-up, got it? 💌

And if you want the webapp to always listen on an IP address, set annex.listen in the git config. set it once, forget it, iconic.

  • --port=number — use this option to specify a port for the webapp. By default, the webapp picks an unused port. she picks her own, honestly kind of her. 💅

Also the git-annex-common-options(1) can be used. don't sleep on those 🧚

🔐 USING HTTPS 🔐

When using the webapp on a remote computer, you'll almost certainly want to enable HTTPS. like, almost certainly. please. 😭

The webapp will use HTTPS if it finds a .git/annex/privkey.pem and .git/annex/certificate.pem. Here's one way to generate those files, using a self-signed certificate:

openssl genrsa -out .git/annex/privkey.pem 4096
openssl req -new -x509 -key .git/annex/privkey.pem > .git/annex/certificate.pem

two commands, one secure lil webapp. slay 🔥

👀 SEE ALSO 👀

💖 AUTHOR 💖

Joey Hess <id@joeyh.name>

okay that's the whole page, bestie — git-annex-webapp(1), straight outta the General Commands Manual. go launch that webapp, you got this 💜🎀✨

📦 where this page comes from