Help for FolderSync

General infoGetting startedFile managerSync statusAccountsFolderPairs

GeneralSchedulingSync optionsConnectionNotificationsAdvancedSync filtersSettingsAboutTaskerShortcutsTroubleshootingLimitations in lite versionUpgrading from lite version

General info

FolderSync uses the ActionBar pattern. FolderSync contains of the following sections:The dashboard where all areas of the app can be accessed quickly.File manager used to manage your files.Sync status screen where sync history can be seen.Accounts screen where cloud accounts can be created and edited.Folderpairs screen where sync folders can be configured.Settings screen where general settings can be configured.About screen where you can find info about license and support.

The dropdown in the top menu bar can be used to quickly jump to the different sections of the app.

To select items in lists, long-press them or tap the checkbox.

The three-dot icon to the right is an "overflow" menu that opens up additional options as seen on the image to the right. There you can access settings, help and about screen from all main sections of the application. Note: On older Android devices it may be necessary to use the menu button to access this menu.

Menu options that is accessible almost everywhere using the menu button:SettingsHelpAbout

Tip: To know what an icon does, long-press it and a help text will appear - no action will be taken when you do so.

Per default, FolderSync starts up in the dashboard mode. This can be changed on the settings screen.Contents

Getting started

If you want to set up a sync between two folders quickly, the first thing you want to do, is to create an account and then configure a folderpair.Go to the accounts screen, press the add account button and fill in your details.After you have configured your account, then open the folderpairs screen.Press the add new folderpair icon and enter a name.Select the local and remote folders you want to sync and choose sync type.Setup a schedule, if you want the sync to run automatically on a schedule.Press save and thats it.You can now sync the folderpair manually or it will sync when it's scheduled.

Tip: To sync manually either select folderpair in the folderpairs list and press sync now icon or add a shortcut to the home screen.

For more info on configuring a folderpair, see the folderpairs section.Contents

File manager

The file manager allows you to copy/move files to and from your accounts from the local sdcard, as well as move/copy files in a remote storage space. You can also rename files and folders and create new folders. Copying from one remote account to another is not supported, as this is not possible without using the local sdcard as a temporary storage space. Moving files locally on a cloud provider is not supported by all providers either.

To browse into a folder in the file manager, just tap the folder. To browse back presse the back-button or the parent icon in the list.

Menu options in the file manager:Create new folderSelect local pathSelect remote path (configured accounts)Select favoriteSelect all

To select a file or folder in the file manager long press it, or press the checkbox. If you normal press a file it will be opened or, if its a remote file, a dialog will open asking if you want to download an open the file. The opening will only succeed if you still have the file manager open when the download has finished. else the file will be available in the temp folder.

When you press the overflow menu in the file manager you are provides with extra options,. in addition to the three standard menu options. These are:Toogle view of hidden filesSort (with options to sort files on different criteria)Refresh (refreshes the files and folder view)Manage transfers (opens a window with transfers)Manage favorites

When you have selected one or more folders you are presented with these options:DeleteCopyCutRename (single selection only)Details (single selection only)Add favorite (single selection only)Media scan (will scan media files and add them to library)

When you have selected one or more files you are presented with these options:DeleteCopyCutRename (single selection only)Details (single selection only)Share (single selection only)Open with (single selection only)Media scan (will scan media files and add them to library)Compress to zip file (will compress to zip file with name of your choice)

To copy files manually from the SD card to a cloud provider or the other way around, selected the files you want to transfer, press the copy (or cut) icon, then browse to the folder where you want to paste the files (using a favorite shortcut for example). Then press the paste icon, that will have appeared on the actionbar. That will start the transfer of the files to the folder that are currently designated in the location bar.

When tapping a local file it will open in a default viewer, or you will be prompted to select an app.

When tapping a remote file, you will have the option to download automatically to a temp folder and then open it. If the file is streamable (video/audio) and the provider supports streaming, you will also have the option to stream the file to a player of your choice. I suggest VLC for video files.Contents

Sync status

The sync status windows provides you with the opportunity to see whats going on when syncing, and to view a history of past syncs that have occurred. It also informs you when the next sync check will run. A sync check is not a sync, but just a periodic check FolderSync does to check if anything needs to be synced. If no scheduled/instant syncs are configured, then this is not set.

