gerrit/Documentation/pgm-LocalUsernamesToLowerCase.txt
David Pursehouse a1d633bb22 Doc: Consistently refer to "Web UI" rather than "WebUI"
Change-Id: Ia41e162394fa0f9ab9ae05c16db0c3032fde19cf
2014-05-02 17:21:22 +09:00

65 lines
1.7 KiB
Plaintext

= LocalUsernamesToLowerCase
== NAME
LocalUsernamesToLowerCase - Convert the local username of every
account to lower case
== SYNOPSIS
--
'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.
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.
This task can run in the background concurrently to the server if the
database is MySQL or PostgreSQL. If the database is H2, this task
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.
--threads::
Number of threads to perform the scan work with. Defaults to
twice the number of CPUs available.
== 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
---------