Skip to content

installation.md

Latest commit

 

History

History
80 lines (56 loc) · 1.72 KB

installation.md

File metadata and controls

80 lines (56 loc) · 1.72 KB
Raw

Installation

pgEdge Document Loader loads documents into a Postgres database in Markdown format. You can install Document Loader with a pgEdge Enterprise Postgres package or build pgEdge Document Loader from source code stored in the pgEdge repository.

pgEdge Document Loader is open-source, and licensed with the PostgreSQL license.

Prerequisites

Before building Document Loader, install:

  • Go 1.23 or later.
  • PostgreSQL version 12 or later.
  • Make (optional, for using Makefile targets to build from source).

Building from Source

To build Document Loader from source, clone the pgedge-docloader repository:

git clone https://github.com/pgedge/pgedge-docloader.git
cd pgedge-docloader

Then, use make to ensure that your Go installation is configured properly:

make deps

Alternatively, you can use the following command to ensure that Go is installed:

go mod download

Then, use make to build the Document Loader binary:

make build

The make build command creates the pgedge-docloader binary in the /bin directory under your current directory. If you'd prefer to install the binary in /usr/local/bin, use the command:

make install

To install the binary in a custom location, specify the installation path when you run the make command:

PREFIX=/opt/local make install

Verify the Installation

After building Document Loader, you can verify the installation worked by retrieving information about the tool:

pgedge-docloader version

Check supported formats:

pgedge-docloader formats
pgedge-docloader help