Version v3.7.0 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.

Template

Configuration templates for Pigsty

This directory conf contains pigsty config templates, which will be used during configure procedure.

Config templates can be designated using ./configure -c <conf>, where the conf is a relative path to conf directory (with or without .yml suffix). e.g. the ~/pigsty/conf/rich.yml can be specified as rich

./configure                     # use the meta.yml config template by default
./configure -c meta             # use the meta.yml 1-node template explicitly
./configure -c rich             # use the 1-node template with all extensions & minio
./configure -c slim             # use the minimal 1-node template
./configure -c supabase         # use the Supabase 1-node template
./configure -c app/dify         # use the dify app template

If no -c|--conf is given, the single-node meta config template will be automatically selected by default.

Basic Templates

Here are one-node templates, which provide different features and configurations.

Template	Node	Description
`meta.yml`	1	Default 1-node config, pgsql, infra, node, etcd, minimal ext
`rich.yml`	1	meta + minio + all extensions
`slim.yml`	1	meta - infra - node monitor, minimal install
`fat.yml`	1	PG 13-18 packages, and install all extensions for current ver

Exotic Kernel

Using exotic Postgres kernel forks:

Template	Node	Description
`mssql.yml`	1	WiltonDB & Babelfish with MSSQL wire-compatibility
`polar.yml`	1	PolarDB for PostgreSQL with Aurora RAC Flavor
`ivory.yml`	1	IvorySQL cluster with Oracle compatibility
`mysql.yml`	1	Halo cluster with MySQL wire-compatibility
`mongo.yml`	1	FerretDB & DocumentDB with Mongo wire-compatibility
`oriole.yml`	1	OrioleDB cluster with OLTP enhancement

Multi Node

Template	Node	Description
`dual.yml`	2	Semi-HA deployment
`trio.yml`	3	Standard HA deployment
`full.yml`	4	Sandbox deployment
`safe.yml`	4	Security enhancement with delayed replica
`simu.yml`	36	Production simulation

Applications

Template	Description
`app/supa.yml`	Launch 1-node supabase
`app/odoo.yml`	Launch the odoo ERP system
`app/dify.yml`	Launch the dify AI workflow system
`app/electric.yml`	Launch the electric sync engine app

Demo Templates

Template	Description
`demo/el.yml`	Config file with all default parameters for EL 8/9/10 systems
`demo/debian.yml`	Config file with all default parameters for debian/ubuntu systems
`demo/remote.yml`	Example config for monitoring a remote pgsql cluster or RDS PG
`demo/redis.yml`	Example config for redis clusters
`demo/minio.yml`	Example config for a 3-node minio clusters
`demo/demo.yml`	Config file for the pigsty public demo
`citus.yml`	Citus cluster example: 1 coordinator and 3 data nodes (4-node)

Build Templates

Template	Description
`build/oss.yml`	Building config for EL 8, 9, Debian 12, and Ubuntu 22.04/24.04 OSS
`build/pro.yml`	Building config for EL 7-10, Ubuntu, Debian pro version