Reference

JupyterLab is an interactive notebook, terminal, and data-analysis environment. Pigsty v4.5.0 has two distinct deployment paths: The VIBE module, managed by Ansible and systemd, for the complete v4.5.0 development sandbox. The lightweight standalone …

Dify is an open-source platform for developing generative AI and LLM applications. It supports agent creation, AI workflows, RAG retrieval, and model management. These features help users build and operate generative AI applications. Pigsty supports …

Odoo is open-source ERP software with CRM, sales, inventory, and other business applications. The template stays on Odoo Community 19.0 for addon compatibility and uses PostgreSQL 18. Odoo 19 requires PostgreSQL 13 or later and Python 3.10 or later; …

Overview GitHub Repository: https://github.com/pgsty/pigsty-app/tree/master/cloud Online Demo: https://demo.pigsty.io/d/ecs Article: Analyzing Computing Costs: Has Aliyun Really Reduced Prices? Data Source Download Aliyun ECS prices as raw CSV data …

Overview GitHub Repository: https://github.com/pgsty/pigsty-app/tree/master/db Online Demo: https://demo.pigsty.io/d/db-engine

Overview GitHub Repository: https://github.com/pgsty/pigsty-app/tree/master/db Online Demo: https://demo.pigsty.io/d/sf-survey

Public Demo: http://wiki.pigsty.cc The current Compose uses the untagged requarks/wiki image. Stable 2.x releases are maintained in requarks/wiki-v2; the original requarks/wiki repository contains 3.x Beta releases. The image resolved to 2.5.316 …

Gitea is a lightweight open-source Git hosting platform. Pigsty’s app/gitea template uses external PostgreSQL mode by default. Configure the database through GITEA_DB_* values in .env. Quick Start cd ~/pigsty/app/gitea vi .env # check domain, ports, …

PostgREST exposes PostgreSQL schemas directly as REST APIs. Pigsty provides the app/postgrest template, with default port 8884. Quick Start cd ~/pigsty/app/postgrest vi .env # check DB_URI / DB_SCHEMA / JWT make up Default endpoints: http://<IP>:8884 …

Kong is an open-source API gateway. Pigsty’s app/kong template stores configuration in PostgreSQL. It automatically runs the one-time kong-migration job. Quick Start cd ~/pigsty/app/kong vi .env # check KONG_PG_* and port settings make Default ports: …

PGLOG is a sample Pigsty application that uses pglog.sample in MetaDB as its data source. Load logs into this table, then open the related dashboard. Pigsty provides commands to retrieve CSV logs and load them into the sample table. These shortcuts …

PGWeb Client PGWeb is a browser-based PostgreSQL client. Pigsty includes a small Docker Compose template in app/pgweb. It publishes container port 8081 on host port 8886. cd ~/pigsty/app/pgweb make up # docker compose up -d If the portal entry …

Covid is a sample applet included with Pigsty. It visualizes the World Health Organization’s official pandemic data. Browse COVID-19 infections and deaths by country and region, and view global pandemic trends. Overview GitHub Repository: …

Use the open-source Vonng/isd project to explore weather data in your database. Use the existing Grafana monitoring system to browse sub-hourly weather data interactively. It covers nearly 30,000 surface stations over the past 120 years. This is a …

2026-10-11 Name Old New Comment arrow 22.0.0 24.0.0 / 25.0.1 Bookworm 24.0.0, others 25.0.1; includes compute/devel; imported locally groonga 15.1.7 / 15.1.9 / 16.0.0 16.0.5 / 16.1.3 Bookworm 16.0.5, others 16.1.3; includes libgroonga-dev; imported …

2026-10-11 Name Old New Comment arrow 22.0.0 25.0.1 Includes compute/devel; ABI 2500; imported locally groonga 15.1.8 16.1.3 Includes libs/devel; upstream packages; imported locally groonga-tokenizer-mecab 15.1.8 16.1.3 MeCab tokenizer; imported …

2026-10-16 Name Old New Comment claude 2.1.296 2.1.301 Official checksums and actual Linux binary versions verified for both architectures; imported locally cloudflared 2026.10.0 2026.10.1 Both architectures; imported locally code 1.141.0 1.142.0 …

Consul is a distributed DCS, KV, DNS, and service registry/discovery component. Pigsty 1.x used Consul as its high-availability DCS. The current open-source tree no longer includes the Consul role, playbook, or consul_* parameters. You cannot use the …

Kubernetes is a production-grade, open-source container orchestration platform. It helps you automate, deploy, scale, and manage containerized applications. Pigsty has native support for ETCD clusters, which can be used as external etcd for …

TigerBeetle is a financial accounting transaction database offering extreme performance and reliability. Overview The current open-source tree has no TigerBeetle role or dedicated playbook. It provides only the tigerbeetle installation alias in the …

DuckDB is a high-performance embedded analytical database. DuckDB is embedded, so it does not require deployment or service management. Install the DuckDB package on the node and use it directly. Installation The current Pigsty node platform mapping …

How mature is the MYSQL module? This pilot targets simple, low-cost MySQL clusters. Deployment/convergence, HA failover, daily backups, and monitoring/alerts have systematic tests, including fault injection and complete-outage exercises. Destructive …

mysqld_exporter supplies raw mysql_ metrics. vmalert derives mysql:ins:* and mysql:cls:* metrics for dashboards and alerts. This page defines those metrics. Common Labels Metrics carry job=mysql, cls, ins, ip, and topology (standalone or …

MYSQL sends mysqld_exporter metrics to VictoriaMetrics and Journald/Vector error logs to VictoriaLogs. Grafana supplies five dashboards. vmalert loads 68 recording rules and 27 alerts. Collection Architecture Each node runs mysqld_exporter on 9104 …

mysql.yml deploys and adjusts clusters to declared state. Separate mysql-rm.yml retires members or clusters with safeguards. Before every removal, recheck the target, backups, and exact confirmation value. mysql.yml Selected clusters follow check → …

Declare state in the inventory and apply it with the playbook. Most dropped members or AdminAPI drift recover after ./mysql.yml -l <cluster>. Member replacement, physical restore, and complete-outage recovery require the manual procedures below. …

Deployment exposes 11 parameters; removal adds two protected-operation parameters. Versions, ports, directories, charset, TLS paths, and schedules are fixed. Memory sizing follows node specifications. Use mysql_parameters to change server behavior. …

Declare the cluster in inventory. mysql.yml adjusts live state to match. This page covers topology and configuration blocks. See Parameters for the full reference. Before You Deploy Manage nodes with NODE. Install the shared CA at /etc/pki/ca.crt …

MySQL is a widely used open-source relational database. Pigsty’s MYSQL module installs a fixed native MySQL 8.4 LTS platform on managed nodes. Choose a standalone instance or three-node single-primary InnoDB Cluster with Group Replication. The module …

How mature is the current KAFKA module? The v1 baseline provides dynamic KRaft, full-cluster checks, cold start and repair, serial broker admission, and dynamic controller join. It supports retirement of live or dead members and three-command …

Both metric sources use job=kafka. JMX targets have a role label and collect each JVM’s internal state. Protocol targets lack role and collect logical cluster, topic, partition, and consumer-group state through Kafka protocol. Protocol exporters run …

Kafka monitoring combines metrics, logs, dashboards, and alerts. It covers JVM internals and the Kafka protocol view. You can inspect partitions, ISR, and consumer lag together with JVM state, request queues, and KRaft controller health. Scrape …

KAFKA exposes 15 persistent parameters. The role derives topology, listeners, security, storage subdirectories, replication safety, and exporter placement consistently. Additional persistent variables cannot override these derived settings. Parameter …

KAFKA uses 15 persistent public parameters. The role derives topology, listeners, storage subdirectories, replication safety, authorization, and exporter placement consistently. Start with Quickstart. See Parameters for the field reference. Plan …

Kafka is a distributed event-streaming platform. Pigsty’s KAFKA module installs Apache Kafka 4.1+ dynamic KRaft clusters on managed nodes from RPM/DEB packages. It manages security, resources, lifecycle, and observability. Current status: Beta module …

Deployment code-server package not found Make sure that NODE and the repository configuration are ready: yum repolist # EL apt-cache policy # Debian/Ubuntu, read-only inspection ./infra.yml -l infra -t repo --check JupyterLab installation failed …

VIBE monitoring mainly uses Claude Code OpenTelemetry data. Code-Server and JupyterLab do not expose Prometheus metrics. Use systemd and logs to check their health. Claude Code Observability VIBE writes default OpenTelemetry env vars into …

The VIBE module has 18 parameters in these groups: Common Code-Server JupyterLab Node.js Claude Code Codex CLI Overview Parameter Type Level Default Description vibe_data path C /fs Workspace dir code_enabled bool C true Enable Code-Server code_port …

Enable VIBE components as needed. VIBE provides a shared workspace and exposes services through the Nginx portal. Overview Component Enable Param Default Description Code-Server code_enabled Enabled VS Code in browser JupyterLab jupyter_enabled …

The VIBE module provides a browser-based development environment. It includes Code-Server, JupyterLab, Node.js, Claude Code, and Codex CLI. It can use JUICE for shared storage and PGSQL for database functions. VIBE depends on NODE and INFRA: NODE …

Port Conflicts? Multiple instances on the same node must use different port values. Example: juice_instances: fs1: path: /fs1 meta: postgres://... port: 9567 fs2: path: /fs2 meta: postgres://... port: 9568 Why does changing data not take effect? …

JuiceFS instances expose Prometheus metrics via juicefs mount --metrics. In JUICE, the metrics endpoint listens on 0.0.0.0:<port>. The default port is 9567. Monitoring Architecture JuiceFS Mount (metrics: 0.0.0.0:<port>) ↓ VictoriaMetrics (scrape) ↓ …

The JUICE module has 2 parameters: juice_cache: shared cache directory juice_instances: instance definition dict Parameter Overview Parameter Type Level Description juice_cache path C JuiceFS shared cache directory juice_instances dict I JuiceFS …

Concepts and Implementation JuiceFS consists of a metadata engine and data storage. The current version passes meta to juicefs as the metadata engine URL. Production deployments typically use PostgreSQL. Data storage is defined by data options …

JuiceFS is a high-performance, POSIX-compatible distributed filesystem. It can mount object storage or databases as a local filesystem. The JUICE module depends on NODE for infrastructure and the package repository. It typically uses PGSQL as the …

Who Can Run Docker Commands? By default, Pigsty adds two users to the Docker operating system group. One is the management user that runs the playbook: the SSH login user on the target node. The other is the admin user specified by …

This snapshot records 123 monitoring metric families for the DOCKER module. The metrics present at runtime vary with package version, enabled collectors, and target state. Metric Name Type Labels Description builder_builds_failed_total counter ip, …

The DOCKER module provides 8 configuration parameters. Parameter Overview Use the DOCKER parameter group to deploy and configure the Docker container engine. It controls the enable switch, data directory, storage driver, registry mirrors, and …

Pigsty includes Docker support. Use it to deploy containerized applications quickly. Getting Started Docker is an optional module. The docker_enabled parameter controls Docker installation. It is disabled by default. The docker-ce upstream repository …

Docker is a widely used containerization platform. It provides a standard way to deliver software. Pigsty provides Docker as an optional module. Pigsty does not require Docker to deploy its components. Select the Docker software, tool, and …

ABORT due to redis_safeguard enabled This means the Redis instance you are trying to remove has the safeguard enabled. If redis_safeguard is true, redis-rm.yml always refuses to run. The switch does not check whether an instance is running. First, …

This page is a snapshot of 275 monitoring metric categories for the REDIS module. The actual runtime metric set varies with package version, enabled collectors, and target state. Metric Name Type Labels Description ALERTS Unknown cls, ip, level, …

Dashboards The REDIS module provides 3 monitoring dashboards: Redis Overview: Overview of all Redis clusters Redis Cluster: Details of a single Redis cluster Redis Instance: Details of a single Redis instance Monitoring Pigsty provides three …

The REDIS module has 22 parameters: 19 for Redis/Valkey deployment and configuration, and 3 for removal. Parameter Overview Use the REDIS parameter group to deploy and configure Redis clusters. It controls identity, instance definitions, operating …

Concept The Redis entity model is similar to the PostgreSQL model. It includes Cluster and Instance entities. Here, Cluster does not mean native Redis Cluster mode. REDIS uses a single-node multi-instance deployment. PGSQL uses a 1:1 deployment. …

REDIS is Pigsty’s Redis-compatible cache module. Select Redis or Valkey with redis_type. The default remains redis. Both engines support primary-replica replication, Sentinel, and native cluster mode. They share configuration paths, instance service …

Which backend does the MINIO module deploy by default? In v4.5.0, the current source deploys only Silo. The only valid minio_type value is silo. MINIO remains the module name for compatibility. This name does not indicate that the MinIO server is …

The MINIO module collects Silo metrics through /minio/metrics/v3. The metric set varies with the server version and enabled features. This page describes the stable interfaces used by current dashboards and alerts. A complete scrape from one version …

Administration UI Silo provides an administration UI through minio_admin_port, which defaults to 9001. Access it directly at https://<node-ip>:9001. Some configuration templates also expose the administration entry point at m.pigsty. Login …

The MINIO module exposes 22 public parameters in two groups: MINIO: 19 parameters for deploying Silo object-storage clusters MINIO_REMOVE: 3 parameters controlling object-storage cluster removal Architecture Change: Pigsty v3.6+ Since Pigsty v3.6, …

Before deploying the MINIO module, define a Silo object-storage cluster in the config inventory. The current role requires minio_type: silo and supports these inventory deployment modes: Single-Node Single-Disk: SNSD: Single-node single-disk mode, …

First, configure Silo and deploy it with the playbook. Then use this page to access its compatible S3 and mcli interfaces. Deploy Cluster First, define a single-node, single-disk object-storage cluster in the config inventory and explicitly pin its …

MINIO is Pigsty’s compatibility module name for S3-compatible object storage. The current role deploys Silo, and minio_type accepts only silo. Silo preserves the MinIO S3/Admin APIs, MINIO_* environment variables, disk format, and mcli client …

What is etcd’s role in Pigsty? etcd is a distributed, reliable key-value store for critical system data. Pigsty uses etcd as the DCS (Distributed Config Store) for Patroni. It stores PostgreSQL HA status. Patroni uses etcd for cluster failure …

This snapshot records 177 monitoring metric families for the ETCD module. The metrics present at runtime vary with package version, enabled collectors, and target state. Metric Name Type Labels Description etcd:ins:backend_commit_rt_p99_5m Unknown …

Dashboards The ETCD module provides one monitoring dashboard: Etcd Overview. ETCD Overview Dashboard ETCD Overview: Overview of ETCD cluster The dashboard shows key ETCD status information. The ETCD Aliveness panel shows the overall cluster service …

The ETCD module has 13 parameters, divided into two sections: ETCD: 10 parameters for etcd cluster deployment and configuration ETCD_REMOVE: 3 parameters for controlling etcd cluster removal Architecture Change: Pigsty v3.6+ Since Pigsty v3.6, …

Before deployment, define the etcd cluster in the configuration inventory. Typical choices are: One Node: No HA, suitable for dev, test, demo, or standalone deployments using external S3 backup for PITR Three Nodes: Basic HA, tolerates 1 node …

ETCD is a distributed, reliable key-value store for critical system configuration data. Pigsty uses etcd as a DCS (Distributed Config Store). It is critical for PostgreSQL high availability and automatic failover. The ETCD module depends on NODE. The …

How to configure NTP service? NTP is critical for production services. If it is not configured, use public NTP services or Chronyd on the admin node as the time source. If the nodes already have NTP configured, set node_ntp_enabled to false to …

This page is a snapshot of 727 monitoring metric categories for the NODE module. The actual runtime metric set varies with package version, enabled collectors, and target state. Metric Name Type Labels Description ALERTS Unknown alertname, ip, level, …

The NODE dashboard directory contains 10 monitoring dashboards. Pigsty also provides comprehensive alert rules. Dashboards The NODE dashboard directory currently contains 10 dashboards. The JuiceFS and Claude Code dashboards show data only after …

The NODE module configures target nodes to the required state. It also adds them to the Pigsty monitoring system. Parameter Section Description NODE_ID Node identity parameters NODE_DNS Node DNS resolution NODE_PACKAGE Upstream repo & package install …

Pigsty uses the IP address as the unique node identifier. Use the internal IP address on which the database instance listens and provides services. node-test: hosts: 10.10.10.11: { nodename: node-test-1 } 10.10.10.12: { nodename: node-test-2 } …

Configure nodes to the required state and monitor them. Manage node settings, VIP, HAProxy, and exporters.

This section covers daily administration and operations for Pigsty deployments.

What components are included in the INFRA module? The current infra role directly manages these components: Nginx: Exposes Grafana, VictoriaMetrics (VMUI), Alertmanager, and other WebUIs, and hosts local YUM/APT repositories. DNSMasq: Provides DNS …

Note: Pigsty v4.0 replaced Prometheus/Loki with VictoriaMetrics/Logs/Traces. This metric list comes from v3.x. Use it only to troubleshoot older versions. For current metrics, query https://p.pigsty (VMUI) or Grafana directly. Future versions will …

This document describes monitoring dashboards and alert rules for the INFRA module in Pigsty. Dashboards Pigsty provides the following monitoring dashboards for the Infra module: Dashboard Description Pigsty Home Pigsty monitoring system homepage …

The INFRA module deploys Pigsty infrastructure. This includes the local software repository, Nginx, DNSMasq, VictoriaMetrics, VictoriaLogs, Grafana, Alertmanager, and Blackbox Exporter. It also deploys other monitoring and alerting components. Pigsty …

Configuration Guide INFRA primarily provides monitoring infrastructure. It is optional for PostgreSQL databases. INFRA failures typically do not affect PostgreSQL cluster operation. Exceptions apply if you manually configure dependencies on INFRA …

Configuration | Administration | Playbooks | Monitoring | Parameters Overview Each Pigsty deployment includes infrastructure components that serve managed nodes and database clusters: Component Port Description Nginx 80/443 Web service portal, local …

Pigsty provides supplementary extension repositories. They supply extension packages in addition to those in the official PGDG repository. YUM Repository Use this repository with EL 8/9/10 and compatible systems, such as RHEL, Rocky, AlmaLinux, and …

Why can’t my current user use the pg admin alias? Since Pigsty v4.0, only members of admin on administration nodes can manage global Patroni and PostgreSQL clusters with pg. The node.yml playbook creates the administration user dba with this …

During PostgreSQL cluster initialization, Pigsty installs and enables some core extensions by default. Default Installed Extensions Pigsty installs these extensions by default through pg_packages: Extension Description pg_repack Handle table bloat …

Extension removal has two levels: drop extension objects from the database, and uninstall packages from the operating system. Drop Extension Objects Use DROP EXTENSION to remove extensions from the database: -- Drop extension DROP EXTENSION pgvector; …

Update extensions at two levels: packages in the operating system, and extension objects in the database. Update Packages Use package managers to update extension packages: # EL systems sudo yum update pgvector_18* # Debian/Ubuntu systems sudo apt …

After you install extension packages, run CREATE EXTENSION in the database to use their features. View Available Extensions After you install extension packages, run these queries to show the available extensions: -- View all available extensions …

Some extensions require you to preload dynamic libraries or configure parameters before use. This section gives the configuration procedures. Preload Extensions After installation, you can enable most extensions with CREATE EXTENSION. Some extensions …

Before you install extensions, make sure that their packages are available from the local repository or an upstream repository. Default Behavior By default, Pigsty downloads the base PostgreSQL 18 kernel packages to the local software repository. The …

Pigsty uses package aliases to simplify extension installation and management. Package Alias Mechanism Extensions have different names at different layers: Layer Example pgvector Example postgis Extension Name vector postgis, postgis_topology, … …

Pigsty includes 600 precompiled PostgreSQL extensions that are ready to use. What are Extensions PostgreSQL extensions add database functionality without changes to the core code. An extension typically consists of three parts: Control file …

In Pigsty, you can replace the native PostgreSQL kernel with a variant that provides specialized features. Pigsty supports multiple PostgreSQL kernels and compatibility branches within one operational framework. These kernels provide compatibility …

Pigsty provides four preset Patroni/PostgreSQL config templates optimized for different workloads: Template CPU Cores Use Case Characteristics /docs/pgsql/template/oltp.yml 4-128C OLTP transactions High concurrency, low latency …

If all cluster nodes share one L2 network, you can optionally define an L2 VIP for the PostgreSQL cluster. The VIP uses Master-Backup mode. It always points to the node that runs the cluster primary instance. VIP-Manager manages the VIP. It reads the …

Pigsty provides 600 packaged extensions that are ready to use. The extensions cover 16 major categories, including time-series, geospatial, vector, full-text search, analytics, and feature enhancements. To use extensions in Pigsty, complete four …

Install PGSQL only on nodes that Pigsty manages through the NODE module. The deployment also needs an available ETCD cluster to store cluster metadata. Install PGSQL on one node to create a standalone server, which is a primary instance. Install it …

The PGSQL module provides 638 available monitoring metrics. Metric Name Type Labels Description ALERTS Unknown category, job, level, ins, severity, ip, alertname, alertstate, instance, cls N/A ALERTS_FOR_STATE Unknown category, job, level, ins, …

Pigsty provides Grafana monitoring dashboards for PostgreSQL: Demo & Gallery. The current source provides 31 PostgreSQL-related dashboards. It includes 29 PostgreSQL / PGCAT dashboards under files/grafana/pgsql and two PGLOG dashboards under …

This page describes the Pigsty monitoring architecture, including metrics, logs, and target management. It also explains how to monitor existing PostgreSQL clusters and remote RDS services. Monitoring Overview Pigsty uses these observability …

Parameters and reference documentation

Pigsty includes the pgsql-migration.yml playbook for online database migration with logical replication. The generated automation scripts can reduce application downtime to a few seconds. Logical replication requires PostgreSQL 10 or later. If the …

Detailed explanation of Host-Based Authentication (HBA) in Pigsty. Authentication supports Access Control and Default Privileges. PostgreSQL supports several authentication methods. This page describes HBA, or Host-Based Authentication. HBA rules …

In this context, Database refers to the logical object created using the SQL command CREATE DATABASE within a database cluster. A PostgreSQL server can serve multiple databases at the same time. In Pigsty, define the required databases in the …

In this context, users refer to logical objects within a database cluster created using the SQL commands CREATE USER/ROLE. In PostgreSQL, users belong to the database cluster, rather than a specific database. Create business users before you create …

Pigsty uses pgBackRest for PostgreSQL backups. It supports full, differential, and incremental backups, parallel processing, encryption, and Silo/S3 object storage. By default, Pigsty configures backup and WAL archiving for every PGSQL cluster. This …

Database administration and operation tasks

Pigsty access-control documentation is organized by purpose: Access Control Concepts: role model, default privileges, database ACLs, and instance-isolation boundaries. Access Control Configuration: pg_default_roles, pg_users, pg_default_privileges, …

Separate read and write operations, route traffic correctly, and deliver PostgreSQL cluster capabilities reliably. A service exposes database cluster capabilities to clients. It hides the details of the underlying cluster. Services provide stable …

PostgreSQL security combines authentication, authorization, network boundaries, encrypted communication, data protection, and operating procedures. Pigsty provides configuration parameters for these mechanisms. Operators must still harden, verify, …

Split read and write operations, route traffic correctly, and reliably deliver PostgreSQL cluster capabilities. A service exposes database cluster capabilities to clients. It hides the details of the underlying cluster. Services provide stable …

Pigsty uses configuration to control PostgreSQL behavior. This configuration combines inventory files in ~/pigsty/conf/*.yml with PGSQL parameters. After you write the configuration, you can reproduce a customized cluster in a few minutes. The …

demo/wool targets small cloud instances in China. It defaults to region: china, PostgreSQL 18, and the tiny tuning profiles. Overview Config Name: demo/wool Node Count: Single node Suggested Size: Approximately 2 vCPU / 2 GB for testing Related: …

Core concepts and architecture design

demo/saas is a legacy single-node example with many features. It includes predefined business users, databases, and application entrypoints. It demonstrates how to combine PostgreSQL, Silo, Redis, Docker, and the portal. Overview Config Name: …

demo/remote declares multiple pg_exporters on an INFRA node. These exporters monitor remote PostgreSQL, PolarDB, or cloud RDS instances. The template does not deploy a local PostgreSQL cluster. Overview Config Name: demo/remote Local Node Count: One …

The build/dev template defines a local environment with three nodes for Pigsty development. It tests repository builds and package downloads on EL9, Debian 12, and Ubuntu 24. Use this template only for development and contribution work. Overview …

The build/oss template configures a build environment for offline packages of the Pigsty open-source edition. Use it to build offline installation packages for multiple operating systems in batches. This configuration is intended for developers and …

demo/mysql provides a four-node example for the native MySQL 8.4 LTS pilot module. The separate conf/mysql.yml template provides MySQL protocol compatibility through the OpenHalo PostgreSQL kernel. Overview Config Name: demo/mysql Node Count: 4 …

The demo/kafka template defines two Kafka 4.x dynamic KRaft clusters on four nodes. The development cluster kf-meta uses one node and plaintext connections. The demonstration cluster kf-test uses three nodes with TLS, SCRAM, and ACLs. Overview Config …

The demo/redis configuration demonstrates the standalone/replica, Sentinel, and native Cluster modes of Pigsty’s Redis module. Overview Config Name: demo/redis Node Count: 4 Clusters: redis-ms, redis-meta, redis-test Related: demo/demo ./configure -c …

demo/minio demonstrates a highly available S3 object-storage cluster. The cluster has four nodes and four drives per node, for a total of 16 drives. The template retains MINIO module names for compatibility and explicitly sets minio_type: silo. The …

The demo/kernel template demonstrates the PostgreSQL kernels and compatible branches that Pigsty supports. Use it to validate features and compare kernel behavior. Do not use this demonstration template for production. Overview Config Name: …

Pigsty’s public demonstration site uses the demo/demo template. It shows public service access, SSL certificate configuration, and installation of all available extensions. Use this template as a reference for a public service on a cloud server. …

The demo/debian template supplies configuration for Debian and Ubuntu. Overview Config Name: demo/debian Node Count: Single node Description: Debian/Ubuntu optimized configuration template OS Distro: d12, d13, u22, u24, u26 OS Arch: x86_64, aarch64 …

The demo/el template supplies configuration for Enterprise Linux distributions. These include RHEL, Rocky Linux, Alma Linux, and Oracle Linux. Overview Config Name: demo/el Node Count: Single node Description: Enterprise Linux optimized configuration …

demo/bare is the smallest Pigsty configuration example. It defines three core groups and three global parameters to show the basic inventory structure. Overview Config Name: demo/bare Node Count: Single node Modules: INFRA, ETCD, PGSQL Related: meta, …

PGSQL is the core Pigsty module. An Ansible inventory declares PostgreSQL clusters. Patroni and etcd manage high availability. pgBackRest provides backup and PITR. HAProxy, VIP, DNS, PgBouncer, and the observability stack expose and monitor database …

The app/jumpserver template deploys JumpServer Community Edition. It uses Pigsty-managed PostgreSQL 18 as its external database. The current validation uses JumpServer v5.0.0-ce. Overview Config Name: app/jumpserver Node Count: Single node Web Port: …

The app/immich template deploys Immich. It uses Pigsty-managed PostgreSQL 18 for metadata and vector indexes. The template follows v3. On 2026-10-08, validation of Immich 3.3.0 on Linux amd64 with PostgreSQL 18.6 used a new media library and covered …

The app/hindsight template deploys Hindsight. It replaces the built-in development database with external PostgreSQL managed by Pigsty. For details, see: Hindsight Deployment Tutorial Overview Config Name: app/hindsight Node Count: Single node …

The app/insforge template deploys InsForge OSS. It uses Pigsty-managed PostgreSQL as the external database. For details, see: InsForge Deployment Tutorial Overview Config Name: app/insforge Node Count: Single node Description: Deploy InsForge App, …

The app/registry template provides a reference configuration for Docker Registry as an image proxy. It acts as a Docker Hub pull-through cache by default. Overview Config Name: app/registry Node Count: Single node Description: Deploy Docker Registry …

The app/mattermost template deploys Mattermost with Pigsty-managed PostgreSQL, Nginx, and monitoring. By default, the application and database share one node. For application usage details, see Mattermost: Open-Source IM. Overview Config Name: …

The app/teable template provides a reference configuration for the Teable open-source no-code database. It uses PostgreSQL managed by Pigsty. Overview Config Name: app/teable Node Count: Single node Description: Deploy Teable using Pigsty-managed …

The app/maybe template deploys Maybe, an open-source personal finance management system. It uses Pigsty-managed PostgreSQL as its database. Overview Config Name: app/maybe Node Count: Single node Description: Deploy Maybe finance management using …

The app/electric template deploys the Electric SQL synchronization service. Electric synchronizes data from PostgreSQL to clients in real time. Overview Config Name: app/electric Node Count: Single node Description: Deploy Electric real-time sync …

The app/dify template deploys the Dify AI application development platform. It uses Pigsty-managed PostgreSQL and pgvector for vector storage. For more details, see Dify Deployment Tutorial Overview Config Name: app/dify Node Count: Single node …

The app/odoo template provides a reference configuration to self-host Odoo Community 19. It uses PostgreSQL managed by Pigsty. For more details, see Odoo Deployment Tutorial Overview Config Name: app/odoo Node Count: Single node Description: Deploy …

The supabase template provides a reference configuration to self-host Supabase. It uses PostgreSQL managed by Pigsty for the underlying storage. For more details, see Supabase Self-Hosting Tutorial Overview Config Name: supabase Node Count: Single …

The ha/citus template deploys a Citus distributed PostgreSQL cluster. It has 1 infrastructure node, 1 coordinator group, and 5 worker groups. The coordinator and worker groups contain 12 Citus nodes in total. The cluster distributes data into shards …

The ha/dual template deploys one primary and one standby on two nodes. This Semi-HA configuration provides limited failover when only two servers are available. Overview Config Name: ha/dual Node Count: Two nodes Description: Two-node limited HA …

Electric is a PostgreSQL sync engine. It delivers database changes efficiently to frontend and edge applications. Pigsty provides the app/electric template (conf/app/electric.yml). It configures the database, containers, and ingress in one workflow. …

Three nodes is the minimum scale for majority-based high availability. The ha/trio template distributes INFRA, ETCD, PGSQL, and Silo across three servers. PostgreSQL, ETCD, and object storage continue serving when one server is unavailable. Overview …

ha/safe uses a three-node high-availability topology. It demonstrates TLS, client certificates, password checks, backup encryption, the CRIT parameter template, and related security settings. Customize this configuration example for your environment. …

Getting Started Path Order Question Entry 1 What modules does Pigsty include? Modular Architecture, PGSQL Architecture, PGSQL Cluster Model 2 How do I get it running first? Quick Start, Web UI, PostgreSQL Quick Start 3 How should I read the config …

The ha/full template defines the recommended Pigsty sandbox. It deploys two PostgreSQL clusters on four nodes for tests and feature demonstrations. Most Pigsty tutorials and examples are based on this template’s sandbox environment. Overview Config …

JumpServer is an open-source PAM and bastion-host system. It manages centralized access to SSH, RDP, database, and web assets. Pigsty’s app/jumpserver template runs Community Edition application containers with Docker Compose. Pigsty-managed …

Pigsty provides the app/registry template (conf/app/registry.yml) for: Docker Registry cache service (default 5000) Optional management UI (default 5080) The default images are registry:3.1.2 and joxit/docker-registry-ui:2.6.0. The template is a …

Metabase is an open-source business intelligence tool. Teams can quickly explore and visualize data through its interface without SQL knowledge. Metabase provides many chart types and connects to different databases. These features support enterprise …

ha/octo builds a compact high-availability simulation with the first eight nodes from vagrant/spec/deci.rb. It exercises co-located modules, VIPs, remote backup, and larger membership counts. Do not use it directly as a production blueprint without …

The ha/simu configuration template simulates a production environment with 20 nodes. It requires a powerful host machine. Overview Config Name: ha/simu Node Count: 20 nodes, pigsty/vagrant/spec/simu.rb Description: 20-node production environment …

Immich is a high-performance, self-hosted photo and video management application. It is a popular open-source alternative to Google Photos, licensed under AGPL-3.0. Features include web and mobile uploads, album sharing, timelines, maps, EXIF and RAW …

Maybe is an open-source personal finance application. It manages accounts, transactions, budgets, investments, and household financial views. This Rails application stores production business data in PostgreSQL and uses Redis for background job …

Use -c with configure to select a template. Specify its path relative to conf/, without the .yml suffix. If you omit -c, Pigsty uses the meta template. Category Templates Solo Templates meta, rich, fat, slim, infra, vibe, docker Kernel Templates …

Mattermost is an open-source team collaboration platform and a private alternative to Slack. Pigsty provides app/mattermost (conf/app/mattermost.yml). It stores application state in external PostgreSQL and keeps file directories on host paths. Quick …

NocoDB is an open-source Airtable alternative that turns any database into a smart spreadsheet. Use its visual interface to create database applications without code. NocoDB supports PostgreSQL, MySQL, SQL Server, and other databases. You can use it …

Teable is a no-code database platform for team collaboration. Pigsty provides the app/teable template (conf/app/teable.yml). Its default dependencies are PostgreSQL + Silo + Docker. It does not require Redis. Quick Start curl -fsSL …

FerretDB provides a MongoDB-compatible protocol over PostgreSQL and the DocumentDB extension. Pigsty’s app/ferretdb runs the stateless protocol proxy. PostgreSQL, the postgres database, DocumentDB extensions, and a backend PostgreSQL login role must …

Hindsight is a PostgreSQL-native long-term memory service for AI agents. Pigsty provides the app/hindsight configuration template (conf/app/hindsight.yml). By default, it uses Pigsty-managed PostgreSQL instead of Hindsight’s built-in development …

InsForge is an open-source Backend-as-a-Service platform for AI coding agents, built around PostgreSQL. It provides authentication, database APIs, file storage, a model gateway, edge functions, site deployment, and payment integrations. These …

Pigsty can deploy Supabase on your physical, virtual, or cloud servers with a single command. Self-hosting provides more extensions, performance options, control, and potential cost savings. As of August 2026, the official Supabase self-hosting guide …

Pigsty applications have two categories: Software Templates: Docker Compose templates under ~/pigsty/app/<name> for stateless business components. Data Applets: PostgreSQL + Grafana analytics demos, mainly for learning and showcase use. Application …

The mongo configuration template is a PostgreSQL deployment mode, not an independent Pigsty module. It combines: PostgreSQL 18 managed by the standard PGSQL module The documentdb extension and its required preload libraries A stateless FerretDB proxy …

This page lists the default ports for Pigsty module components. Adjust them as needed. Use this list to configure specific firewall rules. Module Component Port Parameter Status NODE node_exporter 9100 node_exporter_port Enabled NODE haproxy 9101 …

The oriole configuration template uses the OrioleDB storage engine instead of PostgreSQL’s default Heap storage. It provides bloat-free, high-performance OLTP capability. Overview Config Name: oriole Node Count: Single node Description: OrioleDB …

This page summarizes Pigsty v4.x playbook entries and usage guidance by module. For detailed task tags, open each module’s playbook page. Module Playbook Navigation Module Count Playbooks INFRA 3 deploy.yml infra.yml infra-rm.yml NODE 2 node.yml …

The pgtde configuration template uses the Percona PostgreSQL database kernel. This kernel provides Transparent Data Encryption (TDE). Overview Config Name: pgtde Node Count: Single node Description: Percona PostgreSQL transparent data encryption …

Use this page to find Pigsty v4.x parameters. For full explanations, read each module’s param page. The current source and parameter reference pages confirm 373 public parameters across the 10 official modules. Native MySQL 8.4 remains a pilot …

The mysql configuration template uses the OpenHalo database kernel instead of native PostgreSQL. OpenHalo provides MySQL wire protocol and SQL syntax compatibility. Overview Config Name: mysql Node Count: Single node Description: OpenHalo …

Pigsty FHS The default Pigsty home directory is ~/pigsty. It has this file structure: ~/pigsty Source Tree app/Application template resourcesbin/Management and operations scriptsfiles/victoria/Rules and operations scriptsgrafana/Grafana …

The pgedge configuration template uses the pgEdge kernel instead of native PostgreSQL. The kernel provides distributed, multi-master capabilities for edge deployments. For the full guide, see: pgEdge kernel guide. For kernel differences and version …

Official Modules Module Category Status Docs Path Summary PGSQL Core GA /docs/pgsql High-availability PostgreSQL clusters with built-in backup, monitoring, SOP, and extension ecosystem. INFRA Core GA /docs/infra Local software repository + …

Pigsty runs on Linux with amd64/x86_64 and arm64/aarch64 architectures. It supports three major distribution families: EL, Debian, and Ubuntu. Pigsty runs directly on the host without containers. It supports actively maintained mainstream releases in …

The agens template replaces the standard PostgreSQL kernel with AgensGraph. It supports property graphs and Cypher queries. For the full guide, see: AgensGraph kernel guide Overview Config name: agens Node count: Single node Description: AgensGraph …

The ivory template replaces the standard PostgreSQL kernel with Highgo’s IvorySQL. IvorySQL supports Oracle syntax and PL/SQL. For the complete tutorial, see: IvorySQL (Oracle Compatible) Kernel Guide Overview Config Name: ivory Node Count: Single …

This version does not include the cloudberry configuration template. For Cloudberry support, see these pages: Kernel: Cloudberry Config Templates

The polar configuration template uses Alibaba Cloud’s PolarDB for PostgreSQL kernel instead of native PostgreSQL. This cloud-native kernel separates storage and compute in an architecture similar to Aurora. For the complete tutorial, see: PolarDB for …

The mssql configuration template uses a PostgreSQL 17-compatible Babelfish kernel instead of native PostgreSQL. It provides Microsoft SQL Server wire protocol (TDS) and T-SQL syntax compatibility. The current template fixes the version at pg_version: …

pg19 is the single-node PostgreSQL 19 Beta evaluation template. It follows the meta topology and enables the beta repository. The local repository’s additional cache contains only core PGSQL packages. The template does not preinstall extensions. …

The pgsql configuration template uses the native PostgreSQL kernel. This is Pigsty’s default database kernel, with stable support for PostgreSQL 14 to 18. The current configure command also accepts version 19. PG19 remains Beta. Use the dedicated …

The docker template runs Pigsty in a Docker container. It supplies the minimum single-node infrastructure and PostgreSQL components. For full workflow details, see Docker Deployment. Overview Config Name: docker Node Count: Single node (container …

The vibe configuration template provides a ready-to-use AI coding sandbox. It includes Code-Server (Web VS Code), JupyterLab, Claude Code observability, and Codex CLI. It also includes the JuiceFS distributed filesystem and a PostgreSQL database with …

The infra template deploys the Pigsty monitoring infrastructure, including VictoriaMetrics, Grafana, VictoriaLogs, and Nginx. It does not deploy PostgreSQL or etcd. Use it as a standalone monitoring system for external PostgreSQL or RDS instances and …

The fat configuration template is Pigsty’s Feature-All-Test template. It installs all extension plugins on one node. It also builds a local software repository with all extensions for PostgreSQL 14-18, which covers five major versions. Use this …

The slim configuration template provides a minimal installation of a PostgreSQL high-availability cluster. It installs packages directly from the internet. It does not deploy Infra monitoring infrastructure. If you need a database instance without a …

The rich configuration template extends meta. Use it to try the complete set of features. Use this template to build a local software repository, use Silo backup storage, or run Docker applications. It also provides preconfigured business databases. …

The meta configuration template is the default Pigsty template. It deploys PostgreSQL on one node, which is the core function of Pigsty. For compatibility across operating system distributions and architectures, meta installs only the minimum …

Source: pgBackRest Command Docs: version Display the installed pgBackRest version. Command Options Output Option (--output) Output type. The following output types are supported: text - Display the installed pgBackRest version as text. num - Display …

Source: pgBackRest Command Docs: verify Verify checks whether repository backups and archives are valid. Command Options Output Option (--output) Output type. The following output types are supported: none - No verify output. text - Output verify …

Source: https://patroni.readthedocs.io/en/latest/releases.html Version 4.1.5 Released 2026-08-12 Compatibility improvements Compatibility with PostgreSQL 14.24, 15.19, 16.15, 17.11, 18.6 (Alexander Kukushkin) Add the new output_plugin_libraries GUC, …

Use pig pitr to restore a local PostgreSQL instance from pgBackRest backups. For a managed restore, PIG stops services as needed and restores the data. By default, it then starts PostgreSQL and leaves Patroni stopped for you to verify the recovered …

Source: pgBackRest Command Docs: stop Prevent new pgBackRest processes from running. By default, existing processes can finish. Use --force to terminate them. After stop completes, new pgBackRest processes return an error. See Starting and Stopping …

pig pgbackrest (alias pig pb) creates backups, restores data, and manages pgBackRest stanzas. It runs pgBackRest as the PostgreSQL operating-system user, selected by --dbsu or $PIG_DBSU (default postgres). Before the first backup, install pgBackRest …

Source: https://patroni.readthedocs.io/en/latest/faq.html This section answers common Patroni questions. Each subsection covers a different topic. For more help or unexpected problems, see chatting and reporting_bugs. Comparison with other HA …

Use pig pe to read metrics from a running pg_exporter and reload its configuration. The full command name is pig pg_exporter. Aliases are pe, pgexp, and pgexporter. pig pe get # Show PostgreSQL metrics pig pe list # List PostgreSQL metric families …

China PostgreSQL Ecosystem Projects Sorted by GitHub stars in descending order. Last updated: 2026-09-20 (Beijing time). Project Star Author Type Summary pgsty/pigsty 5660 Ruohang Feng @ PGSTY Distribution Out-of-the-box PostgreSQL distribution …

Overview The following data shows approximate differences in cost. Cloud prices and discounts vary with time, region, instance size, and purchase model. EC2 Core·Month RDS Core·Month DHH Self-Hosted Core-Month Price (192C 384G) 25.32 Junior Open …

Source: pgBackRest Command Docs: start After stop prevents pgBackRest processes from running, use start to permit them again. This does not immediately start any processes. See Starting and Stopping for details and examples. General Options Allow …

pig patroni (alias pig pt) runs the installed patronictl command. Use it to inspect cluster members, change cluster configuration, and switch the primary. PIG selects the configuration file and provides local service, status, and log commands. Other …

Comparison with RDS Pigsty is a local-first RDS alternative under Apache-2.0. You can deploy it on your physical machines, virtual machines, or cloud servers. This comparison uses two benchmarks: Amazon AWS RDS for PostgreSQL and Alibaba Cloud RDS …

Source: pgBackRest Command Docs: stanza-upgrade Immediately after a PostgreSQL major version upgrade, update pg-path in all pgBackRest configurations to the new database location. Then run stanza-upgrade. It upgrades the stanza in every repository …

The latest Pigsty release is v4.5.0. Version Release Date Summary Release Page v4.5.0 2026-08-15 Silo, Kafka, MySQL, Valkey, 575 extensions, and safer orchestration v4.5.0 v4.4.0 2026-07-10 PG 19 beta support, 531 extensions, kernel updates, pig CLI …

pig postgres (alias pig pg) manages local PostgreSQL instances and databases. Use it to initialize or control an instance, run SQL, maintain tables, and create database copies. Use pig pt for Patroni cluster operations and pig pitr for recovery with …

pig do runs administration playbooks from the selected Pigsty directory. It uses the inventory to add clusters, create databases and users, install packages, or remove services. Define the target configuration in the inventory first, then run the …

pig inventory (alias pig inv) inspects, edits, and validates the Pigsty inventory, pigsty.yml. It also checks deployment prerequisites and exchanges configuration with PostgreSQL through the experimental cmdb commands. When you edit a fragment, PIG …

What is Pigsty, and what is it not? Pigsty is a PostgreSQL distribution and a local-first, open-source RDS solution. It provides tools and operational practices for managing a DBMS. It is not itself a Database Management System (DBMS). For …

Pigsty combines tools from the PostgreSQL ecosystem with automated database management. It helps users use PostgreSQL, the world’s most popular database. Pigsty resolves many PostgreSQL operational issues. Enterprise service quality also requires …

Source: pgBackRest Command Docs: stanza-delete The stanza-delete command removes repository data for a stanza. WARNING: Use this command with care. It permanently removes every backup and archive for the specified stanza from the pgBackRest …

pig sty installs Pigsty, prepares the controller, generates configuration, and runs deployment playbooks. It also manages dashboards through the Grafana HTTP API. Command Purpose sty init Download and extract Pigsty into an installation directory sty …

Google Analytics page views and download statistics indicate approximately 100,000 Pigsty users. About half are in mainland China and half in other regions. They work in internet services, cloud computing, finance, autonomous driving, manufacturing, …

Source: pgBackRest Command Docs: stanza-create After configuring a stanza in pgbackrest.conf, run stanza-create. With multiple repositories, pgBackRest creates the stanza in each one. It skips existing stanzas, so you can safely repeat …

Sponsor Us PostgreSQL community members develop Pigsty as free and open-source software. It integrates the PostgreSQL ecosystem and promotes PostgreSQL adoption. If it helps you, consider these ways to support the project: Sponsor the project …

License Summary Pigsty core uses Apache-2.0; documentation uses CC BY 4.0. Official License: https://github.com/pgsty/pigsty/blob/main/LICENSE Pigsty Core The Pigsty core is licensed under Apache License 2.0. Apache-2.0 is a permissive open-source …

Source: pgBackRest Command Docs: server-ping Ping a pgBackRest TLS server to check whether it accepts connections. This checks availability only; it does not attempt authentication. If the command line does not specify a host, use tls-server-host. …

Pigsty Software For offline installation in a network-isolated environment, we receive no data about you. During online installation, our servers or cloud provider servers log the requesting machine’s IP address and/or hostname and downloaded …

pig build downloads sources, installs dependencies, and produces RPM/DEB packages using Pigsty build recipes. Use it on an EL, Debian, or Ubuntu build host. Rust, pgrx, and the Xray client also support their respective macOS workflows. Command …

GitHub Find the project at github.com/pgsty/pigsty. You can support it with a star. Contribute feature suggestions, new issues, or pull requests. For documentation problems, submit issues to github.com/pgsty/pigsty.cc. Press ⌘+ with K on macOS, or …

Release Strategy Pigsty uses semantic versioning: <major>.<minor>.<patch>. Alpha/Beta/RC versions will have suffixes like -a1, -b1, -c1 appended to the version number. Major versions introduce incompatible foundational changes and major features. …

Source: pgBackRest Command Docs: server The pgBackRest server allows access to remote hosts without using the SSH protocol. Command Options TLS Server Address Option (--tls-server-address) TLS server address. Set the IP address on which the server …

pig ext searches the extension catalog and installs, updates, or removes PostgreSQL extension packages on the host. It also supports PostgreSQL server packages. After installing a package, apply the SQL and configuration required by the extension. …

Source: pgBackRest Command Docs: restore By default, restore selects the latest backup from the first repository that has backups. See Quick Start - Restore a Backup. The repository order comes from pgbackrest.conf; for example, repo1 precedes …

pig repo manages Linux package repositories. Use it to add or remove APT/YUM/DNF sources, refresh indexes, and create or extract offline bundles. repo create also supports macOS through SOW. Command Description Notes repo list Print available …

Source: pgBackRest Command Docs: repo-ls This command works like Unix ls on any supported repository type. Supply an absolute path or a path relative to --repo-path. It mainly supports administration, investigation, and testing. A normal pgBackRest …

pig manages PostgreSQL packages, local database services, and Pigsty deployments. Choose a command below for your task. Use pig COMMAND --help to see the options supported by your installed program. pig repo: manage software repositories pig ext: …

Source: pgBackRest Command Docs: repo-get This command works like Unix cat on any supported repository type. Supply a fully qualified file name. It mainly supports administration, investigation, and testing. A normal pgBackRest setup does not …

Source: https://www.pgbouncer.org/faq.html How to connect to PgBouncer? PgBouncer acts as a Postgres server. Configure your client to use the PgBouncer port. How to load-balance queries between several servers? PgBouncer supports comma-separated …

Source: pgBackRest Command Docs: info The info command reports on one stanza or all stanzas. By default, text output summarizes backups for the requested stanzas. The text format can change in any release. For machine-readable output, use …

You can set PostgreSQL parameters at several levels with different scopes and priorities. Pigsty supports four levels, from global to local: Level Scope Configuration Method Storage Location Cluster All instances in cluster Patroni DCS / Tuning …

Source: pgBackRest Command Docs: help Help has three levels. With no command, pgBackRest shows general help. With a command, such as pgbackrest help backup, it shows the command description and valid options. Add an option, such as pgbackrest help …

Introduction These answers cover specific questions that the User Guide and references might not cover. If your issue is absent, check the pgBackRest Issues List in GitHub. What if I get the “could not find WAL segment” error? This error has several …

Source: https://www.pgbouncer.org/changelog.html · 1.26.0 source PgBouncer 1.26.x 2026-09-23 - PgBouncer 1.26.0 - “Ignore all previous search_path” Security Fix CVE-2026-19888: PgBouncer before 1.26.0 did not check that the SCRAM …

Access control combines roles, object privileges, database ACLs, and HBA. This page describes configuration parameters. For design and boundaries, see Access Control Concepts. Pigsty provides a compact ACL model described by these parameters: …

Introduction pgBackRest release numbers have major and minor parts. A major release may break compatibility with the previous major release. However, v2 releases fully support v1 repositories and accept all v1 options. Minor releases can add …

Overview HBA (Host-Based Authentication) controls who can connect to a database, from which source, and with which authentication method. For the authentication model and default rules, see Authentication. Pigsty manages HBA rules through …

Source: pgBackRest Command Docs: expire pgBackRest rotates full backups according to a count or time period. Count-based retention keeps a specified number of backups, regardless of their creation times. Differential retention uses a count, but a …

tiny.yml is optimized for micro instances and environments with limited resources. It is designed for CPUs with 1-3 cores. It minimizes resource use, limits memory allocation, and disables parallel queries. Pair with node_tune = tiny for OS-level …

Source: https://patroni.readthedocs.io/en/latest/patronictl.html The patronictl command-line interface communicates with the Patroni REST API and the DCS. Use it for cluster operations, interactively or in scripts. Configuration patronictl uses 3 …

Source: https://www.pgbouncer.org/downloads/ PgBouncer 1.26 File Date Size Checksum pgbouncer-1.26.0.tar.gz 2026-09-23 897943 bytes sha256 PgBouncer 1.25 File Date Size SHA256 pgbouncer-1.25.2.tar.gz 2026-05-08 865371 bytes sha256 …

In this document, “database” refers to a logical object within a database cluster created with CREATE DATABASE. A PostgreSQL cluster can serve multiple databases at the same time. Define the required databases in the Pigsty cluster configuration. …

Introduction You can configure pgBackRest entirely with command-line parameters. For complex installations or many options, a configuration file is more practical. Its default location is /etc/pgbackrest/pgbackrest.conf. If that file is absent, …

Source: pgBackRest Command Docs: check The check command validates pgBackRest and archive_command configuration for the specified stanza. It checks backup and archive settings for all repositories and databases configured on the current host. It …

In this document, “user” refers to a logical object within a database cluster created with CREATE USER/ROLE. In PostgreSQL, users belong to the database cluster, rather than a specific database. Create business users before you create business …

The latest stable version is v1.10.0. Version Date Summary GitHub v1.10.0 2026-10-17 603 catalog entries, PostgreSQL target and recovery safety, faithful Inventory, automation fixes v1.10.0 v1.9.0 2026-10-06 600 catalog entries, Xray roles, …

Source: https://patroni.readthedocs.io/en/latest/rest_api.html Patroni uses its REST API during leader races. patronictl uses it for failovers, switchovers, reinitialization, restarts, and reloads. HAProxy and other load balancers use it for HTTP …

crit.yml is for transactional workloads with increased consistency and audit requirements. It forces data checksums and Patroni strict synchronous mode. It also adds connection logging and adjusts selected WAL, timeout, and parallel-query parameters. …

Source: https://pgbackrest.org/command.html Introduction Commands execute pgBackRest functions. Each command page lists every applicable option, including options shared with other commands. The lists also include options that you can set in …

Source: pgBackRest Command Docs: backup With multiple repositories, pgBackRest backs up to the highest priority repository, such as repo1. Use --repo to select another repository. pgBackRest has no built-in scheduler. Use cron or another scheduler …

Source: https://patroni.readthedocs.io/en/latest/patroni_configuration.html There are 3 types of Patroni configuration: Global dynamic configuration. These options are stored in the DCS (Distributed Configuration Store) and apply to all nodes. …

PostgreSQL package names differ between operating systems: EL systems (RHEL/Rocky/Alma/…) use formats like pgvector_18, postgis36_18* Debian/Ubuntu systems use formats like postgresql-18-pgvector, postgresql-18-postgis-3 Without aliases, you need …

olap.yml is optimized for online analytical processing (OLAP) on CPUs with 4-128 cores. It supports large queries, high parallelism, relaxed timeouts, and aggressive vacuum. Pair with node_tune = olap for OS-level tuning. Use Cases Use the OLAP …

Recent News 2026-08-15: Pigsty v4.5.0 officially released: Kafka, MySQL, Valkey, Silo, and 575 extensions Release Blog: Pigsty v4.5 Release Article Release Notes: v4.5.0 Highlights: Kafka KRaft and MySQL 8.4 pilot modules, Valkey in REDIS, Silo as …

Source: https://patroni.readthedocs.io/en/latest/ENVIRONMENT.html System environment variables can override some Patroni configuration file parameters. This page lists all supported variables. Environment values always take precedence over file …

Source: pgBackRest Command Docs: archive-push This command accepts a WAL segment from PostgreSQL. It archives the segment in each repository defined by an indexed repo-path option. See Repository for configuration details. The archive-async value …

oltp.yml is Pigsty’s default configuration template for online transaction processing (OLTP). It is designed for CPUs with 4-128 cores and provides high concurrency, low latency, and high throughput. Pair with node_tune = oltp for OS-level tuning. …

Choosing a “kernel” in Pigsty means determining the PostgreSQL major version, mode/distribution, packages to install, and tuning templates to load. The Pigsty v4.5 source supports PostgreSQL 14-18 and uses 18 by default. Use the following …

Historical Origins Pigsty began in 2018-2019 at Tantan. Tantan is a dating app similar to Tinder in China, later acquired by Momo. Its founding engineering team was Swedish, and its startup culture followed a Nordic model. Tantan used PostgreSQL and …

Source: https://www.pgbouncer.org/config.html · 1.26.0 source Description The configuration file uses INI format. Section names appear between [ and ]. Lines beginning with ; or # are comments and are ignored. Elsewhere in a line, these characters …

Source: pgBackRest Command Docs: archive-get PostgreSQL uses this command to restore a backup or perform PITR. It can also use the command instead of streaming to keep a replica current. PostgreSQL needs WAL segments for recovery and replica …

Source: https://patroni.readthedocs.io/en/latest/yaml_configuration.html Global/Universal thread_pool_size: thread pool size for asynchronous tasks and REST API communication with other members during leader races or failsafe checks. Minimum: 5. …

Pigsty provides four parameter templates for different workloads. Select a template with pg_conf. tiny.yml: Optimized for small nodes, VMs, and demos (the template is labeled for 1-3 cores) oltp.yml: Optimized for OLTP workloads and latency-sensitive …

Source: https://pgbackrest.org/news.html pgBackRest 2.59.2 Released September 27, 2026 The pgBackRest community released pgBackRest 2.59.2. This backup and restore solution supports PostgreSQL databases and workloads of all sizes. pgBackRest …

“PostgreSQL In Great STYle”: Postgres, Infras, Graphics, Service, Toolbox, it’s all Yours. —— Battery-included, local-first PostgreSQL distribution, open-source RDS alternative Value Propositions Extensibility: Powerful extensions out of the box: …

Source: https://patroni.readthedocs.io/en/latest/dynamic_configuration.html Dynamic configuration is stored in the DCS (Distributed Configuration Store) and applied on all cluster nodes. Change dynamic configuration with patronictl_edit_config or …

“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 …

Select instance and cluster types that meet your requirements. Pigsty supports several PostgreSQL instance and cluster types: Primary: Define a single instance cluster. Replica: Define a basic HA cluster with one primary and one replica. Offline: …

Source: pgBackRest Command Docs: annotate Use annotate to add, change, or remove annotations after the backup command creates a backup. Command Options Backup Annotation Option (--annotation) Annotate backup with user-defined key/value pairs. Attach …