Documentation & Reference Center

BrickFTP Sync Desktop Application

BrickFTP Sync is an app that you and your users can install on your computers to sync your BrickFTP account to your desktop computer.

You can sync your entire folder tree, or select folders individually to sync. If you have multiple BrickFTP usernames (even if they are for entirely separate businesses), you can use multiple accounts at the same time in the application.

Any change made on BrickFTP will automatically propagate to the local folder(s) and any change made on the local folder(s) will automatically propagate to BrickFTP.

With BrickFTP Sync running, you can also right click anywhere inside your BrickFTP shared folder in Finder or Windows Explorer to get a sharable direct download link to any file or folder on BrickFTP. (This requires your user to have permission to generate Share links.)

BrickFTP Sync uses our proprietary network of global accelerated edge locations in California, Virginia, Germany, Brazil, Japan, Singapore, and Australia to give you and your users the fastest possible transfer times, regardless of location. Of course, if you have opted out of global acceleration (or are a HIPAA customer), we will automatically route your traffic only to your preferred jurisdiction.

And the BrickFTP Sync app is designed to only use port 443 outbound so you should not require any additional firewall setup.

White Label Opportunities

We offer our Enterprise customers the ability to fully whitelabel the BrickFTP Sync desktop app for an additional fee. Please contact us for further information about whitelabelling.

Granting Users Permission

Before downloading BrickFTP Sync, first log in to BrickFTP and go to your Users tab and click on your users to ensure your users have permissions enabled for “Able to log in via Desktop App or REST API”.

This permission is granted by default, but if you have adopted more restrictive default permissions you may need to add it to your users.

Downloading and Installation

To download BrickFTP Sync, use one of the following download links:

The package is a normal installer package. Double click on the package to run the installer and follow the prompts to install BrickFTP Sync.

The installation process requires administrator privileges so be prepared to enter an administrator password when prompted.

Once installed, the app will check for newer versions and allow you to upgrade if an update is available.

Using the BrickFTP Sync App

The BrickFTP Sync app runs in the background and displays a status icon in the system tray on Windows or status bar on macOS.

The status indicator uses the following icons to indicate the current sync status:

OK The green circle with a checkmark indicates that your sync is current and you are connected to your BrickFTP site.
Syncing The blue circle with a syncing symbol indicates that sync is in progress.
Paused The yellow circle with parallel lines indicates that your sync has been paused.
Offline The gray icon with an ellipsis indicates that the app has lost its connection with your BrickFTP site. This usually means there is an issue with your internet connection or firewall.
Error The red circle with an “x” indicates a configuration error, such as an incorrect login.

System Tray / Menu Bar Menu

Clicking on the status icon (left-click on macOS, right-click on Windows) opens a menu for easy access to the most commonly used actions.

This menu provides the following actions and information:

  • Open the BrickFTP Sync app
  • Open BrickFTP in your browser
  • Open your local synced folder(s)
  • Sync status
  • Recent activity
  • Help and About links
  • Pause sync(s)
  • Log in or log out of your BrickFTP account(s)
  • Quit BrickFTP Sync, logging out and closing the app

Initial Setup of Your Account

When first launching the BrickFTP Sync app, you will be prompted to enter the username and password for your BrickFTP account. If you have multiple accounts, start with one now. You can always add the other one(s) later.

Next you will be prompted to select which folders on BrickFTP to sync, and the local folder to sync to.

If you choose ‘Sync everything from BrickFTP’, the BrickFTP Sync app will download every file on BrickFTP that is visible to you. You will be able to exclude certain subfolders later.

If you click the button for ‘Choose what to sync’, you will be able to choose only specific subfolders to be synced. If you choose this option, you can always add or remove subfolders later.

If you are only syncing a single account, we recommend leaving the local folder at the default setting. If you are syncing multiple accounts, we recommend choosing a local folder that is named to match the particular account being synced.

After clicking Finish, the BrickFTP Sync app will open.

In the top pane of the app are tabs for each configured sync account, as well as tabs for Activity and Settings.

