diff --git a/advocacy_docs/pg_extensions/postgrest/configuring.mdx b/advocacy_docs/pg_extensions/postgrest/configuring.mdx new file mode 100644 index 00000000000..98581bee190 --- /dev/null +++ b/advocacy_docs/pg_extensions/postgrest/configuring.mdx @@ -0,0 +1,7 @@ +--- +title: Configuring postgREST +navTitle: Configuring +--- + +Once you have postgREST installed, no other configuration steps are required. + diff --git a/advocacy_docs/pg_extensions/postgrest/index.mdx b/advocacy_docs/pg_extensions/postgrest/index.mdx new file mode 100644 index 00000000000..0a054cde9bb --- /dev/null +++ b/advocacy_docs/pg_extensions/postgrest/index.mdx @@ -0,0 +1,19 @@ +--- +title: 'postgREST' +indexCards: none +directoryDefaults: + product: postgREST +navigation: + - installing + - configuring + - using +--- + +`postgREST` is a standalone web server that allows a PostgreSQL database to function as a RESTful API. The API can be customized based on the database schema. + + +For more information about `postgREST`, see: + +- [Installing postgREST](installing.mdx) +- [Configuring postgREST](configuring.mdx) +- [Using postgREST](using.mdx) \ No newline at end of file diff --git a/advocacy_docs/pg_extensions/postgrest/installing.mdx b/advocacy_docs/pg_extensions/postgrest/installing.mdx new file mode 100644 index 00000000000..df102a433f1 --- /dev/null +++ b/advocacy_docs/pg_extensions/postgrest/installing.mdx @@ -0,0 +1,62 @@ +--- +title: Installing postgREST +navTitle: Installing +--- + +`postgREST` is supported on the same platforms as the Postgres distribution you're using. Support for `postgREST` starts with Postgres 12. For details, see: + +- [PostgreSQL Product Compatibility](https://www.enterprisedb.com/resources/platform-compatibility#pg) + +## Installation + +Before you begin the installation process: + +- Install Postgres. See: + + - [Installing PostgreSQL](https://www.postgresql.org/download/) + +- Set up the repository. + + Setting up the repository is a one-time task. If you've already set up your repository, you don't need to perform this step. + + To set up the repository, go to [EDB repositories](https://www.enterprisedb.com/repos-downloads) and follow the instructions provided there. + +## Install the package + +The syntax for the package install command is: + +```shell +# For SLES, CentOS, RHEL and its derivatives +sudo -y install edb--postgrest2 + +# For Debian and Ubuntu +sudo -y install edb--postgrest2 +``` + +Where: +- ``is the package manager used with your operating system: + + | Package manager | Operating system | + | --------------- | -------------------------------- | + | dnf | RHEL 8/9 and derivatives | + | zypper | SLES | + | apt-get | Debian and derivatives | + +- `` is the distribution of Postgres you're using: + + | Postgres distribution | Value | + | ---------------------------- | ---------- | + | PostgreSQL | pg | + +- `` is the version of Postgres you're using. + +For example, to install postgREST for EDB Postgres 15 on a RHEL 8 platform: + +```shell +sudo dnf -y install edb-pg15-postgrest2 +``` + + + + + diff --git a/advocacy_docs/pg_extensions/postgrest/using.mdx b/advocacy_docs/pg_extensions/postgrest/using.mdx new file mode 100644 index 00000000000..809efac98dd --- /dev/null +++ b/advocacy_docs/pg_extensions/postgrest/using.mdx @@ -0,0 +1,6 @@ +--- +title: Using postgREST +navTitle: Using +--- + +For more information about using `postgREST`, see the [PostgREST documentation](https://postgrest.org/en/stable/index.html). \ No newline at end of file