Gerrit Code Review - Configuration

Type of user authentication employed by Gerrit. The supported values are:

By default, OpenID.

List of permitted OpenID providers. A user may only authenticate with an OpenID that matches this list. Only used if auth.type was set to OpenID (the default).

Patterns may be either a standard Java regular expression (java.util.regex) (start with ^ and end with $) or be a simple prefix (any other string).

By default, the list contains two values, http:// and https://, allowing users to authenticate with any OpenID provider.

List of trusted OpenID providers. Only used if auth.type was set to OpenID (the default).

In order for a user to take advantage of permissions beyond those granted to the Anonymous Users and Registered Users groups, the user account must only have OpenIDs which match at least one pattern from this list.

Patterns may be either a standard Java regular expression (java.util.regex) (start with ^ and end with $) or be a simple prefix (any other string).

By default, the list contains two values, http:// and https://, allowing Gerrit to trust any OpenID it receives.

Time in seconds before an OpenID provider must force the user to authenticate themselves again before authentication to this Gerrit server. Currently this is only a polite request, and users coming from providers that don’t support the PAPE extension will be accepted anyway. In the future it may be enforced, rejecting users coming from providers that don’t honor the max session age.

If set to 0, the provider will always force the user to authenticate (e.g. supply their password). Values should use common unit suffixes to express their setting:

Default is -1, permitting infinite time between authentications.

HTTP header to trust the username from, or unset to select HTTP basic or digest authentication. Only used if auth.type was set to HTTP.

URL to redirect a browser to after the end-user has clicked on the "Sign Out" link in the upper right corner. Organizations using an enterprise single-sign-on solution may want to redirect the browser to the SSO product’s sign-out page.

If not set, the redirect returns to the list of all open changes.

Target for the "Register" link in the upper right corner. Used only when auth.type is LDAP.

If not set, no "Register" link is displayed.

Sets "path" attribute of the authentication cookie.

If not set, HTTP request’s path is used.

Sets "secure" flag of the authentication cookie. If true, cookies will be transmitted only over HTTPS protocol.

By default, false.

Optional format string to construct user email addresses out of user login names. Only used if auth.type is HTTP, HTTP_LDAP or LDAP.

This value can be set to a format string, where \{0\} is replaced with the login name. E.g. "{0}+gerrit@example.com" with a user login name of "foo" will produce "foo+gerrit@example.com" during the first time user "foo" registers.

If the site is using HTTP_LDAP or LDAP, using this option is discouraged. Setting ldap.accountEmailAddress and importing the email address from the LDAP directory is generally preferred.

Controls whether or not the contributor agreement features are enabled for the Gerrit site. If enabled a user must complete a contributor agreement before they can upload changes.

If enabled, the admin must also insert one or more rows into contributor_agreements and create agreement files under '$site_path'/static, so users can actually complete one or more agreements.

By default this is false (no agreements are used).

Allows Google Account users to automatically update their Gerrit account when/if their Google Account OpenID identity token changes. Identity tokens can change if the server changes hostnames, or for other reasons known only to Google. The upgrade path works by matching users by email address if the identity is not present, and then changing the identity.

This setting also permits old Gerrit 1.x users to seamlessly upgrade from Google Accounts on Google App Engine to OpenID authentication.

Having this enabled incurs an extra database query when Google Account users register with the Gerrit server.

By default, unset/false.

Path to a local directory where Gerrit can write cached entities for future lookup. This local disk cache is used to retain potentially expensive to compute information across restarts. If the location does not exist, Gerrit will try to create it.

If not absolute, the path is resolved relative to $site_path.

Default is unset, no disk cache.

Maximum age to keep an entry in the cache. If an entry has not been accessed in this period of time, it is removed from the cache. Values should use common unit suffixes to express their setting:

If a unit suffix is not specified, minutes is assumed. If 0 is supplied, the maximum age is infinite and items are never purged except when the cache is full.

Default is 90 days for most caches, except:

Maximum number of cache items to retain in memory. Keep in mind this is total number of items, not bytes of heap used.

Default is 1024 for most caches, except:

Maximum number of cache items to retain on disk, if this cache supports storing its items to disk. Like memoryLimit, this is total number of items, not bytes of disk used. If 0, disk storage for this cache is disabled.

Default is 16384.

Number of bytes to buffer in memory before writing less frequently accessed cache items to disk, if this cache supports storing its items to disk.

Default is 5 MiB.

