Synchronized Storage

A storage, or Network Attached Storage (NAS), is a device accessible by the hub through the network using the SSH protocol. It can be located behind an Internet service provider or in a data center.

Storage Main Panel

The storage's main panel is divided into 4 sections:

• Geographic map
• Link explorer
• Rsync options
• Health Status

Geographic Map

This map shows the location of the storages, their hub and the links between them. It is centered on the current storage. The localization of the storage is approximated according to its specified hostname, using a IP2GEO service.

Channels Explorer

This interface let you explore the configured synchronisation channels between the storage and its hub. Multiple channels can be expanded to read several channels at a glance using the and buttons.

An channel's status is shown using a (activated) or a (deactivated) icons. You can toggle a channel on and off by pressing this button.

The direction of the transmission is shown using up (upload) and down (download) arrow icons. The current transmission activity is shown using a blinking arrow, and the color of the arrows fades with time.

upload finished on 23-12-15 11:19:03+00:00
duration 9"

Read the rsync filters and the rsync options sections for more details about the links and how to configure them.

Rsync Options

This interface let you configure the rsync options on the volume scope. These options will be used on every links that connects the volume. You can specify some options for a specific direction only.

Read the rsync options section for more details.

Health Status

Storage Parameters

The parameters are described below.

Name (system)

Long Name

Short Name

Identifier

Host Name

SSH Port Number

User Name

Path

Shell

Programming Interface

The storages are described as JSON objects that you can modify using the API.

{
"_id": "vol_01FWEWD03P3J2H98TQ0Y4AXF3H",
"agentExitTime": "2023-10-05 13:33:39+00:00",
"agentStartTime": "2023-10-05 15:05:29+00:00",
"agentStatus": "on",
"author": "support",
"bytesRemaining": 18691697672,
"bytesTotal": 43980465111,
"bytesUsed": 25288767438,
"comment": "\n",
"hostname":"yourstudio.eu",
"image": "syncplanet/sync2:1.1.1",
"enable": true,
"error": 0,
"geoloc": [2.38333,48.91667],
"lastConnectionStatusChange": 1696512782000,
"lastErrorStatusChange": 1696512782000,
"longName": "Studio 1 - Producer",
"name": "1prod",
"port":3222,
"rsync_args": "",
"shell": "",
"shortName": "Studio1 Prod",
"time": 1603117017286,
"username": "sync",
"version": "1.1.1"
}

You can read environment setup page and API for details about how to setup a client and start programming.

Storage Setup

A connected storage is a standard volume configured to be accessible from the remote synchronization agents running on the hub. The volume sould be sized accordingly to the project needs, expandable or shrinkable later on the fly.

1. Configure a Server

It consists in a machine running:

• OpenSSH server
• rsync

The rsync command should be accessible in the user's shell.

2. Open a Network Port

Please open a port for SSH on your firewall to the machine you will use to serve the files.

Please indicate the port number you will open if it is different from the default port 22.

Once each step is completed we have a complete URL to access the storage:

ssh://username@hostname:port/folder

3. Configure the synchronization

• Install the central synchronization hub's public ssh key (into the user's authorized_keys under the user account)
• Create an empty file named .SyncPlanetVolumeRoot in the volume's root folder

Next

You might continue reading:

• Try a demo storage
• Continue reading the documentation about the channels
• Continue reading about the hubs
• Read the troubleshooting to debug a storage