Documentation

BridgeFile Docs

Everything you need to set up and use BridgeFile for secure file transfers.

Docs available in 繁體中文

Quick Start

Preview the connection and transfer workflow while you wait for the first public release.

1. Join the Launch Waitlist

Public installers are not available yet. Join the waitlist to receive the download link when BridgeFile launches.

Join the BridgeFile waitlist

2. Create a Connection

Open BridgeFile and click "New Connection" in the sidebar. Choose SFTP, FTP, FTPS, or S3 and fill in your details. Credentials are saved securely in your OS keychain.

3. Start Transferring

Once connected, your local files appear on the left and remote files on the right. Drag files between panes, or right-click for Upload, Download, Edit, Compare, and more. Transfers appear in the queue at the bottom with progress, speed, and ETA — resume interrupted transfers at any time.

SFTP Setup

BridgeFile supports full SFTP connections with password or SSH key authentication, including passphrase-protected keys.

Password Authentication

Enter the server hostname, port (default 22), username, and password. The password is stored securely in your OS keychain.

Host:     myserver.example.com
Port:     22
Username: deploy
Auth:     Password (stored in OS keychain)

SSH Key Authentication

Select your private key file. BridgeFile supports OpenSSH, PEM, and PPK key formats. Passphrases are stored alongside the key in your OS keychain.

Host:       production.example.com
Port:       22
Username:   ubuntu
Auth:       SSH Key
Key File:   ~/.ssh/id_ed25519
Passphrase: (optional, stored in keychain)

Advanced Options

  • —Keepalive interval: Send keepalive packets to prevent connection drops (default: 30 seconds).
  • —Connection timeout: Maximum time to wait for a connection (default: 30 seconds).
  • —Default remote path: Initial directory when connecting, e.g. /var/www/html.
  • —Host key verification: BridgeFile remembers host keys and warns if they change.
  • —Transfer compression: Automatic zlib compression is negotiated when the server supports it.

FTP / FTPS Setup

BridgeFile supports plain FTP and FTPS (FTP over TLS) in both implicit and explicit modes, powered by basic-ftp under the hood.

Host:      ftp.example.com
Port:      21        # 990 for implicit FTPS
Username:  uploader
Password:  ********
Use FTPS:  Explicit TLS  (or "Implicit" / "None")

Tip: If your server only advertises self-signed certificates, enable 'Accept unverified TLS' in the connection's Advanced tab. For production systems prefer a properly signed certificate.

S3 Setup (Single-Bucket Mode)

BridgeFile's S3 Single-Bucket Mode lets you work with restricted IAM policies that grant access to a specific bucket and prefix only.

Required IAM Permissions

Your IAM user or role needs only these permissions on the specific bucket — no ListAllMyBuckets required:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "ListOnlyAssignedPrefix",
      "Effect": "Allow",
      "Action": "s3:ListBucket",
      "Resource": "arn:aws:s3:::my-company-assets",
      "Condition": {
        "StringLike": {
          "s3:prefix": [
            "team-a/uploads/*"
          ]
        }
      }
    },
    {
      "Sid": "DenyListingOtherPrefixes",
      "Effect": "Deny",
      "Action": "s3:ListBucket",
      "Resource": "arn:aws:s3:::my-company-assets",
      "Condition": {
        "StringNotLike": {
          "s3:prefix": [
            "team-a/uploads/*"
          ]
        }
      }
    },
    {
      "Sid": "WorkWithAssignedObjects",
      "Effect": "Allow",
      "Action": [
        "s3:GetObject",
        "s3:PutObject",
        "s3:DeleteObject"
      ],
      "Resource": "arn:aws:s3:::my-company-assets/team-a/uploads/*"
    }
  ]
}

Set Prefix to team-a/uploads/ including the trailing slash. Listing requests for the bucket root or another prefix are explicitly denied. Object access outside this prefix is not granted by this example; review other identity and bucket policies for broader grants. This covers basic listing, read, write and delete operations; SSE-KMS, versioned objects and multipart uploads may need additional scoped permissions.

AWS: restrict bucket listing by prefix

Connection Configuration

FieldExampleNotes
Bucketmy-company-assetsThe S3 bucket name
Prefixteam-a/uploads/Optional path prefix
Regionus-east-1AWS region of the bucket
Access KeyAKIA…Stored in OS keychain
Secret Key********Never stored in plaintext

Tip: With Single-Bucket Mode enabled, BridgeFile skips the bucket listing step entirely and connects directly to your configured bucket and prefix.

S3-Compatible Endpoints

Use any S3-compatible service by setting a Custom Endpoint. Tested against MinIO, Cloudflare R2, DigitalOcean Spaces, Backblaze B2, and Wasabi.

Endpoint:  https://<account>.r2.cloudflarestorage.com
Region:    auto
Bucket:    my-r2-bucket
Prefix:    (optional)

Transferring Files

