blob: 416c34c5b7cbe5853b95330bf3a332047c4c8f6f [file] [log] [blame]
Shawn O. Pearced2b73db2009-01-09 11:55:47 -08001Gerrit2 - Gitweb Integration
2============================
3
4Gerrit2 can generate hyperlinks to gitweb, allowing users to jump
5from Gerrit content to the same information, but shown by gitweb.
6
Shawn O. Pearced7ba11f2009-06-01 09:35:41 -07007To enable the gitweb integration, set gitweb.url with the URL of
8your gitweb CGI.
Shawn O. Pearced2b73db2009-01-09 11:55:47 -08009
Shawn O. Pearce9743d0b2009-06-01 10:10:06 -070010The CGI's `$projectroot` should be the same directory as
11gerrit.basePath, or a fairly current replica. If a replica is
12being used, ensure it uses a full mirror, so the `refs/changes/*`
13namespace is available.
Shawn O. Pearced2b73db2009-01-09 11:55:47 -080014
15====
Shawn O. Pearced7ba11f2009-06-01 09:35:41 -070016 git config --file=$site_path/gerrit.config gitweb.url http://example.com/gitweb.cgi
Shawn O. Pearced2b73db2009-01-09 11:55:47 -080017====
18
Shawn O. Pearced7ba11f2009-06-01 09:35:41 -070019After updating `'$site_path'/gerrit.config`, the Gerrit server must
20be restarted and clients must reload the host page to see the change.
Shawn O. Pearced2b73db2009-01-09 11:55:47 -080021
22Access Control
23--------------
24
25Gitweb access controls can be implemented using standard web server
26access controls. This isn't typically integrated with Gerrit's own
27access controls. Caution must be taken to ensure the controls are
28consistent if access needs to be restricted.
29
30Caching Gitweb
31--------------
32
33If your repository set is large and you are expecting a lot
34of users, you may want to look at the caching forks used by
35high-traffic sites like kernel.org or repo.or.cz.
Shawn O. Pearce5500e692009-05-28 15:55:01 -070036
Shawn O. Pearced7ba11f2009-06-01 09:35:41 -070037See Also
38--------
39
40* link:config-gerrit.html#section_gitweb[Section gitweb]
41
Shawn O. Pearce5500e692009-05-28 15:55:01 -070042GERRIT
43------
44Part of link:index.html[Gerrit Code Review]