Server hubs organize the file transfers between the connected volumes. They are usually installed in a datacenter on a high availability machine to provide an optimal and continuous service. The hub user interface shows the access path, the project's title, and tabs.
The hub's main panel graphical user interface is divided in sections:
The map is used to show the hub, the connected volumes and their links. They are positioned using a IP address to geolocalization service. The green marker is the hub, blue markers are volumes, links are green. Error volumes are red, archived volumes are deep blue.
This is an interactive user interface that lets you explore the volumes and the links beneath them. It shows the current activity as a blinking icon and allows to enable/disable links. Multiple links can be expanded to show several filters at a glance.
Rsync provides a wide range of options that enable you to customize its behaviour and control various aspects of file transfer.
--times --update --omit-dir-times --recursive --compress
The rsync options that are used globally (on every rsync calls for this project). Visit the Rsync-Parameters page for more details.
The filters defined on the hub are systematically used on each transfer, in the order: 1 hub filters
, 2 link filters
, 3 - *
. Visit the Rsync-Filter-Rules page for more details. Here are basic filters that could be applied on a typical project:
# Global RSYNC Filter Rules
# The filters below are applied first
# on every directions and volumes
# skip hidden files
- .*
# skip backup files
- *~
# skip potential malware
- *.dll
- *.exe
demo
A short code name used to identify the project among the other projects. Composed of a string from 3 to 16 character long containing lowercase characters and numbers. The exact accepted regex pattern is ^[a-z0-9_]{3,16}$
.
Movie Production
A longer name, often the real long name with no size limit, used for the titles in documents.
Demo
A shorter name, used when the display needs a more consize form.
hub_01FX33ZYB78E9F5FTZMKC96A4P
An automatically generated string to identify the hub of the form: hub_#
where #
is a Universally Unique Lexicographically Sortable Identifier.
The public part of the key used to make the SSH connections to the connected volumes. This key is dedicated to the hub and to the project.
When important events occur such has volume disconnections and reconnections, the service can send a notification to a list of emails (usually administrators') and to a webhook.
A view of the current's hub connections.
The hub is described as a JSON object that you can also modify using the API.
{
"_id": "hub_01FX33ZYB78E9F5FTZMKC96A4P",
"author": "support",
"bytesRemaining": 39450477204,
"bytesTotal": 57174604644,
"bytesUsed": 17724127439,
"comment": "# Movie Production Demo\n\nThis example is showing the data flows for a fictional 3D animated\nmovie production.",
"enable": true,
"error": 0,
"filters": "# Global RSYNC Filter Rules\n# The filters below are applied first\n# on every directions and volumes\n\n# skip hidden files\n- .*\n\n# skip backup files\n- *~\n\n# skip potential malware\n- *.dll\n- *.exe",
"geoloc": [3.17456,50.69421],
"hostname": "",
"image": "syncplanet/run:1.0.32",
"longName": "Movie Production",
"name": "demo",
"path": "/projects/demo/",
"rsaPublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAXACAQBYinfRa2J3Yst6TzAwB3mZ7a/yD4VplB/g4QWAJ8C/CkPEtCOArlFj9kAD1rbsRwq1qPb5HqFf6bMM/OQeYxNMf2HGjwBnFxQujVlb10hkrncKUL9wvKhtwjsLd5lGLTqH7A7ioUHjepLFRd6ntitvDAPI9JlCZoELyCZNEGYAgtBflazTXSlgYGZO23xzfFDZt22I9F1FmN7iDG2NxYHrmHa2B0D1VgqLtHbgQEzsh6PtQNAoTCMI25lt9Sy2inSMqS18IfJIe1OaBGo7tCPwFFzk7EwqHaa7ECHGmh6tHLO4XJ/Sgc7VCJiW9OV1nMlc1HRA8KeVDcCqIWZXagBy3DzIj0+7Ul/rxuY9KHh4XynWRRW8gtUVDlDbnbUOnbCl51D7I4HfQJWEJrZP6ModX/baQRkTi9XufsogWaRNTPKDvFFT3kP316DMdrwuy/guNlpnWEQq/UG13+z8JoJPe60wiUn6qMuk5L4Ftq7pqDaVsMTKlZnUzvRkEBA1sUKlBJSIX4lX5B6Ol0AxOEOlP9wME2+Vaf3qu8XMMmymTQlTSIksc3Ltc5PTsHUBkK6WWE5+T3Z+ZEE9MyBYhqsXLyaxuGCybuBIk9VUislYPk+1y43o2qRIBSop4TA1kEQ89xeAwS8afuSMJ5a7Af3jX4IaGE1YAooPRolgliQT2w== demohub@syncplanet",
"rsync_args": "--times --update --omit-dir-times --recursive --compress",
"shortName": "Demo",
"time": 1639134611215,
"webhookURL": ""
}
Please read Environment-Setup and API for details about how to setup a client.
You can try the hub demo interface or continue reading the documentation about the volumes and the links.