Skip to content

Commit c4130d1

Browse files
committed
Adds more help to docs
1 parent a7f5499 commit c4130d1

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/installation.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -269,3 +269,18 @@ By default ``dj-rest-auth`` uses Django's Token-based authentication. If you wan
269269
.. code-block:: python
270270
271271
REST_USE_JWT = True
272+
273+
4. Declare what you want the cookie key to be called.
274+
275+
.. code-block:: python
276+
277+
JWT_AUTH_COOKIE = 'my-app-auth'
278+
279+
280+
This example value above will cause dj-rest-auth to return a `Set-Cookie` header that looks like this:
281+
282+
.. code-block:: bash
283+
284+
Set-Cookie: my-app-auth=xxxxxxxxxxxxx; expires=Sat, 28 Mar 2020 18:59:00 GMT; HttpOnly; Max-Age=300; Path=/
285+
286+
``JWT_AUTH_COOKIE`` is also used while authenticating each request against protected views.

0 commit comments

Comments
 (0)