PostgREST

by mietek

GitHub Readme.md

PostgREST

RESTful API for any PostgreSQL database.

Usage

See the original README for more information.

$ postgrest

Configuration

Authentication credentials and defaults can be configured by setting environment variables.

Environment variable Example DB_NAME Database name. Required. DB_AUTH_ROLE Database role for authenticated requests. Required. DB_AUTH_PASS Authentication password. Optional. DB_ANON_ROLE Database role for non-authenticated requests. Required. DB_HOST Database server hostname. Defaults to localhost. DB_PORT Database server port. Defaults to 5432. DB_POOL_SIZE Maximum number of connections in database pool. Defaults to 10. DB_SECURE Redirect all requests to HTTPS. Either 1 or 0. Defaults to 0. PORT HTTP listening port. Defaults to 8080.

Installation

Installs in one command on regular machines running most recent Linux distributions, using Halcyon.

$ halcyon install https://github.com/mietek/postgrest

Deployment

Deploys in one click to a new DigitalOcean droplet, or to the Heroku web application platform.

About

Made by Joe Nelson. Published under the MIT license.

Packaging by Miëtek Bak.