X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=bup.git;a=blobdiff_plain;f=README.md;h=c580ecea5fd165f37a187a748e613ec83fca6956;hp=01c2e5dec649326161d579f95eb29eee8e0fa387;hb=ea0cb087050dc86bae886c0b2605b83aa819b7d3;hpb=7e0fcaa5b28eb1aa022a59e5056679e7854070b9
diff --git a/README.md b/README.md
index 01c2e5d..c580ece 100644
--- a/README.md
+++ b/README.md
@@ -67,32 +67,65 @@ bup has a few advantages over other backup software:
Reasons you might want to avoid bup
-----------------------------------
- - This is a very early version. Therefore it will most probably not work
- for you, but we don't know why. It is also missing some
- probably-critical features.
+ - It's not remotely as well tested as something like tar, so it's
+ more likely to eat your data. It's also missing some
+ probably-critical features, though fewer than it used to be.
- - It requires python >= 2.5, a C compiler, and an installed git
- version >= 1.5.3.1. It also requires par2 if you want fsck to be
+ - It requires python >= 2.6, a C compiler, and an installed git
+ version >= 1.5.6. It also requires par2 if you want fsck to be
able to generate the information needed to recover from some types
of corruption.
- - It currently only works on Linux, MacOS X >= 10.4,
- NetBSD, Solaris, or Windows (with Cygwin). Patches to support
- other platforms are welcome.
+ - It currently only works on Linux, FreeBSD, NetBSD, OS X >= 10.4,
+ Solaris, or Windows (with Cygwin, and maybe with WSL). Patches to
+ support other platforms are welcome.
- Any items in "Things that are stupid" below.
-
+
+Notable changes introduced by a release
+=======================================
+
+ - Changes in 0.30 as compared to 0.29.3
+ - Changes in 0.29.3 as compared to 0.29.2
+ - Changes in 0.29.2 as compared to 0.29.1
+ - Changes in 0.29.1 as compared to 0.29
+ - Changes in 0.29 as compared to 0.28.1
+ - Changes in 0.28.1 as compared to 0.28
+ - Changes in 0.28 as compared to 0.27.1
+ - Changes in 0.27.1 as compared to 0.27
+
+
+Test status
+===========
+
+| branch | Debian | FreeBSD | macOS |
+|--------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
+| master | [](https://cirrus-ci.com/github/bup/bup) | [](https://cirrus-ci.com/github/bup/bup) | [](https://cirrus-ci.com/github/bup/bup) |
+| 0.29.x | [](https://cirrus-ci.com/github/bup/bup) | [](https://cirrus-ci.com/github/bup/bup) | [](https://cirrus-ci.com/github/bup/bup) |
+
Getting started
===============
-
From source
-----------
- Check out the bup source code using git:
-
- git clone git://github.com/bup/bup
+
+ ```sh
+ git clone https://github.com/bup/bup
+ ```
+
+ - This will leave you on the master branch, which is perfect if you
+ would like to help with development, but if you'd just like to use
+ bup, please check out the latest stable release like this:
+
+ ```sh
+ git checkout 0.29.1
+ ```
+
+ You can see the latest stable release here:
+ https://github.com/bup/bup/releases.
- Install the required python libraries (including the development
libraries).
@@ -100,24 +133,30 @@ From source
On very recent Debian/Ubuntu versions, this may be sufficient (run
as root):
- apt-get build-dep bup
+ ```sh
+ apt-get build-dep bup
+ ```
- Otherwise try this (substitute python2.5-dev or python2.6-dev if
- you have an older system):
+ Otherwise try this (substitute python2.6-dev if you have an older
+ system):
- apt-get install python2.7-dev python-fuse
- apt-get install python-pyxattr python-pylibacl
- apt-get install linux-libc-dev
- apt-get install acl attr
- apt-get install python-tornado # optional
+ ```sh
+ apt-get install python2.7-dev python-fuse
+ apt-get install python-pyxattr python-pylibacl
+ apt-get install linux-libc-dev
+ apt-get install acl attr
+ apt-get install python-tornado # optional
+ ```
On CentOS (for CentOS 6, at least), this should be sufficient (run
as root):
- yum groupinstall "Development Tools"
- yum install python python-devel
- yum install fuse-python pyxattr pylibacl
- yum install perl-Time-HiRes
+ ```sh
+ yum groupinstall "Development Tools"
+ yum install python python-devel
+ yum install fuse-python pyxattr pylibacl
+ yum install perl-Time-HiRes
+ ```
In addition to the default CentOS repositories, you may need to add
RPMForge (for fuse-python) and EPEL (for pyxattr and pylibacl).
@@ -127,15 +166,27 @@ From source
If you would like to use the optional bup web server on systems
without a tornado package, you may want to try this:
- pip install tornado
+ ```sh
+ pip install tornado
+ ```
- Build the python module and symlinks:
- make
+ ```sh
+ make
+ ```
- Run the tests:
-
- make test
+
+ ```sh
+ make long-check
+ ```
+
+ or if you're in a bit more of a hurry:
+
+ ```sh
+ make check
+ ```
The tests should pass. If they don't pass for you, stop here and
send an email to bup-list@googlegroups.com. Though if there are
@@ -143,16 +194,20 @@ From source
may fail. Running something like this before "make test" should
sidestep the problem:
- cd "$(/bin/pwd)"
+ ```sh
+ cd "$(pwd -P)"
+ ```
- You can install bup via "make install", and override the default
destination with DESTDIR and PREFIX.
Files are normally installed to "$DESTDIR/$PREFIX" where DESTDIR is
- empty by default, and PREFIX is set to /usr. So if you wanted to
+ empty by default, and PREFIX is set to /usr/local. So if you wanted to
install bup to /opt/bup, you might do something like this:
- make install DESTDIR=/opt/bup PREFIX=''
+ ```sh
+ make install DESTDIR=/opt/bup PREFIX=''
+ ```
- The Python executable that bup will use is chosen by ./configure,
which will search for a reasonable version unless PYTHON is set in
@@ -175,6 +230,8 @@ Binary packages of bup are known to be built for the following OSes:
http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/sysutils/bup/
- Arch Linux:
https://www.archlinux.org/packages/?sort=&q=bup
+ - Fedora:
+ https://apps.fedoraproject.org/packages/bup
Using bup
@@ -182,108 +239,167 @@ Using bup
- Get help for any bup command:
- bup help
- bup help init
- bup help index
- bup help save
- bup help restore
- ...
+ ```sh
+ bup help
+ bup help init
+ bup help index
+ bup help save
+ bup help restore
+ ...
+ ```
- - Initialize the default BUP_DIR (~/.bup):
+ - Initialize the default BUP_DIR (~/.bup -- you can choose another by
+ either specifying `bup -d DIR ...` or setting the `BUP_DIR`
+ environment variable for a command):
- bup init
+ ```sh
+ bup init
+ ```
- Make a local backup (-v or -vv will increase the verbosity):
- bup index /etc
- bup save -n local-etc /etc
+ ```sh
+ bup index /etc
+ bup save -n local-etc /etc
+ ```
- Restore a local backup to ./dest:
- bup restore -C ./dest local-etc/latest/etc
- ls -l dest/etc
+ ```sh
+ bup restore -C ./dest local-etc/latest/etc
+ ls -l dest/etc
+ ```
- Look at how much disk space your backup took:
- du -s ~/.bup
+ ```sh
+ du -s ~/.bup
+ ```
- Make another backup (which should be mostly identical to the last one;
notice that you don't have to *specify* that this backup is incremental,
it just saves space automatically):
- bup index /etc
- bup save -n local-etc /etc
+ ```sh
+ bup index /etc
+ bup save -n local-etc /etc
+ ```
- Look how little extra space your second backup used (on top of the first):
- du -s ~/.bup
+ ```sh
+ du -s ~/.bup
+ ```
- Get a list of your previous backups:
- bup ls local-etc
+ ```sh
+ bup ls local-etc
+ ```
- Restore your first backup again:
- bup restore -C ./dest-2 local-etc/2013-11-23-11195/etc
+ ```sh
+ bup restore -C ./dest-2 local-etc/2013-11-23-11195/etc
+ ```
- Make a backup to a remote server which must already have the 'bup' command
somewhere in its PATH (see /etc/profile, etc/environment, ~/.profile, or
~/.bashrc), and be accessible via ssh.
Make sure to replace SERVERNAME with the actual hostname of your server:
- bup init -r SERVERNAME:path/to/remote-bup-dir
- bup index /etc
- bup save -r SERVERNAME:path/to/remote-bup-dir -n local-etc /etc
+ ```sh
+ bup init -r SERVERNAME:path/to/remote-bup-dir
+ bup index /etc
+ bup save -r SERVERNAME:path/to/remote-bup-dir -n local-etc /etc
+ ```
+
+ - Make a remote backup to ~/.bup on SERVER:
- - Restore a backup from a remote server. (FAIL: unfortunately,
- unlike "bup join", "bup restore" does not yet support remote
- restores. See both "bup join" and "Things that are stupid" below.)
+ ```sh
+ bup index /etc
+ bup save -r SERVER: -n local-etc /etc
+ ```
+
+ - See what saves are available in ~/.bup on SERVER:
+
+ ```sh
+ bup ls -r SERVER:
+ ```
+
+ - Restore the remote backup to ./dest:
+
+ ```sh
+ bup restore -r SERVER: -C ./dest local-etc/latest/etc
+ ls -l dest/etc
+ ```
- Defend your backups from death rays (OK fine, more likely from the
occasional bad disk block). This writes parity information
(currently via par2) for all of the existing data so that bup may
be able to recover from some amount of repository corruption:
- bup fsck -g
+ ```sh
+ bup fsck -g
+ ```
- Use split/join instead of index/save/restore. Try making a local
backup using tar:
-
- tar -cvf - /etc | bup split -n local-etc -vv
+
+ ```sh
+ tar -cvf - /etc | bup split -n local-etc -vv
+ ```
- Try restoring the tarball:
-
- bup join local-etc | tar -tf -
+
+ ```sh
+ bup join local-etc | tar -tf -
+ ```
- Look at how much disk space your backup took:
-
- du -s ~/.bup
+
+ ```sh
+ du -s ~/.bup
+ ```
- Make another tar backup:
-
- tar -cvf - /etc | bup split -n local-etc -vv
+
+ ```sh
+ tar -cvf - /etc | bup split -n local-etc -vv
+ ```
- Look at how little extra space your second backup used on top of
the first:
-
- du -s ~/.bup
+
+ ```sh
+ du -s ~/.bup
+ ```
- Restore the first tar backup again (the ~1 is git notation for "one
older than the most recent"):
-
- bup join local-etc~1 | tar -tf -
+
+ ```sh
+ bup join local-etc~1 | tar -tf -
+ ```
- Get a list of your previous split-based backups:
-
- GIT_DIR=~/.bup git log local-etc
+
+ ```sh
+ GIT_DIR=~/.bup git log local-etc
+ ```
- - Make a backup on a remote server:
-
- tar -cvf - /etc | bup split -r SERVERNAME: -n local-etc -vv
-
- - Try restoring the remote backup tarball:
+ - Save a tar archive to a remote server (without tar -z to facilitate
+ deduplication):
+
+ ```sh
+ tar -cvf - /etc | bup split -r SERVERNAME: -n local-etc -vv
+ ```
- bup join -r SERVERNAME: local-etc | tar -tf -
+ - Restore the archive:
+
+ ```sh
+ bup join -r SERVERNAME: local-etc | tar -tf -
+ ```
That's all there is to it!
@@ -326,7 +442,7 @@ Notes on NetBSD/pkgsrc
traversal code ("fts") in NetBSD's libc will interpret this as a
cycle and error out, so "ls -R" and "find" will not work.
- - There is no support for ACLs. If/when some entrprising person
+ - There is no support for ACLs. If/when some enterprising person
fixes this, adjust t/compare-trees.
@@ -419,16 +535,6 @@ Things that are stupid for now but which we'll fix later
Help with any of these problems, or others, is very welcome. Join the
mailing list (see below) if you'd like to help.
- - 'bup restore' can't pull directly from a remote server.
-
- So in one sense "save -r" is a dead-end right now. Obviously you
- can use "ssh SERVER bup restore -C ./dest..." to create a tree you
- can transfer elsewhere via rsync/tar/whatever, but that's *lame*.
-
- Until we fix it, you may be able to mount the remote BUP_DIR via
- sshfs and then restore "normally", though that hasn't been
- officially tested.
-
- 'bup save' and 'bup restore' have immature metadata support.
On the plus side, they actually do have support now, but it's new,
@@ -474,22 +580,20 @@ mailing list (see below) if you'd like to help.
give the continuous-backup process a really low CPU and I/O priority so
you wouldn't even know it was running.
- - bup currently has no way to prune *old* backups.
-
- Because of the way the packfile system works, backups become "entangled"
- in weird ways and it's not actually possible to delete one pack
- (corresponding approximately to one backup) without risking screwing up
- other backups.
-
- git itself has lots of ways of optimizing this sort of thing, but its
- methods aren't really applicable here; bup packfiles are just too huge.
- We'll have to do it in a totally different way. There are lots of
- options. For now: make sure you've got lots of disk space :)
+ - bup only has experimental support for pruning old backups.
+
+ While you should now be able to drop old saves and branches with
+ `bup rm`, and reclaim the space occupied by data that's no longer
+ needed by other backups with `bup gc`, these commands are
+ experimental, and should be handled with great care. See the
+ man pages for more information.
- Until we fix this, one possible workaround is to just start a new
- BUP_DIR occasionally, i.e. bup-2013-10, bup-2013-11...
+ Unless you want to help test the new commands, one possible
+ workaround is to just start a new BUP_DIR occasionally,
+ i.e. bup-2013, bup-2014...
- - bup has never been tested on anything but Linux, MacOS, and Windows+Cygwin.
+ - bup has never been tested on anything but Linux, FreeBSD, NetBSD,
+ OS X, and Windows+Cygwin.
There's nothing that makes it *inherently* non-portable, though, so
that's mostly a matter of someone putting in some effort. (For a
@@ -498,7 +602,7 @@ mailing list (see below) if you'd like to help.
- bup needs better documentation.
- According to a recent article about bup in Linux Weekly News
+ According to an article about bup in Linux Weekly News
(https://lwn.net/Articles/380983/), "it's a bit short on examples and
a user guide would be nice." Documentation is the sort of thing that
will never be great unless someone from outside contributes it (since
@@ -512,10 +616,9 @@ mailing list (see below) if you'd like to help.
- bup has no GUI.
- Actually, that's not stupid, but you might consider it a limitation.
- There are a bunch of Linux GUI backup programs; someday I expect someone
- will adapt one of them to use bup.
-
+ Actually, that's not stupid, but you might consider it a
+ limitation. See the ["Related Projects"](https://bup.github.io/)
+ list for some possible options.
More Documentation
==================