Installation¶

This guide will walk you through installing pgraft on your system.

Prerequisites¶

Before installing pgraft, ensure you have the following:

• PostgreSQL: Version 17.6 or higher
• Go: Version 1.21 or higher
• GCC: C compiler
• PostgreSQL development headers

System-Specific Prerequisites¶

sudo apt-get update
sudo apt-get install postgresql-17 postgresql-server-dev-17 golang-go build-essential

sudo yum install postgresql17 postgresql17-devel golang gcc make

brew install postgresql@17 go

Build from Source¶

1. Clone the Repository¶

git clone https://github.com/pgelephant/pgraft.git
cd pgraft

2. Build the Extension¶

make clean
make

make 2>&1 | grep -i error
make 2>&1 | grep -i warning

3. Install the Extension¶

# Manual installation
cp pgraft.dylib /usr/local/pgsql.17/lib/
cp src/pgraft_go.dylib /usr/local/pgsql.17/lib/
cp pgraft.control /usr/local/pgsql.17/share/extension/
cp pgraft--1.0.sql /usr/local/pgsql.17/share/extension/

Verify Installation¶

After installation, verify that pgraft is properly installed:

# Check that the extension files exist
ls -l $(pg_config --libdir)/pgraft*.dylib
ls -l $(pg_config --sharedir)/extension/pgraft*

Next Steps¶

Now that pgraft is installed, you can:

• Set up your first cluster
• Learn about configuration options
• Follow the complete tutorial

Troubleshooting¶

PostgreSQL Development Headers Not Found¶

If you get errors about missing PostgreSQL headers during build:

# Ubuntu/Debian
sudo apt-get install postgresql-server-dev-17

# CentOS/RHEL
sudo yum install postgresql17-devel

Go Not Found¶

Ensure Go is installed and in your PATH:

go version  # Should show Go 1.21 or higher

Permission Denied¶

If you get permission errors during installation:

# Use sudo for copying to system directories
sudo cp pgraft.dylib /usr/local/pgsql.17/lib/