Documentation

Installing Brakeman Pro Engine

The Brakeman Pro Engine gem is hosted on a private, authenticated gem server. Access requires a user name and password which we will generate and send to you upon purchase of a license.

Bundler

To use Brakeman Pro Engine with Bundler, add the Brakeman Pro gem server with your credentials to your Gemfile:

source "https://USER:PASSWORD@brakemanpro.com/gems/" do
  gem "brakeman-pro"
end

And run bundle install.

To update, run bundle update --source brakeman-pro.

Instead of saving the username and password in your Gemfile, either use Bundler to set up a configuration:

bundle config https://brakemanpro.com/gems/ USER:PASSWORD

Or set them as an environment variable:

export BUNDLE_GEM__BRAKEMANPRO__COM="USER:PASSWORD"

Then the source in Gemfile can be simply:

gem "brakeman-pro", source: "https://brakemanpro.com/gems/"

Ruby Gem

To simply install the gem:

gem install brakeman-pro --source https://USER:PASSWORD@brakemanpro.com/gems/

To add as a gem source:

gem sources --add https://USER:PASSWORD@brakemanpro.com/gems/

Note this will save the configuration in ~/.gemrc.