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