Server

Admin guide.

Farwing Server is the licensed portal: accounts, storage roots, transfer tickets, packages, SSO, and audit. The usual install is Docker Compose on a Linux host with a public IP.

Ports

PortUse
443/tcp or 8443/tcpPortal and HTTPS API (compose file chooses which).
47700/udp and 47700/tcpTransfer data. Required for full speed.
80/tcpOnly if you terminate Let’s Encrypt HTTP-01 on this host.
Cloudflare: keep the data hostname DNS only(grey cloud). Do not orange-proxy UDP 47700.

Two-command deploy

When the published Compose URL is live:

curl -fsSL https://get.farwing.io/compose.yml -o compose.yml
docker compose up -d

Until then, pull from the repository:

curl -fsSL https://raw.githubusercontent.com/lmsilva/farwing/main/deploy/compose/compose.yml -o compose.yml
mkdir -p /srv/files
docker compose up -d

Default image: ghcr.io/lmsilva/server:1 (public package; the git repo stays private). Standard compose serves the portal on8443. The demo compose (deploy/demo/compose.yml) binds the portal on443. Host networking is required.

After the container is up

  1. Open https://<hostname> (or :8443 for the standard compose).
  2. Accept the browser warning if the certificate is still self-signed.
  3. Setup wizard: admin account, hostname, storage root (often /files mapped from /srv/files), licence.
  4. Optional: issue a public certificate and point TLS settings at it, or upload PEMs in Admin → TLS.

Checklist

StepDone when
DNSHostname resolves to the host IP.
Composedocker compose ps shows healthy / running.
PortalSetup or sign-in page loads.
Data portUDP/TCP 47700 reachable from a client.
Ticket copyfarwing cp --ticket … completes.

Related

Farwing docs · farwing.io