๐ Environment Variable Configuration
Overviewโ
Open WebUI provides a large range of environment variables that allow you to customize and configure various aspects of the application. This page serves as a comprehensive reference for all available environment variables, providing their types, default values, and descriptions. As new variables are introduced, this page will be updated to reflect the growing configuration options.
This page is up-to-date with Open WebUI release version v0.6.9, but is still a work in progress to later include more accurate descriptions, listing out options available for environment variables, defaults, and improving descriptions.
Important Note on PersistentConfig
Environment Variablesโ
When launching Open WebUI for the first time, all environment variables are treated equally and can be used to configure the application. However, for environment variables marked as PersistentConfig
, their values are persisted and stored internally.
After the initial launch, if you restart the container, PersistentConfig
environment variables will no longer use the external environment variable values. Instead, they will use the internally stored values.
In contrast, regular environment variables will continue to be updated and applied on each subsequent restart.
You can update the values of PersistentConfig
environment variables directly from within Open WebUI, and these changes will be stored internally. This allows you to manage these configuration settings independently of the external environment variables.
Please note that PersistentConfig
environment variables are clearly marked as such in the documentation below, so you can be aware of how they will behave.
To disable PersistentConfig
and have Open WebUI treat all variables equally, you can set ENABLE_PERSISTENT_CONFIG
to False
.
App/Backendโ
The following environment variables are used by backend/open_webui/config.py
to provide Open WebUI startup
configuration. Please note that some variables may have different default values depending on
whether you're running Open WebUI directly or via Docker. For more information on logging
environment variables, see our logging documentation.
Generalโ
WEBUI_URL
โ
- Type:
str
- Default:
http://localhost:3000
- Description: Specifies the URL where your Open WebUI installation is reachable. Needed for search engine support and OAuth/SSO.
- Persistence: This environment variable is a
PersistentConfig
variable.
This variable has to be set before you start using OAuth/SSO for authentication. Since this is a persistent config environment variable, you can only change it through one of the following options:
- Temporarily disabling persistent config using
ENABLE_PERSISTENT_CONFIG
- Changing
WEBUI_URL
in the admin panel > settings and changing "WebUI URL".
Failure to set WEBUI_URL before using OAuth/SSO will result in failure to log in.
ENABLE_SIGNUP
โ
- Type:
bool
- Default:
True
- Description: Toggles user account creation.
- Persistence: This environment variable is a
PersistentConfig
variable.
ENABLE_LOGIN_FORM
โ
- Type:
bool
- Default:
True
- Description: Toggles email, password, sign-in and "or" (only when
ENABLE_OAUTH_SIGNUP
is set to True) elements. - Persistence: This environment variable is a
PersistentConfig
variable.
This should only ever be set to False
when ENABLE_OAUTH_SIGNUP
is also being used and set to True
. Failure to do so will result in the inability to login.
DEFAULT_LOCALE
โ
- Type:
str
- Default:
en
- Description: Sets the default locale for the application.
- Persistence: This environment variable is a
PersistentConfig
variable.
DEFAULT_MODELS
โ
- Type:
str
- Default: Empty string (' '), since
None
. - Description: Sets a default Language Model.
- Persistence: This environment variable is a
PersistentConfig
variable.
DEFAULT_USER_ROLE
โ
- Type:
str
- Options:
pending
- New users are pending until their accounts are manually activated by an admin.user
- New users are automatically activated with regular user permissions.admin
- New users are automatically activated with administrator permissions.
- Default:
pending
- Description: Sets the default role assigned to new users.
- Persistence: This environment variable is a
PersistentConfig
variable.
PENDING_USER_OVERLAY_TITLE
โ
- Type:
str
- Default: Empty string (' ')
- Description: Sets a custom title for the pending user overlay.
- Persistence: This environment variable is a
PersistentConfig
variable.
PENDING_USER_OVERLAY_CONTENT
โ
- Type:
str
- Default: Empty string (' ')
- Description: Sets a custom text content for the pending user overlay.
- Persistence: This environment variable is a
PersistentConfig
variable.
ENABLE_CHANNELS
โ
- Type:
bool
- Default:
False
- Description: Enables or disables channel support.
- Persistence: This environment variable is a
PersistentConfig
variable.
WEBHOOK_URL
โ
- Type:
str
- Description: Sets a webhook for integration with Discord/Slack/Microsoft Teams.
- Persistence: This environment variable is a
PersistentConfig
variable.
ENABLE_ADMIN_EXPORT
โ
- Type:
bool
- Default:
True
- Description: Controls whether admin users can export data.
ENABLE_ADMIN_CHAT_ACCESS
โ
- Type:
bool
- Default:
True
- Description: Enables admin users to access all chats.
ENABLE_USER_WEBHOOKS
โ
- Type:
bool
- Default:
True
- Description: Enables or disables user webhooks.
- Persistence: This environment variable is a
PersistentConfig
variable.
RESPONSE_WATERMARK
โ
- Type:
str
- Default: Empty string (' ')
- Description: Sets a custom text that will be included when you copy a message in the chat. E.g.
"This text is AI generated"
-> will add "This text is AI generated" to every message, when copied. - Persistence: This environment variable is a
PersistentConfig
variable.
THREAD_POOL_SIZE
โ
- Type:
int
- Default:
0
- Description: Sets the thread pool size for FastAPI/AnyIO blocking calls. By default (when set to
0
) FastAPI/AnyIO use40
threads. In case of large instances and many concurrent users, it may be needed to increaseTHREAD_POOL_SIZE
to prevent blocking.
SHOW_ADMIN_DETAILS
โ
- Type:
bool
- Default:
True
- Description: Toggles whether to show admin user details in the interface.
- Persistence: This environment variable is a
PersistentConfig
variable.
ADMIN_EMAIL
โ
- Type:
str
- Description: Sets the admin email shown by
SHOW_ADMIN_DETAILS
- Persistence: This environment variable is a
PersistentConfig
variable.
ENV
โ
- Type:
str
- Options:
dev
- Enables the FastAPI API documentation on/docs
prod
- Automatically configures several environment variables
- Default:
- Backend Default:
dev
- Docker Default:
prod
- Backend Default:
- Description: Environment setting.
ENABLE_PERSISTENT_CONFIG
โ
- Type:
bool
- Default:
True
- Description: If set to
False
, allPersistentConfig
variables are treated as regular variables.
CUSTOM_NAME
โ
- Type:
str
- Description: Sets
WEBUI_NAME
but polls api.openwebui.com for metadata.
WEBUI_NAME
โ
- Type:
str
- Default:
Open WebUI
- Description: Sets the main WebUI name. Appends
(Open WebUI)
if overridden.
PORT
โ
- Type:
int
- Default:
8080
- Description: Sets the port to run Open WebUI from.
If you're running the application via Python and using the open-webui serve
command, you cannot set the port using the PORT
configuration. Instead, you must specify it directly as a command-line argument using the --port
flag. For example:
open-webui serve --port 9999
This will run the Open WebUI on port 9999
. The PORT
environment variable is disregarded in this mode.
ENABLE_REALTIME_CHAT_SAVE
โ
- Type:
bool
- Default:
False
- Description: When enabled, the system saves each chunk of streamed chat data to the database in real time to ensure maximum data persistency. This feature provides robust data recovery and allows accurate session tracking. However, the tradeoff is increased latency, as saving to the database introduces a delay. Disabling this feature can improve performance and reduce delays, but it risks potential data loss in the event of a system failure or crash. Use based on your application's requirements and acceptable tradeoffs.
BYPASS_MODEL_ACCESS_CONTROL
โ
- Type:
bool
- Default:
False
- Description: Bypasses model access control.
WEBUI_BUILD_HASH
โ
- Type:
str
- Default:
dev-build
- Description: Used for identifying the Git SHA of the build for releases.
WEBUI_BANNERS
โ
- Type:
list
ofdict
- Default:
[]
- Description: List of banners to show to users. The format for banners are:
[{"id": "string", "type": "string [info, success, warning, error]", "title": "string", "content": "string", "dismissible": false, "timestamp": 1000}]
- Persistence: This environment variable is a
PersistentConfig
variable.
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:
WEBUI_BANNERS="[{\"id\": \"1\", \"type\": \"warning\", \"title\": \"Your messages are stored.\", \"content\": \"Your messages are stored and may be reviewed by human people. LLM's are prone to hallucinations, check sources.\", \"dismissible\": true, \"timestamp\": 1000}]"
USE_CUDA_DOCKER
โ
- Type:
bool
- Default:
False
- Description: Builds the Docker image with NVIDIA CUDA support. Enables GPU acceleration for local Whisper and embeddings.
EXTERNAL_PWA_MANIFEST_URL
โ
- Type:
str
- Default: Empty string (' '), since
None
is set as default. - Description: When defined as a fully qualified URL (e.g., https://path/to/manifest.webmanifest), requests sent to /manifest.json will use the external manifest file. When not defined, the default manifest.json file will be used.
ENABLE_TITLE_GENERATION
โ
- Type:
bool
- Default:
True
- Description: Enables or disables chat title generation.
- Persistence: This environment variable is a
PersistentConfig
variable.
LICENSE_KEY
โ
- Type:
str
- Default:
None
- Description: Specifies the license key to use (for Enterprise users only).
- Persistence: This environment variable is a
PersistentConfig
variable.
SSL_ASSERT_FINGERPRINT
โ
- Type:
str
- Default: Empty string (' '), since
None
is set as default. - Description: Specifies the SSL assert fingerprint to use.
- Persistence: This environment variable is a
PersistentConfig
variable.
DEFAULT_PROMPT_SUGGESTIONS
โ
- Type:
list
ofdict
- Default:
[]
(which means to use the built-in default prompt suggestions) - Description: List of prompt suggestions. The format for prompt suggestions are:
[{"title": ["Title part 1", "Title part 2"], "content": "prompt"}]
AIOHTTP Clientโ
AIOHTTP_CLIENT_TIMEOUT
โ
- Type:
int
- Default:
300
- Description: Specifies the timeout duration in seconds for the AIOHTTP client. This impacts things such as connections to Ollama and OpenAI endpoints.
This is the maximum amount of time the client will wait for a response before timing out.
If set to an empty string (' '), the timeout will be set to None
, effectively disabling the timeout and
allowing the client to wait indefinitely.
AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST
โ
- Type:
int
- Default:
10
- Description: Sets the timeout in seconds for fetching the model list. This can be useful in cases where network latency requires a longer timeout duration to successfully retrieve the model list.
The AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST is set to 10 seconds by default to help ensure that all necessary connections are available when opening the web UI. This duration allows enough time for retrieving the model list even in cases of higher network latency. You can lower this value if quicker timeouts are preferred, but keep in mind that doing so may lead to some connections being dropped, depending on your network conditions.
AIOHTTP_CLIENT_TIMEOUT_OPENAI_MODEL_LIST
โ
- Type:
int
- Description: Sets the timeout in seconds for fetching the model list. This can be useful in cases where network latency requires a longer timeout duration to successfully retrieve the model list.
Directoriesโ
DATA_DIR
โ
- Type:
str
- Default:
./data
- Description: Specifies the base directory for data storage, including uploads, cache, vector database, etc.
FONTS_DIR
โ
- Type:
str
- Description: Specifies the directory for fonts.
FRONTEND_BUILD_DIR
โ
- Type:
str
- Default:
../build
- Description: Specifies the location of the built frontend files.
STATIC_DIR
โ
- Type:
str
- Default:
./static
- Description: Specifies the directory for static files, such as the favicon.
Ollamaโ
ENABLE_OLLAMA_API
โ
- Type:
bool
- Default:
True
- Description: Enables the use of Ollama APIs.
- Persistence: This environment variable is a
PersistentConfig
variable.
OLLAMA_BASE_URL
(OLLAMA_API_BASE_URL
is deprecated)โ
- Type:
str
- Default:
http://localhost:11434
- Docker Default:
- If
K8S_FLAG
is set:http://ollama-service.open-webui.svc.cluster.local:11434
- If
USE_OLLAMA_DOCKER=True
:http://localhost:11434
- Else
http://host.docker.internal:11434
- If
- Description: Configures the Ollama backend URL.
OLLAMA_BASE_URLS
โ
- Type:
str
- Description: Configures load-balanced Ollama backend hosts, separated by
;
. SeeOLLAMA_BASE_URL
. Takes precedence overOLLAMA_BASE_URL
. - Example:
http://host-one:11434;http://host-two:11434
- Persistence: This environment variable is a
PersistentConfig
variable.
USE_OLLAMA_DOCKER
โ
- Type:
bool
- Default:
False
- Description: Builds the Docker image with a bundled Ollama instance.
K8S_FLAG
โ
- Type:
bool
- Default:
False
- Description: If set, assumes Helm chart deployment and sets
OLLAMA_BASE_URL
tohttp://ollama-service.open-webui.svc.cluster.local:11434
OpenAIโ
ENABLE_OPENAI_API
โ
- Type:
bool
- Default:
True
- Description: Enables the use of OpenAI APIs.
- Persistence: This environment variable is a
PersistentConfig
variable.
OPENAI_API_BASE_URL
โ
- Type:
str
- Default:
https://api.openai.com/v1
- Description: Configures the OpenAI base API URL.
- Persistence: This environment variable is a
PersistentConfig
variable.
OPENAI_API_BASE_URLS
โ
- Type:
str
- Description: Supports balanced OpenAI base API URLs, semicolon-separated.
- Example:
http://host-one:11434;http://host-two:11434
- Persistence: This environment variable is a
PersistentConfig
variable.
OPENAI_API_KEY
โ
- Type:
str
- Description: Sets the OpenAI API key.
- Example:
sk-124781258123
- Persistence: This environment variable is a
PersistentConfig
variable.
OPENAI_API_KEYS
โ
- Type:
str
- Description: Supports multiple OpenAI API keys, semicolon-separated.
- Example:
sk-124781258123;sk-4389759834759834
- Persistence: This environment variable is a
PersistentConfig
variable.
Tasksโ
TASK_MODEL
โ
- Type:
str
- Description: The default model to use for tasks such as title and web search query generation when using Ollama models.
- Persistence: This environment variable is a
PersistentConfig
variable.
TASK_MODEL_EXTERNAL
โ
- Type:
str
- Description: The default model to use for tasks such as title and web search query generation when using OpenAI-compatible endpoints.
- Persistence: This environment variable is a
PersistentConfig
variable.
TITLE_GENERATION_PROMPT_TEMPLATE
โ
- Type:
str
- Description: Prompt to use when generating chat titles.
- Default: The value of
DEFAULT_TITLE_GENERATION_PROMPT_TEMPLATE
environment variable.
DEFAULT_TITLE_GENERATION_PROMPT_TEMPLATE
:
### Task:
Generate a concise, 3-5 word title with an emoji summarizing the chat history.
### Guidelines:
- The title should clearly represent the main theme or subject of the conversation.
- Use emojis that enhance understanding of the topic, but avoid quotation marks or special formatting.
- Write the title in the chat's primary language; default to English if multilingual.
- Prioritize accuracy over excessive creativity; keep it clear and simple.
### Output:
JSON format: { "title": "your concise title here" }
### Examples:
- { "title": "๐ Stock Market Trends" },
- { "title": "๐ช Perfect Chocolate Chip Recipe" },
- { "title": "Evolution of Music Streaming" },
- { "title": "Remote Work Productivity Tips" },
- { "title": "Artificial Intelligence in Healthcare" },
- { "title": "๐ฎ Video Game Development Insights" }
### Chat History:
<chat_history>
{{MESSAGES:END:2}}
</chat_history>
- Persistence: This environment variable is a
PersistentConfig
variable.
ENABLE_FOLLOW_UP_GENERATION
โ
- Type:
bool
- Default:
True
- Description: Enables or disables follow up generation.
- Persistence: This environment variable is a
PersistentConfig
variable.
FOLLOW_UP_GENERATION_PROMPT_TEMPLATE
โ
- Type:
str
- Description: Prompt to use for generating several relevant follow-up questions.
- Default: The value of
DEFAULT_FOLLOW_UP_GENERATION_PROMPT_TEMPLATE
environment variable.
DEFAULT_FOLLOW_UP_GENERATION_PROMPT_TEMPLATE
:
### Task:
Suggest 3-5 relevant follow-up questions or prompts that the user might naturally ask next in this conversation as a **user**, based on the chat history, to help continue or deepen the discussion.
### Guidelines:
- Write all follow-up questions from the userโs point of view, directed to the assistant.
- Make questions concise, clear, and directly related to the discussed topic(s).
- Only suggest follow-ups that make sense given the chat content and do not repeat what was already covered.
- If the conversation is very short or not specific, suggest more general (but relevant) follow-ups the user might ask.
- Use the conversation's primary language; default to English if multilingual.
- Response must be a JSON array of strings, no extra text or formatting.
### Output:
JSON format: { "follow_ups": ["Question 1?", "Question 2?", "Question 3?"] }
### Chat History:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>"
- Persistence: This environment variable is a
PersistentConfig
variable.
TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
โ
- Type:
str
- Description: Prompt to use when calling tools.
- Default: The value of
DEFAULT_TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
environment variable.
DEFAULT_TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
:
Available Tools: {{TOOLS}}
Your task is to choose and return the correct tool(s) from the list of available tools based on the query. Follow these guidelines:
- Return only the JSON object, without any additional text or explanation.
- If no tools match the query, return an empty array:
{
"tool_calls": []
}
- If one or more tools match the query, construct a JSON response containing a "tool_calls" array with objects that include:
- "name": The tool's name.
- "parameters": A dictionary of required parameters and their corresponding values.
The format for the JSON response is strictly:
{
"tool_calls": [
{"name": "toolName1", "parameters": {"key1": "value1"}},
{"name": "toolName2", "parameters": {"key2": "value2"}}
]
}
- Persistence: This environment variable is a
PersistentConfig
variable.
Code Executionโ
ENABLE_CODE_EXECUTION
โ
- Type:
bool
- Default:
True
- Description: Enables or disables code execution.
- Persistence: This environment variable is a
PersistentConfig
variable.
CODE_EXECUTION_ENGINE
โ
- Type:
str
- Default:
pyodide
- Description: Specifies the code execution engine to use.
- Persistence: This environment variable is a
PersistentConfig
variable.
CODE_EXECUTION_JUPYTER_URL
โ
- Type:
str
- Default:
None
- Description: Specifies the Jupyter URL to use for code execution.
- Persistence: This environment variable is a
PersistentConfig
variable.
CODE_EXECUTION_JUPYTER_AUTH
โ
- Type:
str
- Default:
None
- Description: Specifies the Jupyter authentication method to use for code execution.
- Persistence: This environment variable is a
PersistentConfig
variable.
CODE_EXECUTION_JUPYTER_AUTH_TOKEN
โ
- Type:
str
- Default:
None
- Description: Specifies the Jupyter authentication token to use for code execution.
- Persistence: This environment variable is a
PersistentConfig
variable.
CODE_EXECUTION_JUPYTER_AUTH_PASSWORD
โ
- Type:
str
- Default:
None
- Description: Specifies the Jupyter authentication password to use for code execution.
- Persistence: This environment variable is a
PersistentConfig
variable.
CODE_EXECUTION_JUPYTER_TIMEOUT
โ
- Type:
str
- Default: Empty string (' '), since
None
is set as default. - Description: Specifies the timeout for Jupyter code execution.
- Persistence: This environment variable is a
PersistentConfig
variable.
Code Interpreterโ
ENABLE_CODE_INTERPRETER
โ
- Type:
bool
- Default:
True
- Description: Enables or disables code interpreter.
- Persistence: This environment variable is a
PersistentConfig
variable.
CODE_INTERPRETER_ENGINE
โ
- Type:
str
- Default:
pyodide
- Description: Specifies the code interpreter engine to use.
- Persistence: This environment variable is a
PersistentConfig
variable.
CODE_INTERPRETER_PROMPT_TEMPLATE
โ
- Type:
str
- Default:
None
- Description: Specifies the prompt template to use for code interpreter.
- Persistence: This environment variable is a
PersistentConfig
variable.
CODE_INTERPRETER_JUPYTER_URL
โ
- Type:
str
- Default: Empty string (' '), since
None
is set as default. - Description: Specifies the Jupyter URL to use for code interpreter.
- Persistence: This environment variable is a
PersistentConfig
variable.
CODE_INTERPRETER_JUPYTER_AUTH
โ
- Type:
str
- Default: Empty string (' '), since
None
is set as default. - Description: Specifies the Jupyter authentication method to use for code interpreter.
- Persistence: This environment variable is a
PersistentConfig
variable.
CODE_INTERPRETER_JUPYTER_AUTH_TOKEN
โ
- Type:
str
- Default: Empty string (' '), since
None
is set as default. - Description: Specifies the Jupyter authentication token to use for code interpreter.
- Persistence: This environment variable is a
PersistentConfig
variable.
CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD
โ
- Type:
str
- Default: Empty string (' '), since
None
is set as default. - Description: Specifies the Jupyter authentication password to use for code interpreter.
- Persistence: This environment variable is a
PersistentConfig
variable.
CODE_INTERPRETER_JUPYTER_TIMEOUT
โ
- Type:
str
- Default: Empty string (' '), since
None
is set as default. - Description: Specifies the timeout for the Jupyter code interpreter.
- Persistence: This environment variable is a
PersistentConfig
variable.
Direct Connections (OpenAPI/MCPO Tool Servers)โ
ENABLE_DIRECT_CONNECTIONS
โ
- Type:
bool
- Default:
True
- Description: Enables or disables direct connections.
- Persistence: This environment variable is a
PersistentConfig
variable.
Autocompleteโ
ENABLE_AUTOCOMPLETE_GENERATION
โ
- Type:
bool
- Default:
True
- Description: Enables or disables autocomplete generation.
- Persistence: This environment variable is a
PersistentConfig
variable.
When enabling ENABLE_AUTOCOMPLETE_GENERATION
, ensure that you also configure AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH
and AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE
accordingly.
AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH
โ
- Type:
int
- Default:
-1
- Description: Sets the maximum input length for autocomplete generation.
- Persistence: This environment variable is a
PersistentConfig
variable.
AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE
โ
- Type:
str
- Default: The value of the
DEFAULT_AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE
environment variable.
DEFAULT_AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE
:
### Task:
You are an autocompletion system. Continue the text in `<text>` based on the **completion type** in `<type>` and the given language.
### **Instructions**:
1. Analyze `<text>` for context and meaning.
2. Use `<type>` to guide your output:
- **General**: Provide a natural, concise continuation.
- **Search Query**: Complete as if generating a realistic search query.
3. Start as if you are directly continuing `<text>`. Do **not** repeat, paraphrase, or respond as a model. Simply complete the text.
4. Ensure the continuation:
- Flows naturally from `<text>`.
- Avoids repetition, overexplaining, or unrelated ideas.
5. If unsure, return: `{ "text": "" }`.
### **Output Rules**:
- Respond only in JSON format: `{ "text": "<your_completion>" }`.
### **Examples**:
#### Example 1:
Input:
<type>General</type>
<text>The sun was setting over the horizon, painting the sky</text>
Output:
{ "text": "with vibrant shades of orange and pink." }
#### Example 2:
Input:
<type>Search Query</type>
<text>Top-rated restaurants in</text>
Output:
{ "text": "New York City for Italian cuisine." }
---
### Context:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>
<type>{{TYPE}}</type>
<text>{{PROMPT}}</text>
#### Output:
- Description: Sets the prompt template for autocomplete generation.
- Persistence: This environment variable is a
PersistentConfig
variable.
Evaluation Arena Modelโ
ENABLE_EVALUATION_ARENA_MODELS
โ
- Type:
bool
- Default:
True
- Description: Enables or disables evaluation arena models.
- Persistence: This environment variable is a
PersistentConfig
variable.
ENABLE_MESSAGE_RATING
โ
- Type:
bool
- Default:
True
- Description: Enables message rating feature.
- Persistence: This environment variable is a
PersistentConfig
variable.
ENABLE_COMMUNITY_SHARING
โ
- Type:
bool
- Default:
True
- Description: Controls whether users are shown the share to community button.
- Persistence: This environment variable is a
PersistentConfig
variable.
Tags Generationโ
ENABLE_TAGS_GENERATION
โ
- Type:
bool
- Default:
True
- Description: Enables or disables tag generation.
- Persistence: This environment variable is a
PersistentConfig
variable.
TAGS_GENERATION_PROMPT_TEMPLATE
โ
- Type:
str
- Default: The value of
DEFAULT_TAGS_GENERATION_PROMPT_TEMPLATE
environment variable.
DEFAULT_TAGS_GENERATION_PROMPT_TEMPLATE
:
### Task:
Generate 1-3 broad tags categorizing the main themes of the chat history, along with 1-3 more specific subtopic tags.
### Guidelines:
- Start with high-level domains (e.g. Science, Technology, Philosophy, Arts, Politics, Business, Health, Sports, Entertainment, Education)
- Consider including relevant subfields/subdomains if they are strongly represented throughout the conversation
- If content is too short (less than 3 messages) or too diverse, use only ["General"]
- Use the chat's primary language; default to English if multilingual
- Prioritize accuracy over specificity
### Output:
JSON format: { "tags": ["tag1", "tag2", "tag3"] }
### Chat History:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>
- Description: Sets the prompt template for tag generation.
- Persistence: This environment variable is a
PersistentConfig
variable.
API Key Endpoint Restrictionsโ
ENABLE_API_KEY
โ
- Type:
bool
- Default:
True
- Description: Enables API key authentication.
- Persistence: This environment variable is a
PersistentConfig
variable.
ENABLE_API_KEY_ENDPOINT_RESTRICTIONS
โ
- Type:
bool
- Default:
False
- Description: Enables API key endpoint restrictions for added security and configurability.
- Persistence: This environment variable is a
PersistentConfig
variable.
API_KEY_ALLOWED_ENDPOINTS
โ
- Type:
str
- Description: Specifies a comma-separated list of allowed API endpoints when API key endpoint restrictions are enabled.
- Persistence: This environment variable is a
PersistentConfig
variable.
The value of API_KEY_ALLOWED_ENDPOINTS
should be a comma-separated list of endpoint URLs, such as /api/v1/messages, /api/v1/channels
.
JWT_EXPIRES_IN
โ
- Type:
int
- Default:
-1
- Description: Sets the JWT expiration time in seconds. Valid time units:
s
,m
,h
,d
,w
or-1
for no expiration. - Persistence: This environment variable is a
PersistentConfig
variable.
Security Variablesโ
ENABLE_FORWARD_USER_INFO_HEADERS
โ
- type:
bool
- Default:
False
- Description: Forwards user information (name, ID, email, and role) as X-headers to OpenAI API and Ollama API.
If enabled, the following headers are forwarded:
X-OpenWebUI-User-Name
X-OpenWebUI-User-Id
X-OpenWebUI-User-Email
X-OpenWebUI-User-Role
ENABLE_WEB_LOADER_SSL_VERIFICATION
โ
- Type:
bool
- Default:
True
- Description: Bypass SSL Verification for RAG on Websites.
- Persistence: This environment variable is a
PersistentConfig
variable.
WEBUI_SESSION_COOKIE_SAME_SITE
โ
- Type:
str
- Options:
lax
- Sets theSameSite
attribute to lax, allowing session cookies to be sent with requests initiated by third-party websites.strict
- Sets theSameSite
attribute to strict, blocking session cookies from being sent with requests initiated by third-party websites.none
- Sets theSameSite
attribute to none, allowing session cookies to be sent with requests initiated by third-party websites, but only over HTTPS.
- Default:
lax
- Description: Sets the
SameSite
attribute for session cookies.
When ENABLE_OAUTH_SIGNUP
is enabled, setting WEBUI_SESSION_COOKIE_SAME_SITE
to strict
can cause login failures. This is because Open WebUI uses a session cookie to validate the callback from the OAuth provider, which helps prevent CSRF attacks.
However, a strict
session cookie is not sent with the callback request, leading to potential login issues. If you experience this problem, use the default lax
value instead.
WEBUI_SESSION_COOKIE_SECURE
โ
- Type:
bool
- Default:
False
- Description: Sets the
Secure
attribute for session cookies if set toTrue
.
WEBUI_AUTH_COOKIE_SAME_SITE
โ
- Type:
str
- Options:
lax
- Sets theSameSite
attribute to lax, allowing auth cookies to be sent with requests initiated by third-party websites.strict
- Sets theSameSite
attribute to strict, blocking auth cookies from being sent with requests initiated by third-party websites.none
- Sets theSameSite
attribute to none, allowing auth cookies to be sent with requests initiated by third-party websites, but only over HTTPS.
- Default:
lax
- Description: Sets the
SameSite
attribute for auth cookies.
If the value is not set, WEBUI_SESSION_COOKIE_SAME_SITE
will be used as a fallback.
WEBUI_AUTH_COOKIE_SECURE
โ
- Type:
bool
- Default:
False
- Description: Sets the
Secure
attribute for auth cookies if set toTrue
.
If the value is not set, WEBUI_SESSION_COOKIE_SECURE
will be used as a fallback.
WEBUI_AUTH
โ
- Type:
bool
- Default:
True
- Description: This setting enables or disables authentication.
If set to False
, authentication will be disabled for your Open WebUI instance. However, it's
important to note that turning off authentication is only possible for fresh installations without
any existing users. If there are already users registered, you cannot disable authentication
directly. Ensure that no users are present in the database if you intend to turn off WEBUI_AUTH
.
WEBUI_SECRET_KEY
โ
- Type:
str
- Default:
t0p-s3cr3t
- Docker Default: Randomly generated on first start
- Description: Overrides the randomly generated string used for JSON Web Token.
When deploying Open-WebUI in a multi-node/worker cluster with a load balancer, you must ensure that the WEBUI_SECRET_KEY value is the same across all instances in order to enable users to continue working if a node is recycled or their session is transferred to a different node. Without it, they will need to sign in again each time the underlying node changes.
OFFLINE_MODE
โ
- Type:
bool
- Default:
False
- Description: Disables Open WebUI's network connections for update checks and automatic model downloads.
Disabled when enabled:
- Automatic version update checks
- Downloads of embedding models from Hugging Face Hub
- If you did not download an embedding model prior to activating
OFFLINE_MODE
any RAG, web search and document analysis functionality may not work properly
- If you did not download an embedding model prior to activating
- Update notifications in the UI
Still functional:
- External LLM API connections (OpenAI, etc.)
- OAuth authentication providers
- Web search and RAG with external APIs
RESET_CONFIG_ON_START
โ
- Type:
bool
- Default:
False
- Description: Resets the
config.json
file on startup.
SAFE_MODE
โ
- Type:
bool
- Default:
False
- Description: Enables safe mode, which disables potentially unsafe features, deactivating all functions.
CORS_ALLOW_ORIGIN
โ
- Type:
str
- Default:
*
- Description: Sets the allowed origins for Cross-Origin Resource Sharing (CORS).
RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE
โ
- Type:
bool
- Default:
False
- Description: Determines whether to allow custom models defined on the Hub in their own modeling files.
RAG_RERANKING_MODEL_TRUST_REMOTE_CODE
โ
- Type:
bool
- Default:
False
- Description: Determines whether to allow custom models defined on the Hub in their own. modeling files for reranking.
RAG_EMBEDDING_MODEL_AUTO_UPDATE
โ
- Type:
bool
- Default:
True
- Description: Toggles automatic update of the Sentence-Transformer model.
RAG_RERANKING_MODEL_AUTO_UPDATE
โ
- Type:
bool
- Default:
True
- Description: Toggles automatic update of the reranking model.
Vector Databaseโ
VECTOR_DB
โ
- Type:
str
- Options:
chroma
,elasticsearch
,milvus
,opensearch
,pgvector
,qdrant
,pinecone
- Default:
chroma
- Description: Specifies which vector database system to use. This setting determines which vector storage system will be used for managing embeddings.
ChromaDBโ
CHROMA_TENANT
โ
- Type:
str
- Default: The value of
chromadb.DEFAULT_TENANT
(a constant in thechromadb
module) - Description: Sets the tenant for ChromaDB to use for RAG embeddings.
CHROMA_DATABASE
โ
- Type:
str
- Default: The value of
chromadb.DEFAULT_DATABASE
(a constant in thechromadb
module) - Description: Sets the database in the ChromaDB tenant to use for RAG embeddings.
CHROMA_HTTP_HOST
โ
- Type:
str
- Description: Specifies the hostname of a remote ChromaDB Server. Uses a local ChromaDB instance if not set.
CHROMA_HTTP_PORT
โ
- Type:
int
- Default:
8000
- Description: Specifies the port of a remote ChromaDB Server.
CHROMA_HTTP_HEADERS
โ
- Type:
str
- Description: A comma-separated list of HTTP headers to include with every ChromaDB request.
- Example:
Authorization=Bearer heuhagfuahefj,User-Agent=OpenWebUI
.
CHROMA_HTTP_SSL
โ
- Type:
bool
- Default:
False
- Description: Controls whether or not SSL is used for ChromaDB Server connections.
CHROMA_CLIENT_AUTH_PROVIDER
โ
- Type:
str
- Description: Specifies an authentication provider for remote ChromaDB Server.
- Example:
chromadb.auth.basic_authn.BasicAuthClientProvider
CHROMA_CLIENT_AUTH_CREDENTIALS
โ
- Type:
str
- Description: Specifies auth credentials for remote ChromaDB Server.
- Example:
username:password
Elasticsearchโ
ELASTICSEARCH_API_KEY
โ
- Type:
str
- Default: Empty string (' '), since
None
is set as default. - Description: Specifies the Elasticsearch API key.
- Persistence: This environment variable is a
PersistentConfig
variable.
ELASTICSEARCH_CA_CERTS
โ
- Type:
str
- Default: Empty string (' '), since
None
is set as default. - Description: Specifies the path to the CA certificates for Elasticsearch.
- Persistence: This environment variable is a
PersistentConfig
variable.
ELASTICSEARCH_CLOUD_ID
โ
- Type:
str
- Default: Empty string (' '), since
None
is set as default. - Description: Specifies the Elasticsearch cloud ID.
- Persistence: This environment variable is a
PersistentConfig
variable.
ELASTICSEARCH_INDEX_PREFIX
โ
- Type:
str
- Default:
open_webui_collections
- Description: Specifies the prefix for the Elasticsearch index.
- Persistence: This environment variable is a
PersistentConfig
variable.
ELASTICSEARCH_PASSWORD
โ
- Type:
str
- Default: Empty string (' '), since
None
is set as default. - Description: Specifies the password for Elasticsearch.
- Persistence: This environment variable is a
PersistentConfig
variable.
ELASTICSEARCH_URL
โ
- Type:
str
- Default:
https://localhost:9200
- Description: Specifies the URL for the Elasticsearch instance.
- Persistence: This environment variable is a
PersistentConfig
variable.
ELASTICSEARCH_USERNAME
โ
- Type:
str
- Default: Empty string (' '), since
None
is set as default. - Description: Specifies the username for Elasticsearch.
- Persistence: This environment variable is a
PersistentConfig
variable.
Milvusโ
MILVUS_URI
โ
- Type:
str
- Default:
${DATA_DIR}/vector_db/milvus.db
- Description: Specifies the URI for connecting to the Milvus vector database. This can point to a local or remote Milvus server based on the deployment configuration.
MILVUS_DB
โ
- Type:
str
- Default:
default
- Description: Specifies the database to connect to within a Milvus instance.
MILVUS_TOKEN
โ
- Type:
str
- Default:
None
- Description: Specifies an optional connection token for Milvus.
MILVUS_INDEX_TYPE
โ
- Type:
str
- Default:
HNSW
- Options:
AUTOINDEX
,FLAT
,IVF_FLAT
,HNSW
- Description: Specifies the index type to use when creating a new collection in Milvus.
AUTOINDEX
is generally recommended for Milvus standalone.HNSW
may offer better performance but typically requires a clustered Milvus setup. - Persistence: This environment variable is a
PersistentConfig
variable.
MILVUS_METRIC_TYPE
โ
- Type:
str
- Default:
COSINE
- Options:
COSINE
,IP
,L2
- Description: Specifies the metric type for vector similarity search in Milvus.
- Persistence: This environment variable is a
PersistentConfig
variable.
MILVUS_HNSW_M
โ
- Type:
int
- Default:
16
- Description: Specifies the
M
parameter for the HNSW index type in Milvus. This influences the number of bi-directional links created for each new element during construction. Only applicable ifMILVUS_INDEX_TYPE
isHNSW
. - Persistence: This environment variable is a
PersistentConfig
variable.
MILVUS_HNSW_EFCONSTRUCTION
โ
- Type:
int
- Default:
100
- Description: Specifies the
efConstruction
parameter for the HNSW index type in Milvus. This influences the size of the dynamic list for the nearest neighbors during index construction. Only applicable ifMILVUS_INDEX_TYPE
isHNSW
. - Persistence: This environment variable is a
PersistentConfig
variable.
MILVUS_IVF_FLAT_NLIST
โ
- Type:
int
- Default:
128
- Description: Specifies the
nlist
parameter for the IVF_FLAT index type in Milvus. This is the number of cluster units. Only applicable ifMILVUS_INDEX_TYPE
isIVF_FLAT
. - Persistence: This environment variable is a
PersistentConfig
variable.
OpenSearchโ
OPENSEARCH_CERT_VERIFY
โ
- Type:
bool
- Default:
False
- Description: Enables or disables OpenSearch certificate verification.
OPENSEARCH_PASSWORD
โ
- Type:
str
- Default:
None
- Description: Sets the password for OpenSearch.
OPENSEARCH_SSL
โ
- Type:
bool
- Default:
True
- Description: Enables or disables SSL for OpenSearch.
OPENSEARCH_URI
โ
- Type:
str
- Default:
https://localhost:9200
- Description: Sets the URI for OpenSearch.
OPENSEARCH_USERNAME
โ
- Type:
str
- Default:
None
- Description: Sets the username for OpenSearch.
PGVectorโ
PGVECTOR_DB_URL
โ
- Type:
str
- Default: The value of the
DATABASE_URL
environment variable - Description: Sets the database URL for model storage.
PGVECTOR_INITIALIZE_MAX_VECTOR_LENGTH
โ
- Type:
str
- Default:
1536
- Description: Specifies the maximum vector length for PGVector initialization.
Qdrantโ
QDRANT_API_KEY
โ
- Type:
str
- Description: Sets the API key for Qdrant.
QDRANT_URI
โ
- Type:
str
- Description: Sets the URI for Qdrant.
QDRANT_ON_DISK
โ
- Type:
bool
- Default:
False
- Description: Enable the usage of memmap(also known as on-disk) storage
QDRANT_PREFER_GRPC
โ
- Type:
bool
- Default:
False
- Description: Use gPRC interface whenever possible
QDRANT_GRPC_PORT
โ
- Type:
int
- Default:
6334
- Description: Sets the gRPC port number for Qdrant.
ENABLE_QDRANT_MULTITENANCY_MODE
โ
- Type:
bool
- Default:
False
- Description: Enables multitenancy pattern for Qdrant collections management, which significantly reduces RAM usage and computational overhead by consolidating similar vector data structures. Recommend turn on
This will disconect all Qdrant collections created in the previous pattern, which is non-multitenancy. Go to Admin Settings
> Documents
> Reindex Knowledge Base
to migrate existing knowledges.
The Qdrant collections created in the previous pattern will still consume resources.
Currently, there is no button in the UI to only reset the vector DB. If you want to migrate knowledge to multitenancy:
- Remove all collections with the
open_webui-knowledge
prefix (oropen_webui
prefix to remove all collections related to Open WebUI) using the native Qdrant client - Go to
Admin Settings
>Documents
>Reindex Knowledge Base
to migrate existing knowledge base
Reindex Knowledge Base
will ONLY migrate the knowledge base
If you decide to use the multitenancy pattern as your default and you don't need to migrate old knowledge, go to Admin Settings
> Documents
to reset vector and knowledge, which will delete all collections with the open_webui
prefix and all stored knowledge.
Pineconeโ
When using Pinecone as the vector store, the following environment variables are used to control its behavior. Make sure to set these variables in your .env
file or deployment environment.
PINECONE_API_KEY
โ
- Type:
str
- Default:
None
- Description: Sets the API key used to authenticate with the Pinecone service.
PINECONE_ENVIRONMENT
โ
- Type:
str
- Default:
None
- Description: Specifies the Pinecone environment to connect to (e.g.,
us-west1-gcp
,gcp-starter
, etc.).
PINECONE_INDEX_NAME
โ
- Type:
str
- Default:
open-webui-index
- Description: Defines the name of the Pinecone index that will be used to store and query vector embeddings.
PINECONE_DIMENSION
โ
- Type:
int
- Default:
1536
- Description: The dimensionality of the vector embeddings. Must match the dimension expected by the index (commonly 768, 1024, 1536, or 3072 based on model used).
PINECONE_METRIC
โ
- Type:
str
- Default:
cosine
- Options:
cosine
,dotproduct
,euclidean
- Description: Specifies the similarity metric to use for vector comparisons within the Pinecone index.
PINECONE_CLOUD
โ
- Type:
str
- Default:
aws
- Options:
aws
,gcp
,azure
- Description: Specifies the cloud provider where the Pinecone index is hosted.
RAG Content Extraction Engineโ
CONTENT_EXTRACTION_ENGINE
โ
- Type:
str
- Options:
- Leave empty to use default
external
- Use external loadertika
- Use a local Apache Tika serverdocling
- Use Docling enginedocument_intelligence
- Use Document Intelligence enginemistral_ocr
- Use Mistral OCR engine
- Description: Sets the content extraction engine to use for document ingestion.
- Persistence: This environment variable is a
PersistentConfig
variable.
MISTRAL_OCR_API_KEY
โ
- Type:
str
- Default:
None
- Description: Specifies the Mistral OCR API key to use.
- Persistence: This environment variable is a
PersistentConfig
variable.
EXTERNAL_DOCUMENT_LOADER_URL
โ
- Type:
str
- Default:
None
- Description: Sets the URL for the external document loader service.
- Persistence: This environment variable is a
PersistentConfig
variable.
EXTERNAL_DOCUMENT_LOADER_API_KEY
โ
- Type:
str
- Default:
None
- Description: Sets the API key for authenticating with the external document loader service.
- Persistence: This environment variable is a
PersistentConfig
variable.
TIKA_SERVER_URL
โ
- Type:
str
- Default:
http://localhost:9998
- Description: Sets the URL for the Apache Tika server.
- Persistence: This environment variable is a
PersistentConfig
variable.
DOCLING_SERVER_URL
โ
- Type:
str
- Default:
http://docling:5001
- Description: Specifies the URL for the Docling server.
- Persistence: This environment variable is a
PersistentConfig
variable.
DOCLING_OCR_ENGINE
โ
- Type:
str
- Default:
tesseract
- Description: Specifies the OCR engine used by Docling.
Supported values include:tesseract
(default),easyocr
,ocrmac
,rapidocr
, andtesserocr
. - Persistence: This environment variable is a
PersistentConfig
variable.
DOCLING_OCR_LANG
โ
- Type:
str
- Default:
eng,fra,deu,spa
(when using the defaulttesseract
engine) - Description: Specifies the OCR language(s) to be used with the configured
DOCLING_OCR_ENGINE
.
The format and available language codes depend on the selected OCR engine. - Persistence: This environment variable is a
PersistentConfig
variable.
Retrieval Augmented Generation (RAG)โ
RAG_EMBEDDING_ENGINE
โ
- Type:
str
- Options:
- Leave empty for
Default (SentenceTransformers)
- Uses SentenceTransformers for embeddings. ollama
- Uses the Ollama API for embeddings.openai
- Uses the OpenAI API for embeddings.
- Leave empty for
- Description: Selects an embedding engine to use for RAG.
- Persistence: This environment variable is a
PersistentConfig
variable.
RAG_EMBEDDING_MODEL
โ
- Type:
str
- Default:
sentence-transformers/all-MiniLM-L6-v2
- Description: Sets a model for embeddings. Locally, a Sentence-Transformer model is used.
- Persistence: This environment variable is a
PersistentConfig
variable.
ENABLE_RAG_HYBRID_SEARCH
โ
- Type:
bool
- Default:
False
- Description: Enables the use of ensemble search with
BM25
+ChromaDB
, with reranking usingsentence_transformers
models. - Persistence: This environment variable is a
PersistentConfig
variable.
RAG_TOP_K
โ
- Type:
int
- Default:
3
- Description: Sets the default number of results to consider for the embedding when using RAG.
- Persistence: This environment variable is a
PersistentConfig
variable.
RAG_TOP_K_RERANKER
โ
- Type:
int
- Default:
3
- Description: Sets the default number of results to consider for the reranker when using RAG.
- Persistence: This environment variable is a
PersistentConfig
variable.
RAG_RELEVANCE_THRESHOLD
โ
- Type:
float
- Default:
0.0
- Description: Sets the relevance threshold to consider for documents when used with reranking.
- Persistence: This environment variable is a
PersistentConfig
variable.
RAG_HYBRID_BM25_WEIGHT
โ
- Type:
float
- Default:
0.5
- Description: Sets the weight given to the keyword search (BM25) during hybrid search. 1 means only keyword serach, 0 means only vector search.
- Persistence: This environment variable is a
PersistentConfig
variable.
RAG_TEMPLATE
โ
- Type:
str
- Default: The value of
DEFAULT_RAG_TEMPLATE
environment variable.
DEFAULT_RAG_TEMPLATE
:
### Task:
Respond to the user query using the provided context, incorporating inline citations in the format [id] **only when the <source> tag includes an explicit id attribute** (e.g., <source id="1">).
### Guidelines:
- If you don't know the answer, clearly state that.
- If uncertain, ask the user for clarification.
- Respond in the same language as the user's query.
- If the context is unreadable or of poor quality, inform the user and provide the best possible answer.
- If the answer isn't present in the context but you possess the knowledge, explain this to the user and provide the answer using your own understanding.
- **Only include inline citations using [id] (e.g., [1], [2]) when the <source> tag includes an id attribute.**
- Do not cite if the <source> tag does not contain an id attribute.
- Do not use XML tags in your response.
- Ensure citations are concise and directly related to the information provided.
### Example of Citation:
If the user asks about a specific topic and the information is found in a source with a provided id attribute, the response should include the citation like in the following example:
* "According to the study, the proposed method increases efficiency by 20% [1]."
### Output:
Provide a clear and direct response to the user's query, including inline citations in the format [id] only when the <source> tag with id attribute is present in the context.
<context>
{{CONTEXT}}
</context>
<user_query>
{{QUERY}}
</user_query>
- Description: Template to use when injecting RAG documents into chat completion
- Persistence: This environment variable is a
PersistentConfig
variable.
RAG_TEXT_SPLITTER
โ
- Type:
str
- Options:
character
token
- Default:
character
- Description: Sets the text splitter for RAG models.
- Persistence: This environment variable is a
PersistentConfig
variable.
TIKTOKEN_CACHE_DIR
โ
- Type:
str
- Default:
{CACHE_DIR}/tiktoken
- Description: Sets the directory for TikToken cache.
TIKTOKEN_ENCODING_NAME
โ
- Type:
str
- Default:
cl100k_base
- Description: Sets the encoding name for TikToken.
- Persistence: This environment variable is a
PersistentConfig
variable.
CHUNK_SIZE
โ
- Type:
int
- Default:
1000
- Description: Sets the document chunk size for embeddings.
- Persistence: This environment variable is a
PersistentConfig
variable.
CHUNK_OVERLAP
โ
- Type:
int
- Default:
100
- Description: Specifies how much overlap there should be between chunks.
- Persistence: This environment variable is a
PersistentConfig
variable.
PDF_EXTRACT_IMAGES
โ
- Type:
bool
- Default:
False
- Description: Extracts images from PDFs using OCR when loading documents.
- Persistence: This environment variable is a
PersistentConfig
variable.
RAG_FILE_MAX_SIZE
โ
- Type:
int
- Description: Sets the maximum size of a file in megabytes that can be uploaded for document ingestion.
- Persistence: This environment variable is a
PersistentConfig
variable.
RAG_FILE_MAX_COUNT
โ
- Type:
int
- Description: Sets the maximum number of files that can be uploaded at once for document ingestion.
- Persistence: This environment variable is a
PersistentConfig
variable.
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.
RAG_ALLOWED_FILE_EXTENSIONS
โ
- Type:
list
ofstr
- Default:
[]
(which means all supported file types are allowed) - Description: Specifies which file extensions are permitted for upload.
["pdf,docx,txt"]
- Persistence: This environment variable is a
PersistentConfig
variable.
RAG_RERANKING_MODEL
โ
- Type:
str
- Description: Sets a model for reranking results. Locally, a Sentence-Transformer model is used.
- Persistence: This environment variable is a
PersistentConfig
variable.
RAG_OPENAI_API_BASE_URL
โ
- Type:
str
- Default:
${OPENAI_API_BASE_URL}
- Description: Sets the OpenAI base API URL to use for RAG embeddings.
- Persistence: This environment variable is a
PersistentConfig
variable.
RAG_OPENAI_API_KEY
โ
- Type:
str
- Default:
${OPENAI_API_KEY}
- Description: Sets the OpenAI API key to use for RAG embeddings.
- Persistence: This environment variable is a
PersistentConfig
variable.
RAG_EMBEDDING_OPENAI_BATCH_SIZE
โ
- Type:
int
- Default:
1
- Description: Sets the batch size for OpenAI embeddings.
RAG_EMBEDDING_BATCH_SIZE
โ
- Type:
int
- Default:
1
- Description: Sets the batch size for embedding in RAG (Retrieval-Augmented Generator) models.
- Persistence: This environment variable is a
PersistentConfig
variable.
RAG_OLLAMA_API_KEY
โ
- Type:
str
- Description: Sets the API key for Ollama API used in RAG models.
- Persistence: This environment variable is a
PersistentConfig
variable.
RAG_OLLAMA_BASE_URL
โ
- Type:
str
- Description: Sets the base URL for Ollama API used in RAG models.
- Persistence: This environment variable is a
PersistentConfig
variable.
ENABLE_RETRIEVAL_QUERY_GENERATION
โ
- Type:
bool
- Default:
True
- Description: Enables or disables retrieval query generation.
- Persistence: This environment variable is a
PersistentConfig
variable.
QUERY_GENERATION_PROMPT_TEMPLATE
โ
- Type:
str
- Default: The value of
DEFAULT_QUERY_GENERATION_PROMPT_TEMPLATE
environment variable.
DEFAULT_QUERY_GENERATION_PROMPT_TEMPLATE
:
### Task:
Analyze the chat history to determine the necessity of generating search queries, in the given language. By default, **prioritize generating 1-3 broad and relevant search queries** unless it is absolutely certain that no additional information is required. The aim is to retrieve comprehensive, updated, and valuable information even with minimal uncertainty. If no search is unequivocally needed, return an empty list.
### Guidelines:
- Respond **EXCLUSIVELY** with a JSON object. Any form of extra commentary, explanation, or additional text is strictly prohibited.
- When generating search queries, respond in the format: { "queries": ["query1", "query2"] }, ensuring each query is distinct, concise, and relevant to the topic.
- If and only if it is entirely certain that no useful results can be retrieved by a search, return: { "queries": [] }.
- Err on the side of suggesting search queries if there is **any chance** they might provide useful or updated information.
- Be concise and focused on composing high-quality search queries, avoiding unnecessary elaboration, commentary, or assumptions.
- Today's date is: {{CURRENT_DATE}}.
- Always prioritize providing actionable and broad queries that maximize informational coverage.
### Output:
Strictly return in JSON format:
{
"queries": ["query1", "query2"]
}
### Chat History:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>
- Description: Sets the prompt template for query generation.
- Persistence: This environment variable is a
PersistentConfig
variable.
BYPASS_EMBEDDING_AND_RETRIEVAL
โ
- Type:
bool
- Default:
False
- Description: Bypasses the embedding and retrieval process.
- Persistence: This environment variable is a
PersistentConfig
variable.
DOCUMENT_INTELLIGENCE_ENDPOINT
โ
- Type:
str
- Default:
None
- Description: Specifies the endpoint for document intelligence.
- Persistence: This environment variable is a
PersistentConfig
variable.
DOCUMENT_INTELLIGENCE_KEY
โ
- Type:
str
- Default:
None
- Description: Specifies the key for document intelligence.
- Persistence: This environment variable is a
PersistentConfig
variable.
ENABLE_RAG_LOCAL_WEB_FETCH
โ
- Type:
bool
- Default:
False
- Description: Enables or disables local web fetch for RAG.
- Persistence: This environment variable is a
PersistentConfig
variable.
RAG_EMBEDDING_CONTENT_PREFIX
โ
- Type:
str
- Default:
None
- Description: Specifies the prefix for the RAG embedding content.
- Persistence: This environment variable is a
PersistentConfig
variable.
RAG_EMBEDDING_PREFIX_FIELD_NAME
โ
- Type:
str
- Default:
None
- Description: Specifies the field name for the RAG embedding prefix.
- Persistence: This environment variable is a
PersistentConfig
variable.
RAG_EMBEDDING_QUERY_PREFIX
โ
- Type:
str
- Default:
None
- Description: Specifies the prefix for the RAG embedding query.
- Persistence: This environment variable is a
PersistentConfig
variable.
RAG_FULL_CONTEXT
โ
- Type:
bool
- Default:
False
- Description: Specifies whether to use the full context for RAG.
- Persistence: This environment variable is a
PersistentConfig
variable.
Google Driveโ
ENABLE_GOOGLE_DRIVE_INTEGRATION
โ
- Type:
bool
- Default:
False
- 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. - Persistence: This environment variable is a
PersistentConfig
variable.
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.
GOOGLE_DRIVE_CLIENT_ID
โ
- Type:
str
- Description: Sets the client ID for Google Drive (client must be configured with Drive API and Picker API enabled).
- Persistence: This environment variable is a
PersistentConfig
variable.
GOOGLE_DRIVE_API_KEY
โ
- Type:
str
- Description: Sets the API key for Google Drive integration.
- Persistence: This environment variable is a
PersistentConfig
variable.
OneDriveโ
ENABLE_ONEDRIVE_INTEGRATION
โ
- Type:
bool
- Default:
False
- Description: Enables or disables OneDrive integration.
- Persistence: This environment variable is a
PersistentConfig
variable.
ONEDRIVE_CLIENT_ID
โ
- Type:
str
- Default:
None
- Description: Specifies the client ID for OneDrive integration.
- Persistence: This environment variable is a
PersistentConfig
variable.
Web Searchโ
ENABLE_WEB_SEARCH
โ
- Type:
bool
- Default:
False
- Description: Enable web search toggle.
- Persistence: This environment variable is a
PersistentConfig
variable.
ENABLE_SEARCH_QUERY_GENERATION
โ
- Type:
bool
- Default:
True
- Description: Enables or disables search query generation.
- Persistence: This environment variable is a
PersistentConfig
variable.
WEB_SEARCH_TRUST_ENV
โ
- Type:
bool
- Default:
False
- Description: Enables proxy set by
http_proxy
andhttps_proxy
during web search content fetching. - Persistence: This environment variable is a
PersistentConfig
variable.
WEB_SEARCH_RESULT_COUNT
โ
- Type:
int
- Default:
3
- Description: Maximum number of search results to crawl.
- Persistence: This environment variable is a
PersistentConfig
variable.
WEB_SEARCH_CONCURRENT_REQUESTS
โ
- Type:
int
- Default:
10
- Description: Number of concurrent requests to crawl web pages returned from search results.
- Persistence: This environment variable is a
PersistentConfig
variable.
WEB_SEARCH_ENGINE
โ
- Type:
str
- Options:
searxng
- Uses the SearXNG search engine.google_pse
- Uses the Google Programmable Search Engine.brave
- Uses the Brave search engine.kagi
- Uses the Kagi search engine.mojeek
- Uses the Mojeek search engine.bocha
- Uses the Bocha search engine.serpstack
- Uses the Serpstack search engine.serper
- Uses the Serper search engine.serply
- Uses the Serply search engine.searchapi
- Uses the SearchAPI search engine.serpapi
- Uses the SerpApi search engine.duckduckgo
- Uses the DuckDuckGo search engine.tavily
- Uses the Tavily search engine.jina
- Uses the Jina search engine.bing
- Uses the Bing search engine.exa
- Uses the Exa search engine.perplexity
- Uses the Perplexity AI search engine.sougou
- Uses the Sougou search engine.
- Persistence: This environment variable is a
PersistentConfig
variable.
BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL
โ
- Type:
bool
- Default:
False
- Description: Bypasses the web search embedding and retrieval process.
- Persistence: This environment variable is a
PersistentConfig
variable.
SEARXNG_QUERY_URL
โ
- Type:
str
- Description: The SearXNG search API URL supporting JSON output.
<query>
is replaced with the search query. Example:http://searxng.local/search?q=<query>
- Persistence: This environment variable is a
PersistentConfig
variable.
GOOGLE_PSE_API_KEY
โ
- Type:
str
- Description: Sets the API key for the Google Programmable Search Engine (PSE) service.
- Persistence: This environment variable is a
PersistentConfig
variable.
GOOGLE_PSE_ENGINE_ID
โ
- Type:
str
- Description: The engine ID for the Google Programmable Search Engine (PSE) service.
- Persistence: This environment variable is a
PersistentConfig
variable.
BRAVE_SEARCH_API_KEY
โ
- Type:
str
- Description: Sets the API key for the Brave Search API.
- Persistence: This environment variable is a
PersistentConfig
variable.
KAGI_SEARCH_API_KEY
โ
- Type:
str
- Description: Sets the API key for Kagi Search API.
- Persistence: This environment variable is a
PersistentConfig
variable.
MOJEEK_SEARCH_API_KEY
โ
- Type:
str
- Description: Sets the API key for Mojeek Search API.
- Persistence: This environment variable is a
PersistentConfig
variable.
SERPSTACK_API_KEY
โ
- Type:
str
- Description: Sets the API key for Serpstack search API.
- Persistence: This environment variable is a
PersistentConfig
variable.
SERPSTACK_HTTPS
โ
- Type:
bool
- Default:
True
- Description: Configures the use of HTTPS for Serpstack requests. Free tier requests are restricted to HTTP only.
- Persistence: This environment variable is a
PersistentConfig
variable.
SERPER_API_KEY
โ
- Type:
str
- Description: Sets the API key for Serper search API.
- Persistence: This environment variable is a
PersistentConfig
variable.
SERPLY_API_KEY
โ
- Type:
str
- Description: Sets the API key for Serply search API.
- Persistence: This environment variable is a
PersistentConfig
variable.
SEARCHAPI_API_KEY
โ
- Type:
str
- Description: Sets the API key for SearchAPI.
- Persistence: This environment variable is a
PersistentConfig
variable.
SEARCHAPI_ENGINE
โ
- Type:
str
- Description: Sets the SearchAPI engine.
- Persistence: This environment variable is a
PersistentConfig
variable.
TAVILY_API_KEY
โ
- Type:
str
- Description: Sets the API key for Tavily search API.
- Persistence: This environment variable is a
PersistentConfig
variable.
JINA_API_KEY
โ
- Type:
str
- Description: Sets the API key for Jina.
- Persistence: This environment variable is a
PersistentConfig
variable.
BING_SEARCH_V7_ENDPOINT
โ
- Type:
str
- Description: Sets the endpoint for Bing Search API.
- Persistence: This environment variable is a
PersistentConfig
variable.
BING_SEARCH_V7_SUBSCRIPTION_KEY
โ
- Type:
str
- Default:
https://api.bing.microsoft.com/v7.0/search
- Description: Sets the subscription key for Bing Search API.
- Persistence: This environment variable is a
PersistentConfig
variable.
BOCHA_SEARCH_API_KEY
โ
- Type:
str
- Default:
None
- Description: Sets the API key for Bocha Search API.
- Persistence: This environment variable is a
PersistentConfig
variable.
EXA_API_KEY
โ
- Type:
str
- Default:
None
- Description: Sets the API key for Exa search API.
- Persistence: This environment variable is a
PersistentConfig
variable.
SERPAPI_API_KEY
โ
- Type:
str
- Default:
None
- Description: Sets the API key for SerpAPI.
- Persistence: This environment variable is a
PersistentConfig
variable.
SERPAPI_ENGINE
โ
- Type:
str
- Default:
None
- Description: Specifies the search engine to use for SerpAPI.
- Persistence: This environment variable is a
PersistentConfig
variable.
SOUGOU_API_SID
โ
- Type:
str
- Default:
None
- Description: Sets the Sogou API SID.
- Persistence: This environment variable is a
PersistentConfig
variable.
SOUGOU_API_SK
โ
- Type:
str
- Default:
None
- Description: Sets the Sogou API SK.
- Persistence: This environment variable is a
PersistentConfig
variable.
TAVILY_EXTRACT_DEPTH
โ
- Type:
str
- Default:
basic
- Description: Specifies the extract depth for Tavily search results.
- Persistence: This environment variable is a
PersistentConfig
variable.
Web Loader Configurationโ
WEB_LOADER_ENGINE
โ
- Type:
str
- Default:
safe_web
- Description: Specifies the loader to use for retrieving and processing web content.
- Options:
requests
- Uses the Requests module with enhanced error handling.playwright
- Uses Playwright for more advanced web page rendering and interaction.
- Persistence: This environment variable is a
PersistentConfig
variable.
When using playwright
, you have two options:
- If
PLAYWRIGHT_WS_URI
is not set, Playwright with Chromium dependencies will be automatically installed in the Open WebUI container on launch. - If
PLAYWRIGHT_WS_URI
is set, Open WebUI will connect to a remote browser instance instead of installing dependencies locally.
PLAYWRIGHT_WS_URL
โ
- Type:
str
- Default:
None
- Description: Specifies the WebSocket URI of a remote Playwright browser instance. When set, Open WebUI will use this remote browser instead of installing browser dependencies locally. This is particularly useful in containerized environments where you want to keep the Open WebUI container lightweight and separate browser concerns. Example:
ws://playwright:3000
- Persistence: This environment variable is a
PersistentConfig
variable.
Using a remote Playwright browser via PLAYWRIGHT_WS_URL
can be beneficial for:
- Reducing the size of the Open WebUI container
- Using a different browser other than the default Chromium
- Connecting to a non-headless (GUI) browser
FIRECRAWL_API_BASE_URL
โ
- Type:
str
- Default:
https://api.firecrawl.dev
- Description: Sets the base URL for Firecrawl API.
- Persistence: This environment variable is a
PersistentConfig
variable.
FIRECRAWL_API_KEY
โ
- Type:
str
- Default:
None
- Description: Sets the API key for Firecrawl API.
- Persistence: This environment variable is a
PersistentConfig
variable.
PERPLEXITY_API_KEY
โ
- Type:
str
- Default:
None
- Description: Sets the API key for Perplexity API.
- Persistence: This environment variable is a
PersistentConfig
variable.
PLAYWRIGHT_TIMEOUT
โ
- Type:
int
- Default: Empty string (' '), since
None
is set as default. - Description: Specifies the timeout for Playwright requests.
- Persistence: This environment variable is a
PersistentConfig
variable.
YouTube Loaderโ
YOUTUBE_LOADER_PROXY_URL
โ
- Type:
str
- Description: Sets the proxy URL for YouTube loader.
- Persistence: This environment variable is a
PersistentConfig
variable.
YOUTUBE_LOADER_LANGUAGE
โ
- Type:
str
- Default:
en
- Description: Comma-separated list of language codes to try when fetching YouTube video transcriptions, in priority order.
- Example: If set to
es,de
, Spanish transcriptions will be attempted first, then German if Spanish was not available, and lastly English. Note: If none of the specified languages are available anden
was not in your list, the system will automatically try English as a final fallback. - Persistence: This environment variable is a
PersistentConfig
variable.
Audioโ
Whisper Speech-to-Text (Local)โ
WHISPER_MODEL
โ
- Type:
str
- Default:
base
- Description: Sets the Whisper model to use for Speech-to-Text. The backend used is faster_whisper with quantization to
int8
. - Persistence: This environment variable is a
PersistentConfig
variable.
WHISPER_MODEL_DIR
โ
- Type:
str
- Default:
${DATA_DIR}/cache/whisper/models
- Description: Specifies the directory to store Whisper model files.
WHISPER_VAD_FILTER
โ
- Type:
bool
- Default:
False
- Description: Specifies whether to apply a Voice Activity Detection (VAD) filter to Whisper Speech-to-Text.
- Persistence: This environment variable is a
PersistentConfig
variable.
WHISPER_MODEL_AUTO_UPDATE
โ
- Type:
bool
- Default:
False
- Description: Toggles automatic update of the Whisper model.
WHISPER_LANGUAGE
โ
- Type:
str
- Default:
None
- Description: Specifies the ISO 639-1 language Whisper uses for STT (ISO 639-2 for Hawaiian and Cantonese). Whisper predicts the language by default.
Speech-to-Text (OpenAI)โ
AUDIO_STT_ENGINE
โ
- Type:
str
- Options:
- Leave empty to use the built-in local Whisper engine for Speech-to-Text.
openai
- Uses OpenAI engine for Speech-to-Text.deepgram
- Uses Deepgram engine for Speech-to-Text.azure
Uses Azure engine for Speech-to-Text.
- Description: Specifies the Speech-to-Text engine to use.
- Persistence: This environment variable is a
PersistentConfig
variable.
AUDIO_STT_MODEL
โ
- Type:
str
- Default:
whisper-1
- Description: Specifies the Speech-to-Text model to use for OpenAI-compatible endpoints.
- Persistence: This environment variable is a
PersistentConfig
variable.
AUDIO_STT_OPENAI_API_BASE_URL
โ
- Type:
str
- Default:
${OPENAI_API_BASE_URL}
- Description: Sets the OpenAI-compatible base URL to use for Speech-to-Text.
- Persistence: This environment variable is a
PersistentConfig
variable.
AUDIO_STT_OPENAI_API_KEY
โ
- Type:
str
- Default:
${OPENAI_API_KEY}
- Description: Sets the OpenAI API key to use for Speech-to-Text.
- Persistence: This environment variable is a
PersistentConfig
variable.
Speech-to-Text (Azure)โ
AUDIO_STT_AZURE_API_KEY
โ
- Type:
str
- Default:
None
- Description: Specifies the Azure API key to use for Speech-to-Text.
- Persistence: This environment variable is a
PersistentConfig
variable.
AUDIO_STT_AZURE_REGION
โ
- Type:
str
- Default:
None
- Description: Specifies the Azure region to use for Speech-to-Text.
- Persistence: This environment variable is a
PersistentConfig
variable.
AUDIO_STT_AZURE_LOCALES
โ
- Type:
str
- Default:
None
- Description: Specifies the locales to use for Azure Speech-to-Text.
- Persistence: This environment variable is a
PersistentConfig
variable.
Speech-to-Text (Deepgram)โ
DEEPGRAM_API_KEY
โ
- Type:
str
- Default:
None
- Description: Specifies the Deepgram API key to use for Speech-to-Text.
- Persistence: This environment variable is a
PersistentConfig
variable.
Text-to-Speechโ
AUDIO_TTS_API_KEY
โ
- Type:
str
- Description: Sets the API key for Text-to-Speech.
- Persistence: This environment variable is a
PersistentConfig
variable.
AUDIO_TTS_ENGINE
โ
- Type:
str
- Options:
- Leave empty to use the built-in WebAPI engine for Text-to-Speech.
azure
- Uses Azure engine for Text-to-Speech.elevenlabs
- Uses ElevenLabs engine for Text-to-Speechopenai
- Uses OpenAI engine for Text-to-Speech.transformers
- Uses SentenceTransformers for Text-to-Speech.
- Description: Specifies the Text-to-Speech engine to use.
- Persistence: This environment variable is a
PersistentConfig
variable.
AUDIO_TTS_MODEL
โ
- Type:
str
- Default:
tts-1
- Description: Specifies the OpenAI text-to-speech model to use.
- Persistence: This environment variable is a
PersistentConfig
variable.
AUDIO_TTS_VOICE
โ
- Type:
str
- Default:
alloy
- Description: Sets the OpenAI text-to-speech voice to use.
- Persistence: This environment variable is a
PersistentConfig
variable.
AUDIO_TTS_SPLIT_ON
โ
- Type:
str
- Default:
punctuation
- Description: Sets the OpenAI text-to-speech split on to use.
- Persistence: This environment variable is a
PersistentConfig
variable.
Azure Text-to-Speechโ
AUDIO_TTS_AZURE_SPEECH_REGION
โ
- Type:
str
- Description: Sets the region for Azure Text to Speech.
- Persistence: This environment variable is a
PersistentConfig
variable.
AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT
โ
- Type:
str
- Description: Sets the output format for Azure Text to Speech.
- Persistence: This environment variable is a
PersistentConfig
variable.
OpenAI Text-to-Speechโ
AUDIO_TTS_OPENAI_API_BASE_URL
โ
- Type:
str
- Default:
${OPENAI_API_BASE_URL}
- Description: Sets the OpenAI-compatible base URL to use for text-to-speech.
- Persistence: This environment variable is a
PersistentConfig
variable.
AUDIO_TTS_OPENAI_API_KEY
โ
- Type:
str
- Default:
${OPENAI_API_KEY}
- Description: Sets the API key to use for text-to-speech.
- Persistence: This environment variable is a
PersistentConfig
variable.
Image Generationโ
IMAGE_GENERATION_ENGINE
โ
- Type:
str
- Options:
openai
- Uses OpenAI DALL-E for image generation.comfyui
- Uses ComfyUI engine for image generation.automatic1111
- Uses AUTOMATIC1111 engine for image generation.gemini
- Uses Gemini for image generation.
- Default:
openai
- Description: Specifies the engine to use for image generation.
- Persistence: This environment variable is a
PersistentConfig
variable.
ENABLE_IMAGE_GENERATION
โ
- Type:
bool
- Default:
False
- Description: Enables or disables image generation features.
- Persistence: This environment variable is a
PersistentConfig
variable.
ENABLE_IMAGE_PROMPT_GENERATION
โ
- Type:
bool
- Default:
True
- Description: Enables or disables image prompt generation.
- Persistence: This environment variable is a
PersistentConfig
variable.
IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE
โ
- Type:
str
- Default:
None
- Description: Specifies the template to use for generating image prompts.
- Persistence: This environment variable is a
PersistentConfig
variable.
DEFAULT_IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE
:
### Task:
Generate a detailed prompt for am image generation task based on the given language and context. Describe the image as if you were explaining it to someone who cannot see it. Include relevant details, colors, shapes, and any other important elements.
### Guidelines:
- Be descriptive and detailed, focusing on the most important aspects of the image.
- Avoid making assumptions or adding information not present in the image.
- Use the chat's primary language; default to English if multilingual.
- If the image is too complex, focus on the most prominent elements.
### Output:
Strictly return in JSON format:
{
"prompt": "Your detailed description here."
}
### Chat History:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>
IMAGE_SIZE
โ
- Type:
str
- Default:
512x512
- Description: Sets the default image size to generate.
- Persistence: This environment variable is a
PersistentConfig
variable.
IMAGE_STEPS
โ
- Type:
int
- Default:
50
- Description: Sets the default iteration steps for image generation. Used for ComfyUI and AUTOMATIC1111.
- Persistence: This environment variable is a
PersistentConfig
variable.
IMAGE_GENERATION_MODEL
โ
- Type:
str
- Description: Default model to use for image generation
- Persistence: This environment variable is a
PersistentConfig
variable.
AUTOMATIC1111โ
AUTOMATIC1111_BASE_URL
โ
- Type:
str
- Description: Specifies the URL to AUTOMATIC1111's Stable Diffusion API.
- Persistence: This environment variable is a
PersistentConfig
variable.
AUTOMATIC1111_API_AUTH
โ
- Type:
str
- Description: Sets the AUTOMATIC1111 API authentication.
- Persistence: This environment variable is a
PersistentConfig
variable.
AUTOMATIC1111_CFG_SCALE
โ
- Type:
float
- Description: Sets the scale for AUTOMATIC1111 inference.
- Persistence: This environment variable is a
PersistentConfig
variable.
AUTOMATIC1111_SAMPLER
โ
- Type:
str
- Description: Sets the sampler for AUTOMATIC1111 inference.
- Persistence: This environment variable is a
PersistentConfig
variable.
AUTOMATIC1111_SCHEDULER
โ
- Type:
str
- Description: Sets the scheduler for AUTOMATIC1111 inference.
- Persistence: This environment variable is a
PersistentConfig
variable.
ComfyUIโ
COMFYUI_BASE_URL
โ
- Type:
str
- Description: Specifies the URL to the ComfyUI image generation API.
- Persistence: This environment variable is a
PersistentConfig
variable.
COMFYUI_API_KEY
โ
- Type:
str
- Description: Sets the API key for ComfyUI.
- Persistence: This environment variable is a
PersistentConfig
variable.
COMFYUI_WORKFLOW
โ
- Type:
str
- Default:
{
"3": {
"inputs": {
"seed": 0,
"steps": 20,
"cfg": 8,
"sampler_name": "euler",
"scheduler": "normal",
"denoise": 1,
"model": [
"4",
0
],
"positive": [
"6",
0
],
"negative": [
"7",
0
],
"latent_image": [
"5",
0
]
},
"class_type": "KSampler",
"_meta": {
"title": "KSampler"
}
},
"4": {
"inputs": {
"ckpt_name": "model.safetensors"
},
"class_type": "CheckpointLoaderSimple",
"_meta": {
"title": "Load Checkpoint"
}
},
"5": {
"inputs": {
"width": 512,
"height": 512,
"batch_size": 1
},
"class_type": "EmptyLatentImage",
"_meta": {
"title": "Empty Latent Image"
}
},
"6": {
"inputs": {
"text": "Prompt",
"clip": [
"4",
1
]
},
"class_type": "CLIPTextEncode",
"_meta": {
"title": "CLIP Text Encode (Prompt)"
}
},
"7": {
"inputs": {
"text": "",
"clip": [
"4",
1
]
},
"class_type": "CLIPTextEncode",
"_meta": {
"title": "CLIP Text Encode (Prompt)"
}
},
"8": {
"inputs": {
"samples": [
"3",
0
],
"vae": [
"4",
2
]
},
"class_type": "VAEDecode",
"_meta": {
"title": "VAE Decode"
}
},
"9": {
"inputs": {
"filename_prefix": "ComfyUI",
"images": [
"8",
0
]
},
"class_type": "SaveImage",
"_meta": {
"title": "Save Image"
}
}
}
- Description: Sets the ComfyUI workflow.
- Persistence: This environment variable is a
PersistentConfig
variable.
Geminiโ
GEMINI_API_BASE_URL
โ
- Type:
str
- Default:
None
- Description: Specifies the URL to Gemini's API.
- Persistence: This environment variable is a
PersistentConfig
variable.
GEMINI_API_KEY
โ
- Type:
str
- Default:
None
- Description: Sets the Gemini API key.
- Persistence: This environment variable is a
PersistentConfig
variable.
IMAGES_GEMINI_API_BASE_URL
โ
- Type:
str
- Default:
None
- Description: Specifies the URL to Gemini's image generation API.
- Persistence: This environment variable is a
PersistentConfig
variable.
IMAGES_GEMINI_API_KEY
โ
- Type:
str
- Default:
None
- Description: Sets the Gemini API key for image generation.
- Persistence: This environment variable is a
PersistentConfig
variable.
OpenAI DALL-Eโ
IMAGES_OPENAI_API_BASE_URL
โ
- Type:
str
- Default:
${OPENAI_API_BASE_URL}
- Description: Sets the OpenAI-compatible base URL to use for DALL-E image generation.
- Persistence: This environment variable is a
PersistentConfig
variable.
IMAGES_OPENAI_API_KEY
โ
- Type:
str
- Default:
${OPENAI_API_KEY}
- Description: Sets the API key to use for DALL-E image generation.
- Persistence: This environment variable is a
PersistentConfig
variable.