ZenFS Cloud

This package adds backends for many cloud providers to ZenFS, including:

• Dropbox
• Amazon Web Services' S3
• Google Drive

For more information, see the API documentation.

Please read the ZenFS core documentation!

Installing

Important

This project is licensed under the LGPL (v3+).

npm install @zenfs/cloud

Examples

Note

Due to the nature of cloud backends, it isn't possible to test them in CI/CD. Please report any issues so they can be fixed!

Dropbox

import{configure,fs}from'@zenfs/core';import{Dropbox}from'@zenfs/cloud';import{DropboxasDropboxClient}from'dropbox';constclient=newDropboxClient({accessToken: '...',// ...});awaitconfigure({mounts: {'/mnt/dropbox': {backend: Dropbox,
client,},},});

S3

import{configure,fs}from'@zenfs/core';import{S3Bucket}from'@zenfs/cloud';import{S3}from'@aws-sdk/client-s3';constclient=newS3({// ...});awaitconfigure({mounts: {'/mnt/s3': {backend: S3Bucket,bucketName: 'your-bucket',
client,},},});

Google Drive

import{configure,fs}from'@zenfs/core';import{GoogleDrive}from'@zenfs/cloud';awaitconfigure({mounts: {'/mnt/gdrive': {backend: GoogleDrive,drive: gapi.client.drive,},},});