Common unit suffixes of k, m, or g are supported.

Cache entries contain important details of an active user, including their display name, preferences, known email addresses, and group memberships. Entry information is obtained from the following database tables:

If direct updates are made to any of these database tables, this cache should be flushed.

Caches account identities keyed by email address, which is scanned from the account_external_ids database table. If updates are made to this table, this cache should be flushed.

Used only for push over smart HTTP when branch level access controls are enabled. The cache entry contains all commits that are avaliable for the client to use as potential delta bases. Push over smart HTTP requires two HTTP requests, and this cache tries to carry state from the first request into the second to ensure it can complete.

Each item caches the differences between two commits, at both the directory and file levels. Gerrit uses this cache to accelerate the display of affected file names, as well as file contents.

Entries in this cache are relatively large, so the memory limit should not be set incredibly high. Administrators should try to target cache.diff.memoryLimit to be roughly the number of changes which their users will process in a 1 or 2 day span.

Keeping entries for 90 days gives sufficient time for most changes to be submitted or abandoned before their relevant difference items expire out.

Each item caches the intraline difference of one file, when compared between two commits. Gerrit uses this cache to accelerate display of intraline differences when viewing a file.

Entries in this cache are relatively large, so the memory limit should not be set incredibly high. Administrators should try to target cache.diff.memoryLimit to be roughly the number of changes which their users will process in a 1 or 2 day span.

Keeping entries for 90 days gives sufficient time for most changes to be submitted or abandoned before their relevant difference items expire out.

Caches the basic group information from the account_groups table, including the group owner, name, and description.

Gerrit group membership obtained from the account_group_members table is cached under the "accounts" cache, above. External group membership obtained from LDAP is cached under "ldap_groups".

Caches group inclusions in other groups. If direct updates are made to the account_group_includes table, this cache should be flushed.

Caches the LDAP groups that a user belongs to, if LDAP has been configured on this server. This cache should be configured with a low maxAge setting, to ensure LDAP modifications are picked up in a timely fashion.

Caches a mapping of LDAP username to Gerrit account identity. The cache automatically updates when a user first creates their account within Gerrit, so the cache expire time is largely irrelevant.

Caches the project description records, from the projects table in the database. If a project record is updated or deleted, this cache should be flushed. Newly inserted projects do not require a cache flush, as they will be read upon first reference.

Caches unpacked versions of user SSH keys, so the internal SSH daemon can match against them during authentication. The unit of storage is per-user, so 1024 items translates to 1024 unique user accounts. As each individual user account may configure multiple SSH keys, the total number of keys may be larger than the item count.

This cache is based off the account_ssh_keys table and the accounts.ssh_user_name column in the database. If either is modified directly, this cache should be flushed.

Tracks the live user sessions coming in over HTTP. Flushing this cache would cause all users to be signed out immediately, forcing them to sign-in again. To avoid breaking active users, this cache is not flushed automatically by gerrit flush-caches --all, but instead must be explicitly requested.

If no disk cache is configured (or cache.web_sessions.diskLimit is set to 0) a server restart will force all users to sign-out, and need to sign-in again after the restart, as the cache was unable to persist the session information. Enabling a disk cache is strongly recommended.

Session storage is relatively inexpensive, the average entry in this cache is approximately 248 bytes, depending on the JVM.

Number of idle worker threads to maintain for the intraline difference computations. There is no upper bound on how many concurrent requests can occur at once, if additional threads are started to handle a peak load, only this many will remaining idle afterwards.

Default is 1.5x number of available CPUs.

Maximum number of milliseconds to wait for intraline difference data before giving up and disabling it for a particular file pair. This is a work around for an infinite loop bug in the intraline difference implementation. If computation takes longer than the timeout the worker thread is terminated and no intraline difference is displayed.

Values should use common unit suffixes to express their setting:

If a unit suffix is not specified, milliseconds is assumed.

Default is 5 seconds.

Boolean to enable or disable the computation of intraline differences when populating a diff cache entry. This flag is provided primarily as a backdoor to disable the intraline difference feature if necessary. To maintain backwards compatability with prior versions, this setting will fallback to cache.diff.intraline if not set in the configuration.

Default is true, enabled.

A JavaScript regular expression to match positions to be replaced with a hyperlink. Subexpressions of the matched string can be stored using groups and accessed with $'n' syntax, where n is the group number, starting from 1.

