e7ae45c2b3
The local username is the username that is used to login into the Gerrit Web UI and is stored as external ID with the 'gerrit' scheme. Usernames for SSH are stored as external IDs with the 'username' scheme. Those are not touched by the LocalUsernamesToLowerCase program and Gerrit doesn't provide any tool convert them to lower case. Clarify this since in the past some users wrongly thought they could set `auth.userNameToLowerCase` to true when they run the LocalUsernamesToLowerCase program. This is not true since `auth.userNameToLowerCase` is about external IDs in scheme 'username' and LocalUsernamesToLowerCase is about external IDs in scheme 'gerrit'. Change-Id: I862f55101039db55e927fd8c6487447c69f67a9a Signed-off-by: Edwin Kempin <ekempin@google.com>
69 lines
1.8 KiB
Plaintext
69 lines
1.8 KiB
Plaintext
= LocalUsernamesToLowerCase
|
|
|
|
== NAME
|
|
LocalUsernamesToLowerCase - Convert the local username of every
|
|
account to lower case
|
|
|
|
== SYNOPSIS
|
|
[verse]
|
|
--
|
|
_java_ -jar gerrit.war _LocalUsernamesToLowerCase_
|
|
-d <SITE_PATH>
|
|
--
|
|
|
|
== DESCRIPTION
|
|
Converts the local username for every account to lower case. The
|
|
local username is the username that is used to login into the Gerrit
|
|
Web UI. The local username is stored a external ID with scheme
|
|
`gerrit`.
|
|
|
|
[IMPORTANT]
|
|
This program does not modify usernames in the `username` scheme.
|
|
|
|
This task is only intended to be run if the configuration parameter
|
|
link:config-gerrit.html#ldap.localUsernameToLowerCase[ldap.localUsernameToLowerCase]
|
|
was set to true to achieve case insensitive LDAP login to the Gerrit
|
|
Web UI.
|
|
|
|
Please be aware that the conversion of the local usernames to lower
|
|
case can't be undone.
|
|
|
|
The program will produce errors if there are accounts that have the
|
|
same local username, but with different case. In this case the local
|
|
username for these accounts is not converted to lower case.
|
|
|
|
After all usernames have been migrated, the link:pgm-reindex.html[
|
|
reindex] program is automatically invoked to reindex all accounts.
|
|
|
|
This task cannot run in the background concurrently to the server;
|
|
it must be run by itself.
|
|
|
|
== OPTIONS
|
|
|
|
-d::
|
|
--site-path::
|
|
Location of the gerrit.config file, and all other per-site
|
|
configuration data, supporting libraries and log files.
|
|
|
|
== CONTEXT
|
|
This command can only be run on a server which has direct
|
|
connectivity to the metadata database.
|
|
|
|
== EXAMPLES
|
|
To convert the local username of every account to lower case:
|
|
|
|
----
|
|
$ java -jar gerrit.war LocalUsernamesToLowerCase -d site_path
|
|
----
|
|
|
|
== SEE ALSO
|
|
|
|
* Configuration parameter link:config-gerrit.html#ldap.localUsernameToLowerCase[ldap.localUsernameToLowerCase]
|
|
|
|
GERRIT
|
|
------
|
|
Part of link:index.html[Gerrit Code Review]
|
|
|
|
SEARCHBOX
|
|
---------
|