Docs
Read the manual.
Install the free client, copy over a hard path, or run Farwing Server for tickets, packages, and a portal.
Start
Everyday
Files
Browse folders, upload and download, and send a selection as a package.
docs.farwing.io/files
Packages
Send files already on the server to people without accounts.
docs.farwing.io/packages
Receive links
Let people outside your company send files to a folder you choose.
docs.farwing.io/receive-links
Transfers
See copies in progress and finished, and open one for its result.
docs.farwing.io/transfers
Automation
Hot folders and sync
Send finished files on their own, or copy a folder on a schedule.
docs.farwing.io/hot-folders
Event rules
Run scripts, call webhooks and send messages when files arrive.
docs.farwing.io/event-rules
Adding tools such as ffmpeg
Extend the Farwing image so a rule can run the tools you use.
docs.farwing.io/adding-tools
Server
Install and run
Docker deploy, ports, the setup wizard, storage and TLS.
docs.farwing.io/server
Storage spaces
Where files live, and who can reach each space.
docs.farwing.io/storage-spaces
Fast S3 storage
Keep files in an S3 bucket without giving up transfer speed.
docs.farwing.io/s3-storage
People and sign-in
Accounts, groups, password rules and OpenID Connect.
docs.farwing.io/people
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
Appearance
Your name, logo and color on the sign-in page and recipient pages.
docs.farwing.io/appearance
Email delivery
The mail server invitations, receipts and password resets go through.
docs.farwing.io/email
Customizing emails
Change the wording, layout and languages of every email the server sends.
docs.farwing.io/customizing-emails
Virus scanning
Connect ClamAV, an ICAP scanner or your own command, and set size limits.
docs.farwing.io/virus-scanning
Set up the virus scanner
Run ClamAV beside the server and connect it on the Scanning page.
docs.farwing.io/scanning/clamav
Speed check
Find what limits your server and how to fix it.
docs.farwing.io/speed-check
Monitoring
Prometheus counts for the server, and the traffic usage feed.
docs.farwing.io/metrics
Failover with a standby server
Nightly backups, restore on a standby, and switching by hand.
docs.farwing.io/standby
Plans and licenses
Free limits, Free mode, 30-day trials, requesting and loading a license.
docs.farwing.io/licensing
API
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