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