[BACK]Return to INSTALL CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / cvsweb

Annotation of cvsweb/INSTALL, Revision 3.12

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