On your Sync tab (if you have more than one account, it will be labelled with the account name) you will see the following things:

  • Connection status, showing your BrickFTP username and the local folder being synced to.
  • An Open Folder button to open the local synced folder.
  • A Sync From Additional Account button, allowing you to add additional BrickFTP accounts to be synced.
  • A Stop Syncing This Account button to remove the account.
  • Current sync status.
  • A Pause Sync button to pause sync for this account.
  • The Select folders to sync area to choose which folders to sync.
  • For each folder being currently synced (either the root or a subfolder), a Stop Syncing button to stop sync of this folder.

Activity Logs

On the Activity Tab, you can view a list of files that were synced successfully, as well as a list of failures. There is a button to copy the current list to the clipboard.

Settings

On the Settings tab, you can configure general application settings as well as configure an HTTP Proxy Server to use (if one is required for your network).

Sharing Files or Folders Via Windows Explorer or Finder

The BrickFTP Sync app integrates with Finder on macOS and Explorer on Windows. You can create share links to share files with anyone, similar to how you do so in the web interface.

Open Finder on macOS or Explorer on Windows, and you will see your BrickFTP account(s) conveniently displayed under ‘Favorites’. This allows you to quickly enter your local BrickFTP folder(s).

After entering your local BrickFTP folder, right-click the file or folder you want to share, and click Share with BrickFTP.

The share dialog displays your share URL, along with a Copy link button to copy the URL to the clipboard.

Additional Information For System Administrators

Unattended Installations

Both the Windows installer .exe and the macOS package should support unattended installation for bulk distribution of the software. You can also automate the configuration of the BrickFTP Sync application by creating a file called brickftp.cfg in the appropriate location before installation.

To install the Windows installer in an unattended manner, run this command (as an Administrator) programmatically on the machine:

BrickFTP Sync-1.0.0.exe /S

To install the macOS package in an unattended manner, run this command progammatically on the machine:

sudo installer -verboseR -pkg "BrickFTP Sync-1.0.0.pkg" -target /

Updates may be delivered by simply running the new version’s installer. Configuration will be kept in place from the old version.

The app also includes its own update mechanism that will prompt the user to install the latest version if an update is available.

BrickFTP Configuration File Format

The BrickFTP Sync application reads and writes configuration to/from a file called brickftp.cfg. On macOS, this file is stored in ~/Library/Application Support/BrickFTP Sync. On Windows, this file is stored in %LOCALAPPDATA%\BrickFTP Sync which in recent versions of Windows expands to C:\Users\<User>\AppData\Local\BrickFTP Sync.

If you want to preset values such as username, local sync path, and remote target sync path, please write a brickftp.cfg file before performing an unattended installation of the application.

The configuration file contains many non-user-editable things such as window geometry. This documentation focuses only on the keys that a system administrator should need in order to perform an unattended installation.

The file is formatted using Windows INI-style formatting. The only sections documented are called General, Logging, Proxy, and Accounts.

Here is a sample default configuration file you can provide before installation:

[General]
crashReporter=true
skipUpdateCheck=false
desktopNotifications=true

[Logging]
maxLogLines=20000

[Accounts]
0\Folders\0\localPath=/Users/my_user/BrickFTP/
0\Folders\0\targetPath=/
0\Folders\0\paused=false
0\Folders\0\ignoreHiddenFiles=true
0\url=https://app.brickftp.com
0\user=MyBrickFTPUser
1\Folders\0\localPath=/Users/my_user/MyOtherBrickFTPUser/Dictation/
1\Folders\0\targetPath=/Dictation/TeamA/
1\Folders\0\paused=false
1\Folders\0\ignoreHiddenFiles=true
1\Folders\1\localPath=/Users/my_user/MyOtherBrickFTPUser/Transcription/
1\Folders\1\targetPath=/Transcription/TeamA/
1\Folders\1\paused=false
1\Folders\1\ignoreHiddenFiles=true
1\url=https://my_other_brickftp_site.brickftp.com
1\user=MyOtherBrickFTPUser

General configuration options:

crashReporter boolean Whether to enable the crash reporter, which sends reports about application crashes back to BrickFTP’s engineers. Defaults to true.
skipUpdateCheck boolean Whether to skip checking for updates and installing them automatically. Defaults to false. Note that some updates are required and setting this to true without providing an alternate updating mechanism for your users could leave them unable to open the software.
monoIcons boolean Whether to use monochrome icons. Defaults to true on macOS and false on Windows.
desktopNotifications boolean Whether to display desktop notifications of application activity. Defaults to true.
remotePollInterval integer How often we poll BrickFTP for changes in milliseconds. Defaults to 30000. Please do not lower this value, but you may raise it.
updateCheckInterval integer How often we check for application updates in milliseconds. Defaults to 10 hours. Please do not lower this value below 5 minutes.

