Skip to content

docs: add Valkey vector store environment variables #750

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
daric93 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add Valkey vector store environment variables #750

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9efdeac
docs: add Valkey vector store environment variables
daric93 Apr 16, 2026
d7ccd7f
fix: update valkey-bundle image tag to latest
daric93 May 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion en/self-host/configuration/environments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -509,7 +509,7 @@ Default: `weaviate`

Selects the vector database backend. If a dataset already has an index, the dataset's stored type takes precedence over this setting. When switching providers in Docker Compose, `COMPOSE_PROFILES` automatically starts the matching container based on this value.

Supported values: `weaviate`, `oceanbase`, `seekdb`, `qdrant`, `milvus`, `myscale`, `relyt`, `pgvector`, `pgvecto-rs`, `chroma`, `opensearch`, `oracle`, `tencent`, `elasticsearch`, `elasticsearch-ja`, `analyticdb`, `couchbase`, `vikingdb`, `opengauss`, `tablestore`, `vastbase`, `tidb`, `tidb_on_qdrant`, `baidu`, `lindorm`, `huawei_cloud`, `upstash`, `matrixone`, `clickzetta`, `alibabacloud_mysql`, `iris`, `hologres`.
Supported values: `weaviate`, `oceanbase`, `seekdb`, `qdrant`, `milvus`, `myscale`, `relyt`, `pgvector`, `pgvecto-rs`, `chroma`, `opensearch`, `oracle`, `tencent`, `elasticsearch`, `elasticsearch-ja`, `analyticdb`, `couchbase`, `vikingdb`, `opengauss`, `tablestore`, `vastbase`, `tidb`, `tidb_on_qdrant`, `baidu`, `lindorm`, `huawei_cloud`, `upstash`, `matrixone`, `clickzetta`, `alibabacloud_mysql`, `iris`, `hologres`, `valkey`.

| Variable | Default | Description |
|---|---|---|
Expand Down Expand Up @@ -559,6 +559,21 @@ seekdb is the lite version of OceanBase and shares the same connection configura

</Accordion>

<Accordion title="Valkey">

Valkey is an open-source key-value store with a vector search module (`valkey-search`) for similarity search. Requires the `valkey-search` module >= 1.2.0, included in the `valkey/valkey-bundle:latest` Docker image.

| Variable | Default | Description |
|---|---|---|
| `VALKEY_HOST` | `localhost` | Hostname or IP address of the Valkey server. |
| `VALKEY_PORT` | `6379` | Port number. |
| `VALKEY_PASSWORD` | (empty) | Authentication password. |
| `VALKEY_DB` | `0` | Database number (0–15). |
| `VALKEY_USE_SSL` | `false` | Enable SSL/TLS for the connection. |
| `VALKEY_DISTANCE_METRIC` | `COSINE` | Distance metric for vector similarity search. Options: `COSINE`, `L2`, `IP`. |

</Accordion>

<Accordion title="Milvus">

| Variable | Default | Description |
Expand Down