Developer Platforms

PostgREST

Runs PostgREST as a Docker container against the PostgreSQL database you give it. There is no anonymous role, so requests without a valid JWT are refused. The JWT secret is generated on the server and a one-year token for your role is saved in a root-only file.

What it does

Developer Platform Installers

What you will be asked

You fill these in during setup.

REST API port RequiredAdvanced settings
The port the rest api listens on. The default is fine unless another service already uses it.
Database connection string Required
The PostgreSQL connection URI of the login role PostgREST uses, for example postgres://authenticator:[email protected]:5432/mydb. For a database on this same server use the host name host.docker.internal. Percent-encode special characters in the password; the characters $ ` \ quotes are not accepted.
Exposed schema RequiredAdvanced settings
The database schema that becomes the API.
Role for the generated token Required
A database role the login role may switch to. The token saved on the server acts as this role. The role must already exist and be granted to the login role.