Skip to content
Docs0.9GitHubInstall

Running itPublish the apps privately

Publish the apps privately

Make the web client and the iPhone app reach your computer over a tailnet, the Tailscale plugin, or your own reverse proxy, and see what listens where.

How to make the app endpointApp endpoint. The private address your devices connect to. It listens on loopback until you publish it. reachable from your phone and browser without opening it to the internet, for whoever administers the computer. Vendetta listens on loopback only; you put a private HTTPS address in front of it and tell Vendetta what that address is.

The commonest setup is a tailnetTailnet. A private network between your own devices, made with Tailscale. with tailscale serve, below. The Tailscale plugin does the serving for you, and any HTTPS reverse proxy works too.

~/.config/vendetta/config.toml
[plugins.app]
public_url = "wss://workstation.example.ts.net:8743/v1"

public_url is the address your devices use. Pairing codes, QR links, and page links are made from it. The endpoint itself listens on 127.0.0.1:8743 unless listen names another loopback address.

tailscale serve --bg --https=8743 http://127.0.0.1:8743

Tailscale provides the certificate and limits the address to your tailnet.

vendetta app pair

Open https://workstation.example.ts.net:8743/ in a browser and enter the code, or scan the QR in the iPhone app. Connect your phone or browser walks through each screen.

[plugins.tailscale]

Once, so the plugin can run tailscale serve as you:

sudo tailscale set --operator=$USER

The plugin serves the app port, and each person’s, with no tailscale serve line of your own. It changes only the entries it made and never touches another.

On a tagged machine, the plugin also offers the endpoint as a Tailscale Service at its own name on port 443: vendetta-HOST, and vendetta-HOST-NAME for each person, where HOST is this machine’s tailnet name. A name answers only after a tailnet admin has defined its Service and approved this machine as its host. Until then devices keep the port address, and vendetta instance list and People in the apps say what each name waits for.

When a name answers, the worker makes it the address in use: new pairing codes, QR links, page links, and web addresses carry it. The port stays served, so devices paired at it keep working. A name that stops answering goes back to the port.

Plugins has the Service definition, the policy snippet, and the plugin’s settings.

Any reverse proxy that terminates HTTPS and forwards to 127.0.0.1:8743 works. Set public_url to the address it gives you, with the wss:// scheme and the /v1 path:

[plugins.app]
public_url = "wss://vendetta.example.com/v1"

The proxy must:

  • forward the WebSocket upgrade on /v1;
  • forward plain GET and HEAD requests on the same origin, which serve the web client and, under /media/, photos, videos, and audio with byte ranges;
  • let long-lived connections stay open, and not cap WebSocket messages below a few megabytes: uploads travel over the WebSocket in chunks of up to 4 MiB;
  • be reachable only by you. Every connection still needs a paired device, but the proxy decides who can try.

A plugin of your own can take over the exposing job from the Tailscale plugin (the exposes role); see Plugins.

What Listens on Reached by Turned on by
The worker’s control socket A private Unix socket The chooser, plugins, and vendetta commands, as you vendetta notify start
App endpoint: WebSocket /v1, the web client, /media/ 127.0.0.1:8743 Whatever you put in front of it [plugins.app]
Each person’s app endpoint A loopback port of their own, from 8744 The same, per person vendetta instance add
Webhooks: /hooks/NAME 127.0.0.1:8787 Whatever you put in front of it [plugins.webhooks]
Claude and git proxies for machines Unix sockets, one per machine That machine’s container [plugins.claude-proxy]

With no [plugins.app] and no [plugins.webhooks], nothing listens on a TCP port.

vendetta app devices    # list paired devices
vendetta app revoke ID  # disconnect one; its connections close within seconds

Up to 16 devices can be paired. Each browser and each phone is its own device. Revoke a lost one at once.

Webhooks are separate from the apps and usually need to be reachable by a service on the internet. Webhooks covers exposing that port and signing its requests.