documentation: Cleanup formatting in gerrit-config
Some of our formatting style was not consistent. Change-Id: I7bedb9ffc5f691ac66c5974053b52a28a21003b6 Signed-off-by: Shawn O. Pearce <sop@google.com>
This commit is contained in:
@@ -15,13 +15,13 @@ to be restarted before it will use the new values.
|
|||||||
Sample `etc/gerrit.config`:
|
Sample `etc/gerrit.config`:
|
||||||
----
|
----
|
||||||
[core]
|
[core]
|
||||||
packedGitLimit = 200 m
|
packedGitLimit = 200 m
|
||||||
|
|
||||||
[cache]
|
[cache]
|
||||||
directory = /var/cache/gerrit2
|
directory = /var/cache/gerrit2
|
||||||
|
|
||||||
[cache "diff"]
|
[cache "diff"]
|
||||||
diskbuffer = 10 m
|
diskbuffer = 10 m
|
||||||
----
|
----
|
||||||
|
|
||||||
[[auth]]Section auth
|
[[auth]]Section auth
|
||||||
@@ -529,14 +529,14 @@ much more predictable behavior.
|
|||||||
The database section configures where Gerrit stores its metadata
|
The database section configures where Gerrit stores its metadata
|
||||||
records about user accounts and change reviews.
|
records about user accounts and change reviews.
|
||||||
|
|
||||||
====
|
----
|
||||||
[database]
|
[database]
|
||||||
type = postgres
|
type = postgres
|
||||||
hostname = localhost
|
hostname = localhost
|
||||||
database = reviewdb
|
database = reviewdb
|
||||||
username = gerrit2
|
username = gerrit2
|
||||||
password = s3kr3t
|
password = s3kr3t
|
||||||
====
|
----
|
||||||
|
|
||||||
[[database.type]]database.type::
|
[[database.type]]database.type::
|
||||||
+
|
+
|
||||||
@@ -649,19 +649,22 @@ For example, "?p=$project.git;h=$commit".
|
|||||||
~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
[[http.proxy]]http.proxy::
|
[[http.proxy]]http.proxy::
|
||||||
URL of the proxy server when making outgoing HTTP
|
+
|
||||||
connections for OpenID login transactions. Syntax
|
URL of the proxy server when making outgoing HTTP
|
||||||
should be `http://`'hostname'`:`'port'.
|
connections for OpenID login transactions. Syntax
|
||||||
|
should be `http://`'hostname'`:`'port'.
|
||||||
|
|
||||||
[[http.proxyUsername]]http.proxyUsername::
|
[[http.proxyUsername]]http.proxyUsername::
|
||||||
Optional username to authenticate to the HTTP proxy with.
|
+
|
||||||
This property is honored only if the username does not
|
Optional username to authenticate to the HTTP proxy with.
|
||||||
appear in the http.proxy property above.
|
This property is honored only if the username does not
|
||||||
|
appear in the http.proxy property above.
|
||||||
|
|
||||||
[[http.proxyPassword]]http.proxyPassword::
|
[[http.proxyPassword]]http.proxyPassword::
|
||||||
Optional password to authenticate to the HTTP proxy with.
|
+
|
||||||
This property is honored only if the password does not
|
Optional password to authenticate to the HTTP proxy with.
|
||||||
appear in the http.proxy property above.
|
This property is honored only if the password does not
|
||||||
|
appear in the http.proxy property above.
|
||||||
|
|
||||||
|
|
||||||
[[httpd]]Section httpd
|
[[httpd]]Section httpd
|
||||||
@@ -753,10 +756,10 @@ and private key. This keystore is required for `https://` in URL.
|
|||||||
+
|
+
|
||||||
To create a self-signed certificate for simple internal usage:
|
To create a self-signed certificate for simple internal usage:
|
||||||
+
|
+
|
||||||
====
|
----
|
||||||
keytool -keystore keystore -alias jetty -genkey -keyalg RSA
|
keytool -keystore keystore -alias jetty -genkey -keyalg RSA
|
||||||
chmod 600 keystore
|
chmod 600 keystore
|
||||||
====
|
----
|
||||||
+
|
+
|
||||||
If not absolute, the path is resolved relative to `$site_path`.
|
If not absolute, the path is resolved relative to `$site_path`.
|
||||||
+
|
+
|
||||||
@@ -817,18 +820,18 @@ detected during startup. The guessed defaults support both
|
|||||||
link:http://www.ietf.org/rfc/rfc2307.txt[RFC 2307] and Active
|
link:http://www.ietf.org/rfc/rfc2307.txt[RFC 2307] and Active
|
||||||
Directory.
|
Directory.
|
||||||
|
|
||||||
====
|
----
|
||||||
[ldap]
|
[ldap]
|
||||||
server = ldap://ldap.example.com
|
server = ldap://ldap.example.com
|
||||||
#
|
|
||||||
accountBase = ou=people,dc=example,dc=com
|
accountBase = ou=people,dc=example,dc=com
|
||||||
accountPattern = (&(objectClass=person)(uid=${username}))
|
accountPattern = (&(objectClass=person)(uid=${username}))
|
||||||
accountFullName = displayName
|
accountFullName = displayName
|
||||||
accountEmailAddress = mail
|
accountEmailAddress = mail
|
||||||
#
|
|
||||||
groupBase = ou=groups,dc=example,dc=com
|
groupBase = ou=groups,dc=example,dc=com
|
||||||
groupMemberPattern = (&(objectClass=group)(member=${dn}))
|
groupMemberPattern = (&(objectClass=group)(member=${dn}))
|
||||||
====
|
----
|
||||||
|
|
||||||
[[ldap.server]]ldap.server::
|
[[ldap.server]]ldap.server::
|
||||||
+
|
+
|
||||||
@@ -1019,16 +1022,19 @@ or the wildcard `\*/*` to match all types.
|
|||||||
By default, false for all MIME types.
|
By default, false for all MIME types.
|
||||||
|
|
||||||
Common examples:
|
Common examples:
|
||||||
====
|
----
|
||||||
[mimetype "image/*"]
|
[mimetype "image/*"]
|
||||||
safe = true
|
safe = true
|
||||||
[mimetype "application/pdf"]
|
|
||||||
safe = true
|
[mimetype "application/pdf"]
|
||||||
[mimetype "application/msword"]
|
safe = true
|
||||||
safe = true
|
|
||||||
[mimetype "application/vnd.ms-excel"]
|
[mimetype "application/msword"]
|
||||||
safe = true
|
safe = true
|
||||||
====
|
|
||||||
|
[mimetype "application/vnd.ms-excel"]
|
||||||
|
safe = true
|
||||||
|
----
|
||||||
|
|
||||||
[[repo]]Section repo
|
[[repo]]Section repo
|
||||||
~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
@@ -1235,17 +1241,17 @@ be exposed to everyone.
|
|||||||
Sample `etc/secure.config`:
|
Sample `etc/secure.config`:
|
||||||
----
|
----
|
||||||
[database]
|
[database]
|
||||||
username = webuser
|
username = webuser
|
||||||
password = s3kr3t
|
password = s3kr3t
|
||||||
|
|
||||||
[ldap]
|
[ldap]
|
||||||
password = l3tm3srch
|
password = l3tm3srch
|
||||||
|
|
||||||
[httpd]
|
[httpd]
|
||||||
sslKeyPassword = g3rr1t
|
sslKeyPassword = g3rr1t
|
||||||
|
|
||||||
[sendemail]
|
[sendemail]
|
||||||
smtpPass = sp@m
|
smtpPass = sp@m
|
||||||
----
|
----
|
||||||
|
|
||||||
File `etc/replication.config`
|
File `etc/replication.config`
|
||||||
|
|||||||
Reference in New Issue
Block a user