snapsync 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 880db39dccd4f8a40cffc7801b2c768dd899938e
-  data.tar.gz: ea3bb0a392ef829693c9e3145cd76f0a5500cea1
+  metadata.gz: 641ca51fa87cdb9f32a4395c070f8ebe2513d04e
+  data.tar.gz: 4ba5fe6fa7dedf496e4edb6e4b09345a4c52cab5
 SHA512:
-  metadata.gz: fbfe69276bc9f20dcfc6f03797a8554b85783fd67de57fe31482504d8760c30812d1390b536d0049392efc351f391fdfd0a41fa7ed861488182d84a97214e6c4
-  data.tar.gz: c4380cb4f8ebcb50e9bbbe66b520d60f227eb752cb1b9bac2010ff66d6519fb4899270618c148f740ea3acba3b5febc34a6032cad35d049291f792391170f3e0
+  metadata.gz: 863e89167e66a226dcc542bd9a4b11d962387244bd57fbc07667fb5223aa4ea0b4cbdb777672ef810d6a7b269fb291e891ffe3ea2e06bc425a901204a4351c64
+  data.tar.gz: b867d49ffb21283f8a80a05c590f7dc1f757cedd2c6a4f52a0235e0c7033ff30b00d57efaa7ac7d35aaabd79292718fc250bcc80dec27b4457b17d4827a4771a

data/Gemfile.install

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gem 'snapsync'

data/README.md

@@ -3,32 +3,73 @@
 A synchronization tool for snapper
 
 This gem implements snapper-based backup, by allowing you to synchronize a
-snapper snapshot directory to a different location. It uses btrfs send and
-receive to achieve it
+snapper snapshot directory to a different location using btrfs send and
+receive.
+
+It can be used in two modes:
+ - in manual mode, you run snapsync 
 
 ## Installation
 
-Run
+You need to make sure that you've installed Ruby's bundler. On Ubuntu, run
+    $ apt install bundler
+
+Then, the following will install snapsync in /opt/snapsync
+    
+    $ wget https://raw.githubusercontent.com/doudou/snapsync/master/install.sh
+    $ sh install.sh
 
-    $ gem install snapsync
+The script will use sudo to get root rights when required. Add /opt/snapsync/bin
+to your PATH if you want to use 'snapsync' as-is. Otherwise, you will have to
+refer to /opt/snapsync/bin/snapsync explicitely. If it seems that you are using
+systemd, the script also installs snapsync's systemd service file into the
+system, enables and starts it.
 
 ## Usage
 
-To synchronize the snapshots of the 'home' snapper configuration to an existing
-directory, run
+The most common usage of snapsync is to define a remote target (for instance, a
+USB drive) to which the snapshots should be copied. Mount the drive manually
+first and do
+
+    $ snapsync init /path/to/the/drive/snapsync
+
+This will create snapsync targets for each of the snapper configurations
+currently present on the system (i.e. if there is a 'home' and 'root'
+configurations, it will create /path/to/the/drive/snapsync/root and
+/path/to/the/drive/snapsync/auto). The 'default' synchronization policy is used
+(see below for other options).
+
+If you use systemd, the background systemd job will from now on synchronize the
+new target whenever it is present (i.e. as soon as it is plugged in). If you
+don't, or if you decided to disable the service's auto-start, run (and keep on
+running)
+
+    $ snapsync auto-sync
+
+to achieve the same result. The actions taken by the systemd-managed service can
+be followed with
+
+    $ journalctl -f -u snapsync.service
+
+## Synchronization and cleanup policies
+
+snapsync offers multiple synchronization-and-cleanup policies for targets. These
+policies determine what to copy to the target, as well as what to keep on the
+target.
 
-    $ snapsync home /media/backup
+The default policy copies everything and removes nothing. It's great at the
+beginning, but is obviously not a very good long-term strategy ;-)
 
-Snapsync uses sudo to get root access. If you wish to not run it as root, you
-will need to change the snapper permissions to give read access to all the
-snapper shapshots, e.g.
+Policies can be set at initialization time by passing additional arguments to
+'snapsync init', or later with 'snapsync policy'. Run
+'snapsync help init' and 'snapsync help policy' for more information.
 
