backedup 5.0.0.beta.3

data/templates/cli/encryptor/gpg

@@ -0,0 +1,27 @@
+  ##
+  # GPG [Encryptor]
+  #
+  # Setting up #keys, as well as #gpg_homedir and #gpg_config,
+  # would be best set in config.rb using Encryptor::GPG.defaults
+  #
+  encrypt_with GPG do |encryption|
+    # Setup public keys for #recipients
+    encryption.keys = {}
+    encryption.keys['user@domain.com'] = <<-KEY
+      -----BEGIN PGP PUBLIC KEY BLOCK-----
+      Version: GnuPG v1.4.11 (Darwin)
+
+          <Your GPG Public Key Here>
+      -----END PGP PUBLIC KEY BLOCK-----
+    KEY
+
+    # Specify mode (:asymmetric, :symmetric or :both)
+    encryption.mode = :both # defaults to :asymmetric
+
+    # Specify recipients from #keys (for :asymmetric encryption)
+    encryption.recipients = ['user@domain.com']
+
+    # Specify passphrase or passphrase_file (for :symmetric encryption)
+    encryption.passphrase = 'a secret'
+    # encryption.passphrase_file = '~/backup_passphrase'
+  end

data/templates/cli/encryptor/openssl

@@ -0,0 +1,9 @@
+  ##
+  # OpenSSL [Encryptor]
+  #
+  encrypt_with OpenSSL do |encryption|
+    encryption.password      = "my_password"            # From String
+    encryption.password_file = "/path/to/password/file" # Or from File
+    encryption.base64        = true
+    encryption.salt          = true
+  end

data/templates/cli/model

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+##
+# Backup Generated: <%= @options[:trigger] %>
+# Once configured, you can run the backup with the following command:
+#
+# $ backup perform -t <%= @options[:trigger] %> [-c <path_to_configuration_file>]
+#
+# For more information about Backup's components, see the documentation at:
+# http://backup.github.io/backup
+#
+Model.new(:<%= @options[:trigger] %>, 'Description for <%= @options[:trigger] %>') do
+<% if @options[:splitter] %>
+<%= Backup::Template.new.result('cli/splitter') %>
+<% end; if @options[:archives] %>
+<%= Backup::Template.new.result('cli/archive') %>
+<% end; %w{ databases storages syncers encryptor compressor notifiers }.each do |item|
+  if @options[item]
+    @options[item].split(',').map(&:strip).uniq.each do |entry|
+      if File.exist?(File.join(Backup::TEMPLATE_PATH, 'cli', item, entry)) %>
+<%= Backup::Template.new.result("cli/#{ item }/#{ entry }") %>
+<%    end
+    end
+  end
+end %>
+end

data/templates/cli/notifier/zabbix

@@ -0,0 +1,15 @@
+##
+# Zabbix [Notifier]
+#
+notify_by Zabbix do |zabbix|
+    zabbix.on_success = true
+    zabbix.on_warning = true
+    zabbix.on_failure = true
+
+    zabbix.zabbix_host  = "zabbix_server_hostname"
+    zabbix.zabbix_port  = 10051
+    zabbix.service_name = "Backup trigger"
+    zabbix.service_host = "zabbix_host"
+    zabbix.item_key     = "backup_status"
+  end
+

data/templates/cli/notifiers/campfire

@@ -0,0 +1,12 @@
+  ##
+  # Campfire [Notifier]
+  #
+  notify_by Campfire do |campfire|
+    campfire.on_success = true
+    campfire.on_warning = true
+    campfire.on_failure = true
+
+    campfire.api_token = "my_api_authentication_token"
+    campfire.subdomain = "my_subdomain"
+    campfire.room_id   = "my_room_id"
+  end

data/templates/cli/notifiers/command

