Linaro Git Browser
Code Review Sign In
review.linaro.org / infrastructure / cgit.git / e2416259efe8b9bdad9be9597b1a79443dafdb4e / . / README
blob: 0c35f96972cfa5fdf47e9c2672297d935b812d6d [file] [log] [blame]
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]1cgit - CGI for Git
2==================
Lars Hjemli25105d72006-12-10 22:31:36 +0100[diff] [blame]3
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]4This is an attempt to create a fast web interface for the Git SCM, using a
5built-in cache to decrease server I/O pressure.
Lars Hjemli25105d72006-12-10 22:31:36 +0100[diff] [blame]6
Lars Hjemli66414b62007-01-28 13:18:23 +0100[diff] [blame]7Installation
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]8------------
Lars Hjemli66414b62007-01-28 13:18:23 +0100[diff] [blame]9
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]10Building cgit involves building a proper version of Git. How to do this
Lars Hjemlibd8e8a32007-09-04 11:49:40 +0200[diff] [blame]11depends on how you obtained the cgit sources:
12
13a) If you're working in a cloned cgit repository, you first need to
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]14initialize and update the Git submodule:
Lars Hjemlibd8e8a32007-09-04 11:49:40 +0200[diff] [blame]15
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]16 $ git submodule init # register the Git submodule in .git/config
17 $ $EDITOR .git/config # if you want to specify a different url for git
18 $ git submodule update # clone/fetch and checkout correct git version
Lars Hjemlibd8e8a32007-09-04 11:49:40 +0200[diff] [blame]19
20b) If you're building from a cgit tarball, you can download a proper git
21version like this:
22
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]23 $ make get-git
Lars Hjemlibd8e8a32007-09-04 11:49:40 +0200[diff] [blame]24
25When either a) or b) has been performed, you can build and install cgit like
26this:
27
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]28 $ make
29 $ sudo make install
Lars Hjemli5a217ed2007-05-11 12:13:15 +0200[diff] [blame]30
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]31This will install `cgit.cgi` and `cgit.css` into `/var/www/htdocs/cgit`. You
32can configure this location (and a few other things) by providing a `cgit.conf`
Lars Hjemlibd8e8a32007-09-04 11:49:40 +0200[diff] [blame]33file (see the Makefile for details).
Lars Hjemli66414b62007-01-28 13:18:23 +0100[diff] [blame]34
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]35Dependencies
36------------
Lars Hjemlic52e8412007-02-04 23:57:34 +0100[diff] [blame]37
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]38* git 1.7.4
39* zip lib
40* crypto lib
41* openssl lib
Lars Hjemli5a217ed2007-05-11 12:13:15 +0200[diff] [blame]42
43Apache configuration
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]44--------------------
Lars Hjemli5a217ed2007-05-11 12:13:15 +0200[diff] [blame]45
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]46A new `Directory` section must probably be added for cgit, possibly something
Lars Hjemli5a217ed2007-05-11 12:13:15 +0200[diff] [blame]47like this:
Lars Hjemlic52e8412007-02-04 23:57:34 +0100[diff] [blame]48
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]49 <Directory "/var/www/htdocs/cgit/">
50 AllowOverride None
51 Options +ExecCGI
52 Order allow,deny
53 Allow from all
54 </Directory>
Lars Hjemli66414b62007-01-28 13:18:23 +0100[diff] [blame]55
56
57Runtime configuration
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]58---------------------
Lars Hjemli66414b62007-01-28 13:18:23 +0100[diff] [blame]59
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]60The file `/etc/cgitrc` is read by cgit before handling a request. In addition
Lars Hjemli2a0c9dc2011-06-13 13:24:46 +0000[diff] [blame]61to runtime parameters, this file may also contain a list of repositories
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]62displayed by cgit (see `cgitrc.5.txt` for further details).
Lars Hjemli66414b62007-01-28 13:18:23 +0100[diff] [blame]63
64The cache
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]65---------
Lars Hjemli66414b62007-01-28 13:18:23 +0100[diff] [blame]66
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]67When cgit is invoked it looks for a cache file matching the request and
68returns it to the client. If no such cache file exists (or if it has expired),
69the content for the request is written into the proper cache file before the
Lars Hjemli66414b62007-01-28 13:18:23 +0100[diff] [blame]70file is returned.
71
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]72If the cache file has expired but cgit is unable to obtain a lock for it, the
73stale cache file is returned to the client. This is done to favour page
Lars Hjemlidcef2572006-12-13 02:06:29 +0100[diff] [blame]74throughput over page freshness.
Lars Hjemli25105d72006-12-10 22:31:36 +0100[diff] [blame]75
Lars Hjemli66414b62007-01-28 13:18:23 +0100[diff] [blame]76The generated content contains the complete response to the client, including
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]77the HTTP headers `Modified` and `Expires`.
Lars Hjemli5a217ed2007-05-11 12:13:15 +0200[diff] [blame]78
Lars Hjemli2a0c9dc2011-06-13 13:24:46 +0000[diff] [blame]79Online presence
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]80---------------
Lars Hjemli5a217ed2007-05-11 12:13:15 +0200[diff] [blame]81
Jason A. Donenfeldcd42ded2013-05-27 21:56:57 +0200[diff] [blame]82* The cgit homepage is hosted by cgit at <http://git.zx2c4.com/cgit/about/>
Lars Hjemli5a217ed2007-05-11 12:13:15 +0200[diff] [blame]83
Lukas Fleischere2416252014-01-08 19:45:29 +0100[diff] [blame^]84* Patches, bug reports, discussions and support should go to the cgit
Jason A. Donenfeld72f89912013-05-13 14:00:50 +0200[diff] [blame]85 mailing list: <cgit@lists.zx2c4.com>. To sign up, visit
86 <http://lists.zx2c4.com/mailman/listinfo/cgit>