Skip to content

Latest commit

 

History

History
55 lines (42 loc) · 2.32 KB

README.md

File metadata and controls

55 lines (42 loc) · 2.32 KB

Inprovise File dependency

This project implements an extension for the Inprovise provisioning tool providing a file command to the basic Inprovise scripts.

Build Status Code Climate Test Coverage Gem Version

Installation

$ gem install inprovise-file

Usage

Add the following to (for example) your Inprovise project's rigrc file.

require 'inprovise/file'

Syntax

file({
  :source       => '/local/source/path',        # alternatively provide block returning path string
  :destination  => '/remote/destination/path',  # alternatively provide block returning path string
  :create_dirs  => true,                        # alternatively provide block returning boolean
  :permissions  => 0644,                        # alternatively provide block returning permissions
  :group        => 'users',                     # alternatively provide block returning group id
  :user         => 'userid'                     # alternatively provide block returning user id
}) [ do ... end]                                # optional action block

or

file({
  :template     => '/local/template/path',      # alternatively provide block returning inline ERB template
  :destination  => '/remote/destination/path',  # alternatively provide block returning path string
  :create_dirs  => true,                        # alternatively provide block returning boolean
  :permissions  => 0644,                        # alternatively provide block returning permissions
  :group        => 'users',                     # alternatively provide block returning group id
  :user         => 'userid'                     # alternatively provide block returning user id
}) [ do ... end]                                # optional action block

Providing :source and :destination is mandatory. All other settings are optional.