Skip to content

Pigsty Docs v4.5

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

—— Battery-Included, Local-First PostgreSQL Distribution as a Free & Open-Source RDS Alternative

Free & Open Source Local First Production Ready

GitHub | Demo | Blog | Discuss | Discord | DeepWiki | Roadmap | Chinese Docs

Press ⌘K on macOS, or CtrlK, to open local search and the command palette from anywhere.

Getting Started

Learn Pigsty in four steps: read about the project, understand the concepts, try a single-node installation, and deploy to production.

Get Started: Prepare a node with a fresh Linux installation. Run these commands as a user with passwordless ssh and sudo privileges:

Terminal
curl -fsSL https://repo.pigsty.io/get | bash -s v4.5.0   # download the public stable source
cd ~/pigsty      # enter source dir
./configure      # generate config
./deploy.yml     # run installation

Download, Configure, and Deploy Pigsty. Installation takes minutes. You can add more nodes and database clusters later.

Next, explore the Web UI. Access PostgreSQL services on port 5432 and Grafana dashboards on port 3000. The Grafana username and password are admin and pigsty.

You can also wrap PostgreSQL kernel flavors as RDS services: Citus, WiltonDB, IvorySQL, OpenHalo, Percona, OrioleDB, PolarDB, and Supabase.

Modules

Pigsty consists of modules. The PGSQL, INFRA, NODE, and ETCD modules form the PINE stack. These modules are required to self-host complete PostgreSQL RDS services:

Optional modules provide additional functions for your PostgreSQL data infrastructure:

MINIOOPTIONAL

S3-compatible object storage, an optional centralized repository for database backups.

REDISOPTIONAL

High-performance in-memory data structure server with standalone, cluster, and sentinel modes.

DOCKEROPTIONAL

Container runtime for launching containerized, stateless software and application templates.

JUICEOPTIONAL

JuiceFS distributed file system with PostgreSQL as the metadata engine, providing shared POSIX storage.

VIBEOPTIONAL

AI coding sandbox: Code-Server, JupyterLab, Claude Code, and Codex CLI.

KAFKAOPTIONAL

Apache Kafka 4.x dynamic KRaft message queue clusters with security and monitoring included.

MYSQLOPTIONAL

Native MySQL 8.4 LTS as a standalone instance or a three-node InnoDB Cluster.

PILOTPILOT

Experimental module family: Kubernetes, DuckDB, TigerBeetle, and more for early adopters.

Reference

Comprehensive references, the extension catalog, ready-to-use templates, and companion tool manuals:

Last Modified 2026-10-12 · update extensions (4d4b1d96)