Skip to content

Commit 98ef003

Browse files
committed
doc: add disable saving roundup-admin history file for password changes
1 parent 0bc1ea3 commit 98ef003

File tree

2 files changed

+15
-4
lines changed

2 files changed

+15
-4
lines changed

doc/admin_guide.txt

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2151,13 +2151,16 @@ you can put the initialise command and password on the command
21512151
line. But this allows others on the host to see the password (using
21522152
the ps command). To initialise a tracker non-interactively without
21532153
exposing the password, create a file (e.g init_tracker) set to mode
2154-
600 (so only the owner can read it) with the contents:
2154+
600 (so only the owner can read it) with the contents::
21552155

21562156
initialise admin_password
21572157

2158-
and feed it to roundup-admin on standard input. E.G.
2158+
and feed it to roundup-admin on standard input. E.G.::
21592159

2160-
cat init_tracker | roundup-admin -i tracker_dir
2160+
cat init_tracker | roundup-admin -i tracker_dir -P history_features=2
2161+
2162+
setting the pragma ``history_features=2`` prevents storing the command
2163+
in the user's history file.
21612164

21622165
(for more details see https://issues.roundup-tracker.org/issue2550789.)
21632166

doc/upgrading.txt

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2188,7 +2188,7 @@ running::
21882188
roundup-admin -i <tracker_home> table password,id,username
21892189

21902190
Look for lines starting with ``{CRYPT}``. You can reset the user's
2191-
password using::
2191+
password using [#history-pragma]_ ::
21922192

21932193
roundup-admin -i <tracker_home>
21942194
roundup> set user16 password=somenewpassword
@@ -2199,6 +2199,14 @@ prompt). This prevents the new password from showing up in the output
21992199
of ps or shell history. The new password will be encrypted using the
22002200
default encryption method (usually pbkdf2).
22012201

2202+
.. [#history-pragma] If your version of roundup-admin provides history
2203+
support, you should add ``-P history_features=2`` to the command
2204+
line or run ``pragma history_features=2`` at the ``roundup>``
2205+
prompt. This will prevent the command line (and password) from being
2206+
saved to your history file (usually ``.roundup_admin_history`` in
2207+
your user's home directory. You can use ``roundup-admin -i
2208+
<tracker_home> pragma list`` to see if pragmas are supported.
2209+
22022210
Enable performance improvement for wsgi mode (optional)
22032211
-------------------------------------------------------
22042212

0 commit comments

Comments
 (0)