PGXN::Site - Maintain and serve a PGXN web site
pgxn_site_server --api-url https://api.pgxn.org/ \ --errors-from email@example.com \ --errors-to firstname.lastname@example.org \ --feedback-to email@example.com
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.
The URL to use to access the PGXN::API server. Required.
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_urloption will still be used for public URLs pointing to the API in the UI.
If you need to access
private_api_urlvia a proxy server, provide the URL for that proxy server in this option.
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.
An email address from which alert emails should be sent.
An email address to which feedback emails should be sent. This email address will be provided as a clickable link.
The PGXN::Site class itself consists of a single class method.
say 'PGXN::Site ', PGXN::Site->version_string;
Returns a string representation of the PGXN::Site version.
David E. Wheeler <firstname.lastname@example.org>
Copyright (c) 2010-2021 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.