Skip to content

Commit 4001fa5

Browse files
committed
Update env-configuration.md
1 parent 7aeb119 commit 4001fa5

File tree

1 file changed

+46
-1
lines changed

1 file changed

+46
-1
lines changed

docs/getting-started/advanced-topics/env-configuration.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ environment variables, providing their types, default values, and descriptions.
1212
As new variables are introduced, this page will be updated to reflect the growing configuration options.
1313

1414
:::info
15+
1516
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+
1618
:::
1719

1820
## App/Backend
@@ -59,7 +61,9 @@ environment variables, see our [logging documentation](https://docs.openwebui.co
5961
- Description: Sets the port to run Open WebUI from.
6062

6163
:::info
64+
6265
If installed via Python, you must instead pass `--port` as a command line argument.
66+
6367
:::
6468

6569
#### `ENABLE_SIGNUP`
@@ -75,8 +79,10 @@ If installed via Python, you must instead pass `--port` as a command line argume
7579
- Description: Toggles email, password, sign in and "or" (only when `ENABLE_OAUTH_SIGNUP` is set to True) elements.
7680

7781
:::danger
82+
7883
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)
7984
is also being used and set to `True`. Failure to do so will result in the inability to login.
85+
8086
:::
8187

8288
#### `ENABLE_ADMIN_EXPORT`
@@ -156,7 +162,8 @@ is also being used and set to `True`. Failure to do so will result in the inabil
156162
[{"id": "string","type": "string [info, success, warning, error]","title": "string","content": "string","dismissible": False,"timestamp": 1000}]
157163
```
158164

159-
:::note
165+
:::info
166+
160167
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:
161168

162169
```
@@ -188,9 +195,11 @@ for local Whisper and embeddings.
188195
such as connections to Ollama and OpenAI endpoints.
189196

190197
:::info
198+
191199
This is the maximum amount of time the client will wait for a response before timing out.
192200
If set to an empty string (' '), the timeout will be set to `None`, effectively disabling the timeout and
193201
allowing the client to wait indefinitely.
202+
194203
:::
195204

196205
#### `AIOHTTP_CLIENT_TIMEOUT_OPENAI_MODEL_LIST`
@@ -342,6 +351,12 @@ Available Tools: {{TOOLS}}\nReturn an empty string if no tools match the query.
342351
- Default: `False`
343352
- Description: Enables or disables autocomplete generation.
344353

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+
345360
#### `AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH`
346361

347362
- Type: `int`
@@ -399,7 +414,9 @@ Available Tools: {{TOOLS}}\nReturn an empty string if no tools match the query.
399414
- Description: Specifies a comma-separated list of allowed API endpoints when API key endpoint restrictions are enabled.
400415

401416
:::note
417+
402418
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+
403420
:::
404421

405422
## Security Variables
@@ -454,10 +471,12 @@ requests initiated by third-party websites, but only over HTTPS.
454471
- Description: This setting enables or disables authentication.
455472

456473
:::danger
474+
457475
If set to `False`, authentication will be disabled for your Open WebUI instance. However, it's
458476
important to note that turning off authentication is only possible for fresh installations without
459477
any existing users. If there are already users registered, you cannot disable authentication
460478
directly. Ensure that no users are present in the database, if you intend to turn off `WEBUI_AUTH`.
479+
461480
:::
462481

463482
#### `WEBUI_SECRET_KEY`
@@ -645,6 +664,12 @@ You are given a user query, some textual context and rules, all inside xml tags.
645664
- Default: `10`
646665
- Description: Sets the maximum number of files that can be uploaded at once for document ingestion.
647666

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+
648673
#### `RAG_RERANKING_MODEL`
649674

650675
- Type: `str`
@@ -759,6 +784,12 @@ You are given a user query, some textual context and rules, all inside xml tags.
759784
- Default: `False`
760785
- 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.
761786

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+
762793
#### `GOOGLE_DRIVE_CLIENT_ID`
763794

764795
- Type: `str`
@@ -1169,6 +1200,12 @@ the search query. Example: `http://searxng.local/search?q=<query>`
11691200
- Default: `False`
11701201
- Description: Enables account creation when sighting up via OAuth. Distinct from `ENABLE_SIGNUP`.
11711202

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+
11721209
#### `ENABLE_API_KEY`
11731210

11741211
- Type: `bool`
@@ -1505,8 +1542,10 @@ These variables are not specific to Open WebUI but can still be valuable in cert
15051542
- Description: Specifies the database URL to connect to.
15061543

15071544
:::info
1545+
15081546
Supports SQLite and Postgres. Changing the URL does not migrate data between databases.
15091547
Documentation on URL scheme available [here](https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls).
1548+
15101549
:::
15111550

15121551
#### `DATABASE_POOL_SIZE`
@@ -1522,7 +1561,9 @@ Documentation on URL scheme available [here](https://docs.sqlalchemy.org/en/20/c
15221561
- Description: Specifies the database pool max overflow.
15231562

15241563
:::info
1564+
15251565
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+
15261567
:::
15271568

15281569
#### `DATABASE_POOL_TIMEOUT`
@@ -1532,7 +1573,9 @@ More information about this setting can be found [here](https://docs.sqlalchemy.
15321573
- Description: Specifies the database pool timeout in seconds to get a connection.
15331574

15341575
:::info
1576+
15351577
More information about this setting can be found [here](https://docs.sqlalchemy.org/en/20/core/pooling.html#sqlalchemy.pool.QueuePool.params.timeout).
1578+
15361579
:::
15371580

15381581
#### `DATABASE_POOL_RECYCLE`
@@ -1542,7 +1585,9 @@ More information about this setting can be found [here](https://docs.sqlalchemy.
15421585
- Description: Specifies the database pool recycle time in seconds.
15431586

15441587
:::info
1588+
15451589
More information about this setting can be found [here](https://docs.sqlalchemy.org/en/20/core/pooling.html#setting-pool-recycle).
1590+
15461591
:::
15471592

15481593
### Redis

0 commit comments

Comments
 (0)