Skip to content

Home

Jump to bottom
Jude Nelson edited this page Dec 23, 2013 · 12 revisions

Welcome to the Syndicate Wiki. Below you'll find pages that provide detailed information on how to use, deploy, and hack on Syndicate.

Overview

Syndicate organizes your data into one or more Volumes. A Volume is a logical collection of data organized into a filesystem. Syndicate's components work together to implement your Volumes on top of your cloud storage and caches.

There are four major components of Syndicate: the Metadata Service (MS), the User Gateway (UG), the Replica Gateway (RG), and the Acquisition Gateway (AG). The MS is an always-on service that Gateways use to coordinate--in many ways, it's similar to a private BitTorrent tracker. The UGs are peers that cache and exchange Volume data and metadata on your behalf, and give you read/write interfaces to your data. For example, there is a FUSE UG, and a Web store UG. RGs are proxies that take data from UGs and back it up to your storage, so other UGs can get to it. AGs are proxies that expose external, existing datasets as read-only directory hierarchies in your Volumes.

At a minimum, you need to deploy the MS, one UG, and one RG. That will get you Dropbox-like functionality.

Getting Started

  1. Set up or find an MS to use.
  2. Set up and learn how to use syntool.
  3. Create your first Volume.
  4. Create your first User Gateway
  5. Create your first Replica Gateway
  6. Create your first Acquisition Gateway

Deployment

Deploying the MS

Clone this wiki locally