WebDAV Guide for Linux

Sync WebDAV for Linux connects WebDAV-compatible apps to Sync through a local server running on your Linux machine, preserving end-to-end encryption.

As a Linux user, you can:

  • Mount your Sync folder or Vault as a network drive.
  • Browse and manage files through your Linux file manager.
  • Sync or back up local folders with tools like Rclone.
  • Automate transfers and backups with scripts or scheduled tasks.
  • Connect a compatible Linux-based NAS to Sync for cloud backups.

In this article:


How to install the WebDAV server

Follow the steps below to install the Sync WebDAV server on your Linux device:

  1. Open Terminal.
    For example, on Ubuntu click the Grid or Ubuntu icon in the dock, and open the Terminal app.
     
  2. Install the Sync WebDAV Server.

    Paste the following install command into Terminal:
    curl -LsSf https://www10.sync.com/download/webdav/install.sh | sh

    If you receive a Curl-related error, run the following commands and then try the installation again:
    sudo apt-get update
    sudo apt install curl
     

  3. Restart Terminal.
    After the installation completes, close the Terminal window completely and then open a new Terminal window. This step is required because the installer creates a command shortcut that becomes available only after Terminal has been restarted.

    If you're using an esoteric distro, you may need to manually add it to your path using this command: 
    export PATH="$HOME/.sync-webdav/bin:$PATH"
    (this example assumes you installed it in your home directory)
     
  4. Sign in to Sync.
    In the new Terminal window, run:
    sync-webdav

    This will open a web authentication step on a local device, or provide an authorization URL if you're using the --headless option. You'll be prompted to sign in with you Sync credentials, then either redirected back to the Terminal window by clicking Open terminal, or, if using the --headless option, from the URL prompted to Copy token and paste it back into the Terminal. 

    Common runtime options: 

    sync-webdav --headless (to install the server remotely)
    sync-webdav --daemon (to run the server in the background)
    sync-webdav --port <number> (default is 4918)
    sync-webdav --mount vault/ (scoped access to Vault, otherwise defaults to Files)
    sync-webdav --allow-from <addresses> (comma separated IPlist, otherwise only accepts connections from localhost)

     

  5. Copy your WebDAV credentials.
    Installation creates separate WebDAV credentials: username sync and a randomly generated password. 

    Save the password shown during installation. and use these credentials when connecting a WebDAV client.

    Note: your Sync email and account password are only used to authorize the WebDAV install and sign in to Sync, NOT to connect to the WebDAV server.
     
  6. Confirm the server is running.
    After successfully signing in, you should see:

    Sync WebDAV Server running at http://127.0.0.1:4918/


Which Linux WebDAV setup should I use?

Once the WebDAV server is installed and running (see the previous section), you can connect virtually any WebDAV-compatible client or tool to access your files in Sync. The best setup depends on what you want to do with your Sync files.

I want to... Recommended solution
Browse and manage Sync files from Ubuntu or GNOME Nautilus (Files)
Browse and manage Sync files from KDE Plasma Dolphin
Mount Sync as a standard Linux filesystem davfs2
Mount Sync as a local drive with more advanced options Rclone mount
Copy or back up a local folder to Sync Rclone copy or sync
Keep a local folder and Sync synchronized in both directions Rclone Bisync
Move files from Dropbox, Google Drive, OneDrive, or another cloud provider to Sync Rclone migration
Create scheduled, versioned backups of a Linux computer Duplicati
Back up a UGREEN NAS to Sync UGREEN Sync & Backup
Back up a QNAP NAS to Sync QNAP Hybrid Backup Sync
Back up a Synology NAS to Sync Synology Hyper Backup

Terminal commands

Use the login and profile commands to sign in, save your Sync session, view saved profiles, or remove a saved session from your device.

Command Description
login [options]  Log in and persist a session for a profile
logout [options]  Remove the stored session for a profile
update Update to the latest published version
credentials [options]  Show, create or replace the WebDAV password clients must use to connect to the server

Command options

Option Short Description
--help - Displays all available commands and options.
--port <0-65535> -p Port to run the WebDAV server on (default: 4918)
--verbose    -v Enable verbose logging
--analytics <true|false>   Enable or disable analytics (default true)
--daemon   Run in background mode
--mount <path> -m Set the root folder for WebDAV requests
Defaults to Files (Sync folder)
Vault mount: --mount vault/
Folder scope: --mount path/to/folder/
--label <string> -l Display name returned to WebDAV clients (default: "Sync Drive")
--profile <name>      Profile name to use (default: "default"). Can be used with credentials command.
--list   Option for login or credentials command that lists all profiles.
--log-file <path>   Enable file logging to the specified path
--config <path> -c Path to an ini config file
--upload-temp-dir <path>     Directory used to spill PUT request bodies during streaming uploads (default: OS temp directory)
--headless   Complete browser sign-in without a loopback listener: print the URL and read the pasted code from stdin (for NAS / container / SSH hosts). Can be used with credentials command.
--reset   Option for credentials, to reset the auto-generated password
--allow-from <list>   Machines allowed to connect (default: this machine only). Comma-separated IP addresses, CIDR blocks (192.168.1.0/24) or ranges (192.168.1.20-192.168.1.31). One entry may cover at most 65536 machines (an IPv4 /16, or an IPv6 /112), in whichever syntax it is written. 'any' allows every machine that can reach the port; 'none' allows this machine only. 

FAQs

How do I submit a bug?

If you encounter an issue while testing WebDAV, please contact the support team and provide as much detail as possible:

  • A description of the issue
  • Steps to reproduce the behavior
  • Any error messages displayed
  • Screenshots or screen recordings, if available
  • Your Linux distribution and version
  • Optional: 
    • Restart the WebDAV server with verbose logging as follows: 
      sync-webdav --verbose --log-file ~/webdav.log
    • Try to replicate the issue and capture logs.

How do I update to the latest WebDAV version?

Run the installer again:
curl -LsSf https://www10.sync.com/download/webdav/install.sh | sh

If Sync WebDAV is already installed, restarting the server will update your existing installation to the latest available version.

Was this article helpful?
14 out of 16 found this helpful