Pigsty Document v3.4

PostgreSQL In Great STYle”: Postgres, Infras, Graphics, Service, Toolbox, it’s all Yours.

—— Battery-Included, Local-First PostgreSQL Distribution as an Open-Source RDS Alternative

Repo | Demo | Blog | CN Blog | Discuss | Discord | GPTs | Roadmap | 中文文档

Get Started with the latest release: curl -fsSL https://repo.pigsty.io/get | bash


Setup: Install | Offline Install | Slim Install | Preparation | Configuration | Playbook | Provision | Security | FAQ

Modules: PGSQL | INFRA | NODE | ETCD | MINIO | REDIS | FERRET | DOCKER | APP | KERNEL | PRO |

About: Features | History | Event | Community | Privacy Policy | License | Sponsor | Support

Concept: Architecture | Cluster Model |Local CA | IaC | HA | PITR | Service Access | Access Control

Reference: Compatibility | Parameters | Extensions | FHS | Comparison | Cost | Glossary


Getting Started

Get Pigsty up & running based your resources and needs: preparation, provision, download, configure, and installation

About Pigsty

Learn about Pigsty itself: features, values, history, license, privacy policy, events, and news.

Concept

Learn about core concept about Pigsty: architecture, cluster models, infra, PG HA, PITR, and service access.

Configuration

Batteries-included config templates for specific scenarios, and detailed explanations.

References

Detailed information and list: supported OS distros, available modules, monitor metrics, extensions, cost compare & analysis, glossary

PostgreSQL

The most advanced open-source relational database in the world with HA, PITR, IaC and more!

Kernel Forks

How to use another PostgreSQL “kernel” in Pigsty, such as Citus, Babelfish, IvorySQL, PolarDB, Neon, and Greenplum

Module: INFRA

Independent modules which providers infrastructure services: NTP, DNS, and the modern observability stack ——Grafana & Prometheus

Module: NODE

Tune nodes into the desired state and monitor it, manage node, VIP, HAProxy, and exporters.

Module: ETCD

Pigsty has built-in etcd support, which is a reliable distributive consensus storage (DCS), empowering PostgreSQL HA.

Module: MINIO

Pigsty has built-in MinIO support. MinIO is an S3 OSS alternative which is used as an optional PostgreSQL backup repo

Module: REDIS

Pigsty has built-in Redis support, which is a high-performance data-structure server. Deploy redis in standalone, cluster or sentinel mode.

Module: FERRET

Pigsty has built-in FerretDB support, which is a MongoDB compatiable middleware based on PostgreSQL.

Module: DOCKER

Docker Daemon services, which allows you to pull-up stateless software in additional to PostgreSQL.

Module: Pro/Beta

Extra modules available in Pigsty Pro or in development.

Tasks

Look up common tasks and how to perform them using a short sequence of steps

Application

Out-of-the-box config templates to launch application use PostgreSQL as the core database.

Software

Software and tools that use PostgreSQL can be managed by the docker daemon

Visualization Applet

Run data analysis & visualization, data app demo with Pigsty

Release Notes

Pigsty release note history


Last modified 2025-03-22: update task tutorial (a20aa5b)