# Pigsty v5.0 文档

> 从核心概念和快速上手，到生产部署、模块参考与日常运维。

---

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

---

Pigsty v5.0 文档聚焦 **Pigsty 自身**：架构、安装、部署、配置、运维，以及每个正式模块的完整手册。

**v5\.0 文档预览** **OINK 0\.6\.0** **本地优先**

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

## 开始使用


- [认识 Pigsty](/docs/about/) — 了解功能、架构、设计理念、适用场景与项目背景。 [功能特性](/docs/about/feature/) · [核心概念](/docs/concept/) · [系统架构](/docs/concept/arch/) · [高可用](/docs/concept/ha/) · [备份恢复](/docs/concept/pitr/)
- [快速上手](/docs/setup/) — 从一台全新的 Linux 主机开始，完成配置与首次部署。 [安装](/docs/setup/install/) · [配置](/docs/setup/config/) · [执行剧本](/docs/setup/playbook/) · [离线安装](/docs/setup/offline/) · [Web 界面](/docs/setup/webui/)
- [生产部署](/docs/deploy/) — 完成容量规划、资源准备、安全加固和多节点交付。 [规划](/docs/deploy/planning/) · [准备](/docs/deploy/prepare/) · [安装](/docs/deploy/install/) · [安全](/docs/deploy/security/) · [沙箱](/docs/deploy/sandbox/)
- [配置与参考](/docs/ref/) — 查询配置模板、模块、参数、剧本、端口与文件结构。 [配置模板](/docs/conf/) · [模块列表](/docs/ref/module/) · [参数](/docs/ref/param/) · [剧本](/docs/ref/playbook/) · [端口](/docs/ref/port/) · [文件结构](/docs/ref/fhs/)


## 核心模块


- [PGSQL](/docs/pgsql/) (核心) — 高可用 PostgreSQL 集群、服务、备份、监控、安全与日常管理。
- [INFRA](/docs/infra/) (核心) — VictoriaMetrics、VictoriaLogs、Grafana、Nginx 与基础设施服务。
- [NODE](/docs/node/) (核心) — 主机纳管、软件基线、日志采集、VIP 与 HAProxy 负载均衡。
- [ETCD](/docs/etcd/) (核心) — 为 PostgreSQL 高可用提供可靠的分布式配置存储。


## 可选模块


- [MINIO \/ Silo](/docs/minio/) (存储) — S3 兼容对象存储与 PostgreSQL 备份仓库。
- [REDIS \/ Valkey](/docs/redis/) (缓存) — 主从、Sentinel 与原生集群模式。
- [JUICE](/docs/juice/) (文件系统) — 以 PostgreSQL 和对象存储为后端的 JuiceFS。
- [KAFKA](/docs/kafka/) (消息) — 动态 KRaft、TLS、ACL 与完整可观测性。
- [MYSQL](/docs/mysql/) (数据库) — MySQL 8.4 LTS 与 InnoDB Cluster。
- [DOCKER](/docs/docker/) (运行时) — 受管 Docker 服务与容器运行环境。
- [VIBE](/docs/vibe/) (开发) — Code-Server、Jupyter 与 AI 编程沙箱。


## 内容边界

本站不复制 Pig、Patroni、pg_exporter、pgBackRest、PgBouncer、软件仓库、应用模板和试点项目的独立手册。正文确需引用这些组件时，会链接到原有文档站；Pigsty 自身的集成、配置与运维说明仍保留在对应模块内。

---

本节页面：

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