aboutsummaryrefslogtreecommitdiffstats
path: root/guides
diff options
context:
space:
mode:
authorTim Rogers <tim@gocardless.com>2015-12-24 12:24:43 +0000
committerTim Rogers <tim@gocardless.com>2015-12-24 12:24:48 +0000
commit8678740e33132e7e380c446fd2ce96be56bd06f7 (patch)
treef87bc05d3e2b1363b08bc5788ffe176d3521fe41 /guides
parentfefd76e82af28decb895c22bbe1bbf265a2a8b75 (diff)
downloadrails-8678740e33132e7e380c446fd2ce96be56bd06f7.tar.gz
rails-8678740e33132e7e380c446fd2ce96be56bd06f7.tar.bz2
rails-8678740e33132e7e380c446fd2ce96be56bd06f7.zip
Improve documentation of config.force_ssl in guides
Diffstat (limited to 'guides')
-rw-r--r--guides/source/configuring.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/guides/source/configuring.md b/guides/source/configuring.md
index 47acff7c3f..b4ee967fcb 100644
--- a/guides/source/configuring.md
+++ b/guides/source/configuring.md
@@ -104,7 +104,7 @@ application. Accepts a valid week day symbol (e.g. `:monday`).
you don't want shown in the logs, such as passwords or credit card
numbers. New applications filter out passwords by adding the following `config.filter_parameters+=[:password]` in `config/initializers/filter_parameter_logging.rb`.
-* `config.force_ssl` forces all requests to be under HTTPS protocol by using `ActionDispatch::SSL` middleware.
+* `config.force_ssl` forces all requests to be served used HTTPS by using the `ActionDispatch::SSL` middleware. This can be configured by setting `config.ssl_options` - see the [ActionDispatch::SSL documentation](http://edgeapi.rubyonrails.org/classes/ActionDispatch/SSL.html) for details.
* `config.log_formatter` defines the formatter of the Rails logger. This option defaults to an instance of `ActiveSupport::Logger::SimpleFormatter` for all modes except production, where it defaults to `Logger::Formatter`.
@@ -198,7 +198,7 @@ The full set of methods that can be used in this block are as follows:
Every Rails application comes with a standard set of middleware which it uses in this order in the development environment:
-* `ActionDispatch::SSL` forces every request to be under HTTPS protocol. Will be available if `config.force_ssl` is set to `true`. Options passed to this can be configured by using `config.ssl_options`.
+* `ActionDispatch::SSL` forces every request to be served using HTTPS. Enabled if `config.force_ssl` is set to `true`. Options passed to this can be configured by setting `config.ssl_options`.
* `ActionDispatch::Static` is used to serve static assets. Disabled if `config.public_file_server.enabled` is `false`. Set `config.public_file_server.index_name` if you need to serve a static directory index file that is not named `index`. For example, to serve `main.html` instead of `index.html` for directory requests, set `config.public_file_server.index_name` to `"main"`.
* `Rack::Lock` wraps the app in mutex so it can only be called by a single thread at a time. Only enabled when `config.cache_classes` is `false`.
* `ActiveSupport::Cache::Strategy::LocalCache` serves as a basic memory backed cache. This cache is not thread safe and is intended only for serving as a temporary memory cache for a single thread.