Annotation of cvsweb/INSTALL, Revision 3.31
3.3 knu 1: $FreeBSD$
3.2 knu 2:
3.29 scop 3: For notes on upgrading between FreeBSD-CVSweb releases, see the bottom
4: of this document.
3.17 scop 5:
3.16 scop 6: 1) To get cvsweb.cgi to work, make sure that you have Perl 5.6.0 or
3.7 scop 7: newer installed and a web server which is capable of executing CGI
3.18 scop 8: scripts. See also samples/cvsweb-httpd.conf.
3.7 scop 9:
3.10 scop 10: CVSweb uses the following Perl modules. Chances are that some of
3.7 scop 11: these are already installed with your Perl distribution. The oldest
12: Perl distributions, if any, that already ship with these modules have
13: been marked below. If your Perl doesn't have some of the modules,
14: you can get them from CPAN, <http://www.cpan.org/>. Be sure to
15: install also the prerequisites these modules may have. Note that
16: this list contains only modules that aren't already part of Perl
3.16 scop 17: 5.6.0 and newer.
3.17 scop 18:
3.7 scop 19:
3.11 scop 20: Module Version Ships with Perl Type
21: ----------------------------------------------------------
22: File::Temp 5.8.0 required
3.12 scop 23: IPC::Run N/A required
3.11 scop 24: MIME::Types N/A optional
3.13 scop 25: String::Ediff N/A optional
3.15 scop 26: URI N/A required
3.1 knu 27:
3.4 scop 28: Surprisingly enough, you need to have cvs installed. The recommended
29: version of cvs is 1.11 or newer. Older cvs versions may work with
30: more or less quirks, YMMV.
31:
32: Currently, you'll also need to have the GNU RCS utilities 'rlog',
3.17 scop 33: 'rcsdiff' installed (current version is 5.7).
3.1 knu 34:
3.6 scop 35: This may change if cvs will be able to serve these functions without
36: having a working directory [see TODO].
3.1 knu 37:
3.6 scop 38: Note that the cvsweb.cgi script needs to have physical access to the
39: repository (or a copy of it) therefore; rsh, ssh or pserver access
40: doesn't work yet.
41:
3.20 scop 42: Install CvsGraph if you want to use it with CVSweb, and see (6) for
3.8 scop 43: configuration notes. CvsGraph 1.4.0 or newer is required.
3.5 scop 44:
3.9 scop 45: Install GNU Enscript if you want syntax highlighting, and see (7) for
3.19 scop 46: more info. You'll need version 1.6.3 or newer.
3.9 scop 47:
3.29 scop 48: Install CVSHistory if you want to use it with CVSweb, and see (8) for
49: configuration notes. You'll need version 2.0 or newer.
50:
3.17 scop 51: 2) Copy cvsweb.conf to a configuration directory, typically
52: /usr/local/etc/cvsweb/cvsweb.conf.
53: Edit cvsweb.conf to fit your needs, you'll probably need to tweak the
54: CVS root(s) of the Repository(ies) you want to view.
3.26 scop 55: See also the @command_path variable for the path where cvsweb.cgi
3.17 scop 56: looks for the various external executables it interacts with.
3.26 scop 57: The other cvsweb.conf-* files are example per-cvsroot configuration files,
58: see commentary in cvsweb.conf for more information.
3.17 scop 59:
60: 3) Copy cvsweb.cgi to a directory of your web server where the execution
61: of CGI scripts is allowed. Edit it to make the variable $config
62: (look for 'Configuration Area') point to your configuration file.
3.4 scop 63: If your perl binary isn't located in /usr/bin you'll have to edit the
3.26 scop 64: first line of the script as well. For Apache web servers, there is an
65: optional sample httpd.conf snippet in the samples/ directory. Most
66: setups do not need it though, it is only for advanced and/or mod_perl
67: configurations.
3.1 knu 68:
3.4 scop 69: 4) If you do not have the dir.gif, text.gif and back.gif icons, copy
70: them somewhere in your $DocumentRoot and edit the %ICONS hash
71: in cvsweb.conf. You won't need to do this if you have a stock
72: Apache installed - they're located in the default icons directory.
3.1 knu 73: The icons distributed with this cvsweb are in the public domain.
3.4 scop 74: If you think that the default icons are too large, use the corresponding
75: mini icons in the icons/ directory and change the %ICONS hash in
3.1 knu 76: cvsweb.conf.
77:
3.6 scop 78: 5) Copy cvsweb.css from the css/ directory to a web server directory, and
79: point the $cssurl variable in cvsweb.conf to it.
80:
81: 6) CvsGraph <http://www.akhphd.au.dk/~bertho/cvsgraph/> can be used with
3.20 scop 82: this version of CVSweb. See the $allow_cvsgraph and $cvsgraph_config
3.28 scop 83: configuration variables in cvsweb.conf. Note (and install) also the
84: cvsgraph.png icon in the icons/ directory.
3.5 scop 85:
3.9 scop 86: 7) GNU Enscript <http://www.iki.fi/~mtr/genscript/> can be used for syntax
3.27 scop 87: highlighting. To enable it, copy lang_cvsweb.st and lang_cvsweb_diff.st
88: from the enscript/ dir to your Enscript "hl" directory (often eg.
89: /usr/share/enscript/hl/) and enable $allow_enscript in cvsweb.conf.
90: lang_cvsweb.st is used for generic colorization, and lang_cvsweb_diff.st
91: for diffs.
3.9 scop 92:
3.29 scop 93: 8) CVSHistory <http://www.jamwt.com/CVSHistory/> can be used with this
94: version of CVSweb. See the $cvshistory_url configuration variable in
95: cvsweb.conf. For best results, configure CVSweb and CVSHistory to use
96: the same "logical names" for CVS roots.
3.1 knu 97:
3.17 scop 98: 9) 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
3.17 scop 104: - Edit descriptions. Add one line for each directory that you would like
3.1 knu 105: to have a comment for. You can have HTML in the descriptions.
106: These lines are relative from the $CVSROOT. Example:
3.22 scop 107: JVote An application to assist with <a href="http://www.irtc.org/">IRTC</a> voting
3.3 knu 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:
3.29 scop 114: 10) Have fun!
3.1 knu 115:
3.17 scop 116: Troubleshooting
117: ---------------
3.1 knu 118:
119: If you've trouble to make cvsweb.cgi work ...
120: .. if nothing seems to work:
3.17 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
3.4 scop 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.
3.17 scop 126: o View the entries in the web server's 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
3.17 scop 131: CVS repository. The CGI script often runs as the user 'nobody'
132: or 'httpd'.
133: o If you use annotation, see @annotate_options in cvsweb.conf.
134: o See CVSROOT/config for various options controlling what gets written
135: into CVSROOT/history, where lock files are placed etc. You can also
136: build a fake cvsroot with symlinks to the 'real' CVS directories and make
3.1 knu 137: a fake CVSROOT/history as symbolic link to /dev/null.
3.17 scop 138: If you don't want cvs called from cvsweb to place read locks at all, let
3.1 knu 139: cvsweb operate on a copy.
3.17 scop 140: o Does cvsweb find your RCS utils/cvs binary(annotate)?
141: See $command_path in in cvsweb.conf.
142: o cvsweb allows for compression now. It is determined first if the
143: browser accepts gzip encoding. But - no rule without exception - some
144: versions of MSIE claim to understand gzip encoded content but
145: display garbage .. so compression for MSIE is disabled now. Maybe you
146: find another browser with this problem, then you should disable
147: compression ($allow_compress=0 in cvsweb.conf) and report it to
148: <freebsd-cvsweb@freebsd.org>.
149:
3.31 ! scop 150: Upgrade instructions
! 151: --------------------
! 152:
! 153: List of things to pay attention to when upgrading FreeBSD-CVSweb from an
! 154: earlier version follows. Lack of instructions for a particular version
! 155: means that there are no special things to worry about.
! 156:
! 157: Upgrading from 3.0.0 to 3.0.1
! 158: -----------------------------
3.29 scop 159:
160: The following configuration variables in cvsweb.conf have changed:
161:
162: $cvshistory_url is new, and optional. See comments in cvsweb.conf.
3.17 scop 163:
3.31 ! scop 164: Upgrading from 2.0.x to 3.0.0
! 165: -----------------------------
3.17 scop 166:
167: Make sure that the dependencies are met, see 1) above.
168:
169: The following configuration variables in cvsweb.conf have changed:
170:
3.24 scop 171: $command_path has been changed to @command_path, ie. a list.
172:
3.25 scop 173: @HideModules has been removed. It had nothing to do with actual
174: modules in CVS terminology, and the implementation was broken.
175: @ForbiddenFiles has been enhanced to affect directories as well.
176:
3.17 scop 177: $cvstreedefault is now optional. If unset, the first one in
178: @CVSrepositories is used.
179:
180: %DEFAULTVALUE for "f" (default diff format) now understands the values
3.22 scop 181: "uc", "cc" and "sc" for enscript-colored diffs (unified, context and
182: side-by-side respectively).
3.17 scop 183:
184: %DEFAULTVALUE for "ln" can now be set to a boolean indicating whether
185: line numbers in markup views should be shown or not. The default is off.
186:
3.20 scop 187: The following parameters have been removed, use CSS instead:
3.17 scop 188: $body_tag, $body_tag_for_src, $navigationHeaderColor, $dirtable,
189: @tabcolors, $columnHeaderColorDefault, $columnHeaderColorSorted,
190: $tableBorderColor, $diffcolorHeading, $diffcolorEmpty, $diffcolorRemove,
191: $diffcolorChange, $diffcolorAdd, $diffcolorDarkChange, $difffontface,
192: $difffontsize, $markupLogColor.
3.20 scop 193:
194: The following parameters have been removed, with no replacement:
3.21 scop 195: $open_extern_window, $extern_window_height, $extern_window_width,
196: $checkout_magic.
3.17 scop 197:
198: $allow_enscript, @enscript_options and %enscript_types control the use
199: and behavior of enscript(1).
200:
201: $allow_cvsgraph and $cvsgraph_config control the use and behavior of
202: cvsgraph(1).
203:
204: $file_list_len can be set to work around problems with rlog(1) and dirs
205: with lots of files.
206:
207: $cssurl contains the absolute URI to the CSS file to use.
208:
209: %ICONS has two new entries: binfile for binary files (-kb keyword
210: substitution) and graph for the cvsgraph icon.
3.23 scop 211:
212: %DIFF_COMMANDS is new, it is used to configure external per file type
213: diff commands.
CVSweb