brig: Ship your data around the world

Table of Contents

• brig: Ship your data around the world
  • Table of Contents
  • About
  • Installation
  • Getting started
  • Status
  • Documentation
  • Donations
  • Focus

About

brig is a distributed & secure file synchronization tool with version control. It is based on IPFS, written in Go and will feel familiar to git users.

Key feature highlights:

• Encryption of data in rest and transport + compression on the fly.
• Simplified git version control.
• Sync algorithm that can handle moved files and empty directories and files.
• Your data does not need to be stored on the device you are currently using.
• FUSE filesystem that feels like a normal (sync) folder.
• No central server at all. Still, central architectures can be build with brig.
• Simple user identification and discovery with users that look like email addresses.

Also take a look at the documentation for more details.

Installation

You can download the latest script with the following oneliner:

# Before you execute this, ask yourself if you trust me.
$ bash <(curl -s https://raw.githubusercontent.com/sahib/brig/master/scripts/install.sh)

Alternatively, you can simply grab the latest binary from the release tab.

Development versions can be installed easily by compiling yourself. If you have a recent version of go (>= 1.10) installed, it should be as easy as this:

$ go get -d -v -u github.com/sahib/brig  # Download the sources.
$ cd $GOPATH/src/github.com/sahib/brig   # Go to the source directory.
$ git checkout develop                   # Checkout the develop branch.
$ go run mage.go                         # Build the software.
$ $GOPATH/bin/brig help                  # Run the binary.

Please refer to the install docs for more details.

Getting started

...If you want to know, what to do after you can read the Quickstart.

There is also a #brig room on matrix.org you can join with any Matrix client. Click this link to join the room directly via Riot.im.

Status

This software is in a beta phase currently. All mentioned features should work. Things might still change rapidly and there will be no guarantees given before version 1.0.0. Do not use brig yet as only storage for your production data. There are still bugs, but it should be safe enough to toy around with it quite a bit.

This project has started end of 2015 and has seen many conceptual changes in the meantime. It started out as research project. After writing my master theses on it, it was put down for a few months until I picked at up again and currently am trying to push it to usable software.

If you want to open a bug report, just type brig bug to get a readily filled template for you.

Documentation

All documentation can be found on ReadTheDocs.org.

Donations

If you're interested in the development and would think about supporting me financially, then please contact me! If you'd like to give me a small & steady donation, you can always use Liberapay:

Thank you!