English
简体中文

Docs From core concepts and quick start to production deployment, module references, and day-to-day operations. Blog Pigsty technical articles and the complete release archive.

Pigsty v5.0 Documentation
- Docs
  PIGSTY
  
  Get Started
  
  Quick Start
  
  Docker
  
  Web UI
  
  Use PG
  
  Customize
  
  Playbook
  
  Offline
  
  Slim
  
  Security Recommendations
  
  Deployment
  
  Prod Install
  
  Preparation
  
  Arch Planning
  
  Admin Setup
  
  Sandbox
  
  Vagrant
  
  Terraform
  
  Security Considerations
  
  Concepts
  
  Architecture
  
  Nodes
  
  Infrastructure
  
  PGSQL Arch
  
  ER Model
  
  Infra Cluster
  
  PGSQL Cluster
  
  Etcd Cluster
  
  Object Storage Cluster
  
  Redis Cluster
  
  Infra as Code
  
  Inventory
  
  Configure
  
  Parameters
  
  Templates
  
  CMDB
  
  High Availability
  
  RPO Trade-offs
  
  Failure Model
  
  Expire Failure
  
  Crash Failure
  
  Network Partition
  
  RTO Trade-offs
  
  Service Access
  
  PITR
  
  Mechanism
  
  Architecture
  
  Tradeoffs
  
  Recovery
  
  Scenarios
  
  Security
  
  Security Model
  
  Authentication
  
  Access Control
  
  Encrypted Communication
  
  Data Security
  
  Compliance
  
  About
  
  Features
  
  History
  
  Events
  
  Roadmap
  
  Community
  
  Privacy Policy
  
  License
  
  Sponsor Us
  
  User Cases
  
  Subscription
  
  FAQ
  
  Comparison
  
  Cost Reference
  
  Open-Source Impact
  
  Reference
  
  References
  
  Supported Linux
  
  Modules
  
  File Hierarchy
  
  Parameters
  
  Playbooks
  
  Port List
  
  Conf Sample
  
  Solo Templates
  
  meta
  
  rich
  
  slim
  
  fat
  
  infra
  
  vibe
  
  docker
  
  Kernel Templates
  
  pgsql
  
  pg19
  
  mssql
  
  polar
  
  ivory
  
  agens
  
  pgedge
  
  mysql
  
  pgtde
  
  oriole
  
  Mongo
  
  HA Templates
  
  ha/simu
  
  ha/octo
  
  ha/full
  
  ha/safe
  
  ha/trio
  
  ha/dual
  
  ha/citus
  
  Misc Templates
  
  demo/bare
  
  demo/el
  
  demo/debian
  
  demo/demo
  
  demo/kernel
  
  demo/minio
  
  demo/redis
  
  demo/kafka
  
  demo/mysql
  
  build/oss
  
  build/dev
  
  demo/remote
  
  demo/saas
  
  demo/wool
  
  SOP
  
  Modules
  
  Module: PGSQL
  
  Core Concepts
  
  Configuration
  
  Cluster / Instance
  
  Kernel Version
  
  Package Alias
  
  User/Role
  
  Database
  
  HBA Rules
  
  Access Control
  
  Parameters
  
  Service/Access
  
  Security
  
  Administration
  
  Administration
  
  Cluster Admin
  
  User Admin
  
  Database Admin
  
  Patroni HA Admin
  
  HBA Admin
  
  Pgbouncer Admin
  
  Component Admin
  
  Crontab Admin
  
  Extension Admin
  
  Version Upgrade
  
  Backup & Restore
  
  Backup Policy
  
  Restore Operations
  
  Clone a PG Cluster
  
  Backup Mechanism
  
  Backup Repository
  
  Admin Commands
  
  Data Migration
  
  Tutorials
  
  Troubleshooting
  
  Manual PITR Drill
  
  Enable HugePage
  
  Fork Instance
  
  Accidental Deletion
  
  HA Drill: 2/3 Failure
  
  Bind a L2 PG VIP
  
  Setup HA Citus
  
  Reference
  
  Monitoring
  
  Dashboard
  
  Overview
  
  PGSQL Overview
  
  PGSQL Alert
  
  PGSQL Shard
  
  Cluster
  
  PGSQL Cluster
  
  PGRDS Cluster
  
  PGSQL Activity
  
  PGSQL Replication
  
  PGSQL Service
  
  PGSQL Databases
  
  PGSQL Patroni
  
  PGSQL PITR
  
  Instance
  
  PGSQL Instance
  
  PGRDS Instance
  
  PGCAT Instance
  
  PGSQL Persist
  
  PGSQL Proxy
  
  PGSQL Pgbouncer
  
  PGSQL Session
  
  PGSQL Xacts
  
  PGSQL Exporter
  
  Database
  
  PGSQL Database
  
  PGCAT Database
  
  PGSQL Tables
  
  PGSQL Table
  
  PGCAT Table
  
  PGSQL Query
  
  PGCAT Query
  
  PGCAT Locks
  
  PGCAT Schema
  
  Metrics
  
  Parameters
  
  Playbook
  
  Extensions
  
  Quick Start
  
  Introduction
  
  Packages
  
  Download
  
  Install
  
  Config
  
  Create
  
  Update
  
  Remove
  
  Default Extensions
  
  Repository
  
  PG Kernels
  
  PostgreSQL
  
  Supabase
  
  Babelfish
  
  Percona
  
  openHalo
  
  OrioleDB
  
  Cloudberry
  
  AgensGraph
  
  pgEdge
  
  DocumentDB
  
  Citus
  
  IvorySQL
  
  PolarDB PG
  
  PolarDB Oracle
  
  Param Templates
  
  Optimize Params
  
  OLTP Template
  
  OLAP Template
  
  CRIT Template
  
  TINY Template
  
  FAQ
  
  Module: INFRA
  
  Configuration
  
  Parameters
  
  Playbook
  
  Monitoring
  
  Metrics
  
  FAQ
  
  Administration
  
  Nginx Management
  
  Software Repository
  
  Domain Management
  
  Module Management
  
  CA and Certificates
  
  Grafana HA
  
  Module: NODE
  
  Configuration
  
  Parameters
  
  Playbook
  
  Administration
  
  Monitoring
  
  Metrics
  
  FAQ
  
  Module: ETCD
  
  Configuration
  
  Parameters
  
  Administration
  
  Playbook
  
  Monitoring
  
  Metrics
  
  FAQ
  
  Module: MINIO
  
  Usage
  
  Configuration
  
  Parameters
  
  Playbook
  
  Administration
  
  Monitoring and Alerting
  
  Metrics
  
  FAQ
  
  Module: REDIS
  
  Configuration
  
  Parameters
  
  Playbook
  
  Administration
  
  Monitoring
  
  Metrics
  
  FAQ
  
  Module: DOCKER
  
  Usage
  
  Parameters
  
  Playbooks
  
  Metrics
  
  FAQ
  
  Module: JUICE
  
  Configuration
  
  Parameters
  
  Playbook
  
  Administration
  
  Monitoring
  
  FAQ
  
  Module: VIBE
  
  Configuration
  
  Parameters
  
  Playbook
  
  Administration
  
  Monitoring
  
  FAQ
  
  Module: KAFKA
  
  Quick Start
  
  Configuration
  
  Parameters
  
  Administration
  
  Playbook
  
  Monitoring
  
  Metrics
  
  FAQ
  
  Module: MYSQL
  
  Configuration
  
  Parameters
  
  Administration
  
  Playbook
  
  Monitoring
  
  Metrics
  
  FAQ
