Skip to content

Commit dce8f2f

Browse files
committed
issue2551048. Document WEB_SECRET_KEY in config.ini.
1 parent ff6a2c6 commit dce8f2f

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

doc/rest.txt

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,20 @@ The REST api is reached via the ``/rest/`` endpoint of the tracker
2727
URL. Partial URLs paths below (not starting with https) will have
2828
/rest removed for brevity.
2929

30+
Make sure that the ``secret_key`` option is defined in the
31+
``[web]`` section of your tracker's ``config.ini``. Following the
32+
`upgrading directions`_ using ``roundup-admin ... updateconfig
33+
...`` will generate the ``secret_key`` comments and setting. Then
34+
you can merge this into your ``config.ini``. If you are
35+
installing a new tracker with ``roundup-admin ... install`` the
36+
``secret_key`` value is automatically set to some random value.
37+
38+
If ``secret_key`` is not set, the etag value returned by a REST
39+
call will be change on every call even though the item has not
40+
changed.
41+
42+
.. _upgrading directions: upgrading.html
43+
3044
Preventing CSRF Attacks
3145
=======================
3246

0 commit comments

Comments
 (0)