Code Monkey home page Code Monkey logo

capistrano-env's Introduction

capistrano-env

Manage a .env file stored on S3 for deployment with capistrano.

Installation

Add this line to your application's Gemfile (there is another gem with the name capistrano-env):

gem 'capistrano-env', github: 'ecbypi/capistrano-env', tag: 'v0.2.0'

And then execute:

$ bundle

Or install it yourself as:

$ gem install capistrano-env

Usage

Require capistrano/env in your Capfile.

require 'capistrano/env'

Set the aws_credentials and env_bucket_name properties in your configuration:

set :aws_credentials, {
  aws_access_key_id: 'xxx'
  aws_secret_access_key: 'xxx'
}
set :env_bucket_name, 'my-bucket'

env_bucket_name will default to the ENV variables AWS_BUCKET_NAME, BUCKET_NAME or FOG_DIRECTORY. If the environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are set, then the aws-sdk will use them to authenticate so aws_credentials will not need to be set.

The object key that will be used defaults to #{application}-#{stage} or just application if stage is not defined. You can set env_object_key to customize it.

With all the configuration in place, you can begin to set, unset and read values.

$ cap env:set FOO=bar BAZ=buz

$ cap env:read
FOO=bar
BAZ=buz

$ cap env:unset FOO BAZ

The env:set and env:unset tasks are followed by env:export which commits your changes to S3 and uploads the to #{latest_release}/.env.

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.