Logging configuration options:

maxLogLines integer Maximum number of log lines displayed in the debugging log window. Defaults to 20000.

Proxy configration options:

type integer flag Set to 0 to use System Proxy, set to 1 to use a SOCKS proxy, set to 2 to not use any proxy, set to 3 to use an HTTP proxy. Only provide the remaining settings if this is set to 1 or 3.
host string Proxy server hostname.
port integer Proxy server port.
needsAuth boolean Does proxy server require authentication?
user string Proxy server username.
pass encrypted string Proxy server password. To generate an encrypted password, open the BrickFTP Sync app and save the password a single time, then read the generated encrypted password from brickftp.cfg.

Accounts configuration options:

Because BrickFTP Sync supports multiple accounts, the accounts configuration options are prefixed with a numeric zero-based index. To add multiple accounts, simply add more configuration options with a new index. The same is true for folders being synced inside an account. You may either sync a single folder (either the root or a subfolder) or you may sync multiple folders.

Replace the X’s and Y’s in the following table with 0-based integers representing the Account (X) and Folder (Y).

X\Folders\Y\localPath path Local path to sync.
X\Folders\Y\targetPath path Path on BrickFTP to sync. This is the full path on BrickFTP, not a path relative to any user root.
X\Folders\Y\paused boolean Pause syncing this folder? Defaults to false.
X\Folders\Y\ignoreHiddenFiles boolean Ignore local files that are hidden for this sync? Defaults to true.
X\url string URL for connceting to the BrickFTP API. If you have a local (behind the firewall) installation of BrickFTP or if you have disabled global acceleration features, you will need to change this to the proper URL for your BrickFTP installation. Defaults to https://app.brickftp.com
X\user string BrickFTP username associated with this account.

Additional sections will appear in the configuration file after the application runs. Please do not edit these when making configuration file changes in the future.

Crash Reporter

There is a built in crash reporter that will send us information about the application if it should crash. These crash reports are sanitized to exclude any sensitive information about the machine in question. Sending crash reports is optional and the user must approve the crash report being sent before it will be sent.

If you wish to disable the crash reporter entirely, please set the crashReporter configuration option to false.

Automatic Updates

Once installed, the app will check for newer versions and allow you to upgrade if an update is available.

If your local policies for software distribution conflict with having an automatic updater and you wish to disable this behavior, please set the skipUpdateCheck configuration option to true.

Low Disk Space

BrickFTP Sync is designed to intelligently pause its activity when it detects that the machine is running low on disk space. Syncing is aborted entirely when free disk space is below 50MB and no file will be downloaded if it would cause free disk space to fall below 250MB.

Getting Support and Providing Feedback

We would love to hear any and all feedback about the BrickFTP Sync app, including feature suggestions. We are particularly interested in learning about any errors you encounter or anything that is unclear or appears broken.

Also, general comments are welcome. Is this app useful to you? What does it replace? What could it replace, but can’t quite yet because of something missing?

To contact us, use any of the contact methods here.

The BrickFTP Sync application is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. To view the GNU General Public License, click here.

BrickFTP Sync is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. BrickFTP Sync is based on ownCloud Desktop Client by Klaas Freitag, Daniel Molkentin, Jan-Christoph Borchardt, Olivier Gofer, Markus Götz and others. ownCloud Desktop Client is Copyright ownCloud, Inc and licensed under the GNU General Public License (GPL) Version 2.0. To receive a copy of the full source code for BrickFTP Sync for no charge, please send E-Mail to [email protected] or a written request to Action Verb LLC, PO Box 29502 #20898, Las Vegas, NV 89126, United States. This offer is valid for three (3) years from today’s date. We will promptly respond to all requests.

Some portions of these documentation are adapted with changes from the ownCloud Client Documentation, which is Copyright ownCloud Inc. and released under the Creative Commons Attribution 3.0 Unported license.