You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting-started/advanced-topics/env-configuration.md
+46-1Lines changed: 46 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,9 @@ environment variables, providing their types, default values, and descriptions.
12
12
As new variables are introduced, this page will be updated to reflect the growing configuration options.
13
13
14
14
:::info
15
+
15
16
This page is up to date with Open WebUI release version [v0.5.1](https://github.com/open-webui/open-webui/releases/tag/v0.5.1), but is still a work in progress to later include more accurate descriptions, listing out options available for environment variables, defaults, and improving descriptions.
17
+
16
18
:::
17
19
18
20
## App/Backend
@@ -59,7 +61,9 @@ environment variables, see our [logging documentation](https://docs.openwebui.co
59
61
- Description: Sets the port to run Open WebUI from.
60
62
61
63
:::info
64
+
62
65
If installed via Python, you must instead pass `--port` as a command line argument.
66
+
63
67
:::
64
68
65
69
#### `ENABLE_SIGNUP`
@@ -75,8 +79,10 @@ If installed via Python, you must instead pass `--port` as a command line argume
75
79
- Description: Toggles email, password, sign in and "or" (only when `ENABLE_OAUTH_SIGNUP` is set to True) elements.
76
80
77
81
:::danger
82
+
78
83
This should **only** ever be set to `False` when [ENABLE_OAUTH_SIGNUP](https://docs.openwebui.com/getting-started/advanced-topics/env-configuration/#enable_oauth_signup)
79
84
is also being used and set to `True`. Failure to do so will result in the inability to login.
85
+
80
86
:::
81
87
82
88
#### `ENABLE_ADMIN_EXPORT`
@@ -156,7 +162,8 @@ is also being used and set to `True`. Failure to do so will result in the inabil
When setting this environment variable in a `.env` file, make sure to escape the quotes by wrapping the entire value in double quotes and using escaped quotes (`\"`) for the inner quotes. Example:
161
168
162
169
```
@@ -188,9 +195,11 @@ for local Whisper and embeddings.
188
195
such as connections to Ollama and OpenAI endpoints.
189
196
190
197
:::info
198
+
191
199
This is the maximum amount of time the client will wait for a response before timing out.
192
200
If set to an empty string (' '), the timeout will be set to `None`, effectively disabling the timeout and
193
201
allowing the client to wait indefinitely.
202
+
194
203
:::
195
204
196
205
#### `AIOHTTP_CLIENT_TIMEOUT_OPENAI_MODEL_LIST`
@@ -342,6 +351,12 @@ Available Tools: {{TOOLS}}\nReturn an empty string if no tools match the query.
342
351
- Default: `False`
343
352
- Description: Enables or disables autocomplete generation.
344
353
354
+
:::info
355
+
356
+
When enabling `ENABLE_AUTOCOMPLETE_GENERATION`, ensure that you also configure `AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH` and `AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE` accordingly.
357
+
358
+
:::
359
+
345
360
#### `AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH`
346
361
347
362
- Type: `int`
@@ -399,7 +414,9 @@ Available Tools: {{TOOLS}}\nReturn an empty string if no tools match the query.
399
414
- Description: Specifies a comma-separated list of allowed API endpoints when API key endpoint restrictions are enabled.
400
415
401
416
:::note
417
+
402
418
The value of `API_KEY_ALLOWED_ENDPOINTS` should be a comma-separated list of endpoint URLs, such as `/api/v1/messages, /api/v1/channels`.
419
+
403
420
:::
404
421
405
422
## Security Variables
@@ -454,10 +471,12 @@ requests initiated by third-party websites, but only over HTTPS.
454
471
- Description: This setting enables or disables authentication.
455
472
456
473
:::danger
474
+
457
475
If set to `False`, authentication will be disabled for your Open WebUI instance. However, it's
458
476
important to note that turning off authentication is only possible for fresh installations without
459
477
any existing users. If there are already users registered, you cannot disable authentication
460
478
directly. Ensure that no users are present in the database, if you intend to turn off `WEBUI_AUTH`.
479
+
461
480
:::
462
481
463
482
#### `WEBUI_SECRET_KEY`
@@ -645,6 +664,12 @@ You are given a user query, some textual context and rules, all inside xml tags.
645
664
- Default: `10`
646
665
- Description: Sets the maximum number of files that can be uploaded at once for document ingestion.
647
666
667
+
:::info
668
+
669
+
When configuring `RAG_FILE_MAX_SIZE` and `RAG_FILE_MAX_COUNT`, ensure that the values are reasonable to prevent excessive file uploads and potential performance issues.
670
+
671
+
:::
672
+
648
673
#### `RAG_RERANKING_MODEL`
649
674
650
675
- Type: `str`
@@ -759,6 +784,12 @@ You are given a user query, some textual context and rules, all inside xml tags.
759
784
- Default: `False`
760
785
- Description: Enables or disables Google Drive integration. If set to true, and `GOOGLE_DRIVE_CLIENT_ID` & `GOOGLE_DRIVE_API_KEY` are both configured, Google Drive will appear as an upload option in the chat UI.
761
786
787
+
:::info
788
+
789
+
When enabling `GOOGLE_DRIVE_INTEGRATION`, ensure that you have configured `GOOGLE_DRIVE_CLIENT_ID` and `GOOGLE_DRIVE_API_KEY` correctly, and have reviewed Google's terms of service and usage guidelines.
790
+
791
+
:::
792
+
762
793
#### `GOOGLE_DRIVE_CLIENT_ID`
763
794
764
795
- Type: `str`
@@ -1169,6 +1200,12 @@ the search query. Example: `http://searxng.local/search?q=<query>`
1169
1200
- Default: `False`
1170
1201
- Description: Enables account creation when sighting up via OAuth. Distinct from `ENABLE_SIGNUP`.
1171
1202
1203
+
:::danger
1204
+
1205
+
`ENABLE_LOGIN_FORM` must be set to `False` when `ENABLE_OAUTH_SIGNUP` is set to `True`. Failure to do so will result in the inability to login.
1206
+
1207
+
:::
1208
+
1172
1209
#### `ENABLE_API_KEY`
1173
1210
1174
1211
- Type: `bool`
@@ -1505,8 +1542,10 @@ These variables are not specific to Open WebUI but can still be valuable in cert
1505
1542
- Description: Specifies the database URL to connect to.
1506
1543
1507
1544
:::info
1545
+
1508
1546
Supports SQLite and Postgres. Changing the URL does not migrate data between databases.
1509
1547
Documentation on URL scheme available [here](https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls).
1548
+
1510
1549
:::
1511
1550
1512
1551
#### `DATABASE_POOL_SIZE`
@@ -1522,7 +1561,9 @@ Documentation on URL scheme available [here](https://docs.sqlalchemy.org/en/20/c
1522
1561
- Description: Specifies the database pool max overflow.
1523
1562
1524
1563
:::info
1564
+
1525
1565
More information about this setting can be found [here](https://docs.sqlalchemy.org/en/20/core/pooling.html#sqlalchemy.pool.QueuePool.params.max_overflow).
1566
+
1526
1567
:::
1527
1568
1528
1569
#### `DATABASE_POOL_TIMEOUT`
@@ -1532,7 +1573,9 @@ More information about this setting can be found [here](https://docs.sqlalchemy.
1532
1573
- Description: Specifies the database pool timeout in seconds to get a connection.
1533
1574
1534
1575
:::info
1576
+
1535
1577
More information about this setting can be found [here](https://docs.sqlalchemy.org/en/20/core/pooling.html#sqlalchemy.pool.QueuePool.params.timeout).
1578
+
1536
1579
:::
1537
1580
1538
1581
#### `DATABASE_POOL_RECYCLE`
@@ -1542,7 +1585,9 @@ More information about this setting can be found [here](https://docs.sqlalchemy.
1542
1585
- Description: Specifies the database pool recycle time in seconds.
1543
1586
1544
1587
:::info
1588
+
1545
1589
More information about this setting can be found [here](https://docs.sqlalchemy.org/en/20/core/pooling.html#setting-pool-recycle).
0 commit comments