git-browser.cgi: fix handling of latin-1 characters
[git-browser-mirror.git] / README
blob3101286d1b3761fbccaf56242c1fb628dbff27c7
1 This is experimental web interface for git, complementary to gitweb. 
2 It visualizes commit history graph and shows commit diffs.
3 It works in firefox, IE6 and Opera 8. It is not tested 
4 and most probably broken in any other browser. 
5 Since all UI is done in heavy javascript, 
6 it's rather demanding for resources on client side.
8 SETUP
10 cp *.html *.js *.pl *.css js.lib/* JSON/* <server-dir>
12 make sure that git-browser.pl and git-diff.pl are runnable as cgi scripts
13 make sure that html files are served as having UTF-8 charset
15 git-browser.pl checks the current directory for git-browser.conf,
16 if this file does not exists it looks for /etc/git-browser.conf
17 Everything in the file is optional, but with empty repository list 
18 git browser will show nothing. Sample variant of git-browser.conf
19 is provided as git-browser.conf.sample.
21 Format of the file:
23 path: overrides your $PATH
24 gitbin: <path to git binary, including the executable name>
25 git_temp: <path where git-diff.pl will create temp files>
26 http_expires: <value for CGI::header 'expires' parameter, for every responce>
27 warehouse: <path to fallback dir where to look for repos>
28 repos:
29 <repo-name> <repo GIT_DIR>
30 ...
32 Also, there is client-side configuration in GitConfig.js. This is used
33 for configuring gitweb URL in order to create proper links from commits.