# Pigsty 中文文档 v4.5

LLMS 索引： [llms.txt](/llms.txt)

---

"<strong>P</strong>ostgreSQL <strong>I</strong>n <strong>G</strong>reat <strong>STY</strong>le": <strong>P</strong>ostgres, <strong>I</strong>nfras, <strong>G</strong>raphics, <strong>S</strong>ervice, <strong>T</strong>oolbox, it's all <strong>Y</strong>ours.

—— **开源免费、开箱即用、本地优先、自主可控的企业级 PostgreSQL 发行版与 RDS 方案**

**开源免费** **本地优先** **生产可用**

> [仓库](https://github.com/pgsty/pigsty) | [演示](https://demo.pigsty.cc) | [博客](/blog) | [论坛](https://github.com/pgsty/pigsty/discussions) | [微信](https://mp.weixin.qq.com/s/-E_-HZ7LvOze5lmzy3QbQA) | [EN Docs](https://pigsty.io/docs/)

按 ⌘ + K（macOS）或 Ctrl + K 可随时打开本地搜索与命令面板。

## 简介

从了解项目、理解概念，到单机上手、生产部署，四步掌握 Pigsty：


- [关于](/docs/about/) — 了解 Pigsty 项目本身的方方面面：功能特性、历史沿革、开源协议、隐私政策与社区动态。 [功能特性](/docs/about/feature) [历史沿革](/docs/about/history) [活动新闻](/docs/about/event) [加入社区](/docs/about/community) [开源协议](/docs/about/license) [服务订阅](/docs/about/service)
- [概念](/docs/concept/) — 理解 Pigsty 的核心概念、架构设计与设计理念，掌握高可用、备份恢复、安全合规等关键能力。 [系统架构](/docs/concept/arch) [集群模型](/docs/concept/model) [监控系统](/docs/concept/monitor) [IaC](/docs/concept/iac) [高可用](/docs/concept/ha) [PITR](/docs/concept/pitr) [服务接入](/docs/pgsql/misc/svc) [安全加固](/docs/concept/sec)
- [上手](/docs/setup/) — 在你的笔记本或云服务器上拉起 Pigsty 单机版本，访问数据库服务与 Web 管理界面。 [单机安装](/docs/setup/install) [离线安装](/docs/setup/offline) [声明配置](/docs/setup/config) [执行剧本](/docs/setup/playbook) [图形界面](/docs/setup/webui) [常见问题](/docs/pgsql/faq)
- [部署](/docs/deploy/) — 在生产环境中进行多节点、高可用的 Pigsty 架构规划、资源准备与正式部署。 [架构规划](/docs/deploy/planning) [资源准备](/docs/deploy/prepare) [生产部署](/docs/deploy/install) [沙箱环境](/docs/deploy/sandbox) [Vagrant](/docs/deploy/vagrant) [OpenTofu](/docs/deploy/terraform)


## 安装

[**快速上手**](/docs/setup/install)：[**准备**](/docs/deploy/prepare) 一台全新安装 [**Linux**](/docs/ref/linux) 操作系统的节点，使用具有免密 `ssh` 与 `sudo` 权限的用户运行：

```bash {title="Terminal" copy="all" label="Pigsty 快速安装"}
curl -fsSL https://repo.pigsty.cc/get | bash -s v4.4.0   # 下载公开稳定版源码包
cd ~/pigsty      # 进入源码目录
./configure      # 生成配置文件
./deploy.yml     # 执行安装部署
```

[**下载**](/docs/setup/install#安装)、[**配置**](/docs/setup/install#配置) 与 [**部署**](/docs/setup/install#部署)，Pigsty 会在几分钟内完成安装！您可以稍后 [**添加更多节点**](/docs/deploy/install) 与数据库集群。

接下来，您可以探索 [**图形界面**](/docs/setup/webui)，访问 `5432` 端口上的 [**PostgreSQL 服务**](/docs/pgsql/service/)，以及 `3000` 端口上的 Grafana 监控大盘（用户名 / 密码：`admin` / `pigsty`）。

您还可以将多种风味的 [**PostgreSQL 内核**](/docs/pgsql/kernel/) 封装为 RDS 服务：[**Citus**](/docs/pgsql/kernel/citus)、[**WiltonDB**](/docs/pgsql/kernel/babelfish)、[**IvorySQL**](/docs/pgsql/kernel/ivorysql)、[**OpenHalo**](/docs/pgsql/kernel/openhalo)、[**Percona**](/docs/pgsql/kernel/percona)、[**OrioleDB**](/docs/pgsql/kernel/orioledb)、[**PolarDB**](/docs/pgsql/kernel/polardb)，以及 [**Supabase**](/docs/pgsql/kernel/supabase)。


## 模块

Pigsty 由多个 [**模块**](/docs/ref/module) 组成。其中 `PGSQL` / `INFRA` / `NODE` / `ETCD`（PINE 组合）是自建 PostgreSQL RDS 服务的 **必选** 模块：


- [PGSQL](/docs/pgsql/) (核心) — 自治自愈的高可用 PostgreSQL 集群：HA、PITR、IaC、ACL 与监控齐备，海量扩展开箱即用。 [集群配置](/docs/pgsql/config/) [日常管理](/docs/pgsql/admin/) [备份恢复](/docs/pgsql/backup/) [服务接入](/docs/pgsql/service/) [内核分支](/docs/pgsql/kernel/) [参数列表](/docs/pgsql/param/)
- [INFRA](/docs/infra/) (核心) — Nginx、本地软件仓库、DNS、NTP，以及 VictoriaMetrics 与 Grafana 可观测性技术栈。 [配置](/docs/infra/config) [管理](/docs/infra/admin/) [剧本](/docs/infra/playbook) [监控](/docs/infra/monitor) [参数](/docs/infra/param)
- [NODE](/docs/node/) (核心) — 将主机节点纳管调整至期望状态：主机监控、日志收集、VIP 与 HAProxy 负载均衡。 [配置](/docs/node/config) [管理](/docs/node/admin) [剧本](/docs/node/playbook) [监控](/docs/node/monitor) [参数](/docs/node/param)
- [ETCD](/docs/etcd/) (核心) — 可靠的分布式共识存储（DCS），为 PostgreSQL 高可用提供集群元数据支撑。 [配置](/docs/etcd/config) [管理](/docs/etcd/admin) [剧本](/docs/etcd/playbook) [监控](/docs/etcd/monitor) [参数](/docs/etcd/param)


此外还有一些 **可选** 模块，它们与 PostgreSQL 配合良好，可为你的数据基础设施带来额外价值：


- [MINIO](/docs/minio/) (可选) — S3 兼容的对象存储，可用作数据库备份的集中存储仓库。
- [REDIS](/docs/redis/) (可选) — 高性能内存数据结构服务器，主从、集群、哨兵三种模式。
- [DOCKER](/docs/docker/) (可选) — 容器运行时，一键拉起容器化的无状态软件与应用模板。
- [JUICE](/docs/juice/) (可选) — JuiceFS 分布式文件系统，将 PostgreSQL 挂载为文件系统
- [VIBE](/docs/vibe/) (可选) — AI 编程沙箱，Claude/Codex 开发环境，Agent 运行时
- [KAFKA](/docs/kafka/) (可选) — Apache Kafka 4.x dynamic KRaft 消息队列集群，安全与监控齐备。
- [MYSQL](/docs/mysql/) (可选) — MySQL 数据库，广泛使用的关系型数据库管理系统。
- [PILOT](/docs/pilot/) (试点) — 试点功能模组：Kubernetes、DuckDB、MySQL、TigerBeetle……供尝鲜探索。



## 参考信息

详尽的参考资料、扩展目录、开箱即用的模板，以及周边组件的中文文档：


- [参考手册](/docs/ref/) — 详尽的参考信息列表：操作系统、文件结构、参数、监控指标与同类产品对比。 [操作系统](/docs/ref/linux) [模块列表](/docs/ref/module) [文件结构](/docs/ref/fhs) [同类产品](/docs/about/compare) [成本参考](/docs/about/compare/cost) [运维 SOP](/docs/sop/)
- [已打包扩展](/ext/) — {pgext_count} 个已打包 PostgreSQL 生态扩展：元数据、文档、下载与支持矩阵。 [扩展列表](/ext/list) [系统支持](/ext/os) [软件仓库](/docs/repo/)
- [开箱模板](/docs/conf/) — 开箱即用的集群配置模板，以及容器化的软件与应用模板。 [配置模板](/docs/conf/) [应用模板](/docs/app/)
- [组件手册](/docs/pig/) — Pigsty 所用周边组件与工具的中文文档：包管理、高可用、连接池、备份与监控。 [pig](/docs/pig/) [piglet](/docs/piglet/) [patroni](/docs/patroni/) [pgbouncer](/docs/pgbouncer/) [pgbackrest](/docs/pgbackrest/) [pg_exporter](/docs/pg_exporter/)

---

本节页面：

- [PIGSTY](/docs/_div_pigsty/)
- [上手](/docs/setup/): 在你的笔记本/云服务器上部署 Pigsty 单机版本，访问数据库以及 Web 用户界面
- [部署](/docs/deploy/): 在生产环境中进行多节点、高可用的 Pigsty 规划、准备与部署工作。
- [概念](/docs/concept/): 理解 Pigsty 的核心概念、架构设计与设计理念，掌握高可用、备份恢复、安全合规等关键能力。
- [关于](/docs/about/): 了解 Pigsty 项目本身的方方面面：功能特性、历史发展，开源协议，隐私政策，社区活动与新闻。
- [参考信息](/docs/_div_ref/)
- [参考](/docs/ref/): 详细的参考信息与列表：支持的操作系统，模块，参数，监控指标，数据库扩展，同类对比，术语表等。
- [应用](/docs/app/): 基于 Pigsty 的应用模板与数据应用说明：使用 Docker Compose 拉起无状态应用，并将状态托管到外部 PostgreSQL / S3 兼容存储。
- [模板](/docs/conf/): 开箱即用的配置模板，针对具体场景的配置示例，以及配置文件的详细解释。
- [Linux 软件仓库](/docs/repo/): 用于交付 PostgreSQL 扩展的基础设施和软件包仓库
- [运维 SOP 索引](/docs/sop/): 面向新手用户的 Pigsty 与 PostgreSQL 运维文档索引：按常见任务找到应读文档。
- [功能模块](/docs/_div_module/)
- [模块：PGSQL](/docs/pgsql/): 使用 Pigsty v4.5 声明、部署、接入、监控、备份与管理 PostgreSQL 集群。
- [模块：INFRA](/docs/infra/): 可独立使用且可选的基础设施，为 PostgreSQL 提供 NTP，DNS，可观测性等基础服务。
- [模块：NODE](/docs/node/): 配置目标服务器，纳管主机节点，并将其调整至描述的状态。也包括节点上的 VIP，HAProxy 以及监控组件。
- [模块：ETCD](/docs/etcd/): Pigsty 可部署 etcd 模块，作为 DCS 为 PostgreSQL 高可用提供可靠的分布式配置存储支持。
- [模块：MINIO](/docs/minio/): 使用 MINIO 兼容模块部署 Silo S3 对象存储，并作为 PostgreSQL 备份仓库。
- [模块：REDIS](/docs/redis/): 使用统一的 REDIS 模块部署 Redis 或 Valkey，并支持独立主从、原生集群与 Sentinel 三种模式。
- [模块：DOCKER](/docs/docker/): Docker Daemon 服务，允许用户一键拉起容器化的无状态软件工具模板，加装各种功能。
- [模块：JUICE](/docs/juice/): 使用 JuiceFS 分布式文件系统，以 PostgreSQL 作为元数据引擎，提供可共享的 POSIX 存储。
- [模块：VIBE](/docs/vibe/): 使用 Pigsty 部署 AI 编程沙箱：Code-Server、JupyterLab、Node.js、Claude Code 与 Codex CLI。
- [模块：KAFKA](/docs/kafka/): 使用 Pigsty 部署、保护与监控 Apache Kafka 4.1+ 动态 KRaft 集群。
- [模块：MYSQL](/docs/mysql/): 使用 Pigsty 部署原生 MySQL 8.4 LTS 单机或三节点 InnoDB Cluster，附带 TLS、每日备份与完整监控。
- [模块：PILOT](/docs/pilot/): 试点开发的额外功能模组
- [其他组件](/docs/_div_misc/)
- [pig 1.8 文档](/docs/pig/): PostgreSQL 扩展生态包管理器与管理命令行工具
- [Piglet Runtime：AI 运行时沙箱](/docs/piglet/): Pigsty 轻量运行时，AI Vibe Coding 沙箱，一键在云端拉起你的写意编程环境
- [Patroni 4.1.4 中文文档](/docs/patroni/): Patroni PostgreSQL 高可用模板，v4.1.4 中文文档
- [pgBouncer 1.25 中文文档](/docs/pgbouncer/): PgBouncer —— PostgreSQL 轻量级连接池，v1.25 中文文档
- [pgBackRest 2.59 中文文档](/docs/pgbackrest/): 可靠的 PostgreSQL 备份与恢复工具 —— pgBackRest 文档与参考手册。
- [PG Exporter 1.4 中文文档](/docs/pg_exporter/): 高级 PostgreSQL 与 PgBouncer 监控指标导出器