spacedrive/README.md

97 lines
6.4 KiB
Markdown
Raw Normal View History

2021-12-29 07:26:48 +00:00
<p align="center">
2021-12-29 07:35:45 +00:00
<a href="#">
2022-03-07 10:04:06 +00:00
<img src="./apps/desktop/src/assets/images/spacedrive_screenshot_2.png" alt="Logo">
2021-12-29 07:35:45 +00:00
</a>
2022-03-07 10:06:17 +00:00
<div style="text-align: center">
2022-03-07 10:09:55 +00:00
<img width=100 src="./apps/desktop/src/assets/images/spacedrive_logo.png" alt="Logo">
2022-03-07 10:06:17 +00:00
</div>
<h2 align="center">Spacedrive</h2>
2021-12-29 07:26:48 +00:00
<p align="center">
2021-12-30 13:35:25 +00:00
Your personal virtual cloud.
2021-12-29 07:26:48 +00:00
<br />
<a href="https://spacedrive.co"><strong>Learn more »</strong></a>
<br />
<br />
2021-12-29 11:25:13 +00:00
<b>Download for </b>
<a href="">MacOS</a>
2021-12-29 07:26:48 +00:00
·
2021-12-29 11:25:13 +00:00
<a href="">Windows</a>
2021-12-29 07:26:48 +00:00
·
2021-12-29 11:25:13 +00:00
<a href="">Linux</a>
·
2021-12-29 16:33:42 +00:00
iOS
2021-12-29 11:25:13 +00:00
·
2021-12-29 16:33:42 +00:00
watchOS
2021-12-29 11:25:13 +00:00
·
2021-12-29 16:33:42 +00:00
Android
2021-12-29 11:25:13 +00:00
2021-12-29 07:26:48 +00:00
</p>
</p>
2021-12-24 09:13:21 +00:00
2021-12-29 05:44:39 +00:00
Spacedrive is an open source virtual filesystem, a personal cloud powered by your everyday devices. Feature-rich benefits of the cloud, only its owned and hosted by you with security, privacy and ownership as a foundation. Spacedrive makes it possible to create a limitless directory of your digital life that will stand the test of time.
2021-12-29 05:44:39 +00:00
2021-12-31 13:51:47 +00:00
For each client you install, you'll have another node in your personal network. They all share a single encrypted database and work as a team to perform tasks. Prioritizing peer-to-peer LAN connections but always using end-to-end encryption to synchronize in realtime.
As for UI, it has everything you'd expect from a file explorer and more; a native photo viewer, video and audio player. But also *specific* support for VODs, git repositories, social media backups, NFTs, screenshots, webpage snapshots, links, notes and more. Community extensions can add support for different filetypes and tailored file viewers.
2021-12-29 05:44:39 +00:00
## Features
2021-12-29 06:45:15 +00:00
- **File indexing** - Scan your devices, drives, removable storage and cloud accounts to build a virtual "yellow pages" directory of all your data.
2021-12-29 08:50:33 +00:00
- **Realtime synchronization** - Sync database in realtime between devices, prioritizing peer-to-peer LAN connections (WiFi sync).
2021-12-29 07:26:48 +00:00
- **Photos** - Photo and video albums similar to Apple/Google photos.
2021-12-30 09:55:37 +00:00
- **Preview generation** - Auto generate lower resolution stand-ins for image and video,
2021-12-29 14:43:56 +00:00
- **Search** - Search deep into your filesystem, including offline devices, with a custom keybind.
2021-12-29 06:59:45 +00:00
- **Cloud integration** - Apple Photos, Google Drive, Dropbox, OneDrive & Mega + easy API for the community to add more.
2021-12-29 07:02:32 +00:00
- **Smart tags** - Define routines on custom tags to automate workflows, easily tag files individually, in bulk and automatically via rules.
- **Spaces** - A collection of files organized visually and shareable as public web pages with a Spacedrive account.
2021-12-29 14:43:56 +00:00
- **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.
2021-12-29 08:50:33 +00:00
- **Statistics** - Statistics such as total capacity, index size, preview media size, free space etc.
2021-12-29 06:59:45 +00:00
- **Timeline** - View a linear timeline of content, travel to any time and see media represented visually, including overlapping content.
- **Extensions** - Build tools on top of Spacedrive, extend functionality and integrate third party services. Extension directory on [spacedrive.co/extensions](#).
2021-12-29 06:41:24 +00:00
- **Manage redundancy** - Ensure a specific amount of copies exist for your important data, discover at-risk files and monitor device/drive health.
- **Media encoder** - Encode video and audio into various formats, use Tags to automate.
2021-12-29 07:33:53 +00:00
- **Workers** - Utilize the compute power of your devices in unison to encode and perform tasks at insane speeds.
2021-12-29 14:49:25 +00:00
- **Jobs** - Each task a client performs, a body of work we refer to as a "job", is logged and reversible.
- **Self host** - Spacedrive can be deployed as a service, behaving as just another device powering your personal cloud.
- **Spacedrive Cloud** - We'll host an always-on cloud device for you, with pay-as-you-go plans for storage.
2021-12-29 05:44:39 +00:00
## Motivation
Independent creatives are the new normal, our data is steadily accumulating in the terabytes but the infrastructure hasnt caught up. Cloud services like Google Photos and iCloud have great features, beautiful UI—but youre locked in with a very limited capacity. Many people have multiple cloud accounts, drives that arent backed up and collecting dust, data at risk of loss. I don't want to be tied to any one cloud provider; a photo album shouldnt exist only in only my iCloud account, it should be universal and permanent. I believe open source technology is the solution to this, with incredibly an versatile and secure architecture we can create a uniform experience to provide control over vast amounts of data in many environments.
2021-12-29 05:44:39 +00:00
2021-12-29 07:15:21 +00:00
<!-- With a cultural boom of independent creatives there is a lack of tools to support the ever increasing amount of data accumulated. Cloud services have great features, but require your content to be *in* the cloud to benefit from them. For most creators a 50GB OBS recording is just not convenient to upload.
I believe, in the advent of web3, we need to control and own our own data portfolios, not cloud companies. One uniform way to track, organize, back-up, share, encrypt and view an unlimited amount of data, not locking into a single provider and living within their limits. -->
2021-12-29 05:44:39 +00:00
## Architecture
Spacedrive's core (`sdcorelib`) is written in pure Rust, using the Tauri framework to embed a React app in a native browser window for UI. The mobile app is React Native, with `sdcorelib` embedded as a native binary.
2021-12-24 09:13:21 +00:00
2021-12-25 00:50:42 +00:00
## Apps
- `desktop`: a [Tauri](https://nextjs.org) app
- `mobile`: a [React Native](https://nextjs.org) app
2021-12-24 09:13:21 +00:00
- `web`: another [Next.js](https://nextjs.org) app
2021-12-25 00:50:42 +00:00
- `docs`: a [Next.js](https://nextjs.org) app
## Packages
2021-12-29 05:44:39 +00:00
All TypeScript packages are compiled automatically using Turborepo.
2021-12-25 00:50:42 +00:00
- `core`: the [Rust]() core logic library, referred to internally as `sdcorelib`
- `state`: the [TypeScript]() core logic library
- `ui`: a [React Native]() / [RNW]() component library
- `config`: `eslint` configurations (includes `eslint-config-next`, `eslint-config-prettier` and all `tsconfig.json` configs used throughout the monorepo
2021-12-29 05:44:39 +00:00
- `native-macos`: a [Swift]() native binary
- `native-ios`: a [Swift]() native binary
- `native-windows`: a [C#]() native binary
- `native-android`: a [Kotlin]() native binary
## Developer Info
- Rust version: **1.58.1**
- Node version: **17**
Install instructions:
- `$ git clone https://github.com/jamiepine/spacedrive`
- `$ cd spacedrive`
- `$ yarn`
- `$ yarn desktop dev`