2013-12-20 12:55:51 -08:00
|
|
|
= init
|
2009-11-17 14:52:07 -08:00
|
|
|
|
2013-12-20 12:55:51 -08:00
|
|
|
== NAME
|
2016-09-16 09:42:46 +02:00
|
|
|
init - Initialize a new Gerrit server installation or upgrade an existing
|
|
|
|
installation.
|
2009-11-17 14:52:07 -08:00
|
|
|
|
2013-12-20 12:55:51 -08:00
|
|
|
== SYNOPSIS
|
2016-07-08 10:58:27 +02:00
|
|
|
[verse]
|
2013-11-15 11:47:46 -08:00
|
|
|
--
|
2016-07-08 10:58:27 +02:00
|
|
|
_java_ -jar gerrit.war _init_
|
|
|
|
-d <SITE_PATH>
|
|
|
|
[--batch]
|
2016-10-06 16:10:43 +02:00
|
|
|
[--delete-caches]
|
2016-07-08 10:58:27 +02:00
|
|
|
[--no-auto-start]
|
|
|
|
[--skip-plugins]
|
|
|
|
[--list-plugins]
|
|
|
|
[--install-plugin=<PLUGIN_NAME>]
|
|
|
|
[--install-all-plugins]
|
|
|
|
[--secure-store-lib]
|
|
|
|
[--dev]
|
|
|
|
[--skip-all-downloads]
|
|
|
|
[--skip-download=<LIBRARY_NAME>]
|
2013-11-15 11:47:46 -08:00
|
|
|
--
|
2009-11-17 14:52:07 -08:00
|
|
|
|
2013-12-20 12:55:51 -08:00
|
|
|
== DESCRIPTION
|
2009-11-17 14:52:07 -08:00
|
|
|
Creates a new Gerrit server installation, interactively prompting
|
|
|
|
for some basic setup prior to writing default configuration files
|
|
|
|
into a newly created `$site_path`.
|
|
|
|
|
2016-09-16 09:42:46 +02:00
|
|
|
If run in an existing `$site_path`, init upgrades existing resources
|
2018-12-18 13:24:14 -08:00
|
|
|
(e.g. NoteDb schema, plugins) as necessary.
|
2009-11-17 14:52:07 -08:00
|
|
|
|
2013-12-20 12:55:51 -08:00
|
|
|
== OPTIONS
|
2016-09-16 09:43:24 +02:00
|
|
|
-b::
|
2013-12-09 15:43:25 -08:00
|
|
|
--batch::
|
2016-05-02 13:53:52 +02:00
|
|
|
Run in batch mode, skipping interactive prompts. For a fresh
|
|
|
|
install, reasonable configuration defaults are chosen based
|
2016-09-16 09:42:46 +02:00
|
|
|
on the whims of the Gerrit developers. On upgrades, the existing
|
|
|
|
settings in `gerrit.config` are respected.
|
2012-04-27 14:01:26 +02:00
|
|
|
+
|
2016-09-16 10:13:58 +02:00
|
|
|
If during a schema migration unused objects (e.g. tables, columns)
|
|
|
|
are detected, they are *not* automatically dropped; a list of SQL
|
|
|
|
statements to drop these objects is provided. To drop the unused
|
|
|
|
objects these SQL statements must be executed manually.
|
2009-11-17 14:52:07 -08:00
|
|
|
|
2016-10-06 16:10:43 +02:00
|
|
|
--delete-caches::
|
|
|
|
Force deletion of all persistent cache files. Note that
|
|
|
|
re-creation of these caches may be expensive.
|
|
|
|
|
2013-12-09 15:43:25 -08:00
|
|
|
--no-auto-start::
|
2009-12-14 07:34:04 -08:00
|
|
|
Don't automatically start the daemon after initializing a
|
2011-09-15 12:49:42 +02:00
|
|
|
newly created site path. This permits the administrator
|
2009-12-14 07:34:04 -08:00
|
|
|
to inspect and modify the configuration before the daemon
|
|
|
|
is started.
|
|
|
|
|
2009-11-17 14:52:07 -08:00
|
|
|
-d::
|
2013-12-09 15:43:25 -08:00
|
|
|
--site-path::
|
2016-09-16 09:42:46 +02:00
|
|
|
Location of the `gerrit.config` file, and all other per-site
|
2011-09-15 12:49:42 +02:00
|
|
|
configuration data, supporting libraries and log files.
|
2009-11-17 14:52:07 -08:00
|
|
|
|
2016-04-25 17:30:57 -04:00
|
|
|
--skip-plugins::
|
|
|
|
Entirely skip installation and initialization of plugins. This option
|
|
|
|
is needed when initializing a gerrit site without an archive. That
|
|
|
|
happens when running gerrit acceptance or integration tests in a
|
|
|
|
debugger, using classes. Supplying this option leads to ignoring the
|
2016-09-16 09:42:46 +02:00
|
|
|
`--install-plugin` and `--install-all-plugins` options, if supplied as well.
|
2016-04-25 17:30:57 -04:00
|
|
|
|
2013-12-09 15:43:25 -08:00
|
|
|
--list-plugins::
|
2013-07-15 11:06:00 +02:00
|
|
|
Print names of plugins that can be installed during init process.
|
|
|
|
|
2016-04-08 11:52:09 -04:00
|
|
|
--install-all-plugins::
|
|
|
|
Automatically install all plugins from gerrit.war without asking.
|
|
|
|
This option also works in batch mode. This option cannot be supplied
|
2016-09-16 09:42:46 +02:00
|
|
|
alongside `--install-plugin`.
|
2016-04-08 11:52:09 -04:00
|
|
|
|
2016-04-27 15:16:42 -04:00
|
|
|
--secure-store-lib::
|
|
|
|
Path to the jar providing the chosen
|
|
|
|
link:dev-plugins.html#secure-store[SecureStore] implementation class.
|
2016-09-16 09:42:46 +02:00
|
|
|
This option is used in the same way as the `--new-secure-store-lib` option
|
2016-04-27 15:16:42 -04:00
|
|
|
documented in link:pgm-SwitchSecureStore.html[SwitchSecureStore].
|
|
|
|
|
2013-12-10 18:41:38 +09:00
|
|
|
--install-plugin::
|
2013-07-15 13:54:30 +02:00
|
|
|
Automatically install plugin with given name without asking.
|
2016-04-08 11:52:09 -04:00
|
|
|
This option also works in batch mode. This option may be supplied
|
|
|
|
more than once to install multiple plugins. This option cannot be
|
2016-09-16 09:42:46 +02:00
|
|
|
supplied alongside `--install-all-plugins`.
|
2013-07-15 13:54:30 +02:00
|
|
|
|
2015-11-08 12:11:39 -08:00
|
|
|
--dev::
|
|
|
|
Install in developer mode. Default configuration settings are
|
|
|
|
chosen to run the Gerrit server as a developer.
|
|
|
|
|
2016-02-09 15:17:31 +01:00
|
|
|
--skip-all-downloads::
|
|
|
|
Do not automatically download and install required libraries. The
|
2016-09-16 09:42:46 +02:00
|
|
|
administrator must manually install the required libraries in the `lib/`
|
|
|
|
folder.
|
2016-02-09 15:17:31 +01:00
|
|
|
|
|
|
|
--skip-download::
|
|
|
|
Do not automatically download and install the library with the given name.
|
2016-09-16 09:42:46 +02:00
|
|
|
The administrator must manually install the required library in the `lib/`
|
|
|
|
folder.
|
2016-02-09 15:17:31 +01:00
|
|
|
|
2013-12-20 12:55:51 -08:00
|
|
|
== CONTEXT
|
2018-12-18 13:24:14 -08:00
|
|
|
This command can only be run on a server which has direct local access to the
|
2009-11-17 14:52:07 -08:00
|
|
|
managed Git repositories.
|
|
|
|
|
|
|
|
GERRIT
|
|
|
|
------
|
|
|
|
Part of link:index.html[Gerrit Code Review]
|
2013-10-31 17:26:00 -07:00
|
|
|
|
|
|
|
SEARCHBOX
|
|
|
|
---------
|