ConfigReader

Provides a way to manage environment specific configuration settings. It will use the defaults for any environment and override any values you specify for an environment.

Example config file:

defaults:
  site_url: http://localhost:3000
  host_name: example.com
  mail_from: [email protected]
  site_name: example
  admin_email: [email protected]

production:
  site_url: http://example.com

Ruby 3.1 and 3.2

If you want to use Sekrets with these versions of Ruby you need to use this version until upstream gets updated.

gem "sekrets",
  github: "UnderpantsGnome/sekrets",
  branch: "ruby-3-2-support"

Sekrets

Includes Sekrets integration. See https://github.com/ahoward/sekrets for more information.

The format of the sekrets file is the same as the regular file.

Setup

class MyConfig < ConfigReader
  configure do |config|
    config.environment = Rails.env # (set this however you access the env in your app)
    config.config_file = 'config/my_config.yml'
    config.sekrets_file = 'config/my_config.yml.enc' # (default nil)
    config.ignore_missing_keys = true # (default false, raises KeyError)
  end
end

Usage

MyConfig.mail_from    #=> [email protected]
MyConfig[:mail_from]  #=> [email protected]
MyConfig['mail_from'] #=> [email protected]

Note on Patches/Pull Requests