The Farwing protocol

The Farwing protocol is Farwing's own way of moving files. It is encrypted, checked as it lands, and built for long, lossy networks. When the Transfers page or the CLI says how a file moved, these are the names you will see.

Farwing (UDP)

Farwing's fast protocol. Encrypted, checked, and built for long, lossy networks. Farwing (UDP) uses UDP on the data port (default 47700).

Farwing (TCP)

Farwing's protocol over TCP, used when the network blocks UDP. Slower over long distances. It still uses the same data port and the same encryption and checks as Farwing (UDP).

Farwing (SSH)

Farwing's fast protocol to an SSH place. Each time a hot folder or sync sends to an SSH place, the server signs in over SSH and starts farwing serve there. If Farwing is installed on that host, the file then travels on the data port (default 47700, UDP first, then TCP) with the same encryption and checks as Farwing (UDP). Installing Farwing on the host later is enough: the next transfer uses it. Nothing needs to change on the place.

SSH

Standard secure file transfer over the SSH login of an SSH place. The server uses it when Farwing is not installed on that host, or when its data port cannot be reached. After a failed attempt, the server sends over SSH for a while before it tries Farwing again.

SFTP

Standard secure file transfer to an SFTP place. An SFTP place never tries Farwing. If Farwing is installed on that host, add it as an SSH place instead to send at full speed.

TCP

A standard TCP connection that is not the Farwing protocol. Today this is how FTP and FTPS places are labelled.

HTTPS

  • HTTPS (browser) — uploads and downloads in a web browser, including packages and receive links.
  • HTTPS (cloud storage) — a standard connection to cloud storage such as S3.
  • HTTPS (server) — a standard HTTPS connection between two Farwing servers when the data port is not used.

When each is used

  1. Try Farwing (UDP) on the data port.
  2. If UDP does not get through, try Farwing (TCP) on the same port.
  3. Between hosts that share an SSH login, the CLI can also carry the Farwing protocol through SSH.
  4. Connected Farwing servers fall back to HTTPS (server). SSH places use Farwing (SSH) when Farwing is installed there and SSH when it is not. SFTP places use SFTP. Browser work uses HTTPS (browser).

Firewall rules still name the real UDP and TCP ports. For example: Farwing (UDP) uses UDP port 47700. See Install and run and CLI reference.

Farwing docs · farwing.io