Oldtime, a highly customizable and configurable backup & restore system

Homepage:	https://github.com/GutenYe/oldtime
Author:	Guten
License:	MIT-LICENSE
Documentation:	http://rubydoc.info/gems/oldtime/frames
Issue Tracker:	https://github.com/GutenYe/oldtime/issues

Getting Started

For example, we want to backup /oldtime to /tmp/hello.oldtime using rsync.

create hello example from https://github.com/GutenYe/oldtime-helloworld

$ git clone git://github.com/GutenYe/oldtime-helloworld.git  /tmp/oldtime
$ sudo ln -s /tmp/oldtime /oldtime

it will have these files:

/oldtime/oldtime/
  hello.conf
  hello/
    backup.hello

# /oldtime/oldtimerc  # an Optimsim config file.
  media = "/tmp"  # get this variable by Rc.media. 

# /oldtime/oldtime/hello/backup.hello

  /oldtime/  <%=Rc.media%>/hello.oldtime/ # an ERB template.

  [exclude]
  /.git
  /oldtimerc

# /oldtime/hello.conf

  require "oldtime/rsync"

  configure <<-EOF
    backup:
      rsync.options = "-av --delete" # get this variable by Rc.backup.rsync.options

    restore:
      rsync.options = "-av"
  EOF

  backup do
    rsync2 "backup.hello"  # run rsync command read from /oldtime/hello/backup.hello file
  end

  restore do
    rsync "<%=Rc.media%>/hello.oldtime/ /oldtime/" # run rsync command
  end

Let's begin.

$ oldtime backup hello
# it calls "rsync -av --delete --exclude-from /tmp/hello.xx/exclude /oldtime/ /tmp/hello.oldtime/"

$ oldtime restore hello
# it calls "rsync -av /tmp/hello.oldtime/ /oldtime/"

# halt system after complete is done.
$ oldtime backup hello -h

for a real world example, see oldtime-archlinux-solution.

see Optimism Syntax: https://github.com/GutenYe/optimism

see ERB Syntax: http://ruby-doc.org/stdlib-1.9.3/libdoc/erb/rdoc/ERB.html

hooks

# hello.conf 

    before do
        puts "before"
    end

    backup do
        ..
    end

    after do
        puts "after"
    end

$ oldtimie backup hello
# puts "before" 
# do backup
# puts "after"

named hook

# hello.conf

    backup :files do
        ..
    end

    after :halt, :on => "backup.files" do
        puts "halt"
    end

    after :notify, :on => "backup" do
        puts "notify"
    end


$ oldtime backup hello -a halt notify
# do backup
# puts "halt"
# puts "notify"

Install

# Archlinux
pacman -S ruby rsync
gem install oldtime

# /etc/cron.weekly/cleanup_pkg
    pacman -Sc --noconfirm

Note on Patches/Pull Requests

Fork the project.
Make your feature addition or bug fix.
Add tests for it. This is important so I don't break it in a future version unintentionally.
Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
Send me a pull request. Bonus points for topic branches.
Coding Style Guide: https://gist.github.com/1105334

Credits

Contributors

Resources

Ruby: A Programmer's Best Friend
Archlinux: A simple, lightweight distribution

Copyright

(the MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.