aurels-backuper 0.2 → 0.3

data/README.rdoc

@@ -0,0 +1,26 @@
+A simple server backup tool written in Ruby.
+
+= To install:
+
+  sudo gem source -a http://gems.github.com
+  sudo gem install aurels-backuper
+
+= Dependencies:
+
+UNIX commands:
+- 'tar'
+- 'mysqldump' if you want to backup your MySQL databases
+- 'ncftpput' if you backup through FTP
+- 'scp' if you backup through SSH
+
+= To use:
+
+- Create a script file which requires 'backuper' and create a new Backuper instance
+- Configure cron to run the script as root when you want
+
+An example of backup script is in examples/backup.rb (use it as a base template).
+
+(c) 2009 Aurélien Malisart, aurelien.malisart@gmail.com, http://aurelien.malisart.be
+
+Released under GNU GPLv3 license.
+

data/examples/backup.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/ruby
+
+require 'rubygems'
+require 'backuper'
+
+################################################################################
+
+backup = Backuper.new
+
+# Unix general =================================================================
+
+backup.config_file "/etc/ssh/sshd_config"
+backup.config_file "/etc/passwd"
+backup.config_file "/etc/group"
+backup.config_file "/etc/contab"
+
+# Apache2 ======================================================================
+
+backup.config_file "/etc/apache2/httpd.conf"
+backup.config_dir  "/etc/apache2/sites-available"
+
+# Nginx ========================================================================
+
+backup.config_file "/opt/nginx/conf/nginx.conf"
+backup.config_dir  "/opt/nginx/conf/sites-available"
+
+# SQLite databases =============================================================
+
+backup.sqlite_database "/home/aurels/databases/espassvie.sqlite3"
+                                                                
+# MySQL databases ==============================================================
+
+backup.mysql_params = {
+  :user    => 'backup',
+  :password => 'blup'
+}
+
+# We recommend creating a 'backup' user with only SELECT and LOCK TABLES
+# privileges :
+#
+# mysql -u root -p
+# GRANT SELECT, LOCK TABLES ON *.* TO backup@localhost IDENTIFIED BY 'blup';
+# FLUSH PRIVILEGES;
+
+backup.mysql_database 'db1'
+backup.mysql_database 'db2'
+
+# Data directories =============================================================
+
+backup.data_dir "/super/projet/rails/public/assets"
+
+# FTP or SSH setup =============================================================
+
+backup.ftp_params = {
+  :host     => '',
+  :user     => '',
+  :password => '',
+  :path     => '/backups' # path on host
+}
+
+# or:
+
+#backup.ssh_params = {
+#  :host => '',
+#  :user => '', # this user needs to have his public key authorized on the host
+#  :path => '/home/aurels/backups' # path on host
+#}
+
+################################################################################
+
+backup.perform!

data/lib/backuper.rb

@@ -1,9 +1,10 @@
 class Backuper
   
-  TMP_DIR = "/backuper"
+  TMP_DIR = "/tmp/backuper"
   
   attr_writer :mysql_params
   attr_writer :ftp_params
+  attr_writer :ssh_params
   
   def initialize
     @config_files     = []
@@ -13,6 +14,7 @@ class Backuper
     @mysql_databases  = []
     @data_dirs        = []
     @ftp_params       = {}
+    @ssh_params       = {}
     @archive_filename = "backup-#{Time.now.strftime('%Y-%m-%d')}-#{Time.now.to_i}.tar.gz"
   end
   
@@ -76,8 +78,6 @@ class Backuper
       @mysql_databases.each do |db|
         run "mysqldump #{db} --user=#{@mysql_params[:user]} --password=#{@mysql_params[:password]} > #{File.join(TMP_DIR, 'databases', 'mysql', "#{db}.sql")}"
       end
-    else
-      say "MySQL databases backup not done because MySQL params are unset"
     end
   end
   
@@ -88,8 +88,10 @@ class Backuper
   def upload_archive
     unless @ftp_params.empty?
       run "ncftpput -u #{@ftp_params[:user]} -p #{@ftp_params[:password]} #{@ftp_params[:host]} #{@ftp_params[:path]} /tmp/#{@archive_filename}"
-    else
-      say "Upload to FTP server not done because FTP params are unset"
+    end
+    
+    unless @ssh_params.empty?
+      run "scp /tmp/#{@archive_filename} #{@ssh_params[:user]}@#{@ssh_params[:host]}:#{@ssh_params[:path]}"
     end
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aurels-backuper
 version: !ruby/object:Gem::Version 
-  version: "0.2"
+  version: "0.3"
 platform: ruby
 authors: 
 - "Aur\xC3\xA9lien Malisart"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-22 00:00:00 -07:00
+date: 2009-07-25 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -22,8 +22,9 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README
+- README.rdoc
 - lib/backuper.rb
+- examples/backup.rb
 has_rdoc: false
 homepage: http://github.com/aurels/backuper
 post_install_message: 

data/README

@@ -1,14 +0,0 @@
-A simple server backup tool written in Ruby.
-
-To install:
-
-sudo gem list -a http://gems.github.com
-sudo gem install aurels-backuper
-
-To use:
-
-- Create a script file which requires 'backuper' and create a new Backuper instance
-- Configure cron to run the script as root when you want
-
-Example of backup script in examples/backup.rb (use it as a base template)
-