Jason Huntley | 25bbd51 | 2012-08-02 11:10:31 -0400 | [diff] [blame] | 1 | Gerrit Code Review - Standalone Daemon Installation Guide |
| 2 | ========================================================= |
Shawn O. Pearce | d2b73db | 2009-01-09 11:55:47 -0800 | [diff] [blame] | 3 | |
Fredrik Luthander | 833aa74 | 2011-10-27 21:07:46 +0200 | [diff] [blame] | 4 | [[requirements]] |
| 5 | Requirements |
Martin Fick | 472bb9d | 2012-05-08 16:30:16 -0700 | [diff] [blame] | 6 | ------------ |
Fredrik Luthander | 833aa74 | 2011-10-27 21:07:46 +0200 | [diff] [blame] | 7 | To run the Gerrit service, the following requirements must be met on |
| 8 | the host: |
| 9 | |
| 10 | * JDK, minimum version 1.6 http://www.oracle.com/technetwork/java/javase/downloads/index.html[Download] |
| 11 | |
David Pursehouse | 3be717b | 2013-05-13 13:56:11 +0900 | [diff] [blame] | 12 | You'll also need an SQL database to house the review metadata. You have the |
Fredrik Luthander | 833aa74 | 2011-10-27 21:07:46 +0200 | [diff] [blame] | 13 | choice of either using the embedded H2 or to host your own MySQL or PostgreSQL. |
| 14 | |
Shawn O. Pearce | d2b73db | 2009-01-09 11:55:47 -0800 | [diff] [blame] | 15 | |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 16 | [[download]] |
| 17 | Download Gerrit |
Shawn O. Pearce | d2b73db | 2009-01-09 11:55:47 -0800 | [diff] [blame] | 18 | --------------- |
| 19 | |
Shawn O. Pearce | 31af1ff | 2009-01-26 12:04:41 -0800 | [diff] [blame] | 20 | Current and past binary releases of Gerrit can be obtained from |
David Pursehouse | 8d2b4a0 | 2013-10-18 11:01:28 +0900 | [diff] [blame] | 21 | the link:https://gerrit-releases.storage.googleapis.com/index.html[ |
| 22 | Gerrit Releases site]. |
Shawn O. Pearce | 31af1ff | 2009-01-26 12:04:41 -0800 | [diff] [blame] | 23 | |
Shawn O. Pearce | 8ddb8cb | 2009-09-28 12:21:28 -0700 | [diff] [blame] | 24 | Download any current `*.war` package. The war will be referred to as |
| 25 | `gerrit.war` from this point forward, so you may find it easier to |
Anthony | d3aed4c | 2009-09-26 13:48:10 -0400 | [diff] [blame] | 26 | rename the downloaded file. |
Shawn O. Pearce | b8527ea | 2009-02-02 15:39:12 -0800 | [diff] [blame] | 27 | |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 28 | If you would prefer to build Gerrit directly from source, review |
| 29 | the notes under link:dev-readme.html[developer setup]. |
Shawn O. Pearce | 31af1ff | 2009-01-26 12:04:41 -0800 | [diff] [blame] | 30 | |
Jason Huntley | 25bbd51 | 2012-08-02 11:10:31 -0400 | [diff] [blame] | 31 | include::database-setup.txt[] |
Shawn O. Pearce | 0b91a63 | 2009-02-06 12:53:59 -0800 | [diff] [blame] | 32 | |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 33 | [[init]] |
| 34 | Initialize the Site |
| 35 | ------------------- |
Shawn O. Pearce | d2b73db | 2009-01-09 11:55:47 -0800 | [diff] [blame] | 36 | |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 37 | Gerrit stores configuration files, the server's SSH keys, and the |
| 38 | managed Git repositories under a local directory, typically referred |
| 39 | to as `'$site_path'`. If the embedded H2 database is being used, |
| 40 | its data files will also be stored under this directory. |
Shawn O. Pearce | d2b73db | 2009-01-09 11:55:47 -0800 | [diff] [blame] | 41 | |
Fredrik Luthander | 833aa74 | 2011-10-27 21:07:46 +0200 | [diff] [blame] | 42 | You also have to decide where to store your server side git repositories. This |
| 43 | can either be a relative path under `'$site_path'` or an absolute path |
| 44 | anywhere on your server system. You have to choose a place before commencing |
| 45 | your init phase. |
| 46 | |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 47 | Initialize a new site directory by running the init command, passing |
| 48 | the path of the site directory to be created as an argument to the |
| 49 | '-d' option. Its recommended that Gerrit Code Review be given its |
| 50 | own user account on the host system: |
| 51 | |
| 52 | ---- |
| 53 | sudo adduser gerrit2 |
| 54 | sudo su gerrit2 |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 55 | |
Fredrik Luthander | 833aa74 | 2011-10-27 21:07:46 +0200 | [diff] [blame] | 56 | java -jar gerrit.war init -d /path/to/your/gerrit_application_directory |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 57 | ---- |
| 58 | |
Fredrik Luthander | 833aa74 | 2011-10-27 21:07:46 +0200 | [diff] [blame] | 59 | 'Please note:' If you choose a location where your new user doesn't |
| 60 | have any privileges, you may have to manually create the directory first and |
| 61 | then give ownership of that location to the `'gerrit2'` user. |
| 62 | |
| 63 | If run from an interactive terminal, the init command will prompt through a |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 64 | series of configuration questions, including gathering information |
Fredrik Luthander | 833aa74 | 2011-10-27 21:07:46 +0200 | [diff] [blame] | 65 | about the database created above. If the terminal is not interactive, |
| 66 | running the init command will choose some reasonable default selections, |
| 67 | and will use the embedded H2 database. Once the init phase is complete, |
| 68 | you can review your settings in the file `'$site_path/etc/gerrit.config'`. |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 69 | |
Fredrik Luthander | 833aa74 | 2011-10-27 21:07:46 +0200 | [diff] [blame] | 70 | When running the init command, additional JARs might be downloaded to |
| 71 | support optional selected functionality. If a download fails a URL will |
| 72 | be displayed and init will wait for the user to manually download the JAR |
| 73 | and store it in the target location. |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 74 | |
Fredrik Luthander | 833aa74 | 2011-10-27 21:07:46 +0200 | [diff] [blame] | 75 | When the init phase is complete, the daemon will be automatically started |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 76 | in the background and your web browser will open to the site: |
| 77 | |
| 78 | ---- |
| 79 | Initialized /home/gerrit2/review_site |
| 80 | Executing /home/gerrit2/review_site/bin/gerrit.sh start |
| 81 | Starting Gerrit Code Review: OK |
| 82 | Waiting for server to start ... OK |
| 83 | Opening browser ... |
| 84 | ---- |
| 85 | |
| 86 | When the browser opens, sign in to Gerrit through the web interface. |
| 87 | The first user to sign-in and register an account will be |
| 88 | automatically placed into the fully privileged Administrators group, |
| 89 | permitting server management over the web and over SSH. Subsequent |
| 90 | users will be automatically registered as unprivileged users. |
| 91 | |
| 92 | |
Fredrik Luthander | 833aa74 | 2011-10-27 21:07:46 +0200 | [diff] [blame] | 93 | Installation Complete |
| 94 | --------------------- |
| 95 | |
| 96 | Your base Gerrit server is now installed and running. You're now ready to |
| 97 | either set up more projects or start working with the projects you've already |
| 98 | imported. |
| 99 | |
| 100 | |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 101 | [[project_setup]] |
| 102 | Project Setup |
| 103 | ------------- |
| 104 | |
| 105 | See link:project-setup.html[Project Setup] for further details on |
| 106 | how to register a new project with Gerrit. This step is necessary |
| 107 | if existing Git repositories were not imported during 'init'. |
| 108 | |
| 109 | |
Karsten Dambekalns | a7f72a2 | 2011-03-25 14:21:59 +0100 | [diff] [blame] | 110 | [[rc_d]] |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 111 | Start/Stop Daemon |
| 112 | ----------------- |
| 113 | |
| 114 | To control the Gerrit Code Review daemon that is running in the |
| 115 | background, use the rc.d style start script created by 'init': |
Shawn O. Pearce | d2b73db | 2009-01-09 11:55:47 -0800 | [diff] [blame] | 116 | |
| 117 | ==== |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 118 | review_site/bin/gerrit.sh start |
| 119 | review_site/bin/gerrit.sh stop |
| 120 | review_site/bin/gerrit.sh restart |
Shawn O. Pearce | d2b73db | 2009-01-09 11:55:47 -0800 | [diff] [blame] | 121 | ==== |
| 122 | |
David Pursehouse | 626f8b5 | 2013-10-24 13:10:56 +0900 | [diff] [blame] | 123 | ('Optional') Configure the daemon to automatically start and stop |
| 124 | with the operating system. |
| 125 | |
| 126 | Uncomment the following 3 lines in the `'$site_path/bin/gerrit.sh'` |
| 127 | script: |
| 128 | |
| 129 | ==== |
| 130 | chkconfig: 3 99 99 |
| 131 | description: Gerrit Code Review |
| 132 | processname: gerrit |
| 133 | ==== |
| 134 | |
| 135 | Then link the `gerrit.sh` script into `rc3.d`: |
Shawn O. Pearce | d2b73db | 2009-01-09 11:55:47 -0800 | [diff] [blame] | 136 | |
| 137 | ==== |
Kyle Laker | 839edfc | 2013-03-08 01:05:10 -0500 | [diff] [blame] | 138 | sudo ln -snf `pwd`/review_site/bin/gerrit.sh /etc/init.d/gerrit |
| 139 | sudo ln -snf /etc/init.d/gerrit /etc/rc3.d/S90gerrit |
Shawn O. Pearce | 86816ee | 2009-05-13 17:37:20 -0700 | [diff] [blame] | 140 | ==== |
| 141 | |
David Pursehouse | be28499 | 2013-09-26 14:43:33 +0900 | [diff] [blame] | 142 | ('Optional') To enable autocompletion of the gerrit.sh commands, install |
| 143 | autocompletion from the `/contrib/bash_completion` script. Refer to the |
| 144 | script's header comments for installation instructions. |
| 145 | |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 146 | To install Gerrit into an existing servlet container instead of using |
| 147 | the embedded Jetty server, see |
| 148 | link:install-j2ee.html[J2EE installation]. |
Shawn O. Pearce | 86816ee | 2009-05-13 17:37:20 -0700 | [diff] [blame] | 149 | |
Shawn O. Pearce | d2b73db | 2009-01-09 11:55:47 -0800 | [diff] [blame] | 150 | |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 151 | [[customize]] |
| 152 | Site Customization |
| 153 | ------------------ |
Shawn O. Pearce | d2b73db | 2009-01-09 11:55:47 -0800 | [diff] [blame] | 154 | |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 155 | Gerrit Code Review supports some site-specific customization options. |
David Pursehouse | 221d4f6 | 2012-06-08 17:38:08 +0900 | [diff] [blame] | 156 | For more information, see the related topics in this manual: |
Shawn O. Pearce | d2b73db | 2009-01-09 11:55:47 -0800 | [diff] [blame] | 157 | |
Francois Marier | d550b46 | 2011-04-13 14:30:20 +1200 | [diff] [blame] | 158 | * link:config-reverseproxy.html[Reverse Proxy] |
Shawn O. Pearce | f384b44 | 2009-01-10 16:20:56 -0800 | [diff] [blame] | 159 | * link:config-sso.html[Single Sign-On Systems] |
Dave Borowitz | 1e49e14 | 2013-04-09 12:14:57 -0700 | [diff] [blame] | 160 | * link:config-themes.html[Themes] |
Shawn O. Pearce | d2b73db | 2009-01-09 11:55:47 -0800 | [diff] [blame] | 161 | * link:config-gitweb.html[Gitweb Integration] |
Shawn O. Pearce | 7b40571 | 2009-05-08 18:27:53 -0700 | [diff] [blame] | 162 | * link:config-gerrit.html[Other System Settings] |
Sasa Zivkov | e5fc90e | 2013-05-10 15:12:13 +0200 | [diff] [blame] | 163 | * link:config-auto-site-initialization.html[Automatic Site Initialization on Startup] |
Shawn O. Pearce | d2b73db | 2009-01-09 11:55:47 -0800 | [diff] [blame] | 164 | |
Shawn O. Pearce | 0b91a63 | 2009-02-06 12:53:59 -0800 | [diff] [blame] | 165 | |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 166 | [[anonymous_access]] |
| 167 | Anonymous Access |
| 168 | ---------------- |
Shawn O. Pearce | d2b73db | 2009-01-09 11:55:47 -0800 | [diff] [blame] | 169 | |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 170 | Exporting the Git repository directory |
| 171 | (link:config-gerrit.html#gerrit.basePath[gerrit.basePath]) over the |
| 172 | anonymous, unencrypted git:// protocol is more efficient than |
| 173 | Gerrit's internal SSH daemon. See the `git-daemon` documentation |
| 174 | for details on how to configure this if anonymous access is desired. |
Shawn O. Pearce | d2b73db | 2009-01-09 11:55:47 -0800 | [diff] [blame] | 175 | |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 176 | * http://www.kernel.org/pub/software/scm/git/docs/git-daemon.html[man git-daemon] |
Shawn O. Pearce | b546c9b | 2009-02-24 13:12:39 -0800 | [diff] [blame] | 177 | |
| 178 | |
Martin Fick | 472bb9d | 2012-05-08 16:30:16 -0700 | [diff] [blame] | 179 | [[plugins]] |
| 180 | Plugins |
| 181 | ------- |
| 182 | |
| 183 | Place Gerrit plugins in the review_site/plugins directory to have them loaded on Gerrit startup. |
| 184 | |
| 185 | |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 186 | External Documentation Links |
| 187 | ---------------------------- |
Shawn O. Pearce | d2b73db | 2009-01-09 11:55:47 -0800 | [diff] [blame] | 188 | |
Shawn O. Pearce | 9ad8ba5 | 2009-12-11 19:06:21 -0800 | [diff] [blame] | 189 | * http://www.postgresql.org/docs/[PostgreSQL Documentation] |
| 190 | * http://dev.mysql.com/doc/[MySQL Documentation] |
| 191 | * http://www.kernel.org/pub/software/scm/git/docs/git-daemon.html[git-daemon] |
Shawn O. Pearce | d2b73db | 2009-01-09 11:55:47 -0800 | [diff] [blame] | 192 | |
Shawn O. Pearce | 5500e69 | 2009-05-28 15:55:01 -0700 | [diff] [blame] | 193 | |
| 194 | GERRIT |
| 195 | ------ |
| 196 | Part of link:index.html[Gerrit Code Review] |