Home Original page

GitHub - pgvector/setup-pgvector: pgvector instructions for GitHub Actions

pgvector instructions for GitHub Actions

Build Status Build Status Build Status Build Status

Getting Started

First, choose your installation method:

Step

To add to the preinstalled Postgres installation on runner images, add a step to your workflow.

Ubuntu

      - name: Install pgvector
        run: |
          sudo /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh -y
          sudo apt-get install postgresql-16-pgvector

Note: Replace 16 with 14 for ubuntu-22.04

See a full example

Mac

      - name: Install pgvector
        run: brew install pgvector

See a full example

Windows

      - name: Install pgvector
        run: |
          call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Auxiliary\Build\vcvars64.bat"
          cd %TEMP%
          git clone --branch v0.8.2 https://github.com/pgvector/pgvector.git
          cd pgvector
          nmake /NOLOGO /F Makefile.win
          nmake /NOLOGO /F Makefile.win install
        shell: cmd

See a full example

Service

For a service container, use the pgvector/pgvector:pg18-trixie image instead of postgres.

    services:
      postgres:
        image: pgvector/pgvector:pg18-trixie
        env:
          POSTGRES_HOST_AUTH_METHOD: trust
        options: >-
          --health-cmd pg_isready
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5
        ports:
          - 5432:5432

See a full example

Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help: