llms.txt
Compare with other sites' llms.txt files →# PIGSTY
> Pigsty, the FOSS PostgreSQL RDS, self-host PG like a pro, with Monitoring, HA, PITR, IAC, 12 kernels and solutions, and 616 packaged PG extensions
## Site index
- [Home page](https://pigsty.io/index.md)
- [Docs](https://pigsty.io/docs/index.md)
- [Extensions](https://pigsty.io/ext/): Extensions are the soul of PostgreSQL. Pigsty builds, packages, collects, and integrates 626 PG ecosystem extensions for out-of-the-box use.
- [Blog](https://pigsty.io/blog/index.md): Articles about Pigsty, cloud computing, database industry, AI/Agent, and notes on PostgreSQL development, administration, and internals
- [Service](https://pigsty.io/price/index.md): Pigsty offers flexible service plans, from free open source to enterprise support, tailored to your needs
## Documentation index
- [Get Started](https://pigsty.io/docs/setup/index.md): Install Pigsty on one Linux node. Read the setup guide in an ASD-STE100-inspired style.
- [Quick Start](https://pigsty.io/docs/setup/install/index.md): Install, configure, and deploy Pigsty on one Linux node.
- [Docker](https://pigsty.io/docs/setup/docker/index.md): Run Pigsty in a Docker container for local development and testing.
- [Web UI](https://pigsty.io/docs/setup/webui/index.md): Open the Web UI, view monitoring dashboards, and configure domain access.
- [Use PG](https://pigsty.io/docs/setup/pgsql/index.md): Connect to PostgreSQL with command-line tools and graphical clients.
- [Customize](https://pigsty.io/docs/setup/config/index.md): Define nodes, modules, databases, and users in the Pigsty inventory.
- [Playbook](https://pigsty.io/docs/setup/playbook/index.md): Use Ansible playbooks to deploy and manage Pigsty clusters.
- [Offline](https://pigsty.io/docs/setup/offline/index.md): Install Pigsty without Internet access. Use or build offline packages.
- [Slim](https://pigsty.io/docs/setup/slim/index.md): Install PostgreSQL clusters without the monitoring infrastructure.
- [Security Recommendations](https://pigsty.io/docs/setup/security/index.md): Protect credentials, restrict network access, and control access to sensitive files.
- [Deployment](https://pigsty.io/docs/deploy/index.md): Multi-node, high-availability Pigsty deployment for production environments.
- [Prod Install](https://pigsty.io/docs/deploy/install/index.md): How to install Pigsty on Linux hosts for production?
- [Preparation](https://pigsty.io/docs/deploy/prepare/index.md): Production deployment preparation including hardware, nodes, disks, network, VIP, domain, software, and filesystem requirements.
- [Arch Planning](https://pigsty.io/docs/deploy/planning/index.md): How many nodes? Which modules need HA? How to plan based on available resources and requirements?
- [Admin Setup](https://pigsty.io/docs/deploy/admin/index.md): Admin user, sudo, SSH, accessibility verification, and firewall configuration
- [Sandbox](https://pigsty.io/docs/deploy/sandbox/index.md): 4-node sandbox environment for learning, testing, and demonstration
- [Vagrant](https://pigsty.io/docs/deploy/vagrant/index.md): Create local virtual machine environment with Vagrant
- [OpenTofu](https://pigsty.io/docs/deploy/terraform/index.md): Create virtual machine environments on public clouds with OpenTofu
- [Security Considerations](https://pigsty.io/docs/deploy/security/index.md): Credential, network, authentication, encryption, data protection, and audit checks for production Pigsty deployments.
- [Concepts](https://pigsty.io/docs/concept/index.md): Understand Pigsty's core concepts, architecture design, learn how high availability, backup recovery, iac, security works
- [Expire Failure](https://pigsty.io/docs/concept/ha/failure/passive/index.md): Failover path triggered by node crash causing leader lease expiration and cluster election
- [Infra Cluster](https://pigsty.io/docs/concept/model/infra/index.md): Entity-Relationship model for INFRA infrastructure nodes in Pigsty, component composition, and naming conventions.
- [RPO Trade-offs](https://pigsty.io/docs/concept/ha/rpo/index.md): Trade-off analysis for RPO (Recovery Point Objective), finding the optimal balance between availability and data loss.
- [Crash Failure](https://pigsty.io/docs/concept/ha/failure/active/index.md): PostgreSQL primary process crashes while Patroni stays alive and attempts restart, triggering failover after timeout
- [PGSQL Cluster](https://pigsty.io/docs/concept/model/pgsql/index.md): Entity-Relationship model for PostgreSQL clusters in Pigsty, including E-R diagram, entity definitions, and naming conventions.
- [Etcd Cluster](https://pigsty.io/docs/concept/model/etcd/index.md): Entity-Relationship model for ETCD clusters in Pigsty, including E-R diagram, entity definitions, and naming conventions.
- [Network Partition](https://pigsty.io/docs/concept/ha/failure/partition/index.md): Primary loses DCS connectivity, causing lease expiration and triggering split-brain protection and failover
- [Object Storage Cluster](https://pigsty.io/docs/concept/model/minio/index.md): The cluster, instance, and node identity model used when Pigsty's MINIO module deploys Silo.
- [Redis Cluster](https://pigsty.io/docs/concept/model/redis/index.md): Entity-Relationship model for Redis clusters in Pigsty, including E-R diagram, entity definitions, and naming conventions.
- [Nodes](https://pigsty.io/docs/concept/arch/node/index.md): A node is an abstraction of hardware/OS resources—physical machines, bare metal, VMs, or containers/pods.
- [Infrastructure](https://pigsty.io/docs/concept/arch/infra/index.md): Infrastructure module architecture, components, and functionality in Pigsty.
- [PGSQL Arch](https://pigsty.io/docs/concept/arch/pgsql/index.md): PostgreSQL module component interactions and data flow.
- [RTO Trade-offs](https://pigsty.io/docs/concept/ha/rto/index.md): Trade-off analysis for RTO (Recovery Time Objective), finding the optimal balance between recovery speed and false failover risk.
- [Inventory](https://pigsty.io/docs/concept/iac/inventory/index.md): Describe your infrastructure and clusters using declarative configuration files
- [Mechanism](https://pigsty.io/docs/concept/pitr/mechanism/index.md): Snapshots, WAL history, recovery windows, recovery targets, and timelines: the five concepts needed to reason accurately about PostgreSQL PITR.
- [Architecture](https://pigsty.io/docs/concept/pitr/arch/index.md): Pigsty implements PITR with pgBackRest: repository selection, archive flow, scheduling, primary-aware backup execution, performance defaults, and observability.
- [Configure](https://pigsty.io/docs/concept/iac/configure/index.md): Use the configure script to automatically generate recommended configuration files based on your environment.
- [Parameters](https://pigsty.io/docs/concept/iac/parameter/index.md): Fine-tune Pigsty customization using configuration parameters
- [Tradeoffs](https://pigsty.io/docs/concept/pitr/tradeoff/index.md): Repository location determines the failure domain, retention determines the recovery window, and backup frequency shapes restore time. Together they define a backup policy.
- [Recovery](https://pigsty.io/docs/concept/pitr/restore/index.md): Declare the desired pg_pitr recovery target and let pgsql-pitr.yml or pig orchestrate the recovery workflow.
- [Scenarios](https://pigsty.io/docs/concept/pitr/scenarios/index.md): How to choose a recovery target and workflow for accidental DML, dropped objects, defective releases, investigations, and site loss — and why recovery drills must be routine.
- [Templates](https://pigsty.io/docs/concept/iac/template/index.md): Use pre-made configuration templates to quickly generate configuration files adapted to your environment
- [CMDB](https://pigsty.io/docs/concept/iac/cmdb/index.md): Use PostgreSQL as a CMDB metabase to store Ansible inventory.
- [Monitoring System](https://pigsty.io/docs/concept/monitor/index.md): How Pigsty's monitoring system is architected and how monitored targets are automatically managed.
- [Service Access](https://pigsty.io/docs/concept/ha/svc/index.md): Pigsty uses HAProxy to provide service access, with optional pgBouncer for connection pooling, and optional L2 VIP and DNS access.
- [Security Model](https://pigsty.io/docs/concept/sec/level/index.md): Pigsty trust boundaries and defense in depth, with the admin node as a high-trust control plane and a path from the default baseline to production hardening.
- [Authentication](https://pigsty.io/docs/concept/sec/auth/index.md): Pigsty manages PostgreSQL and PgBouncer HBA rules declaratively, combining SCRAM passwords and client certificates to define who may connect and how identity is proven.
- [Access Control](https://pigsty.io/docs/concept/sec/ac/index.md): Pigsty turns least privilege into reusable declarative cluster configuration through a built-in four-tier role model and default privilege templates.
- [Encrypted Communication](https://pigsty.io/docs/concept/sec/ca/index.md): Pigsty provides a self-signed CA that issues certificates and distributes trust for managed components, creating a unified TLS foundation.
- [Data Security](https://pigsty.io/docs/concept/sec/data/index.md): Protect PostgreSQL data integrity, recoverability, confidentiality, and traceability with checksums, backup and PITR, encryption, and audit logs.
- [Compliance](https://pigsty.io/docs/concept/sec/compliance/index.md): Compliance combines configuration, process, and evidence. This page covers launch hardening, MLPS and SOC 2 control mappings, supply-chain integrity, and vulnerability response.
- [About](https://pigsty.io/docs/about/index.md): Learn about Pigsty features, history, licensing, privacy, community, and news.
- [Features](https://pigsty.io/docs/about/feature/index.md): Pigsty's value propositions and highlight features.
- [History](https://pigsty.io/docs/about/history/index.md): The origin and motivation of the Pigsty project, its development history, and future goals and vision.
- [Events](https://pigsty.io/docs/about/event/index.md): News and events related to Pigsty and PostgreSQL, including latest announcements!
- [Roadmap](https://pigsty.io/docs/about/roadmap/index.md): Future feature planning, new feature release schedule, and todo list.
- [Community](https://pigsty.io/docs/about/community/index.md): Pigsty is a Build in Public project. We are very active on GitHub, and Chinese users are mainly active in WeChat groups.
- [Privacy Policy](https://pigsty.io/docs/about/privacy/index.md): What user data does Pigsty software and website collect, and how will we process your data and protect your privacy?
- [License](https://pigsty.io/docs/about/license/index.md): Pigsty's open-source licenses — Apache-2.0 and CC BY 4.0
- [Sponsor Us](https://pigsty.io/docs/about/sponsor/index.md): Pigsty sponsors and investors list - thank you for your support of this project!
- [User Cases](https://pigsty.io/docs/about/case/index.md): Pigsty customer and application cases across various domains and industries
- [Subscription](https://pigsty.io/docs/about/service/index.md): Pigsty Professional/Enterprise subscription service - When you encounter difficulties related to PostgreSQL and Pigsty, our subscription service provides you with comprehensive support.
- [FAQ](https://pigsty.io/docs/about/faq/index.md): Answers to frequently asked questions about the Pigsty project itself.
- [Release Note](https://pigsty.io/docs/about/release/index.md): Pigsty historical version release notes
- [Cost Reference](https://pigsty.io/docs/about/compare/cost/index.md): This article provides cost data to help you evaluate self-hosted Pigsty, cloud RDS costs, and typical DBA salaries.
- [Open-Source Impact](https://pigsty.io/docs/about/compare/impact/index.md): Impact comparison of PostgreSQL ecosystem projects, mainly measured by GitHub star counts.
- [References](https://pigsty.io/docs/ref/index.md): Detailed reference information and lists, supported Linux distros, available modules, metrics, extensions, and more.
- [Supported Linux](https://pigsty.io/docs/ref/linux/index.md): Pigsty compatible Linux OS distribution major versions and CPU architectures
- [Modules](https://pigsty.io/docs/ref/module/index.md): This article lists available Pigsty modules and the current module planning.
- [File Hierarchy](https://pigsty.io/docs/ref/fhs/index.md): How Pigsty's file system structure is designed and organized, and directory structures used by each module.
- [Parameters](https://pigsty.io/docs/ref/param/index.md): Pigsty v4.x configuration overview and module parameter navigation
- [Playbooks](https://pigsty.io/docs/ref/playbook/index.md): Pigsty v4.x preset Ansible playbook navigation and execution notes
- [Port List](https://pigsty.io/docs/ref/port/index.md): Default ports used by Pigsty components, with related parameters and status.
- [Applications](https://pigsty.io/docs/app/index.md): Pigsty application templates and data applets: run stateless apps with Docker Compose and host state in external PostgreSQL and S3-compatible storage.
- [Enterprise Self-Hosted Supabase](https://pigsty.io/docs/app/supabase/index.md): Self-host enterprise-grade Supabase with Pigsty, featuring monitoring, high availability, PITR, IaC, and access to 600 packaged PostgreSQL extensions.
- [Odoo: Self-Hosted Open Source ERP](https://pigsty.io/docs/app/odoo/index.md): Deploy Odoo Community 19 with Pigsty-managed PostgreSQL.
- [Dify: AI Workflow Platform](https://pigsty.io/docs/app/dify/index.md): Self-host Dify with Pigsty, external PostgreSQL, pgvector, and Redis storage.
- [InsForge: AI Backend-as-a-Service](https://pigsty.io/docs/app/insforge/index.md): Self-host InsForge OSS with Pigsty and let Pigsty manage PostgreSQL, backups, monitoring, and ingress.
- [Hindsight: AI Long-Term Memory](https://pigsty.io/docs/app/hindsight/index.md): Self-host Hindsight with Pigsty and store long-term memory in external PostgreSQL.
- [FerretDB: MongoDB Protocol](https://pigsty.io/docs/app/ferretdb/index.md): Deploy a stateless FerretDB proxy on PostgreSQL and DocumentDB managed by Pigsty.
- [Hermes: AI Agent](https://pigsty.io/docs/app/hermes/index.md): Install a pinned Hermes Agent release in a Python virtual environment on a Pigsty host and connect it to an external model provider.
- [Enterprise Software](https://pigsty.io/docs/app/_div_enterprise/index.md)
- [Teable: AI No-Code Database](https://pigsty.io/docs/app/teable/index.md): Self-host Teable with Pigsty, external PostgreSQL, and Silo.
- [Gitea: Git Hosting](https://pigsty.io/docs/app/gitea/index.md): Deploy Gitea with Pigsty's Compose template and connect it to external PostgreSQL.
- [NocoDB: Open-Source Airtable](https://pigsty.io/docs/app/nocodb/index.md): Use NocoDB to transform PostgreSQL databases into smart spreadsheets, a no-code database application platform.
- [Mattermost: Open-Source Team Collaboration](https://pigsty.io/docs/app/mattermost/index.md): Deploy Mattermost with Pigsty and store state in external PostgreSQL.
- [Wiki.js: OSS Wiki Software](https://pigsty.io/docs/app/wiki/index.md): Self-host Wiki.js with Pigsty-managed PostgreSQL as its backend database.
- [Maybe: Self-Hosted Personal Finance](https://pigsty.io/docs/app/maybe/index.md): Self-host the Maybe personal finance application with Pigsty and let Pigsty manage PostgreSQL, backups, monitoring, and ingress.
- [Immich: Self-Hosted Photo and Video Library](https://pigsty.io/docs/app/immich/index.md): Self-host Immich, the open-source Google Photos alternative, with Pigsty managing its metadata, vector search, backups, and ingress.
- [Kong: API Gateway](https://pigsty.io/docs/app/kong/index.md): Deploy Kong with Pigsty Compose templates and PostgreSQL backend storage.
- [Metabase: BI Analytics Tool](https://pigsty.io/docs/app/metabase/index.md): Use Metabase for rapid business intelligence analysis with a user-friendly interface for team self-service data exploration.
- [Registry: Container Image Cache](https://pigsty.io/docs/app/registry/index.md): Deploy a Docker Registry pull-through cache and optional web UI with Pigsty.
- [JumpServer: Open-Source Bastion Host](https://pigsty.io/docs/app/jumpserver/index.md): Self-host JumpServer Community Edition with Pigsty managing its PostgreSQL backend, backups, ingress, and operations.
- [ByteBase: Schema Migration](https://pigsty.io/docs/app/bytebase/index.md): Deploy Bytebase with Pigsty's Docker Compose template and connect it to external PostgreSQL.
- [pgAdmin: PostgreSQL GUI](https://pigsty.io/docs/app/pgadmin/index.md): Deploy pgAdmin4 with Pigsty's Docker Compose template and safely load the PostgreSQL server inventory.
- [Database Tools](https://pigsty.io/docs/app/_div_tools/index.md)
- [PGWeb: Browser-based PostgreSQL Client](https://pigsty.io/docs/app/pgweb/index.md): Run the bundled pgweb Docker application for small, interactive PostgreSQL queries from a browser.
- [PostgREST: Auto-Generated API](https://pigsty.io/docs/app/postgrest/index.md): Deploy PostgREST with Pigsty Compose templates and auto-generate REST APIs from PostgreSQL schema.
- [Electric: PostgreSQL Sync Engine](https://pigsty.io/docs/app/electric/index.md): Self-host Electric with Pigsty to sync PostgreSQL data to frontend apps with partial replication and real-time delivery.
- [Jupyter: Notebooks and Data Analysis](https://pigsty.io/docs/app/jupyter/index.md): Run JupyterLab with Pigsty's standalone Docker Compose template and access PostgreSQL safely.
- [PG Exporter: Containerized Metrics](https://pigsty.io/docs/app/pg-exporter/index.md): Run PG Exporter with a standalone Docker Compose template and configure its database connection, listening port, and metrics path.
- [Data Applications](https://pigsty.io/docs/app/_div_applet/index.md)
- [PGLOG CSV Log Analysis](https://pigsty.io/docs/app/pglog/index.md): A sample Applet included with Pigsty for analyzing PostgreSQL CSV log samples
- [ISD Global Weather Data Query](https://pigsty.io/docs/app/isd/index.md): Demonstrate how to import data into a database using the ISD dataset as an example
- [WHO COVID-19 Pandemic Dashboard](https://pigsty.io/docs/app/covid/index.md): A sample Applet included with Pigsty for visualizing World Health Organization official pandemic data
- [StackOverflow Global Developer Survey](https://pigsty.io/docs/app/sf-survey/index.md): Analyze database-related data from StackOverflow's global developer survey over the past seven years
- [DB-Engines Database Popularity Trend Analysis](https://pigsty.io/docs/app/db-engine/index.md): Analyze database management systems on DB-Engines and browse their popularity evolution
- [AWS & Aliyun Server Pricing](https://pigsty.io/docs/app/cloud/index.md): Analyze compute and storage pricing on Aliyun / AWS (ECS/ESSD)
- [Conf Sample](https://pigsty.io/docs/conf/index.md): Batteries-included configuration templates for specific scenarios, with detailed explanations.
- [Solo Templates](https://pigsty.io/docs/conf/_div_solo/index.md)
- [meta](https://pigsty.io/docs/conf/meta/index.md): Default single-node installation template with extensive configuration parameter descriptions
- [rich](https://pigsty.io/docs/conf/rich/index.md): Feature-rich single-node configuration with local software repository, all extensions, Silo backup, and complete examples
- [slim](https://pigsty.io/docs/conf/slim/index.md): Minimal installation template without monitoring infrastructure, installs PostgreSQL directly from internet
- [fat](https://pigsty.io/docs/conf/fat/index.md): Feature-All-Test template, single-node installation of all extensions, builds local repo with PG 14-18 all versions
- [infra](https://pigsty.io/docs/conf/infra/index.md): Only installs observability infrastructure, dedicated template without PostgreSQL and etcd
- [vibe](htt