Skip to main content

Getting started

In order to use rac-delta, you have 2 options:

  • Use one of the available SDKs
  • Create your own implementation following protocol and core sections

We recommend using the SDK if it fits with your language. Both Rust and Node SDKs are efficient and highly customizable, with support to different storages, reconstruction strategies, streaming and more.

Before you start with rac-delta, we recommend to read the protocol section.

You will need:

  • Storage solution: Available ones are S3, Azure Blob, GCS, SSH, HTTP, Signed URLs and even Local Storage.

The chosen storage will be where chunks and rd-index.json will be stored.

Installation​

For now, rac-delta SDK is only available in Rust and NodeJS. You can install rac-delta this way:

Install with npm or yarn:

npm install rac-delta
yarn add rac-delta

Features​

rac-delta only brings local storage adapter by default, if you plan to use cloud integrations, you will need to install features or peer dependencies.

List of peer dependencies:

  • @aws-sdk/client-s3
  • @azure/identity @azure/storage-blob
  • @google-cloud/storage
  • ssh2