Skip to content

Latest commit

 

History

History
executable file
·
102 lines (75 loc) · 2.83 KB

README.md

File metadata and controls

executable file
·
102 lines (75 loc) · 2.83 KB

QuixByte

QuixByte

-- About

QuixByte is an opensource file service, which allows
users to quickly synchronize and backup their files
across multiple devices.


-- Joining the Project

We are happy to accept contributions. If you are looking
to join this project as a maintainer make sure to contribute
something meaningful once or twice and then get in touch.
(lucasbirkert@gmail.com)

Table of Contents

  1. Goals
  2. Platform Support
  3. Extension Support
  4. Quickstart
  5. Terminology

Goals

  • Fast, resilient sync
  • Memory safety, no crashes
  • Low resource usage
  • Support of many different storage services (current state)
  • Extensibility, allow external processes to act as QBIs
  • Wide platform support (current state)
  • Entirely opensource

Platform Support

platform arch support planned
Linux x86_64 full, tested yes
Linux any untested, should work yes
Windows any currently no support yes
Mac-OS any untested, should work yes
Android arm64-v8 partial, no UDS impl yet yes
Android armeabi-v7 partial, no UDS impl yet yes
Android x86_64 partial, no UDS impl yet yes
iOS any unknown yes

Extension Support

service description support planned
qb-ext-local sync to local folder yes yes
qb-ext-tcp sync via tcp (and TLS) yes yes
qb-ext-rtc sync via WebRTC unimplemented yes
qb-ext-gdrive sync to Google Drive unimplemented yes
qb-ext-dropbox sync to Dropbox unimplemented yes

Quickstart

  1. Install the latest version of rust: https://rustup.rs/
  2. Clone the repository:
$ git clone --depth 1 https://github.com/qb-rs/qb
$ cd qb
  1. Start the daemon process:
$ cargo run --bin qb-daemon
  1. Start the GUI Application:
$ cargo run --bin qb-app

Terminology

interface

A QBI (quixbyte interface) is a piece of software which helps the master to communicate with some storage service.

master

The master controls which QBIs to attach to and handles the communication between the different interfaces.

storage service

A storage service is an entity that we can communicate with to store and read files.


Project licensed under GPLv3

© 2024 The QuixByte Project Authors - All Rights Reserved