Annotation of cvsweb/INSTALL, Revision 3.6
3.3 knu 1: $FreeBSD$
3.2 knu 2:
3.1 knu 3: 1) To get cvsweb.cgi to work, make sure that you
3.4 scop 4: have Perl 5 installed and a web server which is capable
5: of executing cgi-scripts.
3.1 knu 6:
3.4 scop 7: Surprisingly enough, you need to have cvs installed. The recommended
8: version of cvs is 1.11 or newer. Older cvs versions may work with
9: more or less quirks, YMMV.
10:
11: Currently, you'll also need to have the GNU RCS utilities 'rlog',
3.1 knu 12: 'rcsdiff' installed (current version is 5.7).
13:
3.6 ! scop 14: This may change if cvs will be able to serve these functions without
! 15: having a working directory [see TODO].
3.1 knu 16:
3.6 ! scop 17: Note that the cvsweb.cgi script needs to have physical access to the
! 18: repository (or a copy of it) therefore; rsh, ssh or pserver access
! 19: doesn't work yet.
! 20:
! 21: Install CvsGraph if you want to use it with CVSWeb, and see (6) for
3.5 scop 22: configuration notes. This has been tested with CvsGraph 1.3.0.
23:
3.4 scop 24: 2) Copy cvsweb.conf to your configuration directory. If
3.1 knu 25: you've installed Apache, $ServerRoot/conf (or $ServerRoot/etc
26: with versions >= 1.3.0) makes sense.
27: Edit cvsweb.conf to fit your needs, esp. set the CVS-Root(s)
28: of the Repository(ies) you want to view.
29: If your RCS utilities are not in the $PATH of the cgi execution
30: environment you need to set it in the 'Misc' section as well.
31:
3.4 scop 32: 3) Copy cvsweb.cgi to the cgi script location of your web server.
3.1 knu 33: Edit it to make the variable $config (look for 'Configuration Area')
34: point to your configuration file.
3.4 scop 35: If your perl binary isn't located in /usr/bin you'll have to edit the
3.1 knu 36: first line of the script as well.
3.6 ! scop 37: If you want to run cvsweb.cgi on Windows NT, see (8).
3.1 knu 38:
3.4 scop 39: 4) If you do not have the dir.gif, text.gif and back.gif icons, copy
40: them somewhere in your $DocumentRoot and edit the %ICONS hash
41: in cvsweb.conf. You won't need to do this if you have a stock
42: Apache installed - they're located in the default icons directory.
3.1 knu 43: The icons distributed with this cvsweb are in the public domain.
3.4 scop 44: If you think that the default icons are too large, use the corresponding
45: mini icons in the icons/ directory and change the %ICONS hash in
3.1 knu 46: cvsweb.conf.
47:
3.6 ! scop 48: 5) Copy cvsweb.css from the css/ directory to a web server directory, and
! 49: point the $cssurl variable in cvsweb.conf to it.
! 50:
! 51: 6) CvsGraph <http://www.akhphd.au.dk/~bertho/cvsgraph/> can be used with
3.5 scop 52: this version of CVSWeb. See the $allow_cvsgraph and $cvsgraph_config
53: configuration variables in cvsweb.conf. cvsweb.cgi will override some
54: of the settings in the cvsgraph configuration file with command line
55: options; the following in particular: map_branch_href, map_rev_href and
56: map_diff_href so you won't have to tweak them for CVSWeb. Note (and
57: install) also the cvsgraph.png icon in the icons/ directory.
58:
3.6 ! scop 59: 7) Have fun!
3.1 knu 60:
3.6 ! scop 61: 8) If you've Windows NT running, calling of external programs with parameters
3.1 knu 62: single quoted doesn't work (search for rcsdiff, rlog in
3.4 scop 63: cvsweb.cgi), you've to replace it with double quotes. Thanks to
64: Nick Brachet for pointing this out.
3.1 knu 65: I don't know if cvs-annotate works on NT.
66:
67: > From: Nick Brachet <nick@gradient.com>
68: [...]
69: > I'm running NT <g> and I had to patch a few things. For example,
70: > open(RCS, "co -p$rev '$fullname' 2>&1 |")
71: > will fail on NT because the ' are not recognized. Using " will work
72: > though.
73:
3.6 ! scop 74: 9) If you like you can add descriptions to be shown next to each directory
3.4 scop 75: or module name. These are read from CVSROOT/descriptions.
3.1 knu 76:
77: - Check out a copy of your CVSROOT
78: - edit checkoutlist and add a line that says
79: descriptions
80: - edit descriptions. Add one line for each directory that you would like
81: to have a comment for. You can have HTML in the descriptions.
82: These lines are relative from the $CVSROOT. Example:
3.3 knu 83: JVote An application to assist with <A HREF="http://www.irtc.org/">IRTC</A> voting
84: JVote/images Store the images for JVote
85: JVote/tools Scripts to startup JVote
3.1 knu 86: - cvs add descriptions
87: - cvs commit
88: - Set $use_descriptions to 1 in cvsweb.conf.
89:
90: --------------------
91:
92: if you got PROBLEMS ..
93: ----------------------
94:
95: If you've trouble to make cvsweb.cgi work ...
96: .. if nothing seems to work:
3.4 scop 97: o Check if you can execute CGI-scripts (Apache needs to have an
98: ScriptAlias /cgi-bin or cgi-script Handler defined). Try to
99: execute a simple CGI script that often comes with the distribution
100: of the web server; locate the log files and try to find hints
101: which explain the malfunction.
102: o View the entries in the web servers error.log
3.1 knu 103:
104: .. If cvsweb seems to work but doesn't show the expected result
105: (Typical error: you can't see any files)
3.4 scop 106: o Check whether the CGI script has read permissions to your
107: CVS-Repository. The CGI script often runs as the user 'nobody'
108: or 'httpd'...
109: If you use annotation, the user needs to have write permissions
3.1 knu 110: to CVSROOT/history and to the directory the file is in in order
111: to place the read-lock.
3.4 scop 112: If you don't want cvsweb to write into your CVSROOT/history, build
3.1 knu 113: a fake cvsroot with symlinks to the 'real' CVS-directories and make
114: a fake CVSROOT/history as symbolic link to /dev/null.
3.4 scop 115: If you don't want cvs called from cvsweb to place read-locks - let
3.1 knu 116: cvsweb operate on a copy.
3.4 scop 117: o Does cvsweb find your RCS-utils/cvs-binary(annotate) ? ($ENV{PATH} in
3.1 knu 118: cvsweb.conf !)
3.4 scop 119: o cvsweb allows for compression now. It is determined first,
120: if the browser accepts gzip-encoding. But - no rule without
3.1 knu 121: exception - MSIE claims to understand gzip encoded content but
3.4 scop 122: displays garbage .. so MSIE is disabled now. Maybe you find another
3.1 knu 123: Browser with this problem, then you should disable compression
3.4 scop 124: ($allow_compress=0 in cvsweb.conf) and
3.1 knu 125: report it to me (<zeller@think.de>)
CVSweb