/capistrano-logrotate

Logrotate integration for Capistrano

Primary LanguageRuby

Capistrano::Logrotate

Code Climate Gem Version

Installation

Add this line to your application's Gemfile:

gem 'capistrano-logrotate'

And then execute:

$ bundle

Or install it yourself as:

$ gem install capistrano-logrotate

Usage

# Capfile

require 'capistrano/logrotate'

then you can use `cap logrotate:config'

Configurable options, shown here with defaults: Please note the configuration options below are not required unless you are trying to override a default setting

set :logrotate_role, :app
set :logrotate_conf_path, -> { File.join('/etc', 'logrotate.d', "#{fetch(:application)}_#{fetch(:stage)}") }
set :logrotate_log_path, -> { File.join(shared_path, 'log') }
set :logrotate_logs_keep, -> { 12 }
set :logrotate_interval, -> { 'daily' }
set :logrotate_user, -> { fetch(:user) }
set :logrotate_group, -> { fetch(:user) }

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. 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/[USERNAME]/capistrano-logrotate.