87 lines
2.9 KiB
Plaintext
87 lines
2.9 KiB
Plaintext
== Introduction
|
|
|
|
Whenever is a ruby gem that provides a ruby syntax for defining cron jobs. It is designed to work well with Rails applications, but can be used independently as well.
|
|
|
|
== Installation
|
|
|
|
NOTE: Requiring the whenever gem inside your Rails application is technically optional. However, if you plan to use something like Capistrano to automatically deploy and write your crontab file, you'll need to have the gem installed on your servers, and requiring it in your app is one to ensure this. If you plan to manually install the gem on your servers or you don't care about Rails, deploying, etc., you can skip the next step.
|
|
|
|
To install Whenever in a Rails (2.1 or greater) application:
|
|
|
|
in your "config/environment.rb" file:
|
|
|
|
Rails::Initializer.run do |config|
|
|
config.gem 'javan-whenever', :lib => 'whenever', :source => 'http://gems.github.com'
|
|
end
|
|
|
|
To install this gem (and all other missing gem dependencies), run rake gems:install (use sudo if necessary).
|
|
|
|
In older versions of Rails:
|
|
|
|
$ gem sources -a http://gems.github.com
|
|
$ gem install javan-whenever
|
|
|
|
in your "config/environment.rb" file:
|
|
|
|
Rails::Initializer.run do |config|
|
|
...
|
|
end
|
|
|
|
require "whenever"
|
|
|
|
== Getting started
|
|
|
|
$ cd /my/rails/app
|
|
$ wheneverize .
|
|
|
|
This will create an initial "config/schedule.rb" file you.
|
|
|
|
== Example schedule.rb file
|
|
|
|
set :path, '/var/www/apps/my_app' # Whenever will try to use your RAILS_ROOT if this isn't set
|
|
set :environment, :production # Whenever defaults to production so you only need to set this for something different
|
|
set :cron_log, '/my/cronlog.log' # Where to log (this should NOT be your Rails log)
|
|
|
|
every 2.hours do
|
|
runner "MyModel.some_process" # runners are the script/runners you know and love
|
|
rake "my:rake:task" # conveniently run rake tasks
|
|
command "/usr/local/bin/my_great_command" # commands are any unix command
|
|
end
|
|
|
|
every 1.day, :at => '4:30 am' do # If not :at option is set these jobs will run at midnight
|
|
runner "DB.Backup", :cron_log => false # You can specify false for no logging or a string a different log file to override logging.
|
|
end
|
|
|
|
every :hour do # Many shortcuts available: :hour, :day, :month, :year, :reboot
|
|
runner "SomeModel.ladeda"
|
|
end
|
|
|
|
every :sunday do # Use any day of the week or :weekend, :weekday
|
|
runner "Task.do_something_great"
|
|
end
|
|
|
|
== Cron output
|
|
|
|
$ cd /my/rails/app
|
|
$ whenever
|
|
|
|
And you'll see your schedule.rb converted to cron sytax
|
|
|
|
== Capistrano integration
|
|
|
|
in your "config/deploy.rb" file do something like:
|
|
|
|
after "deploy:symlink", "deploy:write_crontab"
|
|
|
|
namespace :deploy do
|
|
desc "write the crontab file"
|
|
task :write_crontab, :roles => :app do
|
|
run "cd #{release_path} && whenever -c"
|
|
end
|
|
end
|
|
|
|
THIS WILL COMPLETELY OVERWRITE ANY EXISTING CRONTAB ENTRIES!
|
|
------------------------------------------------------------
|
|
|
|
Better documentation on the way!
|