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