Capistrano::Env

Capistrano with Env via file

Notice!

ruby_formatter will deprecated at 0.2.x and it will be removed at next version (>= 0.3). Now dotenv_formatter is avaiable, it create .env file instead of capenv.rb file, and use dotenv or dotenv-rails gem to read .env file.

Installation

Add this line to your application's Gemfile:

gem 'capistrano-env'

And then execute:

$ bundle

Or install it yourself as:

$ gem install capistrano-env

Usage

1. set env names in deploy.rb

Capistrano 2.x

in deploy.rb

require 'capistrano/env/v2'

capenv.use do |env|
  env.add /^MYAPP_/
  env.add /^MYAPP_/ do |key|
     key.gsub /^MYAPP_/, '' # replace keyname like MYAPP_DATABASE_URL => DATABASE_URL
  end
  env.add 'UNICORN_PROCESSES'
  env.add 'HOGE', 'hage'
  env.formatter = :dotenv #=> default is :ruby, but it is deprecated now.
end

Capistrano 3.x

in Capfile

require 'capistrano/env/v3'

in deploy.rb

Capistrano::Env.use do |env|
  env.add /^MYAPP_/
  env.add /^MYAPP_/ do |key|
     key.gsub /^MYAPP_/, '' # replace keyname like MYAPP_DATABASE_URL => DATABASE_URL
  end
  env.add 'UNICORN_PROCESSES'
  env.add 'HOGE', 'hage'
  env.formatter = :dotenv #=> default is :ruby, but it is deprecated now.
  env.filemode = 0644 #=> default is 0640.
end

2. deploy

bundle exec cap production deploy

• automaticaly create #current_path/.env
• automaticaly load #current_path/.env if you use dotenv-rails
  • you should load manualy in other framework
• you can use ENV['ENV_NAME'] in application

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