- Blog
  Releases
  
  Pigsty v4.5.0
  
  Pigsty v4.4.0
  
  Pigsty v4.3.0
  
  Pigsty v4.2.2
  
  Pigsty v4.2.1
  
  Pigsty v4.2.0
  
  Pigsty v4.1.0
  
  Pigsty v4.0.0
  
  Pigsty v3.7.0
  
  Pigsty v3.6.1
  
  Pigsty v3.6.0
  
  Pigsty v3.5.0
  
  Pigsty v3.4.1
  
  Pigsty v3.4.0
  
  Pigsty v3.3.0
  
  Pigsty v3.2.2
  
  Pigsty v3.2.1
  
  Pigsty v3.2.0
  
  Pigsty v3.1.0
  
  Pigsty v3.0.4
  
  Pigsty v3.0.3
  
  Pigsty v3.0.2
  
  Pigsty v3.0.1
  
  Pigsty v3.0.0
  
  Pigsty v2.7.0
  
  Pigsty v2.6.0
  
  Pigsty v2.5.1
  
  Pigsty v2.5.0
  
  Pigsty v2.4.1
  
  Pigsty v2.4.0
  
  Pigsty v2.3.1
  
  Pigsty v2.3.0
  
  Pigsty v2.2.0
  
  Pigsty v2.1.0
  
  Pigsty v2.0.2
  
  Pigsty v2.0.1
  
  Pigsty v2.0.0
  
  Pigsty v1.5.1
  
  Pigsty v1.5.0
  
  Pigsty v1.4.1
  
  Pigsty v1.4.0
  
  Pigsty v1.3.1
  
  Pigsty v1.3.0
  
  Pigsty v1.2.0
  
  Pigsty v1.1.1
  
  Pigsty v1.1.0
  
  Pigsty v1.0.1
  
  Pigsty v1.0.0
  
  Pigsty v0.9.1
  
  Pigsty v0.9.0
  
  Pigsty v0.8.0
  
  Pigsty v0.7.0
  
  Pigsty v0.6.0
  
  Pigsty v0.5.2
  
  Pigsty v0.5.1
  
  Pigsty v0.5.0
  
  Pigsty v0.4.0
  
  Pigsty v0.3.0
  
  Pigsty v0.0.5
  
  Pigsty v0.0.4
  
  Pigsty v0.0.3
  
  Pigsty v0.2.0
  
  Pigsty v0.1.0
  
  Posts

Module

PIGSTY

PostgreSQL In Great STYle

A free, open-source, battery-included, local-first enterprise PostgreSQL distribution.

Start

Documentation
Quick Start
Production
Concepts

Modules

PGSQL
INFRA
NODE
ETCD

Content

Post
Release
Config Templates
Reference

Community

GitHub
Discussions
Pigsty v4 Docs
Legacy Chinese Docs

Powered by OINK 0.6.0

简体中文

English
简体中文

Keyboard shortcuts

Section navigation

WS↑↓: Move through sidebar
AD←→: Collapse or expand section
EnterG: Open focused page
JK: Previous or next heading
QE: Previous or next page

Actions

/F: Search
\C: Command palette
H: Reading mode
LY: Switch language
T: Switch theme
R: Cycle top-level pages

↑↓ Navigate ↵ Open esc Close