Google Git
Sign in
gerrit / gerrit / 37f56cc4c9220af4f6084ec9d4c6ed5be3921cf8 / . / Documentation / pgm-LocalUsernamesToLowerCase.txt
blob: 4b5096189348efdec13ab778ceecc9762b85577a [file] [log] [blame]
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -0800[diff] [blame]1= LocalUsernamesToLowerCase
Edwin Kempinb3b0d292011-09-14 14:17:34 +0200[diff] [blame]2
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -0800[diff] [blame]3== NAME
Edwin Kempinb3b0d292011-09-14 14:17:34 +0200[diff] [blame]4LocalUsernamesToLowerCase - Convert the local username of every
5account to lower case
6
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -0800[diff] [blame]7== SYNOPSIS
Michael Ochmanna8434612016-07-08 10:58:27 +0200[diff] [blame]8[verse]
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -0800[diff] [blame]9--
Paladox nonea3689802017-09-07 14:03:03 +0000[diff] [blame]10_java_ -jar gerrit.war _LocalUsernamesToLowerCase_
Michael Ochmanna8434612016-07-08 10:58:27 +0200[diff] [blame]11 -d <SITE_PATH>
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -0800[diff] [blame]12--
Edwin Kempinb3b0d292011-09-14 14:17:34 +0200[diff] [blame]13
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -0800[diff] [blame]14== DESCRIPTION
Edwin Kempinb3b0d292011-09-14 14:17:34 +0200[diff] [blame]15Converts the local username for every account to lower case. The
16local username is the username that is used to login into the Gerrit
Edwin Kempine7ae45c2018-09-20 09:57:15 +0200[diff] [blame]17Web UI. The local username is stored a external ID with scheme
18`gerrit`.
19
20[IMPORTANT]
21This program does not modify usernames in the `username` scheme.
Edwin Kempinb3b0d292011-09-14 14:17:34 +0200[diff] [blame]22
23This task is only intended to be run if the configuration parameter
24link:config-gerrit.html#ldap.localUsernameToLowerCase[ldap.localUsernameToLowerCase]
25was set to true to achieve case insensitive LDAP login to the Gerrit
David Pursehousea1d633b2014-05-02 17:21:02 +0900[diff] [blame]26Web UI.
Edwin Kempinb3b0d292011-09-14 14:17:34 +0200[diff] [blame]27
28Please be aware that the conversion of the local usernames to lower
29case can't be undone.
30
31The program will produce errors if there are accounts that have the
32same local username, but with different case. In this case the local
33username for these accounts is not converted to lower case.
34
Edwin Kempin88031032017-07-04 11:46:19 +0200[diff] [blame]35After all usernames have been migrated, the link:pgm-reindex.html[
36reindex] program is automatically invoked to reindex all accounts.
37
38This task cannot run in the background concurrently to the server;
39it must be run by itself.
Edwin Kempinb3b0d292011-09-14 14:17:34 +0200[diff] [blame]40
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -0800[diff] [blame]41== OPTIONS
Edwin Kempinb3b0d292011-09-14 14:17:34 +0200[diff] [blame]42
43-d::
Yuxuan 'fishy' Wang77e15082013-12-09 15:43:25 -0800[diff] [blame]44--site-path::
Edwin Kempinb3b0d292011-09-14 14:17:34 +0200[diff] [blame]45 Location of the gerrit.config file, and all other per-site
46 configuration data, supporting libraries and log files.
47
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -0800[diff] [blame]48== CONTEXT
Edwin Kempinb3b0d292011-09-14 14:17:34 +0200[diff] [blame]49This command can only be run on a server which has direct
50connectivity to the metadata database.
51
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -0800[diff] [blame]52== EXAMPLES
Edwin Kempinb3b0d292011-09-14 14:17:34 +0200[diff] [blame]53To convert the local username of every account to lower case:
54
Michael Ochmannb99feab2016-07-06 14:10:22 +0200[diff] [blame]55----
Edwin Kempinb3b0d292011-09-14 14:17:34 +0200[diff] [blame]56 $ java -jar gerrit.war LocalUsernamesToLowerCase -d site_path
Michael Ochmannb99feab2016-07-06 14:10:22 +0200[diff] [blame]57----
Edwin Kempinb3b0d292011-09-14 14:17:34 +0200[diff] [blame]58
Fredrik Luthandera6bb9512014-03-24 18:59:45 -0700[diff] [blame]59== SEE ALSO
Edwin Kempinb3b0d292011-09-14 14:17:34 +0200[diff] [blame]60
61* Configuration parameter link:config-gerrit.html#ldap.localUsernameToLowerCase[ldap.localUsernameToLowerCase]
62
63GERRIT
64------
65Part of link:index.html[Gerrit Code Review]
Yuxuan 'fishy' Wang99cb68d2013-10-31 17:26:00 -0700[diff] [blame]66
67SEARCHBOX
68---------