"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "INSTALL" between
viewvc-1.1.28.tar.gz and viewvc-1.2.1.tar.gz

About: ViewVC is a browser interface for CVS and Subversion version control repositories.

INSTALL  (viewvc-1.1.28):INSTALL  (viewvc-1.2.1)
skipping to change at line 19 skipping to change at line 19
ENABLING SYNTAX COLORATION ENABLING SYNTAX COLORATION
CVSGRAPH CONFIGURATION CVSGRAPH CONFIGURATION
IF YOU HAVE PROBLEMS... IF YOU HAVE PROBLEMS...
TO THE IMPATIENT TO THE IMPATIENT
---------------- ----------------
Congratulations on getting this far. :-) Congratulations on getting this far. :-)
Required Software And Configuration Needed To Run ViewVC: Required Software And Configuration Needed To Run ViewVC:
For CVS Support: In General:
* Python 1.5.2 or later (sorry, no 3.x support yet) * Python 2, version 2.4 or later (sorry, no 3.x support yet)
(http://www.python.org/) (http://www.python.org/)
For CVS Support:
* RCS, Revision Control System * RCS, Revision Control System
(http://www.cs.purdue.edu/homes/trinkle/RCS/) (http://www.cs.purdue.edu/homes/trinkle/RCS/)
* GNU-diff to replace diff implementations without the -u option * GNU-diff to replace diff implementations without the -u option
(http://www.gnu.org/software/diffutils/diffutils.html) (http://www.gnu.org/software/diffutils/diffutils.html)
* read-only, physical access to a CVS repository * read-only, physical access to a CVS repository
(See http://www.cvshome.org/ for more information) (See http://www.cvshome.org/ for more information)
For Subversion Support: For Subversion Support:
* Python 2.0 or later (sorry, no 3.x support yet)
(http://www.python.org/)
* Subversion, Version Control System, 1.3.1 or later * Subversion, Version Control System, 1.3.1 or later
(binary installation and Python bindings) (binary installation and Python bindings)
(http://subversion.apache.org/) (http://subversion.apache.org/)
Optional: Optional:
* a web server capable of running CGI programs * a web server capable of running CGI programs
(for example, Apache at http://httpd.apache.org/) (for example, Apache at http://httpd.apache.org/)
* MySQL 3.22 and MySQLdb 0.9.0 or later to create a commit database * MySQL 3.22 and MySQLdb 0.9.0 or later to create a commit database
(http://www.mysql.com/) (http://www.mysql.com/)
skipping to change at line 194 skipping to change at line 195
<Directory <VIEWVC_INSTALLATION_DIRECTORY>> <Directory <VIEWVC_INSTALLATION_DIRECTORY>>
# For Apache 2.4.x, use this: # For Apache 2.4.x, use this:
Require all granted Require all granted
# For Apache 2.2.x, use these instead: # For Apache 2.2.x, use these instead:
# Order allow,deny # Order allow,deny
# Allow from all # Allow from all
</Directory> </Directory>
For example, if ViewVC is installed in /usr/local/viewvc-1.0 on For example, if ViewVC is installed in /usr/local/viewvc-1.2 on
your system: your system:
<Directory /usr/local/viewvc-1.0> <Directory /usr/local/viewvc-1.2>
# For Apache 2.4.x, use this: # For Apache 2.4.x, use this:
Require all granted Require all granted
# For Apache 2.2.x, use these instead: # For Apache 2.2.x, use these instead:
# Order allow,deny # Order allow,deny
# Allow from all # Allow from all
</Directory> </Directory>
3) Configure Apache to expose ViewVC to users at the URL of your choice. 3) Configure Apache to expose ViewVC to users at the URL of your choice.
skipping to change at line 222 skipping to change at line 223
METHOD A: CGI mode via ScriptAlias METHOD A: CGI mode via ScriptAlias
----------------------------------- -----------------------------------
The ScriptAlias directive is very useful for pointing The ScriptAlias directive is very useful for pointing
directly to the viewvc.cgi script. Simply insert a line containing directly to the viewvc.cgi script. Simply insert a line containing
ScriptAlias /viewvc <VIEWVC_INSTALLATION_DIRECTORY>/bin/cgi/viewvc.cgi ScriptAlias /viewvc <VIEWVC_INSTALLATION_DIRECTORY>/bin/cgi/viewvc.cgi
into your httpd.conf file. Choose the location in httpd.conf where into your httpd.conf file. Choose the location in httpd.conf where
also the other ScriptAlias lines reside. Some examples: also the other ScriptAlias lines reside. Some examples:
ScriptAlias /viewvc /usr/local/viewvc-1.0/bin/cgi/viewvc.cgi ScriptAlias /viewvc /usr/local/viewvc-1.2/bin/cgi/viewvc.cgi
ScriptAlias /query /usr/local/viewvc-1.0/bin/cgi/query.cgi
---------------------------------------- ----------------------------------------
METHOD B: CGI mode in cgi-bin directory METHOD B: CGI mode in cgi-bin directory
---------------------------------------- ----------------------------------------
Copy the CGI scripts from Copy the CGI scripts from
<VIEWVC_INSTALLATION_DIRECTORY>/bin/cgi/*.cgi <VIEWVC_INSTALLATION_DIRECTORY>/bin/cgi/*.cgi
to the /cgi-bin/ directory configured in your httpd.conf file. to the /cgi-bin/ directory configured in your httpd.conf file.
You can override configuration file location using: You can override configuration file location using:
skipping to change at line 274 skipping to change at line 274
SetEnv VIEWVC_CONF_PATHNAME /etc/viewvc.conf SetEnv VIEWVC_CONF_PATHNAME /etc/viewvc.conf
NOTE: If you are using Mod_Python under Apache 1.3 the tarball generation NOTE: If you are using Mod_Python under Apache 1.3 the tarball generation
feature may not work because it uses multithreading. This works fine feature may not work because it uses multithreading. This works fine
under Apache 2. under Apache 2.
---------------------------------------- ----------------------------------------
METHOD E: Using mod_wsgi (if installed) METHOD E: Using mod_wsgi (if installed)
---------------------------------------- ----------------------------------------
Copy the Python scripts file from Copy the Python scripts file from
<VIEWVC_INSTALLATION_DIRECTORY>/bin/mod_python/ <VIEWVC_INSTALLATION_DIRECTORY>/bin/wsgi/
to the directory of your choosing. Modify httpd.conf with the to the directory of your choosing. Modify httpd.conf with the
following directives: following directives:
WSGIScriptAlias /viewvc <VIEWVC_INSTALLATION_DIRECTORY>/bin/wsgi/viewvc.ws gi WSGIScriptAlias /viewvc <VIEWVC_INSTALLATION_DIRECTORY>/bin/wsgi/viewvc.ws gi
WSGIScriptAlias /query <VIEWVC_INSTALLATION_DIRECTORY>/bin/wsgi/query.wsgi
You'll probably also need the following directive because of the You'll probably also need the following directive because of the
not-quite-sanctioned way that ViewVC manipulates Python objects. not-quite-sanctioned way that ViewVC manipulates Python objects.
WSGIApplicationGroup %{GLOBAL} WSGIApplicationGroup %{GLOBAL}
NOTE: WSGI support in ViewVC is at this time quite rudimentary, NOTE: WSGI support in ViewVC is at this time quite rudimentary,
bordering on downright experimental. Your mileage may vary. bordering on downright experimental. Your mileage may vary.
----------------------------------------- -----------------------------------------
skipping to change at line 314 skipping to change at line 313
as well as the fcgi server from Python's flup package: as well as the fcgi server from Python's flup package:
http://pypi.python.org/pypi/flup http://pypi.python.org/pypi/flup
http://trac.saddi.com/flup http://trac.saddi.com/flup
The following are some example httpd.conf fragments you can use to The following are some example httpd.conf fragments you can use to
support this configuration: support this configuration:
ScriptAlias /viewvc /usr/local/viewvc/bin/wsgi/viewvc.fcgi ScriptAlias /viewvc /usr/local/viewvc/bin/wsgi/viewvc.fcgi
ScriptAlias /query /usr/local/viewvc/bin/wsgi/query.fcgi
4) [Optional] Add access control. 4) [Optional] Provide direct access to icons, stylesheets, etc.
ViewVC's HTML templates reference various stylesheets and icons
provided by ViewVC itself. By default, ViewVC generates URLs to
those artifacts which point back into ViewVC (using a magic
syntax); ViewVC in turn handles such magic URL requests by
streaming back the contents of the requested icon or stylesheet
file. While this simplifies the configuration and initial
deployment of ViewVC, it's not the most efficient approach to
deliver what is essentially static content.
To improve performance, consider carving out a URL space in your
webserver's configuration solely for this static content and
instruct ViewVC to use that space when generating URLs for that
content. For example, you might add an Alias such as the following
to your httpd.conf:
Alias /viewvc-docroot /usr/local/viewvc/templates/default/docroot
And then, in viewvc.conf, set the 'docroot' option to the same
location:
docroot = /viewvc-docroot
WARNING: As always when using Alias directives, be careful that you
have them in the correct order. For example, if you use an
ordering such as the following, Apache will hand requests for your
static documents off to ViewVC as if they were versioned resources:
ScriptAlias /viewvc /usr/local/viewvc/bin/wsgi/viewvc.fcgi
Alias /viewvc/static /usr/local/viewvc/templates/default/docroot
The correct order would be:
Alias /viewvc/static /usr/local/viewvc/templates/default/docroot
ScriptAlias /viewvc /usr/local/viewvc/bin/wsgi/viewvc.fcgi
(That said, it's best to avoid such namespace nesting altogether if
you can.)
5) [Optional] Add access control.
In your httpd.conf you can control access to certain modules by In your httpd.conf you can control access to certain modules by
adding directives like this: adding directives like this:
<Location "<url to viewvc.cgi>/<modname_you_wish_to_access_ctl>"> <Location "<url to viewvc.cgi>/<modname_you_wish_to_access_ctl>">
AllowOverride None AllowOverride None
AuthUserFile /path/to/passwd/file AuthUserFile /path/to/passwd/file
AuthName "Client Access" AuthName "Client Access"
AuthType Basic AuthType Basic
require valid-user require valid-user
</Location> </Location>
WARNING: If you enable the "checkout_magic" or "allow_tar" options, you WARNING: If you enable the "checkout_magic" or "allow_tar" options, you
will need to add additional location directives to prevent people will need to add additional location directives to prevent people
from sneaking in with URLs like: from sneaking in with URLs like:
http://<server_name>/viewvc/*checkout*/<module_name> http://<server_name>/viewvc/*checkout*/<module_name>
http://<server_name>/viewvc/~checkout~/<module_name> http://<server_name>/viewvc/~checkout~/<module_name>
http://<server_name>/viewvc/<module_name>.tar.gz?view=tar http://<server_name>/viewvc/<module_name>.tar.gz?view=tar
5) Restart Apache. 6) Restart Apache.
The commands to do this vary. "httpd -k restart" and "apache -k The commands to do this vary. "httpd -k restart" and "apache -k
restart" are two common variants. On RedHat Linux it is done using restart" are two common variants. On RedHat Linux it is done using
the command "/sbin/service httpd restart" and on SuSE Linux it is the command "/sbin/service httpd restart" and on SuSE Linux it is
done with "rcapache restart". Other systems use "apachectl restart". done with "rcapache restart". Other systems use "apachectl restart".
6) Optional: Protect your ViewVC instance from server-whacking webcrawlers. 7) [Optional] Protect your ViewVC instance from server-whacking webcrawlers.
As ViewVC is a web-based application which each page containing various As ViewVC is a web-based application which each page containing various
links to other pages and views, you can expect your server's performance links to other pages and views, you can expect your server's performance
to suffer if a webcrawler finds your ViewVC instance and begins to suffer if a webcrawler finds your ViewVC instance and begins
traversing those links. We highly recommend that you add your ViewVC traversing those links. We highly recommend that you add your ViewVC
location to a site-wide robots.txt file. Visit the Wikipedia page location to a site-wide robots.txt file. Visit the Wikipedia page
for Robots.txt (http://en.wikipedia.org/wiki/Robots.txt) for more for Robots.txt (http://en.wikipedia.org/wiki/Robots.txt) for more
information. information.
UPGRADING VIEWVC UPGRADING VIEWVC
 End of changes. 13 change blocks. 
14 lines changed or deleted 52 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)