Supervisor wrapper for mina
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib/mina
.gitignore
CHANGELOG.md
CODE_OF_CONDUCT.md
Gemfile
LICENSE.txt
README.md
Rakefile
mina-supervisord.gemspec

README.md

Mina::Supervisord

This is a Supervisor (process control system) wrapper for mina.

Installation

Add this line to your application's Gemfile:

gem 'mina-supervisord', require: false

And then execute:

$ bundle

Or install it yourself as:

$ gem install mina-supervisord

Usage

To restart your app during deploy you might add this to deloy.rb:

require 'mina/supervisord'

task deploy: :environment do
  deploy do
    ...
    on :launch do
      invoke :'supervisord:restart', 'puma'
    end
  end
end

To call it as mina task, eg. to start your puma, you would run this from command line:

bundle exec mina supervisord:start['puma']

puma is a supervisord program.

Supported tasks

  • supervisord:restart- to restart a program (eg. bundle exec mina supervisord:restart['program'])
  • supervisord:start- to start a program (eg. bundle exec mina supervisord:start['program'])
  • supervisord:stop- to stop a program (eg. bundle exec mina supervisord:stop['program'])
  • supervisord:status- to get status of a program (eg. bundle exec mina supervisord:status['program'])
  • supervisord:signal- to send a signal to a program (eg. bundle exec mina supervisord:signal['program,signal'])

Extra tasks

  • supervisord:signal:or_start- to send a signal to a program, or start it if not running (eg. bundle exec mina supervisord:signal:or_start['program,signal'])
  • supervisord:restart:or_start- to restart a program, or start it if not running (eg. bundle exec mina supervisord:restart:or_start['program'])

You might find these extra tasks useful when you are not sure whether your program is running.

Eg. when we do our deploy, we want our puma server to be restarted or started if not running already. To do that, we have following in our deploy.rb:

desc "Phased restart of the application"
task :phased_restart => :environment do
  invoke :'supervisord:signal:or_start', fetch(:application_supervisor_file), "SIGUSR1"
end

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/hovancik/mina-supervisord. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Development of this gem is sponsored by Mix.it.

License

The gem is available as open source under the terms of the MIT License.