.env.example 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814
  1. # ------------------------------
  2. # Environment Variables for API service & worker
  3. # ------------------------------
  4. # ------------------------------
  5. # Common Variables
  6. # ------------------------------
  7. # The backend URL of the console API,
  8. # used to concatenate the authorization callback.
  9. # If empty, it is the same domain.
  10. # Example: https://api.console.dify.ai
  11. CONSOLE_API_URL=
  12. # The front-end URL of the console web,
  13. # used to concatenate some front-end addresses and for CORS configuration use.
  14. # If empty, it is the same domain.
  15. # Example: https://console.dify.ai
  16. CONSOLE_WEB_URL=
  17. # Service API Url,
  18. # used to display Service API Base Url to the front-end.
  19. # If empty, it is the same domain.
  20. # Example: https://api.dify.ai
  21. SERVICE_API_URL=
  22. # WebApp API backend Url,
  23. # used to declare the back-end URL for the front-end API.
  24. # If empty, it is the same domain.
  25. # Example: https://api.app.dify.ai
  26. APP_API_URL=
  27. # WebApp Url,
  28. # used to display WebAPP API Base Url to the front-end.
  29. # If empty, it is the same domain.
  30. # Example: https://app.dify.ai
  31. APP_WEB_URL=
  32. # File preview or download Url prefix.
  33. # used to display File preview or download Url to the front-end or as Multi-model inputs;
  34. # Url is signed and has expiration time.
  35. FILES_URL=
  36. # ------------------------------
  37. # Server Configuration
  38. # ------------------------------
  39. # The log level for the application.
  40. # Supported values are `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`
  41. LOG_LEVEL=INFO
  42. # Debug mode, default is false.
  43. # It is recommended to turn on this configuration for local development
  44. # to prevent some problems caused by monkey patch.
  45. DEBUG=false
  46. # Flask debug mode, it can output trace information at the interface when turned on,
  47. # which is convenient for debugging.
  48. FLASK_DEBUG=false
  49. # A secretkey that is used for securely signing the session cookie
  50. # and encrypting sensitive information on the database.
  51. # You can generate a strong key using `openssl rand -base64 42`.
  52. SECRET_KEY=sk-9f73s3ljTXVcMT3Blb3ljTqtsKiGHXVcMT3BlbkFJLK7U
  53. # Password for admin user initialization.
  54. # If left unset, admin user will not be prompted for a password
  55. # when creating the initial admin account.
  56. INIT_PASSWORD=
  57. # Deployment environment.
  58. # Supported values are `PRODUCTION`, `TESTING`. Default is `PRODUCTION`.
  59. # Testing environment. There will be a distinct color label on the front-end page,
  60. # indicating that this environment is a testing environment.
  61. DEPLOY_ENV=PRODUCTION
  62. # Whether to enable the version check policy.
  63. # If set to empty, https://updates.dify.ai will be called for version check.
  64. CHECK_UPDATE_URL=https://updates.dify.ai
  65. # Used to change the OpenAI base address, default is https://api.openai.com/v1.
  66. # When OpenAI cannot be accessed in China, replace it with a domestic mirror address,
  67. # or when a local model provides OpenAI compatible API, it can be replaced.
  68. OPENAI_API_BASE=https://api.openai.com/v1
  69. # When enabled, migrations will be executed prior to application startup
  70. # and the application will start after the migrations have completed.
  71. MIGRATION_ENABLED=true
  72. # File Access Time specifies a time interval in seconds for the file to be accessed.
  73. # The default value is 300 seconds.
  74. FILES_ACCESS_TIMEOUT=300
  75. # Access token expiration time in minutes
  76. ACCESS_TOKEN_EXPIRE_MINUTES=60
  77. # The maximum number of active requests for the application, where 0 means unlimited, should be a non-negative integer.
  78. APP_MAX_ACTIVE_REQUESTS=0
  79. # ------------------------------
  80. # Container Startup Related Configuration
  81. # Only effective when starting with docker image or docker-compose.
  82. # ------------------------------
  83. # API service binding address, default: 0.0.0.0, i.e., all addresses can be accessed.
  84. DIFY_BIND_ADDRESS=0.0.0.0
  85. # API service binding port number, default 5001.
  86. DIFY_PORT=5001
  87. # The number of API server workers, i.e., the number of gevent workers.
  88. # Formula: number of cpu cores x 2 + 1
  89. # Reference: https://docs.gunicorn.org/en/stable/design.html#how-many-workers
  90. SERVER_WORKER_AMOUNT=
  91. # Defaults to gevent. If using windows, it can be switched to sync or solo.
  92. SERVER_WORKER_CLASS=
  93. # Similar to SERVER_WORKER_CLASS. Default is gevent.
  94. # If using windows, it can be switched to sync or solo.
  95. CELERY_WORKER_CLASS=
  96. # Request handling timeout. The default is 200,
  97. # it is recommended to set it to 360 to support a longer sse connection time.
  98. GUNICORN_TIMEOUT=360
  99. # The number of Celery workers. The default is 1, and can be set as needed.
  100. CELERY_WORKER_AMOUNT=
  101. # Flag indicating whether to enable autoscaling of Celery workers.
  102. #
  103. # Autoscaling is useful when tasks are CPU intensive and can be dynamically
  104. # allocated and deallocated based on the workload.
  105. #
  106. # When autoscaling is enabled, the maximum and minimum number of workers can
  107. # be specified. The autoscaling algorithm will dynamically adjust the number
  108. # of workers within the specified range.
  109. #
  110. # Default is false (i.e., autoscaling is disabled).
  111. #
  112. # Example:
  113. # CELERY_AUTO_SCALE=true
  114. CELERY_AUTO_SCALE=false
  115. # The maximum number of Celery workers that can be autoscaled.
  116. # This is optional and only used when autoscaling is enabled.
  117. # Default is not set.
  118. CELERY_MAX_WORKERS=
  119. # The minimum number of Celery workers that can be autoscaled.
  120. # This is optional and only used when autoscaling is enabled.
  121. # Default is not set.
  122. CELERY_MIN_WORKERS=
  123. # API Tool configuration
  124. API_TOOL_DEFAULT_CONNECT_TIMEOUT=10
  125. API_TOOL_DEFAULT_READ_TIMEOUT=60
  126. # ------------------------------
  127. # Database Configuration
  128. # The database uses PostgreSQL. Please use the public schema.
  129. # It is consistent with the configuration in the 'db' service below.
  130. # ------------------------------
  131. DB_USERNAME=postgres
  132. DB_PASSWORD=difyai123456
  133. DB_HOST=db
  134. DB_PORT=5432
  135. DB_DATABASE=dify
  136. # The size of the database connection pool.
  137. # The default is 30 connections, which can be appropriately increased.
  138. SQLALCHEMY_POOL_SIZE=30
  139. # Database connection pool recycling time, the default is 3600 seconds.
  140. SQLALCHEMY_POOL_RECYCLE=3600
  141. # Whether to print SQL, default is false.
  142. SQLALCHEMY_ECHO=false
  143. # Maximum number of connections to the database
  144. # Default is 100
  145. #
  146. # Reference: https://www.postgresql.org/docs/current/runtime-config-connection.html#GUC-MAX-CONNECTIONS
  147. POSTGRES_MAX_CONNECTIONS=100
  148. # Sets the amount of shared memory used for postgres's shared buffers.
  149. # Default is 128MB
  150. # Recommended value: 25% of available memory
  151. # Reference: https://www.postgresql.org/docs/current/runtime-config-resource.html#GUC-SHARED-BUFFERS
  152. POSTGRES_SHARED_BUFFERS=128MB
  153. # Sets the amount of memory used by each database worker for working space.
  154. # Default is 4MB
  155. #
  156. # Reference: https://www.postgresql.org/docs/current/runtime-config-resource.html#GUC-WORK-MEM
  157. POSTGRES_WORK_MEM=4MB
  158. # Sets the amount of memory reserved for maintenance activities.
  159. # Default is 64MB
  160. #
  161. # Reference: https://www.postgresql.org/docs/current/runtime-config-resource.html#GUC-MAINTENANCE-WORK-MEM
  162. POSTGRES_MAINTENANCE_WORK_MEM=64MB
  163. # Sets the planner's assumption about the effective cache size.
  164. # Default is 4096MB
  165. #
  166. # Reference: https://www.postgresql.org/docs/current/runtime-config-query.html#GUC-EFFECTIVE-CACHE-SIZE
  167. POSTGRES_EFFECTIVE_CACHE_SIZE=4096MB
  168. # ------------------------------
  169. # Redis Configuration
  170. # This Redis configuration is used for caching and for pub/sub during conversation.
  171. # ------------------------------
  172. REDIS_HOST=redis
  173. REDIS_PORT=6379
  174. REDIS_USERNAME=
  175. REDIS_PASSWORD=difyai123456
  176. REDIS_USE_SSL=false
  177. # Whether to use Redis Sentinel mode.
  178. # If set to true, the application will automatically discover and connect to the master node through Sentinel.
  179. REDIS_USE_SENTINEL=false
  180. # List of Redis Sentinel nodes. If Sentinel mode is enabled, provide at least one Sentinel IP and port.
  181. # Format: `<sentinel1_ip>:<sentinel1_port>,<sentinel2_ip>:<sentinel2_port>,<sentinel3_ip>:<sentinel3_port>`
  182. REDIS_SENTINELS=
  183. REDIS_SENTINEL_SERVICE_NAME=
  184. REDIS_SENTINEL_USERNAME=
  185. REDIS_SENTINEL_PASSWORD=
  186. REDIS_SENTINEL_SOCKET_TIMEOUT=0.1
  187. # ------------------------------
  188. # Celery Configuration
  189. # ------------------------------
  190. # Use redis as the broker, and redis db 1 for celery broker.
  191. # Format as follows: `redis://<redis_username>:<redis_password>@<redis_host>:<redis_port>/<redis_database>`
  192. # Example: redis://:difyai123456@redis:6379/1
  193. # If use Redis Sentinel, format as follows: `sentinel://<sentinel_username>:<sentinel_password>@<sentinel_host>:<sentinel_port>/<redis_database>`
  194. # Example: sentinel://localhost:26379/1;sentinel://localhost:26380/1;sentinel://localhost:26381/1
  195. CELERY_BROKER_URL=redis://:difyai123456@redis:6379/1
  196. BROKER_USE_SSL=false
  197. # If you are using Redis Sentinel for high availability, configure the following settings.
  198. CELERY_USE_SENTINEL=false
  199. CELERY_SENTINEL_MASTER_NAME=
  200. CELERY_SENTINEL_SOCKET_TIMEOUT=0.1
  201. # ------------------------------
  202. # CORS Configuration
  203. # Used to set the front-end cross-domain access policy.
  204. # ------------------------------
  205. # Specifies the allowed origins for cross-origin requests to the Web API,
  206. # e.g. https://dify.app or * for all origins.
  207. WEB_API_CORS_ALLOW_ORIGINS=*
  208. # Specifies the allowed origins for cross-origin requests to the console API,
  209. # e.g. https://cloud.dify.ai or * for all origins.
  210. CONSOLE_CORS_ALLOW_ORIGINS=*
  211. # ------------------------------
  212. # File Storage Configuration
  213. # ------------------------------
  214. # The type of storage to use for storing user files.
  215. # Supported values are `local` and `s3` and `azure-blob` and `google-storage` and `tencent-cos` and `huawei-obs`
  216. # Default: `local`
  217. STORAGE_TYPE=local
  218. # S3 Configuration
  219. # Whether to use AWS managed IAM roles for authenticating with the S3 service.
  220. # If set to false, the access key and secret key must be provided.
  221. S3_USE_AWS_MANAGED_IAM=false
  222. # The endpoint of the S3 service.
  223. S3_ENDPOINT=
  224. # The region of the S3 service.
  225. S3_REGION=us-east-1
  226. # The name of the S3 bucket to use for storing files.
  227. S3_BUCKET_NAME=difyai
  228. # The access key to use for authenticating with the S3 service.
  229. S3_ACCESS_KEY=
  230. # The secret key to use for authenticating with the S3 service.
  231. S3_SECRET_KEY=
  232. # Azure Blob Configuration
  233. # The name of the Azure Blob Storage account to use for storing files.
  234. AZURE_BLOB_ACCOUNT_NAME=difyai
  235. # The access key to use for authenticating with the Azure Blob Storage account.
  236. AZURE_BLOB_ACCOUNT_KEY=difyai
  237. # The name of the Azure Blob Storage container to use for storing files.
  238. AZURE_BLOB_CONTAINER_NAME=difyai-container
  239. # The URL of the Azure Blob Storage account.
  240. AZURE_BLOB_ACCOUNT_URL=https://<your_account_name>.blob.core.windows.net
  241. # Google Storage Configuration
  242. # The name of the Google Storage bucket to use for storing files.
  243. GOOGLE_STORAGE_BUCKET_NAME=your-bucket-name
  244. # The service account JSON key to use for authenticating with the Google Storage service.
  245. GOOGLE_STORAGE_SERVICE_ACCOUNT_JSON_BASE64=your-google-service-account-json-base64-string
  246. # The Alibaba Cloud OSS configurations,
  247. # only available when STORAGE_TYPE is `aliyun-oss`
  248. ALIYUN_OSS_BUCKET_NAME=your-bucket-name
  249. ALIYUN_OSS_ACCESS_KEY=your-access-key
  250. ALIYUN_OSS_SECRET_KEY=your-secret-key
  251. ALIYUN_OSS_ENDPOINT=https://oss-ap-southeast-1-internal.aliyuncs.com
  252. ALIYUN_OSS_REGION=ap-southeast-1
  253. ALIYUN_OSS_AUTH_VERSION=v4
  254. # Don't start with '/'. OSS doesn't support leading slash in object names.
  255. ALIYUN_OSS_PATH=your-path
  256. # Tencent COS Configuration
  257. # The name of the Tencent COS bucket to use for storing files.
  258. TENCENT_COS_BUCKET_NAME=your-bucket-name
  259. # The secret key to use for authenticating with the Tencent COS service.
  260. TENCENT_COS_SECRET_KEY=your-secret-key
  261. # The secret id to use for authenticating with the Tencent COS service.
  262. TENCENT_COS_SECRET_ID=your-secret-id
  263. # The region of the Tencent COS service.
  264. TENCENT_COS_REGION=your-region
  265. # The scheme of the Tencent COS service.
  266. TENCENT_COS_SCHEME=your-scheme
  267. # Huawei OBS Configuration
  268. # The name of the Huawei OBS bucket to use for storing files.
  269. HUAWEI_OBS_BUCKET_NAME=your-bucket-name
  270. # The secret key to use for authenticating with the Huawei OBS service.
  271. HUAWEI_OBS_SECRET_KEY=your-secret-key
  272. # The access key to use for authenticating with the Huawei OBS service.
  273. HUAWEI_OBS_ACCESS_KEY=your-access-key
  274. # The server url of the HUAWEI OBS service.
  275. HUAWEI_OBS_SERVER=your-server-url
  276. # Volcengine TOS Configuration
  277. # The name of the Volcengine TOS bucket to use for storing files.
  278. VOLCENGINE_TOS_BUCKET_NAME=your-bucket-name
  279. # The secret key to use for authenticating with the Volcengine TOS service.
  280. VOLCENGINE_TOS_SECRET_KEY=your-secret-key
  281. # The access key to use for authenticating with the Volcengine TOS service.
  282. VOLCENGINE_TOS_ACCESS_KEY=your-access-key
  283. # The endpoint of the Volcengine TOS service.
  284. VOLCENGINE_TOS_ENDPOINT=your-server-url
  285. # The region of the Volcengine TOS service.
  286. VOLCENGINE_TOS_REGION=your-region
  287. # ------------------------------
  288. # Vector Database Configuration
  289. # ------------------------------
  290. # The type of vector store to use.
  291. # Supported values are `weaviate`, `qdrant`, `milvus`, `myscale`, `relyt`, `pgvector`, `pgvecto-rs`, ``chroma`, `opensearch`, `tidb_vector`, `oracle`, `tencent`, `elasticsearch`, `analyticdb`.
  292. VECTOR_STORE=weaviate
  293. # The Weaviate endpoint URL. Only available when VECTOR_STORE is `weaviate`.
  294. WEAVIATE_ENDPOINT=http://weaviate:8080
  295. # The Weaviate API key.
  296. WEAVIATE_API_KEY=WVF5YThaHlkYwhGUSmCRgsX3tD5ngdN8pkih
  297. # The Qdrant endpoint URL. Only available when VECTOR_STORE is `qdrant`.
  298. QDRANT_URL=http://qdrant:6333
  299. # The Qdrant API key.
  300. QDRANT_API_KEY=difyai123456
  301. # The Qdrant client timeout setting.
  302. QDRANT_CLIENT_TIMEOUT=20
  303. # The Qdrant client enable gRPC mode.
  304. QDRANT_GRPC_ENABLED=false
  305. # The Qdrant server gRPC mode PORT.
  306. QDRANT_GRPC_PORT=6334
  307. # Milvus configuration Only available when VECTOR_STORE is `milvus`.
  308. # The milvus uri.
  309. MILVUS_URI=http://127.0.0.1:19530
  310. # The milvus token.
  311. MILVUS_TOKEN=
  312. # The milvus username.
  313. MILVUS_USER=root
  314. # The milvus password.
  315. MILVUS_PASSWORD=Milvus
  316. # MyScale configuration, only available when VECTOR_STORE is `myscale`
  317. # For multi-language support, please set MYSCALE_FTS_PARAMS with referring to:
  318. # https://myscale.com/docs/en/text-search/#understanding-fts-index-parameters
  319. MYSCALE_HOST=myscale
  320. MYSCALE_PORT=8123
  321. MYSCALE_USER=default
  322. MYSCALE_PASSWORD=
  323. MYSCALE_DATABASE=dify
  324. MYSCALE_FTS_PARAMS=
  325. # pgvector configurations, only available when VECTOR_STORE is `pgvector`
  326. PGVECTOR_HOST=pgvector
  327. PGVECTOR_PORT=5432
  328. PGVECTOR_USER=postgres
  329. PGVECTOR_PASSWORD=difyai123456
  330. PGVECTOR_DATABASE=dify
  331. PGVECTOR_MIN_CONNECTION=1
  332. PGVECTOR_MAX_CONNECTION=5
  333. # pgvecto-rs configurations, only available when VECTOR_STORE is `pgvecto-rs`
  334. PGVECTO_RS_HOST=pgvecto-rs
  335. PGVECTO_RS_PORT=5432
  336. PGVECTO_RS_USER=postgres
  337. PGVECTO_RS_PASSWORD=difyai123456
  338. PGVECTO_RS_DATABASE=dify
  339. # analyticdb configurations, only available when VECTOR_STORE is `analyticdb`
  340. ANALYTICDB_KEY_ID=your-ak
  341. ANALYTICDB_KEY_SECRET=your-sk
  342. ANALYTICDB_REGION_ID=cn-hangzhou
  343. ANALYTICDB_INSTANCE_ID=gp-ab123456
  344. ANALYTICDB_ACCOUNT=testaccount
  345. ANALYTICDB_PASSWORD=testpassword
  346. ANALYTICDB_NAMESPACE=dify
  347. ANALYTICDB_NAMESPACE_PASSWORD=difypassword
  348. # TiDB vector configurations, only available when VECTOR_STORE is `tidb`
  349. TIDB_VECTOR_HOST=tidb
  350. TIDB_VECTOR_PORT=4000
  351. TIDB_VECTOR_USER=xxx.root
  352. TIDB_VECTOR_PASSWORD=xxxxxx
  353. TIDB_VECTOR_DATABASE=dify
  354. # Chroma configuration, only available when VECTOR_STORE is `chroma`
  355. CHROMA_HOST=127.0.0.1
  356. CHROMA_PORT=8000
  357. CHROMA_TENANT=default_tenant
  358. CHROMA_DATABASE=default_database
  359. CHROMA_AUTH_PROVIDER=chromadb.auth.token_authn.TokenAuthClientProvider
  360. CHROMA_AUTH_CREDENTIALS=xxxxxx
  361. # Oracle configuration, only available when VECTOR_STORE is `oracle`
  362. ORACLE_HOST=oracle
  363. ORACLE_PORT=1521
  364. ORACLE_USER=dify
  365. ORACLE_PASSWORD=dify
  366. ORACLE_DATABASE=FREEPDB1
  367. # relyt configurations, only available when VECTOR_STORE is `relyt`
  368. RELYT_HOST=db
  369. RELYT_PORT=5432
  370. RELYT_USER=postgres
  371. RELYT_PASSWORD=difyai123456
  372. RELYT_DATABASE=postgres
  373. # open search configuration, only available when VECTOR_STORE is `opensearch`
  374. OPENSEARCH_HOST=opensearch
  375. OPENSEARCH_PORT=9200
  376. OPENSEARCH_USER=admin
  377. OPENSEARCH_PASSWORD=admin
  378. OPENSEARCH_SECURE=true
  379. # tencent vector configurations, only available when VECTOR_STORE is `tencent`
  380. TENCENT_VECTOR_DB_URL=http://127.0.0.1
  381. TENCENT_VECTOR_DB_API_KEY=dify
  382. TENCENT_VECTOR_DB_TIMEOUT=30
  383. TENCENT_VECTOR_DB_USERNAME=dify
  384. TENCENT_VECTOR_DB_DATABASE=dify
  385. TENCENT_VECTOR_DB_SHARD=1
  386. TENCENT_VECTOR_DB_REPLICAS=2
  387. # ElasticSearch configuration, only available when VECTOR_STORE is `elasticsearch`
  388. ELASTICSEARCH_HOST=0.0.0.0
  389. ELASTICSEARCH_PORT=9200
  390. ELASTICSEARCH_USERNAME=elastic
  391. ELASTICSEARCH_PASSWORD=elastic
  392. # baidu vector configurations, only available when VECTOR_STORE is `baidu`
  393. BAIDU_VECTOR_DB_ENDPOINT=http://127.0.0.1:5287
  394. BAIDU_VECTOR_DB_CONNECTION_TIMEOUT_MS=30000
  395. BAIDU_VECTOR_DB_ACCOUNT=root
  396. BAIDU_VECTOR_DB_API_KEY=dify
  397. BAIDU_VECTOR_DB_DATABASE=dify
  398. BAIDU_VECTOR_DB_SHARD=1
  399. BAIDU_VECTOR_DB_REPLICAS=3
  400. # ------------------------------
  401. # Knowledge Configuration
  402. # ------------------------------
  403. # Upload file size limit, default 15M.
  404. UPLOAD_FILE_SIZE_LIMIT=15
  405. # The maximum number of files that can be uploaded at a time, default 5.
  406. UPLOAD_FILE_BATCH_LIMIT=5
  407. # ETl type, support: `dify`, `Unstructured`
  408. # `dify` Dify's proprietary file extraction scheme
  409. # `Unstructured` Unstructured.io file extraction scheme
  410. ETL_TYPE=dify
  411. # Unstructured API path, needs to be configured when ETL_TYPE is Unstructured.
  412. # For example: http://unstructured:8000/general/v0/general
  413. UNSTRUCTURED_API_URL=
  414. # ------------------------------
  415. # Multi-modal Configuration
  416. # ------------------------------
  417. # The format of the image sent when the multi-modal model is input,
  418. # the default is base64, optional url.
  419. # The delay of the call in url mode will be lower than that in base64 mode.
  420. # It is generally recommended to use the more compatible base64 mode.
  421. # If configured as url, you need to configure FILES_URL as an externally accessible address so that the multi-modal model can access the image.
  422. MULTIMODAL_SEND_IMAGE_FORMAT=base64
  423. # Upload image file size limit, default 10M.
  424. UPLOAD_IMAGE_FILE_SIZE_LIMIT=10
  425. # ------------------------------
  426. # Sentry Configuration
  427. # Used for application monitoring and error log tracking.
  428. # ------------------------------
  429. # API Service Sentry DSN address, default is empty, when empty,
  430. # all monitoring information is not reported to Sentry.
  431. # If not set, Sentry error reporting will be disabled.
  432. API_SENTRY_DSN=
  433. # API Service The reporting ratio of Sentry events, if it is 0.01, it is 1%.
  434. API_SENTRY_TRACES_SAMPLE_RATE=1.0
  435. # API Service The reporting ratio of Sentry profiles, if it is 0.01, it is 1%.
  436. API_SENTRY_PROFILES_SAMPLE_RATE=1.0
  437. # Web Service Sentry DSN address, default is empty, when empty,
  438. # all monitoring information is not reported to Sentry.
  439. # If not set, Sentry error reporting will be disabled.
  440. WEB_SENTRY_DSN=
  441. # ------------------------------
  442. # Notion Integration Configuration
  443. # Variables can be obtained by applying for Notion integration: https://www.notion.so/my-integrations
  444. # ------------------------------
  445. # Configure as "public" or "internal".
  446. # Since Notion's OAuth redirect URL only supports HTTPS,
  447. # if deploying locally, please use Notion's internal integration.
  448. NOTION_INTEGRATION_TYPE=public
  449. # Notion OAuth client secret (used for public integration type)
  450. NOTION_CLIENT_SECRET=
  451. # Notion OAuth client id (used for public integration type)
  452. NOTION_CLIENT_ID=
  453. # Notion internal integration secret.
  454. # If the value of NOTION_INTEGRATION_TYPE is "internal",
  455. # you need to configure this variable.
  456. NOTION_INTERNAL_SECRET=
  457. # ------------------------------
  458. # Mail related configuration
  459. # ------------------------------
  460. # Mail type, support: resend, smtp
  461. MAIL_TYPE=resend
  462. # Default send from email address, if not specified
  463. MAIL_DEFAULT_SEND_FROM=
  464. # API-Key for the Resend email provider, used when MAIL_TYPE is `resend`.
  465. RESEND_API_KEY=your-resend-api-key
  466. # SMTP server configuration, used when MAIL_TYPE is `smtp`
  467. SMTP_SERVER=
  468. SMTP_PORT=465
  469. SMTP_USERNAME=
  470. SMTP_PASSWORD=
  471. SMTP_USE_TLS=true
  472. SMTP_OPPORTUNISTIC_TLS=false
  473. # ------------------------------
  474. # Others Configuration
  475. # ------------------------------
  476. # Maximum length of segmentation tokens for indexing
  477. INDEXING_MAX_SEGMENTATION_TOKENS_LENGTH=1000
  478. # Member invitation link valid time (hours),
  479. # Default: 72.
  480. INVITE_EXPIRY_HOURS=72
  481. # Reset password token valid time (hours),
  482. # Default: 24.
  483. RESET_PASSWORD_TOKEN_EXPIRY_HOURS=24
  484. # The sandbox service endpoint.
  485. CODE_EXECUTION_ENDPOINT=http://sandbox:8194
  486. CODE_MAX_NUMBER=9223372036854775807
  487. CODE_MIN_NUMBER=-9223372036854775808
  488. CODE_MAX_DEPTH=5
  489. CODE_MAX_PRECISION=20
  490. CODE_MAX_STRING_LENGTH=80000
  491. TEMPLATE_TRANSFORM_MAX_LENGTH=80000
  492. CODE_MAX_STRING_ARRAY_LENGTH=30
  493. CODE_MAX_OBJECT_ARRAY_LENGTH=30
  494. CODE_MAX_NUMBER_ARRAY_LENGTH=1000
  495. # Workflow runtime configuration
  496. WORKFLOW_MAX_EXECUTION_STEPS=500
  497. WORKFLOW_MAX_EXECUTION_TIME=1200
  498. WORKFLOW_CALL_MAX_DEPTH=5
  499. # HTTP request node in workflow configuration
  500. HTTP_REQUEST_NODE_MAX_BINARY_SIZE=10485760
  501. HTTP_REQUEST_NODE_MAX_TEXT_SIZE=1048576
  502. # SSRF Proxy server HTTP URL
  503. SSRF_PROXY_HTTP_URL=http://ssrf_proxy:3128
  504. # SSRF Proxy server HTTPS URL
  505. SSRF_PROXY_HTTPS_URL=http://ssrf_proxy:3128
  506. # ------------------------------
  507. # Environment Variables for web Service
  508. # ------------------------------
  509. # The timeout for the text generation in millisecond
  510. TEXT_GENERATION_TIMEOUT_MS=60000
  511. # ------------------------------
  512. # Environment Variables for db Service
  513. # ------------------------------
  514. PGUSER=${DB_USERNAME}
  515. # The password for the default postgres user.
  516. POSTGRES_PASSWORD=${DB_PASSWORD}
  517. # The name of the default postgres database.
  518. POSTGRES_DB=${DB_DATABASE}
  519. # postgres data directory
  520. PGDATA=/var/lib/postgresql/data/pgdata
  521. # ------------------------------
  522. # Environment Variables for sandbox Service
  523. # ------------------------------
  524. # The API key for the sandbox service
  525. SANDBOX_API_KEY=dify-sandbox
  526. # The mode in which the Gin framework runs
  527. SANDBOX_GIN_MODE=release
  528. # The timeout for the worker in seconds
  529. SANDBOX_WORKER_TIMEOUT=15
  530. # Enable network for the sandbox service
  531. SANDBOX_ENABLE_NETWORK=true
  532. # HTTP proxy URL for SSRF protection
  533. SANDBOX_HTTP_PROXY=http://ssrf_proxy:3128
  534. # HTTPS proxy URL for SSRF protection
  535. SANDBOX_HTTPS_PROXY=http://ssrf_proxy:3128
  536. # The port on which the sandbox service runs
  537. SANDBOX_PORT=8194
  538. # ------------------------------
  539. # Environment Variables for weaviate Service
  540. # (only used when VECTOR_STORE is weaviate)
  541. # ------------------------------
  542. WEAVIATE_PERSISTENCE_DATA_PATH='/var/lib/weaviate'
  543. WEAVIATE_QUERY_DEFAULTS_LIMIT=25
  544. WEAVIATE_AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED=true
  545. WEAVIATE_DEFAULT_VECTORIZER_MODULE=none
  546. WEAVIATE_CLUSTER_HOSTNAME=node1
  547. WEAVIATE_AUTHENTICATION_APIKEY_ENABLED=true
  548. WEAVIATE_AUTHENTICATION_APIKEY_ALLOWED_KEYS=WVF5YThaHlkYwhGUSmCRgsX3tD5ngdN8pkih
  549. WEAVIATE_AUTHENTICATION_APIKEY_USERS=hello@dify.ai
  550. WEAVIATE_AUTHORIZATION_ADMINLIST_ENABLED=true
  551. WEAVIATE_AUTHORIZATION_ADMINLIST_USERS=hello@dify.ai
  552. # ------------------------------
  553. # Environment Variables for Chroma
  554. # (only used when VECTOR_STORE is chroma)
  555. # ------------------------------
  556. # Authentication credentials for Chroma server
  557. CHROMA_SERVER_AUTHN_CREDENTIALS=difyai123456
  558. # Authentication provider for Chroma server
  559. CHROMA_SERVER_AUTHN_PROVIDER=chromadb.auth.token_authn.TokenAuthenticationServerProvider
  560. # Persistence setting for Chroma server
  561. CHROMA_IS_PERSISTENT=TRUE
  562. # ------------------------------
  563. # Environment Variables for Oracle Service
  564. # (only used when VECTOR_STORE is Oracle)
  565. # ------------------------------
  566. ORACLE_PWD=Dify123456
  567. ORACLE_CHARACTERSET=AL32UTF8
  568. # ------------------------------
  569. # Environment Variables for milvus Service
  570. # (only used when VECTOR_STORE is milvus)
  571. # ------------------------------
  572. # ETCD configuration for auto compaction mode
  573. ETCD_AUTO_COMPACTION_MODE=revision
  574. # ETCD configuration for auto compaction retention in terms of number of revisions
  575. ETCD_AUTO_COMPACTION_RETENTION=1000
  576. # ETCD configuration for backend quota in bytes
  577. ETCD_QUOTA_BACKEND_BYTES=4294967296
  578. # ETCD configuration for the number of changes before triggering a snapshot
  579. ETCD_SNAPSHOT_COUNT=50000
  580. # MinIO access key for authentication
  581. MINIO_ACCESS_KEY=minioadmin
  582. # MinIO secret key for authentication
  583. MINIO_SECRET_KEY=minioadmin
  584. # ETCD service endpoints
  585. ETCD_ENDPOINTS=etcd:2379
  586. # MinIO service address
  587. MINIO_ADDRESS=minio:9000
  588. # Enable or disable security authorization
  589. MILVUS_AUTHORIZATION_ENABLED=true
  590. # ------------------------------
  591. # Environment Variables for pgvector / pgvector-rs Service
  592. # (only used when VECTOR_STORE is pgvector / pgvector-rs)
  593. # ------------------------------
  594. PGVECTOR_PGUSER=postgres
  595. # The password for the default postgres user.
  596. PGVECTOR_POSTGRES_PASSWORD=difyai123456
  597. # The name of the default postgres database.
  598. PGVECTOR_POSTGRES_DB=dify
  599. # postgres data directory
  600. PGVECTOR_PGDATA=/var/lib/postgresql/data/pgdata
  601. # ------------------------------
  602. # Environment Variables for opensearch
  603. # (only used when VECTOR_STORE is opensearch)
  604. # ------------------------------
  605. OPENSEARCH_DISCOVERY_TYPE=single-node
  606. OPENSEARCH_BOOTSTRAP_MEMORY_LOCK=true
  607. OPENSEARCH_JAVA_OPTS_MIN=512m
  608. OPENSEARCH_JAVA_OPTS_MAX=1024m
  609. OPENSEARCH_INITIAL_ADMIN_PASSWORD=Qazwsxedc!@#123
  610. OPENSEARCH_MEMLOCK_SOFT=-1
  611. OPENSEARCH_MEMLOCK_HARD=-1
  612. OPENSEARCH_NOFILE_SOFT=65536
  613. OPENSEARCH_NOFILE_HARD=65536
  614. # ------------------------------
  615. # Environment Variables for Nginx reverse proxy
  616. # ------------------------------
  617. NGINX_SERVER_NAME=_
  618. NGINX_HTTPS_ENABLED=false
  619. # HTTP port
  620. NGINX_PORT=80
  621. # SSL settings are only applied when HTTPS_ENABLED is true
  622. NGINX_SSL_PORT=443
  623. # if HTTPS_ENABLED is true, you're required to add your own SSL certificates/keys to the `./nginx/ssl` directory
  624. # and modify the env vars below accordingly.
  625. NGINX_SSL_CERT_FILENAME=dify.crt
  626. NGINX_SSL_CERT_KEY_FILENAME=dify.key
  627. NGINX_SSL_PROTOCOLS=TLSv1.1 TLSv1.2 TLSv1.3
  628. # Nginx performance tuning
  629. NGINX_WORKER_PROCESSES=auto
  630. NGINX_CLIENT_MAX_BODY_SIZE=15M
  631. NGINX_KEEPALIVE_TIMEOUT=65
  632. # Proxy settings
  633. NGINX_PROXY_READ_TIMEOUT=3600s
  634. NGINX_PROXY_SEND_TIMEOUT=3600s
  635. # Set true to accept requests for /.well-known/acme-challenge/
  636. NGINX_ENABLE_CERTBOT_CHALLENGE=false
  637. # ------------------------------
  638. # Certbot Configuration
  639. # ------------------------------
  640. # Email address (required to get certificates from Let's Encrypt)
  641. CERTBOT_EMAIL=your_email@example.com
  642. # Domain name
  643. CERTBOT_DOMAIN=your_domain.com
  644. # certbot command options
  645. # i.e: --force-renewal --dry-run --test-cert --debug
  646. CERTBOT_OPTIONS=
  647. # ------------------------------
  648. # Environment Variables for SSRF Proxy
  649. # ------------------------------
  650. SSRF_HTTP_PORT=3128
  651. SSRF_COREDUMP_DIR=/var/spool/squid
  652. SSRF_REVERSE_PROXY_PORT=8194
  653. SSRF_SANDBOX_HOST=sandbox
  654. # ------------------------------
  655. # docker env var for specifying vector db type at startup
  656. # (based on the vector db type, the corresponding docker
  657. # compose profile will be used)
  658. # if you want to use unstructured, add ',unstructured' to the end
  659. # ------------------------------
  660. COMPOSE_PROFILES=${VECTOR_STORE:-weaviate}
  661. # ------------------------------
  662. # Docker Compose Service Expose Host Port Configurations
  663. # ------------------------------
  664. EXPOSE_NGINX_PORT=80
  665. EXPOSE_NGINX_SSL_PORT=443
  666. # ----------------------------------------------------------------------------
  667. # ModelProvider & Tool Position Configuration
  668. # Used to specify the model providers and tools that can be used in the app.
  669. # ----------------------------------------------------------------------------
  670. # Pin, include, and exclude tools
  671. # Use comma-separated values with no spaces between items.
  672. # Example: POSITION_TOOL_PINS=bing,google
  673. POSITION_TOOL_PINS=
  674. POSITION_TOOL_INCLUDES=
  675. POSITION_TOOL_EXCLUDES=
  676. # Pin, include, and exclude model providers
  677. # Use comma-separated values with no spaces between items.
  678. # Example: POSITION_PROVIDER_PINS=openai,openllm
  679. POSITION_PROVIDER_PINS=
  680. POSITION_PROVIDER_INCLUDES=
  681. POSITION_PROVIDER_EXCLUDES=
  682. # CSP https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP
  683. CSP_WHITELIST=