diff options
Diffstat (limited to 'Documentation/config-gerrit.txt')
| -rw-r--r-- | Documentation/config-gerrit.txt | 121 |
1 files changed, 70 insertions, 51 deletions
diff --git a/Documentation/config-gerrit.txt b/Documentation/config-gerrit.txt index d942aa3273..45d4fc6f7d 100644 --- a/Documentation/config-gerrit.txt +++ b/Documentation/config-gerrit.txt @@ -37,9 +37,10 @@ flags. [[accountPatchReviewDb.url]]accountPatchReviewDb.url:: + -The url of accountPatchReviewDb. Supported types are `H2`, `POSTGRESQL`, -`MARIADB`, and `MYSQL`. Drop the driver jar in the lib folder of the site path -if the Jdbc driver of the corresponding Database is not yet in the class path. +The url of accountPatchReviewDb. Supported types are `CLOUDSPANNER`, `H2`, +`POSTGRESQL`, `MARIADB`, and `MYSQL`. Drop the driver jar in the lib folder of +the site path if the Jdbc driver of the corresponding Database is not yet in +the class path. + Default is to create H2 database in the db folder of the site path. + @@ -960,12 +961,6 @@ information is obtained from NoteDb data in the `All-Users` repo. + If direct updates are made to `All-Users`, this cache should be flushed. -cache `"approvals"`:: -+ -Cache entries contain approvals for a given patch set. This includes -approvals granted on this patch set as well as approvals copied from -earlier patch sets. - cache `"adv_bases"`:: + Used only for push over smart HTTP when branch level access controls @@ -1066,12 +1061,6 @@ It is not recommended to change the in-memory attributes of this cache away from the defaults. The cache may be persisted by setting `diskLimit`, which is only recommended if cold start performance is problematic. -+ -`external_ids_map` supports computing the new cache value based on a -previously cached state. This applies modifications based on the Git -diff and is almost always faster. -`cache.external_ids_map.enablePartialReloads` turns this behavior on -or off. The default is `true`. cache `"git_tags"`:: + @@ -1208,6 +1197,9 @@ branch of each project. 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. +NOTE: This cache should be disabled or set with a low refreshAfterWrite +in a cluster setup using multiple primary or multiple replica nodes. + cache `"prolog_rules"`:: + Caches parsed `rules.pl` contents for each project. This cache uses the same @@ -1218,6 +1210,14 @@ cache `"pure_revert"`:: Result of checking if one change or commit is a pure/clean revert of another. +cache `"soy_sauce_compiled_templates"`:: ++ +Caches compiled soy templates. Stores at most only one key-value pair with +a constant key value and the value is a compiled SoySauce templates. The value +is reloaded automatically every few seconds if there are reads from the cache. +If cache is not used for 1 minute, the item is removed (i.e. emails can be send +with templates which are max 1 minute old). + cache `"sshkeys"`:: + Caches unpacked versions of user SSH keys, so the internal SSH daemon @@ -1226,6 +1226,9 @@ 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. +NOTE: This cache should be disabled or set with a low refreshAfterWrite +in a cluster setup using multiple primary or multiple replica nodes. + cache `"web_sessions"`:: + Tracks the live user sessions coming in over HTTP. Flushing this @@ -1242,6 +1245,9 @@ is strongly recommended. + Session storage is relatively inexpensive. The average entry in this cache is approximately 346 bytes. ++ +The `maxAge` configuration is also used for as maximum lifetime +of the HTTP servlet container session. See also link:cmd-flush-caches.html[gerrit flush-caches]. @@ -1541,8 +1547,7 @@ moved to a new branch, and the moved change gets submitted to the new branch, the changes on which the change depends are silently merged into the new branch, although these changes have not been moved to that branch (see details in -link:https://bugs.chromium.org/p/gerrit/issues/detail?id=9877[issue -9877]). +link:https://issues.gerritcodereview.com/issues/40009784[issue 40009784]). + By default true. @@ -1657,6 +1662,21 @@ If 0 the update polling is disabled. + Default is 5 minutes. +[[change.skipCurrentRulesEvaluationOnClosedChanges]] ++ +If false, Gerrit will always take latest project configuration to +compute submit labels. This means that, closed changes (either merged +or abandoned) will be evaluated against the latest configuration which +may produce different results. Especially for merged changes, they may +look like they didn't meet the submit requirements. ++ +When true, evaluation will be skipped and Gerrit will show the +exact status of submit labels when change was submitted. Post-review +votes will only be allowed on labels that were configured when change +was closed. ++ +Default it false. + [[changeCleanup]] === Section changeCleanup @@ -2068,6 +2088,14 @@ Values can be specified using standard time unit abbreviations (`ms`, `sec`, + Default is 1 hour. +[[dashboard]] +=== Section dashboard + +[[dashboard.submitRequirementColumns]]dashboard.submitRequirementColumns:: ++ +The list of submit requirement names that should be displayed as separate +columns in the dashboard. + [[download]] === Section download @@ -2209,15 +2237,6 @@ valid JAR file, whose code would have access to cookies on the domain. For this reason `zip` format is always excluded from formats offered through the `Download` drop down or accessible in the REST API. -[[download.maxBundleSize]]download.maxBundleSize:: -+ -Specifies the maximum size of a bundle in bytes that can be downloaded. -As bundles are kept in memory this setting is to protect the server -from a single request consuming too much heap when generating -a bundle and thereby impacting other users. -+ -Defaults to 100MB. - [[gc]] === Section gc @@ -3338,11 +3357,6 @@ For example, if the limit of previous query was 500, pageSizeMultiplier is configured to 5 and maxPageSize to 2000, the next query will have a limit of 2000 (instead of 2500). + -When `index.type` is set to `ELASTICSEARCH`, this value should not exceed -the `index.max_result_window` value configured on the Elasticsearch -server. If a value is not configured during site initialization, defaults to -10000, which is the default value of `index.max_result_window` in Elasticsearch. -+ _Note: ignored when paginationType is `NONE`_ + Defaults to no limit. @@ -3658,7 +3672,7 @@ an encrypted connection. If you want to configure multiple ldap servers you can try to put multiple ldap urls separated by a space: `server = ldaps://ldap1 ldaps://ldap2` -See https://bugs.chromium.org/p/gerrit/issues/detail?id=10841[issue 10841]. +See https://issues.gerritcodereview.com/issues/40010644[issue 40010644]. [[ldap.startTls]]ldap.startTls:: + @@ -5016,16 +5030,6 @@ namespace. To alias `replication start` to `gerrit replicate`: replicate = replication start ---- -[[ssh]] -=== Section ssh - -[[ssh.clientImplementation]]ssh.clientImplementation:: -+ -JCraft JSch client is supported in addition to Apache MINA SSH client. -To use JSch client set the value to `JSCH`. -+ -By default, `APACHE`. - [[sshd]] === Section sshd @@ -5246,22 +5250,27 @@ from the default cipher set. + Supported ciphers: + -* `aes128-ctr` -* `aes192-ctr` -* `aes256-ctr` * `aes128-cbc` +* `aes128-ctr` +* `aes128-gcm@openssh.com` * `aes192-cbc` +* `aes192-ctr` * `aes256-cbc` -* `blowfish-cbc` -* `3des-cbc` +* `aes256-ctr` +* `aes256-gcm@openssh.com` * `arcfour128` * `arcfour256` +* `blowfish-cbc` +* `chacha20-poly1305@openssh.com` +* `3des-cbc` * `none` + -By default, all supported ciphers except `none` are available. -+ If your setup allows for it, it's recommended to disable all ciphers except the AES-CTR modes. ++ +See also link:https://github.com/apache/mina-sshd/tree/master#ciphers[ciphers,role=external,window=_blank]. ++ +By default, all supported ciphers except `none` are available. [[sshd.mac]]sshd.mac:: + @@ -5279,6 +5288,11 @@ Supported MACs: * `hmac-sha1-96` * `hmac-sha2-256` * `hmac-sha2-512` +* `hmac-sha1-etm@openssh.com` +* `hmac-sha2-256-etm@openssh.com` +* `hmac-sha2-512-etm@openssh.com` ++ +See also link:https://github.com/apache/mina-sshd/tree/master#macs[macs,role=external,window=_blank]. + By default, all supported MACs are available. @@ -5307,6 +5321,9 @@ Supported key exchange algorithms: * `ecdh-sha2-nistp521` * `ecdh-sha2-nistp384` * `ecdh-sha2-nistp256` +* `curve25519-sha256` +* `curve25519-sha256@libssh.org` +* `curve448-sha512` * `diffie-hellman-group-exchange-sha256` * `diffie-hellman-group18-sha512` * `diffie-hellman-group17-sha512` @@ -5317,12 +5334,14 @@ Supported key exchange algorithms: See link:#sshd.enableDeprecatedKexAlgorithms[sshd.enableDeprecatedKexAlgorithms] for deprecated key algorithms and how to enable them. -By default, all supported key exchange algorithms are available. - It is strongly recommended to disable at least `diffie-hellman-group1-sha1` as it's known to be vulnerable (logjam attack). Additionally, if your setup allows for it, it is recommended to disable the remaining two `sha1` key exchange algorithms. + +See also link:https://github.com/apache/mina-sshd/tree/master#key-exchange[key exchange,role=external,window=_blank]. + +By default, all supported key exchange algorithms are available. -- [[sshd.kerberosKeytab]]sshd.kerberosKeytab:: |