BridgeFile offers multiple ways to move files between local and remote systems, with a resumable queue that tracks progress for every transfer.

  • —Drag & drop: Drag files between the local and remote panes, or from your OS file manager into either pane.
  • —Right-click menu: Upload, Download, Delete, Rename, Edit, Permissions, Compare, Verify Checksum.
  • —Keyboard: Ctrl/Cmd + U to upload, Ctrl/Cmd + D to download, Delete to remove, F2 to rename.
  • —Batch selection: Shift + click for ranges, Ctrl/Cmd + click for individual files.
  • —Resume: Interrupted SFTP and FTP transfers can be resumed from where they stopped.

Multi-Tab Sessions

Open multiple SFTP, FTP, and S3 connections in parallel tabs. Drag tabs to reorder them. Switch with Ctrl/Cmd + Tab. Close the active tab with Ctrl/Cmd + W.

Synchronised browsing: Enable 'Sync navigation' in the connection toolbar to mirror path changes between local and remote panes. Great for structured deploys where folder layouts match.

Site Manager & Groups

The Site Manager in the left sidebar stores every connection profile. Star favourites, organise servers into collapsible groups, and use bookmarks to save frequently accessed remote paths.

  • —Favourites: Pin your most-used servers to the top of the list.
  • —Groups: Nest connections into folders: staging, production, customer-x, etc.
  • —Bookmarks: Save remote paths like /var/www/app/releases to jump there in one click.

Jump Host / SSH Proxy

For SFTP connections behind a bastion / jump host, enable 'Jump Host' in the connection settings. BridgeFile tunnels the SFTP session through the jump host transparently — no manual ProxyCommand config required.

# Target server
Host:      db.internal.example.com
Port:      22
Username:  ops

# Jump host
Proxy Host:      bastion.example.com
Proxy Port:      22
Proxy Username:  alvin
Proxy Password:  (or SSH key)

Remote File Editor

Right-click a remote text file and choose 'Edit' to open it in the built-in editor. Save (Ctrl/Cmd + S) and BridgeFile uploads the changes back atomically. Perfect for quick nginx/env tweaks without round-tripping through scp.

Directory Compare

Open Directory Compare from the right-click menu on any folder. BridgeFile lists files that are missing, newer, or different between local and remote. One-click sync in either direction.

Press Ctrl/Cmd + F inside any pane to search recursively with a glob pattern. Works across SFTP, FTP, and S3. Double-click a result to jump to it.

**/*.log
uploads/2026-*/invoice-*.pdf
node_modules/**/.DS_Store

Checksum Verification

Right-click a file and choose 'Verify Checksum' to compute MD5 or SHA-256 on both local and remote copies. BridgeFile compares the two and shows Match / Mismatch. Use it after large transfers over unreliable networks.

Themes & Language

  • —Theme: Ctrl/Cmd + Shift + T toggles between dark and light mode; or follow OS preference in Settings.
  • —Language: English and 繁體中文 (Traditional Chinese, zh-TW). Switch in Settings (Ctrl/Cmd + ,).
  • —Panels: Drag the centre divider to resize panes; collapse the transfer queue to reclaim space.

Keyboard Shortcuts

On macOS, use Cmd instead of Ctrl. Shortcuts match the authoritative list in the BridgeFile README.

ShortcutAction
Ctrl/Cmd + NNew connection
F5Refresh file list
Ctrl/Cmd + UUpload selected files
Ctrl/Cmd + DDownload selected files
DeleteDelete selected files
F2Rename selected file
Ctrl/Cmd + Shift + NCreate new folder
Ctrl/Cmd + ASelect all files
Ctrl/Cmd + LGo to path (focus address bar)
Ctrl/Cmd + WClose current tab
Ctrl/Cmd + TabSwitch to next tab
Ctrl/Cmd + Shift + TToggle dark / light theme

FAQ

Does BridgeFile support FTP and FTPS?

Yes. BridgeFile v0.1.0 supports SFTP (SSH File Transfer Protocol), plain FTP, and FTPS (FTP over TLS — both implicit and explicit modes), in addition to AWS S3 and S3-compatible services.

Where are my saved credentials stored?

On macOS, credentials are stored in the system Keychain. On Windows, they are stored in Windows Credential Manager. On Linux, BridgeFile uses the Secret Service API (GNOME Keyring, KDE Wallet). Your passwords and SSH passphrases are never saved in plaintext config files.

Can I transfer files larger than 5GB over S3?

Yes. BridgeFile automatically uses S3 multipart uploads for files larger than 100MB, so you can reliably transfer files of any size supported by your bucket.

Does BridgeFile work with S3-compatible storage like MinIO, R2, or Backblaze?

Yes. You can set a custom S3 endpoint URL in the connection settings. BridgeFile works with any S3-compatible API including MinIO, Cloudflare R2, DigitalOcean Spaces, Backblaze B2, and Wasabi.

Is BridgeFile open source?

BridgeFile is source-available under the Business Source License (BSL 1.1). The source code is public on GitHub. Free for personal and non-commercial use. Commercial use requires a Pro or Enterprise license.

Which languages does the app support?

English and Traditional Chinese (zh-TW). You can switch languages in Settings or via Ctrl/Cmd + , . All 266+ UI strings are translated.

Need more help?

Check the GitHub repository for issues and discussions, or reach out to us directly.