github-migration/whenever
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
Javan Makhmali 2009-02-16 16:47:21 -08:00
parent 01b7b81a10
commit b82ef34ec4
1 changed files with 22 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.rdoc
View File

@ -1,9 +1,11 @@
= Whenever == Introduction
Whenever is a ruby gem that provides a ruby syntax for defining cron jobs. It was designed to work well with Rails applications, but can be used independently as well. 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 == 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: To install Whenever in a Rails (2.1 or greater) application:
in your "config/environment.rb" file: in your "config/environment.rb" file:
@ -16,9 +18,8 @@ To install this gem (and all other missing gem dependencies), run rake gems:inst
In older versions of Rails: In older versions of Rails:
$ gem sources -a http://gems.github.com $ gem sources -a http://gems.github.com
$ gem install javan-whenever
$ gem install javan-whenever
in your "config/environment.rb" file: in your "config/environment.rb" file:
@ -30,21 +31,20 @@ in your "config/environment.rb" file:
== Getting started == Getting started
$ cd /my/rails/app $ cd /my/rails/app
$ wheneverize .
$ wheneverize .
This will create an initial "config/schedule.rb" file you. This will create an initial "config/schedule.rb" file you.
== Example schedule.rb file == Example schedule.rb file
set :runner_path, '/var/www/apps/my_app' # Whenever will try to use your RAILS_ROOT if this isn't set set :path, '/var/www/apps/my_app' # Whenever will try to use your RAILS_ROOT if this isn't set
set :runner_environment, :production # Whenever defaults to production so only set this if you want to use a different environment. set :environment, :production # Whenever defaults to production so you only need to set this for something different
set :cron_log, '/path/to/my/cronlog.log' # Where to log (this should NOT be your Rails log) set :cron_log, '/my/cronlog.log' # Where to log (this should NOT be your Rails log)
every 2.hours do every 2.hours do
runner "MyModel.some_process" # runners are the script/runners you know and love 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 command "/usr/local/bin/my_great_command" # commands are any unix command
end end
@ -62,19 +62,23 @@ This will create an initial "config/schedule.rb" file you.
== Cron output == Cron output
$ cd /my/rails/app $ cd /my/rails/app
$ whenever
$ whenever
And you'll see your schedule.rb converted to cron sytax And you'll see your schedule.rb converted to cron sytax
== Capistrano integration == Capistrano integration
Use the "whenever:write_cron" task to automatically write your crontab file with each deploy.
in your "config/deploy.rb" file do something like: in your "config/deploy.rb" file do something like:
after "deploy:symlink", "whenever:write_cron" 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! THIS WILL COMPLETELY OVERWRITE ANY EXISTING CRONTAB ENTRIES!
------------------------------------------------------------ ------------------------------------------------------------