配置模板

使用预制的配置模板,快速生成适配当前环境的配置文件

在 Pigsty 中,部署的蓝图细节由 配置清单 所定义,也就是 pigsty.yml 配置文件,您可以通过声明式配置进行定制。

然而,直接编写配置文件可能会让新用户望而生畏。为此,我们提供了一些开箱即用的配置模板,涵盖了常见的使用场景。

每一个模板都是一个预定义的 pigsty.yml 配置文件,包含了适用于特定场景的合理默认值。

您可以根据自己的需要,选择一个模板作为定制起点,然后根据需要进行修改,以满足您的具体需求。


使用模板

Pigsty 提供了 configure 脚本作为可选的配置向导,它将根据您的环境和输入,生成具有良好默认值的 配置清单

使用 ./configure -c <conf> 指定配置模板,其中 <conf> 是相对于 conf 目录的路径(可省略 .yml 后缀)。

./configure                     # 默认使用 meta.yml 配置模板
./configure -c meta             # 显式指定使用 meta.yml 单节点模板
./configure -c rich             # 使用包含全部扩展与 MinIO 的富功能模板
./configure -c slim             # 使用最小化的单节点模板

# 使用不同的数据库内核
./configure -c pgsql            # 原生 PostgreSQL 内核,基础功能 (14~18)
./configure -c ha/citus         # Citus 分布式高可用 PostgreSQL (14~18)
./configure -c mssql            # Babelfish 内核,兼容 SQL Server 协议 (17)
./configure -c polar            # PolarDB PG 内核,Aurora/RAC 风格 (17)
./configure -c ivory            # IvorySQL 内核,兼容 Oracle 语法 (18)
./configure -c mysql            # OpenHalo 内核,兼容 MySQL (14)
./configure -c pgtde            # Percona PostgreSQL Server 透明加密 (18)
./configure -c oriole           # OrioleDB 内核,OLTP 增强 (17)
./configure -c agens            # AgensGraph 图数据库内核 (16)
./configure -c pgedge           # pgEdge 分布式数据库内核 (18)
./configure -c supabase         # Supabase 自托管配置 (15~18)

# 使用多节点高可用模板
./configure -c ha/dual          # 使用 2 节点高可用模板
./configure -c ha/trio          # 使用 3 节点高可用模板
./configure -c ha/full          # 使用 4 节点高可用模板

如果不指定模板,Pigsty 默认使用 meta.yml 单节点配置模板。


模板列表

主要模板

以下是单节点配置模板,可用于在单台服务器上安装 Pigsty:

模板说明
meta.yml默认模板,单节点 PostgreSQL 在线安装
rich.yml富功能模板,包含本地软件源、MinIO 及更多示例
slim.yml精简模板,仅安装 PostgreSQL,不含监控与基础设施

数据库内核模板

适用于各类数据库管理系统与内核的模板:

模板说明
pgsql.yml原生 PostgreSQL 内核,基础功能 (14~18)
mssql.ymlBabelfish 内核,兼容 SQL Server 协议 (17)
polar.ymlPolarDB PG 内核,Aurora/RAC 风格 (17)
ivory.ymlIvorySQL 内核,兼容 Oracle 语法 (18)
mysql.ymlOpenHalo 内核,兼容 MySQL (14)
pgtde.ymlPercona PostgreSQL Server 透明加密 (18)
oriole.ymlOrioleDB 内核,OLTP 增强 (17,Debian 包暂缺)
agens.ymlAgensGraph 图数据库内核 (16)
pgedge.ymlpgEdge 分布式数据库内核 (18)
supabase.ymlSupabase 自托管配置 (15~18)

您可以后续添加更多节点,或使用 高可用模板 在一开始就规划好集群。


高可用模板

您可以配置 Pigsty 在多节点上运行,组成高可用(HA)集群:

模板说明
dual.yml2 节点半高可用部署
trio.yml3 节点标准高可用部署
full.yml4 节点标准部署
safe.yml4 节点安全增强部署,含延迟从库
simu.yml20 节点生产环境模拟
ha/citus.ymlCitus 分布式高可用 PostgreSQL (14~18)

应用模板

您可以使用以下模板运行 Docker 应用/软件:

模板说明
supabase.yml启动单节点 Supabase
odoo.yml启动 Odoo ERP 系统
dify.yml启动 Dify AI 工作流系统
electric.yml启动 Electric 同步引擎
insforge.yml启动 Insforge 后端平台
hindsight.yml启动 Hindsight 应用
mattermost.yml启动 Mattermost 协作平台
teable.yml启动 Teable 表格数据库
maybe.yml启动 Maybe 财务应用
registry.yml启动 Docker Registry

演示模板

除主要模板外,Pigsty 还提供了一组面向不同场景的演示模板:

模板说明
el.ymlEL 8/9 系统的全参数配置文件
debian.ymlDebian/Ubuntu 系统的全参数配置文件
remote.yml监控远程 PostgreSQL 集群或 RDS 的示例配置
redis.ymlRedis 集群示例配置
minio.yml3 节点 MinIO 集群示例配置
demo.ymlPigsty 公开演示站 的配置文件
fat.yml含本地软件源与完整功能的单节点配置文件
infra.yml仅部署基础设施模块
vibe.ymlVibe Coding / AI 应用开发模板
mongo.ymlFerretDB / MongoDB 兼容示例
docker.ymlDocker 应用宿主模板

构建模板

以下配置模板用于开发和测试目的:

模板说明
build/oss.ymlEL 9/10、Debian 12/13、Ubuntu 22.04/24.04/26.04 开源构建配置
build/dev.yml开发测试构建配置