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 ⌘ with K on macOS, or Ctrl with K, to open local search and the command palette from anywhere.
Getting Started
Learn the project, understand the concepts, get hands-on on a single node, then go to production — four steps to master Pigsty:
Understand Pigsty’s architecture and design philosophy: high availability, backup & recovery, security and compliance.
Architecture Cluster Model Monitoring IaC HA PITR Service Access Security
Spin up a single-node Pigsty on your laptop or cloud server, and access database services and the web UI.
Plan, prepare, and roll out multi-node, high-availability Pigsty deployments in production environments.
Get Started: Prepare a node with a fresh Linux installation, and run as a user with passwordless ssh and sudo privileges:
Download, Configure and Deploy — Pigsty completes installation in 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 (username / password: admin / pigsty).
You can also wrap PostgreSQL kernel flavors as RDS services: Citus, WiltonDB, IvorySQL, OpenHalo, Percona, OrioleDB, PolarDB, and Supabase.
Modules
Pigsty is composed of modules. Among them, PGSQL / INFRA / NODE / ETCD (the PINE stack) are required for self-hosting PostgreSQL RDS services:
Self-healing HA PostgreSQL clusters: HA, PITR, IaC, ACL, and monitoring included, with massive extension support out of the box.
Configuration Administration Backup & PITR Services Kernels Parameters
Nginx, local software repo, DNS, NTP, and the VictoriaMetrics & Grafana observability stack.
Manage host nodes into the desired state: node monitoring, log collection, VIP, and HAProxy load balancing.
Reliable distributed consensus storage (DCS), providing cluster metadata for PostgreSQL high availability.
There are also optional modules that work well alongside PostgreSQL, bringing extra value to your data infrastructure:
S3-compatible object storage, an optional centralized repository for database backups.
High-performance in-memory data structure server with standalone, cluster, and sentinel modes.
Container runtime for launching containerized, stateless software and application templates.
JuiceFS distributed file system with PostgreSQL as the metadata engine, providing shared POSIX storage.
AI coding sandbox: Code-Server, JupyterLab, Claude Code, and Codex CLI.
Apache Kafka 4.x dynamic KRaft message queue clusters with security and monitoring included.
Native MySQL 8.4 LTS as a standalone instance or a three-node InnoDB Cluster.
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:
Detailed reference lists: operating systems, file hierarchy, ports, metrics, and product comparisons.
Linux Support Modules File Hierarchy Ports Comparison Cost Reference SOP
A catalog of 576 packaged PostgreSQL ecosystem extensions: metadata, docs, downloads, and support matrix.
Ready-to-use cluster configuration templates, plus containerized software and application templates.
Manuals for the companion tools Pigsty builds upon: packaging, HA, connection pooling, backup, and monitoring.