https://github.com/goodmeasuresllc/delayed_job_maintenance

In conjunction with capistrano-maintenance, stop delayed jobs during maintenance
https://github.com/goodmeasuresllc/delayed_job_maintenance

capistrano delayed-job rails

Last synced: about 2 months ago
JSON representation

In conjunction with capistrano-maintenance, stop delayed jobs during maintenance

• Host: GitHub
• URL: https://github.com/goodmeasuresllc/delayed_job_maintenance
• Owner: GoodMeasuresLLC
• License: mit
• Created: 2018-04-02T15:25:26.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-04-12T05:54:38.000Z (over 1 year ago)
• Last Synced: 2024-04-27T02:27:10.628Z (8 months ago)
• Topics: capistrano, delayed-job, rails
• Language: Ruby
• Size: 36.1 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: MIT-LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Delayed Job Maintenance

Extends [capistrano-maitenance](https://github.com/capistrano/maintenance) to stop delayed job while the maintenance page is displayed.

## Usage

After capistrano-maintenence is installed and configured, your application's web

interface will be disabled when the maintenance page is written to the server.  To

also disable backend processing in delayed job, you need to configure

capistrano-maintenance to also write to the delayed-job servers.

In your deployment configuration, add the queue server, or whichever role you

use for capistrano deployments to your delayed job servers:

```ruby

set :maintenance_roles, -> { roles([:web, :queue]) }

```

By default, capistrano-maintnance will write the maintenance template to

`"#{shared_path}/public/system"`.  However, `shared_path` is a capistrano variable

and is not available in delayed_job.  If this is different than `Rails.root.join("public", "system")`

or you are using a different maintenance file, you will need to configure the maintenance file:

Add this as an initializer:

```ruby

DelayedJobMaintenance.configure do |config|

  config.maintenance_file = Rails.root.join("public", "system", "maintenance.html")

end

```

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'delayed_job_maintenance'

```

And then execute:

```bash

$ bundle

```

Or install it yourself as:

```bash

$ gem install delayed_job_maintenance

```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/GoodMeasuresLLC/delayed_job_maintenance. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/GoodMeasuresLLC/delayed_job_maintenance/blob/master/CODE_OF_CONDUCT.md).