A tool that generates an HTML page, RSS feed, and Phive metadata for a PHAR repository
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Add configuration for probot-stale Jun 2, 2018
build Cleanup Jun 2, 2018
src Prepare release Aug 22, 2018
.gitignore Cleanup Jun 2, 2018
.php_cs.dist Enable more fixers Jun 16, 2018
ChangeLog.md Prepare release Aug 22, 2018
LICENSE Cleanup Jun 2, 2018
README.md Update documentation Feb 27, 2016
build.xml Cleanup Jun 2, 2018
composer.json Cleanup Jun 2, 2018
composer.phar Cleanup/Update build automation Jul 10, 2017
phar-site-generator Cleanup Jun 2, 2018
phive.xml Cleanup/Update build automation Jul 10, 2017

README.md

phar-site-generator

phar-site-generator is a tool that generates an HTML page (example), RSS feed (example), and Phive metadata (example) for a PHAR repository.

This tool makes the following assumptions:

  • The PHAR repository is hosted using nginx
  • The PHAR repository is hosted using HTTPS
  • The PHAR repository directory contains .phar (PHP Archive) and .phar.asc (GPG signature) files
  • The output of package-x.y.z.phar --manifest, if that option is available, is used as the manifest information for that package's release

Usage

We distribute a PHP Archive (PHAR) that has all required (as well as some optional) dependencies of phar-site-generator bundled in a single file:

wget https://phar.phpunit.de/phar-site-generator.phar

phar-site-generator requires an XML configuration file:

<?xml version="1.0" encoding="UTF-8"?>
<phar-site>
    <domain>phar.phpunit.de</domain>
    <email>sebastian@phpunit.de</email>
    <directory>/webspace/phar.phpunit.de/html</directory>
    <nginx>/webspace/phpunit.de/phar/redirects.conf</nginx>
</phar-site>