Skip to content

Commit 09ceb7d

Browse files
committed
doc: ad use of openssl rand to generate jwt secret.
Recommend use of 'openssl rand -base64 32' for creating minimal jwt_secret.
1 parent ee55a66 commit 09ceb7d

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

doc/rest.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1971,7 +1971,9 @@ There are 5 steps to set this up:
19711971
This uses the `Adding new rest endpoints`_ mechanism.
19721972
4. configure roundup's config.ini [web] jwt_secret with at least 32
19731973
random characters of data. (You will get a message
1974-
``Support for jwt disabled by admin.`` if it's not long enough.)
1974+
``Support for jwt disabled by admin.`` if it's not long
1975+
enough.) If you have openssl installed, you can use the output
1976+
of ``openssl rand -base64 32``.
19751977
5. add an auditor to make sure that users with this role are appending
19761978
timelog links to the ``times`` property of the issue.
19771979

@@ -2212,7 +2214,8 @@ Final steps
22122214
See the `upgrading directions`_ on how to use the ``updateconfig``
22132215
command to generate an updated copy of config.ini using
22142216
roundup-admin. Then set the ``JWT_secret`` to at least 32 characters
2215-
(more is better up to 512 bits).
2217+
(more is better up to 512 bits). The output of
2218+
``openssl rand -base64 32`` will fulfill the minimum requirements.
22162219

22172220
Writing an auditor that uses "db.user.get_roles" to see if the user
22182221
making the change has the ``user:timelog`` role, and then comparing

0 commit comments

Comments
 (0)