dedup

deduplicating backup program
git clone git://git.2f30.org/dedup.git
Log | Files | Refs | README | LICENSE

README (1519B)


      1 What is it?
      2 ===========
      3 
      4 dedup is a deduplicating backup program.
      5 
      6 Getting started
      7 ===============
      8 
      9 To use dedup you have to first initialize a repository:
     10 
     11     dup-init repo
     12 
     13 dup-init(1) will create a storage file and an archive directory inside
     14 the repository.  The storage file contains all the unique blocks of
     15 the repository.  The archive directory contains all snapshots.
     16 
     17 dedup only handles a single file at a time, so using tar is advised.
     18 To deduplicate a directory tree invoke dup-pack(1) as follows:
     19 
     20     tar -cf - ~/dir | dup-pack -r repo foo
     21 
     22 This will create a new snapshot called foo under repo/archive/.
     23 
     24 To extract the snapshot:
     25 
     26     dup-unpack -r repo foo | tar -xf -
     27 
     28 Encrypting a dedup repository
     29 =============================
     30 
     31 First a secret key has to be generated using dup-keygen(1).  This is a
     32 256-bit symmetric key.
     33 
     34     dup-keygen keyfile
     35 
     36 Initialize the repo and select XChaCha20-Poly1305 as the encryption
     37 algorithm:
     38 
     39     dup-init -k keyfile -E XChaCha20-Poly1305 repo
     40 
     41 To create a snapshot named foo:
     42 
     43     tar -cf - ~/dir | dup-pack -k keyfile -r repo foo
     44 
     45 To extract the snapshot:
     46 
     47     dup-unpack -k keyfile -r repo foo | tar -xf -
     48 
     49 All tools require the -k option when operating on an encrypted dedup
     50 repository.
     51 
     52 Portability
     53 ===========
     54 
     55 dedup works on Linux, *BSD, macOS and possibly other UNIX-like systems.
     56 
     57 Dependencies
     58 ============
     59 
     60   - snappy
     61   - liblz4
     62   - libsodium
     63 
     64 Contact
     65 =======
     66 
     67 You can reach us through irc.2f30.org/6697 at #2f30 or
     68 irc.freenode.net/6697 at #bitreich-en.