changeset 8432:7f7749d86da8

doc: add disable saving roundup-admin history file for password changes
author John Rouillard <rouilj@ieee.org>
date Mon, 25 Aug 2025 20:44:42 -0400
parents a6c41651f553
children de1dac9abcb6
files doc/admin_guide.txt doc/upgrading.txt
diffstat 2 files changed, 16 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/doc/admin_guide.txt	Mon Aug 25 20:32:14 2025 -0400
+++ b/doc/admin_guide.txt	Mon Aug 25 20:44:42 2025 -0400
@@ -2151,13 +2151,16 @@
 line. But this allows others on the host to see the password (using
 the ps command). To initialise a tracker non-interactively without
 exposing the password, create a file (e.g init_tracker) set to mode
-600 (so only the owner can read it) with the contents:
+600 (so only the owner can read it) with the contents::
 
    initialise admin_password
 
-and feed it to roundup-admin on standard input. E.G.
-
-  cat init_tracker | roundup-admin -i tracker_dir
+and feed it to roundup-admin on standard input. E.G.::
+
+  cat init_tracker | roundup-admin -i tracker_dir -P history_features=2
+
+setting the pragma ``history_features=2`` prevents storing the command
+in the user's history file.
 
 (for more details see https://issues.roundup-tracker.org/issue2550789.)
 
--- a/doc/upgrading.txt	Mon Aug 25 20:32:14 2025 -0400
+++ b/doc/upgrading.txt	Mon Aug 25 20:44:42 2025 -0400
@@ -2188,7 +2188,7 @@
     roundup-admin -i <tracker_home> table password,id,username
 
 Look for lines starting with ``{CRYPT}``. You can reset the user's
-password using::
+password using [#history-pragma]_ ::
 
     roundup-admin -i <tracker_home>
     roundup> set user16 password=somenewpassword
@@ -2199,6 +2199,14 @@
 of ps or shell history. The new password will be encrypted using the
 default encryption method (usually pbkdf2).
 
+.. [#history-pragma] If your version of roundup-admin provides history
+  support, you should add ``-P history_features=2`` to the command
+  line or run ``pragma history_features=2`` at the ``roundup>``
+  prompt. This will prevent the command line (and password) from being
+  saved to your history file (usually ``.roundup_admin_history`` in
+  your user's home directory.  You can use ``roundup-admin -i
+  <tracker_home> pragma list`` to see if pragmas are supported.
+
 Enable performance improvement for wsgi mode (optional)
 -------------------------------------------------------
 

Roundup Issue Tracker: http://roundup-tracker.org/