Pgvector

Deploy Pgvector, an open source PostgreSQL extension storing vector embeddings and performing similarity searches. It's commonly used for AI applications, semantic search, and retrieval-augmented generation (RAG) workloads.

1. Deploy Pgvector

Estimated deployment time: 5–10 minutes

Follow the deployment instructions from the Get started section to configure the app, deploy it, and verify software installation.

For information on the app-specific configurations, see the Configuration options section.

Base distribution and plan

Supported distribution: Ubuntu 24.04 LTS
Recommended plan: A dedicated 16GB instance or higher for baseline development and testing with support for GPU instances.

Configuration options

Configure the required options to deploy your instance. For additional customization, add advanced options.

The table maps the Cloud Manager UI fields to their corresponding API/CLI keys (stackscript_data) required for automated deployments.

StackScript ID: 1972184

UI field	API/CLI key	Description
Required options
Limited sudo user	`user_name`	Your preferred username for the limited sudo user, entered without any capital letters, spaces, or special characters. When adding a limited sudo user, the user is created with a strong generated password for your new Linode instance, and the account is assigned to the `sudo` group, which provides elevated permissions when running commands with the `sudo` prefix. Note: For easier and more secure access with the sudo user, add an account SSH key for the Cloud Manager user during deployment and select that user as an `authorized_user`. Their SSH pubkey will be assigned to both the root and limited sudo users.
Postgres Database Name	`postgresql_app_db`	The name for your Postgres database.
Postgres Database Admin Username	`postgresql_admin_user`	The username linked to your Postgres database, entered without any special characters. It can't include `postgres` in the name.
Advanced options
Disable root access over SSH	`disable_root`	Applies to a limited sudo user. To block the root user from logging in over SSH, select Yes. Defaults to No. Note: When you disable the root user from logging in over SSH and don't provide a valid Account SSH Key assigned to the `authorized_user`, you can still switch to the root user. To do that, log in as root via the Lish console and run `cat /home/$USERNAME/.credentials` to view the generated password for the limited sudo user.
Linode API token	`token_password`	Applies to a custom domain. The Linode API token if you want to use Linode's DNS Manager to manage DNS records for your custom domain. Follow Manage personal access tokens to get your token on your account with `Read/Write` access to `Domains`. If you provide the token along with the subdomain and domain, the installation attempts to create DNS records via the Linode API. If you don't provide the token, you need to manually configure your DNS records through your DNS provider and point them to the IP address of the new instance.
Subdomain	`subdomain`	Applies to a custom domain. The subdomain you want to use, like `blog` for `blog.example.com`. Use it only if you specify a Domain.
Domain	`domain`	Applies to a custom domain. The domain name you want to use, like `example.com`. Use it only if you specify a Linode API token.
Email address for new DNS zone	`soa_email_address`	Your email address for a new DNS zone.
Optional data exporter Add-ons	`add_ons`	An option to include add-ons for your deployment. Possible values are: none (default) alloy node_exporter mysqld_exporter newrelic

Notes:

After the app deployment completes, the password for your limited sudo user is generated and stored in the .credentials file in the home directory, along with application-specific passwords. Log in to your instance as root through the Lish console or SSH, then run cat /home/$USERNAME/.credentials to view its contents.

You can automatically configure a custom domain (optional) during deployment. To do that:

First, configure your domain to use Linode’s name servers via your registrar. See Configure your domain's authoritative name servers for details.

Once you complete that, specify the Linode API token, subdomain, and domain for the app in Cloud Manager or via API/CLI/Terraform.

Use API, CLI, or Terraform

In addition to deploying the app to a new Linode instance via Cloud Manager, you can also use the Linode API, CLI, or Terraform. When running the operation, you need to provide the StackScript ID, supported Linux distribution, and app-specific fields along with the standard Linode deployment configurations.

Note: Generate a personal access token to authenticate your API, CLI, or Terraform requests.

curl --location 'https://api.linode.com/v4/linode/instances' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer abc123def456hij789klm' \
    --data-raw '{
        "region": "us-east",
        "type": "g6-standard-2",
        "image": "linode/ubuntu24.04",
        "label": "my-pgvector-one-click-app",
        "root_pass": "@C0mpl3x#P@ssw0rd",
        "stackscript_id": 1972184,
        "stackscript_data": {
            "user_name":"jsmith",
            "postgresql_app_db":"my-database",
            "postgresql_admin_user":"jsmith-admin",
        }
    }'

linode-cli linodes create \
    --region us-east \
    --type g6-standard-2 \
    --label my-pgvector-one-click-app \
    --image linode/ubuntu24.04 \
    --root_pass @C0mpl3x#P@ssw0rd \
    --stackscript_id 1972184 \
    --stackscript_data '{"user_name":"jsmith", "postgresql_app_db":"my-database", "postgresql_admin_user":"jsmith-admin"}'

resource "linode_instance" "my-linode" {
    region         = "us-east"
    type           = "g6-standard-2"
    label          = "my-pgvector-one-click-app"
    image          = "linode/ubuntu24.04"
    root_pass      = "@C0mpl3x#P@ssw0rd"
    stackscript_id = 1972184
    stackscript_data = {
        "user_name"             = "jsmith"
        "postgresql_app_db"     = "my-database"
        "postgresql_admin_user" = "jsmith-admin"
    }
}

2. Access Pgvector

Once the app is deployed, connect to your PostgreSQL database.

Run psql -h localhost -U $POSTGRES_USER -d $POSTGRES_DB.
Define vector columns and run similarity queries directly in SQL.

Pgvector works with standard PostgreSQL clients and integrates easily with popular AI frameworks and ORMs.

psycopg: PostgreSQL adapter for Python
SQLAlchemy: Python ORM with pgvector support
pgvector-node: Node.js client helpers
pgvector-go: Go utilities for pgvector

Additional resources

For more information about the installed packages, including indexing strategies, performance tuning, and advanced query patterns, see their official documentation.

📘
Note that we can't vouch for the accuracy or timeliness of externally hosted resources.