Successful syncs will have a green icon, either containing a check mark or plus character. The latter is present when a sync has transferred actual files. A yellow icon indicates a sync has errors.

If you click on an item in the sync history, you will be able to see a detailed log of events for the sync.

Menu options in the sync status screen:Sync now (sync all folderpairs that are allowed)Select all (select all sync logs)Cancel syncing (if sync is in progress)Delete (if sync logs selected)View log (if single sync log selected)Contents

Accounts

The accounts screen is where you create and manage your cloud accounts.

The first thing to do in FolderSync is create an account to use for syncing with cloud storage. You will be required to provide your login credentials, either directly in FolderSync or on the provider webpage for those using OAuth authentication. If you do not already have an account you can create one for free at the applicable vendor website, if you want to use SkyDrive, Dropbox, SugarSync, Google Drive, Ubuntu One, Box or Amazon S3 cloud storage..

Menu options in the accounts screen:Add accountDelete account (if accounts selected)Edit account (if single account selected)

Press the add account icon represented as a cloud with a plus icon. That will bring up menu where you are asked to select provider type. Choose the type you want.

To activate an cloud account, using OAuth authentication, press [Authenticate account]. Then a website asking for your login credentials to your account will open - FolderSync will not know your password, as the cloud provider will generate an OAuth token it returns to FolderSync, when you have signed in. When that happens you will be able to see your quota for your cloud provider.

Depending on the account type, this process may be different. Some cloud providers does not support OAuth authentication. For those provider types where FolderSync need to store credentials, they are stored in encrypted form.

If you want to use Samba/Windows shares, FTP, SFTP or WebDAV, you have to set it up on a server or your home PC, or have access to an existing account. Explaining how setup this is not in the scope of this help text, but try using Google.

When not using OAuth, FolderSync provides an option to test your entered account settings using the [Test connection] button, to see if it can connect to the selected provider with the server address and credentials you have entered.

When entering a server address, never enter protocol type and never enter folders. Just enter a server address or IP address, eg. "www.server.com" or "11.22.11.43". If you need to define a start folder for your server, enter it in the start folder field.Contents

FolderPairs

A FolderPair is a definition of a sync that you want this application to perform. A folderpair defines a sync between a local folder on your device and a remote folder for your chosen provider type. A sync can sync files to remote cloud storage, to your local storage or both ways.

Menu options in the folderpairs screen:Add folderpairSelect allDelete (if folderpairs selected)Sync now (if folderpairs selected)Copy folderpair (if single folderpair selected)Edit folderpair (if single folderpair selected)View log (if single folderpair selected)

Press the add folderpair icon to add a new folderpair. Then the first thing you do, after entering a name for your folderpair, is to select an account to use. If you have not already configured an account, do this before setting up a folderpair or use the built-in SD Card account if you want to sync locally on your device between two folders. When an account has been selected, and it is properly configured, you will be able to browse the remote file system for your cloud provider, when clicking the remote folder input field, and chose the folder to be used when syncing. Similarly you can choose which local folder to use.

Additionally you can define various parameters for each sync: which network connection it should be allowed to use, allowed/disallowed SSID's, if sub folders or hidden files are to be synced and if you want a scheduled sync to run automatically or at certain times.

Syncing
Syncing occurs according to the schedule you have defined for each folderpair. If a schedule is not defined the folderpair will only be synced if you manually initiate it. If no network connection is set to be allowed for a folderpair it will never sync, not even if you manually initiate it. This is to ensure you are not accidentally charged for expensive network traffic. Files are compared using their last modification date and optionally using MD5 hashes (for local files).

Two-way sync
Two-way sync copies files in both directions, overwriting older files if duplicate files are found. It will also detect cases where modifications have happened on both local and cloud storage. If this happens, the latest modified file will be used or the file will be skipped, according to what you specify in for the folderpair.

Instant sync
This feature is experimental and can be enabled for a folderpair. When enabled, local file changes will be detected in the device folder, and a immediate partial sync will be attempted. It is recommended that a scheduled sync is still configured, as some change events are not detected properly - fx. on some custom ROMs etc.

Mirroring of deletions
If the "Sync deletions" option is enabled, deletions will also be synced, for all types of sync. FolderSync has an internal database of synced files. If a previously synced filed is deleted at either end, the deletion will also happen at the opposite end (if the file at the opposite end has not changed since last sync). Use this option only if you are sure what you are doing, and at your own risk!

