Conf Templates
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/:
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:
| Template | Description |
|---|---|
meta.yml | Default template, single-node PostgreSQL online installation |
rich.yml | Feature-rich template with local repo, Silo, and more examples |
slim.yml | Minimal template, PostgreSQL only without monitoring and infrastructure |
Database Kernel Templates
Templates for various database management systems and kernels:
| Template | Description |
|---|---|
fork/pgsql.yml | Native PostgreSQL with core functionality (14–18) |
pg19.yml | Dedicated PostgreSQL 19 Beta evaluation template |
fork/mssql.yml | Babelfish, SQL Server protocol compatibility (17/18) |
fork/polar.yml | PolarDB PG, Aurora/RAC-style architecture (17) |
fork/ivory.yml | IvorySQL, Oracle syntax compatibility (18) |
fork/halo.yml | OpenHalo, MySQL protocol compatibility (14) |
fork/pgtde.yml | Percona PostgreSQL Server with transparent encryption (18) |
fork/oriole.yml | OrioleDB, enhanced OLTP (16–18) |
fork/agens.yml | AgensGraph graph database (18) |
fork/pgedge.yml | pgEdge distributed database (15–18, default 18) |
fork/mongo.yml | FerretDB / MongoDB compatibility example |
supabase.yml | Self-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:
| Template | Description |
|---|---|
ha/dual.yml | Two-node semi-HA deployment |
ha/trio.yml | Three-node standard HA |
ha/full.yml | Four-node standard deployment |
ha/safe.yml | Three-node security-focused deployment with an offline query replica |
ha/octo.yml | Eight-node compact HA simulation |
ha/simu.yml | Twenty-node production simulation |
ha/citus.yml | Citus distributed HA PostgreSQL (14~18) |
Application Templates
Use these templates to run applications with Docker:
| Template | Description |
|---|---|
supabase.yml | Single-node Supabase |
app/supa.yml | Minimal Supabase application stack |
app/odoo.yml | Odoo ERP |
app/dify.yml | Dify AI workflows |
app/electric.yml | Electric synchronization engine |
app/insforge.yml | Insforge backend platform |
app/hindsight.yml | Hindsight application |
app/mattermost.yml | Mattermost collaboration |
app/teable.yml | Teable spreadsheet database |
app/maybe.yml | Maybe finance application |
app/registry.yml | Docker Registry |
app/immich.yml | Immich photo management |
app/jumpserver.yml | JumpServer bastion host |
app/discourse.yml | Discourse community forum |
app/silo.yml | Standalone Silo object storage |
Demo Templates
Pigsty also provides these demonstration templates:
| Template | Description |
|---|---|
demo/bare.yml | Minimal single-node starting configuration |
demo/el.yml | Full-parameter configuration for EL9/10 |
demo/debian.yml | Full-parameter configuration for Debian/Ubuntu |
demo/remote.yml | Monitor remote PostgreSQL or RDS |
demo/redis.yml | Redis cluster example |
demo/minio.yml | Four-node Silo cluster with multiple drives |
demo/kafka.yml | Kafka dynamic KRaft: single-node development and three-node secured clusters |
demo/mysql.yml | Native MySQL 8.4 single/three-node pilot, distinct from OpenHalo fork/halo.yml |
demo/kernel.yml | Ten-node kernel matrix |
demo/saas.yml | Feature-rich single node with all extensions |
demo/wool.yml | Low-cost Alibaba Cloud ECS example |
demo/demo.yml | Pigsty public demo configuration |
fat.yml | Full-featured single node with a local repository |
infra.yml | Infrastructure only |
vibe.yml | Vibe Coding / AI application development |
docker.yml | Docker application host |
Build Templates
These templates support package builds and cross-distribution testing:
| Template | Description |
|---|---|
build/oss.yml | Open source build config for EL 9/10, Debian 12/13, Ubuntu 22.04/24.04/26.04 |
build/dev.yml | Seven-node local cross-distribution development, test, and build environment |
Was this page helpful?
Thanks—your feedback helps us improve this page.
What got in the way? (optional)