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
Sync WebDAV runs a local WebDAV server that connects compatible Linux apps and
tools to your encrypted files in Sync.
This article covers only the Sync WebDAV server. After the server is running, see the use-cases table to choose a file manager, mounting, transfer, backup, or NAS configuration. Additionally, you may want to review our quick installer and docker instructions for NAS.
Before you begin, you need a 64-bit Intel/AMD or ARM Linux computer with curl installed. If curl is missing, install it with the command for your distribution (e.g. sudo apt install curl).
1. Install Sync WebDAV
Open Terminal and run the official installer:
curl -LsSf https://www10.sync.com/download/webdav/install.sh | shThe installer downloads the appropriate version for your computer and verifies its checksum before installing it in your home folder.
Close Terminal and open it again, then confirm the installation:
sync-webdav --versionIf the command is not found, make it available in the current Terminal window with this command:
export PATH="$HOME/.sync-webdav/bin:$PATH"2. Sign in to Sync
Sign in and save a default profile:
sync-webdav loginComplete sign-in in the browser window that opens. For an SSH session, NAS, or other computer without a graphical browser, run: sync-webdav login --headless
Note: The login command creates separate credentials for WebDAV clients:
- Username: sync
- Password: the randomly generated password displayed after sign-in
IMPORTANT: Save the generated password when it is displayed. It is NOT your Sync account password, and Sync WebDAV cannot display it again later.
3. Choose foreground or background mode
- Both modes provide the same WebDAV service at http://127.0.0.1:4918
- Complete sign-in before using background mode so the daemon can use the saved profile.
- Do not run both modes at the same time because only one process can use the port.
Run in the foreground
Foreground mode keeps Sync WebDAV attached to the current Terminal window:
sync-webdav --allow-from noneUse foreground mode when first testing the server or troubleshooting it. You can see messages directly in Terminal, and pressing `Ctrl+C` stops the server. Closing the Terminal also stops it.
Run in the background
Background mode detaches Sync WebDAV from Terminal:
sync-webdav --daemon --allow-from noneThe command returns to the prompt while the server continues running.
To see the running background process:
pgrep -a -u "$USER" -x sync-webdavTo stop it:
pkill -TERM -u "$USER" -x sync-webdavBackground mode does not configure automatic startup. You must start it again after restarting the computer. Depending on your Linux session policy, it may also stop when you log out. For automatic startup or an automatically mounted Sync drive, follow the separate automatic Linux setup article.
4. Scope your Sync content to Sync Folder, Vault, or a specific folder
The default command opens access to your Sync Folder.
To scope access to Vault instead:
sync-webdav --mount vault/ --allow-from noneTo scope access to a folder within your Sync Folder:
sync-webdav --mount path/to/folder/ --allow-from noneAdd `--daemon` to either command to run it in the background.
5. Connect a WebDAV client
Configure the client with:
- Server address: http://127.0.0.1:4918
- Username: sync
- Password: the generated WebDAV password saved during sign-in
By default, only clients running on the same computer can connect. To allow a trusted local address or subnet, use --allow-from. For example:
sync-webdav --allow-from 192.168.1.0/24- Remote clients must connect using the Linux computer’s IP address instead of 127.0.0.1.
- WebDAV traffic uses unencrypted HTTP, so only allow trusted local addresses.
- Do not expose port 4918 directly to the internet.
- Run sync-webdav --help to see all accepted address formats.
See here for a list of popular clients.
6. Manage the WebDAV password
Sync WebDAV stores the password securely and cannot display it again. If it is lost, stop the server and create a replacement:
sync-webdav credentials --reset
For a headless computer: sync-webdav credentials --reset --headless
Save the replacement password and update every WebDAV client. The previous password stops working immediately, and the replacement takes effect the next time the server starts.
To remove the saved sign-in session for the default profile without uninstalling Sync WebDAV, stop the server and run:
sync-webdav logout
7. Update Sync WebDAV
Check the installed version, latest published version, and automatic-update setting:
sync-webdav update --statusInstall the latest published version manually:
sync-webdav updateIf the server was already running, stop and restart it to use the new version.
Automatic updates are enabled by default. To change the setting:
sync-webdav update --auto on
sync-webdav update --auto offYou can also rerun the official installer to replace the installed executable with the latest published version:
curl -LsSf https://www10.sync.com/download/webdav/install.sh | shUpdating does not remove the saved profile or change the generated WebDAV password.
8. Uninstall Sync WebDAV
Run the official uninstaller from the same Linux account that installed Sync WebDAV. Do not run it with sudo:
curl -LsSf https://www10.sync.com/download/webdav/install.sh | sh -s -- --uninstallReview the paths displayed by the uninstaller, then confirm when prompted. It:
- Stops Sync WebDAV processes running from the installed executable
- Removes the executable from ~/.sync-webdav
- Removes all standard Sync WebDAV profiles, saved sign-in sessions, generated WebDAV passwords, and settings
- Removes the shell PATH entries added by the installer
Uninstalling does not delete files stored in Sync. It also does not remove credentials saved by WebDAV clients, client bookmarks, Rclone configuration, custom systemd services, or custom paths supplied with --config, --log-file, or --upload-temp-dir.
Open a new Terminal after uninstalling so the PATH change takes effect.
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.
- Restart the WebDAV server with verbose logging as follows:
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.
How do I get the WebDAV server to start automatically and run in the background?
- Follow these instructions: How to start Sync WebDAV automatically on Linux