Skip to content

Commit 63890b1

Browse files
committed
Put the default value alongside the name of the option to improve readability
1 parent aa91c37 commit 63890b1

File tree

1 file changed

+41
-43
lines changed

1 file changed

+41
-43
lines changed

cookbook/security/remember_me.rst

Lines changed: 41 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -52,49 +52,47 @@ the session lasts using a cookie with the ``remember_me`` firewall option:
5252
5353
The ``remember_me`` firewall defines the following configuration options:
5454

55-
``key``
56-
(default value: ``null``) The value used to encrypt the cookie's content.
57-
It's common to use the ``secret`` value defined in the ``app/config/parameters.yml``
58-
file.
59-
60-
``name``
61-
(default value: ``REMEMBERME``) The name of the cookie used to maintain the
62-
user logged in. If you enable the "Remember Me" feature in several firewalls
63-
of the same application, make sure to choose a different name for the cookie
64-
of each firewall. Otherwise, you'll face lots of security related problems.
65-
66-
``lifetime``
67-
(default value: ``31536000``) The number of seconds during which the user
68-
will remain logged in. By default users are logged in for one year.
69-
70-
``path``
71-
(default value: ``/``) The path where the cookie associated with this
72-
feature is used. By default the cookie will be applied to the entire website
73-
but you can restrict to a specific section (e.g. ``/forum``, ``/admin``).
74-
75-
``domain``
76-
(default value: ``null``) The domain where the cookie associated with this
77-
feature is used. By default cookies use the current domain obtained from
78-
``$_SERVER``.
79-
80-
``secure``
81-
(default value: ``false``) If ``true``, the cookie associated with this
82-
feature is sent to the user through an HTTPS secure connection.
83-
84-
``httponly``
85-
(default value: ``true``) If ``true``, the cookie associated with this
86-
feature is accessible only through the HTTP protocol. This means that the
87-
cookie won't be accessible by scripting languages, such as JavaScript.
88-
89-
``remember_me_parameter``
90-
(default value: ``_remember_me``) The name of the form field checked to
91-
decide if the "Remember Me" feature should be enabled or not. Keep reading
92-
this article to know how to enable this feature conditionally.
93-
94-
``always_remember_me``
95-
(default value: ``false``) If ``true``, the value of the ``remember_me_parameter``
96-
is ignored and the "Remember Me" feature is always enabled, regardless of the
97-
desire of the end user.
55+
``key`` (default value: ``null``)
56+
The value used to encrypt the cookie's content. It's common to use the
57+
``secret`` value defined in the ``app/config/parameters.yml`` file.
58+
59+
``name`` (default value: ``REMEMBERME``)
60+
The name of the cookie used to maintain the user logged in. If you enable the
61+
"Remember Me" feature in several firewalls of the same application, make sure
62+
to choose a different name for the cookie of each firewall. Otherwise, you'll
63+
face lots of security related problems.
64+
65+
``lifetime`` (default value: ``31536000``)
66+
The number of seconds during which the user will remain logged in. By default
67+
users are logged in for one year.
68+
69+
``path`` (default value: ``/``)
70+
The path where the cookie associated with this feature is used. By default
71+
the cookie will be applied to the entire website but you can restrict to a
72+
specific section (e.g. ``/forum``, ``/admin``).
73+
74+
``domain`` (default value: ``null``)
75+
The domain where the cookie associated with this feature is used. By default
76+
cookies use the current domain obtained from ``$_SERVER``.
77+
78+
``secure`` (default value: ``false``)
79+
If ``true``, the cookie associated with this feature is sent to the user
80+
through an HTTPS secure connection.
81+
82+
``httponly`` (default value: ``true``)
83+
If ``true``, the cookie associated with this feature is accessible only
84+
through the HTTP protocol. This means that the cookie won't be accessible
85+
by scripting languages, such as JavaScript.
86+
87+
``remember_me_parameter`` (default value: ``_remember_me``)
88+
The name of the form field checked to decide if the "Remember Me" feature
89+
should be enabled or not. Keep reading this article to know how to enable
90+
this feature conditionally.
91+
92+
``always_remember_me`` (default value: ``false``)
93+
If ``true``, the value of the ``remember_me_parameter`` is ignored and the
94+
"Remember Me" feature is always enabled, regardless of the desire of the
95+
end user.
9896

9997
Forcing the User to Opt-Out of the Remember Me Feature
10098
------------------------------------------------------

0 commit comments

Comments
 (0)