David E. Wheeler > PGXN-Site-v0.10.3 > PGXN::Site

Download:
PGXN-Site-v0.10.3.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: v0.10.3   Source  

Name ^

PGXN::Site - Maintain and serve a PGXN web site

Synopsis ^

  pgxn_site_server --api-url     http://api.pgxn.org/ \
                   --errors-from oops@example.com \
                   --errors-to   alerts@example.com \
                   --feedback-to feedback@example.com

Description ^

PGXN is a CPAN-inspired network for distributing extensions for the PostgreSQL RDBMS. All of the infrastructure tools, however, have been designed to be used to create networks for distributing any kind of release distributions and for providing a lightweight static file JSON REST API.

This module provides a simple PGXN web site. All it needs is a PGXN::API-powered API to get the data it needs. Such an API can be accessed either remotely or via the local file system.

To run your own PGXN web server, just install this module and run the included <pgxn_site_server Plack server, passing it the following options:

api_url

The URL to use to access the PGXN::API server. Required.

private_api_url

A private URL to use to access the PGXN::API-powered API. Optional. Useful if you're serving the site and the API from the same box (or with access to the same file system) and want it to be fast: just specify a file: URL here and the API will be read directly from the file system. The api_url option will still be used for public URLs pointing to the API in the UI.

proxy_url

If you need to access private_api_url via a proxy server, provide the URL for that proxy server in this option.

errors_to

An email address to which error emails should be sent. In the event of an internal server error, the server will send an email to this address with diagnostic information.

errors_from

An email address from which alert emails should be sent.

feedback_to

An email address to which feedback emails should be sent. This email address will be provided as a clickable link.

Interface ^

The PGXN::Site class itself consists of a single class method.

Class Method

version_string

  say 'PGXN::Site ', PGXN::Site->version_string;

Returns a string representation of the PGXN::Site version.

Author ^

David E. Wheeler <david.wheeler@pgexperts.com>

Copyright and License ^

Copyright (c) 2010-2013 David E. Wheeler.

This module is free software; you can redistribute it and/or modify it under the PostgreSQL License.

Permission to use, copy, modify, and distribute this software and its documentation for any purpose, without fee, and without a written agreement is hereby granted, provided that the above copyright notice and this paragraph and the following two paragraphs appear in all copies.

In no event shall David E. Wheeler be liable to any party for direct, indirect, special, incidental, or consequential damages, including lost profits, arising out of the use of this software and its documentation, even if David E. Wheeler has been advised of the possibility of such damage.

David E. Wheeler specifically disclaims any warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The software provided hereunder is on an "as is" basis, and David E. Wheeler has no obligations to provide maintenance, support, updates, enhancements, or modifications.

syntax highlighting: