- Creating your job
- Choosing your source and destination
- General tab
- Filters tab
- Auto tab
- Scripts tab
- Advanced tab
Creating your job
To create a new job, navigate to the "Jobs" tab and click "CREATE NEW JOB."
A window will appear, allowing you to configure your options.
To begin, you may give the job a name and description (optional):
Choosing your source and destination
In the Left Folder and Right Folder tabs, you may set the locations of your job and configure options:
1) The File System drop-down will list available file systems that may be chosen for the job.
2) In the Path field, you may specify the exact path of the folder you would like to set for the Left or Right side. For more information regarding the available supported file systems and services, click here.
3) What Makes Files Differ
Compare Checksums when needed (slower) (un-checked by default)
If checked, compare MD5 checksum of Old to New file if the file size has not changed, but the file mod time has.
If MD5 checksum of the file differs, but the File Size and File Mod Time are the same, declare a conflict.
After Sync, verify that checksum of the copied file is the same on both sides.
If unchecked, the file is only considered to be changed if the File Size or File Mod Time have changed.
Compare Attributes (Windows only, un-checked by default)
If checked, changes in file/folder Attributes are detected even when the file body does not change.
If unchecked, Attributes are copied only when the changed file is copied.
Compare Permissions (Mac and Unix only, unchecked by default)
If checked, changes in file/folder Permissions are detected even when the file body does not change. If unchecked, Permissions are copied only when the changed file is copied.
Compare Owner (un-checked by default)
If checked, changes in the File Owner are detected even when the file body does not change.
If unchecked, the File Owner is copied only when the file body has changed.
Compare ACL (un-checked by default)
If checked, changes in ACL are detected even when the file body does not change.
If unchecked, ACL is copied only when the file body has changed.
Compare Extended Attributes (Mac only, un-checked by default)
If checked, changes in Extended Attributes are detected even when the file body does not change.
If unchecked, Extended Attributes are copied only when the changed file is copied.
4) File System Specific
Compress (Windows only, un-checked by default)
If checked, compress file bodies using native file system functionality.
Works only in NTFS. Compression will be done by Windows. Compressed attribute will be set.
Uncompress (Windows only, un-checked by default)
If checked, decompress file bodies using native file system functionality.
Works only in NTFS, decompression will be done by Windows.
FAT file system that does not reveal itself (Windows only, un-checked by default)
If checked, use special time adjustment designed to neutralize FAT time storage problems.
If unchecked and if FAT is not reported by FS, assume that the file system stores file mod time in UTC.
5) Folder Options
No _gsdata_ folder here (un-checked by default)
If checked, do not create _GSDATA_ folder in the sync folder on Left/Right side of the job.
Instead, create _GSDATA_ folder in the GoodSync profile folder on this computer.
If unchecked, create _GSDATA_ folder in the sync folder.
This option should be used only in situations where writing to sync folder is not possible or undesirable (read-only source side of 1-way job).
Use this option only for sync folders that are not synced with any other folder (by any other job on this or another computer).
Note: If this option is checked, these other options cannot be used:
Save Previous/Past Version, Save History.
Do Not List Folders During Analyze (un-checked by default, formerly Fast Pre-Analyze)
If checked, do not list folders to see what's in them during Analyze. Instead, trust GoodSync state file to provide file listings.
If unchecked, perform full Analyze.
This option can be used if only GoodSync (not you or another program)
changes files in folder and sub-folders on this side.
Note: Misuse of this option can result in data corruption or loss. For advanced users only.
Safe Copy using temporary files (checked by default)
If checked, Sync does not copy the source file directly to the destination file on this side, as an interrupt midsync would corrupt the file. Instead, Sync copies the source file to the temporary file in the destination folder. Once the copy operation is finished, the temporary file is renamed to the destination file.
You may uncheck this option if you are doing 1-way backups and destination volume has limited free space.
This option is available only for file systems that do not have atomic upload (atomic upload means that until upload is complete, interrupting will revert to the previous version of a file).
Encrypt File Bodies (un-checked by default)
If checked, Encrypt file bodies before uploading them to this Left/Right folder.
AES with 256-bit key is used for encryption, with all file blocks chained.
Random salt is applied, so different encryptions of the same file will produce different results.
File size will increase by exactly 32 bytes.
Encrypt File Name (un-checked by default)
If checked, Encrypt file names (inside the sync folder) before uploading them to this folder.
AES with 256-bit key is used for encryption.
*For information regarding our "Use GS Account" option, click here.
In the General tab, you may configure options relating to versioning, direction, throttling, and more.
Job Type and Direction
Job type can be one of the three choices below.
Synchronize 2-Way (default)
Propagate changes from Left to Right and from Right to Left. Ensures that the content will be kept identical on both sides.
Backup Left to Right (1-way)
Propagate changes only from the Left sync folder to the Right sync folder.
Backup Right to Left (1-way)
Propagate changes only from the Right sync folder to the Left sync folder.
Propagate Deletions (checked by default)
If checked, deletions made by the user on one side of the job are propagated to the other side.
If unchecked, deletions are not propagated, only changed files are propagated.
This modifier applies only to 1-way jobs.
Create left/right Sync folders if they are not found (off by default)
If checked then GoodSync will create left/right sync folders if they are not present.
If unchecked, an error message will be shown on Analyze if the chosen sync folders are not present.
Save deleted/replaced files, last version only (checked by default)
If checked, GoodSync retains the previous version of any modified file to the _gsdata_\_saved_ folder on the side of the job where the replacement occurs. Deleted files will also be placed into this folder for recovery purposes.
If this option is unchecked, replaced/deleted files are removed permanently.
Only the most recent version of the file (the one just before the current version) is retained.
Note that _gsdata_ is a hidden folder. You must check Show Hidden Files option in Windows Explorer to view the contents of this folder.
Cleanup _saved_ folder after this many days (checked by default, 30 days)
If checked, all files placed in _gsdata_\_saved_ folder will be purged after the specified number of days.
If unchecked, all files in _gsdata_\_saved_ folder will be kept indefinitely.
Save deleted/replaced files, multiple version (off by default)
If checked, GoodSync retains a version for every modification made to a file. These versions are saved to the _gsdata_\_history_ folder on the side of the job where the replacement occurs.
A timestamp is added to the file name before its extension so multiple versions of the file can be saved. Directory structure is preserved. Deleted files will also be placed into this folder for recovery purposes.
This option cannot be used together with 'Save deleted/replaced files, last version only' option.
Cleanup _history_ folder after this many days (off by default, 30 days)
If checked, all files placed in _gsdata_\_history_ folder will be purged after the specified number of days.
If unchecked, all files in _gsdata_\_history_ folder will be kept indefinitely.
Total Seconds for Reconnect Attempts (120 by default)
Total seconds allowed for Reconnect attempts, when file system disconnects or returns connection errors.
If file operation fails after this many seconds of retries, the file system is declared disconnected and the entire job fails.
Run parallel Threads in Sync (off by default)
If checked, then run Sync using this many parallel threads. Using this option speeds up file transfer for remote servers that have high latency. It does not increase speed however if your bandwidth is used up by a single-thread sync.
If unchecked, 0, or 1 then run sync in one sequential thread.
Examples of when it helps: uploading many small files to an FTP or SFTP server.
Example of when it does not help: uploading several large files to a GSTP, S3, or FTP server.
File Copy Speed Limit in KBytes/sec (0 by default)
If not zero, then limit file copy speed by specified value in KBytes/sec.
When average file copy speed in Sync exceeds the specified threshold, GoodSync suspends (sleeps) jobs for 1 second until the effective average speed falls below the limit.
The Filters tab allows you to create inclusion and exclusion filters for full control over what data syncs and what does not.
Exclude (empty by default)
Files and folders that match an exclusion filter will be excluded from synchronization.
Include (empty by default)
If not empty, files and folders whose names match an inclusion filter - and do not match any exclusion filters - are included in synchronization.
Note: By design, exclusions will take priority over inclusions.
Exclude Empty Folders (un-checked by default)
If checked, Exclude folders that are empty or that contain only empty folders. Folders are considered empty if they contain no files or if they contain only files that were excluded by Filters.
Exclude Hidden Files and Folders (checked by default)
Exclude files and folders that have HIDDEN attribute.
Exclude System Files and Folders (checked by default)
Exclude files and folders that have SYSTEM attribute.
For details regarding syntax and how to create specific filters, click here.
Scheduling, conflict resolution, and sync triggers can be configured under the Auto tab.
On File Change
Monitors source and/or destination for changes and replicates them in real-time.
On File Change supports the following file systems:
- Windows File System and local disks (except root folder)
- Windows shares (except some faulty NAS shares that do not report changes)
- Mac file system and local disks
- Any of the above file systems remotely accessed via the GSTP protocol using GS Connect.
On File Change Delay option:
Wait this many seconds since the last detected change before starting the Analyze and Sync.
Note: If changes occur during Analyze/Sync, they are still detected and sent to the next Analyze interval.
On Folders Connect
Analyze and Sync this job when a specified location is made available.
By design, GoodSync checks every 3 minutes for the status of the left and right folders to determine availability.
The following events speed up detection of connected/disconnected status:
* Insertion or Ejection of Portable Volume: detachable folders may connect or disconnect.
* Network Connect or Disconnect: FTP, SFTP, DAV folders may connect or disconnect.
Should not be used together with On File Change mode, as OFC overrides it.
Periodically (On Timer)
Analyze and Sync this job periodically, every HH hours and MM minutes.
Analyze and Sync this job on a specified schedule.
These time unit values can be set:
- Minute (0 to 59),
- Hour (0 to 23),
- Day of Month (1 to 31),
- Month (1 to 12),
- Day of Week (0=Sun to 6=Sat)
Note: If a field is left empty, it will run for every unit value of its range.
If your computer goes to Sleep/Standby, GoodSync can wake it up for the On Schedule job. Ensure that 'Control Panel -> Power Options -> Change Plan Settings -> Change Advanced Power Settings -> Sleep -> Allow Wake Timers' is enabled.
Do Not Sync if changed files more than (50% by default)
Automated Sync (2-way mode only) is not performed if more than the specified (in percent) fraction of files in the Job has changed. An unusually high number of changed files typically indicates an event that requires user attention (e.g. ransomware).
Wait for Locks to clear (checked by default)
If checked, auto jobs wait for lock files to clear instead of producing an error.
Automatically Resolve Conflicts
If a file is changed on both sides of a 2-way sync prior to a scheduled run, this will create a “conflict”. Conflicts may be resolved automatically with the following options:
Do Not Copy (default value) - Leave Conflicts in unresolved (Do Not Copy) state.
Left to Right - Resolve to Left to Right propagation.
Right to Left - Resolve to Right to Left propagation.
Newer File Wins - File with the most recent modification date wins.
Stop Sync - Stop Sync when Conflict is detected.
Conflict Resolution: Rename Losing File, Not Delete
If Automatically Resolve Conflicts option is enabled, do not delete the file that loses as a result of conflict resolution. Instead, rename it to 'FileName (Conflicted Copy from COMPUTER on DATE).ext'.
The Scripts tab may be used to call a program, script, or email alert during a certain phase of a job run.
Pre Analyze E-Mail or Program
If the option is not empty, then take the action specified just before Analyze begins.
If the program returns non-zero return code or fails, do not start Analyze.
If the program succeeds and returns zero return code, proceed with Analyze.
Post Analyze (No Changes) E-Mail or Program
If the option is not empty, take the action specified just after Analyze finishes.
Action is taken only if Analyze finishes with No Changes.
Post Sync E-Mail or Program
If the option is not empty, then take the action specified just after Sync finishes.
Scripts: Sending Emails
If the Scripts option value contains the '@' symbol, then GoodSync sends e-mail to address(es) specified in the option.
Multiple email addresses must be separated by comma or semicolon: firstname.lastname@example.org; email@example.com
If only emails are specified in the field(s), then default email text is sent.
To specify custom emails, you may prepend with some of the following options:
noattach: firstname.lastname@example.org: Synced %SYNCOK% items, changed items were %CHANGED%
Here 'noattach" ' specifies that a sync log will not be attached to the email, the email will be sent to email@example.com, and the email will contain parameters %SYNCOK% (number of files/folders synced OK) and %CHANGED% (number of changed items synced OK).
Scripts: Calling Programs
If the Scripts option value contains no '@', then GoodSync runs the program specified in the option and arguments passed to this program:
program-name %ARG1% %ARG2% %ARG3% ...
where arguments can be one of the following (all variable names are case-sensitive):
|%RESULT%||Result: "" for OK or "terminal error message"|
|%LOGPATH%||Log file path in "..."|
|%LF%||Left folder path in "..."|
|%LF_ACT%||Resolved (=VolumeName\folder -> f:\folder) Left folder path in "..."|
|%RF%||Right folder path in "..."|
|%RF_ACT%||Resolved (=VolumeName\folder -> f:\folder) Right folder path in "..."|
|%CHANGED%||Number of Changed Items in Post-Analyze|
|%ERRORS%||Number of Errors in Post-Analyze or Post-Sync|
|%CONFLICTS%||Number of Conflicts in Post-Analyze or Post-Sync|
|%SYNCOK%||Number of Synced-OK items in Post-Sync|
Please use absolute paths to point to the location of the program or script.
If the program name contains spaces, it must be enclosed in double quotes like so:
"C:\Documents and Settings\John Smith\My Documents\myscript.vbs"
Example: call Notepad to show log file:
If a script or email alert is prefixed with "errors: ", then it is started only if:
- Terminal Errors occurred in Analyze or Sync, OR
- Non-Terminal Errors occurred in Analyze or Sync, OR
- Conflicts occurred in Analyze.
The Advanced tab contains settings for backing up permissions, attributes, locked files, and other exotic options.
Copy File Creation Time (un-checked by default)
If checked, copy Creation Time of the file or folder, in addition to copying Modification Time.
If unchecked, copy only file/folder Modification Time.
Copy Attributes (Windows only, checked by default)
If checked, copy file/folder Attributes (ReadOnly, Hidden, System) when it is being copied by GoodSync.
If unchecked, Normal Attribute is assigned to copied files.
Copy Permissions (Mac and Unix only, checked by default)
If checked, copy Permissions (rwxrwxrwx) of the file or folder when it is being copied by
Copy Extended Attributes (Mac only, un-checked by default)
If checked, copy file/folder Extended Attributes (custom icons, Finder tags) when it is being copied.
If unchecked, empty Extended Attributes are assigned to the copied files.
Copy Owner (un-checked by default)
If checked then copy file/folder owner, when file is being copied.
If unchecked, the Current Owner is assigned to copied files.
Current Owner for Local Windows FS is the Windows user into which you are logged in now.
Current Owner for Local Mac FS is the Mac user into which you are logged in now.
Current Owner for GS Server is defined when you setup GoodSync Connect, in Configure Mac User page.
Copy ACL (un-checked by default)
If checked, copy the file/folder Access Control List (ACL) when the file is being copied.
If unchecked, Empty ACL is assigned to copied files.
Move Mode: Delete Source File after Copy
After the file is copied from the source folder to the destination folder, delete it.
This is equivalent to Moving the file from source to destination.
If the source folder becomes empty as a result of such deletions, it is also deleted.
To be used only by advanced users.
Move Mode: Delete Empty Folders after Copy
After 'Move Mode: Delete Source File after Copy' did its work,
also delete folder if it became empty.
To be used only by advanced users.
Copy Locked Files (checked by default)
If On then copy from locked files using Volume Shadow Service (VSS).
If Off then return Cannot Copy Locked File error for locked files.
Available on Windows XP, Vista, 7, 8, 10 and later.
Does not work in GoodSync2Go, must have installed GoodSync.
GoodSync can copy only FROM a locked file and never TO a locked file.
GoodSync can copy only from locked file on local disk, never from a network-mounted locked file.
Uber-Unlocked Mode (un-checked by default)
If checked then Source files may be deleted or moved during upload, as GoodSync does not lock them in any way during upload. Also GoodSync would notice right away that such deletion/move have occurred and it will not continue uploading the deleted file. If un-checked then use operating system unlocked mode for uploads, but this mode still locks source files against move or delete. Even if OS appears to allow you to delete/move the source file, GoodSync will continue uploading the file, and only when GoodSync finishes, the file will actually be deleted.
Retry Sync if the source file changes between Analyze and Sync (un-checked by default)
If checked and a file changes after Analyze or during its Sync then retry sync of this file right away. If unchecked and a file changes after Analyze or during Sync then finish syncing and let the next Analyze handle the new difference.
Copy original file system names (Mac only, unchecked by default)
If checked then Copy original file system names, even if they differ only in name case between sides.
If unchecked then Copy/Rename files with the same content, only if file name changed in a case-insensitive way.
Detect File and Folder Moves and Renames (checked by default)
If checked, detect file and folder Move or Rename and execute them as such, not as a deletion and recreation.
Folder moves are detected when all files inside a folder are moved to the same destination folder.
Note that if a folder contains two or more files that are exactly the same per file size and file mod time, then rename/move of such files or their parent folders cannot be detected.
Estimate disk space required for Sync (checked by default)
If checked then Compute how much free disk space is needed to complete the Sync.
Compare Checksums of All Files (slow) (un-checked by default)
If checked then compare MD5 checksum of all files on the Left and Right.
If MD5 checksum of the file differs where File Size and File Mod Time are the same, declare a conflict. After Sync, verify that the checksum of the copied file is the same on both sides. If unchecked, a file is considered to be changed if its File Size or File Mod Time has changed.
3) Symbolic links and Junctions
Symbolic Links Processing (Copy As Is by default)
This option determines how symbolic links to files and folders are processed.
* Ignore. Symlinks are ignored and not copied in any way.
* Copy As Is. Symlink to file/folder is copied as the same Symlink in the destination folder.
* Drill Down. Target file/folder of symbolic link is copied to the destination folder.
Windows: A symbolic link itself knows whether it is to file or folder.
Linux/Unix: A symbolic link does not know whether it is to file or folder, so drilling to the target is required to find out.