{"id":24782612,"url":"https://github.com/oaklight/vectorsearch","last_synced_at":"2025-03-24T05:29:30.746Z","repository":{"id":268072567,"uuid":"903212307","full_name":"Oaklight/vectorsearch","owner":"Oaklight","description":"Dockerized vector database based on pgvector, pgvectorscale and pg_search","archived":false,"fork":false,"pushed_at":"2025-03-18T18:58:54.000Z","size":15,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-18T19:43:40.994Z","etag":null,"topics":["bm25","pgsearch","pgvector","postgres","semantic-search","vector-database","vector-search"],"latest_commit_sha":null,"homepage":"https://oaklight.github.io/vectorsearch/","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Oaklight.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-14T02:27:04.000Z","updated_at":"2025-03-18T18:58:58.000Z","dependencies_parsed_at":"2025-03-19T11:15:33.434Z","dependency_job_id":null,"html_url":"https://github.com/Oaklight/vectorsearch","commit_stats":null,"previous_names":["oaklight/vectorsearch"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Oaklight%2Fvectorsearch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Oaklight%2Fvectorsearch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Oaklight%2Fvectorsearch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Oaklight%2Fvectorsearch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Oaklight","download_url":"https://codeload.github.com/Oaklight/vectorsearch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245215768,"owners_count":20579040,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bm25","pgsearch","pgvector","postgres","semantic-search","vector-database","vector-search"],"created_at":"2025-01-29T11:18:18.635Z","updated_at":"2025-03-24T05:29:30.729Z","avatar_url":"https://github.com/Oaklight.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vectorsearch Docker Image\n\n## About\n\nInitially, I targeted the `paradedb/paradedb:0.12.0-pg17` image for my task, but it became clear that we only required its `pg_search` and `pgvector` extensions, with the rest being unnecessary for our use case.\n\nAdditionally, an older release of paradedb included `pgvectorscale` from Timescale for its advanced algorithms. However, this was removed in the latest release. I decided to explore using it, which brings us to the current setup.\n\n## Build\n\nI started with the Postgres 17 base image featuring `pgvector` (by time of writing, the latest version is `pgvector/pgvector:0.8.0-pg17` ).\nSubsequently, I added `pg_search` and `pgvectorscale` as dependencies.\n\nThe `bootstrap.sh` script includes SQL commands to create these extensions for every potential database, ensuring a comprehensive setup.\n\n## Usage\n\n1. I have published a docker image for vectorsearch at [dockerhub](https://hub.docker.com/r/oaklight/vectorsearch)\n\n2. To build from the Dockerfile: `make build`. For more details regarding the build process, please refer to the [makefile details](./README_makefile.md).\n\nTo run the container:\n\n```bash\ndocker run --name vectorsearch -p \u003c5432\u003e:5432 -v \u003c$pwd/pgdata\u003e:/var/lib/postgresql/data/ -e POSTGRES_USER=myuser -e POSTGRES_PASSWORD=mypassword -e POSTGRES_DB=mydatabase oaklight/vectorsearch\n```\n\nor use `docker compose` :\n\n```bash\ndocker compose up -d\n```\n\n## Docker Compose Sample Configuration\n\nFor easier management of the container, a sample `docker-compose.yaml` is provided as `compose.yaml.sample` . You can use this file as a starting point for configuring and running the service with Docker Compose.\n\nHere is the content of `compose.yaml.sample` :\n\n```yaml\nservices:\n  paradedb:\n    image: oaklight/vectorsearch:latest-pg17\n    container_name: vectorsearch\n    environment:\n      POSTGRES_USER: myuser\n      POSTGRES_PASSWORD: mypassword\n      POSTGRES_DB: mydatabase\n    ports:\n      - 5432:5432\n    volumes:\n      - $pwd/pgdata:/var/lib/postgresql/data/\n```\n\n### How to Use the Sample Configuration\n\n1. Copy `compose.yaml.sample` to `compose.yaml`:\n\n```bash\n   cp compose.yaml.sample compose.yaml\n```\n\n2. Modify `compose.yaml` as needed to match your environment and configuration preferences.\n\n3. Run the following command to start the service using Docker Compose:\n\n```bash\n   docker compose up -d\n```\n\nThis will start the `vectorsearch` container with the configurations specified in `compose.yaml` .\n\n## Note\n\nThe image is based on the official postgres image, so you can use the same commands to interact with the database.\n\nFor a detailed history of changes, see the [CHANGELOG](CHANGELOG.md).\n\nFor example, you could use `psql` to connect to the database:\n\n```bash\npsql -h \u003cyour_container_name\u003e -U \u003cusername\u003e -d \u003cdatabase\u003e\n```\n\nYou can also use `pgAdmin` to connect to the database.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foaklight%2Fvectorsearch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foaklight%2Fvectorsearch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foaklight%2Fvectorsearch/lists"}