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