Installation

1. Installation

Option A: Download Binaries

Download the latest pre-compiled version for your operating system:

Linux

x64/Intel/AMD ARM64/Aarch64

macOS

ARM64/Apple Silicon x64/Intel

Windows

x64/Intel/AMD ARM64

More versions available in GitHub Releases.

Option B: Build from Source

git clone https://github.com/heptau/pgarachne.git
cd pgarachne
make build

2. Database Setup

1. Create a database (e.g., my_database).

2. Run the schema script to create the necessary pgarachne structure.

psql -d my_database -f sql/schema.sql

3. Create the pgarachne system user (optional but recommended for production):

-- Connect to your database
CREATE ROLE pgarachne WITH LOGIN PASSWORD 'secure_password';
GRANT ALL PRIVILEGES ON DATABASE my_database TO pgarachne;
-- Ensure it can use the schema
GRANT USAGE ON SCHEMA pgarachne TO pgarachne;
GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA pgarachne TO pgarachne;

4. Configure ~/.pgpass to allow pgarachne to connect without password prompt:

# Format: hostname:port:database:username:password
echo "localhost:5432:*:pgarachne:secure_password" >> ~/.pgpass
chmod 0600 ~/.pgpass
← Comparison with PostgREST Configuration →