The configuration file parser eats one level of backslashes, so the character class \s requires \\s in the configuration file. The parser also terminates the line at the first #, so a match expression containing # must be wrapped in double quotes.

To match case insensitive strings, a character class with both the upper and lower case character for each position must be used. For example, to match the string bug in a case insensitive way the match pattern [bB][uU][gG] needs to be used.

A common pattern to match is bug\\s+(\\d+).

The URL to direct the user to whenever the regular expression is matched. Groups in the match expression may be accessed as $'n'.

The link property is used only when the html property is not present.

HTML to replace the entire matched string with. If present, this property overrides the link property above. Groups in the match expression may be accessed as $'n'.

The configuration file eats double quotes, so escaping them as \" is necessary to protect them from the parser.

URL of the web based contact store Gerrit will send any offline contact information to when it collects the data from users as part of a contributor agreement.

See Contact Information.

Shared secret of the web based contact store.

Maximum heap size of the Java process running Gerrit, in bytes. This property is translated into the -Xmx flag for the JVM.

Default is platform and JVM specific.

Common unit suffixes of k, m, or g are supported.

Path of the JRE/JDK installation to run Gerrit with. If not set, the Gerrit startup script will attempt to search your system and guess a suitable JRE. Overrides the environment variable JAVA_HOME.

Additional options to pass along to the Java runtime. If multiple values are configured, they are passed in order on the command line, separated by spaces. These options are appended onto JAVA_OPTIONS.

Used on Gerrit slave installations. If set to true the Gerrit JVM is called with the --slave switch, enabling slave mode. If no value is set (or any other value), gerrit defaults to master mode.

Login name (or UID) of the operating system user the Gerrit JVM will execute as. If not set, defaults to the user who launched the gerrit.sh wrapper script.

Path of the JAR file to start daemon execution with. This should be the path of the local gerrit.war archive. Overrides the environment variable GERRIT_WAR.

If not set, defaults to $site_path/bin/gerrit.war, or to $HOME/gerrit.war.

Number of bytes of a pack file to load into memory in a single read operation. This is the "page size" of the JGit buffer cache, used for all pack access operations. All disk IO occurs as single window reads. Setting this too large may cause the process to load more data than is required; setting this too small may increase the frequency of read() system calls.

Default on JGit is 8 KiB on all platforms.

Common unit suffixes of k, m, or g are supported.

Maximum number of bytes to load and cache in memory from pack files. If JGit needs to access more than this many bytes it will unload less frequently used windows to reclaim memory space within the process. As this buffer must be shared with the rest of the JVM heap, it should be a fraction of the total memory available.

Default on JGit is 10 MiB on all platforms.

Common unit suffixes of k, m, or g are supported.

Maximum number of bytes to reserve for caching base objects that multiple deltafied objects reference. By storing the entire decompressed base object in a cache Git is able to avoid unpacking and decompressing frequently used base objects multiple times.

Default on JGit is 10 MiB on all platforms. You probably do not need to adjust this value.

Common unit suffixes of k, m, or g are supported.

Maximum number of pack files to have open at once. A pack file must be opened in order for any of its data to be available in a cached window.

If you increase this to a larger setting you may need to also adjust the ulimit on file descriptors for the host JVM, as Gerrit needs additional file descriptors available for network sockets and other repository data manipulation.

Default on JGit is 128 file descriptors on all platforms.

Largest object size, in bytes, that JGit will allocate as a contiguous byte array. Any file revision larger than this threshold will have to be streamed, typically requiring the use of temporary files under $GIT_DIR/objects to implement psuedo-random access during delta decompression.

Servers with very high traffic should set this to be larger than the size of their common big files. For example a server managing the Android platform typically has to deal with ~10-12 MiB XML files, so 15 m would be a reasonable setting in that environment. Setting this too high may cause the JVM to run out of heap space when handling very big binary files, such as device firmware or CD-ROM ISO images.

Default is 50 MiB on all platforms. Prior to Gerrit 2.1.6, this value was effectively 2047 MiB.

Common unit suffixes of k, m, or g are supported.

When true, JGit will use mmap() rather than malloc()+read() to load data from pack files. The use of mmap can be problematic on some JVMs as the garbage collector must deduce that a memory mapped segment is no longer in use before a call to munmap() can be made by the JVM native code.

In server applications (such as Gerrit) that need to access many pack files, setting this to true risks artifically running out of virtual address space, as the garbage collector cannot reclaim unused mapped spaces fast enough.

