Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sahib/brig
File synchronization on top of ipfs with git like interface & web based UI
https://github.com/sahib/brig
Last synced: 29 days ago
JSON representation
File synchronization on top of ipfs with git like interface & web based UI
- Host: GitHub
- URL: https://github.com/sahib/brig
- Owner: sahib
- License: agpl-3.0
- Created: 2016-01-16T15:18:04.000Z (almost 9 years ago)
- Default Branch: develop
- Last Pushed: 2024-02-13T20:46:10.000Z (9 months ago)
- Last Synced: 2024-09-30T20:33:12.453Z (about 1 month ago)
- Language: Go
- Homepage: https://brig.readthedocs.io
- Size: 133 MB
- Stars: 567
- Watchers: 28
- Forks: 33
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing.rst
- License: LICENSE
- Roadmap: docs/roadmap.rst
Awesome Lists containing this project
- awesome-ipfs - brig - File synchronization with git like interface and FUSE filesystem. (Apps)
- awesome-starred - sahib/brig - File synchronization on top of ipfs with git like interface & web based UI (others)
README
# `brig`: Ship your data around the world
[](https://goreportcard.com/report/github.com/sahib/brig)
[](https://godoc.org/github.com/sahib/brig)
[](https://travis-ci.org/sahib/brig)
[](http://brig.readthedocs.io/en/latest)
[](https://www.gnu.org/licenses/agpl-3.0)
[](https://bestpractices.coreinfrastructure.org/en/projects/1558)
## Table of Contents
- [`brig`: Ship your data around the world](#brig-ship-your-data-around-the-world)
- [Table of Contents](#table-of-contents)
- [About](#about)
- [Installation](#installation)
- [Getting started](#getting-started)
- [Status](#status)
- [Documentation](#documentation)
- [Donations](#donations)
- [Focus](#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](http://brig.readthedocs.io/en/latest/index.html) for more details.
## Installation
You can download the latest script with the following oneliner:
```bash
# 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](https://github.com/sahib/brig/releases).
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:
```bash
$ 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](https://brig.readthedocs.io/en/latest/installation.html) for more details.
## Getting started
[](https://asciinema.org/a/163713)
...If you want to know, what to do after you can read the
[Quickstart](http://brig.readthedocs.io/en/latest/quickstart.html).
There is also a ``#brig`` room on ``matrix.org`` you can join with any [Matrix](https://matrix.org) client.
Click [this link](https://riot.im/app/#/room/#brig:matrix.org) to join the room directly via [Riot.im](https://about.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](https://github.com/disorganizer/brig-thesis) 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](http://brig.readthedocs.io/en/latest/index.html).
## Donations
If you're interested in the development and would think about supporting me
financially, then please [contact me!](mailto:[email protected]) If you'd like to
give me a small & steady donation, you can always use *Liberapay*:
*Thank you!*