README.md in symmetric-encryption-3.3 vs README.md in symmetric-encryption-3.4.0

- old
+ new

@@ -415,10 +415,12 @@ bundle install ## Rails Configuration +If deploying to Heroku skip to the section "Rails Configuration for a Heroku deployment" below + ### Creating the configuration file The configuration file contains the path to the production encryption key files. Generally in development and test the files are not created, so supply the full path to these files in production. Once the config file has been generated it can be @@ -482,10 +484,31 @@ key files to every server in that environment. I.e. All Rails servers in each environment must run the same encryption keys. Note: The generate step above must only be run once in each environment +## Rails Configuration for a Heroku deployment + +Deploying to Heroku requires the encrypted key to be stored in an environment +variable rather than as a file on disk. + +Generate the configuration file: + + rails g symmetric_encryption:heroku_config + +Note: Ignore the warning about "Symmetric Encryption config not found" since it is +being generated. + +Note: The encrypted keys for the release and production environments are displayed on +screen and must be entered manually as environment variables into Heroku so that the +application can find them when it starts. + +#### Save to version control + +This configuration file should be checked into the source code control system. +It does Not include the Symmetric Encryption keys. + ## Using in non-Rails environments SymmetricEncryption can also be used in non-Rails environment. Install SymmetricEncryption @@ -679,9 +702,10 @@ Contributors ------------ [M. Scott Ford](https://github.com/mscottford) +[Adam St. John](https://github.com/astjohn) License ------- Copyright 2012, 2013, 2014 Reid Morrison