blob: 1136ced6193299324a92363747b529b0efe58ff2 [file] [log] [blame]
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08001= LocalUsernamesToLowerCase
Edwin Kempinb3b0d292011-09-14 14:17:34 +02002
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08003== NAME
Edwin Kempinb3b0d292011-09-14 14:17:34 +02004LocalUsernamesToLowerCase - Convert the local username of every
5account to lower case
6
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08007== SYNOPSIS
Michael Ochmanna8434612016-07-08 10:58:27 +02008[verse]
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -08009--
Michael Ochmanna8434612016-07-08 10:58:27 +020010_java_ -jar gerrit.war _LocalUsernamesToLowerCase
11 -d <SITE_PATH>
12 [--threads]
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -080013--
Edwin Kempinb3b0d292011-09-14 14:17:34 +020014
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080015== DESCRIPTION
Edwin Kempinb3b0d292011-09-14 14:17:34 +020016Converts the local username for every account to lower case. The
17local username is the username that is used to login into the Gerrit
David Pursehousea1d633b2014-05-02 17:21:02 +090018Web UI.
Edwin Kempinb3b0d292011-09-14 14:17:34 +020019
20This task is only intended to be run if the configuration parameter
21link:config-gerrit.html#ldap.localUsernameToLowerCase[ldap.localUsernameToLowerCase]
22was set to true to achieve case insensitive LDAP login to the Gerrit
David Pursehousea1d633b2014-05-02 17:21:02 +090023Web UI.
Edwin Kempinb3b0d292011-09-14 14:17:34 +020024
25Please be aware that the conversion of the local usernames to lower
26case can't be undone.
27
28The program will produce errors if there are accounts that have the
29same local username, but with different case. In this case the local
30username for these accounts is not converted to lower case.
31
32This task can run in the background concurrently to the server if the
33database is MySQL or PostgreSQL. If the database is H2, this task
34must be run by itself.
35
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080036== OPTIONS
Edwin Kempinb3b0d292011-09-14 14:17:34 +020037
38-d::
Yuxuan 'fishy' Wang77e15082013-12-09 15:43:25 -080039--site-path::
Edwin Kempinb3b0d292011-09-14 14:17:34 +020040 Location of the gerrit.config file, and all other per-site
41 configuration data, supporting libraries and log files.
42
Yuxuan 'fishy' Wang77e15082013-12-09 15:43:25 -080043--threads::
Edwin Kempinb3b0d292011-09-14 14:17:34 +020044 Number of threads to perform the scan work with. Defaults to
45 twice the number of CPUs available.
46
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080047== CONTEXT
Edwin Kempinb3b0d292011-09-14 14:17:34 +020048This command can only be run on a server which has direct
49connectivity to the metadata database.
50
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080051== EXAMPLES
Edwin Kempinb3b0d292011-09-14 14:17:34 +020052To convert the local username of every account to lower case:
53
Michael Ochmannb99feab2016-07-06 14:10:22 +020054----
Edwin Kempinb3b0d292011-09-14 14:17:34 +020055 $ java -jar gerrit.war LocalUsernamesToLowerCase -d site_path
Michael Ochmannb99feab2016-07-06 14:10:22 +020056----
Edwin Kempinb3b0d292011-09-14 14:17:34 +020057
Fredrik Luthandera6bb9512014-03-24 18:59:45 -070058== SEE ALSO
Edwin Kempinb3b0d292011-09-14 14:17:34 +020059
60* Configuration parameter link:config-gerrit.html#ldap.localUsernameToLowerCase[ldap.localUsernameToLowerCase]
61
62GERRIT
63------
64Part of link:index.html[Gerrit Code Review]
Yuxuan 'fishy' Wang99cb68d2013-10-31 17:26:00 -070065
66SEARCHBOX
67---------