Default on JGit is false. Although potentially slower, it yields much more predictable behavior.

Type of database server to connect to. If set this value will be used to automatically create correct database.driver and database.url values to open the connection.

If not specified, database.driver and database.url are used as-is, and if they are also not specified, defaults to H2.

Hostname of the database server. Defaults to localhost.

Port number of the database server. Defaults to the default port of the server named by database.type.

For POSTGRESQL or MYSQL, the name of the database on the server.

For H2, this is the path to the database, and if not absolute is relative to '$site_path'.

Username to connect to the database server as.

Password to authenticate to the database server with.

Name of the JDBC driver class to connect to the database with. Setting this usually isn’t necessary as it can be derived from database.type or database.url for any supported database.

jdbc: URL for the database. Setting this variable usually isn’t necessary as it can be constructed from the all of the above properties.

Maximum number of open database connections. If the server needs more than this number, request processing threads will wait up to poolMaxWait seconds for a connection to be released before they abort with an exception. This limit must be several units higher than the total number of httpd and sshd threads as some request processing code paths may need multiple connections.

Default is 8.

Minimum number of connections to keep idle in the pool. Default is 4.

Maximum number of connections to keep idle in the pool. If there are more idle connections, connections will be closed instead of being returned back to the pool. Default is 4.

Maximum amount of time a request processing thread will wait to acquire a database connection from the pool. If no connection is released within this time period, the processing thread will abort its current operations and return an error to the client. Values should use common unit suffixes to express their setting:

If a unit suffix is not specified, milliseconds is assumed.

Default is 30 seconds.

Schemes that should be used to download changes.

Multiple schemes are supported:

If download.scheme is not specified, SSH, HTTP and Anonymous HTTP downloads are allowed.

Local filesystem directory holding all Git repositories that Gerrit knows about and can process changes for. A project entity in Gerrit maps to a local Git repository by creating the path string "$\{basePath}/$\{project_name}.git".

If relative, the path is resolved relative to '$site_path'.

The default URL for Gerrit to be accessed through.

Typically this would be set to "http://review.example.com/" or "http://example.com/gerrit/" so Gerrit can output links that point back to itself.

Setting this is highly recommended, as its necessary for the upload code invoked by "git push" or "repo upload" to output hyperlinks to the newly uploaded changes.

Optional base URL for repositories available over the anonymous git protocol. For example, set this to git://mirror.example.com/base/ to have Gerrit display patch set download URLs in the UI. Gerrit automatically appends the project name onto the end of the URL.

By default unset, as the git daemon must be configured externally by the system administrator, and might not even be running on the same host as Gerrit.

If true, replicates to all remotes on startup to ensure they are in-sync with this server. By default, true.

Path to the locally installed gitweb.cgi executable. This CGI will be called by Gerrit Code Review when the URL /gitweb is accessed. Project level access controls are enforced prior to calling the CGI.

Defaults to /usr/lib/cgi-bin/gitweb.cgi if gitweb.url is not set.

Optional URL of an affiliated gitweb service. Defines the web location where a gitweb.cgi is installed to browse gerrit.basePath and the repositories it contains.

Gerrit appends any necessary query arguments onto the end of this URL. For example, "?p=$project.git;h=$commit".

Optional type of affiliated gitweb service. This allows using alternatives to gitweb, such as cgit.

Valid values are gitweb, cgit or custom.

Optional pattern to use for constructing the gitweb URL when pointing at a specific commit when custom is used above.

Valid replacements are $\{project\} for the project name in Gerrit and $\{commit\} for the SHA1 hash for the commit.

Optional pattern to use for constructing the gitweb URL when pointing at a specific project when custom is used above.

Valid replacements are $\{project\} for the project name in Gerrit.

Optional pattern to use for constructing the gitweb URL when pointing at a specific branch when custom is used above.

Valid replacements are $\{project\} for the project name in Gerrit and $\{branch\} for the name of the branch.

Optional path to hooks, if not specified then '$site_path'/hooks will be used.

Optional filename for the patchset created hook, if not specified then patchset-created will be used.

Optional filename for the comment added hook, if not specified then comment-added will be used.

Optional filename for the change merged hook, if not specified then change-merged will be used.

Optional filename for the change abandoned hook, if not specified then change-abandoned will be used.

URL of the proxy server when making outgoing HTTP connections for OpenID login transactions. Syntax should be http://hostname:port.

Optional username to authenticate to the HTTP proxy with. This property is honored only if the username does not appear in the http.proxy property above.

