Table of contents
User Interface
The SyncPlanet user interface is designed to be intuitive and easy to navigate. Here you will find a breakdown of its main features.
Navigation
You can navigate through the different pages in SyncPlanet using the navigation bar or by clicking on an element name in the channel explorer.
Navigation Bar
You can easily navigate between different elements in SyncPlanet using the navigation bar:

The bar lets you navigate between the elements using a clickable hierarchy-like path: hub storage channel
Note
The hub, storages and channels can be represented as a tree:
hub/
├── storage1/
│ ├── chan
│ ├── chan
│ └── chan
├── storage2/
│ ├── chan
│ ├── chan
│ └── chan
└── storage3/
├── chan
├── chan
└── chan
The right side of the navigation bar is composed of an icon showing the element type, a contextual help icon, and a toggle in cases of channels and storage units.
Tabs
Each page contains a series of tabs. The number and types vary from elements (hubs, storage units, teams, channels). Simply click on a tab to open it.

Note
Edits (such as parameter changes) will not be lost upon switching tabs.
Icons
SyncPlanet uses icons and interactive buttons to highlight important information and offer functions.
Buttons
These clickable elements are displayed in light blue and are fully interactive:
- Contextual help. Click on these icons to display a short explanation about its element and a link to the relevant documentation (when applicable).
- A toggle to enable or disable the channel or storage unit. When toggled on (), the element will be read by the synchronisation when it comes to its turn on the process loop. When toggled off (), the element will not be read and will be skipped when the processing agent reaches its turn in the sequence. Toggling off a in-progress element won't kill the ongoing synchronisation process, it waits until the rsync process finishes, and won´t start it until it is switched on again.
- Click on this button to create a new element such as a team (in the main page), a storage unit (in the hub), or add new rsync options (in the parameters).
Information only
These icons highlight important information:
- This icon shows that the element is a hub.
- This icon shows that the element is a storage unit.
- This icon shows that the element is a channel.
- and Channels only These indicate the activity and the direction of the channel. A up arrow means that the storage is sending to the hub (upload), a down arrow means the storage is receiving (download). A blinking arrow means that the channel synchronisation is in progress.
- and Channels only These indicate the direction of the channel regardless of activity.
- Hub explorer only This indicates that the channel or storage unit is functioning properly.
- Hub explorer only This indicates an error with the channel or storage unit has encountered an error. Hover on the icon or click on the channel/storage unit for more information on the error.
- Channel explorer only This indicates that some unidentified files are being deleted at the destination.
- Rsync option This indicates that the
--timesor preserve modification times option is enabled. - Rsync option This indicates that the recurse into directories option is enabled.
- This indicates that the
--moit-dir-timesor omit directories from the -times option function is enabled. - Rsync option This indicates that the
--deleteor delete extraneous files option is enabled. - Rsync option This indicates that the
--progressor show progress during transfer option is enabled. - Rsync option This indicates that the
--compressor compress file data during transfer option is enabled. - Rsync option This indicates that the
--updateor skip newer files on the receiver option is enabled. - Rsync option This indicates that the
--dirsor transfer directories without recursing option is enabled. - Rsync option This indicates that the
--fake-superoption, allowing for the restoration of extended attributes, is enabled. - Rsync option This indicates that the
--linksor copy symlink option is enabled. - Rsync option This indicates that the
--recursiveor recurse into directories option is enabled.
Note
Click on the icons of the Rsync options to check the relevant documentation.
Demo
If you're unsure about the different tools and navigational options, you can try them out yourself with our freely accessible demo.
Next
Further reading :
- Learn how to start setting up SyncPlanet with our hub tutorial
- Find out more about our terminology in the glossary