.env.example 30 KB

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