-    $ chmod go+rx /.snapshots
-    $ chmod go+r /.snapshots/*/info.xml
+## Manual usage
 
-In addition, sudo will ask for your root password when applicable. If you wish
-to fully automate, you will need to allow snapsync to run the btrfs tool without
-password in the sudoers file.
+If you prefer using snapsync manually, or use different automation that the one
+provided by auto-sync, run 'snapsync' without arguments to get all the
+possibilities. Targets have configuration files that allow to fine-tune
+snapsync's automated behaviour to that effect.
 
 ## Development
 

data/Rakefile

@@ -1,4 +1,3 @@
-require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|

data/install.sh

@@ -0,0 +1,24 @@
+#! /bin/sh -ex
+
+target=`mktemp -d`
+cd $target
+cat > Gemfile <<GEMFILE
+source "https://rubygems.org"
+gem 'snapsync'
+GEMFILE
+
+bundler install --standalone --binstubs
+if test -d /opt/snapsync; then
+    sudo rm -rf /opt/snapsync
+    sudo cp -r . /opt/snapsync
+fi
+
+if test -d /lib/systemd/system; then
+    snapsync_gem=`bundler show snapsync`
+    cp $snapsync_gem/snapsync.service /lib/systemd/system
+    ( systemctl enable snapsync.service
+      systemctl start snapsync.service )
+fi
+
+rm -rf $target
+

data/lib/snapsync/local_sync.rb

@@ -84,7 +84,7 @@ module Snapsync
 
             if copy_snapshot(target_snapshot_dir, src, parent: parent)
                 partial_marker_path.unlink
-                IO.popen(["sudo", "btrfs", "filesystem", "sync", target_snapshot_dir.to_s, err: '/dev/null']).read
+                IO.popen(["btrfs", "filesystem", "sync", target_snapshot_dir.to_s, err: '/dev/null']).read
                 Snapsync.info "Successfully synchronized #{src.snapshot_dir}"
                 true
             end
@@ -114,9 +114,9 @@ module Snapsync
             receive_status, send_status = nil
             err_send_pipe_r, err_send_pipe_w = IO.pipe
             err_receive_pipe_r, err_receive_pipe_w = IO.pipe
-            IO.popen(['sudo', 'btrfs', 'send', *parent_opt, src.subvolume_dir.to_s, err: err_send_pipe_w]) do |send_io|
+            IO.popen(['btrfs', 'send', *parent_opt, src.subvolume_dir.to_s, err: err_send_pipe_w]) do |send_io|
                 err_send_pipe_w.close
-                IO.popen(['sudo', 'btrfs', 'receive', target_snapshot_dir.to_s, err: err_receive_pipe_w, out: '/dev/null'], 'w') do |receive_io|
+                IO.popen(['btrfs', 'receive', target_snapshot_dir.to_s, err: err_receive_pipe_w, out: '/dev/null'], 'w') do |receive_io|
                     err_receive_pipe_w.close
                     receive_io.sync = true
                     bytes_transferred = copy_stream(send_io, receive_io, estimated_size: estimated_size)
@@ -142,7 +142,7 @@ module Snapsync
 
             if success
                 Snapsync.info "Flushing data to disk"
-                IO.popen(["sudo", "btrfs", "filesystem", "sync", target_snapshot_dir.to_s, err: '/dev/null']).read
+                IO.popen(["btrfs", "filesystem", "sync", target_snapshot_dir.to_s, err: '/dev/null']).read
                 duration = Time.now - start
                 rate = bytes_transferred / duration
                 Snapsync.info "Transferred #{human_readable_size(bytes_transferred)} in #{human_readable_time(duration)} (#{human_readable_size(rate)}/s)"
@@ -155,7 +155,7 @@ module Snapsync
                 Snapsync.warn "Failed to synchronize #{src.snapshot_dir}, deleting target directory"
                 subvolume_dir = target_snapshot_dir + "snapshot"
                 if subvolume_dir.directory?
-                    IO.popen(["sudo", "btrfs", "subvolume", "delete", subvolume_dir.to_s, err: '/dev/null']).read
+                    IO.popen(["btrfs", "subvolume", "delete", subvolume_dir.to_s, err: '/dev/null']).read
                 end
                 target_snapshot_dir.rmtree
             end

data/lib/snapsync/sync_all.rb

@@ -51,13 +51,13 @@ module Snapsync
                     LocalSync.new(config, target).sync
                     if should_autoclean_target?(target)
                         if target.cleanup
-                            Snapsync.info "running cleanup"
+                            Snapsync.info "running cleanup for #{config.name}"
                             target.cleanup.cleanup(target)
                         else
-                            Snapsync.info "#{target.sync_policy.class.name} policy set, no cleanup to do"
+                            Snapsync.info "#{target.sync_policy.class.name} policy set, no cleanup to do for #{config.name}"
                         end
                     else
-                        Snapsync.info "autoclean not set"
+                        Snapsync.info "autoclean not set on #{config.name}"
                     end
                 end
             end

data/lib/snapsync/version.rb

@@ -1,3 +1,3 @@
 module Snapsync
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/snapsync.service

@@ -0,0 +1,10 @@
+[Unit]
+Description=service that synchronizes snapper snapshots to other media
+Wants=udisks2.service
+
+[Service]
+Type=simple
+ExecStart=/opt/snapsync/bin/snapsync auto-sync
+
+[Install]
+WantedBy=default.target

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snapsync
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sylvain Joyeux
@@ -14,148 +14,148 @@ dependencies:
   name: logging
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: ruby-dbus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.11.0
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.11.0
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0.11'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.19.0
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.19.0
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.19.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.0'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '5.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.0'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '5.7'
 - !ruby/object:Gem::Dependency
   name: flexmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.3.3
 description: 
@@ -166,13 +166,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - Gemfile
+- Gemfile.install
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/snapsync
+- install.sh
 - lib/snapsync.rb
 - lib/snapsync/auto_sync.rb
 - lib/snapsync/cleanup.rb
@@ -190,6 +192,7 @@ files:
 - lib/snapsync/timeline_sync_policy.rb
 - lib/snapsync/version.rb
 - snapsync.gemspec
+- snapsync.service
 homepage: https://github.com/doudou/snapsync
 licenses:
 - MIT
@@ -200,17 +203,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: tool to automate backing up snapper snapshots to other medias