0.01
No commit activity in last 3 years
No release in over 3 years
Guard plug-in that allows you to restart Foreman
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

~> 2.6
>= 0.0.4, ~> 0.0
 Project Readme

Guard::Foreman

This project was originally a fork of [Guard::Unicorn] gdu, but has since diverged significantly.

Guard::Foreman automatically restarts Foreman using [Guard] gu.

Installation

Using Rubygems:

$ gem install guard-foreman

Using Bundler, you can add this to your Gemfile, preferably in the development group:

group :development do
  gem 'guard-foreman'
end

Add a sample Guard definition to your Guardfile:

$ guard init foreman

Guard General Usage

Please read the [guard usage doc] gd in order to find out more about Guard and how to use Guards. There is also [a Railscast about Guard] gc, created by Ryan Bates.

It is recommended that you also install the [ruby-gntp] gntp on Mac OS X, [libnotify] ln on Linux, FreeBSD or Solaris or [rb-notifu] notifu in order to have graphical notifications.

Guardfile for guard-foreman

guard :foreman, procfile: 'Procfile.dev'

Available options (Note: mostly stolen directly from the [Foreman documentation] fd):

  • :log_file Specify a location to pipe the Foreman logs into. Defaults to log/foreman.log
  • :concurrency Specify the number of each process to run. This should be passed in the format process=num,process=num
  • :env Specify one or more .env files to load
  • :procfile Specify an alternate Procfile to load
  • :port Specify which port to use as the base for this application. Should be a multiple of 1000.
  • :root Specify an alternate application root. This defaults to the directory containing the Procfile.

NOTE: The parent project of Guard::Foreman, [Guard::Unicorn] gdu, has a :bundler option available for using bundle exec. I have removed this bit of functionality as the [Foreman Github page] fgp asks users to not put Foreman in their Gemfiles.