Update documentation to point to etc subdirectory

These files were moved under $site_path/etc and our documentation
was out of date with that change.

Change-Id: I50f6115706c68ada871f244b21f5d5b369646f60
Signed-off-by: Shawn O. Pearce <sop@google.com>
This commit is contained in:
Shawn O. Pearce 2009-11-17 16:10:10 -08:00
parent 309d8d365a
commit c5fed82732
7 changed files with 42 additions and 43 deletions

@ -60,7 +60,7 @@ you can easily copy-and-paste the text. Gerrit can read both the
armored and unarmored formats.
====
gpg --export --armor KEYEMAIL >$site_path/contact_information.pub
gpg --export --armor KEYEMAIL >$site_path/etc/contact_information.pub
====
Consider storing the private key with some sort of key escrow
@ -75,13 +75,13 @@ gerrit-contactstore project.
* link:http://android.git.kernel.org/?p=tools/gerrit-contactstore.git[gerrit-contactstore]
Configure `'$site_path'/gerrit.config` with the contact store's
Configure `'$site_path'/etc/gerrit.config` with the contact store's
URL (in `contactstore.url`), and if needed, APPSEC value (in
`contactstore.appsec`):
====
git config --file $site_path/gerrit.config appsec.url https://...
git config --file $site_path/gerrit.config appsec.appsec sekret
git config --file $site_path/etc/gerrit.config appsec.url https://...
git config --file $site_path/etc/gerrit.config appsec.appsec sekret
====

