Clone this wiki locally
Currently supported notifiers:
Below are examples you can copy/paste in to your "Backup" configuration file.
These blocks should be placed between
Backup::Model.new(:my_backup, 'My Backup') do and
notify_by Mail do |mail| mail.on_success = true mail.on_failure = true mail.from = 'email@example.com' mail.to = 'firstname.lastname@example.org' mail.address = 'smtp.gmail.com' mail.port = 587 mail.domain = 'your.host.name' mail.user_name = 'email@example.com' mail.password = 'my_password' mail.authentication = 'plain' mail.enable_starttls_auto = true end
This will make
firstname.lastname@example.org send an email to
email@example.com every time a Backup process ends with, or without any errors.
In case a Backup process succeeds without any errors, it'll notify
firstname.lastname@example.org with a plain email.
In case a Backup process raises an error, it'll (try to) notify
email@example.com with a more detailed email that includes the raised exception name, the backtrace, the Ruby version, the Backup Gem version, etc. for debugging purposes.
notify_by Twitter do |tweet| tweet.on_success = 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
In order to use Twitter as a notifier you will need a Twitter account. Once you create a Twitter account for the notifier, you need to register a new application for your Twitter account. After registering an application you will acquire the following credentials:
You can find these credentials on your application's pages.
notify_by Campfire do |campfire| campfire.on_success = true campfire.on_failure = true campfire.api_token = 'my_token' campfire.subdomain = 'my_subdomain' campfire.room_id = 'the_room_id' end
In order to use Campfire as a notifier you will need a Campfire account. Once you create a Campfire account for the notifier, you need to create a room and take note of it's id (room_id) (https://.campfirenow.com/room/), get your api authentication token from the "My info" page, and take not of your subdomain (https://.campfirenow.com/). Long story short, this is the information you will need:
- api authentication token
- room id
Default Configuration for each notifier
If you are planning to set up a Mail notifier for multiple Backup processes, it'll become quite verbose and redundant, very quickly. Consider setting up some default configuration. For example, if in most cases you want to use the same "sender" to send email notifications, you could set up a default Mail configuration, like so:
Backup::Configuration::Notifier::Mail.defaults do |mail| mail.from = 'firstname.lastname@example.org' mail.to = 'email@example.com' mail.address = 'smtp.gmail.com' mail.port = 587 mail.domain = 'your.host.name' mail.user_name = 'firstname.lastname@example.org' mail.password = 'my_password' mail.authentication = 'plain' mail.enable_starttls_auto = true end
So now, every time you wish to setup Mail notifications for a Backup process, you only have to define the following inside the Backup::Model block
notify_by Mail do |mail| mail.on_success = true mail.on_failure = true end
and you won't have to specify all the SMTP configuration, sender, receiver, credentials, etc. It'll always use these as default unless you explicitly overwrite them within the