Skip to main content
Version: Next

PostgREST

PostgREST is Web server turns PostgreSQL into a RESTful API, used for Relational Databases Database Management Tools BaaS . PostgREST is a standalone web server that turns your PostgreSQL database directly into a RESTful API. The structural constraints and permissions in the database determine the API endpoints and operations.

gui

Prepare​

When referring to this document to use PostgREST, please read and ensure the following points:

  • Login to Websoft9 Console and find or install PostgREST:

    • Go to My Apps listing applications
    • Go to App Store installing target application

  • This application is installed by Websoft9 console.

  • The purpose of this application complies with the MIT open source license agreement.

  • Configure the domain name or server security group opens external network ports for application access.

Getting Started​

Initial Setup​

  1. After completing the installation of PostgREST via the Websoft9 Console, retrieve the application's Overview and Access information from My Apps.

  2. When installing using the Websoft9 console, ensure you fill in the exact PostgreSQL connection URI; otherwise, an error will appear in the container log.

Configuration Options​

  • Configuration files: You can pass configuration items via environment variables.
  • Connect to PostgreSQL database: Modify W9_POSTGRESQL_URI_SET in the .env file using orchestration.

Administration​

Troubleshooting​

Database Connection Error?​

Ensure that the PostgreSQL URI is correct and accessible by PostgREST.