@ -1,18 +1,18 @@
Gerrit2 - Configuration
=======================
File `gerrit.config`
--------------------
File `etc/gerrit.config`
------------------------
The optional file `'$site_path'/gerrit.config` is a Git-style config
file that controls many host specific settings for Gerrit.
The optional file `'$site_path'/etc/gerrit.config` is a Git-style
config file that controls many host specific settings for Gerrit.
[NOTE]
The contents of the `gerrit.config` file are cached at startup
The contents of the `etc/gerrit.config` file are cached at startup
by Gerrit. If you modify any propeties in this file, Gerrit needs
to be restarted before it will use the new values.
Sample `gerrit.config`:
Sample `etc/gerrit.config`:
----
[core]
packedGitLimit = 200 m
@ -690,7 +690,7 @@ 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/keystore`.
By default, `$site_path/etc/keystore`.
[[httpd.sslKeyPassword]]httpd.sslKeyPassword::
+
@ -1146,15 +1146,15 @@ If not set, Gerrit generates this as "gerrit@`hostname`", where
By default, not set, generating the value at startup.
File `secure.config`
--------------------
The optional file `'$site_path'/secure.config` overrides (or
supplements) the settings supplied by `'$site_path'/gerrit.config`.
File `etc/secure.config`
-------------------------
The optional file `'$site_path'/etc/secure.config` overrides (or
supplements) the settings supplied by `'$site_path'/etc/gerrit.config`.
The file should be readable only by the daemon process and can be
used to contain private configuration entries that wouldn't normally
be exposed to everyone.
Sample `secure.config`:
Sample `etc/secure.config`:
----
[database]
username = webuser
@ -1170,10 +1170,10 @@ Sample `secure.config`:
smtpPass = sp@m
----
File `replication.config`
-------------------------
File `etc/replication.config`
-----------------------------
The optional file `'$site_path'/replication.config` controls how
The optional file `'$site_path'/etc/replication.config` controls how
Gerrit automatically replicates changes it makes to any of the Git
repositories under its control.
@ -1199,9 +1199,7 @@ Local filesystem directory holding the site customization assets.
Placing this directory under version control and/or backup is a
good idea.
+
SSH key files (`ssh_host_rsa_key` and `ssh_host_dsa_key` or
`ssh_host_key`) in this directory provide the host keys for the
internal SSH daemon.
Files in this directory provide additional configuration.
+
Other files support site customization.
+

@ -13,10 +13,10 @@ being used, ensure it uses a full mirror, so the `refs/changes/*`
namespace is available.
====
git config --file $site_path/gerrit.config gitweb.url http://example.com/gitweb.cgi
git config --file $site_path/etc/gerrit.config gitweb.url http://example.com/gitweb.cgi
====
After updating `'$site_path'/gerrit.config`, the Gerrit server must
After updating `'$site_path'/etc/gerrit.config`, the Gerrit server must
be restarted and clients must reload the host page to see the change.
Access Control

@ -11,19 +11,19 @@ HTML Header/Footer
At startup Gerrit reads the following files (if they exist) and
uses them to customize the HTML page it sends to clients:
* `'$site_path'/GerritSiteHeader.html`
* `'$site_path'/etc/GerritSiteHeader.html`
+
HTML is inserted below the menu bar, but above any page content.
This is a good location for an organizational logo, or links to
other systems like bug tracking.
* `'$site_path'/GerritSiteFooter.html`
* `'$site_path'/etc/GerritSiteFooter.html`
+
HTML is inserted at the bottom of the page, below all other content,
but just above the footer rule and the "Powered by Gerrit Code
Review (v....)" message shown at the extreme bottom.
* `'$site_path'/GerritSite.css`
* `'$site_path'/etc/GerritSite.css`
+
The CSS rules are inlined into the top of the HTML page, inside
of a `<style>` tag. These rules can be used to support styling

@ -13,7 +13,7 @@ user authentication services. To enable OpenID, the auth.type
setting should be `OpenID`:
====
git config --file $site_path/gerrit.config auth.type OpenID
git config --file $site_path/etc/gerrit.config auth.type OpenID
====
As this is the default setting there is nothing required from the
@ -45,7 +45,7 @@ will match any OpenID provider on the Internet:
To trust only Google Accounts:
====
git config --file $site_path/gerrit.config auth.trustedOpenID 'https://www.google.com/accounts/o8/id?id='
git config --file $site_path/etc/gerrit.config auth.trustedOpenID 'https://www.google.com/accounts/o8/id?id='
====
Database Schema
@ -73,9 +73,9 @@ all requests have already been authenticated. The "Sign In" and
To enable this form of authentication:
====
git config --file $site_path/gerrit.config auth.type HTTP
git config --file $site_path/gerrit.config --unset auth.httpHeader
git config --file $site_path/gerrit.config auth.emailFormat '{0}@example.com'
git config --file $site_path/etc/gerrit.config auth.type HTTP
git config --file $site_path/etc/gerrit.config --unset auth.httpHeader
git config --file $site_path/etc/gerrit.config auth.emailFormat '{0}@example.com'
====
The auth.type must always be HTTP, indicating the user identity
@ -136,9 +136,9 @@ all requests have already been authenticated. The "Sign In" and
To enable this form of authentication:
====
git config --file $site_path/gerrit.config auth.type HTTP
git config --file $site_path/gerrit.config auth.httpHeader SM_USER
git config --file $site_path/gerrit.config auth.emailFormat '{0}@example.com'
git config --file $site_path/etc/gerrit.config auth.type HTTP
git config --file $site_path/etc/gerrit.config auth.httpHeader SM_USER
git config --file $site_path/etc/gerrit.config auth.emailFormat '{0}@example.com'
====
The auth.type must always be HTTP, indicating the user identity

@ -596,8 +596,8 @@ the warm-standby is reasonably current should the master go offline.
Gerrit can be configured to replicate changes made to the local
Git repositories over any standard Git transports. This can be
configured in `'$site_path'/replication.conf` to send copies of
all changes over SSH to other servers, or to the Amazon S3 blob
configured in `'$site_path'/etc/replication.conf` to send copies
of all changes over SSH to other servers, or to the Amazon S3 blob
storage service.

@ -159,8 +159,9 @@ If you choose to install the Bouncy Castle Crypto APIs (see below)
you must create an RSA, DSA, or both, host keys for the daemon:
====
ssh-keygen -t rsa -P '' -f ssh_host_rsa_key
ssh-keygen -t dsa -P '' -f ssh_host_dsa_key
mkdir etc
ssh-keygen -t rsa -P '' -f etc/ssh_host_rsa_key
ssh-keygen -t dsa -P '' -f etc/ssh_host_dsa_key
====
These keys are used as the host keys for the internal SSH daemon
@ -172,8 +173,8 @@ be readable *only* by the account that is executing Gerrit2's web
application container. It is a security risk to make these files
readable by anyone else.
If you don't install Bouncy Castle, Gerrit will automatically
create a host key and save a copy to `'$site_path'/ssh_host_key`
If you don't install Bouncy Castle, Gerrit will automatically create
a host key and save a copy to `'$site_path'/etc/ssh_host_key`
during first startup. For this to work correctly, Gerrit will
require write access to the directory.
@ -186,7 +187,7 @@ any Git repository stored within it.
====
mkdir /srv/git
git config --file '$site_path'/gerrit.config gerrit.basePath /srv/git
git config --file '$site_path'/etc/gerrit.config gerrit.basePath /srv/git
====
You may wish to consider also exporting this directory over the
@ -298,7 +299,7 @@ rule into `'$JETTY_HOME'/etc`:
Create a start script like the one above, configuring Jetty to
listen on another port, such as 127.0.0.1:8081.
Set `gerrit.canonicalWebUrl` in `'$site_path'/gerrit.config`
Set `gerrit.canonicalWebUrl` in `'$site_path'/etc/gerrit.config`
to an `https://` style URL for your application, so that non-SSL
connections are automatically upgraded to SSL by issuing a redirect.
Gerrit does not currently support a dual http/https usage on the