| .. | ||
| app | ||
| demo | ||
| ha | ||
| docker.yml | ||
| fat.yml | ||
| infra.yml | ||
| ivory.yml | ||
| meta.yml | ||
| mongo.yml | ||
| mssql.yml | ||
| mysql.yml | ||
| oriole.yml | ||
| pgsql.yml | ||
| pgtde.yml | ||
| polar.yml | ||
| README.md | ||
| rich.yml | ||
| slim.yml | ||
| vibe.yml | ||
Configuration Template
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).
./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
# use different kernels
./configure -c pgsql # Vanilla PostgreSQL kernel with basic features (13~18)
./configure -c mssql # Babelfish kernel with SQL Server wire-compatibility (15)
./configure -c polar # PolarDB PG kernel for Aurora / RAC flavor postgres (15)
./configure -c ivory # IvorySQL Kernel for Oracle grammar compatibility (18)
./configure -c mysql # OpenHalo Kernel for MySQL Compatibility (14)
./configure -c pgtde # Percona PostgreSQL Server with TDE (18)
./configure -c oriole # OrioleDB Kernel for OLTP Enhancement (17)
./configure -c supabase # PostgreSQL configured for Supabase self-hosting (15~18)
# use multi-node HA templates
./configure -c ha/dual # use the 2-node HA template
./configure -c ha/trio # use the 3-node HA template
./configure -c ha/full # use the 4-node HA template
./configure -c ha/citus # use the 13-node HA citus template
./configure -c ha/simu # use the 20-node HA prod template
# special configuration
./configure -c vibe # 1-node vibe coding devbox
Pigsty will use the meta.yml single node config template if you do not specify a conf.
Main Templates
These are 1-node config template, which can be used to install pigsty on a single node:
- meta.yml : DEFAULT, 1-node PostgreSQL online installation
- rich.yml : feature-rich config with local repo, minio, and more examples
- slim.yml : install postgres directly without monitoring and infra
- fat.yml : extreme feature-rich config with all extensions installed!
- infra.yml : only install the infra components without postgres
- vibe.yml : 1-node vibe coding devbox with pgsql and various tools
Templates for exotic DBMS and kernels:
- pgsql.yml : Vanilla PostgreSQL kernel with basic features (13~18)
- mssql.yml : Babelfish kernel with SQL Server wire-compatibility (15)
- polar.yml : PolarDB PG kernel for Aurora / RAC flavor postgres (15)
- ivory.yml : IvorySQL Kernel for Oracle grammar compatibility (17)
- mysql.yml : OpenHalo Kernel for MySQL Compatibility (14)
- pgtde.yml : Percona PostgreSQL Server with TDE (17)
- oriole.yml : OrioleDB Kernel for OLTP Enhancement (17, deb broken)
- supabase.yml : PostgreSQL configured for Supabase self-hosting (15~17)
You can add more nodes later, or use HA config templates to plan it at the beginning.
HA Templates
You can configure pigsty to run on multiple nodes to form a high availability (HA) cluster.
- ha/dual.yml : 2-node semi-ha deployment
- ha/trio.yml : 3-node standard ha deployment
- ha/full.yml : 4-node standard deployment
- ha/safe.yml : 4-node security enhanced setup with delayed replica
- ha/citus.yml : 13-node distributive citus cluster
- ha/simu.yml : 20-node Production simulation
App Templates
You can run docker software/app with the following templates:
- 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/electirc.yml : launch the electric sync engine app
Demo Templates
In addition to the main templates, Pigsty provides a set of demo templates for different scenarios.
- demo/el.yml : config file with all default parameters for EL 8/9 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
Building Templates
These config templates are used for development and testing purposes.
- build/oss.yml : building config for EL 9, 10 ,Debian 12/13, and Ubuntu 22.04/24.04 OSS.