| Edwin Kempin | b3b0d29 | 2011-09-14 14:17:34 +0200 | [diff] [blame] | 1 | LocalUsernamesToLowerCase |
| 2 | ========================= |
| 3 | |
| 4 | NAME |
| 5 | ---- |
| 6 | LocalUsernamesToLowerCase - Convert the local username of every |
| 7 | account to lower case |
| 8 | |
| 9 | SYNOPSIS |
| 10 | -------- |
| 11 | [verse] |
| 12 | 'java' -jar gerrit.war 'LocalUsernamesToLowerCase' -d <SITE_PATH> |
| 13 | |
| 14 | DESCRIPTION |
| 15 | ----------- |
| 16 | Converts the local username for every account to lower case. The |
| 17 | local username is the username that is used to login into the Gerrit |
| 18 | WebUI. |
| 19 | |
| 20 | This task is only intended to be run if the configuration parameter |
| 21 | link:config-gerrit.html#ldap.localUsernameToLowerCase[ldap.localUsernameToLowerCase] |
| 22 | was set to true to achieve case insensitive LDAP login to the Gerrit |
| 23 | WebUI. |
| 24 | |
| 25 | Please be aware that the conversion of the local usernames to lower |
| 26 | case can't be undone. |
| 27 | |
| 28 | The program will produce errors if there are accounts that have the |
| 29 | same local username, but with different case. In this case the local |
| 30 | username for these accounts is not converted to lower case. |
| 31 | |
| 32 | This task can run in the background concurrently to the server if the |
| 33 | database is MySQL or PostgreSQL. If the database is H2, this task |
| 34 | must be run by itself. |
| 35 | |
| 36 | OPTIONS |
| 37 | ------- |
| 38 | |
| 39 | -d:: |
| 40 | \--site-path:: |
| 41 | Location of the gerrit.config file, and all other per-site |
| 42 | configuration data, supporting libraries and log files. |
| 43 | |
| 44 | \--threads:: |
| 45 | Number of threads to perform the scan work with. Defaults to |
| 46 | twice the number of CPUs available. |
| 47 | |
| 48 | CONTEXT |
| 49 | ------- |
| 50 | This command can only be run on a server which has direct |
| 51 | connectivity to the metadata database. |
| 52 | |
| 53 | EXAMPLES |
| 54 | -------- |
| 55 | To convert the local username of every account to lower case: |
| 56 | |
| 57 | ==== |
| 58 | $ java -jar gerrit.war LocalUsernamesToLowerCase -d site_path |
| 59 | ==== |
| 60 | |
| 61 | See Also |
| 62 | -------- |
| 63 | |
| 64 | * Configuration parameter link:config-gerrit.html#ldap.localUsernameToLowerCase[ldap.localUsernameToLowerCase] |
| 65 | |
| 66 | GERRIT |
| 67 | ------ |
| 68 | Part of link:index.html[Gerrit Code Review] |
