Skip to content

Categories: Reference

  • Jupyter: Notebooks and Data Analysis

    In Applications

    ReferenceSOFTWARE

    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 …

    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: AI Workflow Platform

    In Applications

    ReferenceSOFTWARE

    Dify is a Generative AI Application Innovation Engine and open-source LLM application development platform. It provides capabilities from Agent building to AI workflow orchestration, RAG retrieval, and model management, helping users easily build and …

    Dify is a Generative AI Application Innovation Engine and open-source LLM application development platform. It provides capabilities from Agent building to AI workflow orchestration, RAG retrieval, and model management, helping users easily build and …

  • Odoo: Self-Hosted Open Source ERP

    In Applications

    ReferenceSOFTWARE

    Odoo is an open-source enterprise resource planning (ERP) software that provides a full suite of business applications, including CRM, sales, purchasing, inventory, production, accounting, and other management functions. Odoo is a typical web …

    Odoo is an open-source enterprise resource planning (ERP) software that provides a full suite of business applications, including CRM, sales, purchasing, inventory, production, accounting, and other management functions. Odoo is a typical web …

  • AWS & Aliyun Server Pricing

    In Applications

    ReferenceAPP

    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 Aliyun ECS pricing can be obtained as raw …

    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 Aliyun ECS pricing can be obtained as raw …

  • DB-Engines Database Popularity Trend Analysis

    In Applications

    ReferenceAPP

    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/db-engine

  • StackOverflow Global Developer Survey

    In Applications

    ReferenceAPP

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

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

  • Wiki.js: OSS Wiki Software

    In Applications

    ReferenceSOFTWARE

    Public Demo: http://wiki.pigsty.cc TL; DR cd ~/pigsty/app/wiki && docker compose up -d Postgres Preparation # postgres://dbuser_wiki:[email protected]:5432/wiki - { name: wiki, owner: dbuser_wiki, revokeconn: true , comment: wiki the api …

    Public Demo: http://wiki.pigsty.cc TL; DR cd ~/pigsty/app/wiki && docker compose up -d Postgres Preparation # postgres://dbuser_wiki:[email protected]:5432/wiki - { name: wiki, owner: dbuser_wiki, revokeconn: true , comment: wiki the api …

  • Gitea: Self-Hosted Git Service

    In Applications

    ReferenceSOFTWARE

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

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

  • PostgREST: Auto-Generated API

    In Applications

    ReferenceSOFTWARE

    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 …

    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: API Gateway

    In Applications

    ReferenceSOFTWARE

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

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

  • PGLOG: PostgreSQL Log Analysis Application

    In Applications

    ReferenceAPP

    PGLOG is a sample application included with Pigsty that uses the pglog.sample table in MetaDB as its data source. You simply need to load logs into this table, then access the related dashboard. Pigsty provides convenient commands for pulling CSV …

    PGLOG is a sample application included with Pigsty that uses the pglog.sample table in MetaDB as its data source. You simply need to load logs into this table, then access the related dashboard. Pigsty provides convenient commands for pulling CSV …

  • PGWeb: Browser-based PostgreSQL Client

    In Applications

    ReferenceSOFTWARE

    PGWeb Client PGWeb is a browser-based PostgreSQL client. Pigsty includes a small Docker Compose template under app/pgweb; it publishes container port 8081 on host port 8886. cd ~/pigsty/app/pgweb make up # docker compose up -d Open http://cli.pigsty …

    PGWeb Client PGWeb is a browser-based PostgreSQL client. Pigsty includes a small Docker Compose template under app/pgweb; it publishes container port 8081 on host port 8886. cd ~/pigsty/app/pgweb make up # docker compose up -d Open http://cli.pigsty …

  • WHO COVID-19 Pandemic Dashboard

    In Applications

    ReferenceAPP

    Covid is a sample Applet included with Pigsty for visualizing the World Health Organization’s official pandemic data dashboard. You can browse COVID-19 infection and death cases for each country and region, as well as global pandemic trends. Overview …

    Covid is a sample Applet included with Pigsty for visualizing the World Health Organization’s official pandemic data dashboard. You can browse COVID-19 infection and death cases for each country and region, as well as global pandemic trends. Overview …

  • NOAA ISD Global Weather Station Historical Data Query

    In Applications

    ReferenceAPP

    If you have a database and don’t know what to do with it, why not try this open-source project: Vonng/isd You can directly reuse the monitoring system Grafana to interactively browse sub-hourly meteorological data from nearly 30,000 surface weather …

    If you have a database and don’t know what to do with it, why not try this open-source project: Vonng/isd You can directly reuse the monitoring system Grafana to interactively browse sub-hourly meteorological data from nearly 30,000 surface weather …

  • APT Changelog

    In PGSQL Repo

    Reference

    2026-08-14 This batch adds pg_relation_sql, upgrades pg_oidc_validator and pg_when, and rebuilds existing packages after correcting license metadata. pg_relation_sql is standalone SQL and does not support CREATE EXTENSION. Name Old New Comment …

    2026-08-14 This batch adds pg_relation_sql, upgrades pg_oidc_validator and pg_when, and rebuilds existing packages after correcting license metadata. pg_relation_sql is standalone SQL and does not support CREATE EXTENSION. Name Old New Comment …

  • DNF Changelog

    In PGSQL Repo

    Reference

    2026-08-14 This batch adds pg_relation_sql, upgrades pg_oidc_validator and pg_when, and rebuilds existing packages after correcting license metadata. pg_relation_sql is standalone SQL and does not support CREATE EXTENSION. Name Old New Comment …

    2026-08-14 This batch adds pg_relation_sql, upgrades pg_oidc_validator and pg_when, and rebuilds existing packages after correcting license metadata. pg_relation_sql is standalone SQL and does not support CREATE EXTENSION. Name Old New Comment …

  • Release Log

    In INFRA Repo

    Reference

    2026-08-12 Name Old New Comment claude 2.1.226 2.1.227 Official manifest verified via proxy; dual-arch RPM/DEB built code-server 4.131.0 4.132.0 Official dual-architecture RPM/DEB downloaded and verified grafana-infinity-ds 3.11.2 3.11.3 Built as …

    2026-08-12 Name Old New Comment claude 2.1.226 2.1.227 Official manifest verified via proxy; dual-arch RPM/DEB built code-server 4.131.0 4.132.0 Official dual-architecture RPM/DEB downloaded and verified grafana-infinity-ds 3.11.2 3.11.3 Built as …

  • Module: Consul

    In Module: Consul

    ReferencePILOT

    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 has removed the Consul role, playbook, and consul_* parameters, so the legacy inventory …

    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 has removed the Consul role, playbook, and consul_* parameters, so the legacy inventory …

  • Module: Kubernetes

    In Module: Kubernetes

    ReferencePILOT

    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 …

    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 …

  • Module: TigerBeetle

    In Module: TigerBeetle

    ReferencePILOT

    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 only provides the tigerbeetle installation alias in the …

    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 only provides the tigerbeetle installation alias in the …

  • Module: DuckDB

    In Module: DuckDB

    ReferencePILOT

    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 …

    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 …

  • FAQ

    In Module: MYSQL

    ReferenceMYSQL

    How mature is the MYSQL module? It is a pilot module aiming for a simple, inexpensive, good-enough MySQL cluster. The four core capabilities — deployment and convergence, HA failover, daily backups, monitoring and alerting — have been tested …

    How mature is the MYSQL module? It is a pilot module aiming for a simple, inexpensive, good-enough MySQL cluster. The four core capabilities — deployment and convergence, HA failover, daily backups, monitoring and alerting — have been tested …

  • Metrics

    In Module: MYSQL

    ReferenceMYSQL

    MYSQL metrics come from mysqld_exporter (raw metrics, mysql_ prefix) and vmalert recording rules (mysql:ins:* / mysql:cls:*). Dashboards and alerts are built on the derived metrics; this page is their dictionary. Common Labels Every metric carries …

    MYSQL metrics come from mysqld_exporter (raw metrics, mysql_ prefix) and vmalert recording rules (mysql:ins:* / mysql:cls:*). Dashboards and alerts are built on the derived metrics; this page is their dictionary. Common Labels Every metric carries …

  • Monitoring

    In Module: MYSQL

    ReferenceMYSQL

    The MYSQL module plugs into Pigsty’s observability stack: metrics flow through mysqld_exporter into VictoriaMetrics, error logs flow through Journald/Vector into VictoriaLogs, Grafana ships 5 dashboards, and vmalert loads 68 recording rules plus 27 …

    The MYSQL module plugs into Pigsty’s observability stack: metrics flow through mysqld_exporter into VictoriaMetrics, error logs flow through Journald/Vector into VictoriaLogs, Grafana ships 5 dashboards, and vmalert loads 68 recording rules plus 27 …

  • Playbook

    In Module: MYSQL

    ReferenceMYSQL

    The MYSQL module ships two playbooks: mysql.yml deploys and converges, while mysql-rm.yml performs protected member retirement and cluster teardown. Re-running the former converges toward declared state; the latter is a separate lifecycle operation …

    The MYSQL module ships two playbooks: mysql.yml deploys and converges, while mysql-rm.yml performs protected member retirement and cluster teardown. Re-running the former converges toward declared state; the latter is a separate lifecycle operation …

  • Administration

    In Module: MYSQL

    ReferenceMYSQL

    This page covers day-to-day operations for the MYSQL module. The governing principle: declare state in the inventory, converge with the playbook. Most anomalies — a dropped member, drifted AdminAPI state — heal with a single ./mysql.yml -l <cluster> …

    This page covers day-to-day operations for the MYSQL module. The governing principle: declare state in the inventory, converge with the playbook. Most anomalies — a dropped member, drifted AdminAPI state — heal with a single ./mysql.yml -l <cluster> …

  • Parameters

    In Module: MYSQL

    ReferenceMYSQL

    The MYSQL deployment role deliberately exposes only 11 parameters; the removal role adds 2 protected operations parameters. Software versions, ports, directories, charset, TLS paths, and timer schedules are fixed by the role; memory sizing is derived …

    The MYSQL deployment role deliberately exposes only 11 parameters; the removal role adds 2 protected operations parameters. Software versions, ports, directories, charset, TLS paths, and timer schedules are fixed by the role; memory sizing is derived …

  • Configuration

    In Module: MYSQL

    ReferenceMYSQL

    The MYSQL module is driven by the inventory: you declare the desired cluster, and mysql.yml converges the live state to match. This page covers topology planning and every configuration block; see Parameters for the full reference. Before You Deploy …

    The MYSQL module is driven by the inventory: you declare the desired cluster, and mysql.yml converges the live state to match. This page covers topology planning and every configuration block; see Parameters for the full reference. Before You Deploy …

  • Module: MYSQL

    In Module: MYSQL

    ReferenceMYSQL

    MySQL is one of the world’s most popular open-source relational databases. Pigsty’s MYSQL module deploys a fixed, native MySQL 8.4 LTS platform on managed nodes: either a standalone instance or a three-node single-primary InnoDB Cluster built on …

    MySQL is one of the world’s most popular open-source relational databases. Pigsty’s MYSQL module deploys a fixed, native MySQL 8.4 LTS platform on managed nodes: either a standalone instance or a three-node single-primary InnoDB Cluster built on …

  • FAQ

    In Module: KAFKA

    ReferenceKAFKA

    How mature is the current KAFKA module? The current role implements a production-grade v1 baseline: dynamic KRaft, full cluster guardrails, cold-start/repair, serial broker admission and dynamic controller join, member retirement (including dead …

    How mature is the current KAFKA module? The current role implements a production-grade v1 baseline: dynamic KRaft, full cluster guardrails, cold-start/repair, serial broker admission and dynamic controller join, member retirement (including dead …

  • Metrics

    In Module: KAFKA

    ReferenceKAFKA

    The KAFKA module uses two kinds of metric sources, both registered under the same job=kafka scrape job: the JMX target (with a role label) collects the internal state of each JVM, while the protocol exporter target (without a role label) collects the …

    The KAFKA module uses two kinds of metric sources, both registered under the same job=kafka scrape job: the JMX target (with a role label) collects the internal state of each JVM, while the protocol exporter target (without a role label) collects the …

  • Monitoring

    In Module: KAFKA

    ReferenceKAFKA

    Pigsty gives the KAFKA module a unified observability stack that combines metrics, logs, dashboards, and alerts. Monitoring covers both the Kafka JVM internals and the Kafka protocol view, so you never end up seeing only that the process is alive …

    Pigsty gives the KAFKA module a unified observability stack that combines metrics, logs, dashboards, and alerts. Monitoring covers both the Kafka JVM internals and the Kafka protocol view, so you never end up seeing only that the process is alive …

  • Parameters

    In Module: KAFKA

    ReferenceKAFKA

    The KAFKA role deliberately exposes only 15 persistent parameters. Details such as topology, listeners, security implementation, storage subdirectories, replication safety, and Exporter placement are derived by the role in a single, consistent way, …

    The KAFKA role deliberately exposes only 15 persistent parameters. Details such as topology, listeners, security implementation, storage subdirectories, replication safety, and Exporter placement are derived by the role in a single, consistent way, …

  • Configuration

    In Module: KAFKA

    ReferenceKAFKA

    The KAFKA module expresses cluster intent through 15 persistent public parameters; everything else — topology, listeners, storage subdirectories, replication safety, authorization, and Exporter placement — is derived by the role in a single, …

    The KAFKA module expresses cluster intent through 15 persistent public parameters; everything else — topology, listeners, storage subdirectories, replication safety, authorization, and Exporter placement — is derived by the role in a single, …

  • Module: KAFKA

    In Module: KAFKA

    ReferenceKAFKA

    Kafka is a distributed event-streaming platform. Pigsty’s KAFKA module deploys Apache Kafka 4.1+ dynamic KRaft clusters on managed nodes from RPM/DEB packages, with unified management of security, resources, lifecycle, and observability. Current …

    Kafka is a distributed event-streaming platform. Pigsty’s KAFKA module deploys Apache Kafka 4.1+ dynamic KRaft clusters on managed nodes from RPM/DEB packages, with unified management of security, resources, lifecycle, and observability. Current …

  • FAQ

    In Module: VIBE

    ReferenceVIBE

    Deployment code-server package not found Ensure NODE and repo config are in place: yum repolist # EL apt-cache policy # Debian/Ubuntu, read-only inspection ./infra.yml -l infra -t repo --check JupyterLab installation failed jupyter_venv must exist: …

    Deployment code-server package not found Ensure NODE and repo config are in place: yum repolist # EL apt-cache policy # Debian/Ubuntu, read-only inspection ./infra.yml -l infra -t repo --check JupyterLab installation failed jupyter_venv must exist: …

  • Monitoring

    In Module: VIBE

    ReferenceVIBE

    VIBE monitoring mainly focuses on Claude Code OpenTelemetry data. Code-Server and JupyterLab do not expose Prometheus metrics; use systemd and logs for health checks. Claude Code Observability VIBE writes default OpenTelemetry env vars into …

    VIBE monitoring mainly focuses on Claude Code OpenTelemetry data. Code-Server and JupyterLab do not expose Prometheus metrics; use systemd and logs for health checks. Claude Code Observability VIBE writes default OpenTelemetry env vars into …

  • Parameters

    In Module: VIBE

    ReferenceVIBE

    VIBE module has 18 parameters, grouped as: 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 port C …

    VIBE module has 18 parameters, grouped as: 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 port C …

  • Configuration

    In Module: VIBE

    ReferenceVIBE

    VIBE supports enabling components on demand and exposes services via a unified workspace and Nginx portal. Overview Component Enable Param Default Description Code-Server code_enabled Enabled VS Code in browser JupyterLab jupyter_enabled Disabled …

    VIBE supports enabling components on demand and exposes services via a unified workspace and Nginx portal. Overview Component Enable Param Default Description Code-Server code_enabled Enabled VS Code in browser JupyterLab jupyter_enabled Disabled …

  • Module: VIBE

    In Module: VIBE

    ReferenceVIBE

    The VIBE module provides a browser-based dev environment with Code-Server, JupyterLab, Node.js, Claude Code, and Codex CLI, and can work with JUICE shared storage and PGSQL database capabilities. VIBE depends on NODE and INFRA: NODE provides base …

    The VIBE module provides a browser-based dev environment with Code-Server, JupyterLab, Node.js, Claude Code, and Codex CLI, and can work with JUICE shared storage and PGSQL database capabilities. VIBE depends on NODE and INFRA: NODE provides base …

  • FAQ

    In Module: JUICE

    ReferenceJUICE

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

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

  • Monitoring

    In Module: JUICE

    ReferenceJUICE

    JuiceFS instances expose Prometheus metrics via juicefs mount --metrics. In JUICE, metrics listen on 0.0.0.0:<port>, default port 9567. Monitoring Architecture JuiceFS Mount (metrics: 0.0.0.0:<port>) ↓ VictoriaMetrics (scrape) ↓ Grafana Dashboard If …

    JuiceFS instances expose Prometheus metrics via juicefs mount --metrics. In JUICE, metrics listen on 0.0.0.0:<port>, default port 9567. Monitoring Architecture JuiceFS Mount (metrics: 0.0.0.0:<port>) ↓ VictoriaMetrics (scrape) ↓ Grafana Dashboard If …

  • Parameters

    In Module: JUICE

    ReferenceJUICE

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

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

  • Configuration

    In Module: JUICE

    ReferenceJUICE

    Concepts and Implementation JuiceFS consists of a metadata engine and data storage. In the current version, meta is passed through to juicefs as the metadata engine URL, and PostgreSQL is typically used in production. Data storage is defined by data …

    Concepts and Implementation JuiceFS consists of a metadata engine and data storage. In the current version, meta is passed through to juicefs as the metadata engine URL, and PostgreSQL is typically used in production. Data storage is defined by data …

  • Module: JUICE

    In Module: JUICE

    ReferenceJUICE

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

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

  • FAQ

    In Module: DOCKER

    ReferenceDOCKER

    Who Can Run Docker Commands? By default, Pigsty adds both the management user running the playbook on the remote node (i.e., the SSH login user on the target node) and the admin user specified in the node_admin_username parameter to the Docker …

    Who Can Run Docker Commands? By default, Pigsty adds both the management user running the playbook on the remote node (i.e., the SSH login user on the target node) and the admin user specified in the node_admin_username parameter to the Docker …

  • Metrics

    In Module: DOCKER

    ReferenceDOCKER

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

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

  • Parameters

    In Module: DOCKER

    Reference

    The DOCKER module provides 8 configuration parameters. Parameter Overview The DOCKER parameter group is used for Docker container engine deployment and configuration, including enable switch, data directory, storage driver, registry mirrors, and …

    The DOCKER module provides 8 configuration parameters. Parameter Overview The DOCKER parameter group is used for Docker container engine deployment and configuration, including enable switch, data directory, storage driver, registry mirrors, and …

  • Usage

    In Module: DOCKER

    ReferenceDOCKER

    Pigsty has built-in Docker support, which you can use to quickly deploy containerized applications. Getting Started Docker is an optional module. In Pigsty, whether Docker is installed is controlled by docker_enabled, which is disabled by default. …

    Pigsty has built-in Docker support, which you can use to quickly deploy containerized applications. Getting Started Docker is an optional module. In Pigsty, whether Docker is installed is controlled by docker_enabled, which is disabled by default. …

  • Module: DOCKER

    In Module: DOCKER

    ReferenceDOCKER

    Docker is the most popular containerization platform, providing standardized software delivery capabilities. Pigsty does not rely on Docker to deploy any of its components; instead, it provides the ability to deploy and install Docker — this is an …

    Docker is the most popular containerization platform, providing standardized software delivery capabilities. Pigsty does not rely on Docker to deploy any of its components; instead, it provides the ability to deploy and install Docker — this is an …

  • FAQ

    In Module: REDIS

    ReferenceREDIS

    ABORT due to redis_safeguard enabled This means the Redis instance you are trying to remove has the safeguard enabled. When redis_safeguard is true, redis-rm.yml refuses to run unconditionally; the switch does not probe whether an instance is …

    ABORT due to redis_safeguard enabled This means the Redis instance you are trying to remove has the safeguard enabled. When redis_safeguard is true, redis-rm.yml refuses to run unconditionally; the switch does not probe whether an instance is …

  • Metrics

    In Module: REDIS

    ReferenceREDIS

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

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

  • Monitoring

    In Module: REDIS

    ReferenceREDIS

    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 …

    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 …

  • Parameters

    In Module: REDIS

    Reference

    The REDIS module has 22 parameters: 19 for Redis/Valkey deployment and configuration, and 3 for removal. Parameter Overview The REDIS parameter group is used for Redis cluster deployment and configuration, including identity, instance definitions, …

    The REDIS module has 22 parameters: 19 for Redis/Valkey deployment and configuration, and 3 for removal. Parameter Overview The REDIS parameter group is used for Redis cluster deployment and configuration, including identity, instance definitions, …

  • Configuration

    In Module: REDIS

    ReferenceREDIS

    Concept The entity model of Redis is almost the same as that of PostgreSQL, which also includes the concepts of Cluster and Instance. Note that the Cluster here does not refer to the native Redis Cluster mode. The core difference between the REDIS …

    Concept The entity model of Redis is almost the same as that of PostgreSQL, which also includes the concepts of Cluster and Instance. Note that the Cluster here does not refer to the native Redis Cluster mode. The core difference between the REDIS …

  • Module: REDIS

    In Module: REDIS

    ReferenceREDIS

    REDIS is Pigsty’s Redis-compatible cache module. Choose Redis or Valkey with redis_type; the default remains redis. Both engines support primary-replica replication, Sentinel, and native cluster mode while sharing configuration paths, instance …

    REDIS is Pigsty’s Redis-compatible cache module. Choose Redis or Valkey with redis_type; the default remains redis. Both engines support primary-replica replication, Sentinel, and native cluster mode while sharing configuration paths, instance …

  • FAQ

    In Module: MINIO

    ReferenceMINIO

    Which backend does the MINIO module deploy by default? In v4.5.0, the current source deploys Silo—and only Silo. The only valid value for minio_type is silo. MINIO remains the compatibility module name; it does not mean the MinIO server is running. …

    Which backend does the MINIO module deploy by default? In v4.5.0, the current source deploys Silo—and only Silo. The only valid value for minio_type is silo. MINIO remains the compatibility module name; it does not mean the MinIO server is running. …

  • Metrics

    In Module: MINIO

    ReferenceMINIO

    The MINIO module collects Silo metrics through /minio/metrics/v3. The metric set varies with server versions and enabled features, so this page documents the stable interfaces used by current dashboards and alerts rather than treating a complete …

    The MINIO module collects Silo metrics through /minio/metrics/v3. The metric set varies with server versions and enabled features, so this page documents the stable interfaces used by current dashboards and alerts rather than treating a complete …

  • Monitoring and Alerting

    In Module: MINIO

    ReferenceMINIO

    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 …

    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 …

  • Parameters

    In Module: MINIO

    Reference

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

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

  • Configuration

    In Module: MINIO

    ReferenceMINIO

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

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

  • Usage

    In Module: MINIO

    ReferenceMINIO

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

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

  • Module: MINIO

    In Module: MINIO

    ReferenceMINIO

    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 …

    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 …

  • FAQ

    In Module: ETCD

    ReferencePIGSTY

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

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

  • Metrics

    In Module: ETCD

    ReferenceETCD

    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 …

    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 …

  • Monitoring

    In Module: ETCD

    ReferenceETCD

    Dashboards ETCD module provides one monitoring dashboard: Etcd Overview. ETCD Overview Dashboard ETCD Overview: Overview of ETCD cluster Dashboard provides key ETCD status info. Notable: ETCD Aliveness—shows overall etcd cluster service status. Red …

    Dashboards ETCD module provides one monitoring dashboard: Etcd Overview. ETCD Overview Dashboard ETCD Overview: Overview of ETCD cluster Dashboard provides key ETCD status info. Notable: ETCD Aliveness—shows overall etcd cluster service status. Red …

  • Parameters

    In Module: ETCD

    Reference

    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, the …

    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, the …

  • Configuration

    In Module: ETCD

    ReferenceETCD

    Before deployment, define etcd cluster in config inventory. Typical choices: 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 failure, suitable for …

    Before deployment, define etcd cluster in config inventory. Typical choices: 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 failure, suitable for …

  • Module: ETCD

    In Module: ETCD

    ReferenceETCD

    ETCD is a distributed, reliable key-value store for critical system config data. Pigsty uses etcd as DCS (Distributed Config Store), critical for PostgreSQL HA and automatic failover. The ETCD module depends on NODE module and is required by PGSQL …

    ETCD is a distributed, reliable key-value store for critical system config data. Pigsty uses etcd as DCS (Distributed Config Store), critical for PostgreSQL HA and automatic failover. The ETCD module depends on NODE module and is required by PGSQL …

  • FAQ

    In Module: NODE

    Reference

    How to configure NTP service? NTP is critical for various production services. If NTP is not configured, you can use public NTP services or the Chronyd on the admin node as the time standard. If your nodes already have NTP configured, you can …

    How to configure NTP service? NTP is critical for various production services. If NTP is not configured, you can use public NTP services or the Chronyd on the admin node as the time standard. If your nodes already have NTP configured, you can …

  • Metrics

    In Module: NODE

    Reference

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

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

  • Monitoring

    In Module: NODE

    Reference

    Pigsty currently provides 10 monitoring dashboards in the NODE dashboard directory, along with comprehensive alerting rules. Dashboards The NODE dashboard directory currently contains 10 dashboards. The JuiceFS and Claude Code dashboards show data …

    Pigsty currently provides 10 monitoring dashboards in the NODE dashboard directory, along with comprehensive alerting rules. Dashboards The NODE dashboard directory currently contains 10 dashboards. The JuiceFS and Claude Code dashboards show data …

  • Parameters

    In Module: NODE

    Reference

    The NODE module tunes target nodes into the desired state and integrates them into the Pigsty monitoring system. Parameter Section Description NODE_ID Node identity parameters NODE_DNS Node DNS resolution NODE_PACKAGE Upstream repo & package install …

    The NODE module tunes target nodes into the desired state and integrates them into the Pigsty monitoring system. Parameter Section Description NODE_ID Node identity parameters NODE_DNS Node DNS resolution NODE_PACKAGE Upstream repo & package install …

  • Configuration

    In Module: NODE

    Reference

    Pigsty uses IP address as the unique identifier for nodes. This IP should be the internal IP address on which the database instance listens and provides external services. node-test: hosts: 10.10.10.11: { nodename: node-test-1 } 10.10.10.12: { …

    Pigsty uses IP address as the unique identifier for nodes. This IP should be the internal IP address on which the database instance listens and provides external services. node-test: hosts: 10.10.10.11: { nodename: node-test-1 } 10.10.10.12: { …

  • Module: NODE

    In Module: NODE

    Reference

    Tune nodes into the desired state and monitor it, manage node, VIP, HAProxy, and exporters.

    Tune nodes into the desired state and monitor it, manage node, VIP, HAProxy, and exporters.

  • Administration

    In Administration

    TaskReference

    This section covers daily administration and operations for Pigsty deployments.

    This section covers daily administration and operations for Pigsty deployments.

  • FAQ

    In Module: INFRA

    ReferencePIGSTY

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

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

  • Metrics

    In Module: INFRA

    ReferenceINFRA

    Note: Pigsty v4.0 has replaced Prometheus/Loki with VictoriaMetrics/Logs/Traces. The following metric list is still based on v3.x generation, for reference when troubleshooting older versions only. To get the latest metrics, query directly in …

    Note: Pigsty v4.0 has replaced Prometheus/Loki with VictoriaMetrics/Logs/Traces. The following metric list is still based on v3.x generation, for reference when troubleshooting older versions only. To get the latest metrics, query directly in …

  • Monitoring

    In Module: INFRA

    Reference

    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 …

    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 …

  • Parameters

    In Module: INFRA

    Reference

    The INFRA module is responsible for deploying Pigsty’s infrastructure components: local software repository, Nginx, DNSMasq, VictoriaMetrics, VictoriaLogs, Grafana, Alertmanager, Blackbox Exporter, and other monitoring and alerting infrastructure. …

    The INFRA module is responsible for deploying Pigsty’s infrastructure components: local software repository, Nginx, DNSMasq, VictoriaMetrics, VictoriaLogs, Grafana, Alertmanager, Blackbox Exporter, and other monitoring and alerting infrastructure. …

  • Configuration

    In Module: INFRA

    Reference

    Configuration Guide INFRA = primarily monitoring infrastructure, optional for PostgreSQL databases. Unless manually configured to depend on DNS/NTP services on INFRA nodes, INFRA module failures typically don’t affect PG cluster operations. Single …

    Configuration Guide INFRA = primarily monitoring infrastructure, optional for PostgreSQL databases. Unless manually configured to depend on DNS/NTP services on INFRA nodes, INFRA module failures typically don’t affect PG cluster operations. Single …

  • Module: INFRA

    In Module: INFRA

    Reference

    Configuration | Administration | Playbooks | Monitoring | Parameters Overview Every Pigsty deployment includes a set of infrastructure components that provide services for managed nodes and database clusters: Component Port Description Nginx 80/443 …

    Configuration | Administration | Playbooks | Monitoring | Parameters Overview Every Pigsty deployment includes a set of infrastructure components that provide services for managed nodes and database clusters: Component Port Description Nginx 80/443 …

  • Repository

    In Extensions

    ReferencePGSQL

    Pigsty provides supplementary extension repositories, offering additional extension packages on top of the PGDG official repository. YUM Repository Applicable to EL 8/9/10 and compatible systems (RHEL, Rocky, AlmaLinux, CentOS, etc.). Add Repository …

    Pigsty provides supplementary extension repositories, offering additional extension packages on top of the PGDG official repository. YUM Repository Applicable to EL 8/9/10 and compatible systems (RHEL, Rocky, AlmaLinux, CentOS, etc.). Add Repository …

  • FAQ

    In Module: PGSQL

    ReferencePGSQL

    Why can’t my current user use the pg admin alias? Starting from Pigsty v4.0, permissions to manage global Patroni / PostgreSQL clusters using the pg admin alias have been tightened to the admin group (admin) on admin nodes. The admin user (dba) …

    Why can’t my current user use the pg admin alias? Starting from Pigsty v4.0, permissions to manage global Patroni / PostgreSQL clusters using the pg admin alias have been tightened to the admin group (admin) on admin nodes. The admin user (dba) …

  • Default Extensions

    In Extensions

    ReferencePGSQL

    Pigsty installs and enables some core extensions by default when initializing PostgreSQL clusters. Default Installed Extensions Extensions installed by default via pg_packages: Extension Description pg_repack Handle table bloat online, important …

    Pigsty installs and enables some core extensions by default when initializing PostgreSQL clusters. Default Installed Extensions Extensions installed by default via pg_packages: Extension Description pg_repack Handle table bloat online, important …

  • Remove

    In Extensions

    ReferencePGSQL

    Removing extensions involves two levels: dropping extension objects (database level) and uninstalling packages (operating system level). Drop Extension Objects Use DROP EXTENSION to remove extensions from the database: -- Drop extension DROP …

    Removing extensions involves two levels: dropping extension objects (database level) and uninstalling packages (operating system level). Drop Extension Objects Use DROP EXTENSION to remove extensions from the database: -- Drop extension DROP …

  • Update

    In Extensions

    ReferencePGSQL

    Extension updates involve two levels: package updates (operating system level) and extension object updates (database level). Update Packages Use package managers to update extension packages: # EL systems sudo yum update pgvector_18* # Debian/Ubuntu …

    Extension updates involve two levels: package updates (operating system level) and extension object updates (database level). Update Packages Use package managers to update extension packages: # EL systems sudo yum update pgvector_18* # Debian/Ubuntu …

  • Create

    In Extensions

    ReferencePGSQL

    After installing extension packages, you need to execute CREATE EXTENSION in the database to use extension features. View Available Extensions After installing extension packages, you can view available extensions: -- View all available extensions …

    After installing extension packages, you need to execute CREATE EXTENSION in the database to use extension features. View Available Extensions After installing extension packages, you can view available extensions: -- View all available extensions …

  • Config

    In Extensions

    ReferencePGSQL

    Some extensions require preloading dynamic libraries or configuring parameters before use. This section describes how to configure extensions. Preload Extensions Most extensions can be enabled directly with CREATE EXTENSION after installation, but …

    Some extensions require preloading dynamic libraries or configuring parameters before use. This section describes how to configure extensions. Preload Extensions Most extensions can be enabled directly with CREATE EXTENSION after installation, but …

  • Download

    In Extensions

    ReferencePGSQL

    Before installing extensions, ensure that extension packages are downloaded to the local repository or available from upstream. Default Behavior Pigsty downloads the base PostgreSQL 18 kernel packages to the local software repository by default. The …

    Before installing extensions, ensure that extension packages are downloaded to the local repository or available from upstream. Default Behavior Pigsty downloads the base PostgreSQL 18 kernel packages to the local software repository by default. The …

  • Packages

    In Extensions

    ReferencePGSQL

    Pigsty uses a package alias mechanism to simplify extension installation and management. Package Alias Mechanism Managing extensions involves multiple layers of name mapping: Layer Example pgvector Example postgis Extension Name vector postgis, …

    Pigsty uses a package alias mechanism to simplify extension installation and management. Package Alias Mechanism Managing extensions involves multiple layers of name mapping: Layer Example pgvector Example postgis Extension Name vector postgis, …

  • Introduction

    In Extensions

    ReferencePGSQL

    Extensions are the soul of PostgreSQL. Pigsty includes 576 pre-compiled, out-of-the-box extension plugins, fully unleashing PostgreSQL’s potential. What are Extensions PostgreSQL extensions are a modular mechanism that allows enhancing database …

    Extensions are the soul of PostgreSQL. Pigsty includes 576 pre-compiled, out-of-the-box extension plugins, fully unleashing PostgreSQL’s potential. What are Extensions PostgreSQL extensions are a modular mechanism that allows enhancing database …

  • PG Kernels

    In PG Kernels

    ReferenceConceptPGSQL

    In Pigsty, you can replace the native PostgreSQL kernel with different PostgreSQL “flavors” to unlock specialized capabilities. Pigsty supports multiple PostgreSQL kernels and compatibility branches so you can get compatibility layers, multi-master …

    In Pigsty, you can replace the native PostgreSQL kernel with different PostgreSQL “flavors” to unlock specialized capabilities. Pigsty supports multiple PostgreSQL kernels and compatibility branches so you can get compatibility layers, multi-master …

  • Param Templates

    In Param Templates

    ReferencePGSQL

    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 …

    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 …

  • Bind a L2 VIP to PostgreSQL Primary with VIP-Manager

    In Tutorials

    TaskReferencePGSQL

    You can define an OPTIONAL L2 VIP on a PostgreSQL cluster, provided that all nodes in the cluster are in the same L2 network. This VIP works on Master-Backup mode and always points to the node where the primary instance of the database cluster is …

    You can define an OPTIONAL L2 VIP on a PostgreSQL cluster, provided that all nodes in the cluster are in the same L2 network. This VIP works on Master-Backup mode and always points to the node where the primary instance of the database cluster is …

  • Extensions

    In Extensions

    ReferencePGSQL

    Pigsty provides 576 packaged extensions, covering 16 major categories including time-series, geospatial, vector, full-text search, analytics, and feature enhancements, ready to use out-of-the-box. Using extensions in Pigsty involves four core steps: …

    Pigsty provides 576 packaged extensions, covering 16 major categories including time-series, geospatial, vector, full-text search, analytics, and feature enhancements, ready to use out-of-the-box. Using extensions in Pigsty involves four core steps: …

  • Parameters

    In Parameters

    Reference

    The PGSQL module needs to be installed on nodes managed by Pigsty (i.e., nodes that have the NODE module configured), and also requires an available ETCD cluster in your deployment to store cluster metadata. Installing the PGSQL module on a single …

    The PGSQL module needs to be installed on nodes managed by Pigsty (i.e., nodes that have the NODE module configured), and also requires an available ETCD cluster in your deployment to store cluster metadata. Installing the PGSQL module on a single …

  • Metrics

    In Module: PGSQL

    ReferencePGSQL

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

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

  • Dashboard

    In Dashboard

    ReferencePGSQL

    Pigsty provides numerous out-of-the-box Grafana monitoring dashboards for PostgreSQL: Demo & Gallery. The current source provides 31 PostgreSQL-related dashboards: 29 PostgreSQL / PGCAT dashboards under files/grafana/pgsql, plus two PGLOG dashboards …

    Pigsty provides numerous out-of-the-box Grafana monitoring dashboards for PostgreSQL: Demo & Gallery. The current source provides 31 PostgreSQL-related dashboards: 29 PostgreSQL / PGCAT dashboards under files/grafana/pgsql, plus two PGLOG dashboards …

  • Monitoring

    In Monitoring

    ReferencePGSQL

    This document introduces Pigsty’s monitoring system architecture, including metrics, logs, and target management. It also covers how to monitor existing PG clusters and remote RDS services. Monitoring Overview Pigsty uses a modern observability stack …

    This document introduces Pigsty’s monitoring system architecture, including metrics, logs, and target management. It also covers how to monitor existing PG clusters and remote RDS services. Monitoring Overview Pigsty uses a modern observability stack …

  • Reference

    In Module: PGSQL

    ReferencePGSQL

    Parameters and reference documentation

    Parameters and reference documentation

  • Data Migration

    In Data Migration

    TaskReferencePGSQL

    Pigsty includes a built-in playbook pgsql-migration.yml that implements online database migration based on logical replication. With pre-generated automation scripts, application downtime can be reduced to just a few seconds. However, note that …

    Pigsty includes a built-in playbook pgsql-migration.yml that implements online database migration based on logical replication. With pre-generated automation scripts, application downtime can be reduced to just a few seconds. However, note that …

  • Authentication / HBA

    In Misc

    ReferencePGSQL

    Detailed explanation of Host-Based Authentication (HBA) in Pigsty. Authentication is the foundation of Access Control and Default Privileges. PostgreSQL supports several authentication methods. Here we mainly introduce HBA: Host Based …

    Detailed explanation of Host-Based Authentication (HBA) in Pigsty. Authentication is the foundation of Access Control and Default Privileges. PostgreSQL supports several authentication methods. Here we mainly introduce HBA: Host Based …

  • Database

    In Misc

    ReferencePGSQL

    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 simultaneously. In Pigsty, you can define the required databases in the …

    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 simultaneously. In Pigsty, you can define the required databases in the …

  • User / Role

    In Misc

    ReferencePGSQL

    In this context, users refer to logical objects within a database cluster created using the SQL commands CREATE USER/ROLE. In PostgreSQL, users belong directly to the database cluster rather than to a specific database. Therefore, when creating …

    In this context, users refer to logical objects within a database cluster created using the SQL commands CREATE USER/ROLE. In PostgreSQL, users belong directly to the database cluster rather than to a specific database. Therefore, when creating …

  • Backup & Restore

    In Backup & Restore

    TaskReference

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

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

  • Administration

    In Module: PGSQL

    ReferencePGSQL

    Database administration and operation tasks

    Database administration and operation tasks

  • Access Control

    In Misc

    ReferencePGSQL

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

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

  • Service / Access

    In Misc

    ReferencePGSQL

    Separate read and write operations, route traffic correctly, and deliver PostgreSQL cluster capabilities reliably. Service is an abstraction: it is the form in which database clusters provide capabilities to the outside world and encapsulates the …

    Separate read and write operations, route traffic correctly, and deliver PostgreSQL cluster capabilities reliably. Service is an abstraction: it is the form in which database clusters provide capabilities to the outside world and encapsulates the …

  • PostgreSQL Security

    In Security

    ReferencePGSQL

    PostgreSQL security combines authentication, authorization, network boundaries, encrypted communication, data protection, and operational process. Pigsty provides configuration entry points for these mechanisms; operators must still harden, verify, …

    PostgreSQL security combines authentication, authorization, network boundaries, encrypted communication, data protection, and operational process. Pigsty provides configuration entry points for these mechanisms; operators must still harden, verify, …

  • Service/Access

    In Service/Access

    ReferencePGSQL

    Split read and write operations, route traffic correctly, and reliably deliver PostgreSQL cluster capabilities. Service is an abstraction: it is the form in which database clusters provide capabilities externally, encapsulating the details of the …

    Split read and write operations, route traffic correctly, and reliably deliver PostgreSQL cluster capabilities. Service is an abstraction: it is the form in which database clusters provide capabilities externally, encapsulating the details of the …

  • Configuration

    In Configuration

    ReferencePGSQL

    Pigsty is a “configuration-driven” PostgreSQL platform: all behaviors come from the combination of inventory files in ~/pigsty/conf/*.yml and PGSQL parameters. Once you’ve written the configuration, you can replicate a customized cluster with …

    Pigsty is a “configuration-driven” PostgreSQL platform: all behaviors come from the combination of inventory files in ~/pigsty/conf/*.yml and PGSQL parameters. Once you’ve written the configuration, you can replicate a customized cluster with …

  • demo/wool

    In Conf Sample

    Reference

    demo/wool targets small cloud instances in China and 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: …

    demo/wool targets small cloud instances in China and 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

    In Module: PGSQL

    ReferencePGSQL

    Core concepts and architecture design

    Core concepts and architecture design

  • demo/saas

    In Conf Sample

    Reference

    demo/saas is a legacy feature-rich single-node example with predefined business users, databases, and application entrypoints. It demonstrates how PostgreSQL, Silo, Redis, Docker, and the portal can be combined. Overview Config Name: demo/saas Node …

    demo/saas is a legacy feature-rich single-node example with predefined business users, databases, and application entrypoints. It demonstrates how PostgreSQL, Silo, Redis, Docker, and the portal can be combined. Overview Config Name: demo/saas Node …

  • demo/remote

    In Conf Sample

    Reference

    demo/remote deploys no local PostgreSQL cluster. Instead, it declares multiple pg_exporters on an INFRA node to monitor remote PostgreSQL, PolarDB, or cloud RDS instances. Overview Config Name: demo/remote Local Node Count: One INFRA node Example …

    demo/remote deploys no local PostgreSQL cluster. Instead, it declares multiple pg_exporters on an INFRA node to monitor remote PostgreSQL, PolarDB, or cloud RDS instances. Overview Config Name: demo/remote Local Node Count: One INFRA node Example …

  • build/dev

    In Conf Sample

    Reference

    The build/dev configuration template is Pigsty’s three-node local build and development environment. It is used to validate repository build and package download workflows across EL9, Debian 12, and Ubuntu 24 nodes. This template is intended only for …

    The build/dev configuration template is Pigsty’s three-node local build and development environment. It is used to validate repository build and package download workflows across EL9, Debian 12, and Ubuntu 24 nodes. This template is intended only for …

  • build/oss

    In Conf Sample

    Reference

    The build/oss configuration template is the build environment configuration for Pigsty open-source edition offline packages, used to batch-build offline installation packages across multiple operating systems. This configuration is intended for …

    The build/oss configuration template is the build environment configuration for Pigsty open-source edition offline packages, used to batch-build offline installation packages across multiple operating systems. This configuration is intended for …

  • demo/mysql

    In Conf Sample

    Reference

    demo/mysql is the four-node example for the native MySQL 8.4 LTS pilot module. It is distinct from conf/mysql.yml, which provides MySQL protocol compatibility through the OpenHalo PostgreSQL kernel. Overview Config Name: demo/mysql Node Count: 4 …

    demo/mysql is the four-node example for the native MySQL 8.4 LTS pilot module. It is distinct from conf/mysql.yml, which provides MySQL protocol compatibility through the OpenHalo PostgreSQL kernel. Overview Config Name: demo/mysql Node Count: 4 …

  • demo/kafka

    In Conf Sample

    Reference

    demo/kafka declares two Kafka 4.x dynamic KRaft clusters across four nodes: the plaintext single-node development cluster kf-meta, and the three-node TLS/SCRAM/ACL demonstration cluster kf-test. Overview Config Name: demo/kafka Node Count: 4 kf-meta: …

    demo/kafka declares two Kafka 4.x dynamic KRaft clusters across four nodes: the plaintext single-node development cluster kf-meta, and the three-node TLS/SCRAM/ACL demonstration cluster kf-test. Overview Config Name: demo/kafka Node Count: 4 kf-meta: …

  • demo/redis

    In Conf Sample

    Reference

    demo/redis demonstrates standalone/replica, Sentinel, and native Cluster modes supported by Pigsty’s Redis module in one configuration. Overview Config Name: demo/redis Node Count: 4 Clusters: redis-ms, redis-meta, redis-test Related: demo/demo …

    demo/redis demonstrates standalone/replica, Sentinel, and native Cluster modes supported by Pigsty’s Redis module in one configuration. Overview Config Name: demo/redis Node Count: 4 Clusters: redis-ms, redis-meta, redis-test Related: demo/demo …

  • demo/minio

    In Conf Sample

    Reference

    demo/minio demonstrates a highly available S3 object-storage cluster with four nodes and four drives per node, for 16 drives total. The template retains MINIO module compatibility naming and explicitly sets minio_type: silo; the current v4.5.0 source …

    demo/minio demonstrates a highly available S3 object-storage cluster with four nodes and four drives per node, for 16 drives total. The template retains MINIO module compatibility naming and explicitly sets minio_type: silo; the current v4.5.0 source …

  • demo/kernel

    In Conf Sample

    Reference

    The demo/kernel configuration template demonstrates the major PostgreSQL kernels and compatible branches supported by Pigsty in a single configuration. It is intended for feature validation and kernel difference testing, not production use. Overview …

    The demo/kernel configuration template demonstrates the major PostgreSQL kernels and compatible branches supported by Pigsty in a single configuration. It is intended for feature validation and kernel difference testing, not production use. Overview …

  • demo/demo

    In Conf Sample

    Reference

    The demo/demo configuration template is used by Pigsty’s public demo site, demonstrating how to expose services publicly, configure SSL certificates, and install all available extensions. If you want to set up your own public service on a cloud …

    The demo/demo configuration template is used by Pigsty’s public demo site, demonstrating how to expose services publicly, configure SSL certificates, and install all available extensions. If you want to set up your own public service on a cloud …

  • demo/debian

    In Conf Sample

    Reference

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

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

  • demo/el

    In Conf Sample

    Reference

    The demo/el configuration template is optimized for Enterprise Linux family distributions (RHEL, Rocky Linux, Alma Linux, Oracle Linux). Overview Config Name: demo/el Node Count: Single node Description: Enterprise Linux optimized configuration …

    The demo/el configuration template is optimized for Enterprise Linux family distributions (RHEL, Rocky Linux, Alma Linux, Oracle Linux). Overview Config Name: demo/el Node Count: Single node Description: Enterprise Linux optimized configuration …

  • demo/bare

    In Conf Sample

    Reference

    demo/bare is Pigsty’s smallest configuration example. It keeps only three core groups and three global parameters to show a working inventory skeleton. Overview Config Name: demo/bare Node Count: Single node Modules: INFRA, ETCD, PGSQL Related: meta, …

    demo/bare is Pigsty’s smallest configuration example. It keeps only three core groups and three global parameters to show a working inventory skeleton. Overview Config Name: demo/bare Node Count: Single node Modules: INFRA, ETCD, PGSQL Related: meta, …

  • Module: PGSQL

    In Module: PGSQL

    ReferencePGSQL

    PGSQL is Pigsty’s core module. Ansible inventory declares PostgreSQL clusters; Patroni and etcd provide HA orchestration; pgBackRest provides backup and PITR; HAProxy, VIP, DNS, PgBouncer, and the observability stack expose and monitor database …

    PGSQL is Pigsty’s core module. Ansible inventory declares PostgreSQL clusters; Patroni and etcd provide HA orchestration; pgBackRest provides backup and PITR; HAProxy, VIP, DNS, PgBouncer, and the observability stack expose and monitor database …

  • app/jumpserver

    In Conf Sample

    Reference

    The app/jumpserver template deploys JumpServer Community Edition with Pigsty-managed PostgreSQL 18 as its external database. The current template is validated with JumpServer v4.10.16-ce. Overview Config Name: app/jumpserver Node Count: Single node …

    The app/jumpserver template deploys JumpServer Community Edition with Pigsty-managed PostgreSQL 18 as its external database. The current template is validated with JumpServer v4.10.16-ce. Overview Config Name: app/jumpserver Node Count: Single node …

  • app/immich

    In Conf Sample

    Reference

    The app/immich template deploys Immich with Pigsty-managed PostgreSQL 18 for metadata and vector indexes. The current template is validated with Immich v3.0.1. Overview Config Name: app/immich Node Count: Single node Application Port: 2283 Data …

    The app/immich template deploys Immich with Pigsty-managed PostgreSQL 18 for metadata and vector indexes. The current template is validated with Immich v3.0.1. Overview Config Name: app/immich Node Count: Single node Application Port: 2283 Data …

  • app/hindsight

    In Conf Sample

    Reference

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

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

  • app/insforge

    In Conf Sample

    Reference

    The app/insforge configuration template deploys InsForge OSS and 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 …

    The app/insforge configuration template deploys InsForge OSS and 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 …

  • app/registry

    In Conf Sample

    Reference

    The app/registry configuration template provides a reference configuration for deploying Docker Registry as an image proxy, usable as Docker Hub mirror acceleration or private image registry. Overview Config Name: app/registry Node Count: Single node …

    The app/registry configuration template provides a reference configuration for deploying Docker Registry as an image proxy, usable as Docker Hub mirror acceleration or private image registry. Overview Config Name: app/registry Node Count: Single node …

  • app/mattermost

    In Conf Sample

    Reference

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

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

  • app/teable

    In Conf Sample

    Reference

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

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

  • app/maybe

    In Conf Sample

    Reference

    The app/maybe configuration template provides a reference configuration for deploying Maybe open-source personal finance management system, using Pigsty-managed PostgreSQL as the database. Overview Config Name: app/maybe Node Count: Single node …

    The app/maybe configuration template provides a reference configuration for deploying Maybe open-source personal finance management system, using Pigsty-managed PostgreSQL as the database. Overview Config Name: app/maybe Node Count: Single node …

  • app/electric

    In Conf Sample

    Reference

    The app/electric configuration template provides a reference configuration for deploying Electric SQL real-time sync service, enabling real-time data synchronization from PostgreSQL to clients. Overview Config Name: app/electric Node Count: Single …

    The app/electric configuration template provides a reference configuration for deploying Electric SQL real-time sync service, enabling real-time data synchronization from PostgreSQL to clients. Overview Config Name: app/electric Node Count: Single …

  • app/dify

    In Conf Sample

    Reference

    The app/dify configuration template provides a reference configuration for self-hosting Dify AI application development platform, using Pigsty-managed PostgreSQL and pgvector as vector storage. For more details, see Dify Deployment Tutorial Overview …

    The app/dify configuration template provides a reference configuration for self-hosting Dify AI application development platform, using Pigsty-managed PostgreSQL and pgvector as vector storage. For more details, see Dify Deployment Tutorial Overview …

  • app/odoo

    In Conf Sample

    Reference

    The app/odoo configuration template provides a reference configuration for self-hosting Odoo open-source ERP system, using Pigsty-managed PostgreSQL as the database. For more details, see Odoo Deployment Tutorial Overview Config Name: app/odoo Node …

    The app/odoo configuration template provides a reference configuration for self-hosting Odoo open-source ERP system, using Pigsty-managed PostgreSQL as the database. For more details, see Odoo Deployment Tutorial Overview Config Name: app/odoo Node …

  • supabase

    In Conf Sample

    Reference

    The supabase configuration template provides a reference configuration for self-hosting Supabase, using Pigsty-managed PostgreSQL as the underlying storage. For more details, see Supabase Self-Hosting Tutorial Overview Config Name: supabase Node …

    The supabase configuration template provides a reference configuration for self-hosting Supabase, using Pigsty-managed PostgreSQL as the underlying storage. For more details, see Supabase Self-Hosting Tutorial Overview Config Name: supabase Node …

  • ha/citus

    In Conf Sample

    Reference

    The ha/citus template deploys a complete Citus distributed PostgreSQL cluster with 1 infra node, 1 coordinator group, and 5 worker groups (12 Citus nodes total), providing transparent horizontal scaling and data sharding. Overview Config Name: …

    The ha/citus template deploys a complete Citus distributed PostgreSQL cluster with 1 infra node, 1 coordinator group, and 5 worker groups (12 Citus nodes total), providing transparent horizontal scaling and data sharding. Overview Config Name: …

  • ha/dual

    In Conf Sample

    Reference

    The ha/dual template uses two-node deployment, implementing a “semi-HA” architecture with one primary and one standby. If you only have two servers, this is a pragmatic choice. Overview Config Name: ha/dual Node Count: Two nodes Description: Two-node …

    The ha/dual template uses two-node deployment, implementing a “semi-HA” architecture with one primary and one standby. If you only have two servers, this is a pragmatic choice. Overview Config Name: ha/dual Node Count: Two nodes Description: Two-node …

  • Electric: PostgreSQL Sync Engine

    In Applications

    ReferenceSOFTWARE

    Electric is a PostgreSQL sync engine focused on efficiently delivering database changes to frontend and edge applications. Pigsty provides the app/electric template (conf/app/electric.yml) to bootstrap database, container, and ingress settings in one …

    Electric is a PostgreSQL sync engine focused on efficiently delivering database changes to frontend and edge applications. Pigsty provides the app/electric template (conf/app/electric.yml) to bootstrap database, container, and ingress settings in one …

  • ha/trio

    In Conf Sample

    Reference

    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 …

    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

    In Conf Sample

    Reference

    ha/safe uses a three-node high-availability topology to demonstrate TLS, client certificates, password checks, backup encryption, the CRIT parameter template, and related security settings. It is a configuration example to customize, not a …

    ha/safe uses a three-node high-availability topology to demonstrate TLS, client certificates, password checks, backup encryption, the CRIT parameter template, and related security settings. It is a configuration example to customize, not a …

  • Operations SOP Index

    In SOP

    TutorialReferencePIGSTYPGSQL

    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 …

    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 …

  • ha/full

    In Conf Sample

    Reference

    The ha/full configuration template is Pigsty’s recommended sandbox demonstration environment, deploying two PostgreSQL clusters across four nodes for testing and demonstrating various Pigsty capabilities. Most Pigsty tutorials and examples are based …

    The ha/full configuration template is Pigsty’s recommended sandbox demonstration environment, deploying two PostgreSQL clusters across four nodes for testing and demonstrating various Pigsty capabilities. Most Pigsty tutorials and examples are based …

  • JumpServer: Open-Source Bastion Host

    In Applications

    ReferenceSOFTWARE

    JumpServer is an open-source PAM and bastion-host system for centralized access management of SSH, RDP, database, and web assets. Pigsty’s app/jumpserver template runs the JumpServer Community Edition application layer with Docker Compose and uses …

    JumpServer is an open-source PAM and bastion-host system for centralized access management of SSH, RDP, database, and web assets. Pigsty’s app/jumpserver template runs the JumpServer Community Edition application layer with Docker Compose and uses …

  • Registry: Container Image Cache

    In Applications

    ReferenceSOFTWARE

    Pigsty provides the app/registry template (conf/app/registry.yml) for: Docker Registry cache service (default 5000) Optional management UI (default 5080) Quick Start curl -fsSL https://repo.pigsty.io/get | bash; cd ~/pigsty ./bootstrap ./configure -c …

    Pigsty provides the app/registry template (conf/app/registry.yml) for: Docker Registry cache service (default 5000) Optional management UI (default 5080) Quick Start curl -fsSL https://repo.pigsty.io/get | bash; cd ~/pigsty ./bootstrap ./configure -c …

  • Metabase: BI Analytics Tool

    In Applications

    ReferenceSOFTWARE

    Metabase is a fast, easy-to-use open-source business intelligence tool that lets your team explore and visualize data without SQL knowledge. Metabase provides a friendly user interface with rich chart types and supports connecting to various …

    Metabase is a fast, easy-to-use open-source business intelligence tool that lets your team explore and visualize data without SQL knowledge. Metabase provides a friendly user interface with rich chart types and supports connecting to various …

  • ha/octo

    In Conf Sample

    Reference

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

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

  • ha/simu

    In Conf Sample

    Reference

    The ha/simu configuration template is a 20-node production environment simulation, requiring a powerful host machine to run. Overview Config Name: ha/simu Node Count: 20 nodes, pigsty/vagrant/spec/simu.rb Description: 20-node production environment …

    The ha/simu configuration template is a 20-node production environment simulation, requiring a powerful host machine to run. Overview Config Name: ha/simu Node Count: 20 nodes, pigsty/vagrant/spec/simu.rb Description: 20-node production environment …

  • Immich: Self-Hosted Photo and Video Library

    In Applications

    ReferenceSOFTWARE

    Immich is a high-performance, self-hosted photo and video management application and one of the most popular open-source alternatives to Google Photos. It provides web and mobile uploads, album sharing, timelines, maps, EXIF and RAW support, …

    Immich is a high-performance, self-hosted photo and video management application and one of the most popular open-source alternatives to Google Photos. It provides web and mobile uploads, album sharing, timelines, maps, EXIF and RAW support, …

  • Maybe: Self-Hosted Personal Finance

    In Applications

    ReferenceSOFTWARE

    Maybe is an open-source personal finance application for managing accounts, transactions, budgets, investments, and household financial views. Maybe is a typical Rails web application: it stores business data in PostgreSQL in production and uses …

    Maybe is an open-source personal finance application for managing accounts, transactions, budgets, investments, and household financial views. Maybe is a typical Rails web application: it stores business data in PostgreSQL in production and uses …

  • Configuration Templates

    In Conf Sample

    ReferencePIGSTY

    Use -c with configure to select a template. Its value is a path relative to conf/ without the .yml suffix. If omitted, Pigsty uses the default meta template. Category Templates Solo Templates meta, rich, fat, slim, infra, vibe, docker Kernel …

    Use -c with configure to select a template. Its value is a path relative to conf/ without the .yml suffix. If omitted, Pigsty uses the default meta template. Category Templates Solo Templates meta, rich, fat, slim, infra, vibe, docker Kernel …

  • Mattermost: Open-Source Team Collaboration

    In Applications

    ReferenceSOFTWARE

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

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

  • NocoDB: Open-Source Airtable

    In Applications

    ReferenceSOFTWARE

    NocoDB is an open-source Airtable alternative that turns any database into a smart spreadsheet. It provides a rich user interface that allows you to create powerful database applications without writing code. NocoDB supports PostgreSQL, MySQL, SQL …

    NocoDB is an open-source Airtable alternative that turns any database into a smart spreadsheet. It provides a rich user interface that allows you to create powerful database applications without writing code. NocoDB supports PostgreSQL, MySQL, SQL …

  • Teable: AI No-Code Database

    In Applications

    ReferenceSOFTWARE

    Teable is a no-code database platform for team collaboration. Pigsty provides the app/teable template (conf/app/teable.yml) and depends on PostgreSQL + Silo + Docker by default (no Redis dependency). Quick Start curl -fsSL https://repo.pigsty.io/get …

    Teable is a no-code database platform for team collaboration. Pigsty provides the app/teable template (conf/app/teable.yml) and depends on PostgreSQL + Silo + Docker by default (no Redis dependency). Quick Start curl -fsSL https://repo.pigsty.io/get …

  • FerretDB: MongoDB Protocol

    In Applications

    ReferenceSOFTWARE

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

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

  • Hindsight: AI Long-Term Memory

    In Applications

    ReferenceSOFTWARE

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

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

  • InsForge: AI Backend-as-a-Service

    In Applications

    ReferenceSOFTWARE

    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, payment integrations, and more, …

    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, payment integrations, and more, …

  • Enterprise Self-Hosted Supabase

    In Applications

    ReferenceSOFTWARE

    Supabase is great, but having your own Supabase is even better. Pigsty can help you deploy enterprise-grade Supabase on your own servers (physical, virtual, or cloud) with a single command — more extensions, better performance, deeper control, and …

    Supabase is great, but having your own Supabase is even better. Pigsty can help you deploy enterprise-grade Supabase on your own servers (physical, virtual, or cloud) with a single command — more extensions, better performance, deeper control, and …

  • Applications

    In Applications

    ReferenceAPP

    Pigsty “applications” fall into 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. …

    Pigsty “applications” fall into 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. …

  • PostgreSQL Mongo Mode

    In Conf Sample

    ReferenceConceptPGSQL

    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 …

    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 …

  • Port List

    In References

    Reference

    This page lists default ports used by Pigsty module components. Adjust as needed or use as a reference for fine-grained firewall configuration. Module Component Port Parameter Status NODE node_exporter 9100 node_exporter_port Enabled NODE haproxy …

    This page lists default ports used by Pigsty module components. Adjust as needed or use as a reference for fine-grained firewall configuration. Module Component Port Parameter Status NODE node_exporter 9100 node_exporter_port Enabled NODE haproxy …

  • oriole

    In Conf Sample

    Reference

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

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

  • Playbooks

    In References

    Reference

    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 …

    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 …

  • pgtde

    In Conf Sample

    Reference

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

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

  • Parameters

    In References

    Reference

    This is the parameter navigation page for Pigsty v4.x, without repeating full explanations for each parameter. For parameter details, please read each module’s param page. Cross-checked against the current source and parameter reference pages, the 10 …

    This is the parameter navigation page for Pigsty v4.x, without repeating full explanations for each parameter. For parameter details, please read each module’s param page. Cross-checked against the current source and parameter reference pages, the 10 …

  • mysql

    In Conf Sample

    Reference

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

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

  • File Hierarchy

    In References

    ReferencePIGSTY

    Pigsty FHS Pigsty’s home directory is located at ~/pigsty by default. The file structure within this directory is as follows: ~/pigsty Source Tree app/Application template resourcesbin/Management and operations scriptsfiles/victoria/Rules and …

    Pigsty FHS Pigsty’s home directory is located at ~/pigsty by default. The file structure within this directory is as follows: ~/pigsty Source Tree app/Application template resourcesbin/Management and operations scriptsfiles/victoria/Rules and …

  • pgedge

    In Conf Sample

    Reference

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

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

  • Modules

    In References

    ReferencePIGSTY

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

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

  • Supported Linux

    In References

    Reference

    Pigsty runs on Linux, supporting amd64/x86_64 and arm64/aarch64 arch, plus 3 major distros: EL, Debian, Ubuntu. Pigsty runs bare-metal without containers. Supports actively maintained mainstream releases across the 3 major distro families and both …

    Pigsty runs on Linux, supporting amd64/x86_64 and arm64/aarch64 arch, plus 3 major distros: EL, Debian, Ubuntu. Pigsty runs bare-metal without containers. Supports actively maintained mainstream releases across the 3 major distro families and both …

  • agens

    In Conf Sample

    Reference

    The agens configuration template replaces native PostgreSQL with the AgensGraph kernel and enables property-graph modeling plus Cypher queries. For the full guide, see: AgensGraph kernel guide Overview Config name: agens Node count: Single node …

    The agens configuration template replaces native PostgreSQL with the AgensGraph kernel and enables property-graph modeling plus Cypher queries. For the full guide, see: AgensGraph kernel guide Overview Config name: agens Node count: Single node …

  • ivory

    In Conf Sample

    Reference

    The ivory configuration template uses Highgo’s IvorySQL database kernel instead of native PostgreSQL, providing Oracle syntax and PL/SQL compatibility. For the complete tutorial, see: IvorySQL (Oracle Compatible) Kernel Guide Overview Config Name: …

    The ivory configuration template uses Highgo’s IvorySQL database kernel instead of native PostgreSQL, providing Oracle syntax and PL/SQL compatibility. For the complete tutorial, see: IvorySQL (Oracle Compatible) Kernel Guide Overview Config Name: …

  • cloudberry

    In Conf Sample

    Reference

    The cloudberry config template is not available yet in this version. If you need Cloudberry support, please see: Kernel: Cloudberry Config Templates

    The cloudberry config template is not available yet in this version. If you need Cloudberry support, please see: Kernel: Cloudberry Config Templates

  • polar

    In Conf Sample

    Reference

    The polar configuration template uses Alibaba Cloud’s PolarDB for PostgreSQL database kernel instead of native PostgreSQL, providing “cloud-native” Aurora-style storage-compute separation capability. For the complete tutorial, see: PolarDB for …

    The polar configuration template uses Alibaba Cloud’s PolarDB for PostgreSQL database kernel instead of native PostgreSQL, providing “cloud-native” Aurora-style storage-compute separation capability. For the complete tutorial, see: PolarDB for …

  • mssql

    In Conf Sample

    Reference

    The mssql configuration template uses a PostgreSQL 17-compatible Babelfish kernel instead of native PostgreSQL, providing Microsoft SQL Server wire protocol (TDS) and T-SQL syntax compatibility. The current template is pinned to pg_version: 17; …

    The mssql configuration template uses a PostgreSQL 17-compatible Babelfish kernel instead of native PostgreSQL, providing Microsoft SQL Server wire protocol (TDS) and T-SQL syntax compatibility. The current template is pinned to pg_version: 17; …

  • pg19

    In Conf Sample

    Reference

    pg19 is the single-node PostgreSQL 19 Beta evaluation template. It follows the meta topology, enables the beta repository, and limits the local repository’s additional cache to core PGSQL packages without preinstalling extensions. Overview Config …

    pg19 is the single-node PostgreSQL 19 Beta evaluation template. It follows the meta topology, enables the beta repository, and limits the local repository’s additional cache to core PGSQL packages without preinstalling extensions. Overview Config …

  • pgsql

    In Conf Sample

    Reference

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

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

  • docker

    In Conf Sample

    Reference

    The docker configuration template runs Pigsty inside a Docker container and provides a minimal single-node stack for infrastructure and PostgreSQL. For full workflow details, see Docker Deployment. Overview Config Name: docker Node Count: Single node …

    The docker configuration template runs Pigsty inside a Docker container and provides a minimal single-node stack for infrastructure and PostgreSQL. For full workflow details, see Docker Deployment. Overview Config Name: docker Node Count: Single node …

  • vibe

    In Conf Sample

    Reference

    The vibe config template provides a ready-to-use AI coding sandbox, integrating Code-Server (Web VS Code), JupyterLab, Claude Code observability, Codex CLI, JuiceFS distributed filesystem, and a feature-rich PostgreSQL database. Overview Config Name: …

    The vibe config template provides a ready-to-use AI coding sandbox, integrating Code-Server (Web VS Code), JupyterLab, Claude Code observability, Codex CLI, JuiceFS distributed filesystem, and a feature-rich PostgreSQL database. Overview Config Name: …

  • infra

    In Conf Sample

    Reference

    The infra configuration template only deploys Pigsty’s observability infrastructure components (VictoriaMetrics/Grafana/VictoriaLogs/Nginx, etc.), without PostgreSQL and etcd. Suitable for scenarios requiring a standalone monitoring stack, such as …

    The infra configuration template only deploys Pigsty’s observability infrastructure components (VictoriaMetrics/Grafana/VictoriaLogs/Nginx, etc.), without PostgreSQL and etcd. Suitable for scenarios requiring a standalone monitoring stack, such as …

  • fat

    In Conf Sample

    Reference

    The fat configuration template is Pigsty’s Feature-All-Test template, installing all extension plugins on a single node and building a local software repository containing all extensions for PostgreSQL 14-18 (five major versions). This is a …

    The fat configuration template is Pigsty’s Feature-All-Test template, installing all extension plugins on a single node and building a local software repository containing all extensions for PostgreSQL 14-18 (five major versions). This is a …

  • slim

    In Conf Sample

    Reference

    The slim configuration template provides minimal installation capability, installing a PostgreSQL high-availability cluster directly from the internet without deploying Infra monitoring infrastructure. When you only need an available database …

    The slim configuration template provides minimal installation capability, installing a PostgreSQL high-availability cluster directly from the internet without deploying Infra monitoring infrastructure. When you only need an available database …

  • rich

    In Conf Sample

    Reference

    The rich configuration template is an enhanced version of meta, designed for users who need to experience complete functionality. If you want to build a local software repository, use Silo for backup storage, run Docker applications, or need …

    The rich configuration template is an enhanced version of meta, designed for users who need to experience complete functionality. If you want to build a local software repository, use Silo for backup storage, run Docker applications, or need …

  • meta

    In Conf Sample

    Reference

    The meta configuration template is Pigsty’s default template, designed to fulfill Pigsty’s core functionality—deploying PostgreSQL—on a single node. To maximize compatibility, meta installs only the minimum required software set to ensure it runs …

    The meta configuration template is Pigsty’s default template, designed to fulfill Pigsty’s core functionality—deploying PostgreSQL—on a single node. To maximize compatibility, meta installs only the minimum required software set to ensure it runs …

  • Version Command (version)

    In Commands

    ReferencePGBACKREST

    Source: pgBackRest Command Docs: version Displays 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: version Displays 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 …

  • Verify Command (verify)

    In Commands

    ReferencePGBACKREST

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

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

  • Release notes

    In patroni

    ReferencePATRONI

    Source: https://patroni.readthedocs.io/en/latest/releases.html Version 4.1.4 Released 2026-07-07 Bugfixes Check NOTIFY_SOCKET environment variable before using systemd package (Polina Bungina) Only try to import and use the package when the …

    Source: https://patroni.readthedocs.io/en/latest/releases.html Version 4.1.4 Released 2026-07-07 Bugfixes Check NOTIFY_SOCKET environment variable before using systemd package (Polina Bungina) Only try to import and use the package when the …

  • pig pitr

    In pig

    ReferencePIG

    The pig pitr command performs point-in-time recovery through pgBackRest and conservatively handles the local PostgreSQL and Patroni lifecycle. Unlike the lower-level pig pb restore, pig pitr runs pre-restore checks, stops Patroni and PostgreSQL when …

    The pig pitr command performs point-in-time recovery through pgBackRest and conservatively handles the local PostgreSQL and Patroni lifecycle. Unlike the lower-level pig pb restore, pig pitr runs pre-restore checks, stops Patroni and PostgreSQL when …

  • Stop Command (stop)

    In Commands

    ReferencePGBACKREST

    Source: pgBackRest Command Docs: stop Does not allow any new pgBackRest processes to run. By default running processes will be allowed to complete successfully. Use the --force option to terminate running processes. pgBackRest processes will return …

    Source: pgBackRest Command Docs: stop Does not allow any new pgBackRest processes to run. By default running processes will be allowed to complete successfully. Use the --force option to terminate running processes. pgBackRest processes will return …

  • pig pgbackrest

    In pig

    ReferencePIG

    The pig pgbackrest command (alias pig pb) manages pgBackRest backups and provides low-level restore primitives. It wraps common pgbackrest operations for a simplified backup management experience. All commands run as the database superuser (default …

    The pig pgbackrest command (alias pig pb) manages pgBackRest backups and provides low-level restore primitives. It wraps common pgbackrest operations for a simplified backup management experience. All commands run as the database superuser (default …

  • FAQ

    In patroni

    ReferencePATRONI

    Source: https://patroni.readthedocs.io/en/latest/faq.html In this section you will find answers for the most frequently asked questions about Patroni. Each sub-section attempts to focus on different kinds of questions. We hope that this helps you to …

    Source: https://patroni.readthedocs.io/en/latest/faq.html In this section you will find answers for the most frequently asked questions about Patroni. Each sub-section attempts to focus on different kinds of questions. We hope that this helps you to …

  • Open-Source Impact

    In Comparison

    ReferencePIGSTY

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

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

  • Cost Reference

    In Comparison

    ReferencePIGSTY

    Overview The cost data below is intended to illustrate order-of-magnitude differences. Cloud vendor pricing and discounts vary over time, region, instance size, and purchase model. EC2 Core·Month RDS Core·Month DHH Self-Hosted Core-Month Price (192C …

    Overview The cost data below is intended to illustrate order-of-magnitude differences. Cloud vendor pricing and discounts vary over time, region, instance size, and purchase model. EC2 Core·Month RDS Core·Month DHH Self-Hosted Core-Month Price (192C …

  • Start Command (start)

    In Commands

    ReferencePGBACKREST

    Source: pgBackRest Command Docs: start If the pgBackRest processes were previously stopped using the stop command then they can be started again using the start command. Note that this will not immediately start up any pgBackRest processes but they …

    Source: pgBackRest Command Docs: start If the pgBackRest processes were previously stopped using the stop command then they can be started again using the start command. Note that this will not immediately start up any pgBackRest processes but they …

  • pig patroni

    In pig

    ReferencePIG

    Since v1.6.0, the pig patroni command (alias pig pt) is a transparent launcher for the installed patronictl binary: pig only owns config-file selection and a few local helpers, while every other command and all of its arguments are forwarded …

    Since v1.6.0, the pig patroni command (alias pig pt) is a transparent launcher for the installed patronictl binary: pig only owns config-file selection and a few local helpers, while every other command and all of its arguments are forwarded …

  • Comparison

    In Comparison

    ReferenceINFRA

    Comparison with RDS Pigsty is a local-first RDS alternative released under Apache-2.0, deployable on your own physical/virtual machines or cloud servers. We’ve chosen Amazon AWS RDS for PostgreSQL (the global market leader) and Alibaba Cloud RDS for …

    Comparison with RDS Pigsty is a local-first RDS alternative released under Apache-2.0, deployable on your own physical/virtual machines or cloud servers. We’ve chosen Amazon AWS RDS for PostgreSQL (the global market leader) and Alibaba Cloud RDS for …

  • Stanza Upgrade Command (stanza-upgrade)

    In Commands

    ReferencePGBACKREST

    Source: pgBackRest Command Docs: stanza-upgrade Immediately after upgrading PostgreSQL to a newer major version, the pg-path for all pgBackRest configurations must be set to the new database location and the stanza-upgrade command run. If there is …

    Source: pgBackRest Command Docs: stanza-upgrade Immediately after upgrading PostgreSQL to a newer major version, the pg-path for all pgBackRest configurations must be set to the new database location and the stanza-upgrade command run. If there is …

  • Release Note

    In About

    Reference

    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 …

    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

    In pig

    ReferencePIG

    The pig pg command (alias pig postgres) manages local PostgreSQL servers and databases. It wraps local primitives such as pg_ctl, psql, and vacuumdb; use pig pt for Patroni cluster operations and pig pitr for orchestrated PITR. pig pg - Local …

    The pig pg command (alias pig postgres) manages local PostgreSQL servers and databases. It wraps local primitives such as pg_ctl, psql, and vacuumdb; use pig pt for Patroni cluster operations and pig pitr for orchestrated PITR. pig pg - Local …

  • pig inventory

    In pig

    ReferencePIG

    The pig inventory command group (alias pig inv), introduced in v1.6.0, provides lossless inspection, editing, validation, and readiness checks for the Pigsty inventory (pigsty.yml), plus an experimental cmdb subtree that exchanges the inventory with …

    The pig inventory command group (alias pig inv), introduced in v1.6.0, provides lossless inspection, editing, validation, and readiness checks for the Pigsty inventory (pigsty.yml), plus an experimental cmdb subtree that exchanges the inventory with …

  • FAQ

    In About

    ReferencePIGSTY

    What is Pigsty, and what is it not? Pigsty is a PostgreSQL database distribution, a local-first open-source RDS cloud database solution. Pigsty is not a Database Management System (DBMS), but rather a tool, distribution, solution, and best practice …

    What is Pigsty, and what is it not? Pigsty is a PostgreSQL database distribution, a local-first open-source RDS cloud database solution. Pigsty is not a Database Management System (DBMS), but rather a tool, distribution, solution, and best practice …

  • Subscription

    In About

    ReferencePIGSTY

    Pigsty aims to unite the power of the PostgreSQL ecosystem and help users make the most of the world’s most popular database, PostgreSQL, with self-driving database management software. While Pigsty itself has already resolved many issues in …

    Pigsty aims to unite the power of the PostgreSQL ecosystem and help users make the most of the world’s most popular database, PostgreSQL, with self-driving database management software. While Pigsty itself has already resolved many issues in …

  • Stanza Delete Command (stanza-delete)

    In Commands

    ReferencePGBACKREST

    Source: pgBackRest Command Docs: stanza-delete The stanza-delete command removes data in the repository associated with a stanza. WARNING: Use this command with caution — it will permanently remove all backups and archives from the pgBackRest …

    Source: pgBackRest Command Docs: stanza-delete The stanza-delete command removes data in the repository associated with a stanza. WARNING: Use this command with caution — it will permanently remove all backups and archives from the pgBackRest …

  • pig sty

    In pig

    ReferencePIG

    pig can also be used as a CLI tool for Pigsty, a batteries-included free PostgreSQL RDS solution. It brings HA, PITR, monitoring, infrastructure as code (IaC), and rich extension support to your PostgreSQL clusters. pig sty - Init (Download), …

    pig can also be used as a CLI tool for Pigsty, a batteries-included free PostgreSQL RDS solution. It brings HA, PITR, monitoring, infrastructure as code (IaC), and rich extension support to your PostgreSQL clusters. pig sty - Init (Download), …

  • User Cases

    In About

    ReferencePIGSTY

    According to Google Analytics PV and download statistics, Pigsty currently has approximately 100,000 users, with half from mainland China and half from other regions globally. They span across multiple industries including internet, cloud computing, …

    According to Google Analytics PV and download statistics, Pigsty currently has approximately 100,000 users, with half from mainland China and half from other regions globally. They span across multiple industries including internet, cloud computing, …

  • Stanza Create Command (stanza-create)

    In Commands

    ReferencePGBACKREST

    Source: pgBackRest Command Docs: stanza-create The stanza-create command must be run after the stanza has been configured in pgbackrest.conf. If there is more than one repository configured, the stanza will be created on each. Stanzas that have …

    Source: pgBackRest Command Docs: stanza-create The stanza-create command must be run after the stanza has been configured in pgbackrest.conf. If there is more than one repository configured, the stanza will be created on each. Stanzas that have …

  • Sponsor Us

    In About

    ReferencePIGSTY

    Sponsor Us Pigsty is a free and open-source software, passionately developed by PostgreSQL community members, aiming to integrate the power of the PostgreSQL ecosystem and promote the widespread adoption of PostgreSQL. If our work has helped you, …

    Sponsor Us Pigsty is a free and open-source software, passionately developed by PostgreSQL community members, aiming to integrate the power of the PostgreSQL ecosystem and promote the widespread adoption of PostgreSQL. If our work has helped you, …

  • License

    In About

    ReferencePIGSTY

    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 …

    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 …

  • Server Ping Command (server-ping)

    In Commands

    ReferencePGBACKREST

    Source: pgBackRest Command Docs: server-ping Ping a pgBackRest TLS server to ensure it is accepting connections. This serves as an aliveness check only since no authentication is attempted. If no host is specified on the command-line then the …

    Source: pgBackRest Command Docs: server-ping Ping a pgBackRest TLS server to ensure it is accepting connections. This serves as an aliveness check only since no authentication is attempted. If no host is specified on the command-line then the …

  • Privacy Policy

    In About

    ReferencePIGSTY

    Pigsty Software When you install Pigsty software, if you use offline package installation in a network-isolated environment, we will not receive any data about you. If you choose online installation, when downloading related packages, our servers or …

    Pigsty Software When you install Pigsty software, if you use offline package installation in a network-isolated environment, we will not receive any data about you. If you choose online installation, when downloading related packages, our servers or …

  • pig build

    In pig

    ReferencePIG

    The pig build command simplifies the full workflow for building PostgreSQL extensions from source. It provides build infrastructure setup, dependency management, and compilation environments for standard and custom PostgreSQL extensions across …

    The pig build command simplifies the full workflow for building PostgreSQL extensions from source. It provides build infrastructure setup, dependency management, and compilation environments for standard and custom PostgreSQL extensions across …

  • Join the Community

    In About

    ReferencePIGSTY

    GitHub Our GitHub repository is: https://github.com/pgsty/pigsty. Please give us a ⭐️ star! We welcome anyone to submit new Issues or create Pull Requests, propose feature suggestions, and contribute to Pigsty. Please note that for issues related to …

    GitHub Our GitHub repository is: https://github.com/pgsty/pigsty. Please give us a ⭐️ star! We welcome anyone to submit new Issues or create Pull Requests, propose feature suggestions, and contribute to Pigsty. Please note that for issues related to …

  • Roadmap

    In About

    ReferencePIGSTY

    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 version updates signify incompatible foundational changes and major new …

    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 version updates signify incompatible foundational changes and major new …

  • Server Command (server)

    In Commands

    ReferencePGBACKREST

    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. IP address the server will listen on for …

    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. IP address the server will listen on for …

  • pig ext

    In pig

    ReferencePIG

    The pig ext command is an all-in-one tool for managing PostgreSQL extensions. It lets you search, install, remove, update, and manage PostgreSQL extensions, and it can also handle PostgreSQL kernel packages. pig ext - Manage PostgreSQL Extensions pig …

    The pig ext command is an all-in-one tool for managing PostgreSQL extensions. It lets you search, install, remove, update, and manage PostgreSQL extensions, and it can also handle PostgreSQL kernel packages. pig ext - Manage PostgreSQL Extensions pig …

  • Restore Command (restore)

    In Commands

    ReferencePGBACKREST

    Source: pgBackRest Command Docs: restore The restore command automatically defaults to selecting the latest backup from the first repository where backups exist (see Quick Start - Restore a Backup). The order in which the repositories are checked is …

    Source: pgBackRest Command Docs: restore The restore command automatically defaults to selecting the latest backup from the first repository where backups exist (see Quick Start - Restore a Backup). The order in which the repositories are checked is …

  • pig repo

    In pig

    ReferencePIG

    The pig repo command is a comprehensive package repository manager. It can add, remove, create, and manage repositories on RPM systems (RHEL/CentOS/Rocky/Alma) and Debian systems (Debian/Ubuntu). pig repo - Manage Linux APT/YUM Repo pig repo list # …

    The pig repo command is a comprehensive package repository manager. It can add, remove, create, and manage repositories on RPM systems (RHEL/CentOS/Rocky/Alma) and Debian systems (Debian/Ubuntu). pig repo - Manage Linux APT/YUM Repo pig repo list # …

  • Repository List Command (repo-ls)

    In Commands

    ReferencePGBACKREST

    Source: pgBackRest Command Docs: repo-ls Similar to the unix ls command but works on any supported repository type. This command accepts a path, absolute or relative to the repository path defined by the --repo-path option, and is primarily for …

    Source: pgBackRest Command Docs: repo-ls Similar to the unix ls command but works on any supported repository type. This command accepts a path, absolute or relative to the repository path defined by the --repo-path option, and is primarily for …

  • pig

    In pig

    ReferencePIG

    The pig CLI provides a comprehensive toolkit for managing PostgreSQL installations, extensions, repositories, and extension builds from source. Use pig help <command> to view command documentation. pig repo: manage software repositories pig ext: …

    The pig CLI provides a comprehensive toolkit for managing PostgreSQL installations, extensions, repositories, and extension builds from source. Use pig help <command> to view command documentation. pig repo: manage software repositories pig ext: …

  • Repository Get Command (repo-get)

    In Commands

    ReferencePGBACKREST

    Source: pgBackRest Command Docs: repo-get Similar to the unix cat command but works on any supported repository type. This command requires a fully qualified file name and is primarily for administration, investigation, and testing. It is not a …

    Source: pgBackRest Command Docs: repo-get Similar to the unix cat command but works on any supported repository type. This command requires a fully qualified file name and is primarily for administration, investigation, and testing. It is not a …

  • Frequently Asked Questions

    In pgbouncer

    ReferencePGBOUNCER

    Source: https://www.pgbouncer.org/faq.html How to connect to PgBouncer? PgBouncer acts as a Postgres server, so simply point your client to the PgBouncer port. How to load-balance queries between several servers? PgBouncer does not have an internal …

    Source: https://www.pgbouncer.org/faq.html How to connect to PgBouncer? PgBouncer acts as a Postgres server, so simply point your client to the PgBouncer port. How to load-balance queries between several servers? PgBouncer does not have an internal …

  • Info Command (info)

    In Commands

    ReferencePGBACKREST

    Source: pgBackRest Command Docs: info The info command operates on a single stanza or all stanzas. Text output is the default and gives a human-readable summary of backups for the stanza(s) requested. This format is subject to change with any …

    Source: pgBackRest Command Docs: info The info command operates on a single stanza or all stanzas. Text output is the default and gives a human-readable summary of backups for the stanza(s) requested. This format is subject to change with any …

  • Parameters

    In Configuration

    ReferencePGSQL

    PostgreSQL parameters can be configured at multiple levels with different scopes and precedence. Pigsty supports four configuration levels, from global to local: Level Scope Configuration Method Storage Location Cluster All instances in cluster …

    PostgreSQL parameters can be configured at multiple levels with different scopes and precedence. Pigsty supports four configuration levels, from global to local: Level Scope Configuration Method Storage Location Cluster All instances in cluster …

  • Help Command (help)

    In Commands

    ReferencePGBACKREST

    Source: pgBackRest Command Docs: help Three levels of help are provided. If no command is specified then general help will be displayed. If a command is specified (e.g. pgbackrest help backup) then a full description of the command will be displayed …

    Source: pgBackRest Command Docs: help Three levels of help are provided. If no command is specified then general help will be displayed. If a command is specified (e.g. pgbackrest help backup) then a full description of the command will be displayed …

  • Frequently Asked Questions

    In pgbackrest

    ReferencePGBACKREST

    Introduction Frequently Asked Questions are intended to provide details for specific questions that may or may not be covered in the User Guide, Configuration, or Command reference. If you are unable to find details for your specific issue here, …

    Introduction Frequently Asked Questions are intended to provide details for specific questions that may or may not be covered in the User Guide, Configuration, or Command reference. If you are unable to find details for your specific issue here, …

  • Changelog

    In pgbouncer

    ReferencePGBOUNCER

    Source: https://www.pgbouncer.org/changelog.html PgBouncer 1.25.x 2026-05-08 - PgBouncer 1.25.2 - “Human touch with fresh twist in title race full of uncertainties” Security Fix CVE-2026-6664: An integer overflow in network packet parsing code in …

    Source: https://www.pgbouncer.org/changelog.html PgBouncer 1.25.x 2026-05-08 - PgBouncer 1.25.2 - “Human touch with fresh twist in title race full of uncertainties” Security Fix CVE-2026-6664: An integer overflow in network packet parsing code in …

  • Access Control

    In Configuration

    ReferencePGSQL

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

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

  • Release Notes

    In pgbackrest

    ReferencePGBACKREST

    Introduction pgBackRest release numbers consist of two parts, major and minor. A major release may break compatibility with the prior major release, but v2 releases are fully compatible with v1 repositories and will accept all v1 options. Minor …

    Introduction pgBackRest release numbers consist of two parts, major and minor. A major release may break compatibility with the prior major release, but v2 releases are fully compatible with v1 repositories and will accept all v1 options. Minor …

  • HBA Rules

    In Configuration

    ReferencePGSQL

    Overview HBA (Host-Based Authentication) controls “who can connect to the database, from where, and how”. See Authentication for the authentication model and default rules. Pigsty manages HBA rules declaratively through pg_default_hba_rules and …

    Overview HBA (Host-Based Authentication) controls “who can connect to the database, from where, and how”. See Authentication for the authentication model and default rules. Pigsty manages HBA rules declaratively through pg_default_hba_rules and …

  • Expire Command (expire)

    In Commands

    ReferencePGBACKREST

    Source: pgBackRest Command Docs: expire pgBackRest does full backup rotation based on the retention type which can be a count or a time period. When a count is specified, then expiration is not concerned with when the backups were created but with …

    Source: pgBackRest Command Docs: expire pgBackRest does full backup rotation based on the retention type which can be a count or a time period. When a count is specified, then expiration is not concerned with when the backups were created but with …

  • TINY Template

    In Param Templates

    ReferencePGSQL

    tiny.yml is optimized for micro instances and resource-constrained environments. Designed for 1-3 core CPUs with minimal resource usage, conservative memory allocation, and disabled parallel queries. Pair with node_tune = tiny for OS-level tuning. …

    tiny.yml is optimized for micro instances and resource-constrained environments. Designed for 1-3 core CPUs with minimal resource usage, conservative memory allocation, and disabled parallel queries. Pair with node_tune = tiny for OS-level tuning. …

  • patronictl

    In patroni

    ReferencePATRONI

    Source: https://patroni.readthedocs.io/en/latest/patronictl.html Patroni has a command-line interface named patronictl, which is used basically to interact with Patroni’s REST API and with the DCS. It is intended to make it easier to perform …

    Source: https://patroni.readthedocs.io/en/latest/patronictl.html Patroni has a command-line interface named patronictl, which is used basically to interact with Patroni’s REST API and with the DCS. It is intended to make it easier to perform …

  • Source Releases Download

    In pgbouncer

    ReferencePGBOUNCER

    Source: https://www.pgbouncer.org/downloads/ PgBouncer 1.25 File Date Size SHA256 pgbouncer-1.25.2.tar.gz 2026-05-08 865371 bytes sha256 pgbouncer-1.25.1.tar.gz 2025-12-03 864801 bytes sha256 pgbouncer-1.25.0.tar.gz 2025-11-09 863322 bytes sha256 …

    Source: https://www.pgbouncer.org/downloads/ PgBouncer 1.25 File Date Size SHA256 pgbouncer-1.25.2.tar.gz 2026-05-08 865371 bytes sha256 pgbouncer-1.25.1.tar.gz 2025-12-03 864801 bytes sha256 pgbouncer-1.25.0.tar.gz 2025-11-09 863322 bytes sha256 …

  • Database

    In Configuration

    ReferencePGSQL

    In this document, “database” refers to a logical object within a database cluster created with CREATE DATABASE. A PostgreSQL cluster can serve multiple databases simultaneously. In Pigsty, you can define required databases in cluster configuration. …

    In this document, “database” refers to a logical object within a database cluster created with CREATE DATABASE. A PostgreSQL cluster can serve multiple databases simultaneously. In Pigsty, you can define required databases in cluster configuration. …

  • Configuration Reference

    In pgbackrest

    ReferencePGBACKREST

    Introduction pgBackRest can be used entirely with command-line parameters but a configuration file is more practical for installations that are complex or set a lot of options. The default location for the configuration file is …

    Introduction pgBackRest can be used entirely with command-line parameters but a configuration file is more practical for installations that are complex or set a lot of options. The default location for the configuration file is …

  • Check Command (check)

    In Commands

    ReferencePGBACKREST

    Source: pgBackRest Command Docs: check The check command validates that pgBackRest and the archive_command setting are configured correctly for archiving and backups for the specified stanza. It will attempt to check all repositories and databases …

    Source: pgBackRest Command Docs: check The check command validates that pgBackRest and the archive_command setting are configured correctly for archiving and backups for the specified stanza. It will attempt to check all repositories and databases …

  • User/Role

    In Configuration

    ReferencePGSQL

    In this document, “user” refers to a logical object within a database cluster created with CREATE USER/ROLE. In PostgreSQL, users belong directly to the database cluster rather than a specific database. Therefore, when creating business databases …

    In this document, “user” refers to a logical object within a database cluster created with CREATE USER/ROLE. In PostgreSQL, users belong directly to the database cluster rather than a specific database. Therefore, when creating business databases …

  • Release

    In pig

    ReferencePIG

    The latest stable version is v1.8.0. Version Date Summary GitHub v1.8.0 2026-08-14 Native sty boot and sty conf, 575 packaged extensions v1.8.0 v1.7.0 2026-08-12 EL module policy, China mirrors, EL7 compatibility, 575 extensions v1.7.0 v1.6.2 …

    The latest stable version is v1.8.0. Version Date Summary GitHub v1.8.0 2026-08-14 Native sty boot and sty conf, 575 packaged extensions v1.8.0 v1.7.0 2026-08-12 EL module policy, China mirrors, EL7 compatibility, 575 extensions v1.7.0 v1.6.2 …

  • Patroni REST API

    In patroni

    ReferencePATRONI

    Source: https://patroni.readthedocs.io/en/latest/rest_api.html Patroni has a rich REST API, which is used by Patroni itself during the leader race, by the patronictl tool in order to perform failovers/switchovers/reinitialize/restarts/reloads, by …

    Source: https://patroni.readthedocs.io/en/latest/rest_api.html Patroni has a rich REST API, which is used by Patroni itself during the leader race, by the patronictl tool in order to perform failovers/switchovers/reinitialize/restarts/reloads, by …

  • CRIT Template

    In Param Templates

    ReferencePGSQL

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

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

  • Command Reference

    In Commands

    ReferencePGBACKREST

    Source: https://pgbackrest.org/command.html Introduction Commands are used to execute the various pgBackRest functions. Here the command options are listed exhaustively, that is, each option applicable to a command is listed with that command even …

    Source: https://pgbackrest.org/command.html Introduction Commands are used to execute the various pgBackRest functions. Here the command options are listed exhaustively, that is, each option applicable to a command is listed with that command even …

  • Backup Command (backup)

    In Commands

    ReferencePGBACKREST

    Source: pgBackRest Command Docs: backup When multiple repositories are configured, pgBackRest will backup to the highest priority repository (e.g. repo1) unless the --repo option is specified. pgBackRest does not have a built-in scheduler so it’s …

    Source: pgBackRest Command Docs: backup When multiple repositories are configured, pgBackRest will backup to the highest priority repository (e.g. repo1) unless the --repo option is specified. pgBackRest does not have a built-in scheduler so it’s …

  • Patroni configuration

    In Patroni configuration

    ReferencePATRONI

    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 applied on all cluster …

    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 applied on all cluster …

  • Package Alias

    In Configuration

    ReferencePGSQL

    PostgreSQL package naming conventions vary significantly across different operating systems: EL systems (RHEL/Rocky/Alma/…) use formats like pgvector_18, postgis36_18* Debian/Ubuntu systems use formats like postgresql-18-pgvector, …

    PostgreSQL package naming conventions vary significantly across different operating systems: EL systems (RHEL/Rocky/Alma/…) use formats like pgvector_18, postgis36_18* Debian/Ubuntu systems use formats like postgresql-18-pgvector, …

  • OLAP Template

    In Param Templates

    ReferencePGSQL

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

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

  • News & Events

    In About

    ReferencePIGSTY

    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 …

    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 …

  • Environment Configuration Settings

    In Patroni configuration

    ReferencePATRONI

    Source: https://patroni.readthedocs.io/en/latest/ENVIRONMENT.html It is possible to override some of the configuration parameters defined in the Patroni configuration file using the system environment variables. This document lists all environment …

    Source: https://patroni.readthedocs.io/en/latest/ENVIRONMENT.html It is possible to override some of the configuration parameters defined in the Patroni configuration file using the system environment variables. This document lists all environment …

  • Archive Push Command (archive-push)

    In Commands

    ReferencePGBACKREST

    Source: pgBackRest Command Docs: archive-push Accepts a WAL segment from PostgreSQL and archives it in each repository defined by the indexed repo-path option (see the Repository section for information on configuring repositories). The WAL segment …

    Source: pgBackRest Command Docs: archive-push Accepts a WAL segment from PostgreSQL and archives it in each repository defined by the indexed repo-path option (see the Repository section for information on configuring repositories). The WAL segment …

  • OLTP Template

    In Param Templates

    ReferencePGSQL

    oltp.yml is Pigsty’s default config template, optimized for online transaction processing (OLTP). Designed for 4-128 core CPUs with high concurrency, low latency, and high throughput. Pair with node_tune = oltp for OS-level tuning. Use Cases OLTP …

    oltp.yml is Pigsty’s default config template, optimized for online transaction processing (OLTP). Designed for 4-128 core CPUs with high concurrency, low latency, and high throughput. Pair with node_tune = oltp for OS-level tuning. Use Cases OLTP …

  • Kernel Version

    In Configuration

    ReferencePGSQL

    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 currently supports PostgreSQL 14-18 and uses 18 by default. The following …

    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 currently supports PostgreSQL 14-18 and uses 18 by default. The following …

  • History

    In About

    ReferencePIGSTY

    Historical Origins The Pigsty project began in 2018-2019, originating from Tantan. Tantan is an internet dating app — China’s Tinder, now acquired by Momo. Tantan was a Nordic-style startup with a Swedish engineering founding team. Tantan had …

    Historical Origins The Pigsty project began in 2018-2019, originating from Tantan. Tantan is an internet dating app — China’s Tinder, now acquired by Momo. Tantan was a Nordic-style startup with a Swedish engineering founding team. Tantan had …

  • Configuration: pgbouncer.ini

    In pgbouncer

    ReferencePGBOUNCER

    Source: https://www.pgbouncer.org/config.html Description The configuration file is in “ini” format. Section names are between [ and ]. Lines starting with ; or # are taken as comments and ignored. The characters ; and # are not recognized as …

    Source: https://www.pgbouncer.org/config.html Description The configuration file is in “ini” format. Section names are between [ and ]. Lines starting with ; or # are taken as comments and ignored. The characters ; and # are not recognized as …

  • Archive Get Command (archive-get)

    In Commands

    ReferencePGBACKREST

    Source: pgBackRest Command Docs: archive-get This command is used by PostgreSQL to restore a backup, perform PITR, or as an alternative to streaming for keeping a replica up to date. WAL segments are required for PostgreSQL recovery or to maintain a …

    Source: pgBackRest Command Docs: archive-get This command is used by PostgreSQL to restore a backup, perform PITR, or as an alternative to streaming for keeping a replica up to date. WAL segments are required for PostgreSQL recovery or to maintain a …

  • YAML Configuration Settings

    In Patroni configuration

    ReferencePATRONI

    Source: https://patroni.readthedocs.io/en/latest/yaml_configuration.html Global/Universal thread_pool_size: size of thread pool used by Patroni to execute asynchronous tasks and communicate via REST API with other members during leader race or …

    Source: https://patroni.readthedocs.io/en/latest/yaml_configuration.html Global/Universal thread_pool_size: size of thread pool used by Patroni to execute asynchronous tasks and communicate via REST API with other members during leader race or …

  • Parameter Optimization Policy

    In Param Templates

    ReferencePGSQL

    Pigsty provides four scenario-based parameter templates by default, which can be specified and used through the pg_conf parameter. tiny.yml: Optimized for small nodes, VMs, and demos (the template is labeled for 1-3 cores) oltp.yml: Optimized for …

    Pigsty provides four scenario-based parameter templates by default, which can be specified and used through the pg_conf parameter. tiny.yml: Optimized for small nodes, VMs, and demos (the template is labeled for 1-3 cores) oltp.yml: Optimized for …

  • News

    In pgbackrest

    ReferencePGBACKREST

    Source: https://pgbackrest.org/news.html New Distribution Tarball July 20, 2026 Starting with pgBackRest 2.59.0, every release includes a distribution tarball that makes building from source simpler. Unlike a checkout of the git repository, the …

    Source: https://pgbackrest.org/news.html New Distribution Tarball July 20, 2026 Starting with pgBackRest 2.59.0, every release includes a distribution tarball that makes building from source simpler. Unlike a checkout of the git repository, the …

  • Features

    In About

    ReferencePIGSTY

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

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

  • Dynamic Configuration Settings

    In Patroni configuration

    ReferencePATRONI

    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. In order to change the dynamic configuration you can use …

    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. In order to change the dynamic configuration you can use …

  • Pigsty Docs v4.5

    In Docs

    ReferencePIGSTY

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

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

  • Cluster / Instance

    In Configuration

    ReferencePGSQL

    Choose the appropriate instance and cluster types based on your requirements to configure PostgreSQL database clusters that meet your needs. You can define different types of instances and clusters. Here are several common PostgreSQL …

    Choose the appropriate instance and cluster types based on your requirements to configure PostgreSQL database clusters that meet your needs. You can define different types of instances and clusters. Here are several common PostgreSQL …

  • Annotate Command (annotate)

    In Commands

    ReferencePGBACKREST

    Source: pgBackRest Command Docs: annotate Annotations included with the backup command can be added, modified, or removed afterwards using the annotate command. Command Options Backup Annotation Option (--annotation) Annotate backup with …

    Source: pgBackRest Command Docs: annotate Annotations included with the backup command can be added, modified, or removed afterwards using the annotate command. Command Options Backup Annotation Option (--annotation) Annotate backup with …