Doppler Ruby Library

The Doppler Ruby library provides convenient access to the Doppler API from applications written for only server-side code.

Installation

Install the gem with:

gem install doppler

Usage

The package needs to be configured with your account's api key which is available in your Doppler account, pipeline identifier and the environment name:

require "doppler"

Doppler.configure do |config|
  config.api_key = "api-key"
  config.pipeline = "31"
  config.environment = "development_ruby"
  config.priority = Doppler::PRIORITY_REMOTE
end


doppler = Doppler::Client.new()

# Rest of Application

Key Best Practices

So if Doppler stores my environment keys, where should I keep my Doppler API keys?

That is a great question! We recommend storing your API_KEY, PIPELINE_ID, and ENVIRONMENT_NAME in local environment. That means the only keys you should be storing in your local environment are the Doppler keys. All other keys should be be fetched by the Doppler client.

Fetch Environment Keys

You can fetch your environment keys from Doppler by calling the get(name) method.

doppler.get(KEY_NAME)

Here is an example:

config = {
  "segment_key" => doppler.get("SEGMENT_API_KEY"),
  "algolia_key" => doppler.get("ALGOLIA_API_KEY")
}

If there are differences between the values your local environment sets and the ones on Doppler, the client will use the ones provided by Doppler. You can override this behavior by passing in a second argument to the get(key_name, priority) method that sets the priority to favor your local environment.

For example:

# Local Enviroment
os.environ["MAGICAL_KEY"] = "123"

# Doppler
MAGICAL_KEY = "456"


# Default Behavior
doppler.get("MAGICAL_KEY") # => "456"

# Override to Local
doppler.get("MAGICAL_KEY", Doppler::Priority.local) # => "123"

You can also set the priority globally on initialization:

Doppler.configure do |config|
  # ...
  config.priority = Doppler::PRIORITY_LOCAL
end

Rails integration

Configure Doppler with keys and environments, and then you should be all good. Please use the following snippet in initializer folder.

Doppler.configure do |config|
  config.api_key = "api-key"
  config.pipeline = "31"
  config.environment = "development_ruby"
  config.priority = Doppler::PRIORITY_REMOTE
end

Example repo found here.

Local Key Privacy

By default the Doppler client will only track the local environment keys that are used during doppler.get(). Collecting only those local keys helps us automatically setup your pipelines for immediate use. After setup we also use your keys to detect when your keys locally have changed from what is on Doppler. We then provide a way for you to adopt or reject those changes through our dashboard. This can help help when debugging silent bugs or build failures.

Track Additional Keys

The Doppler client can also track additional keys by providing an array of keys to the track_keys field.

Doppler.configure do |config|
  # ...
  config.track_keys = [
    "KEY_TO_TRACK"
  ]
end

Ignoring Specific Keys

Inversely, you can also ignore specific local keys by adding them to the ignore_keys array.

Doppler.configure do |config|
  # ...
  config.ignore_keys = [
    "SUPER_SECRET_KEY"
  ]
end

Extra Information

• Doppler
• API KEY