Table of contents
Documentation
Welcome to the documentation & knowledge base of SyncPlanet, the animation studio connection and file synchronisation solution.
Introduction
These articles will help you through the basics of SyncPlanet, from navigation to setting things up for the first time. We highly recommend checking these out if this is your first time using SyncPlanet, or if you are unfamiliar with file synchronisation systems.
- User Interface This article will help you understand the basic elements of the UI and how to properly navigate it.
- Glossary This article lists all the terminology specific to SyncPlanet.
- Tutorial: Hub Setup This tutorial is designed to guide you through the setup of a hub, the first steps required to start synchronising your studio's files.
- Tutorial: Storage Setup This second part of the tutorial will guide you through the setup of your storage units. Going through the first part is recommended, as you need a functioning hub for your storage units to work.
- Tutorial: Teams Setup This last part of the tutorial deals with teams setup. Please ensure you're familiar with the first two parts before checking this article, as teams cannot function properly without a hub and storage units.
Elements
Synchronisation Scopes
These articles contain information on the hub and its subsidiaries, the storages and channels. A hub transfers the files between its connected storages through channels. You can control each part using a contextualised configuration.
- Hub The hub is the core of any SyncPlanet system. This article lists all the important information related to the hub, its interface, configuration, and management.
- Storage Storage units host the files that transit through the hub. This article lists all the important information related to storage units, their interface, configuration, and management.
- Channel Channels are sets of instruction that allow for the transfer of files between storages. This article lists all the important information related to channels, their creation, interface, configuration, and management.
Other Elements
These articles contain information on smaller aspects of SyncPlanet, the user, teams, and individual files.
- User TBA
- Team TBA
- File TBA
Rsync
Rsync is a free and open source software with numerous options and a powerful filter syntax to control the file transfers. You can drive your automated configuration from here. The following articles contain information on how to use and understand those options and filters.
- Rsync Command Line Options This article lists the most commonly used rsync line options for the hub, storage units, and channels. Please note that this list is far from exhaustive.
- Include and Exclude Filters This article explains the way filters operate and lists the most commonly used filters. As with options, the list is not exhaustive.
- Logs This article covers the logs and how to understand them.
API
With a few lines of Python, upgrade your pipeline with multisite publish and listen to triggered events at file delivery.
- Reference This article contains an overview of the API, its functions, and management.
- Packages This article deals with packages, their logic, and how to publish them.
- Priorities This short article will explain how to manage the priorities of your files.
- Destination-Filtering This article deals with the management of your files' destinations.
- Environment-Setup This article explains how to access the API.
Maintenance
Here you will find information on how to manage bugs and errors. If the problem is outside the current scope of this documentation, you can also contact us using the link.