A volume is a data storage area accessible through the network. It can be located in a company connected to Internet or in a data center.
The volume's main panel graphical user interface is divided in 3 sections:
1prod
A short code name used to identify this volume among the other volumes of the project. This name is a string from 3 to 16 character long containing lowercase characters and numbers. The exact accepted regex pattern is ^[a-z0-9_]{3,16}$
.
Studio 1 - Producer
A longer name, often the real long name with no size limit, used for the titles in documents.
Studio1 Prod
A shorter name, used when the display needs a more consize form.
vol_01FWEWD03P3J2H98TQ0Y4AXF3H
An automatically generated string to identify the volume of the form: vol_#
where #
is a Universally Unique Lexicographically Sortable Identifier.
Host name or IP address of the machine host.
The network port configured to access the volume using the SSH protocol. 22
is the default SSH port. You can indicate another port number if it is different from the default port.
In a normal configuration, this port will only be accessed by the project's server hub. To increase security you can authorize its IP address only in your firewall configuration.
User account on the machine host.
Install the provided public SSH key under
.ssh/authorized_keys
in the user's home directory. This key is used by the hub to access the volume without password.
The rsync
command must be installed on the system and accessible through this user's shell.
The configured path to access the volume's files. For example: /folder/
.
A file named
.SyncPlanetVolumeRoot
in the volume's root folder is mandatory to start the file transfers. This allows the synchronization agents to verify that the folder is ready and mounted.
A command to use in place of the native shell. This is useful if the service is ran inside a docker container. Example: /share/bin/docker exec -i centos-1 bash
To get more information about setting up a volume, an OpenSSH server and rsync on specific systems such as Synology NAS and microsoft servers please see Setup-on-specific-systems.
The support is available anytime to help setting up your volumes and for any information : support@syncplanet.io.
A volume is described as a JSON object that you can also 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",
"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",
"rsync_args": "",
"shell": "",
"shortName": "Studio1 Prod",
"time": 1603117017286,
"version": "1.1.1"
}
Please read Environment-Setup and API for details about how to setup a client.
You can play with the interface of the demo volume or