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