@@ -0,0 +1,32 @@
+  ##
+  # Command [Notifier]
+  #
+  notify_by Command do |cmd|
+    cmd.on_success = true
+    cmd.on_warning = true
+    cmd.on_failure = true
+
+    # Command to execute
+    cmd.command = 'notify-send'
+
+    # Arguments to pass to the command.
+    #
+    # Must be an array of strings or callable objects.
+    #
+    # Callables will be invoked with #call(model, status),
+    # and the return value used as the argument.
+    #
+    # In strings you can use the following placeholders:
+    #
+    # %l - Model label
+    # %t - Model trigger
+    # %s - Status (success/failure/warning)
+    # %v - Status verb (succeeded/failed/succeeded with warnings)
+    #
+    # All placeholders can be used with uppercase letters to capitalize
+    # the value.
+    #
+    # Defaults to ["%L %v"]
+    #
+    # cmd.args = ["Backup %L", "%V"]
+  end

data/templates/cli/notifiers/datadog

@@ -0,0 +1,57 @@
+  ##
+  # DataDog [Notifier]
+  #
+  notify_by DataDog do |datadog|
+    datadog.on_success           = true
+    datadog.on_warning           = true
+    datadog.on_failure           = true
+
+    datadog.api_key              = 'my_api_key'
+
+    ##
+    # Optional
+    #
+    # Override Default Title
+    # Default is: "Backup #{:label}"
+    # datadog.title                = "Backup #{:status}"
+    #
+    # Override Default Text
+    # Default is "Backup Notification for #{:label}"
+    # datadog.text                 = "Backup #{:status} - #{:message}"
+    #
+    # Provide a hostname to associate this backup to
+    # Default is nil
+    # datadog.host                 = 'db.example.com'
+    #
+    # Add Tags to the Event
+    # Default is nil
+    # valid option is an Array
+    # datadog.tags                 = ['backup', 'env:production']
+    #
+    # Override the Alert Type
+    # Default is based on the :status of the backup:
+    # :success => 'success'
+    # :warning => 'warning'
+    # :failure => 'error'
+    # valid options are: 'info', 'success', 'warning', 'error'
+    # datadog.alert_type           = 'info'
+    #
+    # Add a Source Type
+    # Default is nil
+    # see api docs for valid source_type_names
+    # datadog.source_type_name        = 'my apps'
+    #
+    # Override the Priority Level
+    # Default is 'normal'
+    # valid options are: 'normal' or 'low'
+    # datadog.priority             = 'low'
+    #
+    # Override the Event Time (must be a unix Timestamp)
+    # Default is Time.now.to_i
+    # datadog.date_happened        = Time.now.to_i
+    #
+    # Add an Aggregation Key
+    # Default is nil
+    # max length allowed is 100 characters
+    # datadog.aggregation_key      = 'my_aggregation'
+  end

data/templates/cli/notifiers/flowdock

@@ -0,0 +1,16 @@
+  ##
+  # Flowdock [Notifier]
+  #
+  notify_by FlowDock do |flowdock|
+    flowdock.on_success = true
+    flowdock.on_warning = true
+    flowdock.on_failure = true
+
+    flowdock.token          = "token"
+    flowdock.from_name      = 'my_name'
+    flowdock.from_email     = 'email@example.com'
+    flowdock.subject        = 'My Daily Backup'
+    flowdock.source         = 'Backup'
+    flowdock.tags           = ['prod', 'backup']
+    flowdock.link           = 'www.example.com'
+  end

data/templates/cli/notifiers/hipchat

@@ -0,0 +1,16 @@
+  ##
+  # Hipchat [Notifier]
+  #
+  notify_by Hipchat do |hipchat|
+    hipchat.on_success = true
+    hipchat.on_warning = true
+    hipchat.on_failure = true
+
+    hipchat.token          = "token"
+    hipchat.from           = "DB Backup"
+    hipchat.rooms_notified = ["activity"]
+    hipchat.success_color  = "green"
+    hipchat.warning_color  = "yellow"
+    hipchat.failure_color  = "red"
+    hipchat.api_version    = "v1"
+  end

