From d7bf2a59c4701803b6f3a13e5a9fb0226af71206 Mon Sep 17 00:00:00 2001 From: Sam Rose Date: Fri, 26 Sep 2025 10:32:32 -0400 Subject: [PATCH 1/3] docs: getting started guide --- GETTING_STARTED.md | 181 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 4 + 2 files changed, 185 insertions(+) create mode 100644 GETTING_STARTED.md diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md new file mode 100644 index 000000000..895f2c0d5 --- /dev/null +++ b/GETTING_STARTED.md @@ -0,0 +1,181 @@ +# Getting Started with Supabase Postgres + +This guide covers getting up and running with Supabase Postgres. After reading this guide, you will understand: + +* What Supabase Postgres provides and why you might want to use it +* How the project is organized and what each directory contains +* How to build and run Postgres with extensions locally +* The basics of working with the extension ecosystem + +--- + +## What is Supabase Postgres? + +Supabase Postgres is a batteries-included PostgreSQL distribution that provides unmodified PostgreSQL with a curated set of the most useful extensions pre-installed. Think of it as PostgreSQL with superpowers - you get the reliability and power of standard PostgreSQL, plus immediate access to extensions for tasks like: + +* Full-text search and indexing +* Geospatial data processing +* Time-series data management +* JSON validation and GraphQL support +* Cryptography and security +* Message queuing +* And much more + +The goal is simple: make it fast and easy to get started with a production-ready PostgreSQL setup without having to hunt down, compile, and configure dozens of extensions yourself. + +## Philosophy + +Supabase Postgres follows these core principles: + +1. **Unmodified PostgreSQL** - We don't fork or modify PostgreSQL itself. You get standard PostgreSQL with extensions. +2. **Curated Extensions** - We include well-maintained, production-tested extensions that solve real problems. +3. **Multi-version Support** - Currently supporting PostgreSQL 15, 17, and OrioleDB-17. +4. **Ready for Production** - Configured with sensible defaults for replication, security, and performance. +5. **Open Source** - Everything is open source and can be self-hosted. + +## Directory Structure + +Here's a comprehensive overview of the project's directory structure: + +| File/Directory | Purpose | +| -------------- | ------- | +| **nix/** | Core build system directory containing all Nix expressions for building PostgreSQL and extensions | +| nix/postgresql/ | PostgreSQL version configurations, patches, and base package definitions | +| nix/ext/ | Individual extension package definitions and build configurations | +| nix/ext/wrappers/ | Wrapper scripts and utilities for extensions | +| nix/ext/tests/ | Extension-specific test suites | +| nix/overlays/ | Nix overlays for customizing and overriding package definitions | +| nix/tools/ | Build tools, utilities, and helper scripts | +| nix/docker/ | Docker image build definitions using Nix | +| nix/tests/ | Comprehensive integration test suites for validating builds | +| nix/tests/smoke/ | Quick smoke tests for basic functionality | +| nix/tests/migrations/ | Migration and upgrade test scenarios | +| nix/tests/expected/ | Expected `pg_regress` test outputs for validation | +| nix/tests/sql/ | SQL test scripts that are run in `pg_regress` tests | +| nix/docs/ | Build system documentation | +| **ansible/** | Infrastructure as Code for server configuration and deployment of production hosted AWS AMI image | +| ansible/playbook.yml | Main Ansible playbook for PostgreSQL/PostgREST/pgbouncer/Auth server setup | +| ansible/tasks/ | Modular Ansible tasks for specific configuration steps | +| ansible/files/ | Static files, scripts, and templates used by Ansible | +| ansible/vars.yml | AMI version tracking, legacy package version tracking | +| **migrations/** | Database migration management and upgrade tools | +| migrations/db/ | Database schema migrations | +| migrations/db/migrations/ | Individual migration files | +| migrations/db/init-scripts/ | Database initialization scripts | +| migrations/tests/ | Migration testing infrastructure | +| migrations/tests/database/ | Database-specific migration tests | +| migrations/tests/storage/ | Storage-related migration tests | +| migrations/tests/extensions/ | Extension migration tests | +| **docker/** | Container definitions and Docker-related files | +| docker/nix/ | Nix-based Docker build configurations | +| Dockerfile-15 | Docker image definition for PostgreSQL 15 | +| Dockerfile-17 | Docker image definition for PostgreSQL 17 | +| **tests/** | Integration and system tests | +| testinfra/ | Infrastructure tests using pytest framework | +| tests/ | General integration test suites | +| **scripts/** | Utility scripts for development and deployment | +| **docs/** | Additional documentation, images, and resources | +| **ebssurrogate/** | AWS EBS surrogate building for AMI creation | +| **http/** | HTTP-related configurations and files | +| **rfcs/** | Request for Comments - design documents and proposals | +| **db/** | Database-related utilities and configurations | +| **.github/** | GitHub-specific configurations (Actions, templates, etc.) | +| **Root Config Files** | | +| .gitignore | Git ignore patterns | +| .envrc.recommended | Recommended environment variables for development | +| ansible.cfg | Ansible configuration | +| amazon-arm64-nix.pkr.hcl | Packer configuration for AWS ARM64 builds | +| common-nix.vars.pkr.hcl | Common Packer variables | +| development-arm.vars.pkr.hcl | ARM development environment variables | +| CONTRIBUTING.md | Contribution guidelines | +| README.md | Main project documentation | + +## Key Concepts + +### Extensions + +Extensions are the superpower of PostgreSQL. They add functionality without modifying the core database. Supabase Postgres includes dozens of pre-built extensions covering: + +* **Data Types & Validation** - pg_jsonschema, pg_hashids +* **Search & Indexing** - pgroonga, rum, hypopg +* **Geospatial** - PostGIS, pgrouting +* **Time-series** - TimescaleDB +* **Security** - pgsodium, vault, pgaudit +* **Development** - pgtap, plpgsql_check +* **And many more...** + +### Multi-version Support + +The project supports multiple PostgreSQL versions simultaneously: + +* **PostgreSQL 15** - Stable, battle-tested version +* **PostgreSQL 17** - Latest features and improvements +* **OrioleDB-17** - Experimental storage engine for PostgreSQL 17 + +Each version has its own set of compatible extensions defined in the Nix build system. + +### Build System (Nix) + +The project uses Nix as its build system, which provides: + +* **Reproducible Builds** - Same input always produces the same output +* **Declarative Configuration** - Define what you want, not how to build it +* **Dependency Management** - Automatic handling of complex dependency trees +* **Cross-platform Support** - Build for Linux, macOS, and more + +## Common Tasks + +### Building Locally + +To build PostgreSQL with extensions locally: + +```bash +# Build PostgreSQL 15 with extensions +nix build .#psql_15/bin + +# Build PostgreSQL 17 +nix build .#psql_17/bin + +# Build a specific extension +nix build .#psql_17/exts/pg_graphql +``` + +### Running Tests + +```bash +# Run all tests +nix flake check -L + +# Run specific test suite (for macos apple silicon for example) +nix build .#checks.aarch64-darwin.psql_17 -L +``` + +### Creating Docker Images + +```bash +# Build Docker image for PostgreSQL 15 +docker build -f Dockerfile-15 -t supabase-postgres:15 . + +# Build Docker image for PostgreSQL 17 +docker build -f Dockerfile-17 -t supabase-postgres:17 . +``` + +## Next Steps + +Now that you understand the basics of Supabase Postgres: + +* Check the [Installation Guide](https://github.com/supabase/postgres/wiki) for deployment options +* Explore the [Extension Documentation](#) to learn about available extensions +* Review [Contributing Guidelines](CONTRIBUTING.md) if you want to contribute +* Join the [Supabase Community](https://github.com/supabase/postgres/discussions) for questions and discussions + +## Getting Help + +* **GitHub Issues** - For bugs and feature requests +* **Discussions** - For questions and general discussion +* **Wiki** - For detailed documentation +* **Discord** - For real-time chat with the community + +--- + +Remember: This is the same PostgreSQL build that powers [Supabase](https://supabase.io), battle-tested in production by thousands of projects. \ No newline at end of file diff --git a/README.md b/README.md index 0fa889e86..d1131c2b0 100644 --- a/README.md +++ b/README.md @@ -118,6 +118,10 @@ Unmodified Postgres with some useful plugins. Our goal with this repo is not to | [PostgREST](https://postgrest.org/en/stable/) | [v13.0.4](https://github.com/PostgREST/postgrest/releases/tag/v13.0.4) | Instantly transform your database into an RESTful API. | | [WAL-G](https://github.com/wal-g/wal-g#wal-g) | [v2.0.1](https://github.com/wal-g/wal-g/releases/tag/v2.0.1) | Tool for physical database backup and recovery. | --> +## Getting Started + +For a comprehensive guide to understanding and working with this project, see our [Getting Started Guide](GETTING_STARTED.md). + ## Install See all installation instructions in the [repo wiki](https://github.com/supabase/postgres/wiki). From 2f80051805929d94ce53448e9d4915fd8aa6e2d4 Mon Sep 17 00:00:00 2001 From: Sam Rose Date: Fri, 26 Sep 2025 10:36:24 -0400 Subject: [PATCH 2/3] docs: inline getting started into README --- GETTING_STARTED.md | 181 ------------------------------------------- README.md | 186 +++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 181 insertions(+), 186 deletions(-) delete mode 100644 GETTING_STARTED.md diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md deleted file mode 100644 index 895f2c0d5..000000000 --- a/GETTING_STARTED.md +++ /dev/null @@ -1,181 +0,0 @@ -# Getting Started with Supabase Postgres - -This guide covers getting up and running with Supabase Postgres. After reading this guide, you will understand: - -* What Supabase Postgres provides and why you might want to use it -* How the project is organized and what each directory contains -* How to build and run Postgres with extensions locally -* The basics of working with the extension ecosystem - ---- - -## What is Supabase Postgres? - -Supabase Postgres is a batteries-included PostgreSQL distribution that provides unmodified PostgreSQL with a curated set of the most useful extensions pre-installed. Think of it as PostgreSQL with superpowers - you get the reliability and power of standard PostgreSQL, plus immediate access to extensions for tasks like: - -* Full-text search and indexing -* Geospatial data processing -* Time-series data management -* JSON validation and GraphQL support -* Cryptography and security -* Message queuing -* And much more - -The goal is simple: make it fast and easy to get started with a production-ready PostgreSQL setup without having to hunt down, compile, and configure dozens of extensions yourself. - -## Philosophy - -Supabase Postgres follows these core principles: - -1. **Unmodified PostgreSQL** - We don't fork or modify PostgreSQL itself. You get standard PostgreSQL with extensions. -2. **Curated Extensions** - We include well-maintained, production-tested extensions that solve real problems. -3. **Multi-version Support** - Currently supporting PostgreSQL 15, 17, and OrioleDB-17. -4. **Ready for Production** - Configured with sensible defaults for replication, security, and performance. -5. **Open Source** - Everything is open source and can be self-hosted. - -## Directory Structure - -Here's a comprehensive overview of the project's directory structure: - -| File/Directory | Purpose | -| -------------- | ------- | -| **nix/** | Core build system directory containing all Nix expressions for building PostgreSQL and extensions | -| nix/postgresql/ | PostgreSQL version configurations, patches, and base package definitions | -| nix/ext/ | Individual extension package definitions and build configurations | -| nix/ext/wrappers/ | Wrapper scripts and utilities for extensions | -| nix/ext/tests/ | Extension-specific test suites | -| nix/overlays/ | Nix overlays for customizing and overriding package definitions | -| nix/tools/ | Build tools, utilities, and helper scripts | -| nix/docker/ | Docker image build definitions using Nix | -| nix/tests/ | Comprehensive integration test suites for validating builds | -| nix/tests/smoke/ | Quick smoke tests for basic functionality | -| nix/tests/migrations/ | Migration and upgrade test scenarios | -| nix/tests/expected/ | Expected `pg_regress` test outputs for validation | -| nix/tests/sql/ | SQL test scripts that are run in `pg_regress` tests | -| nix/docs/ | Build system documentation | -| **ansible/** | Infrastructure as Code for server configuration and deployment of production hosted AWS AMI image | -| ansible/playbook.yml | Main Ansible playbook for PostgreSQL/PostgREST/pgbouncer/Auth server setup | -| ansible/tasks/ | Modular Ansible tasks for specific configuration steps | -| ansible/files/ | Static files, scripts, and templates used by Ansible | -| ansible/vars.yml | AMI version tracking, legacy package version tracking | -| **migrations/** | Database migration management and upgrade tools | -| migrations/db/ | Database schema migrations | -| migrations/db/migrations/ | Individual migration files | -| migrations/db/init-scripts/ | Database initialization scripts | -| migrations/tests/ | Migration testing infrastructure | -| migrations/tests/database/ | Database-specific migration tests | -| migrations/tests/storage/ | Storage-related migration tests | -| migrations/tests/extensions/ | Extension migration tests | -| **docker/** | Container definitions and Docker-related files | -| docker/nix/ | Nix-based Docker build configurations | -| Dockerfile-15 | Docker image definition for PostgreSQL 15 | -| Dockerfile-17 | Docker image definition for PostgreSQL 17 | -| **tests/** | Integration and system tests | -| testinfra/ | Infrastructure tests using pytest framework | -| tests/ | General integration test suites | -| **scripts/** | Utility scripts for development and deployment | -| **docs/** | Additional documentation, images, and resources | -| **ebssurrogate/** | AWS EBS surrogate building for AMI creation | -| **http/** | HTTP-related configurations and files | -| **rfcs/** | Request for Comments - design documents and proposals | -| **db/** | Database-related utilities and configurations | -| **.github/** | GitHub-specific configurations (Actions, templates, etc.) | -| **Root Config Files** | | -| .gitignore | Git ignore patterns | -| .envrc.recommended | Recommended environment variables for development | -| ansible.cfg | Ansible configuration | -| amazon-arm64-nix.pkr.hcl | Packer configuration for AWS ARM64 builds | -| common-nix.vars.pkr.hcl | Common Packer variables | -| development-arm.vars.pkr.hcl | ARM development environment variables | -| CONTRIBUTING.md | Contribution guidelines | -| README.md | Main project documentation | - -## Key Concepts - -### Extensions - -Extensions are the superpower of PostgreSQL. They add functionality without modifying the core database. Supabase Postgres includes dozens of pre-built extensions covering: - -* **Data Types & Validation** - pg_jsonschema, pg_hashids -* **Search & Indexing** - pgroonga, rum, hypopg -* **Geospatial** - PostGIS, pgrouting -* **Time-series** - TimescaleDB -* **Security** - pgsodium, vault, pgaudit -* **Development** - pgtap, plpgsql_check -* **And many more...** - -### Multi-version Support - -The project supports multiple PostgreSQL versions simultaneously: - -* **PostgreSQL 15** - Stable, battle-tested version -* **PostgreSQL 17** - Latest features and improvements -* **OrioleDB-17** - Experimental storage engine for PostgreSQL 17 - -Each version has its own set of compatible extensions defined in the Nix build system. - -### Build System (Nix) - -The project uses Nix as its build system, which provides: - -* **Reproducible Builds** - Same input always produces the same output -* **Declarative Configuration** - Define what you want, not how to build it -* **Dependency Management** - Automatic handling of complex dependency trees -* **Cross-platform Support** - Build for Linux, macOS, and more - -## Common Tasks - -### Building Locally - -To build PostgreSQL with extensions locally: - -```bash -# Build PostgreSQL 15 with extensions -nix build .#psql_15/bin - -# Build PostgreSQL 17 -nix build .#psql_17/bin - -# Build a specific extension -nix build .#psql_17/exts/pg_graphql -``` - -### Running Tests - -```bash -# Run all tests -nix flake check -L - -# Run specific test suite (for macos apple silicon for example) -nix build .#checks.aarch64-darwin.psql_17 -L -``` - -### Creating Docker Images - -```bash -# Build Docker image for PostgreSQL 15 -docker build -f Dockerfile-15 -t supabase-postgres:15 . - -# Build Docker image for PostgreSQL 17 -docker build -f Dockerfile-17 -t supabase-postgres:17 . -``` - -## Next Steps - -Now that you understand the basics of Supabase Postgres: - -* Check the [Installation Guide](https://github.com/supabase/postgres/wiki) for deployment options -* Explore the [Extension Documentation](#) to learn about available extensions -* Review [Contributing Guidelines](CONTRIBUTING.md) if you want to contribute -* Join the [Supabase Community](https://github.com/supabase/postgres/discussions) for questions and discussions - -## Getting Help - -* **GitHub Issues** - For bugs and feature requests -* **Discussions** - For questions and general discussion -* **Wiki** - For detailed documentation -* **Discord** - For real-time chat with the community - ---- - -Remember: This is the same PostgreSQL build that powers [Supabase](https://supabase.io), battle-tested in production by thousands of projects. \ No newline at end of file diff --git a/README.md b/README.md index d1131c2b0..3f4869a73 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,185 @@ -# Postgres + goodies +# Getting Started with Supabase Postgres + +This guide covers getting up and running with Supabase Postgres. After reading this guide, you will understand: + +* What Supabase Postgres provides and why you might want to use it +* How the project is organized and what each directory contains +* How to build and run Postgres with extensions locally +* The basics of working with the extension ecosystem + +--- + +## What is Supabase Postgres? + +Supabase Postgres is a batteries-included PostgreSQL distribution that provides unmodified PostgreSQL with a curated set of the most useful extensions pre-installed. Think of it as PostgreSQL with superpowers - you get the reliability and power of standard PostgreSQL, plus immediate access to extensions for tasks like: + +* Full-text search and indexing +* Geospatial data processing +* Time-series data management +* JSON validation and GraphQL support +* Cryptography and security +* Message queuing +* And much more + +The goal is simple: make it fast and easy to get started with a production-ready PostgreSQL setup without having to hunt down, compile, and configure dozens of extensions yourself. + +## Philosophy + +Supabase Postgres follows these core principles: + +1. **Unmodified PostgreSQL** - We don't fork or modify PostgreSQL itself. You get standard PostgreSQL with extensions. +2. **Curated Extensions** - We include well-maintained, production-tested extensions that solve real problems. +3. **Multi-version Support** - Currently supporting PostgreSQL 15, 17, and OrioleDB-17. +4. **Ready for Production** - Configured with sensible defaults for replication, security, and performance. +5. **Open Source** - Everything is open source and can be self-hosted. + +## Directory Structure + +Here's a comprehensive overview of the project's directory structure: + +| File/Directory | Purpose | +| -------------- | ------- | +| **nix/** | Core build system directory containing all Nix expressions for building PostgreSQL and extensions | +| nix/postgresql/ | PostgreSQL version configurations, patches, and base package definitions | +| nix/ext/ | Individual extension package definitions and build configurations | +| nix/ext/wrappers/ | Wrapper scripts and utilities for extensions | +| nix/ext/tests/ | Extension-specific test suites | +| nix/overlays/ | Nix overlays for customizing and overriding package definitions | +| nix/tools/ | Build tools, utilities, and helper scripts | +| nix/docker/ | Docker image build definitions using Nix | +| nix/tests/ | Comprehensive integration test suites for validating builds | +| nix/tests/smoke/ | Quick smoke tests for basic functionality | +| nix/tests/migrations/ | Migration and upgrade test scenarios | +| nix/tests/expected/ | Expected `pg_regress` test outputs for validation | +| nix/tests/sql/ | SQL test scripts that are run in `pg_regress` tests | +| nix/docs/ | Build system documentation | +| **ansible/** | Infrastructure as Code for server configuration and deployment of production hosted AWS AMI image | +| ansible/playbook.yml | Main Ansible playbook for PostgreSQL/PostgREST/pgbouncer/Auth server setup | +| ansible/tasks/ | Modular Ansible tasks for specific configuration steps | +| ansible/files/ | Static files, scripts, and templates used by Ansible | +| ansible/vars.yml | AMI version tracking, legacy package version tracking | +| **migrations/** | Database migration management and upgrade tools | +| migrations/db/ | Database schema migrations | +| migrations/db/migrations/ | Individual migration files | +| migrations/db/init-scripts/ | Database initialization scripts | +| migrations/tests/ | Migration testing infrastructure | +| migrations/tests/database/ | Database-specific migration tests | +| migrations/tests/storage/ | Storage-related migration tests | +| migrations/tests/extensions/ | Extension migration tests | +| **docker/** | Container definitions and Docker-related files | +| docker/nix/ | Nix-based Docker build configurations | +| Dockerfile-15 | Docker image definition for PostgreSQL 15 | +| Dockerfile-17 | Docker image definition for PostgreSQL 17 | +| **tests/** | Integration and system tests | +| testinfra/ | Infrastructure tests using pytest framework | +| tests/ | General integration test suites | +| **scripts/** | Utility scripts for development and deployment | +| **docs/** | Additional documentation, images, and resources | +| **ebssurrogate/** | AWS EBS surrogate building for AMI creation | +| **http/** | HTTP-related configurations and files | +| **rfcs/** | Request for Comments - design documents and proposals | +| **db/** | Database-related utilities and configurations | +| **.github/** | GitHub-specific configurations (Actions, templates, etc.) | +| **Root Config Files** | | +| .gitignore | Git ignore patterns | +| .envrc.recommended | Recommended environment variables for development | +| ansible.cfg | Ansible configuration | +| amazon-arm64-nix.pkr.hcl | Packer configuration for AWS ARM64 builds | +| common-nix.vars.pkr.hcl | Common Packer variables | +| development-arm.vars.pkr.hcl | ARM development environment variables | +| CONTRIBUTING.md | Contribution guidelines | +| README.md | Main project documentation | + +## Key Concepts + +### Extensions + +Extensions are the superpower of PostgreSQL. They add functionality without modifying the core database. Supabase Postgres includes dozens of pre-built extensions covering: + +* **Data Types & Validation** - pg_jsonschema, pg_hashids +* **Search & Indexing** - pgroonga, rum, hypopg +* **Geospatial** - PostGIS, pgrouting +* **Time-series** - TimescaleDB +* **Security** - pgsodium, vault, pgaudit +* **Development** - pgtap, plpgsql_check +* **And many more...** + +### Multi-version Support + +The project supports multiple PostgreSQL versions simultaneously: + +* **PostgreSQL 15** - Stable, battle-tested version +* **PostgreSQL 17** - Latest features and improvements +* **OrioleDB-17** - Experimental storage engine for PostgreSQL 17 + +Each version has its own set of compatible extensions defined in the Nix build system. + +### Build System (Nix) + +The project uses Nix as its build system, which provides: + +* **Reproducible Builds** - Same input always produces the same output +* **Declarative Configuration** - Define what you want, not how to build it +* **Dependency Management** - Automatic handling of complex dependency trees +* **Cross-platform Support** - Build for Linux, macOS, and more + +## Common Tasks + +### Building Locally + +To build PostgreSQL with extensions locally: + +```bash +# Build PostgreSQL 15 with extensions +nix build .#psql_15/bin + +# Build PostgreSQL 17 +nix build .#psql_17/bin + +# Build a specific extension +nix build .#psql_17/exts/pg_graphql +``` + +### Running Tests + +```bash +# Run all tests +nix flake check -L + +# Run specific test suite (for macos apple silicon for example) +nix build .#checks.aarch64-darwin.psql_17 -L +``` + +### Creating Docker Images + +```bash +# Build Docker image for PostgreSQL 15 +docker build -f Dockerfile-15 -t supabase-postgres:15 . + +# Build Docker image for PostgreSQL 17 +docker build -f Dockerfile-17 -t supabase-postgres:17 . +``` + +## Next Steps + +Now that you understand the basics of Supabase Postgres: + +* Check the [Installation Guide](https://github.com/supabase/postgres/wiki) for deployment options +* Explore the [Extension Documentation](#) to learn about available extensions +* Review [Contributing Guidelines](CONTRIBUTING.md) if you want to contribute +* Join the [Supabase Community](https://github.com/supabase/postgres/discussions) for questions and discussions + +## Getting Help + +* **GitHub Issues** - For bugs and feature requests +* **Discussions** - For questions and general discussion +* **Wiki** - For detailed documentation +* **Discord** - For real-time chat with the community + +--- + +This is the same PostgreSQL build that powers [Supabase](https://supabase.io), battle-tested in production by over one million projects. -Unmodified Postgres with some useful plugins. Our goal with this repo is not to modify Postgres, but to provide some of the most common extensions with a one-click install. ## Primary Features - ✅ Postgres [postgresql-15.14](https://www.postgresql.org/docs/15/index.html) @@ -118,9 +297,6 @@ Unmodified Postgres with some useful plugins. Our goal with this repo is not to | [PostgREST](https://postgrest.org/en/stable/) | [v13.0.4](https://github.com/PostgREST/postgrest/releases/tag/v13.0.4) | Instantly transform your database into an RESTful API. | | [WAL-G](https://github.com/wal-g/wal-g#wal-g) | [v2.0.1](https://github.com/wal-g/wal-g/releases/tag/v2.0.1) | Tool for physical database backup and recovery. | --> -## Getting Started - -For a comprehensive guide to understanding and working with this project, see our [Getting Started Guide](GETTING_STARTED.md). ## Install From 7bb95bfa1a67fc521ab59cd01dab03b35c2f7a56 Mon Sep 17 00:00:00 2001 From: Sam Rose Date: Fri, 26 Sep 2025 10:39:18 -0400 Subject: [PATCH 3/3] docs: run readme update for versions --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 3f4869a73..204fb92dc 100644 --- a/README.md +++ b/README.md @@ -193,7 +193,8 @@ This is the same PostgreSQL build that powers [Supabase](https://supabase.io), b ### PostgreSQL 15 Extensions | Extension | Version | Description | | ------------- | :-------------: | ------------- | -| [hypopg](https://github.com/HypoPG/hypopg/archive/refs/tags/1.4.1.tar.gz) | [1.4.1](https://github.com/HypoPG/hypopg/archive/refs/tags/1.4.1.tar.gz) | Hypothetical Indexes for PostgreSQL | +| [http]() | [1.6]() | | +| [hypopg]() | [1.4.1]() | | | [index_advisor]() | [0.2.0]() | | | [pg-safeupdate](https://github.com/eradman/pg-safeupdate/archive/1.4.tar.gz) | [1.4](https://github.com/eradman/pg-safeupdate/archive/1.4.tar.gz) | A simple extension to PostgreSQL that requires criteria for UPDATE and DELETE | | [pg_cron]() | [1.6.4]() | Run Cron jobs through PostgreSQL (multi-version compatible) | @@ -210,15 +211,14 @@ This is the same PostgreSQL build that powers [Supabase](https://supabase.io), b | [pgmq](https://github.com/tembo-io/pgmq/archive/v1.4.4.tar.gz) | [1.4.4](https://github.com/tembo-io/pgmq/archive/v1.4.4.tar.gz) | A lightweight message queue. Like AWS SQS and RSMQ but on Postgres. | | [pgroonga](https://packages.groonga.org/source/pgroonga/pgroonga-3.2.5.tar.gz) | [3.2.5](https://packages.groonga.org/source/pgroonga/pgroonga-3.2.5.tar.gz) | A PostgreSQL extension to use Groonga as the index | | [pgrouting](https://github.com/pgRouting/pgrouting/archive/v3.4.1.tar.gz) | [3.4.1](https://github.com/pgRouting/pgrouting/archive/v3.4.1.tar.gz) | A PostgreSQL/PostGIS extension that provides geospatial routing functionality | -| [pgsodium](https://github.com/michelp/pgsodium/archive/refs/tags/v3.1.8.tar.gz) | [3.1.8](https://github.com/michelp/pgsodium/archive/refs/tags/v3.1.8.tar.gz) | Modern cryptography for PostgreSQL | -| [pgsql-http](https://github.com/pramsey/pgsql-http/archive/refs/tags/v1.6.1.tar.gz) | [1.6.1](https://github.com/pramsey/pgsql-http/archive/refs/tags/v1.6.1.tar.gz) | HTTP client for Postgres | +| [pgsodium]() | [3.1.8]() | | | [pgtap](https://github.com/theory/pgtap/archive/v1.2.0.tar.gz) | [1.2.0](https://github.com/theory/pgtap/archive/v1.2.0.tar.gz) | A unit testing framework for PostgreSQL | | [plpgsql-check](https://github.com/okbob/plpgsql_check/archive/v2.7.11.tar.gz) | [2.7.11](https://github.com/okbob/plpgsql_check/archive/v2.7.11.tar.gz) | Linter tool for language PL/pgSQL | | [plv8](https://github.com/plv8/plv8/archive/v3.1.10.tar.gz) | [3.1.10](https://github.com/plv8/plv8/archive/v3.1.10.tar.gz) | V8 Engine Javascript Procedural Language add-on for PostgreSQL | | [postgis](https://download.osgeo.org/postgis/source/postgis-3.3.7.tar.gz) | [3.3.7](https://download.osgeo.org/postgis/source/postgis-3.3.7.tar.gz) | Geographic Objects for PostgreSQL | -| [rum](https://github.com/postgrespro/rum/archive/1.3.14.tar.gz) | [1.3.14](https://github.com/postgrespro/rum/archive/1.3.14.tar.gz) | Full text search index method for PostgreSQL | +| [rum]() | [1.3]() | | | [supautils](https://github.com/supabase/supautils/archive/refs/tags/v2.9.4.tar.gz) | [2.9.4](https://github.com/supabase/supautils/archive/refs/tags/v2.9.4.tar.gz) | PostgreSQL extension for enhanced security | -| [timescaledb-apache](https://github.com/timescale/timescaledb/archive/2.16.1.tar.gz) | [2.16.1](https://github.com/timescale/timescaledb/archive/2.16.1.tar.gz) | Scales PostgreSQL for time-series data via automatic partitioning across time and space | +| [timescaledb]() | [2.9.1]() | | | [vault](https://github.com/supabase/vault/archive/refs/tags/v0.3.1.tar.gz) | [0.3.1](https://github.com/supabase/vault/archive/refs/tags/v0.3.1.tar.gz) | Store encrypted secrets in PostgreSQL | | [vector]() | [0.8.0]() | | | [wal2json](https://github.com/eulerto/wal2json/archive/wal2json_2_6.tar.gz) | [2_6](https://github.com/eulerto/wal2json/archive/wal2json_2_6.tar.gz) | PostgreSQL JSON output plugin for changeset extraction | @@ -227,7 +227,8 @@ This is the same PostgreSQL build that powers [Supabase](https://supabase.io), b ### PostgreSQL 17 Extensions | Extension | Version | Description | | ------------- | :-------------: | ------------- | -| [hypopg](https://github.com/HypoPG/hypopg/archive/refs/tags/1.4.1.tar.gz) | [1.4.1](https://github.com/HypoPG/hypopg/archive/refs/tags/1.4.1.tar.gz) | Hypothetical Indexes for PostgreSQL | +| [http]() | [1.6]() | | +| [hypopg]() | [1.4.1]() | | | [index_advisor]() | [0.2.0]() | | | [pg-safeupdate](https://github.com/eradman/pg-safeupdate/archive/1.4.tar.gz) | [1.4](https://github.com/eradman/pg-safeupdate/archive/1.4.tar.gz) | A simple extension to PostgreSQL that requires criteria for UPDATE and DELETE | | [pg_cron]() | [1.6.4]() | Run Cron jobs through PostgreSQL (multi-version compatible) | @@ -244,12 +245,11 @@ This is the same PostgreSQL build that powers [Supabase](https://supabase.io), b | [pgmq](https://github.com/tembo-io/pgmq/archive/v1.4.4.tar.gz) | [1.4.4](https://github.com/tembo-io/pgmq/archive/v1.4.4.tar.gz) | A lightweight message queue. Like AWS SQS and RSMQ but on Postgres. | | [pgroonga](https://packages.groonga.org/source/pgroonga/pgroonga-3.2.5.tar.gz) | [3.2.5](https://packages.groonga.org/source/pgroonga/pgroonga-3.2.5.tar.gz) | A PostgreSQL extension to use Groonga as the index | | [pgrouting](https://github.com/pgRouting/pgrouting/archive/v3.4.1.tar.gz) | [3.4.1](https://github.com/pgRouting/pgrouting/archive/v3.4.1.tar.gz) | A PostgreSQL/PostGIS extension that provides geospatial routing functionality | -| [pgsodium](https://github.com/michelp/pgsodium/archive/refs/tags/v3.1.8.tar.gz) | [3.1.8](https://github.com/michelp/pgsodium/archive/refs/tags/v3.1.8.tar.gz) | Modern cryptography for PostgreSQL | -| [pgsql-http](https://github.com/pramsey/pgsql-http/archive/refs/tags/v1.6.1.tar.gz) | [1.6.1](https://github.com/pramsey/pgsql-http/archive/refs/tags/v1.6.1.tar.gz) | HTTP client for Postgres | +| [pgsodium]() | [3.1.8]() | | | [pgtap](https://github.com/theory/pgtap/archive/v1.2.0.tar.gz) | [1.2.0](https://github.com/theory/pgtap/archive/v1.2.0.tar.gz) | A unit testing framework for PostgreSQL | | [plpgsql-check](https://github.com/okbob/plpgsql_check/archive/v2.7.11.tar.gz) | [2.7.11](https://github.com/okbob/plpgsql_check/archive/v2.7.11.tar.gz) | Linter tool for language PL/pgSQL | | [postgis](https://download.osgeo.org/postgis/source/postgis-3.3.7.tar.gz) | [3.3.7](https://download.osgeo.org/postgis/source/postgis-3.3.7.tar.gz) | Geographic Objects for PostgreSQL | -| [rum](https://github.com/postgrespro/rum/archive/1.3.14.tar.gz) | [1.3.14](https://github.com/postgrespro/rum/archive/1.3.14.tar.gz) | Full text search index method for PostgreSQL | +| [rum]() | [1.3]() | | | [supautils](https://github.com/supabase/supautils/archive/refs/tags/v2.9.4.tar.gz) | [2.9.4](https://github.com/supabase/supautils/archive/refs/tags/v2.9.4.tar.gz) | PostgreSQL extension for enhanced security | | [vault](https://github.com/supabase/vault/archive/refs/tags/v0.3.1.tar.gz) | [0.3.1](https://github.com/supabase/vault/archive/refs/tags/v0.3.1.tar.gz) | Store encrypted secrets in PostgreSQL | | [vector]() | [0.8.0]() | | @@ -259,7 +259,8 @@ This is the same PostgreSQL build that powers [Supabase](https://supabase.io), b ### PostgreSQL orioledb-17 Extensions | Extension | Version | Description | | ------------- | :-------------: | ------------- | -| [hypopg](https://github.com/HypoPG/hypopg/archive/refs/tags/1.4.1.tar.gz) | [1.4.1](https://github.com/HypoPG/hypopg/archive/refs/tags/1.4.1.tar.gz) | Hypothetical Indexes for PostgreSQL | +| [http]() | [1.6]() | | +| [hypopg]() | [1.4.1]() | | | [index_advisor]() | [0.2.0]() | | | [orioledb](https://github.com/orioledb/orioledb/archive/beta12.tar.gz) | [orioledb](https://github.com/orioledb/orioledb/archive/beta12.tar.gz) | orioledb | | [pg-safeupdate](https://github.com/eradman/pg-safeupdate/archive/1.4.tar.gz) | [1.4](https://github.com/eradman/pg-safeupdate/archive/1.4.tar.gz) | A simple extension to PostgreSQL that requires criteria for UPDATE and DELETE | @@ -277,12 +278,11 @@ This is the same PostgreSQL build that powers [Supabase](https://supabase.io), b | [pgmq](https://github.com/tembo-io/pgmq/archive/v1.4.4.tar.gz) | [1.4.4](https://github.com/tembo-io/pgmq/archive/v1.4.4.tar.gz) | A lightweight message queue. Like AWS SQS and RSMQ but on Postgres. | | [pgroonga](https://packages.groonga.org/source/pgroonga/pgroonga-3.2.5.tar.gz) | [3.2.5](https://packages.groonga.org/source/pgroonga/pgroonga-3.2.5.tar.gz) | A PostgreSQL extension to use Groonga as the index | | [pgrouting](https://github.com/pgRouting/pgrouting/archive/v3.4.1.tar.gz) | [3.4.1](https://github.com/pgRouting/pgrouting/archive/v3.4.1.tar.gz) | A PostgreSQL/PostGIS extension that provides geospatial routing functionality | -| [pgsodium](https://github.com/michelp/pgsodium/archive/refs/tags/v3.1.8.tar.gz) | [3.1.8](https://github.com/michelp/pgsodium/archive/refs/tags/v3.1.8.tar.gz) | Modern cryptography for PostgreSQL | -| [pgsql-http](https://github.com/pramsey/pgsql-http/archive/refs/tags/v1.6.1.tar.gz) | [1.6.1](https://github.com/pramsey/pgsql-http/archive/refs/tags/v1.6.1.tar.gz) | HTTP client for Postgres | +| [pgsodium]() | [3.1.8]() | | | [pgtap](https://github.com/theory/pgtap/archive/v1.2.0.tar.gz) | [1.2.0](https://github.com/theory/pgtap/archive/v1.2.0.tar.gz) | A unit testing framework for PostgreSQL | | [plpgsql-check](https://github.com/okbob/plpgsql_check/archive/v2.7.11.tar.gz) | [2.7.11](https://github.com/okbob/plpgsql_check/archive/v2.7.11.tar.gz) | Linter tool for language PL/pgSQL | | [postgis](https://download.osgeo.org/postgis/source/postgis-3.3.7.tar.gz) | [3.3.7](https://download.osgeo.org/postgis/source/postgis-3.3.7.tar.gz) | Geographic Objects for PostgreSQL | -| [rum](https://github.com/postgrespro/rum/archive/1.3.14.tar.gz) | [1.3.14](https://github.com/postgrespro/rum/archive/1.3.14.tar.gz) | Full text search index method for PostgreSQL | +| [rum]() | [1.3]() | | | [supautils](https://github.com/supabase/supautils/archive/refs/tags/v2.9.4.tar.gz) | [2.9.4](https://github.com/supabase/supautils/archive/refs/tags/v2.9.4.tar.gz) | PostgreSQL extension for enhanced security | | [vault](https://github.com/supabase/vault/archive/refs/tags/v0.3.1.tar.gz) | [0.3.1](https://github.com/supabase/vault/archive/refs/tags/v0.3.1.tar.gz) | Store encrypted secrets in PostgreSQL | | [vector]() | [0.8.0]() | |