aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_dispatch
diff options
context:
space:
mode:
authorRyan Wallace <rywall@gmail.com>2015-04-29 14:15:18 -0700
committerRyan Wallace <rywall@gmail.com>2015-04-29 14:15:18 -0700
commitd5a6297178d47c32103861fd1de860ad214a0280 (patch)
tree1197637e2e885c57fc3fb823aa635d67b73971de /actionpack/lib/action_dispatch
parent8979a5a4bd5cd570655ef66794140ad9212dcb0f (diff)
downloadrails-d5a6297178d47c32103861fd1de860ad214a0280.tar.gz
rails-d5a6297178d47c32103861fd1de860ad214a0280.tar.bz2
rails-d5a6297178d47c32103861fd1de860ad214a0280.zip
Document :tld_length option for cookies.
Diffstat (limited to 'actionpack/lib/action_dispatch')
-rw-r--r--actionpack/lib/action_dispatch/middleware/cookies.rb3
1 files changed, 3 insertions, 0 deletions
diff --git a/actionpack/lib/action_dispatch/middleware/cookies.rb b/actionpack/lib/action_dispatch/middleware/cookies.rb
index bb6a73afb5..dd1f140051 100644
--- a/actionpack/lib/action_dispatch/middleware/cookies.rb
+++ b/actionpack/lib/action_dispatch/middleware/cookies.rb
@@ -79,6 +79,9 @@ module ActionDispatch
# domain: %w(.example.com .example.org) # Allow the cookie
# # for concrete domain names.
#
+ # * <tt>:tld_length</tt> - When using <tt>:domain => :all</tt>, this option can be used to explicitly
+ # set the TLD length when using a short (<= 3 character) domain that is being interpreted as part of a TLD.
+ # For example, to share cookies between user1.lvh.me and user2.lvh.me, set <tt>:tld_length</tt> to 1.
# * <tt>:expires</tt> - The time at which this cookie expires, as a \Time object.
# * <tt>:secure</tt> - Whether this cookie is only transmitted to HTTPS servers.
# Default is +false+.