data/templates/cli/notifiers/http_post

@@ -0,0 +1,32 @@
+  ##
+  # HttpPost [Notifier]
+  #
+  notify_by HttpPost do |post|
+    post.on_success = true
+    post.on_warning = true
+    post.on_failure = true
+
+    # URI to post the notification to.
+    # Port may be specified if needed.
+    # If Basic Authentication is required, supply user:pass.
+    post.uri = 'https://user:pass@your.domain.com:8443/path'
+
+    ##
+    # Optional
+    #
+    # Additional headers to send.
+    # post.headers = { 'Authentication' => 'my_auth_info' }
+    #
+    # Additional form params to post.
+    # post.params = { 'auth_token' => 'my_token' }
+    #
+    # Successful response codes. Default: 200
+    # post.success_codes = [200, 201, 204]
+    #
+    # Defaults to true on most systems.
+    # Force with +true+, disable with +false+
+    # post.ssl_verify_peer = false
+    #
+    # Supplied by default. Override with a custom 'cacert.pem' file.
+    # post.ssl_ca_file = '/my/cacert.pem'
+  end

data/templates/cli/notifiers/mail

@@ -0,0 +1,24 @@
+  ##
+  # Mail [Notifier]
+  #
+  # The default delivery method for Mail Notifiers is 'SMTP'.
+  # See the documentation for other delivery options.
+  #
+  notify_by Mail do |mail|
+    mail.on_success           = true
+    mail.on_warning           = true
+    mail.on_failure           = true
+
+    mail.from                 = "sender@email.com"
+    mail.to                   = "receiver@email.com"
+    mail.cc                   = "cc@email.com"
+    mail.bcc                  = "bcc@email.com"
+    mail.reply_to             = "reply_to@email.com"
+    mail.address              = "smtp.gmail.com"
+    mail.port                 = 587
+    mail.domain               = "your.host.name"
+    mail.user_name            = "sender@email.com"
+    mail.password             = "my_password"
+    mail.authentication       = "plain"
+    mail.encryption           = :starttls
+  end

data/templates/cli/notifiers/nagios

@@ -0,0 +1,13 @@
+  ##
+  # Nagios [Notifier]
+  #
+  notify_by Nagios do |nagios|
+    nagios.on_success = true
+    nagios.on_warning = true
+    nagios.on_failure = true
+
+    nagios.nagios_host  = 'nagioshost'
+    nagios.nagios_port  = 5667
+    nagios.service_name = 'My Backup'
+    nagios.service_host = 'backuphost'
+  end

data/templates/cli/notifiers/pagerduty

@@ -0,0 +1,12 @@
+##
+# PagerDuty [Notifier]
+#
+
+notify_by PagerDuty do |pagerduty|
+  pagerduty.on_success = true
+  pagerduty.on_warning = true
+  pagerduty.on_failure = true
+
+  pagerduty.service_key = '0123456789abcdef01234567890abcde'
+  pagerduty.resolve_on_warning = true
+end

data/templates/cli/notifiers/prowl

@@ -0,0 +1,11 @@
+  ##
+  # Prowl [Notifier]
+  #
+  notify_by Prowl do |prowl|
+    prowl.on_success = true
+    prowl.on_warning = true
+    prowl.on_failure = true
+
+    prowl.application	= "my_application"
+    prowl.api_key    	= "my_api_key"
+  end

data/templates/cli/notifiers/pushover

@@ -0,0 +1,11 @@
+  ##
+  # Pushover [Notifier]
+  #
+  notify_by Pushover do |push|
+    push.on_success = true
+    push.on_warning = true
+    push.on_failure = true
+
+    push.user       = "USER_TOKEN"
+    push.token      = "APP_TOKEN"
+  end

data/templates/cli/notifiers/ses

