aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/rails
diff options
context:
space:
mode:
authorGuo Xiang Tan <tgx_world@hotmail.com>2014-12-24 00:32:31 +0800
committerGuo Xiang Tan <tgx_world@hotmail.com>2014-12-24 00:32:31 +0800
commit2f7b72b793dc18449c4033932ebd9e667e55dd89 (patch)
tree5f19396c8a3b642c521d9c2b8856c524f7d1cc0c /railties/lib/rails
parenta407bb245b0f5888c93dd98265e0f3b2cb35ef20 (diff)
downloadrails-2f7b72b793dc18449c4033932ebd9e667e55dd89.tar.gz
rails-2f7b72b793dc18449c4033932ebd9e667e55dd89.tar.bz2
rails-2f7b72b793dc18449c4033932ebd9e667e55dd89.zip
Rails::Application#secrets should be documented.
Diffstat (limited to 'railties/lib/rails')
-rw-r--r--railties/lib/rails/application.rb16
1 files changed, 15 insertions, 1 deletions
diff --git a/railties/lib/rails/application.rb b/railties/lib/rails/application.rb
index f8bd6096f2..ad8b52a39f 100644
--- a/railties/lib/rails/application.rb
+++ b/railties/lib/rails/application.rb
@@ -368,7 +368,21 @@ module Rails
@config = configuration
end
- def secrets #:nodoc:
+ # Returns secrets added to config/secrets.yml.
+ #
+ # Example:
+ #
+ # development:
+ # secret_key_base: 836fa3665997a860728bcb9e9a1e704d427cfc920e79d847d79c8a9a907b9e965defa4154b2b86bdec6930adbe33f21364523a6f6ce363865724549fdfc08553
+ # test:
+ # secret_key_base: 5a37811464e7d378488b0f073e2193b093682e4e21f5d6f3ae0a4e1781e61a351fdc878a843424e81c73fb484a40d23f92c8dafac4870e74ede6e5e174423010
+ # production:
+ # secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>
+ # namespace: my_app_production
+ #
+ # +Rails.application.secrets.namespace+ returns +my_app_production+ in the
+ # production environment.
+ def secrets
@secrets ||= begin
secrets = ActiveSupport::OrderedOptions.new
yaml = config.paths["config/secrets"].first