pantographe / capistrano-procfile

⚠️ NOT PROD READY / NO LONGER MAINTAINED ⚠️ — Procfile specific tasks for Capistrano v3 (generate systemd services)

Capistrano::Procfile

⚠️ This project is not production ready for now ⚠️

Procfile specific tasks for Capistrano v3.
This Capistrano v3 extension read the Procfile of your application to generate systemd services.

Installation

Add these lines to your application's Gemfile:

group :development do
  gem "capistrano", "~> 3.6"
  gem "capistrano-procfile", "~> 1.2"
end

And then execute:

$ bundle

Or install it yourself as:

$ gem install capistrano-procfile

Usage

Require in Capfile to use the default task:

require "capistrano/procfile"

This Capistrano extension reads the Procfile of your application and it generates systemd services. The services generation is based on server roles to know which Procfile rules must be applied. In each server a service target will be generated to simplify the availability of start/stop/restart a complete application.

Configurable options (default values):

set_if_empty :procfile_path,    "Procfile"
set_if_empty :procfile_options, {
  user: ->(host) { host.user }
}

set :procfile_service_name,          -> { fetch(:application) }
set :procfile_service_path,          "/lib/systemd/system"
set :procfile_service_template_path, File.expand_path("../../templates/systemd", __FILE__)
set :procfile_service_env_vars,      -> { fetch(:default_env, {}) }
set :procfile_check_timeout,         15

set :procfile_apply_automatically,  true
set :procfile_enable_automatically, -> { fetch(:procfile_apply_automatically) }

Tasks

cap procfile:apply                  # Apply Procfile commands on server(s)
cap procfile:check[procname]        # Check services status
cap procfile:cleanup                # Cleanup services
cap procfile:disable                # Disable Procfile services
cap procfile:enable                 # Enable Procfile services
cap procfile:kill[signal,procname]  # Kill Procfile service(s)
cap procfile:restart[procname]      # Restart Procfile service(s)
cap procfile:start[procname]        # Start Procfile service(s)
cap procfile:stop[procname]         # Stop Procfile service(s)

Examples

See examples.

Contributing

1. Fork it
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

License

This project is under MIT license.