blob: 39cd70dd69e17e4e31bb7812ab7d8d494fd602fa [file] [log] [blame]
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08001= init
Shawn O. Pearce2fe738b2009-11-17 14:52:07 -08002
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08003== NAME
Shawn O. Pearce2fe738b2009-11-17 14:52:07 -08004init - Initialize a new Gerrit server installation
5
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08006== SYNOPSIS
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -08007--
Shawn O. Pearce2fe738b2009-11-17 14:52:07 -08008'java' -jar gerrit.war 'init'
9 -d <SITE_PATH>
Yuxuan 'fishy' Wang77e15082013-12-09 15:43:25 -080010 [--batch]
11 [--no-auto-start]
12 [--list-plugins]
13 [--install-plugin=<PLUGIN_NAME>]
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -080014--
Shawn O. Pearce2fe738b2009-11-17 14:52:07 -080015
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080016== DESCRIPTION
Shawn O. Pearce2fe738b2009-11-17 14:52:07 -080017Creates a new Gerrit server installation, interactively prompting
18for some basic setup prior to writing default configuration files
19into a newly created `$site_path`.
20
David Pursehouse221d4f62012-06-08 17:38:08 +090021If run in an existing `$site_path`, init will upgrade some resources
Shawn O. Pearce89cefce2010-12-08 18:30:43 -080022as necessary.
Shawn O. Pearce2fe738b2009-11-17 14:52:07 -080023
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080024== OPTIONS
Yuxuan 'fishy' Wang77e15082013-12-09 15:43:25 -080025--batch::
Shawn O. Pearce2fe738b2009-11-17 14:52:07 -080026 Run in batch mode, skipping interactive prompts. Reasonable
27 configuration defaults are chosen based on the whims of
28 the Gerrit developers.
Edwin Kempin1cd69092012-04-27 14:01:26 +020029+
30If during a schema migration unused objects (e.g. tables, columns)
31are detected they are *not* automatically dropped, but only a list of
32SQL statements to drop these objects is provided. To drop the unused
33objects these SQL statements have to be executed manually.
Shawn O. Pearce2fe738b2009-11-17 14:52:07 -080034
Yuxuan 'fishy' Wang77e15082013-12-09 15:43:25 -080035--no-auto-start::
Shawn O. Pearced99326d2009-12-14 07:34:04 -080036 Don't automatically start the daemon after initializing a
Edwin Kempinf1acbb82011-09-15 12:49:42 +020037 newly created site path. This permits the administrator
Shawn O. Pearced99326d2009-12-14 07:34:04 -080038 to inspect and modify the configuration before the daemon
39 is started.
40
Shawn O. Pearce2fe738b2009-11-17 14:52:07 -080041-d::
Yuxuan 'fishy' Wang77e15082013-12-09 15:43:25 -080042--site-path::
Shawn O. Pearce2fe738b2009-11-17 14:52:07 -080043 Location of the gerrit.config file, and all other per-site
Edwin Kempinf1acbb82011-09-15 12:49:42 +020044 configuration data, supporting libraries and log files.
Shawn O. Pearce2fe738b2009-11-17 14:52:07 -080045
Yuxuan 'fishy' Wang77e15082013-12-09 15:43:25 -080046--list-plugins::
Dariusz Lukszab8aae532013-07-15 11:06:00 +020047 Print names of plugins that can be installed during init process.
48
David Pursehouse4495f302013-12-10 18:41:38 +090049--install-plugin::
Dariusz Luksza3c226782013-07-15 13:54:30 +020050 Automatically install plugin with given name without asking.
David Ostrovsky359900e2013-12-10 01:04:09 +010051 This option may be supplied more than once to install multiple
52 plugins.
Dariusz Luksza3c226782013-07-15 13:54:30 +020053
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080054== CONTEXT
Shawn O. Pearce2fe738b2009-11-17 14:52:07 -080055This command can only be run on a server which has direct
56connectivity to the metadata database, and local access to the
57managed Git repositories.
58
59GERRIT
60------
61Part of link:index.html[Gerrit Code Review]
Yuxuan 'fishy' Wang99cb68d2013-10-31 17:26:00 -070062
63SEARCHBOX
64---------