Optional password to authenticate to the HTTP proxy with. This property is honored only if the password does not appear in the http.proxy property above.

Specifies the URLs the internal HTTP daemon should listen for connections on. The special hostname \* may be used to listen on all local addresses. A context path may optionally be included, placing Gerrit Code Review’s web address within a subdirectory of the server.

Multiple protocol schemes are supported:

If multiple values are supplied, the daemon will listen on all of them.

By default, http://*:8080.

If true, permits the daemon to bind to the port even if the port is already in use. If false, the daemon ensures the port is not in use before starting. Busy sites may need to set this to true to permit fast restarts.

By default, true.

Size, in bytes, of the buffer used to parse the HTTP headers of an incoming HTTP request. The entire request headers, including any cookies sent by the browser, must fit within this buffer, otherwise the server aborts with the response 413 Request Entity Too Large.

One buffer of this size is allocated per active connection. Allocating a buffer that is too large wastes memory that cannot be reclaimed, allocating a buffer that is too small may cause unexpected errors caused by very long Referer URLs or large cookie values.

By default, 16384 (16 K), which is sufficient for most OpenID and other web-based single-sign-on integrations.

Path of the Java keystore containing the server’s SSL certificate and private key. This keystore is required for https:// in URL.

To create a self-signed certificate for simple internal usage:

If not absolute, the path is resolved relative to $site_path.

By default, $site_path/etc/keystore.

Password used to decrypt the private portion of the sslKeyStore. Java key stores require a password, even if the administrator doesn’t want to enable one.

If set to the empty string the embedded server will prompt for the password during startup.

By default, gerrit.

Enable (or disable) the '$site_path'/logs/httpd_log request log. If enabled, an NCSA combined log format request log file is written out by the internal HTTP daemon.

By default, true if httpd.listenUrl uses http:// or https://, and false if httpd.listenUrl uses proxy-http:// or proxy-https://.

Number of worker threads dedicated to accepting new incoming TCP connections and allocate them connection-specific resources.

By default, 2, which should be suitable for most high-traffic sites.

Minimum number of spare threads to keep in the worker thread pool. This number must be at least 1 larger than httpd.acceptorThreads multipled by the number of httpd.listenUrls configured.

By default, 5, suitable for most lower-volume traffic sites.

Maximum number of threads to permit in the worker thread pool.

By default 25, suitable for most lower-volume traffic sites.

Maximum number of client connections which can enter the worker thread pool waiting for a worker thread to become available. 0 disables the queue and permits infinite number of connections.

By default 50.

Maximum amount of time a client will wait to for an available thread to handle a project clone, fetch or push request over the smart HTTP transport.

Values should use common unit suffixes to express their setting:

If a unit suffix is not specified, minutes is assumed. If 0 is supplied, the maximum age is infinite and connections will not abort until the client disconnects.

By default, 5 minutes.

URL of the organization’s LDAP server to query for user information and group membership from. Must be of the form ldap://host or ldaps://host to bind with either a plaintext or SSL connection.

If auth.type is LDAP this setting should use ldaps:// to ensure the end user’s plaintext password is transmitted only over an encrypted connection.

If false and ldap.server is an ldaps:// style URL, Gerrit will not verify the server certificate when it connects to perform a query.

By default, true, requiring the certificate to be verified.

(Optional) Username to bind to the LDAP server with. If not set, an anonymous connection to the LDAP server is attempted.

(Optional) Password for the user identified by ldap.username. If not set, an anonymous (or passwordless) connection to the LDAP server is attempted.

(Optional) How an LDAP referral should be handled if it is encountered during directory traversal. Set to follow to automatically follow any referrals, or ignore to stop and fail with javax.naming.PartialResultException: Unprocessed Continuation Reference(s)

By default, ignore.

Root of the tree containing all user accounts. This is typically of the form ou=people,dc=example,dc=com.

Scope of the search performed for accounts. Must be one of:

Default is subtree as many directories have several levels.

Query pattern to use when searching for a user account. This may be any valid LDAP query expression, including the standard (&...) and (|...) operators. If auth.type is HTTP_LDAP then the variable $\{username\} is replaced with a parameter set to the username that was supplied by the HTTP server. If auth.type is LDAP then the variable $\{username\} is replaced by the string entered by the end user.

This pattern is used to search the objects contained directly under the ldap.accountBase tree. A typical setting for this parameter is (uid=$\{username\}) or (cn=$\{username\}), but the proper setting depends on the LDAP schema used by the directory server.

