aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorZachary Scott <e@zzak.io>2015-04-29 16:47:52 -0700
committerZachary Scott <e@zzak.io>2015-04-29 16:47:52 -0700
commit8cf22cefd4e44b6dae1152b4fddea240c7ee479b (patch)
tree45540be9abfbc7967daa83097b64192cb64a92ee
parent8b9e8a3f6f0b921a4fba5cfbb274961d82bde609 (diff)
parentd5a6297178d47c32103861fd1de860ad214a0280 (diff)
downloadrails-8cf22cefd4e44b6dae1152b4fddea240c7ee479b.tar.gz
rails-8cf22cefd4e44b6dae1152b4fddea240c7ee479b.tar.bz2
rails-8cf22cefd4e44b6dae1152b4fddea240c7ee479b.zip
Merge pull request #19957 from rywall/patch-2
Document :tld_length option for cookies.
-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+.