Contents

# Clockwork Web

A web interface for [Clockwork](https://github.com/Rykian/clockwork)

[View the demo](https://clockwork.dokkuapp.com/)

- see list of jobs
- monitor jobs
- disable jobs

:tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)

[![Build Status](https://github.com/ankane/clockwork_web/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/clockwork_web/actions)

## Installation

Add this line to your application’s Gemfile:

```ruby
gem "clockwork_web"
```

And add it to your `config/routes.rb`.

```ruby
mount ClockworkWeb::Engine, at: "clockwork"
```

Be sure to secure the dashboard in production.

To monitor and disable jobs, hook up Redis in an initializer.

```ruby
ClockworkWeb.redis = Redis.new
```

#### Basic Authentication

Set the following variables in your environment or an initializer.

```ruby
ENV["CLOCKWORK_USERNAME"] = "andrew"
ENV["CLOCKWORK_PASSWORD"] = "secret"
```

#### Devise

```ruby
authenticate :user, ->(user) { user.admin? } do
  mount ClockworkWeb::Engine, at: "clockwork"
end
```

## Monitoring

```ruby
ClockworkWeb.running?
ClockworkWeb.multiple?
```

## Customize

Change clock path

```ruby
ClockworkWeb.clock_path = Rails.root.join("clock") # default
```

Turn off monitoring

```ruby
ClockworkWeb.monitor = false
```

## History

View the [changelog](CHANGELOG.md)

## Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help:

- [Report bugs](https://github.com/ankane/clockwork_web/issues)
- Fix bugs and [submit pull requests](https://github.com/ankane/clockwork_web/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features

To get started with development:

```sh
git clone https://github.com/ankane/clockwork_web.git
cd clockwork_web
bundle install
bundle exec rake test
```

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
clockwork_web-0.3.1	README.md
clockwork_web-0.3.0	README.md