-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy path.env.openwebui.example
More file actions
165 lines (146 loc) · 7.12 KB
/
Copy path.env.openwebui.example
File metadata and controls
165 lines (146 loc) · 7.12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# Caddy HTTPS reverse proxy (optional) — see README for setup details
# To enable: export COMPOSE_FILE=compose.yaml:compose.caddy.yaml
# Or pass explicitly: docker compose -f compose.yaml -f compose.caddy.yaml up -d
#DOMAIN=maition.example.com
#ACME_EMAIL=admin@example.com
#WEBUI_URL=https://maition.example.com
# optional: publish Caddy on different host ports (defaults to 80/443)
#CADDY_HTTP_PORT=80
#CADDY_HTTPS_PORT=443
# replace with your domain if deploying in production
# for dev always include port number if not 80
WEBUI_URL=http://localhost:3000
# on what port to listen on the host
HTTP_WEB_PORT=3000
# replace with your key, generate via `openssl rand -hex 32`
#WEBUI_SECRET_KEY=
# database credentials
# NOTE: if you change the user from `postgres` you must also update the user
# at the ./helpers/01-openwebui-init.sql !!!
POSTGRES_USER=postgres
POSTGRES_PASSWORD=postgres
POSTGRES_DB=openwebui
POSTGRES_HOST=postgres
POSTGRES_PORT=5432
# credentials for automatic provisioning of admin account (required)
X_WEBUI_ADMIN_USER=Admin
X_WEBUI_ADMIN_EMAIL=admin@example123.com
X_WEBUI_ADMIN_PASS=q1w2e3r4!
# credentials for automatic provisioning of a regular user account (optional)
X_WEBUI_USER_NAME=user123
X_WEBUI_USER_EMAIL=user@example123.com
X_WEBUI_USER_PASS=q1w2e3r4!
# NOTE: the web auth must be enabled and signups must be enabled during
# first application start to allow for automatic admin user creation
# and system configuration. You can disable them after first boot
WEBUI_AUTH=True
ENABLE_SIGNUP=True
ENABLE_LOGIN_FORM=True
# optional: pre-configure OpenAI-compatible provider and default chat model to use
# set to False to skip this setting
ENABLE_OPENAI_API=True
OPENAI_API_BASE_URL=https://openrouter.ai/api/v1
# replace with your key!
OPENAI_API_KEY=sk-or-v1-xxxxxxxxx
# replace with your desired model!
OPENAI_DEFAULT_MODEL=openai/gpt-4.1-nano
# CREATE_CUSTOM_WORKSPACE_MODEL="True" installs the bundled wikiteqcenturion.json
# (kept for backward compatibility). Set it to a filename under models/
# (e.g. "wikiteqcenturion.json") to install a different bundled model instead.
# "False" or unset installs no custom workspace model.
# CREATE_CUSTOM_WORKSPACE_MODEL=True
# Model system prompt override/extension (optional, applies whenever CREATE_CUSTOM_WORKSPACE_MODEL installs a model):
# - OWUI_MODEL_PROMPT fully replaces the bundled system prompt
# - OWUI_MODEL_PROMPT_APPEND appends to the bundled (or overridden) system prompt, separated by a blank line
#OWUI_MODEL_PROMPT=
#OWUI_MODEL_PROMPT_APPEND=
# system settings, see https://docs.openwebui.com/getting-started/env-configuration/ for a complete list
ENV=dev
UVICORN_WORKERS=1
USER_AGENT=rag-of-all-trades+openwebui/0.6.5
ENABLE_BASE_MODELS_CACHE=True
MODELS_CACHE_TTL=300
# Intentionally disabled
ENABLE_WEB_SEARCH=False
WEB_SEARCH_ENGINE=duckduckgo
ENABLE_OLLAMA_API=False
# the URL of the ROAT API, keep default
ROAT_API_URL=http://api:8000
ROAT_API_KEY=12345
# MediaWiki Tool (optional): set TOOL_MEDIAWIKI_ENABLED=True to auto-install the
# MediaWiki Search & Write Tool on first boot. MEDIAWIKI_API_URL is required when enabled.
#TOOL_MEDIAWIKI_ENABLED=True
#MEDIAWIKI_API_URL=https://wiki.example.com/w/api.php
#MEDIAWIKI_USERNAME=
#MEDIAWIKI_PASSWORD=
# Web Search Tool (optional): set TOOL_WEB_SEARCH_ENABLED=True to auto-install the
# Tavily-powered web search Tool on first boot. Set TOOL_WEB_SEARCH_API_KEY to have
# it auto-configure the tavily_api_key valve, or leave unset and set the valve
# later from Workspace -> Tools in the UI.
#TOOL_WEB_SEARCH_ENABLED=True
#TOOL_WEB_SEARCH_API_KEY=
# Video Inject Filter (optional): set FUNCTION_VIDEO_INJECT_ENABLED=True to auto-install the
# inline video player filter on first boot. Requires video_url metadata in retrieved sources.
#FUNCTION_VIDEO_INJECT_ENABLED=True
# Get Sources Tool (optional): set TOOL_GET_SOURCES_ENABLED=True to auto-install the
# Get Current Sources tool on first boot. Lets the model retrieve sources emitted
# by other tools (roat_retrieval, mediawiki) during the current chat turn, for
# more reliable inline citations.
#TOOL_GET_SOURCES_ENABLED=True
# openwebui-mcp bridge (optional): set COMPOSE_FILE=compose.yaml:compose.mcp.owui.yaml
# to run an MCP server that lets external MCP clients (Claude Desktop, Codex CLI)
# call mAItion over Streamable HTTP. Vars are prefixed MCP_ here (and remapped
# to their unprefixed names for the container in compose.mcp.owui.yaml) to
# match the MCP_-prefixed keys used in the k8s deployment's ConfigMap.
#MCP_PORT=8001
MCP_OPENWEBUI_BASE_URL=http://openwebui:8080
# replace with a mAItion API key (Account settings -> Account -> API keys)
MCP_OPENWEBUI_API_KEY=
# bearer token MCP clients must send to the bridge itself; generate via `openssl rand -hex 32`
# required — the mcp-owui service refuses to start if this is unset
MCP_OPENWEBUI_MCP_TOKEN=
# optional:
#MCP_OPENWEBUI_DEFAULT_MODEL=
#MCP_OPENWEBUI_ENFORCE_DEFAULT_MODEL=false
#MCP_OPENWEBUI_ASK_DESCRIPTION=
#MCP_OPENWEBUI_INSTRUCTIONS=
#MCP_OWUI_TIMEOUT_MS=120000
# MCP_OPENWEBUI_CA_BUNDLE must point to a path inside the mcp-owui container;
# mount your CA file there via compose.mcp.owui.yaml's volumes to use it.
#MCP_OPENWEBUI_CA_BUNDLE=
#MCP_OPENWEBUI_SSL_VERIFY=true
# ── SSO / OAuth2 ──────────────────────────────────────────────────────────────
# Single Sign-On is configured via environment variables and is disabled by default.
# Uncomment and fill in the vars for your chosen provider.
# See docs/configuration/sso for full setup instructions, all providers, and gotchas.
# Verified against OpenWebUI open-webui:0.6.5
# Google OAuth2
#GOOGLE_CLIENT_ID=your-client-id.apps.googleusercontent.com
#GOOGLE_CLIENT_SECRET=your-client-secret
# Microsoft / Azure AD
#MICROSOFT_CLIENT_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
#MICROSOFT_CLIENT_SECRET=your-client-secret
#MICROSOFT_TENANT_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
# GitHub OAuth
#GITHUB_CLIENT_ID=your-github-client-id
#GITHUB_CLIENT_SECRET=your-github-client-secret
# Generic OIDC (Okta, Keycloak, Auth0, etc.)
#OAUTH_CLIENT_ID=your-client-id
#OAUTH_CLIENT_SECRET=your-client-secret
#OPENID_PROVIDER_URL=https://your-idp.example.com
#OAUTH_PROVIDER_NAME=MySSO
#OAUTH_SCOPES=openid email profile
# Common OAuth settings (apply to all providers above)
#ENABLE_OAUTH_SIGNUP=True
#OAUTH_MERGE_ACCOUNTS_BY_EMAIL=True
# Required when running behind a reverse proxy or on a non-root path:
# Use the provider-specific path: /oauth/google/callback, /oauth/github/callback,
# /oauth/microsoft/callback, or /oauth/oidc/callback (for Keycloak/Okta/etc.)
#OPENID_REDIRECT_URI=https://your-domain.com/oauth/oidc/callback
# Trusted Header SSO (advanced — requires hardened reverse proxy; see security warning in docs)
#WEBUI_AUTH_TRUSTED_EMAIL_HEADER=X-Auth-Request-Email
#WEBUI_AUTH_TRUSTED_NAME_HEADER=X-Auth-Request-User
# Image Resizer Filter (optional): set FUNCTION_IMAGE_RESIZER_ENABLED=True to auto-install
# the image downscaling filter on first boot. max_dimension (default 768px) is
# controlled via the filter's Valve in the admin UI, not an env var.
#FUNCTION_IMAGE_RESIZER_ENABLED=True