# Pigsty v5.0 Documentation

> From core concepts and quick start to production deployment, module references, and day-to-day operations.

---

LLMS index: [llms.txt](/llms.txt)

---

The Pigsty v5.0 documentation focuses on **Pigsty itself**: architecture, installation, deployment, configuration, operations, and the complete manual for every first-party module.

**v5\.0 Docs Preview** **OINK 0\.6\.0** **Local First**

Press ⌘ + K on macOS, or Ctrl + K, to open offline search and the command palette anywhere on the site.

## Get Started


- [About Pigsty](/docs/about/) — Learn about Pigsty's features, architecture, design principles, use cases, and project background. [Features](/docs/about/feature/) · [Core Concepts](/docs/concept/) · [Architecture](/docs/concept/arch/) · [High Availability](/docs/concept/ha/) · [Backup & Recovery](/docs/concept/pitr/)
- [Quick Start](/docs/setup/) — Start with a fresh Linux host, configure Pigsty, and complete your first deployment. [Install](/docs/setup/install/) · [Configure](/docs/setup/config/) · [Run Playbooks](/docs/setup/playbook/) · [Offline Install](/docs/setup/offline/) · [Web UI](/docs/setup/webui/)
- [Production Deployment](/docs/deploy/) — Plan capacity, prepare resources, harden security, and deliver a multi-node production environment. [Planning](/docs/deploy/planning/) · [Preparation](/docs/deploy/prepare/) · [Install](/docs/deploy/install/) · [Security](/docs/deploy/security/) · [Sandbox](/docs/deploy/sandbox/)
- [Configuration \& Reference](/docs/ref/) — Look up configuration templates, modules, parameters, playbooks, ports, and filesystem conventions. [Config Templates](/docs/conf/) · [Modules](/docs/ref/module/) · [Parameters](/docs/ref/param/) · [Playbooks](/docs/ref/playbook/) · [Ports](/docs/ref/port/) · [File Hierarchy](/docs/ref/fhs/)


## Core Modules


- [PGSQL](/docs/pgsql/) (CORE) — Highly available PostgreSQL clusters, services, backup, monitoring, security, and daily administration.
- [INFRA](/docs/infra/) (CORE) — VictoriaMetrics, VictoriaLogs, Grafana, Nginx, and infrastructure services.
- [NODE](/docs/node/) (CORE) — Host management, software baselines, log collection, VIP, and HAProxy load balancing.
- [ETCD](/docs/etcd/) (CORE) — Reliable distributed configuration storage for PostgreSQL high availability.


## Optional Modules


- [MINIO \/ Silo](/docs/minio/) (STORAGE) — S3-compatible object storage and a PostgreSQL backup repository.
- [REDIS \/ Valkey](/docs/redis/) (CACHE) — Primary-replica, Sentinel, and native cluster modes.
- [JUICE](/docs/juice/) (FILESYSTEM) — JuiceFS backed by PostgreSQL metadata and object storage.
- [KAFKA](/docs/kafka/) (MESSAGING) — Dynamic KRaft, TLS, ACL, and complete observability.
- [MYSQL](/docs/mysql/) (DATABASE) — MySQL 8.4 LTS and InnoDB Cluster.
- [DOCKER](/docs/docker/) (RUNTIME) — A managed Docker service and container runtime.
- [VIBE](/docs/vibe/) (DEVELOPMENT) — Code-Server, Jupyter, and an AI coding sandbox.


## Content Scope

This site does not duplicate the standalone manuals for Pig, Patroni, pg_exporter, pgBackRest, PgBouncer, the software repository, application templates, or pilot projects. When these components must be referenced, the documentation links to the existing site; Pigsty's own integration, configuration, and operational guidance remains in the relevant module manual.

---

Section pages:

- [PIGSTY](/docs/_div_pigsty/)
- [Get Started](/docs/setup/): Deploy Pigsty single-node version on your laptop/cloud server, access DB and Web UI
- [Deployment](/docs/deploy/): Multi-node, high-availability Pigsty deployment for production environments.
- [Concepts](/docs/concept/): Understand Pigsty's core concepts, architecture design, learn how high availability, backup recovery, iac, security works
- [About](/docs/about/): Learn about Pigsty itself in every aspect - features, history, license, privacy policy, community, and news.
- [Reference](/docs/_div_ref/)
- [References](/docs/ref/): Detailed reference information and lists, supported Linux distros, available modules, metrics, extensions, and more.
- [Configuration Templates](/docs/conf/): Batteries-included configuration templates for specific scenarios, with detailed explanations.
- [Operations SOP Index](/docs/sop/): Pigsty and PostgreSQL operations documentation index for new users: find the right page by common task.
- [Modules](/docs/_div_module/)
- [Module: PGSQL](/docs/pgsql/): Declare, deploy, expose, observe, back up, and manage PostgreSQL clusters with Pigsty v4.5.
- [Module: INFRA](/docs/infra/): Optional standalone infrastructure that provides NTP, DNS, observability and other foundational services for PostgreSQL.
- [Module: NODE](/docs/node/): Tune nodes into the desired state and monitor it, manage node, VIP, HAProxy, and exporters.
- [Module: ETCD](/docs/etcd/): Pigsty deploys etcd as DCS for reliable distributed config storage, supporting PostgreSQL HA.
- [Module: MINIO](/docs/minio/): Deploy Silo S3-compatible object storage with Pigsty's MINIO compatibility module and use it as a PostgreSQL backup repository.
- [Module: REDIS](/docs/redis/): Deploy Redis or Valkey through one REDIS module, with standalone replication, native cluster, and Sentinel modes.
- [Module: DOCKER](/docs/docker/): Docker daemon service that enables one-click deployment of containerized stateless software templates and additional functionality.
- [Module: JUICE](/docs/juice/): Use JuiceFS distributed filesystem with PostgreSQL metadata to provide shared POSIX storage.
- [Module: VIBE](/docs/vibe/): Deploy an AI coding sandbox with Pigsty: Code-Server, JupyterLab, Node.js, Claude Code, and Codex CLI.
- [Module: KAFKA](/docs/kafka/): Deploy, secure, and monitor Apache Kafka 4.1+ dynamic KRaft clusters with Pigsty.
- [Module: MYSQL](/docs/mysql/): Deploy native MySQL 8.4 LTS as a standalone instance or a three-node InnoDB Cluster, with TLS, daily backups, and full observability.