Explanation of folderpair configuration optionsGeneralSchedulingSync optionsConnectionNotificationsAdvanced

When configured, a folderpair will run on a schedule (if so configured), obeying the settings you have set. That is, it will not try to sync on non-allowed networks or in any other non-allowed state.Contents

Folderpairs - General

Name: Unique name of your choice.Account: The account to sync to or from (must be configured first on account page).Remote folder: The remote folder to sync to or from. Can be selected after an account has been chosen.Local folder: The local folder on the device to sync to or from.Sync type: The type of sync - one-way to local or remote or two-way sync. Default: To local folder.Contents

Folderpairs - Scheduling

Use scheduled sync: Check this if you want to sync on a schedule (and not solely by manual start or Tasker).Sync interval: Choose how often you want to sync.Sync days: If sync interval is set to advanced, then this option is shown. Choose which days to sync.Sync times: If sync interval is set to advanced, then this option is shown. Choose which time of day to sync.Contents

Folderpairs - Sync options

Instant sync: Select this for instant sync on change. Only detects changes on local device. Use with care!Copy files to time-stamped folder: For one-way sync only. If enabled , this creates a time-stamped folder at target location, so all source files are synced every time into a new folder at target location.Exclude from force sync: Check this if this sync should be excluded from sync all action on sync status screen.Sync sub-folders: Check this if sub-folders are to be synced. Enabled by default.Sync hidden files: Check this if hidden files are to be synced. Enabled by default.Delete source files after sync: For one-way sync only. After syncing of files, the source files are deleted. Use with care! Disabled by default.Retry sync if failed: Retry sync on next sync check, if previous sync failed. If not enabled, sync will not be retried until next scheduled sync if failed.Sync deletions: Check this if deletions are to be mirrored. Use with care! Disabled by default.Sync modified files since last sync only: Only available for one-way sync. If enabled, only files modified since previous sync will be synced again. That means if files are deleted or changed in the target folder, they will not be replaced or overwritten. You can then delete files in target folder, without them being transferred again.Overwrite old files: Choose what to do if a file already exist at target. Default setting is to overwrite the old file, so the newest file is used.If conflicting modifications: Choose what to do if a conflicting modification is detected. A conflicting modification is one where both the source and target file has been changed since last recorded sync. Default is to skip file, which will result in sync warnings.Contents

Folderpairs - Connection

Use WiFi: Check this setting, if this Folderpair is allowed to sync on WiFi.Turn on WiFi for scheduled syncs: Check this if WiFi can be turned on for this sync.Allowed WiFi SSID's: Enter a list of allowed WiFi SSID's to sync on. If empty, all WiFi networks are allowed.Disallowed Wifi SSID's: Enter a list of disallowed WiFi SSID's.Use 3G/4G: Check this setting, if this FolderPair is allowed to sync on 3G/4G mobile networks.Use Edge/2G: Check this setting, if this FolderPair is allowed to sync on 2G mobile networks.Use other connections: Enable this if other connection types should be allowed (Bluetooth, USB, etc.).Sync when roaming: Enable this to allow sync while roaming on mobile networks (use with care).Contents

Folderpairs - Notifications

Show notification when syncing: Show persistent notification while syncing folderpair.Show notification on sync success: Show dismiss-able notification on sync success.Show notification when changes occur: Show dismiss-able notification if transfers/deletions happened.Show notification on sync error: Show dismiss-able notification if syncs fail for any reason.Contents

Folderpairs - Advanced

Only sync if charging: Check this setting if FolderPair should only sync when charging.Rescan media library: Check this if media library should be updated for deleted or added media files.Use MD5 checksums: Check this setting if MD5 checksum should be calculated for files. May decrease sync speed and use extra battery, but can also result in less download and upload traffic. Enabled by default.Use temp-file scheme: Check this setting, if you want to use temp-file scheme. Temp-file scheme means files are transferred using temporary name, and upon completion of transfer is renamed to the final filename. This may break the functionality of some cloud providers (proper revisions etc.). Enabled by default.Disable file-size check: Check this if transferred files should not be validated against source by comparing file-size. Some providers adds bytes to certain files when uploaded, so this setting can help in those cases.Contents

