Synology Drive Client
Synology Drive Client desktop application is the desktop utility that provides file syncing and personal computer backup service on multiple client computers to a centralized server, Synology Drive Server.
Contents
Before you start
Please note the following:
- Synology Drive Client compatibility, system requirements, and feature specifications can be found in Technical Specifications.
- Before setting up the utility, you need to choose a Synology NAS as the host server and install Synology Drive Server on it.
- To use the file synchronization and management solution offered by Synology Drive Admin Console, Synology Drive, or Synology Drive ShareSync, please sign in with an account belonging to the administrators group of your DSM, and go to Package Center to install the Synology Drive Server package.
Starting Synology Drive Client
Download and install the Synology Drive Client utility from Synology Download Center. Follow the instructions in this section to configure the syncing service provided by Synology Drive.
To launch the Synology Drive Client setup wizard:
- On your Windows computer, go to Start > All Programs > Synology Drive Client.
- On your macOS computer, go to Finder > Applications > Synology Drive Client.
- On your Linux computer, go to Dash > Applications > Synology Drive Client.
- Click Start Now and select Sync Task or Backup Task from the wizard to get started.
Configuring Your Sync Tasks
You may create sync tasks to sync files between Synology Drive and multiple computers to enhance productivity and file accessibility.
To create a sync task:
- Enter the IP address or QuickConnect ID, username, and password of your Synology NAS. For domain users, use your domain name or username to sign in. For LDAP users, use "username@Base_DN" to sign in. You can also connect via IPv6 or proxy service. Click Next.
- If you are unable to connect to your Synology NAS, please make sure you have installed Synology Drive Server and check the Internet connection, or go to Global Settings to configure the proxy.
- You can also click the search icon on the right, and Synology Drive Client will automatically search for Synology NAS devices within your LAN.
- Select Sync Task and click Next.
- Check the path of the local and remote folders you wish to sync. You may click Change to select different folders for syncing.
- For Windows 10 computers, you may decide whether to Enable On-demand Sync to reduce computer capacity consumption and overhead on the server. For more information, please visit this FAQ.
- You may click Advanced to further modify the following sync settings:
- You may specify folders and files you don't want to sync in Folder and File Filter:
- Max file size: Any files larger than the size specified here will not be synced.
- File name: Any file with the designated file name will not be synced.
- File extension: Any designated file extension will not be synced. Add *.extension to the table, e.g., *.iso.
- You may configure the advanced sync options in Sync Mode.
- Sync direction may be two-way sync, one-way data download from the server, or one-way upload. You can later change this configuration in Sync Rules > Sync Mode by clicking on the task.
- For One-way upload tasks, untick Keep locally deleted files on the server if you wish to also delete the items on the server when they are deleted on the computer.
- For Windows 10 computers, you may decide whether to Enable On-demand Sync to reduce computer capacity consumption and overhead on the server.
- You may choose to untick Enable advanced consistency check to reduce the time and system resources required in file comparison. This lowers the accuracy of file comparison.
- Click Done to save the settings.
Note:
- To find your QuickConnect ID, sign in to DSM using an account belonging to the administrators group, and go to Control Panel > External Access > QuickConnect (for DSM 7.0 or above) or Control Panel > QuickConnect (for DSM 6.2 or earlier) to check the information.
- If you are unable to connect to the Synology NAS or authorize the connection with your user credentials, check your network settings, and make sure your access to Synology Drive has been enabled by your DSM administrator at Control Panel > Applications Privileges (for DSM 7.0 or above) or Privileges (for DSM 6.2 or earlier) > Synology Drive.
- If you have read-only permission for a remote Team Folder, you can only configure a download-only task, meaning that any changes you make in the local folder will not be synced to Synology Drive. Only accounts with read/write privileges to the remote folder may configure bidirectional and upload-only sync tasks.
- You can set the maximum file size as a number between 0-10240000 MB, with 0 meaning unlimited. Please note, Hybrid Share file size must be between 1-65536 MB.
- Enable advanced consistency check ensures ultimate accuracy of synchronization, where Synology Drive Client compares additional criteria such as hash, execution bit, and file permissions in different scenarios where file merging is required. This takes more time and resources in completing synchronization tasks.
- Enable On-demand Sync option is currently available on Windows 10 version 1809 and above. Only NTFS drives or local sync folders that are NOT root drive directories or home directories (e.g., C drive, D drive, or C:\Users\<username>) can be selected as On-demand Sync folder.
- For Windows environment, you can create up to 64 sync tasks with Synology Drive Client. Please refer to below instruction regarding adding new tasks and connections.
To add a new sync task:
- Go to Sync Tasks and click Create.
- Select a connected server or connect to a new server you want to create a new task on and click Next.
- Choose to sync either My Drive or Team Folder.
- Choose the local folder and remote folder you want to sync, and configure Advanced settings.
- For Windows 10 computers, you may decide whether to Enable On-demand Sync to reduce computer capacity consumption and overhead on the server.
- Click Done to complete the setup.
Note:
- Folders that cannot be selected include folders already being used for sync tasks, or ancestor or child folders of synced folders.
- Folders that cannot be selected for tasks with On-demand Sync include local folders that are already synced with Synology Drive's On-demand Sync, OneDrive's File On-Demand, or iCloud Drive and their child folders.
- The following file and drive types are not supported on Synology Drive sync tasks:
- macOS alias
- Windows/macOS mounted drives
- Windows shortcuts
- Windows symbolic links
- Hidden files
- Windows folders with these attributes:
- OFFLINE
- REPARSE_POINT
- SYSTEM
- TEMPORARY
To delete a sync task:
- Select the connection you want to unlink on the Sync Tasks page.
- Click Delete.
Managing your Sync Tasks
You may manage your sync tasks with the buttons located at the top of the main page.
To manage your sync tasks:
- Select the sync task you want to manage.
- Click Pause, Resume, or Delete to pause, resume, or delete the task.
- Inside your sync folder, you can also right-click on any subfolder, select Synology Drive, and click Stop syncing this folder or Resume syncing this folder.
Note:
- After deleting a task, a full re-sync might be required if you wish to link again. When you set up a new connection, Synology Drive will automatically compare existing files and only upload/download the changes that have been made.
To change your sync rules:
- Select the sync task you want to manage and click Sync Rules.
- You can reconfigure the sync rules in the Folder, File Filter, and Sync Mode tabs.
Syncing and managing your files
After Synology Drive Client is set up on all of your computers, you can start syncing files with your connected Synology NAS and other computers.
To access your files, do any of the following:
- Click the link below your sync tasks to open the Synology Drive folder on your computer and then select the files or folders you want to access.
- In the Synology Drive Client tray menu, you can click the folder icon on the upper-right corner to access the local syncing folders from different connected servers.
To sync your files, do any of the following:
- Put your files into the Synology Drive folder on your computer to start file syncing. When file syncing is in progress, a blue symbol will appear on the application icon in the system tray of your computer, which will be replaced with a green one once the syncing process is complete. If you pause syncing, a gray symbol will appear.
- Right-click on any file on your computer to copy it to your Synology Drive sync folder.
If you want to pause or resume the sync process, click on the application icon in the system tray of your computer, and then choose Pause or Resume.
To enable syncing Shared with me:
- To enable syncing Shared with me, select the sync task and click Edit Connections. On the Shared with me tab, tick to enable syncing Shared with me. You may click Change to change the folder location for storing shared with me files.
- You can also click the Synology Drive Client icon in the system tray, go to Notifications, click a shared item, and click Sync this item.
Note:
- Synology Office files are synchronizable. To view them in browsers, your client device must have network connection to the Synology NAS. Version control cannot be performed on the computer end. If a previous version of your Synology Office file is needed, you can directly trace back to the version on Synology Drive web portal.
- Pause/Terminate syncing Shared with me: Select the Shared with me you wish to pause or terminate in Sync tasks and click Pause/Delete to proceed with the process.
Sync Task Rules:
- By default, Synology Drive Client will not sync files and folders under the following circumstances:
- The file type is any of the following: tmp, temp, swp, lnk
- The file name starts with a tilde (~)
- The file name is or contains any of the following:
- @eadir
- .SynologyWorkingDirectory
- #recycle
- desktop.ini
- .DS_STORE
- Icon\r
- thumbs.db
- $Recycle.Bin
- @sharebin
- System Volume Information
- Program Files
- Program Files (x86)
- ProgramData
- #snapshot
- For Windows:
- The folder or file path contains the following characters: * : ? \ / " < > |
- The folder or file path is longer than 247 characters
- The file name is longer than 255 characters
- File type is a shortcut or symbolic link
- Files or folders with these attributes:
- OFFLINE
- REPARSE_POINT
- SYSTEM
- TEMPORARY
- For macOS:
- The folder or file path contains the following characters: \ /
- The folder or file path is longer than 768 characters
- The file name is longer than 255 characters
- The file type is any of the following:
- Icon
- Socket
- Device node
- FIFO
- For Linux:
- The folder or file path contains the following characters: \ /
- The folder or file path is longer than 2,048 characters
- The file name is longer than 255 characters
- The file type is any of the following:
- When setting file names you don't want to sync, please note that on Windows a capitalized and lower case file names are considered to be the same file (e.g., A.txt and a.txt), but on Linux and macOS systems they can be used as different file names.
- .pst files are not supported because .pst files are not guaranteed to be portable.
- Network drives and removable devices (such as USB drives or SD cards) are supported on Synology Drive. Since file changes might not be detected on these drives and devices, we suggest only using them as local sync directory for download-only tasks.
- If local folder contains a mount point, files inside the mount point might not be synced because Synology Drive cannot detect file changes inside a mount point.
To download previous versions of a synced file:
- Right-click on the file and choose Synology Drive > Browse previous versions.
- Find the version you want to download and click the Download icon.
- Enter the filename and choose the destination to save the file.
To create a file sharing link:
- Right-click on the file you want to share, and choose Synology Drive > Get link.
- If you have manager permission for the item, you can customize the sharing permission of the link or specific DSM users. Click Apply to complete your settings. The link will be copied to your clipboard.
Understanding the file status
Icon overlays
Icon overlays appear on the lower-left corner of the files or folders in your local Synology Drive folder, indicating its status. You can untick Show icon overlay for file status in Global Settings > Display if you do not wish to see them.
Icon |
Description |
|
This icon indicates that your file or folder has been successfully synced and is up to date, or it is yet to be processed. |
|
This icon indicates that your file or folder has been filtered out and has not been synced. Possible reasons include: a system default filter, sync rules filter, server profile settings, or ACL permissions. You can untick Show icon overlay for unsynced files in Global Settings > Display if you do not wish to see this icon. |
|
This icon indicates that sync is currently in process. |
|
This icon indicates that you have read-only permission to the synced file or folder. |
Status indicator for On-demand Sync tasks
For tasks set with On-demand Sync on, the below icons indicate the current sync status.
Icon |
Description |
|
This icon indicates that your file or folder is available when online and does not take up disk capacity. You may open and download a local copy to the computer, or right-click on the file, select Synology Drive > Pin local copy permanently to maintain a local copy. |
|
This icon indicates your file or folder has been downloaded to a local computer and can be viewed offline. You may right-click on the file, select Synology Drive > Free up space to manually delete the local file and release the space. However, when your computer is low on disk capacity, these local copies will be automatically deleted to release space. The icons will change to the cloud icon and these files and folders are still available when online. |
|
This icon indicates that the file has been permanently pinned to the local computer and can be viewed offline. When your computer is low on disk capacity, these permanently pinned copies will not be automatically deleted to release space. |
Configuring Your Backup Tasks
You may create backup tasks to back up your files from multiple client computers to Synology Drive server to protect computer data.
To create a backup task:
- Enter the IP address or QuickConnect ID, username, and password of your Synology NAS. For domain users, use your domain name or username to sign in. For LDAP users, use "username@Base_DN" to sign in. You can also connect via IPv6 or proxy service. Click Next.
- If you are unable to connect to your Synology NAS, please make sure you have installed Synology Drive Server and check the Internet connection, or go to Global Settings to configure the proxy.
- You can also click the search icon on the right, and Synology Drive Client will automatically search for Synology NAS devices within your LAN.
- Select Backup Task and click Next.
- Select the local folders that you want to back up.
- You may click Backup Rules to further modify backup settings.
- Max file size: Any files larger than the size specified here will not be backed up.
- File name: Any file with the designated file name will not be backed up.
- File extension: Any designated file extension will not be backed up. Add *.extension to the table, e.g., *.iso.
- You may tick Back up files and folders with the prefix "." if you wish to back up such files.
- You may tick Back up temporary files and folders if you wish to do back up temp files.
- You may tick Keep locally deleted files on the remote backup destination folder to prevent backed up files from being deleted.
- Click Apply to save the settings.
- The destination of the backed up data will be shown at the bottom of the window. If you want to modify your backup destination, click Select:
- Destination folder: Synology Drive will create a folder with your computer name in the backup destination to back up to.
- Select a backup destination on you NAS: Choose a remote folder path for the backup destination folder.
- Click OK to save all the settings.
- After configuring your backup settings, source and destination folder paths, click Next.
- Select a backup mode for the backup task and then click Next.
- Continuous backup: Back up files whenever changes are made to the selected backup source.
- Manual backup: Back up files whenever you click Back up now.
- Scheduled backup: Back up files as you scheduled.
- Select the days you would like to run the backup task from the Run on drop-down menu.
- Select the time you would like to start the backup task from the Start time drop-down menu.
- Select the frequency you would like the backup task to run with from the Frequency drop-down menu. You may choose to run it once a day or every certain period of time.
- If you choose to run at the frequency other than Once a Day, you may select the time for the last backup in the days selected from the Last run time drop-down menu.
- Select the time you would like the last backup task to end in the scheduled day or its next day from the End time drop-down menu.
- Tick the checkboxes if you wish to enable Shut down automatically after running the last backup task of the day or Continue any uncompleted backup tasks when the system is in operation again.
- Check the backup settings summary and click Done to complete the setup.
Note:
- Synology Drive Backup Task only allows one connection to one server at a time.
- To find your QuickConnect ID, sign in to DSM using an account belonging to the administrators group, and go to Control Panel > External Access > QuickConnect (for DSM 7.0 or above) or Control Panel > QuickConnect (for DSM 6.2 or earlier) to check the information.
- If you are unable to connect to the Synology NAS or authorize the connection with your user credentials, check your network settings, and make sure your access to Synology Drive has been enabled by your DSM administrator at Control Panel > Application Privileges (for DSM 7.0 or above) or Privileges (for DSM 6.2 or earlier) > Synology Drive.
- If you have read-only permission for a remote shared folder, you cannot set it as your backup destination.
- If you tick Keep locally deleted files on the remote backup destination folder, deleting local files/folders will not affect data that has already been backed up to your remote destination.
- You can set the maximum file size as a number between 0-10240000 MB, with 0 meaning unlimited. Please note, Hybrid Share file size must be between 1-65536 MB.
Backup Task Rules:
- The following file types and drive types are not supported in Drive backup task:
- macOS alias
- Windows/macOS mounted drives
- Windows shortcuts
- Windows symbolic links
- Hidden files
- Windows folders with these attributes:
- OFFLINE
- REPARSE_POINT
- SYSTEM
- TEMPORARY
- By default, Synology Drive Client will not back up files and folders under the following circumstances:
- The file type is any of the following: tmp, temp, swp, lnk
- The file name starts with a tilde (~)
- The file name is or contains any of the following:
- @tmp
- @eadir
- .SynologyWorkingDirectory
- #recycle
- desktop.ini
- .DS_STORE
- Icon\r
- thumbs.db
- $Recycle.Bin
- tmp
- temp
- @sharebin
- System Volume Information
- Program Files
- Program Files (x86)
- ProgramData
- #snapshot
- For Windows:
- The folder or file path contains the following characters: * : ? \ / " < > |
- The folder or file path is longer than 247 characters
- The file name is longer than 255 characters
- File type is a shortcut or symbolic link
- Files or folders with these attributes:
- OFFLINE
- REPARSE_POINT
- SYSTEM
- TEMPORARY
- For macOS:
- The folder or file path contains the following characters: \ /
- The folder or file path is longer than 768 characters
- The file name is longer than 255 characters
- The file type is any of the following:
- Icon
- Socket
- Device node
- FIFO
- For Linux:
- The folder or file path contains the following characters: \ /
- The folder or file path is longer than 2,048 characters
- The file name is longer than 255 characters
- The file type is any of the following:
- On macOS, we suggest using APFS file system for external drives in order to prevent errors caused by files with “._” in their filenames.
- If local folder contains a mount point, files inside the mount point might not be backed up because Synology Drive can not detect file changes inside a mount point.
Managing your Backup Tasks
Double-click the Synology Drive Client icon in the system tray to launch the application and go to the Backup Task page to manage your backup tasks.
To manage your backup:
- Click Pause to pause your running backup task or scheduled backup task.
- Click Resume to resume your backup.
To modify the folder you want to backup:
- Click Backup Settings > Backup Source.
- Tick the folders you want to back up, and untick those you don't want to back up.
- Click Apply to save the settings.
To change your backup rules:
- Click Backup Settings > Backup Source.
- Click Backup Rules button, and make changes to your settings.
- Click Apply to save the settings.
To change your backup mode:
- Click Backup Settings > Backup Mode.
- Make changes to your settings.
- Click Apply to save the settings.
To edit the backup task connection:
- Click Backup Settings > Connection.
- Make changes to the server connection or username and password.
- Click Apply to save the settings.
Note:
- If you would like to link the task to a different NAS server, please delete the current backup task and create a new connection.
To delete a backup task:
- Click Backup Settings > Connection.
- Click the Unlink button to delete the task.
Note:
- After deleting a backup task, previously backed up data will remain on the server. However, all data needs to be processed again the next time you set up the backup task.
Back up your files effortlessly
To automatically back up your files, do any of the following:
- Place files you wish to back up into the backup folder on your computer.
- While backup is running, files uploaded will be shown in Logs tab in the application.
- If you want to pause or resume your backup, click Pause or Resume in the Backup Task page in the application.
Note:
- Synology Drive Backup Task uploads up to three files to the destination server concurrently.
Managing backed up files and historical versions
Synology Drive saves historical versions of each modified file according to the settings in Synology Drive Admin Console. Every time you modify a file, a backup version is created, just in case you make mistakes or wish to revert to an older version. On the client computer, double-click the Synology Drive Client icon in the system tray to launch the application and go to the Backup Task page. Here you can browse historical versions of backed up data as well as restore files from a specific point in time.
To download previous versions of a backed up file:
- Click Restore to open the Restore window.
- You can view the history of files by selecting a specific date and time from the Time drop-down menu.
- Select a file you want to download, and then click Download.
- You can also click Browse previous versions to view all historical versions of the file at once and then click Download to download the selected version.
To restore a backed up file or folder to a specific time:
- Click Restore to open the Restore window.
- You can view the history of files by selecting a specific date and time from the Time drop-down menu.
- Select a file you want to restore, then click Restore. The file will be restored to its directory on the computer.
To download or restore a deleted file or folder:
- Click Restore to open the Restore window.
- Check the box next to Show deleted files. After choosing this option, all deleted files will be shown in the file chooser below.
- You can download or restore a deleted file or folder using the same steps as regular files.
To check the download or restore progress:
- Click Restore to open the Restore window.
- Click the task icon on the upper-right to open the task list.
- Both download and restore task progress will be shown in the task list.
Note:
- After closing the Restore window, the task list will be wiped.
To access your backed up files on your Synology NAS, do any of the following:
- Sign in to Synology Drive web portal with your credentials and click Computer Backup in the left panel.
- Files backed up from your computers will be saved here.
Note:
- Any changes made to the backup destination from server side will not be updated to local computer backup source.
Application Management and Settings
You may make changes to general settings and view event status in Synology Drive Client.
Logs
To view logs:
- Double-click on the Synology Drive Client icon in the system tray to launch the app.
- Go to the Logs page to view your sync and backup events.
Notifications
To view notifications:
- Double-click on the Synology Drive Client icon in the system tray to launch the app.
- Go to the Notifications page to view notifications of sync and backup events.
Global Settings
You can modify general application, notification, display and proxy settings on the Global Settings page.
To edit your settings:
- Double-click on the Synology Drive Client icon and go to Global Settings.
- Under the General tab, you may adjust the following:
- Select whether to start Synology Drive application upon login.
- Select a default action for when application restarts and syncing connection resumes.
- Select a file version conflict resolution.
- Keep the latest modified version: When a file conflict takes place between the server and the desktop application, the latest file (the one with the latest modified time) will be retained. If the latest file is the local file on the application, the file on the server will become a historic version. If the latest file is on the server, the local file will be discarded, but you can tick the option Rename to keep the discarded version.
- Keep the version on the server: When a file conflict takes place between the server and the desktop application, the file on the server will always be retained and the local version will be discarded. You can tick the option Rename to keep the discarded version.
- Select a default folder for Synology Drive when you click on Synology Drive Client in the system tray.
- Select the language to be displayed in the application.
- Click Apply to save the settings.
Note:
- If more than one computer makes changes to the same file, conflicts may occur. To solve this problem, you can set a conflict solution.
- Conflicting files to be kept will be renamed "[file name]_[computer name]_[modified date]_Conflict.[file extension]" (for example, "a.txt" might be renamed as "a_ComputerName_20181001_Conflict.txt").
To edit notification settings:
- Double-click on the Synology Drive Client icon and go to Global Settings.
- Under the Notifications tab, you can change the setting for Show desktop notifications for file events.
- Click Apply to save the settings.
To edit display settings:
- Double-click on the Synology Drive Client icon and go to Global Settings.
- Under the Display tab, you may modify below options:
- Select to show tutorial tips the next time Synology Drive Client is launched.
- Select to use minimalist tray icon.
- Adjust the style of the icon and context menu in the synced local folder.
- Click Apply to save the settings.
Note:
- Icon overlay option will not be applied to display settings of tasks with On-demand Sync.
To configure proxy settings:
- Double-click on the Synology Drive Client icon and go to Global Settings.
- Under the Proxy tab, you may select Auto-detect to use proxy settings provided by the operating system.
- You may also manually specify your own proxy server IP and port.
- Tick Enable proxy authentication and enter username and password for proxy authorization.
- Click Apply to save all the settings.
Note:
- If proxy is enabled, Synology Drive Client will always connect to Synology NAS through proxy.
- Only HTTP tunnel is supported. SOCKS 4/5 and other types of proxies are not supported.
To enable SSL data transmission encryption:
- For new connections:
- Click Create.
- Select Another Synology NAS and enter your user credentials.
- Tick the Enable SSL data transmission encryption checkbox.
- For existing connections:
- Select the connection you want to modify and click the drop-down menu to the right of the server name.
- Click Edit Connection, enter your user credentials and tick the Enable SSL data transmission encryption checkbox.
Note:
- If Synology Drive fails to verify the SSL certificate, it may mean that it is an untrusted self-signed certificate, or someone may be trying to intercept your connection. Please go to Control Panel > Security > Certificate for more information.
To monitor personal usage in Team Folders:
- Double-click on the Synology Drive Client icon and go to Global Settings.
- Under the Usage tab, you will find your personal storage usage of each team folder or My Drive. The total capacity is only shown if the quota limit has been set for the user. Please note that the usage calculation is not available for ext4 file system.
Removing Synology Drive Client from your computer
To remove Synology Drive Client on macOS:
- Go to Finder > Application and right-click the Synology Drive Client application, then select Package Contents.
- Go to Contents > SharedSupport.
- Copy and paste Remove Synology Drive Client onto your desktop.
- Double-click on Remove Synology Drive Client to uninstall the Synology Drive desktop application from your macOS computer.