Whenever Web

Whenever Web is a Rails engine, that can be easily integrated with your admin panel layout.

Installation

Add this line to your application's Gemfile:

gem 'whenever-web'

And then execute:

$ bundle

Usage

1. Mount the engine in your routes.rb:

MyApp::Application.routes.draw do
  # ...
  mount Whenever::Web, at: '/whenever'
  # ...
end

2. Go to localhost:3000/whenever.

3. Add a link to the panel in your views:

= link_to 'Cron Jobs', whenever_path

Authentication

Out of the box Whenever::Web doesn't make any assumptions about authentication. It's possible to take advantage of rails routing constraints or rack middleware.

An example using Rack::Auth::Basic.

# config/routes.rb
Whenever::Web.middleware.use Rack::Auth::Basic do |username, password|
  username == ENV['USERNAME'] && password == ENV['PASSWORD']
end

Optional usage

Describe your Cron jobs in schedule.rb by using desc method:

require 'whenever/web'

every 1.day, at: '3:00 am' do
  desc 'Database Backup'
  rake 'db:backup'
end

Custom configuration

Put this into config/initializers/whenever_web.rb:

# Specify your own controller base eg. 'Admin::AdminController'
# Whenever::Web.config.parent_controller = 'Whenever::WebController'

# Change default schedule file path
# Whenever::Web.config.schedule_file = 'config/schedule.rb'

Contributing

1. Fork it (http://github.com/bartoszkopinski/whenever-web/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request