Applied patch from tuttle@somsants.net.

[butterbackup.git] / README.md

diff --git a/README.md b/README.md
index 1eeab6d6a079ca1b1606999e9e039a69a8c1e2ee..4014f96121af437540c983ab58d85591e2bc9cd0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,11 +4,27 @@ butterbackup
 Butterbackup is a backup system which stores snapshots in btrfs on a central server. A web gui allows for simple restore of files. 
 
 For now it is rather crude. To get started backing up some manual work is needed.
-    Create /etc/Butterbackup
-    # echo "--exclude /tmp --exclude /proc --exclude /sys --exclude /dev" > /etc/butterbackup/machine1.example.com
-    # cp /etc/butterbackup/machine1.example.com /etc/butterbackup/machine2.example.com
-    # ssh-copy-id root@machine1.example.com
-    # ssh-copy-id root@machine1.example.com
-    # mkdir /mnt/data2
-    # mkfs.btrfs /dev/sdb1
-    # mount /dev/sdb1 /mnt/data2  #hardcoded for now
\ No newline at end of file
+<pre lang="bash"><code>
+Create /etc/butterbackup
+# cat > /etc/butterbackup/default.cfg
+[DEFAULT]
+exclude = /proc/, /sys, /tmp, /dev, /run
+store_dir = /mnt/data
+keep=10
+(ctrl-d to exit)
+# touch /etc/butterbackup/machine1.example.com
+# touch /etc/butterbackup/machine2.example.com
+# ssh-copy-id root@machine1.example.com
+# ssh-copy-id root@machine2.example.com
+# mkdir /mnt/data
+# mkfs.btrfs /dev/sdb1
+# mount /dev/sdb1 /mnt/data
+</code></pre>
+
+To override the default setting for a specific host do:
+<pre lang="bash"><code>
+cat > /etc/butterbackup/machine1.example.com
+[host]
+exclude = /proc/, /sys, /tmp, /dev, /run, /home/mikael/.gvfs, /.snapshots
+keep=20
+</code></pre>