@@ -0,0 +1,15 @@
+  ##
+  # SES [Notifier]
+  #
+  notify_by Ses do |ses|
+    ses.on_success = true
+    ses.on_warning = true
+    ses.on_failure = true
+
+    ses.access_key_id = ''
+    ses.secret_access_key = ''
+    ses.region = 'eu-west-1'
+
+    ses.from = "sender@email.com"
+    ses.to = "receiver@email.com"
+  end

data/templates/cli/notifiers/slack

@@ -0,0 +1,22 @@
+  ##
+  # Slack [Notifier]
+  #
+  notify_by Slack do |slack|
+    slack.on_success = true
+    slack.on_warning = true
+    slack.on_failure = true
+
+    # The incoming webhook url
+    # https://hooks.slack.com/services/xxxxxxxx/xxxxxxxxx/xxxxxxxxxx
+    slack.webhook_url = 'xxxxxxxxxxxxxxxxxxxxxxxx'
+
+
+    ##
+    # Optional
+    #
+    # The channel to which messages will be sent
+    # slack.channel = 'my_channel'
+    #
+    # The username to display along with the notification
+    # slack.username = 'my_username'
+  end

data/templates/cli/notifiers/twitter

@@ -0,0 +1,13 @@
+  ##
+  # Twitter [Notifier]
+  #
+  notify_by Twitter do |tweet|
+    tweet.on_success = true
+    tweet.on_warning = true
+    tweet.on_failure = true
+
+    tweet.consumer_key       = "my_consumer_key"
+    tweet.consumer_secret    = "my_consumer_secret"
+    tweet.oauth_token        = "my_oauth_token"
+    tweet.oauth_token_secret = "my_oauth_token_secret"
+  end

data/templates/cli/splitter

@@ -0,0 +1,7 @@
+  ##
+  # Split [Splitter]
+  #
+  # Split the backup file in to chunks of 250 megabytes
+  # if the backup file size exceeds 250 megabytes
+  #
+  split_into_chunks_of 250

data/templates/cli/storages/cloud_files

@@ -0,0 +1,11 @@
+  ##
+  # Rackspace Cloud Files [Storage]
+  #
+  store_with CloudFiles do |cf|
+    cf.api_key            = 'my_api_key'
+    cf.username           = 'my_username'
+    cf.container          = 'my_container'
+    cf.segments_container = 'my_segments_container' # must be different than `container`
+    cf.segment_size       = 5 # MiB
+    cf.path               = 'path/to/backups' # path within the container
+  end

data/templates/cli/storages/dropbox

@@ -0,0 +1,20 @@
+  ##
+  # Dropbox [Storage]
+  #
+  # Your initial backup must be performed manually to authorize
+  # this machine with your Dropbox account. This authorized session
+  # will be stored in `cache_path` and used for subsequent backups.
+  #
+  store_with Dropbox do |db|
+    db.api_key     = "my_api_key"
+    db.api_secret  = "my_api_secret"
+    # Sets the path where the cached authorized session will be stored.
+    # Relative paths will be relative to ~/Backup, unless the --root-path
+    # is set on the command line or within your configuration file.
+    db.cache_path  = ".cache"
+    # :app_folder (default) or :dropbox
+    db.access_type = :app_folder
+    db.path        = "/path/to/my/backups"
+    db.keep        = 25
+    # db.keep        = Time.now - 2592000 # Remove all backups older than 1 month.
+  end

data/templates/cli/storages/ftp

@@ -0,0 +1,13 @@
+  ##
+  # FTP (File Transfer Protocol) [Storage]
+  #
+  store_with FTP do |server|
+    server.username     = "my_username"
+    server.password     = "my_password"
+    server.ip           = "123.45.678.90"
+    server.port         = 21
+    server.path         = "~/backups/"
+    server.keep         = 5
+    # server.keep         = Time.now - 2592000 # Remove all backups older than 1 month.
+    server.passive_mode = false
+  end

