Docs
Read the manual.
Install the free client, copy over a hard path, or run Farwing Server for tickets, packages, and a portal.
Getting started
Install, first copy, and a path test in a few minutes.
docs.farwing.io/start
CLI reference
Commands and flags for farwing cp, bench, daemon, and more.
docs.farwing.io/cli
Server admin
Docker deploy, ports, portal setup, storage, and TLS.
docs.farwing.io/server
Failover with a standby server
Nightly backups, restore on a standby, and switching by hand.
docs.farwing.io/standby
Receive links
Let people outside your company send files to a folder you choose.
docs.farwing.io/receive-links
Customizing emails
Change the wording, layout and languages of every email the server sends.
docs.farwing.io/customizing-emails
Event rules
Run scripts, call webhooks and send messages when files arrive.
docs.farwing.io/event-rules
Virus scanning
Connect ClamAV, an ICAP scanner or your own command, and set size limits.
docs.farwing.io/virus-scanning
SAML single sign-on
Sign in with Okta, Microsoft Entra ID, Google Workspace or ADFS.
docs.farwing.io/saml
LDAP and Active Directory
Sign in with directory passwords, with nested groups and an hourly sync.
docs.farwing.io/ldap
Adding tools such as ffmpeg
Extend the Farwing image so a rule can run the tools you use.
docs.farwing.io/adding-tools
Speed check
Find what limits your server and how to fix it.
docs.farwing.io/speed-check
Plans and licenses
Free limits, Free mode, 30-day trials, requesting and loading a license.
docs.farwing.io/licensing
API reference
Create a key, send it, and make a first call.
docs.farwing.io/api
Files and spaces API
List spaces, browse folders, and create, rename, or delete files.
docs.farwing.io/api/files
Transfers API
Issue a ticket, upload or download over HTTPS, and read transfer records.
docs.farwing.io/api/transfers
Packages API
Send files to people without accounts, and see who downloaded them.
docs.farwing.io/api/packages
Receive links API
Create and manage receive links, and the files people send you.
docs.farwing.io/api/receive-links
Automation API
Hot folders, sync jobs, and event rules.
docs.farwing.io/api/automation
Accounts API
The signed-in account, users, and groups.
docs.farwing.io/api/accounts
Administration API
License, audit, email, storage, and the rest of the server settings.
docs.farwing.io/api/administration
Release notes
Where published versions and checksums are listed.
docs.farwing.io/releases