Google Git
Sign in
gerrit / gerrit / 625fd7e7098c5c3f108626343925066c4fb9ce7e / . / Documentation / linux-quickstart.txt
blob: 13873ed62728cf55e675c4a5dce14a63f5a95946 [file] [log] [blame]
Marian Harbachebeb1542019-12-13 10:42:46 +0100[diff] [blame]1:linkattrs:
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]2= Quickstart for Installing Gerrit on Linux
3
Janet Davies0c1a6212018-05-09 15:18:57 -0700[diff] [blame]4This content explains how to install a basic instance of Gerrit on a Linux
5machine.
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]6
7[NOTE]
8====
Janet Davies0c1a6212018-05-09 15:18:57 -0700[diff] [blame]9This quickstart is provided for demonstration purposes only. The Gerrit instance
10they install must not be used in a production environment.
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]11
Janet Davies0c1a6212018-05-09 15:18:57 -0700[diff] [blame]12Instead, to install a Gerrit production environment, see
David Shevitzbcd0d242017-10-01 02:11:07 -0700[diff] [blame]13link:install.html[Standalone Daemon Installation Guide].
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]14====
15
Janet Davies0c1a6212018-05-09 15:18:57 -0700[diff] [blame]16== Before you start
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]17
Janet Davies0c1a6212018-05-09 15:18:57 -0700[diff] [blame]18Be sure you have:
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]19
Janet Davies0c1a6212018-05-09 15:18:57 -0700[diff] [blame]20. A Unix-based server, including any Linux flavor, MacOS, or Berkeley Software
21 Distribution (BSD).
Orgad Shanehffef3d82021-06-08 17:18:52 +0300[diff] [blame]22. Java SE Runtime Environment version 11 and up.
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]23
24== Download Gerrit
25
26From the Linux machine on which you want to install Gerrit:
27
28. Open a terminal window.
Janet Davies0c1a6212018-05-09 15:18:57 -0700[diff] [blame]29. Download the desired Gerrit archive.
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]30
Janet Davies0c1a6212018-05-09 15:18:57 -0700[diff] [blame]31To view previous archives, see
Eryk Szymanski2aed8cc2022-05-10 11:50:13 +0200[diff] [blame]32link:https://gerrit-releases.storage.googleapis.com/index.html[Gerrit Code Review: Releases,role=external,window=_blank]. The steps below install Gerrit 3.5.1:
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]33
34....
Eryk Szymanski2aed8cc2022-05-10 11:50:13 +0200[diff] [blame]35wget https://gerrit-releases.storage.googleapis.com/gerrit-3.5.1.war
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]36....
37
Janet Davies0c1a6212018-05-09 15:18:57 -0700[diff] [blame]38NOTE: To build and install Gerrit from the source files, see
39link:dev-readme.html[Gerrit Code Review: Developer Setup].
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]40
41== Install and initialize Gerrit
42
Janet Davies0c1a6212018-05-09 15:18:57 -0700[diff] [blame]43From the command line, enter:
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]44
45....
Ben Rohlfsb65406b2019-05-02 10:43:40 +0200[diff] [blame]46export GERRIT_SITE=~/gerrit_testsite
47java -jar gerrit*.war init --batch --dev -d $GERRIT_SITE
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]48....
49
Janet Davies0c1a6212018-05-09 15:18:57 -0700[diff] [blame]50This command takes two parameters:
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]51
Janet Davies0c1a6212018-05-09 15:18:57 -0700[diff] [blame]52* `--batch` assigns default values to several Gerrit configuration
53 options. To learn more about these options, see
54 link:config-gerrit.html[Configuration].
55* `--dev` configures the Gerrit server to use the authentication
56 option, `DEVELOPMENT_BECOME_ANY_ACCOUNT`, which enables you to
57 switch between different users to explore how Gerrit works. To learn more
58 about setting up Gerrit for development, see
59 link:dev-readme.html[Gerrit Code Review: Developer Setup].
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]60
Janet Davies0c1a6212018-05-09 15:18:57 -0700[diff] [blame]61While this command executes, status messages are displayed in the terminal
62window. For example:
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]63
64....
65Generating SSH host key ... rsa(simple)... done
66Initialized /home/gerrit/gerrit_testsite
67Executing /home/gerrit/gerrit_testsite/bin/gerrit.sh start
68Starting Gerrit Code Review: OK
69....
70
Janet Davies0c1a6212018-05-09 15:18:57 -0700[diff] [blame]71The last message confirms that the Gerrit service is running:
72
73`Starting Gerrit Code Review: OK`.
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]74
75== Update the listen URL
76
Janet Davies0c1a6212018-05-09 15:18:57 -0700[diff] [blame]77To prevent outside connections from contacting your new Gerrit instance
78(strongly recommended), change the URL on which Gerrit listens from `*` to
79`localhost`. For example:
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]80
81....
Ben Rohlfsb65406b2019-05-02 10:43:40 +0200[diff] [blame]82git config --file $GERRIT_SITE/etc/gerrit.config httpd.listenUrl 'http://localhost:8080'
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]83....
84
85== Restart the Gerrit service
86
87You must restart the Gerrit service for your authentication type and listen URL
Janet Davies0c1a6212018-05-09 15:18:57 -0700[diff] [blame]88changes to take effect:
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]89
90....
Ben Rohlfsb65406b2019-05-02 10:43:40 +0200[diff] [blame]91$GERRIT_SITE/bin/gerrit.sh restart
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]92....
93
94== Viewing Gerrit
95
Janet Davies0c1a6212018-05-09 15:18:57 -0700[diff] [blame]96To view your new basic installation of Gerrit, go to:
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]97
98....
99http://localhost:8080
100....
101
102== Next steps
103
Janet Davies0c1a6212018-05-09 15:18:57 -0700[diff] [blame]104Now that you have a simple version of Gerrit running, use the installation to
105explore the user interface and learn about Gerrit. For more detailed
106installation instructions, see
Kenyon Ralph8faf4232021-07-22 17:08:37 -0700[diff] [blame]107link:install.html[Standalone Daemon Installation Guide].
David Shevitz11a458a2017-07-20 15:32:05 -0700[diff] [blame]108
109GERRIT
110------
111
112Part of link:index.html[Gerrit Code Review]
113
114SEARCHBOX
115---------