Welcome to ArchZoom
-------------------

ArchZoom is an Arch repository browser, a web based application that
provides a convenient view of registered archives and local libraries,
their revisions, changesets and full trees.

ArchZoom works under any web server and does not require anything special,
except for tla and perl greater than 5.005 (perl-5.8.3 is just fine).
The generated pages should work in all browsers including text-based.
A web browser with the standard css and javasctipt support is a bonus.


Verify the dist
---------------

Please run "make". This checks that you have all needed dependancies, good
if you build from the arch repository and not from the released tarball.


How to install
--------------

Run one of the following commands (read INSTALL if you need more info):

	./configure  # autodetects DocumentRoot if possible
	make install

This copies one file archzoom.cgi and creates one directory archzoom-data
inside the specified or autodetected DocumentRoot dir of your web server.

Then edit /etc/httpd/conf/httpd.conf or a similar file:

	* define *.cgi or just archzoom.cgi to be cgi-script, for example:
		AddHandler cgi-script .cgi
	* optionally use mod_perl to speed up archzoom.cgi

As a deamon user that runs web server (like "nobody" or "apache"):

	* configure archives you want others to browse from the web
	* optionally define revision library and either enable auto
          library updating (see the next section) or populate it with
	  archive revisions you want to provide to your web users

Edit archzoom-data/conf/archzoom.conf and load archzoom.cgi into browser.


Keeping revlib at constant size
-------------------------------

It is suggested to enable auto_library_updating in archzoom.conf and
optionally setup a hourly or daily cronjob to prune older revisions and
remove incomplete directories left by interrupted tla, like:

	14 0/3 * * * /path/to/axp revlib prune --quiet --number 500
	14 1/3 * * * /path/to/axp revlib prune --quiet --size 2GB
	14 2/3 * * * /path/to/axp revlib cleanup --quiet

Currently, bin/axp script is included, but not installed. You may run it
from the source directory or copy it manually to one of the subdirectories
relative to the installed archzoom-data. Run bin/axp to get help.


Hopefully, this is all, see FAQ if you have questions. Enjoy.

-- 
Mikhael Goikhman <migo@homemail.com>
% tla get migo@homemail.com--Perl-GPL/arch-perl--devel--0 arch-perl
% tla get migo@homemail.com--Perl-GPL/archzoom--devel--0 archzoom
