diff --git a/en/self-host/configuration/environments.mdx b/en/self-host/configuration/environments.mdx index c2fa159e..d3aa8a0f 100644 --- a/en/self-host/configuration/environments.mdx +++ b/en/self-host/configuration/environments.mdx @@ -127,7 +127,7 @@ The database uses PostgreSQL. Please use the public schema. Available values include： - `postgresql`(default) - - `mysql` + - `mysql` (MySQL-compatible databases like TiDB can also use this value) - `oceanbase` - `seekdb` @@ -261,24 +261,40 @@ Used to store uploaded data set files, team/tenant encryption keys, and other fi ### Vector Database Configuration -- VECTOR_STORE - - Available values include： - +- VECTOR_STORE\ + Available values include: - `weaviate` + - `oceanbase` + - `seekdb` - `qdrant` - `milvus` - - `zilliz` (share the same configuration as `milvus`) - `myscale` - - `pinecone` (not yet open) + - `relyt` + - `pgvector` + - `pgvecto-rs` + - `chroma` + - `opensearch` + - `oracle` + - `tencent` + - `elasticsearch` + - `elasticsearch-ja` - `analyticdb` - `couchbase` - - `oceanbase` - - `seekdb` (share the same configuration as `oceanbase`) - - `tablestore` - - `lindorm` - - `tencent` + - `vikingdb` - `opengauss` + - `tablestore` + - `vastbase` + - `tidb` + - `baidu` + - `lindorm` + - `huawei_cloud` + - `upstash` + - `matrixone` + - `clickzetta` + - `alibabacloud_mysql` + - `iris` + +#### Weaviate Configuration - WEAVIATE_ENDPOINT @@ -298,113 +314,7 @@ Used to store uploaded data set files, team/tenant encryption keys, and other fi Whether to use the gRPC method to interact with Weaviate, performance will greatly increase when enabled, may not be usable locally, default is true. -- QDRANT_URL - - Qdrant endpoint address, such as: `https://your-qdrant-cluster-url.qdrant.tech/` - -- QDRANT_API_KEY - - The api-key credential used to connect to Qdrant. - -- PINECONE_API_KEY - - The api-key credential used to connect to Pinecone. - -- PINECONE_ENVIRONMENT - - The environment where Pinecone is located, such as: `us-east4-gcp` - -- MILVUS_URI - - Milvus uri configuration. e.g. `http://host.docker.internal:19530`. For [Zilliz Cloud](https://docs.zilliz.com/docs/free-trials), adjust the uri and token to the Public Endpoint and API Key. - -- MILVUS_TOKEN - - Milvus token configuration, default is empty. - -- MILVUS_USER - - Milvus user configuration, default is empty. - -- MILVUS_PASSWORD - - Milvus password configuration, default is empty. - -- MYSCALE_HOST - - MyScale host configuration. - -- MYSCALE_PORT - - MyScale port configuration. - -- MYSCALE_USER - - MyScale user configuration, default is `default`. - -- MYSCALE_PASSWORD - - MyScale password configuration, default is empty. - -- MYSCALE_DATABASE - - MyScale database configuration, default is `default`. - -- MYSCALE_FTS_PARAMS - - MyScale text-search params, check [MyScale docs](https://myscale.com/docs/en/text-search/#understanding-fts-index-parameters) for multi-language support, default is empty. - -- ANALYTICDB_KEY_ID - - The access key ID used for Aliyun OpenAPI authentication. Read the [Analyticdb documentation](https://help.aliyun.com/zh/analyticdb/analyticdb-for-postgresql/support/create-an-accesskey-pair) to create your AccessKey. - -- ANALYTICDB_KEY_SECRET - - The access key secret used for Aliyun OpenAPI authentication. - -- ANALYTICDB_INSTANCE_ID - - The unique identifier for your AnalyticDB instance, such as : `gp-xxxxxx`. Read the [Analyticdb documentation](https://help.aliyun.com/zh/analyticdb/analyticdb-for-postgresql/getting-started/create-an-instance-1) to create your instance. - -- ANALYTICDB_REGION_ID - - The region identifier where the AnalyticDB instance is located, such as: `cn-hangzhou`. - -- ANALYTICDB_ACCOUNT - - The account name used to connect to the AnalyticDB instance. Read the [Analyticdb documentation](https://help.aliyun.com/zh/analyticdb/analyticdb-for-postgresql/getting-started/createa-a-privileged-account) to create an account. - -- ANALYTICDB_PASSWORD - - The password for the account used to connect to the AnalyticDB instance. - -- ANALYTICDB_NAMESPACE - - The namespace(schema) within the AnalyticDB instance that you wish to interact with, such as `dify`. If this namespace does not exist, it will be created automatically. - -- ANALYTICDB_NAMESPACE_PASSWORD - - The password for the namespace(schema). If the namespace does not exist, it will be created with this password. - -- COUCHBASE_CONNECTION_STRING - - The connection string for the Couchbase cluster. - -- COUCHBASE_USER - - The username for the database user. - -- COUCHBASE_PASSWORD - - The password for the database user. - -- COUCHBASE_BUCKET_NAME - - The name of the bucket to use. - -- COUCHBASE_SCOPE_NAME - - The name of the scope to use. +#### OceanBase/seekdb Configuration - OCEANBASE_VECTOR_HOST @@ -438,33 +348,161 @@ Used to store uploaded data set files, team/tenant encryption keys, and other fi The memory limit of seekdb vector database, only available for Docker deployment. -- TABLESTORE_ENDPOINT +#### Qdrant Configuration - The endpoint address of the TableStore server (e.g. 'https://instance-name.cn-hangzhou.ots.aliyuncs.com') +- QDRANT_URL -- TABLESTORE_INSTANCE_NAME + Qdrant endpoint address, such as: `https://your-qdrant-cluster-url.qdrant.tech/` - The instance name to access TableStore server (e.g. 'instance-name') +- QDRANT_API_KEY -- TABLESTORE_ACCESS_KEY_ID + The api-key credential used to connect to Qdrant. - The accessKey id for the instance name +#### Milvus Configuration -- TABLESTORE_ACCESS_KEY_SECRET +- MILVUS_URI - The accessKey secret for the instance name + Milvus uri configuration. e.g. `http://host.docker.internal:19530`. For [Zilliz Cloud](https://docs.zilliz.com/docs/free-trials), adjust the uri and token to the Public Endpoint and API Key. -- LINDORM_URL +- MILVUS_TOKEN - The URL of LINDORM search engine，you can get it from [the console](https://lindorm.console.aliyun.com/) + Milvus token configuration, default is empty. -- LINDORM_USERNAME +- MILVUS_USER - The username of lindorm search engine + Milvus user configuration, default is empty. -- LINDORM_PASSWORD +- MILVUS_PASSWORD - The password of lindorm search engine + Milvus password configuration, default is empty. + +#### MyScale Configuration + +- MYSCALE_HOST + + MyScale host configuration. + +- MYSCALE_PORT + + MyScale port configuration. + +- MYSCALE_USER + + MyScale user configuration, default is `default`. + +- MYSCALE_PASSWORD + + MyScale password configuration, default is empty. + +- MYSCALE_DATABASE + + MyScale database configuration, default is `default`. + +- MYSCALE_FTS_PARAMS + + MyScale text-search params, check [MyScale docs](https://myscale.com/docs/en/text-search/#understanding-fts-index-parameters) for multi-language support, default is empty. + +#### Couchbase Configuration + +- COUCHBASE_CONNECTION_STRING + + The connection string for the Couchbase cluster. + +- COUCHBASE_USER + + The username for the database user. + +- COUCHBASE_PASSWORD + + The password for the database user. + +- COUCHBASE_BUCKET_NAME + + The name of the bucket to use. + +- COUCHBASE_SCOPE_NAME + + The name of the scope to use. + +#### AnalyticDB Configuration + +- ANALYTICDB_KEY_ID + + The access key ID used for Aliyun OpenAPI authentication. Read the [Analyticdb documentation](https://help.aliyun.com/zh/analyticdb/analyticdb-for-postgresql/support/create-an-accesskey-pair) to create your AccessKey. + +- ANALYTICDB_KEY_SECRET + + The access key secret used for Aliyun OpenAPI authentication. + +- ANALYTICDB_INSTANCE_ID + + The unique identifier for your AnalyticDB instance, such as : `gp-xxxxxx`. Read the [Analyticdb documentation](https://help.aliyun.com/zh/analyticdb/analyticdb-for-postgresql/getting-started/create-an-instance-1) to create your instance. + +- ANALYTICDB_REGION_ID + + The region identifier where the AnalyticDB instance is located, such as: `cn-hangzhou`. + +- ANALYTICDB_ACCOUNT + + The account name used to connect to the AnalyticDB instance. Read the [Analyticdb documentation](https://help.aliyun.com/zh/analyticdb/analyticdb-for-postgresql/getting-started/createa-a-privileged-account) to create an account. + +- ANALYTICDB_PASSWORD + + The password for the account used to connect to the AnalyticDB instance. + +- ANALYTICDB_NAMESPACE + + The namespace(schema) within the AnalyticDB instance that you wish to interact with, such as `dify`. If this namespace does not exist, it will be created automatically. + +- ANALYTICDB_NAMESPACE_PASSWORD + + The password for the namespace(schema). If the namespace does not exist, it will be created with this password. + +#### TiDB Configuration + +- TIDB_VECTOR_HOST + + The hostname or IP address of the TiDB vector database. Default is `tidb`. + +- TIDB_VECTOR_PORT + + The port of the TiDB vector database. Default is `4000`. + +- TIDB_VECTOR_USER + + The username of the TiDB vector database. + +- TIDB_VECTOR_PASSWORD + + The password of the TiDB vector database. + +- TIDB_VECTOR_DATABASE + + The database name of the TiDB vector database. Default is `dify`. + +#### MatrixOne Configuration + +- MATRIXONE_HOST + + The host of Matrixone database, default value is matrixone. + +- MATRIXONE_PORT + + The port of Matrixone database, default value is 6001. + +- MATRIXONE_USER + + The user of Matrixone database, default value is dump. + +- MATRIXONE_PASSWORD + + The password of Matrixone database, default value is 111. + +- MATRIXONE_DATABASE + + The database of Matrixone database, default value is dify. + +#### Tencent Cloud VectorDB Configuration - TENCENT_VECTOR_DB_URL @@ -498,25 +536,21 @@ Used to store uploaded data set files, team/tenant encryption keys, and other fi Specify whether to enable HybridSearch. [Sparse Vector Documentation](https://cloud.tencent.com/document/product/1709/110110). -- MATRIXONE_HOST +#### Lindorm Configuration - The host of Matrixone database, default value is matrixone. +- LINDORM_URL -- MATRIXONE_PORT + The URL of LINDORM search engine，you can get it from [the console](https://lindorm.console.aliyun.com/) - The port of Matrixone database, default value is 6001. +- LINDORM_USERNAME -- MATRIXONE_USER + The username of lindorm search engine - The user of Matrixone database, default value is dump. +- LINDORM_PASSWORD -- MATRIXONE_PASSWORD + The password of lindorm search engine - The password of Matrixone database, default value is 111. - -- MATRIXONE_DATABASE - - The database of Matrixone database, default value is dify. +#### OpenGauss Configuration - OPENGAUSS_HOST @@ -550,6 +584,24 @@ Used to store uploaded data set files, team/tenant encryption keys, and other fi Enabling PQ Acceleration for the openGauss vector database. +#### TableStore Configuration + +- TABLESTORE_ENDPOINT + + The endpoint address of the TableStore server (e.g. 'https://instance-name.cn-hangzhou.ots.aliyuncs.com') + +- TABLESTORE_INSTANCE_NAME + + The instance name to access TableStore server (e.g. 'instance-name') + +- TABLESTORE_ACCESS_KEY_ID + + The accessKey id for the instance name + +- TABLESTORE_ACCESS_KEY_SECRET + + The accessKey secret for the instance name + ### Knowledge Configuration - UPLOAD_FILE_SIZE_LIMIT\