Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ankane/clockwork_web
A web interface for Clockwork
https://github.com/ankane/clockwork_web
Last synced: 5 days ago
JSON representation
A web interface for Clockwork
- Host: GitHub
- URL: https://github.com/ankane/clockwork_web
- Owner: ankane
- License: mit
- Created: 2015-02-13T08:10:31.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-10-27T18:04:26.000Z (7 days ago)
- Last Synced: 2024-10-27T21:46:20.017Z (7 days ago)
- Language: Ruby
- Size: 43.9 KB
- Stars: 39
- Watchers: 4
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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)
[](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
```