blob: ae5e4718357c63d870abe8bf857610ad6789e7eb [file] [log] [blame]
Shawn O. Pearce2fe738b2009-11-17 14:52:07 -08001init
2====
3
4NAME
5----
6init - Initialize a new Gerrit server installation
7
8SYNOPSIS
9--------
10[verse]
11'java' -jar gerrit.war 'init'
12 -d <SITE_PATH>
13 [\--batch]
Shawn O. Pearced99326d2009-12-14 07:34:04 -080014 [\--no-auto-start]
Shawn O. Pearce2fe738b2009-11-17 14:52:07 -080015
16DESCRIPTION
17-----------
18Creates a new Gerrit server installation, interactively prompting
19for some basic setup prior to writing default configuration files
20into a newly created `$site_path`.
21
22If run an an existing `$site_path`, init will upgrade some resources
Shawn O. Pearce89cefce2010-12-08 18:30:43 -080023as necessary.
Shawn O. Pearce2fe738b2009-11-17 14:52:07 -080024
25OPTIONS
26-------
27\--batch::
28 Run in batch mode, skipping interactive prompts. Reasonable
29 configuration defaults are chosen based on the whims of
30 the Gerrit developers.
Edwin Kempin1cd69092012-04-27 14:01:26 +020031+
32If during a schema migration unused objects (e.g. tables, columns)
33are detected they are *not* automatically dropped, but only a list of
34SQL statements to drop these objects is provided. To drop the unused
35objects these SQL statements have to be executed manually.
Shawn O. Pearce2fe738b2009-11-17 14:52:07 -080036
Shawn O. Pearced99326d2009-12-14 07:34:04 -080037\--no-auto-start::
38 Don't automatically start the daemon after initializing a
Edwin Kempinf1acbb82011-09-15 12:49:42 +020039 newly created site path. This permits the administrator
Shawn O. Pearced99326d2009-12-14 07:34:04 -080040 to inspect and modify the configuration before the daemon
41 is started.
42
Shawn O. Pearce2fe738b2009-11-17 14:52:07 -080043-d::
44\--site-path::
45 Location of the gerrit.config file, and all other per-site
Edwin Kempinf1acbb82011-09-15 12:49:42 +020046 configuration data, supporting libraries and log files.
Shawn O. Pearce2fe738b2009-11-17 14:52:07 -080047
48CONTEXT
49-------
50This command can only be run on a server which has direct
51connectivity to the metadata database, and local access to the
52managed Git repositories.
53
54GERRIT
55------
56Part of link:index.html[Gerrit Code Review]