Git borg linker utility

The full documentation of this work is lecensed under a Creative Commons Attribution 4.0 International License (CC BY 4.0) licence.

The source code of gblk is licensed under a AGPL3 Licence

Description

The git borg linker utility (abreviated as gblk) is a tool that aims to ease the usage of borgbackup in a project using git as a version control system.

It helps you to track the changes in your results folder every time you commit a change in your code. For versionning your results gblk uses borgbackup a tool to create backups and using a data deduplication technique.

Prerequisites

To install gblk, git and borgbackup must be installed on your system.

To install borg, you can go to borg's installation page.

As gblk is written in rust, you need to install it with:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

You can optionally install delta. Delta aims to show differences between two files and can be used with git. It can be customized by editing the ~/.gitconfig file. This tool is needed if you use the --diff option of the gblk mount command.

You can optionally install ImageMagick. ImageMagick aims to perform various operation on images. This tool is needed if you plan to create diff of image with gblk with the --diff option of the gblk mount command.

If you want to share your borg folder whith gblk clone, push and pull, rsync must be installed on your computer and on remote machines where you want to store/share you results. ssh program must be installed to send the archived results to remote servers.

Below some commands you can use to install gblk dependencies on ubuntu:

# Install git
sudo apt install git
# Install borg
sudo apt install borgbackup
# install rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# Install delta (Ubuntu)
wget https://github.com/dandavison/delta/releases/download/0.15.1/git-delta_0.15.1_amd64.deb && \
 dpkg -i git-delta_0.15.1_amd64.deb
# Install Imagemagick
sudo apt install imagemagick
# Install Rsync (if not already installed)
sudo apt install rsync
# install gblk
cargo install --git https://gitbio.ens-lyon.fr/LBMC/hub/git_borg_linker
# Update your bashrc
echo "export PATH=$PATH:/home/nicolas/.cargo/bin" > ~/.bashrc
source ~/.bashrc

Installation

To install gblk run the following command:

cargo install --git https://gitbio.ens-lyon.fr/LBMC/hub/git_borg_linker

Usage

You can check the gblk's documentation here.