Default is (uid=$\{username\}) for RFC 2307 servers, and (&(objectClass=user)(sAMAccountName=${username})) for Active Directory.

(Optional) Name of an attribute on the user account object which contains the initial value for the user’s full name field in Gerrit. Typically this is the displayName property in LDAP, but could also be legalName or cn.

Attribute values may be concatenated with literal strings, for example to join given name and surname together use the pattern $\{givenName\} $\{SN\}.

If set, users will be unable to modify their full name field, as Gerrit will populate it only from the LDAP data.

Default is displayName for RFC 2307 servers, and ${givenName} ${sn} for Active Directory.

(Optional) Name of an attribute on the user account object which contains the user’s Internet email address, as defined by this LDAP server.

Attribute values may be concatenated with literal strings, for example to set the email address to the lowercase form of sAMAccountName followed by a constant domain name, use $\{sAMAccountName.toLowerCase\}@example.com.

If set, the preferred email address will be prefilled from LDAP, but users may still be able to register additional email address, and select a different preferred email address.

Default is mail.

(Optional) Name of an attribute on the user account object which contains the initial value for the user’s SSH username field in Gerrit. Typically this is the uid property in LDAP, but could also be cn. Administrators should prefer to match the attribute corresponding to the user’s workstation username, as this is what SSH clients will default to.

Attribute values may also be forced to lowercase, or to uppercase in an expression. For example, $\{sAMAccountName.toLowerCase\} will force the value of sAMAccountName, if defined, to be all lowercase. The suffix .toUpperCase can be used for the other direction. The suffix .localPart can be used to split attribute values of the form user@example.com and return only the left hand side, for example $\{userPrincipalName.localPart\} would provide only user.

If set, users will be unable to modify their SSH username field, as Gerrit will populate it only from the LDAP data.

Default is uid for RFC 2307 servers, and ${sAMAccountName.toLowerCase} for Active Directory.

(Optional) Name of an attribute on the user account object which contains the groups the user is part of. Typically used for Active Directory servers.

Default is unset for RFC 2307 servers (disabled) and memberOf for Active Directory.

Root of the tree containing all group objects. This is typically of the form ou=groups,dc=example,dc=com.

Scope of the search performed for group objects. Must be one of:

Default is subtree as many directories have several levels.

Query pattern used when searching for an LDAP group to connect to a Gerrit group. This may be any valid LDAP query expression, including the standard (&...) and (|...) operators. The variable $\{groupname\} is replaced with the search term supplied by the group owner.

Default is (cn=$\{groupname\}) for RFC 2307, and (&(objectClass=group)(cn=$\{groupname\})) for Active Directory.

Query pattern to use when searching for the groups that a user account is currently a member of. This may be any valid LDAP query expression, including the standard (&...) and (|...) operators.

If auth.type is HTTP_LDAP then the variable $\{username\} is replaced with a parameter set to the username that was supplied by the HTTP server. Other variables appearing in the pattern, such as $\{fooBarAttribute\}, are replaced with the value of the corresponding attribute (in this case, fooBarAttribute) as read from the user’s account object matched under ldap.accountBase. Attributes such as $\{dn\} or $\{uidNumber\} may be useful.

Default is (memberUid=$\{username\}) for RFC 2307, and unset (disabled) for Active Directory.

