feat: add README
This commit is contained in:
@@ -1,5 +1,25 @@
|
||||
# Qdrant
|
||||
|
||||
## 鉴权
|
||||
[English](./README.md) | [中文](./README.zh.md)
|
||||
|
||||
Qdrant 支持 [API 密钥](https://qdrant.tech/documentation/guides/security/#read-only-api-key)和 [JWT 令牌](https://qdrant.tech/documentation/guides/security/#granular-access-control-with-jwt)两种鉴权方式。
|
||||
Qdrant is a vector database for efficient similarity search and AI applications.
|
||||
|
||||
## Authorization
|
||||
|
||||
Qdrant supports [API keys](https://qdrant.tech/documentation/guides/security/#read-only-api-key) and [JWT tokens](https://qdrant.tech/documentation/guides/security/#granular-access-control-with-jwt) for access control.
|
||||
|
||||
## Services
|
||||
|
||||
- `qdrant`: The Qdrant vector database service.
|
||||
|
||||
## Configuration
|
||||
|
||||
- `QDRANT_VERSION`: The version of the Qdrant image, default is `v1.15.4`.
|
||||
- `QDRANT_HTTP_PORT`: The host port for Qdrant HTTP API, default is `6333`.
|
||||
- `QDRANT_GRPC_PORT`: The host port for Qdrant gRPC API, default is `6334`.
|
||||
- `QDRANT_API_KEY`: API key for Qdrant.
|
||||
- `QDRANT_JWT_RBAC`: Enable JWT RBAC, default is `false`.
|
||||
|
||||
## Volumes
|
||||
|
||||
- `qdrant_data`: A volume for storing Qdrant data.
|
||||
|
||||
25
src/qdrant/README.zh.md
Normal file
25
src/qdrant/README.zh.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# Qdrant
|
||||
|
||||
[English](./README.md) | [中文](./README.zh.md)
|
||||
|
||||
Qdrant 是一个用于高效相似性搜索和 AI 应用的向量数据库。
|
||||
|
||||
## 鉴权
|
||||
|
||||
Qdrant 支持 [API 密钥](https://qdrant.tech/documentation/guides/security/#read-only-api-key) 和 [JWT 令牌](https://qdrant.tech/documentation/guides/security/#granular-access-control-with-jwt) 两种鉴权方式。
|
||||
|
||||
## 服务
|
||||
|
||||
- `qdrant`: Qdrant 向量数据库服务。
|
||||
|
||||
## 配置
|
||||
|
||||
- `QDRANT_VERSION`: Qdrant 镜像的版本,默认为 `v1.15.4`。
|
||||
- `QDRANT_HTTP_PORT`: Qdrant HTTP API 的主机端口,默认为 `6333`。
|
||||
- `QDRANT_GRPC_PORT`: Qdrant gRPC API 的主机端口,默认为 `6334`。
|
||||
- `QDRANT_API_KEY`: Qdrant 的 API 密钥。
|
||||
- `QDRANT_JWT_RBAC`: 是否启用 JWT RBAC,默认为 `false`。
|
||||
|
||||
## 卷
|
||||
|
||||
- `qdrant_data`: 用于存储 Qdrant 数据的卷。
|
||||
Reference in New Issue
Block a user