data/templates/cli/storages/gcs

@@ -0,0 +1,8 @@
+  ##
+  # Google Cloud Storage Service [Storage]
+  #
+  store_with GCS do |gcs|
+    gcs.google_storage_access_key_id      = "GOOGXXXXXXXXXXXXXXXXX"
+    gcs.google_storage_secret_access_key  = "XXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX"
+    gcs.bucket                            = 'backups'
+  end

data/templates/cli/storages/local

@@ -0,0 +1,8 @@
+  ##
+  # Local (Copy) [Storage]
+  #
+  store_with Local do |local|
+    local.path       = "~/backups/"
+    local.keep       = 5
+    # local.keep       = Time.now - 2592000 # Remove all backups older than 1 month.
+  end

data/templates/cli/storages/qiniu

@@ -0,0 +1,12 @@
+  ##
+  # Qiniu [Storage]
+  #
+  store_with Qiniu do |qiniu|
+    # Qiniu Credentials
+    qiniu.access_key = "my_access_key"
+    qiniu.secret_key = "my_secret_key"
+
+    qiniu.bucket     = "bucket-name"
+    qiniu.keep       = 5
+    qiniu.path       = "path/to/backups"
+  end

data/templates/cli/storages/rsync

@@ -0,0 +1,17 @@
+  ##
+  # RSync [Storage]
+  #
+  # The default `mode` is :ssh, which does not require the use
+  # of an rsync daemon on the remote. If you wish to connect
+  # directly to an rsync daemon, or via SSH using daemon features,
+  # :rsync_daemon and :ssh_daemon modes are also available.
+  #
+  # If no `host` is specified, the transfer will be a local
+  # operation. `mode` and `compress` will have no meaning.
+  #
+  store_with RSync do |rsync|
+    rsync.mode      = :ssh
+    rsync.host      = "123.45.678.90"
+    rsync.path      = "~/backups/"
+    rsync.compress  = true
+  end

data/templates/cli/storages/s3

@@ -0,0 +1,16 @@
+  ##
+  # Amazon Simple Storage Service [Storage]
+  #
+  store_with S3 do |s3|
+    # AWS Credentials
+    s3.access_key_id     = "my_access_key_id"
+    s3.secret_access_key = "my_secret_access_key"
+    # Or, to use a IAM Profile:
+    # s3.use_iam_profile = true
+
+    s3.region            = "us-east-1"
+    s3.bucket            = "bucket-name"
+    s3.path              = "path/to/backups"
+    s3.keep              = 5
+    # s3.keep              = Time.now - 2592000 # Remove all backups older than 1 month.
+  end

data/templates/cli/storages/scp

@@ -0,0 +1,15 @@
+  ##
+  # SCP (Secure Copy) [Storage]
+  #
+  store_with SCP do |server|
+    server.username   = "my_username"
+    server.password   = "my_password"
+    server.ip         = "123.45.678.90"
+    server.port       = 22
+    server.path       = "~/backups/"
+    server.keep       = 5
+    # server.keep       = Time.now - 2592000 # Remove all backups older than 1 month.
+
+    # Additional options for the SSH connection.
+    # server.ssh_options = {}
+  end

data/templates/cli/storages/sftp

@@ -0,0 +1,15 @@
+  ##
+  # SFTP (Secure File Transfer Protocol) [Storage]
+  #
+  store_with SFTP do |server|
+    server.username   = "my_username"
+    server.password   = "my_password"
+    server.ip         = "123.45.678.90"
+    server.port       = 22
+    server.path       = "~/backups/"
+    server.keep       = 5
+    # server.keep         = Time.now - 2592000 # Remove all backups older than 1 month.
+
+    # Additional options for the SSH connection.
+    # server.ssh_options = {}
+  end

data/templates/cli/storages/swift

