Get Started

Use this guide to install Pigsty on one Linux node. Start with Quick Start. A node with 1 CPU core and 2 GB of memory is sufficient.

You can use a Linux MiniPC, a cloud server, Windows WSL, or a virtual machine on your laptop. Pigsty supplies Vagrant templates for local virtual machines. It also supplies OpenTofu templates for cloud servers.

The single-node installation includes these features:

• 600 PostgreSQL extensions.
• Grafana and Victoria monitoring services.
• Infrastructure as code for deployment.
• Local point-in-time recovery (PITR).

External object storage can keep PostgreSQL backups outside the node. These backups improve data durability for demonstrations, personal websites, and small services. A single node cannot provide high availability. Automatic failover requires at least three nodes.

Choose the installation method that meets your requirements:

Quick Start

1. Prepare a node with a supported Linux operating system.
2. Use an administration account with passwordless SSH and sudo access.
3. Run the commands below.

curl -fsSL https://repo.pigsty.io/get | bash  # Install Pigsty and dependencies
cd ~/pigsty; ./configure -g                   # Generate config (with 1-node template, -g generates random passwords)
./deploy.yml                                  # Execute deployment playbook

The installation script downloads Pigsty and installs its dependencies. The configuration script creates pigsty.yml and generates random passwords. The deployment playbook installs the modules in the configuration file.

You can also select a configuration template. The template supplies the initial configuration.

After deployment, do these tasks:

• Open the Web UI.
• Connect to PostgreSQL.
• Apply the security recommendations.
• Change the configuration to add more clusters.
• Run playbooks to apply the configuration.