Docs
Putting Farpane on a computer takes one command from your relay. The longer guides are in the wiki.
Install
Your relay hands out a setup code, good for 24 hours, and the command that uses it. Run it on the computer, as yourself.
Windows
In PowerShell (no administrator needed):
powershell -NoProfile -ExecutionPolicy Bypass -Command "irm https://YOUR-RELAY/install/windows/CODE | iex"
Farpane installs for your account only, starts when you sign in, puts an icon in the tray (who's connected, Stop sharing, Quit) and appears in Settings > Apps.
If you already have the program (from the downloads), farpane setup https://YOUR-RELAY CODE does the same.
Linux
In a terminal in your desktop session, as yourself (not with sudo; the script asks for your password only if something needs installing):
curl -fsSL https://YOUR-RELAY/install/linux/CODE | sh
It starts each time you sign in. On Wayland the desktop asks once whether Farpane may share the screen.
Removing it
- Windows: Settings > Apps > Farpane > Uninstall, or
farpane remove. - Linux:
farpane remove.
Either deletes the program, its settings and its log, and stops it starting at sign-in.
More
- Run a relay: the server, with Docker or on its own, and every setting
- Releases and building: how releases are made, and building it yourself
- Security · Privacy policy · Code signing policy