Gerrit command line utility to set/update secure.config
When using a secure store for encrypting the secure.config
values, an utility or tool is needed to edit the values
using the same encryption key used by Gerrit at runtime.
Change-Id: Iacb017b010f7efd8217255796e571c5291499c0e
diff --git a/Documentation/pgm-index.txt b/Documentation/pgm-index.txt
index bf6dc57..0c347f4 100644
--- a/Documentation/pgm-index.txt
+++ b/Documentation/pgm-index.txt
@@ -33,6 +33,9 @@
version::
Display the release version of Gerrit Code Review.
+link:pgm-passwd.html[passwd]::
+ Set or reset password in secure.config.
+
=== Transition Utilities
link:pgm-LocalUsernamesToLowerCase.html[LocalUsernamesToLowerCase]::
diff --git a/Documentation/pgm-passwd.txt b/Documentation/pgm-passwd.txt
new file mode 100644
index 0000000..133fb03
--- /dev/null
+++ b/Documentation/pgm-passwd.txt
@@ -0,0 +1,49 @@
+= passwd
+
+== NAME
+passwd - Set or reset password in secure.config.
+
+== SYNOPSIS
+[verse]
+--
+_java_ -jar gerrit.war _passwd_
+ -d <SITE_PATH>
+ <SECTION.KEY>
+ [PASSWORD]
+
+--
+
+== DESCRIPTION
+Set or reset password in an existing Gerrit server installation,
+interactively prompting for a new password or using the one
+provided in the command line argument.
+
+== OPTIONS
+
+-d::
+--site-path::
+ Location of the `gerrit.config` file, and all other per-site
+ configuration data, supporting libraries and log files.
+
+== ARGUMENTS
+
+SECTION.KEY::
+ Section and key in the `secure.config` file for setting or editing the
+ password value.
+
+PASSWORD::
+ New password to set in `secure.config` associated to the section and key.
+ When specified as argument, automatically implies batch mode and the command
+ would not ask anything interactively.
+
+== CONTEXT
+
+This utility is typically useful when a secure store is configured
+to encrypt password values and thus editing the file manually is not an option.
+
+GERRIT
+------
+Part of link:index.html[Gerrit Code Review]
+
+SEARCHBOX
+---------
