Skip to content

Spacedrive is an open source cross-platform file explorer, powered by a virtual distributed filesystem written in Rust.

License

Notifications You must be signed in to change notification settings

fullstop125/spacedrive

 
 

Repository files navigation

Logo

Spacedrive

A file explorer from the future.
spacedrive.com »

Download for macOS · Windows · Linux · iOS · watchOS · Android
~ Links will be added once a release is available. ~

Spacedrive is an open source cross-platform file manager, powered by a virtual distributed filesystem (VDFS) written in Rust.

NOTE: Spacedrive is under active development, most of the listed features are still experimental and subject to change.

Organize files across many devices in one place. From cloud services to offline hard drives, Spacedrive combines the storage capacity and processing power of your devices into one personal distributed cloud, that is both secure and intuitive to use.

For independent creatives, hoarders and those that want to own their digital footprint. Spacedrive provides a file management experience like no other, and it's completely free.

Logo


What is a VDFS?

A VDFS (virtual distributed filesystem) is a filesystem designed to work across a variety of storage layers. It is not restricted to a single machine, with a uniform API to manipulate and access content across many devices. It achieves this by maintaining a virtual index of all storage locations, synchronizing the database between clients in realtime. This implementation also uses CAS (Content-addressable storage) to uniquely identify files, while keeping record of logical file paths relative to the storage locations.

The first implementation of a VDFS can be found in this UC Berkeley paper by Haoyuan Li. This paper describes its use for cloud computing, however the underlying concepts can be translated to open consumer software.

Motivation

Many of us have multiple cloud accounts, drives that aren’t backed up and data at risk of loss. We depend on cloud services like Google Photos and iCloud, but are locked in with limited capacity and almost zero interoperability between services and operating systems. Photo albums shouldn’t be stuck in a device ecosystem, or harvested for advertising data. They should be OS agnostic, permanent and personally owned. Data we create is our legacy, that will long outlive us—open source technology is the only way to ensure we retain absolute control over the data that defines our lives, at unlimited scale.

Features

Note: Links are for highlight purposes only until feature specific documentation is complete.

Complete: (in testing)

  • File discovery - Scan devices, drives and cloud accounts to build a directory of all files with metadata.
  • Preview generation - Auto generate lower resolution stand-ins for image and video.
  • Statistics - Total capacity, index size, preview media size, free space etc.

In progress:

  • File Explorer - Browse online/offline storage locations, view files with metadata, perform basic CRUD.
  • Realtime synchronization - Data index synchronized in realtime between devices, prioritizing peer-to-peer LAN connections (WiFi sync).

To be developed (MVP):

  • Photos - Photo and video albums similar to Apple/Google photos.
  • Search - Deep search into your filesystem with a keybind, including offline locations.
  • Tags - Define routines on custom tags to automate workflows, easily tag files individually, in bulk and automatically via rules.
  • Extensions - Build tools on top of Spacedrive, extend functionality and integrate third party services. Extension directory on spacedrive.com/extensions.

To be developed (Post-MVP):

  • Cloud integration - Index & backup to Apple Photos, Google Drive, Dropbox, OneDrive & Mega + easy API for the community to add more.
  • Encrypted vault(s) - Effortlessly manage & encrypt sensitive files, built on top of VeraCrypt. Encrypt individual files or create flexible-size vaults.
  • Key manager - View, mount, dismount and hide keys. Mounted keys automatically unlock respective areas of your filesystem.
  • Redundancy Goal - Ensure a specific amount of copies exist for your important data, discover at-risk files and monitor device/drive health.
  • Timeline - View a linear timeline of content, travel to any time and see media represented visually.
  • Media encoder - Encode video and audio into various formats, use Tags to automate. Built with FFMPEG.
  • Workers - Utilize the compute power of your devices in unison to encode and perform tasks at increased speeds.
  • Spacedrive Cloud - We'll host an always-on cloud device for you, with pay-as-you-go plans for storage.
  • Self hosted - Spacedrive can be deployed as a service, behaving as just another device powering your personal cloud.

Developer Guide

Please refer to the contributing guide for how to install Spacedrive from sources.

Architecture

This project is using what I'm calling the "PRRTT" stack (Prisma, Rust, React, TypeScript, Tauri).

  • Prisma on the front-end? 🤯 Made possible thanks to prisma-client-rust, developed by Brendonovich. Gives us access to the powerful migration CLI in development, along with the Prisma syntax for our schema. The application bundles with the Prisma query engine and codegen for a beautiful Rust API. Our lightweight migration runner is custom built for a desktop app context.
  • Tauri allows us to create a pure Rust native OS webview, without the overhead of your average Electron app. This brings the bundle size and average memory usage down dramatically. It also contributes to a more native feel, especially on macOS due to Safari's close integration with the OS.
  • The core (sdcore) is written in pure Rust.

Monorepo structure:

Apps:

Core:

  • core: The Rust core, referred to internally as sdcore. Contains filesystem, database and networking logic. Can be deployed in a variety of host applications.

Packages:

  • client: A TypeScript client library to handle dataflow via RPC between UI and the Rust core.
  • ui: A React Shared component library.
  • interface: The complete user interface in React (used by apps desktop, web and landing)
  • config: eslint configurations (includes eslint-config-next, eslint-config-prettier and all tsconfig.json configs used throughout the monorepo.
  • macos: A Swift Native binary for MacOS system extensions.
  • ios: A Swift Native binary (planned).
  • windows: A C# Native binary (planned).
  • android: A Kotlin Native binary (planned).

Repo structure:

Visualization of the codebase

About

Spacedrive is an open source cross-platform file explorer, powered by a virtual distributed filesystem written in Rust.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 60.0%
  • Rust 29.5%
  • CSS 3.9%
  • JavaScript 2.3%
  • Swift 2.1%
  • SCSS 1.7%
  • Other 0.5%