Sign inSign up

stevechavez/postgrest

By stevechavez

•Updated almost 6 years ago

REST API for any Postgres database

Image
0

1.0K

stevechavez/postgrest repository overview

⁠PostgREST

Join the chat at https://gitter.im/begriffs/postgrest Donate Donate Docs Build Status

PostgREST serves a fully RESTful API from any existing PostgreSQL database. It provides a cleaner, more standards-compliant, faster API than you are likely to write from scratch.

⁠Usage

To learn how to use this container, see the PostgREST Docker documentation⁠.

You can configure the PostgREST image by setting the enviroment variables used in the default /etc/postgrest.conf file or overriding that file. This is the default configuration file:

# See https://postgrest.org/en/stable/configuration.html#configuration

# Required settings

db-uri = "$(PGRST_DB_URI)"
db-schema = "$(PGRST_DB_SCHEMA)"
db-anon-role = "$(PGRST_DB_ANON_ROLE)"

# Optional settings

db-pool = "$(PGRST_DB_POOL)"
db-pool-timeout = "$(PGRST_DB_POOL_TIMEOUT)"
db-extra-search-path = "$(PGRST_DB_EXTRA_SEARCH_PATH)"

db-channel = "$(PGRST_DB_CHANNEL)"
db-channel-enabled = "$(PGRST_DB_CHANNEL_ENABLED)"

server-host = "$(PGRST_SERVER_HOST)"
server-port = "$(PGRST_SERVER_PORT)"

openapi-server-proxy-uri = "$(PGRST_OPENAPI_SERVER_PROXY_URI)"
jwt-secret = "$(PGRST_JWT_SECRET)"
secret-is-base64 = "$(PGRST_SECRET_IS_BASE64)"
jwt-aud = "$(PGRST_JWT_AUD)"
role-claim-key = "$(PGRST_ROLE_CLAIM_KEY)"

max-rows = "$(PGRST_MAX_ROWS)"
pre-request = "$(PGRST_PRE_REQUEST)"
root-spec = "$(PGRST_ROOT_SPEC)"
raw-media-types = "$(PGRST_RAW_MEDIA_TYPES)"

⁠How this image is built

The image is built from scratch using Nix⁠ instead of a Dockerfile, which yields a higly secure and optimized image. This is also why no commands are listed in the image history. See the PostgREST respository⁠ for details on the build process and how to inspect the image.

Tag summary

Content type

Image

Digest

Size

4 MB

Last updated

almost 6 years ago

docker pull stevechavez/postgrest