@@ -0,0 +1,19 @@
+##
+# OpenStack Swift object storage [Storage]
+#
+store_with Swift do |swift|
+  # Your OpenStack credentials
+  swift.auth_url      = "https://my.identity.server/v2.0/tokens"
+  swift.username      = "my_username"
+  swift.password      = "my_password"
+  
+  # If using a Keystone (v2) identity
+  swift.tenant_name   = "my_tenant_name"
+
+  swift.container     = "my_swift_container"
+  swift.path          = "path/to/backups"        
+  swift.keep          = 5
+  # swift.keep          = Time.now - 2592000 # Remove all backups older than 1 month.        
+  # If your deploiement has multiple regions
+  # swift.region        = "region"
+end

data/templates/cli/storages/webdav

@@ -0,0 +1,13 @@
+  ##
+  # Webdav [Storage]
+  #
+  store_with Webdav do |server|
+    server.username   = "my_username"
+    server.password   = "my_password"
+    server.ip         = "123.45.678.90"
+    server.port       = 443
+    server.use_ssl    = true
+    server.ssl_verify = true
+    server.path       = "remote.php/webdav/backups"
+    server.keep       = 3
+  end

data/templates/cli/syncers/cloud_files

@@ -0,0 +1,22 @@
+  ##
+  # Rackspace Cloud Files [Syncer]
+  #
+  sync_with Cloud::CloudFiles do |cf|
+    cf.username          = "my_username"
+    cf.api_key           = "my_api_key"
+    cf.container         = "my_container"
+    cf.path              = "/backups"
+    cf.mirror            = true
+    cf.thread_count      = 10
+
+    cf.directories do |directory|
+      directory.add "/path/to/directory/to/sync"
+      directory.add "/path/to/other/directory/to/sync"
+
+      # Exclude files/folders from the sync.
+      # The pattern may be a shell glob pattern (see `File.fnmatch`) or a Regexp.
+      # All patterns will be applied when traversing each added directory.
+      directory.exclude '**/*~'
+      directory.exclude /\/tmp$/
+    end
+  end

data/templates/cli/syncers/rsync_local

@@ -0,0 +1,20 @@
+  ##
+  # RSync::Local [Syncer]
+  #
+  sync_with RSync::Local do |rsync|
+    rsync.path     = "~/backups"
+    rsync.mirror   = true
+
+    rsync.directories do |directory|
+      directory.add "/var/apps/my_app/public/uploads"
+      directory.add "/var/apps/my_app/logs"
+
+      # Exclude files/folders.
+      # Each pattern will be passed to rsync's `--exclude` option.
+      #
+      # Note: rsync is run using the `--archive` option,
+      #       so be sure to read the `FILTER RULES` in `man rsync`.
+      directory.exclude '*~'
+      directory.exclude 'tmp/'
+    end
+  end

data/templates/cli/syncers/rsync_pull

@@ -0,0 +1,28 @@
+  ##
+  # RSync::Pull [Syncer]
+  #
+  # The default `mode` is :ssh, which does not require the use
+  # of an rsync daemon on the remote. If you wish to connect
+  # directly to an rsync daemon, or via SSH using daemon features,
+  # :rsync_daemon and :ssh_daemon modes are also available.
+  #
+  sync_with RSync::Pull do |rsync|
+    rsync.mode     = :ssh
+    rsync.host     = "123.45.678.90"
+    rsync.path     = "~/backups"
+    rsync.mirror   = true
+    rsync.compress = true
+
+    rsync.directories do |directory|
+      directory.add "/var/apps/my_app/public/uploads"
+      directory.add "/var/apps/my_app/logs"
+
+      # Exclude files/folders.
+      # Each pattern will be passed to rsync's `--exclude` option.
+      #
+      # Note: rsync is run using the `--archive` option,
+      #       so be sure to read the `FILTER RULES` in `man rsync`.
+      directory.exclude '*~'
+      directory.exclude 'tmp/'
+    end
+  end