If set to true, files with the MIME type <name> will be sent as direct downloads to the user’s browser, rather than being wrapped up inside of zipped archives. The type name may be a complete type name, e.g. image/gif, a generic media type, e.g. image/\*, or the wildcard \*/* to match all types.

By default, false for all MIME types.

If true, delta compression between objects is enabled. This may result in a smaller overall transfer for the client, but requires more server memory and CPU time.

False (off) by default, matching Gerrit Code Review 2.1.4.

Maximum number of threads to use for delta compression (if enabled). This is per-client request. If set to 0 then the number of CPUs is auto-detected and one thread per CPU is used, per client request.

By default, 1.

Name of the groups of users that are allowed to execute receive-pack on the server. One or more groups can be set.

If no groups are added, any user will be allowed to execute receive-pack on the server.

A name of a group which exists in the database. Zero, one or many groups are allowed. Each on its own line. Groups which don’t exist in the database are ignored.

If no groups are declared (or only non-existing ones), the default value Administrators is used.

A name of a group which exists in the database. Zero, one or many groups are allowed. Each on its own line. Groups which don’t exist in the database are ignored.

If no groups are declared (or only non-existing ones), it defaults to whatever is declared by repository.<name>.createGroup (including any fallback to Administrators.)

If false Gerrit will not send email messages, for any reason, and all other properties of section sendemail are ignored.

By default, true, allowing notifications to be sent.

Designates what name and address Gerrit will place in the From field of any generated email messages. The supported values are:

By default, MIXED.

Hostname (or IP address) of a SMTP server that will relay messages generated by Gerrit to end users.

By default, 127.0.0.1 (aka localhost).

Port number of the SMTP server in sendemail.smtpserver.

By default, 25, or 465 if smtpEncryption is ssl.

Specify the encryption to use, either ssl or tls.

By default, none, indicating no encryption is used.

If false and sendemail.smtpEncryption is ssl or tls, Gerrit will not verify the server certificate when it connects to send an email message.

By default, true, requiring the certificate to be verified.

User name to authenticate with, if required for relay.

Password for the account named by sendemail.smtpUser.

If present, each value adds one entry to the whitelist of email addresses that Gerrit can send email to. If set to a complete email address, that one address is added to the white list. If set to a domain name, any address at that domain can receive email from Gerrit.

By default, unset, permitting delivery to any email address.

If present, emails sent from Gerrit will have the given level of importance. Valid values include high and low, which email clients will render in different ways.

By default, unset, so no Importance header is generated.

If present, emails sent from Gerrit will expire after the given number of days. This will add the Expiry-Date header and email clients may expire or expunge mails whose Expiry-Date header is in the past. This should be a positive non-zero number indicating how many days in the future the mails should expire.

By default, unset, so no Expiry-Date header is generated.

Specifies the local addresses the internal SSHD should listen for connections on. The following forms may be used to specify an address. In any form, :'port' may be omitted to use the default of 29418.

If multiple values are supplied, the daemon will listen on all of them.

By default, *:29418.

If true, permits the daemon to bind to the port even if the port is already in use. If false, the daemon ensures the port is not in use before starting. Busy sites may need to set this to true to permit fast restarts.

By default, true.

If true, enables TCP keepalive messages to the other side, so the daemon can terminate connections if the peer disappears.

By default, true.

Number of threads to use when executing SSH command requests. If additional requests are received while all threads are busy they are queued and serviced in a first-come-first-serve order.

By default, 1.5x the number of CPUs available to the JVM.

Number of threads to allocate for SSH command requests from non-interactive users. If equals to 0, then all non-interactive requests are executed in the same queue as interactive requests.

Any other value will remove the number of threads from the queue allocated to interactive users, and create a separate thread pool of the requested size, which will be used to run commands from non-interactive users.

If the number of threads requested for non-interactive users is larger than the total number of threads allocated in sshd.threads, then the value of sshd.threads is increased to accomodate the requested value.

By default, 0.

Number of threads to use when formatting events to asynchronous streaming clients. Event formatting is multiplexed onto this thread pool by a simple FIFO scheduling system.

By default, 1 plus the number of CPUs available to the JVM.

Number of threads used to parse a command line submitted by a client over SSH for execution, create the internal data structures used by that command, and schedule it for execution on another thread.

By default, 2.

Maximum number of authentication attempts before the server disconnects the client. Each public key that a client has loaded into its local agent counts as one auth request. Users can work around the server’s limit by loading less keys into their agent, or selecting a specific key in their ~/.ssh/config file with the IdentityFile option.

By default, 6.

Time in seconds that a client has to authenticate before the server automatically terminates their connection. Values should use common unit suffixes to express their setting:

By default, 2 minutes.

Maximum number of concurrent SSH sessions that a user account may open at one time. This is the number of distinct SSH logins the each user may have active at one time, and is not related to the number of commands a user may issue over a single connection. If set to 0, there is no limit.

By default, 64.

Available ciphers. To permit multiple ciphers, specify multiple sshd.cipher keys in the configuration file, one cipher name per key. Cipher names starting with + are enabled in addition to the default ciphers, cipher names starting with - are removed from the default cipher set.

Supported ciphers: aes128-cbc, aes128-cbc, aes256-cbc, blowfish-cbc, 3des-cbc, none.

By default, all supported ciphers except none are available.

Available MAC (message authentication code) algorithms. To permit multiple algorithms, specify multiple sshd.mac keys in the configuration file, one MAC per key. MAC names starting with + are enabled in addition to the default MACs, MAC names starting with - are removed from the default MACs.

Supported MACs: hmac-md5, hmac-md5-96, hmac-sha1, hmac-sha1-96.

By default, all supported MACs are available.

If ALL, all matching user accounts will be offered as completion suggestions when adding a reviewer to a change, or a user to a group.

If SAME_GROUP, only users who are also members of a group the current user is a member of will be offered.

If VISIBLE_GROUP, only users who are members of at least one group that is visible to the current user will be offered.

If OFF, no account suggestions are given.

Default is ALL.

Background color for the page, and major data tables like the all open changes table or the account dashboard. The value must be a valid HTML hex color code, or standard color name.

By default FCFEEF (a creme color) for signed-out theme and white (FFFFFF) for signed-in theme.

This is the color of the main menu bar at the top of the page. The value must be a valid HTML hex color code, or standard color name. The value defaults to trimColor.

Text color for the page, and major data tables like the all open changes table or the account dashboard. The value must be a valid HTML hex color code, or standard color name.

By default black, 000000.

Primary color used as a background color behind text. This is the color of the main menu bar at the top, of table headers, and of major UI areas that we want to offset from other portions of the page. The value must be a valid HTML hex color code, or standard color name.

By default a shade of green, D4E9A9.

Background color used within a trimColor area to denote the currently selected tab, or the background color used in a table to denote the currently selected row. The value must be a valid HTML hex color code, or standard color name.

By default a shade of yellow, FFFFCC.

A prefix tag that identify the footer line to parse for tracking ids. Several trakingid entries can have the same footer tag. (the trailing ":" is optional)

A standard Java regular expression (java.util.regex) used to match the external tracking id part of the footer line. The match can result in several entries in the DB. If grouping is used in the regex the first group will be interpreted as the tracking id. Tracking ids > 20 char will be ignored.

The configuration file parser eats one level of backslashes, so the character class \s requires \\s in the configuration file. The parser also terminates the line at the first #, so a match expression containing # must be wrapped in double quotes.

The name of the external tracking system(max 10 char). It is possible to have several trackingid entries for the same tracking system.

Number of seconds to wait for a single network read or write to complete before giving up and declaring the remote side is not responding. If 0, there is no timeout, and this server will wait indefinitely for a transfer to finish.

A timeout should be large enough to mostly transfer the objects to the other side. 1 second may be too small for larger projects, especially over a WAN link, while 10-30 seconds is a much more reasonable timeout value.

Defaults to 0 seconds, wait indefinitely.

Name of the groups of users that are allowed to execute upload-pack on the server. One or more groups can be set.

If no groups are added, any user will be allowed to execute upload-pack on the server.

Name that Gerrit calls itself in Git when it creates a new Git commit, such as a merge during change submission.

By default this is "Gerrit Code Review".

Email address that Gerrit refers to itself as when it creates a new Git commit, such as a merge commit during change submission.

If not set, Gerrit generates this as "gerrit@hostname", where hostname is the hostname of the system Gerrit is running on.

By default, not set, generating the value at startup.

Local filesystem directory holding the site customization assets. Placing this directory under version control and/or backup is a good idea.

Files in this directory provide additional configuration.

Other files support site customization.

Private key used to sign the links emailed to users when they request to register a new email address on their user account. When the link is activated, the private key authenticates the link was created and sent by this Gerrit server, proving that the user can receive email at the address they are registering.

This column is automatically generated when the database is initialized. Changing it to a new value would cause all current links to be invalidated.

Changing it is not recommended.

Unique identity of the group with full privileges. Any user who is a member of this group may manage any other group, any project, and other system settings over the web.

This is initialized by Gerrit to be the "Administrators" group.

Changing it is not recommended.

Unique identity of the group for anonymous (not authenticated) users.

All users are a member of this group, whether or not they are actually signed in to Gerrit. Any access rights assigned to this group are inherited by all users.

This is initialized by Gerrit to be the "Anonymous Users" group.

Changing it is not recommended.

Unique identity of the group for all authenticated users.

All signed-in users are a member of this group. Any access rights assigned to this group are inherited by all users once they have authenticated to Gerrit.

Since account registration is open and fairly easy to obtain, moving from the "Anonymous Users" group to this group is not very difficult. Caution should be taken when assigning any permissions to this group.

This is initialized by Gerrit to be the "Registered Users" group.

Changing it is not recommended.