Skip to content

Conf Templates

Use pre-made configuration templates to quickly generate configuration files adapted to your environment

The inventory defines the deployment through declarative configuration. Customize its pigsty.yml file for your requirements.

New users can start with ready-to-use templates for common deployment scenarios.

Each template is a predefined pigsty.yml file with defaults for a specific scenario.

Select a template, then change it to meet your requirements.


Using Templates

The optional configure wizard generates an inventory from your environment and input, with suitable defaults.

Use ./configure -c <conf>, where <conf> is a path relative to conf/ without .yml, or a bare name searched in order: conf/ → ha/ → fork/ → app/ → demo/ → build/:

./configure                     # Default to meta.yml configuration template
./configure -c meta             # Explicitly specify meta.yml single-node template
./configure -c rich             # Use feature-rich template with all extensions and Silo
./configure -c slim             # Use minimal single-node template

# Select different database kernels and compatibility stacks
./configure -c pgsql            # Native PostgreSQL kernel, basic features (14~18)
./configure -c pg19             # PostgreSQL 19 Beta trial template
./configure -c mssql            # Babelfish kernel, SQL Server protocol compatible (17/18)
./configure -c polar            # PolarDB PG kernel, Aurora/RAC style (17)
./configure -c ivory            # IvorySQL kernel, Oracle syntax compatible (18)
./configure -c halo             # OpenHalo, MySQL protocol compatibility (14); equivalent to fork/halo
./configure -c pgtde            # Percona PostgreSQL Server transparent encryption (18)
./configure -c oriole           # OrioleDB kernel, OLTP enhanced (16~18)
./configure -c agens            # AgensGraph graph database (18); equivalent to fork/agens
./configure -c pgedge           # pgEdge distributed database kernel (15~18, default 18)
./configure -c mongo            # FerretDB / MongoDB protocol stack; equivalent to fork/mongo
./configure -c mysql            # native MySQL 8.4 deployment; equivalent to demo/mysql
./configure -c ha/citus         # Citus distributed HA PostgreSQL (14~18)
./configure -c supabase         # Supabase self-hosted configuration (15~18)

# Use multi-node HA templates
./configure -c ha/dual          # Use 2-node HA template
./configure -c ha/trio          # Use 3-node HA template
./configure -c ha/full          # Use 4-node HA template

If no template is specified, Pigsty defaults to the meta.yml single-node configuration template.


Template List

Main Templates

Use these templates to install Pigsty on one server:

TemplateDescription
meta.ymlDefault template, single-node PostgreSQL online installation
rich.ymlFeature-rich template with local repo, Silo, and more examples
slim.ymlMinimal template, PostgreSQL only without monitoring and infrastructure

Database Kernel Templates

Templates for various database management systems and kernels:

TemplateDescription
fork/pgsql.ymlNative PostgreSQL with core functionality (14–18)
pg19.ymlDedicated PostgreSQL 19 Beta evaluation template
fork/mssql.ymlBabelfish, SQL Server protocol compatibility (17/18)
fork/polar.ymlPolarDB PG, Aurora/RAC-style architecture (17)
fork/ivory.ymlIvorySQL, Oracle syntax compatibility (18)
fork/halo.ymlOpenHalo, MySQL protocol compatibility (14)
fork/pgtde.ymlPercona PostgreSQL Server with transparent encryption (18)
fork/oriole.ymlOrioleDB, enhanced OLTP (16–18)
fork/agens.ymlAgensGraph graph database (18)
fork/pgedge.ymlpgEdge distributed database (15–18, default 18)
fork/mongo.ymlFerretDB / MongoDB compatibility example
supabase.ymlSelf-hosted Supabase (15–18)

You can add more nodes later or use HA templates to plan your cluster from the start.


HA Templates

Use these templates for a deployment with multiple nodes and high availability:

TemplateDescription
ha/dual.ymlTwo-node semi-HA deployment
ha/trio.ymlThree-node standard HA
ha/full.ymlFour-node standard deployment
ha/safe.ymlThree-node security-focused deployment with an offline query replica
ha/octo.ymlEight-node compact HA simulation
ha/simu.ymlTwenty-node production simulation
ha/citus.ymlCitus distributed HA PostgreSQL (14~18)

Application Templates

Use these templates to run applications with Docker:

TemplateDescription
supabase.ymlSingle-node Supabase
app/supa.ymlMinimal Supabase application stack
app/odoo.ymlOdoo ERP
app/dify.ymlDify AI workflows
app/electric.ymlElectric synchronization engine
app/insforge.ymlInsforge backend platform
app/hindsight.ymlHindsight application
app/mattermost.ymlMattermost collaboration
app/teable.ymlTeable spreadsheet database
app/maybe.ymlMaybe finance application
app/registry.ymlDocker Registry
app/immich.ymlImmich photo management
app/jumpserver.ymlJumpServer bastion host
app/discourse.ymlDiscourse community forum
app/silo.ymlStandalone Silo object storage

Demo Templates

Pigsty also provides these demonstration templates:

TemplateDescription
demo/bare.ymlMinimal single-node starting configuration
demo/el.ymlFull-parameter configuration for EL9/10
demo/debian.ymlFull-parameter configuration for Debian/Ubuntu
demo/remote.ymlMonitor remote PostgreSQL or RDS
demo/redis.ymlRedis cluster example
demo/minio.ymlFour-node Silo cluster with multiple drives
demo/kafka.ymlKafka dynamic KRaft: single-node development and three-node secured clusters
demo/mysql.ymlNative MySQL 8.4 single/three-node pilot, distinct from OpenHalo fork/halo.yml
demo/kernel.ymlTen-node kernel matrix
demo/saas.ymlFeature-rich single node with all extensions
demo/wool.ymlLow-cost Alibaba Cloud ECS example
demo/demo.ymlPigsty public demo configuration
fat.ymlFull-featured single node with a local repository
infra.ymlInfrastructure only
vibe.ymlVibe Coding / AI application development
docker.ymlDocker application host

Build Templates

These templates support package builds and cross-distribution testing:

TemplateDescription
build/oss.ymlOpen source build config for EL 9/10, Debian 12/13, Ubuntu 22.04/24.04/26.04
build/dev.ymlSeven-node local cross-distribution development, test, and build environment