blob: f2952258f91e85ee22ae68e9a14292448400bb55 [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>
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -080012--
Edwin Kempinb3b0d292011-09-14 14:17:34 +020013
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080014== DESCRIPTION
Edwin Kempinb3b0d292011-09-14 14:17:34 +020015Converts the local username for every account to lower case. The
16local username is the username that is used to login into the Gerrit
David Pursehousea1d633b2014-05-02 17:21:02 +090017Web UI.
Edwin Kempinb3b0d292011-09-14 14:17:34 +020018
19This task is only intended to be run if the configuration parameter
20link:config-gerrit.html#ldap.localUsernameToLowerCase[ldap.localUsernameToLowerCase]
21was set to true to achieve case insensitive LDAP login to the Gerrit
David Pursehousea1d633b2014-05-02 17:21:02 +090022Web UI.
Edwin Kempinb3b0d292011-09-14 14:17:34 +020023
24Please be aware that the conversion of the local usernames to lower
25case can't be undone.
26
27The program will produce errors if there are accounts that have the
28same local username, but with different case. In this case the local
29username for these accounts is not converted to lower case.
30
31This task can run in the background concurrently to the server if the
32database is MySQL or PostgreSQL. If the database is H2, this task
33must be run by itself.
34
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080035== OPTIONS
Edwin Kempinb3b0d292011-09-14 14:17:34 +020036
37-d::
Yuxuan 'fishy' Wang77e15082013-12-09 15:43:25 -080038--site-path::
Edwin Kempinb3b0d292011-09-14 14:17:34 +020039 Location of the gerrit.config file, and all other per-site
40 configuration data, supporting libraries and log files.
41
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080042== CONTEXT
Edwin Kempinb3b0d292011-09-14 14:17:34 +020043This command can only be run on a server which has direct
44connectivity to the metadata database.
45
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080046== EXAMPLES
Edwin Kempinb3b0d292011-09-14 14:17:34 +020047To convert the local username of every account to lower case:
48
Michael Ochmannb99feab2016-07-06 14:10:22 +020049----
Edwin Kempinb3b0d292011-09-14 14:17:34 +020050 $ java -jar gerrit.war LocalUsernamesToLowerCase -d site_path
Michael Ochmannb99feab2016-07-06 14:10:22 +020051----
Edwin Kempinb3b0d292011-09-14 14:17:34 +020052
Fredrik Luthandera6bb9512014-03-24 18:59:45 -070053== SEE ALSO
Edwin Kempinb3b0d292011-09-14 14:17:34 +020054
55* Configuration parameter link:config-gerrit.html#ldap.localUsernameToLowerCase[ldap.localUsernameToLowerCase]
56
57GERRIT
58------
59Part of link:index.html[Gerrit Code Review]
Yuxuan 'fishy' Wang99cb68d2013-10-31 17:26:00 -070060
61SEARCHBOX
62---------