PostgREST

PostgREST is an open-source tool that generates a representational state transfer (REST) interface for any existing PostgreSQL database.

  • Databases
  • Development
  • Other
  • Productivity
  • Tools & Utilities
PostgREST is an open-source tool that generates a representational state transfer (REST) interface for any existing PostgreSQL database. It exposes database tables and views as standard web endpoints, reducing the need to hand-write boilerplate backend code. It is useful for developers and homelab builders who already run PostgreSQL and want a predictable, standards-compliant interface for their data.

Platform availability

Available on 2 of 10 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

72/100 Good

Maintained
100last commit 2 days ago
Popular
8927,763 GitHub stars
Easy to install
452 install platforms, install notes, Docker image
Light to run
No data
Security check
201 serious finding, CI, tests, OpenSSF Scorecard 6.2/10

Based on 4 of 5 factors.

Availability: platform listings confirmed today, links checked 10 days ago

GitHub stars
27,763
Open issues
407
Last commit
2026-11-19
Latest release
v16.6
License
MIT
Activity
declining

Checked yesterday - source: GitHub (PostgREST/postgrest)

Resources & Compatibility

ARM (e.g. Raspberry Pi) is supported.

Checked 54 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Start PostgREST with a config file Run PostgREST by giving it the path to a config file, for example: ./postgrest /path/to/postgrest.conf. This file holds required settings like the database address, so if it is missing or wrong, PostgREST will not know which database to connect to. source
  • Keep port 5432 free for PostgreSQL If you start the example PostgreSQL with Docker, make sure no other database is already using port 5432 on your computer. Port 5432 is where PostgreSQL listens for connections, and if it is blocked or already in use, PostgREST cannot reach the database. source
  • Note the port PostgREST listens on After starting PostgREST, read its output to find the API port it is listening on, such as port 3000 in the example. That is the port clients use to call PostgREST, so open it only if you need access from other devices. source

Fetched 54 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

How do I tell PostgREST which PostgreSQL database to use?

Start PostgREST by giving it a config file path. That file holds required settings such as the database address, and if it is missing or wrong, PostgREST will not know which database to connect to.

Which ports do I need to keep free or open?

If you run PostgreSQL locally with Docker, keep port 5432 free because PostgreSQL listens for connections there. PostgREST uses a separate API port, such as 3000, and you should open it only if clients on other devices need to call it.

How does PostgREST handle authentication and authorization?

It authenticates clients with JSON Web Tokens and delegates authorization to the role permissions defined in the database. While serving a request, it acts as the authenticated database user and cannot do anything that user could not.

What extra responsibility does self-hosting the PostgreSQL backend add?

You become responsible for backups, downtime, and patching. You should also verify that you can restore from your backups.

Should I expose PostgREST directly to clients?

Some users put PostgREST behind their own API layer, such as Flask, to add business logic. It can also be acceptable to expose it directly depending on your needs and hosting setup.

Answers sourced from github.com, github.com, github.com, www.reddit.com, www.reddit.com

Community

Collected 48 days ago - public community threads