Allows the javadocs stored inside of an Ivy repository to be served over http.
It provides an index of modules that contain javadocs. The first time the url for a particular revision's javadocs is hit, it will extract the javadoc jar into the cache directory. From then on, it will serve the javadocs out of the cache as static files.
- Ivy repository
- Apache server with PHP and
mod_rewrite
unpack.php, template.html and .htaccess must be placed in the root of the
site.
There are three variables to configure at the top of unpack.php:
$archive_root, $cache_root and $template.
The archive root is the path of the Ivy repository. It must be a filesystem
repository in a path readable by the web server. The structure of the
repository should be
{repository root}\{organisation}\{module}\{revision}\javadocs\{module}.jar.
The cache root is the path of the directory that the jar files will be
extracted to, and the static documentation served from. It must be relative
to the document root and readable and writable by www-data. If it is
changed, it should be changes in the .htaccess file also.
The template is a path to a PHP file that is used to generate the HTML for an
index page. It has references to the $module_description and
$org_module_revs variables.
$module_description is an array containing the organisation, module and
revision, depending on how many are specified in the url. It will be empty
for the root index page.
$org_module_revs is an array of either organisations, modules or revisions,
depending on which index page is being rendered.
Use this software at your own risk. It is designed for use in an environment with trusted people, so security has not been a major concern in design or testing.