Browse files

updated README to explain how to use alternate variable files

  • Loading branch information...
1 parent 8af132f commit 35aec9abe08ec10345319de212f2a77e4292b776 @andyl committed Jun 7, 2012
Showing with 25 additions and 0 deletions.
  1. +25 −0
@@ -16,6 +16,8 @@ that supports plugin bundles.)
## Usage
+### Variable File
Define environment variables in an `.rbenv-vars` file in your project,
one variable per line, in the format `VAR=value`. For example:
@@ -40,6 +42,29 @@ directories of the current directory will be set. Variables from the
Use the `rbenv vars` command to print all environment variables in the
order they'll be set.
+### Alternate Variable File
+It is a good idea to segregate sensitive information like passwords
+and account infomation from your public code repository.
+To help with this, an alternate file can be used with the filename
+`.rbenv-vars-<yourfile>`. The alternate file will be loaded before
+the normal `.rbenv-vars` file.
+For example, your application may require an environment variable with
+a database connect string that contains a password.
+Alternate file: `.rbenv-vars-passwords`
+ DB_PASSWORD=mypassword
+Normal file: `.rbenv-vars`
+ DB_CONNECT_STRING=postgres://dbuser:${DB_PASSWORD}@localhost/my_database
+In this situation, you would include `.rbenv-vars-passwords` in your .gitignore
## License
&copy; 2011 Sam Stephenson. Released under the MIT license. See

0 comments on commit 35aec9a

Please sign in to comment.