Speak, Friend, and enter.
Mellon is four things:
- A simple library for reading and writing notes in Mac OSX keychains. (see Mellon::Keychain)
- A simple library for using Mac OSX keychain notes as hash storage. (see Mellon::Store)
- An adapter for econfig, that uses Mellon::Store.
- A tiny CLI interface for Mellon::Keychain. (see Command-line interface)
I built Mellon because I wanted Yet Another Way of Managing Application Secrets™. Frankly, I am fed up with passing around some secret file not included in our source code repository that runs out of sync every time we add or change values during development.
Mellon, together with Econfig, solves this problem.
Mellon is sponsored by Elabs.
Mellon is intended for usage during development only. The recommended workflow is:
- Create an OSX keychain using Keychain Access, name it something hip and clever, like
- Share your keychain with your colleagues, through iCloud sync, Dropbox or similar.
- Hook up Mellon with your application according to the instructions below.
Using with Econfig (recommended) and Rails
Add to your Gemfile:
gem "econfig", require: "econfig/rails" gem "mellon", require: "mellon/econfig"
And create an initializer
if Rails.env.development? Econfig.instance.backends << Econfig::Mellon.new(Rails.application.name, keychain: "thanks-a-latte") MyRailsApplication.extend(Econfig::Shortcut) end
Now you’ll be able look up, and change, your shared configuration as such:
MyRailsApplication.some_configuration_key # => some value MyRailsApplication.some_configuration_key = "new value" # automatically synced to keychain
Mellon::Keychain allows you to read and write notes in OSX keychains.
keychain = Mellon::Keychain.default keychain["ruby note"] # => nil keychain["ruby note"] = "Hello from Ruby!" # creates keychain note `ruby note` keychain["ruby note"] # => "Hello from Ruby!" keychain["ruby note"] = nil # deletes keychain note `ruby note`
Mellon::Store is a layer above Mellon::Keychain, allowing you to use a single keychain note as hash storage. Notes are serialized as YAML by default.
project_name = "ruby note" store = Mellon::Store.new(project_name, keychain: Mellon::Keychain.default) store["some key"] # => nil store["some key"] = "Hello from Ruby!" # creates keychain note "ruby note", and puts value for "some key" in it store["some key"] # => "Hello from Ruby!" # Have a peek at the data, which is serialized as YAML store.keychain[store.project_name] # => "---\nsome key: Hello from Ruby!\n"
When you install the Mellon gem you also get an executable called
mellon -h for usage information.