Sync filters

In the full version you have the ability to create sync filters, where your can include or exclude files and folders based on file type, name, size, file age and modification date. Regular expression filtering is also supported (experts only). Sync filters are specific to the folderpair for which you configure them.

All filters are case-sensitive.

For file type filters you should enter the file type of the file, for example "jpg" or "doc". Don't include leading period.

All folders will be matched against folder filters - that means if you want to exclude or include a specific folder with name matching "xyz" then all folders in the tree under the root folder configured for the folderpair will be filtered, if it has the name "xyz".

To exclude or include only a specific "xyz" folder you have to include a forward slash ("/") in the name you specify. Then you can exclude a folder and all its sub folders with a folder filter of type "startswith" with value "/mnt/sdcard/rootfolder/xyz". When using full path in a filter please only use the "startswith" type filter.

To totally exclude a folder from all syncs, it is possible to place an empty file in a folder named ".foldersync_ignore". Then this folder will be excluded from all syncing. Both local and correspoding remote folder will be excluded if this is done for a folder, and vice versa.Contents

Settings

The settings panel allow you to configure settings for FolderSync. These settings are not backed up in the database.

General:Language: Set your preferred language.Startup screen: Set which screen should be displayed on initial startup.Disable notifications: If enabled, this totally disables all notifications from Foldersync.Temp folder: The device folder where FolderSync stores temporary files.Retain sync logs: The number of sync logs to retain. If limit is reached, oldest sync logs are deleted.

Sync options:Use full wakelock: This may be required on some devices, to stay awake during syncing.Disable scheduled sync: Check this to completely disable all scheduled or instant syncing.Difference in ms allowed when comparing files: When comparing files, modified timestamp are required to be identical, if files are to be considered equal. This lets you configure how much slack you will allow in this comparison.Required free space (MB): How much free SD card space is required on device. Syncs that writes files to local device will not start, if free space is below this threshold.

Security:Use access pin code: Enable this to require pin code when opening FolderSync.Pin timeout (seconds): The number of seconds FolderSync can be paused before again asking for pin code.The pin code to use: The code you want to use.

Backup:Disable automatic backup: FolderSync automatically backup up database at certain intervals. Check this to disable this backup.Backup folder: The folder where backups are createdBackup database: Press to create a backup nowRestore database: Press to restore a earlier created backup. You will be prompted with a list of backups located in the current backup folder.Contents

About

On the about view you can view license details regarding FolderSync or use the link to upgrade to full version (if you haven't done so already).

You can also enable logging and send logs to developer. Please see the troubleshooting section for more info on logging.

Support:Enable verbose logging: Enable more verbose logging. May slow down syncing, but can provide invaluable information to debug errors.Review logs: Press to review collected log.Send collected logs: Press to send log to developer.Get support: Pressing this will open the support webpage in a browser.Contents

Tasker

The full version of FolderSync works as Tasker plugin. This means one or more folderpair syncs can be initiated when a condition or rule you configured in Tasker occurs. Configuring Tasker is out of the scope of this help text, but FolderSync is found in the the Plugin section. Note that syncs will run no matter what settings they are configured with, when initiated from Tasker, except if the allowed connection type(s) is not met.Contents

Shortcuts

You can add shortcuts to sync folderpairs, favorites and the main app sectoins to your Android home screen. Do this the normal way. When adding the shortcut you will be prompted which item you want add a shortcut for.Contents

Troubleshooting

FolderSync incorporates its own log collection functionality, to help the developers fix bugs that might exist. It can be enabled on the about screen, where it can also be emailed to the developer.

To create a log file with useful data, please check [Enable verbose logging] on the FolderSync about screen. Redo the function/action that fails (previous errors will not be logged, so its important to recreate the error). After that, go back to the about screen and review the log. Then press [Send collected logs] to attach the log to a new e-mail. Add your description of the problem and press send. (emails without description are auto-deleted).Contents

Limitations in lite version

The following limitations are present in the lite version:Only two accountsNo instant syncNo sync filtersDisplays adsContents

Upgrading from lite version

Create a database backup in the lite version in the settings menu. Then fire up the full version and restore the database backup you created in the lite version to import settings - this will overwrite existing database so beware. That's its.Contents