Categories: Reference

History

The origin and motivation of the Pigsty project, its development history, and future goals and vision.

Package Alias

Pigsty provides a package alias translation mechanism that shields the differences in binary package details across operating systems, making installation easier.

Roadmap

Future feature planning, new feature release schedule, and todo list.

Join the Community

Pigsty is a Build in Public project. We are very active on GitHub, and Chinese users are mainly active in WeChat groups.

Privacy Policy

What user data does Pigsty software and website collect, and how will we process your data and protect your privacy?

License

Pigsty’s open-source licenses — Apache-2.0 and CC BY 4.0

Sponsor Us

Pigsty sponsors and investors list - thank you for your support of this project!

User Cases

Pigsty customer and application cases across various domains and industries

Subscription

Pigsty Professional/Enterprise subscription service - When you encounter difficulties related to PostgreSQL and Pigsty, our subscription service provides you with comprehensive support.

FAQ

Answers to frequently asked questions about the Pigsty project itself.

Comparison

This article compares Pigsty with similar products and projects, highlighting feature differences.

pig patroni

Manage Patroni service and cluster with pig patroni subcommand

FAQ

Frequently asked questions about Patroni operation and troubleshooting.

pig pitr

Perform orchestrated point-in-time recovery (PITR) with pig pitr

meta

Default single-node installation template with extensive configuration parameter descriptions

rich

Feature-rich single-node configuration with local software repository, all extensions, MinIO backup, and complete examples

slim

Minimal installation template without monitoring infrastructure, installs PostgreSQL directly from internet

fat

Feature-All-Test template, single-node installation of all extensions, builds local repo with PG 14-18 all versions

infra

Only installs observability infrastructure, dedicated template without PostgreSQL and etcd

vibe

VIBE AI coding sandbox config template, integrating Code-Server, JupyterLab, Claude Code, Codex CLI, and JuiceFS

docker

Pigsty Docker single-node template for quickly bootstrapping Pigsty in containers.

pgsql

Native PostgreSQL kernel, supports deployment of PostgreSQL versions 14 to 18

pg19

Single-node PostgreSQL 19 Beta evaluation template with the PGDG Beta repository and a minimal runtime

mssql

Babelfish template pinned to a PostgreSQL 17-compatible kernel with SQL Server protocol and T-SQL support

polar

PolarDB for PostgreSQL kernel, provides Aurora-style storage-compute separation capability

agens

AgensGraph kernel template with property graph model and Cypher query support

References

Detailed reference information and lists, supported Linux distros, available modules, metrics, extensions, and more.

pgedge

pgEdge kernel template for distributed multi-master PostgreSQL in edge scenarios

Extensions

This page lists PostgreSQL extensions supported by Pigsty and their availability overview.

File Hierarchy

How Pigsty’s file system structure is designed and organized, and directory structures used by each module.

pgtde

Percona PostgreSQL kernel, provides Transparent Data Encryption (pg_tde) capability

mongo

DocumentDB + FerretDB template providing Mongo wire compatibility on PostgreSQL.

Applications

Pigsty application templates and data applets: run stateless apps with Docker Compose and host state in external PostgreSQL and MinIO.

ha/full

Four-node complete feature demonstration environment with two PostgreSQL clusters, MinIO, Redis, etc.

Operations SOP Index

Pigsty and PostgreSQL operations documentation index for new users: find the right page by common task.

ha/citus

13-node Citus distributed PostgreSQL cluster, 1 coordinator + 5 worker groups with HA

supabase

Self-host Supabase using Pigsty-managed PostgreSQL, an open-source Firebase alternative

Module: PGSQL

Deploy and manage world’s most advanced open-source relational database — PostgreSQL, customizable and production-ready!

demo/demo

Pigsty public demo site configuration, showcasing SSL certificates, domain exposure, and full extension installation

demo/saas

Legacy single-node SaaS bundle with PostgreSQL, MinIO, Redis, and multiple application entrypoints

Configuration

Choose the appropriate instance and cluster types based on your requirements to configure PostgreSQL database clusters that meet your needs.

Service/Access

Split read and write operations, route traffic correctly, and reliably deliver PostgreSQL cluster capabilities.

Database

Database refers to the logical object created using the SQL command CREATE DATABASE within a database cluster.

Data Migration

How to migrate an existing PostgreSQL cluster to a new Pigsty-managed PostgreSQL cluster with minimal downtime?

Monitoring

Overview of Pigsty’s monitoring system architecture and how to monitor existing PostgreSQL instances

PG Kernels

How to use PostgreSQL kernel forks in Pigsty, such as Citus, Babelfish, IvorySQL, PolarDB, and more.

Module: INFRA

Optional standalone infrastructure that provides NTP, DNS, observability and other foundational services for PostgreSQL.

Administration

Infrastructure components and INFRA cluster administration SOP: create, destroy, scale out, scale in, certificates, repositories…

Module: NODE

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

Module: ETCD

Pigsty deploys etcd as DCS for reliable distributed config storage, supporting PostgreSQL HA.

Parameters

ETCD module provides 13 configuration parameters for fine-grained control over cluster behavior.

Module: MINIO

Pigsty has built-in MinIO support, an open-source S3-compatible object storage that can be used for PGSQL cold backup storage.

Usage

Getting started: how to use MinIO? How to reliably access MinIO? How to use mc / rclone client tools?

Monitoring

How to monitor MinIO in Pigsty? How to use MinIO’s built-in console? What alerting rules are worth noting?

Metrics

Complete list of monitoring metrics provided by the Pigsty MINIO module with explanations

Module: REDIS

Built-in support for Redis in standalone, cluster, or sentinel mode as a high-performance open-source cache companion to PostgreSQL.

Metrics

Complete list of monitoring metrics provided by the Pigsty REDIS module with explanations

Module: FERRET

Add MongoDB-compatible protocol support to PostgreSQL using FerretDB

Module: DOCKER

Docker daemon service that enables one-click deployment of containerized stateless software templates and additional functionality.

Usage

Docker module quick start guide - installation, removal, download, repository, mirrors, proxy, and image pulling.

Module: JUICE

Use JuiceFS distributed filesystem with PostgreSQL metadata to provide shared POSIX storage.

Module: VIBE

Deploy an AI coding sandbox with Pigsty: Code-Server, JupyterLab, Node.js, Claude Code, and Codex CLI.

Module: Kafka

Deploy, secure, and monitor Apache Kafka 4.1+ dynamic KRaft clusters with Pigsty.

Parameters

15 persistent public parameters and transient protected operational variables of the KAFKA module.

All Categories