main.py 51 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569
  1. import asyncio
  2. import inspect
  3. import json
  4. import logging
  5. import mimetypes
  6. import os
  7. import shutil
  8. import sys
  9. import time
  10. import random
  11. from contextlib import asynccontextmanager
  12. from urllib.parse import urlencode, parse_qs, urlparse
  13. from pydantic import BaseModel
  14. from sqlalchemy import text
  15. from typing import Optional
  16. from aiocache import cached
  17. import aiohttp
  18. import anyio.to_thread
  19. import requests
  20. from fastapi import (
  21. Depends,
  22. FastAPI,
  23. File,
  24. Form,
  25. HTTPException,
  26. Request,
  27. UploadFile,
  28. status,
  29. applications,
  30. BackgroundTasks,
  31. )
  32. from fastapi.openapi.docs import get_swagger_ui_html
  33. from fastapi.middleware.cors import CORSMiddleware
  34. from fastapi.responses import JSONResponse, RedirectResponse
  35. from fastapi.staticfiles import StaticFiles
  36. from starlette.exceptions import HTTPException as StarletteHTTPException
  37. from starlette.middleware.base import BaseHTTPMiddleware
  38. from starlette.middleware.sessions import SessionMiddleware
  39. from starlette.responses import Response, StreamingResponse
  40. from open_webui.utils import logger
  41. from open_webui.utils.audit import AuditLevel, AuditLoggingMiddleware
  42. from open_webui.utils.logger import start_logger
  43. from open_webui.socket.main import (
  44. app as socket_app,
  45. periodic_usage_pool_cleanup,
  46. )
  47. from open_webui.routers import (
  48. audio,
  49. images,
  50. ollama,
  51. openai,
  52. retrieval,
  53. pipelines,
  54. tasks,
  55. auths,
  56. channels,
  57. chats,
  58. notes,
  59. folders,
  60. configs,
  61. groups,
  62. files,
  63. functions,
  64. memories,
  65. models,
  66. knowledge,
  67. prompts,
  68. evaluations,
  69. tools,
  70. users,
  71. utils,
  72. )
  73. from open_webui.routers.retrieval import (
  74. get_embedding_function,
  75. get_ef,
  76. get_rf,
  77. )
  78. from open_webui.internal.db import Session, engine
  79. from open_webui.models.functions import Functions
  80. from open_webui.models.models import Models
  81. from open_webui.models.users import UserModel, Users
  82. from open_webui.models.chats import Chats
  83. from open_webui.config import (
  84. LICENSE_KEY,
  85. # Ollama
  86. ENABLE_OLLAMA_API,
  87. OLLAMA_BASE_URLS,
  88. OLLAMA_API_CONFIGS,
  89. # OpenAI
  90. ENABLE_OPENAI_API,
  91. ONEDRIVE_CLIENT_ID,
  92. ONEDRIVE_SHAREPOINT_URL,
  93. ONEDRIVE_SHAREPOINT_TENANT_ID,
  94. OPENAI_API_BASE_URLS,
  95. OPENAI_API_KEYS,
  96. OPENAI_API_CONFIGS,
  97. # Direct Connections
  98. ENABLE_DIRECT_CONNECTIONS,
  99. # Thread pool size for FastAPI/AnyIO
  100. THREAD_POOL_SIZE,
  101. # Tool Server Configs
  102. TOOL_SERVER_CONNECTIONS,
  103. # Code Execution
  104. ENABLE_CODE_EXECUTION,
  105. CODE_EXECUTION_ENGINE,
  106. CODE_EXECUTION_JUPYTER_URL,
  107. CODE_EXECUTION_JUPYTER_AUTH,
  108. CODE_EXECUTION_JUPYTER_AUTH_TOKEN,
  109. CODE_EXECUTION_JUPYTER_AUTH_PASSWORD,
  110. CODE_EXECUTION_JUPYTER_TIMEOUT,
  111. ENABLE_CODE_INTERPRETER,
  112. CODE_INTERPRETER_ENGINE,
  113. CODE_INTERPRETER_PROMPT_TEMPLATE,
  114. CODE_INTERPRETER_JUPYTER_URL,
  115. CODE_INTERPRETER_JUPYTER_AUTH,
  116. CODE_INTERPRETER_JUPYTER_AUTH_TOKEN,
  117. CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD,
  118. CODE_INTERPRETER_JUPYTER_TIMEOUT,
  119. # Image
  120. AUTOMATIC1111_API_AUTH,
  121. AUTOMATIC1111_BASE_URL,
  122. AUTOMATIC1111_CFG_SCALE,
  123. AUTOMATIC1111_SAMPLER,
  124. AUTOMATIC1111_SCHEDULER,
  125. COMFYUI_BASE_URL,
  126. COMFYUI_API_KEY,
  127. COMFYUI_WORKFLOW,
  128. COMFYUI_WORKFLOW_NODES,
  129. ENABLE_IMAGE_GENERATION,
  130. ENABLE_IMAGE_PROMPT_GENERATION,
  131. IMAGE_GENERATION_ENGINE,
  132. IMAGE_GENERATION_MODEL,
  133. IMAGE_SIZE,
  134. IMAGE_STEPS,
  135. IMAGES_OPENAI_API_BASE_URL,
  136. IMAGES_OPENAI_API_KEY,
  137. IMAGES_GEMINI_API_BASE_URL,
  138. IMAGES_GEMINI_API_KEY,
  139. # Audio
  140. AUDIO_STT_ENGINE,
  141. AUDIO_STT_MODEL,
  142. AUDIO_STT_OPENAI_API_BASE_URL,
  143. AUDIO_STT_OPENAI_API_KEY,
  144. AUDIO_STT_AZURE_API_KEY,
  145. AUDIO_STT_AZURE_REGION,
  146. AUDIO_STT_AZURE_LOCALES,
  147. AUDIO_STT_AZURE_BASE_URL,
  148. AUDIO_STT_AZURE_MAX_SPEAKERS,
  149. AUDIO_TTS_API_KEY,
  150. AUDIO_TTS_ENGINE,
  151. AUDIO_TTS_MODEL,
  152. AUDIO_TTS_OPENAI_API_BASE_URL,
  153. AUDIO_TTS_OPENAI_API_KEY,
  154. AUDIO_TTS_SPLIT_ON,
  155. AUDIO_TTS_VOICE,
  156. AUDIO_TTS_AZURE_SPEECH_REGION,
  157. AUDIO_TTS_AZURE_SPEECH_BASE_URL,
  158. AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT,
  159. PLAYWRIGHT_WS_URL,
  160. PLAYWRIGHT_TIMEOUT,
  161. FIRECRAWL_API_BASE_URL,
  162. FIRECRAWL_API_KEY,
  163. WEB_LOADER_ENGINE,
  164. WHISPER_MODEL,
  165. WHISPER_VAD_FILTER,
  166. WHISPER_LANGUAGE,
  167. DEEPGRAM_API_KEY,
  168. WHISPER_MODEL_AUTO_UPDATE,
  169. WHISPER_MODEL_DIR,
  170. # Retrieval
  171. RAG_TEMPLATE,
  172. DEFAULT_RAG_TEMPLATE,
  173. RAG_FULL_CONTEXT,
  174. BYPASS_EMBEDDING_AND_RETRIEVAL,
  175. RAG_EMBEDDING_MODEL,
  176. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  177. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE,
  178. RAG_RERANKING_MODEL,
  179. RAG_RERANKING_MODEL_AUTO_UPDATE,
  180. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE,
  181. RAG_EMBEDDING_ENGINE,
  182. RAG_EMBEDDING_BATCH_SIZE,
  183. RAG_RELEVANCE_THRESHOLD,
  184. RAG_FILE_MAX_COUNT,
  185. RAG_FILE_MAX_SIZE,
  186. RAG_OPENAI_API_BASE_URL,
  187. RAG_OPENAI_API_KEY,
  188. RAG_OLLAMA_BASE_URL,
  189. RAG_OLLAMA_API_KEY,
  190. CHUNK_OVERLAP,
  191. CHUNK_SIZE,
  192. CONTENT_EXTRACTION_ENGINE,
  193. TIKA_SERVER_URL,
  194. DOCLING_SERVER_URL,
  195. DOCLING_OCR_ENGINE,
  196. DOCLING_OCR_LANG,
  197. DOCUMENT_INTELLIGENCE_ENDPOINT,
  198. DOCUMENT_INTELLIGENCE_KEY,
  199. MISTRAL_OCR_API_KEY,
  200. RAG_TOP_K,
  201. RAG_TOP_K_RERANKER,
  202. RAG_TEXT_SPLITTER,
  203. TIKTOKEN_ENCODING_NAME,
  204. PDF_EXTRACT_IMAGES,
  205. YOUTUBE_LOADER_LANGUAGE,
  206. YOUTUBE_LOADER_PROXY_URL,
  207. # Retrieval (Web Search)
  208. ENABLE_WEB_SEARCH,
  209. WEB_SEARCH_ENGINE,
  210. BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL,
  211. WEB_SEARCH_RESULT_COUNT,
  212. WEB_SEARCH_CONCURRENT_REQUESTS,
  213. WEB_SEARCH_TRUST_ENV,
  214. WEB_SEARCH_DOMAIN_FILTER_LIST,
  215. JINA_API_KEY,
  216. SEARCHAPI_API_KEY,
  217. SEARCHAPI_ENGINE,
  218. SERPAPI_API_KEY,
  219. SERPAPI_ENGINE,
  220. SEARXNG_QUERY_URL,
  221. YACY_QUERY_URL,
  222. YACY_USERNAME,
  223. YACY_PASSWORD,
  224. SERPER_API_KEY,
  225. SERPLY_API_KEY,
  226. SERPSTACK_API_KEY,
  227. SERPSTACK_HTTPS,
  228. TAVILY_API_KEY,
  229. TAVILY_EXTRACT_DEPTH,
  230. BING_SEARCH_V7_ENDPOINT,
  231. BING_SEARCH_V7_SUBSCRIPTION_KEY,
  232. BRAVE_SEARCH_API_KEY,
  233. EXA_API_KEY,
  234. PERPLEXITY_API_KEY,
  235. SOUGOU_API_SID,
  236. SOUGOU_API_SK,
  237. KAGI_SEARCH_API_KEY,
  238. MOJEEK_SEARCH_API_KEY,
  239. BOCHA_SEARCH_API_KEY,
  240. GOOGLE_PSE_API_KEY,
  241. GOOGLE_PSE_ENGINE_ID,
  242. GOOGLE_DRIVE_CLIENT_ID,
  243. GOOGLE_DRIVE_API_KEY,
  244. ONEDRIVE_CLIENT_ID,
  245. ONEDRIVE_SHAREPOINT_URL,
  246. ONEDRIVE_SHAREPOINT_TENANT_ID,
  247. ENABLE_RAG_HYBRID_SEARCH,
  248. ENABLE_RAG_LOCAL_WEB_FETCH,
  249. ENABLE_WEB_LOADER_SSL_VERIFICATION,
  250. ENABLE_GOOGLE_DRIVE_INTEGRATION,
  251. ENABLE_ONEDRIVE_INTEGRATION,
  252. UPLOAD_DIR,
  253. EXTERNAL_WEB_SEARCH_URL,
  254. EXTERNAL_WEB_SEARCH_API_KEY,
  255. EXTERNAL_WEB_LOADER_URL,
  256. EXTERNAL_WEB_LOADER_API_KEY,
  257. # WebUI
  258. WEBUI_AUTH,
  259. WEBUI_NAME,
  260. WEBUI_BANNERS,
  261. WEBHOOK_URL,
  262. ADMIN_EMAIL,
  263. SHOW_ADMIN_DETAILS,
  264. JWT_EXPIRES_IN,
  265. ENABLE_SIGNUP,
  266. ENABLE_LOGIN_FORM,
  267. ENABLE_API_KEY,
  268. ENABLE_API_KEY_ENDPOINT_RESTRICTIONS,
  269. API_KEY_ALLOWED_ENDPOINTS,
  270. ENABLE_CHANNELS,
  271. ENABLE_NOTES,
  272. ENABLE_COMMUNITY_SHARING,
  273. ENABLE_MESSAGE_RATING,
  274. ENABLE_USER_WEBHOOKS,
  275. ENABLE_EVALUATION_ARENA_MODELS,
  276. USER_PERMISSIONS,
  277. DEFAULT_USER_ROLE,
  278. DEFAULT_PROMPT_SUGGESTIONS,
  279. DEFAULT_MODELS,
  280. DEFAULT_ARENA_MODEL,
  281. MODEL_ORDER_LIST,
  282. EVALUATION_ARENA_MODELS,
  283. # WebUI (OAuth)
  284. ENABLE_OAUTH_ROLE_MANAGEMENT,
  285. OAUTH_ROLES_CLAIM,
  286. OAUTH_EMAIL_CLAIM,
  287. OAUTH_PICTURE_CLAIM,
  288. OAUTH_USERNAME_CLAIM,
  289. OAUTH_ALLOWED_ROLES,
  290. OAUTH_ADMIN_ROLES,
  291. # WebUI (LDAP)
  292. ENABLE_LDAP,
  293. LDAP_SERVER_LABEL,
  294. LDAP_SERVER_HOST,
  295. LDAP_SERVER_PORT,
  296. LDAP_ATTRIBUTE_FOR_MAIL,
  297. LDAP_ATTRIBUTE_FOR_USERNAME,
  298. LDAP_SEARCH_FILTERS,
  299. LDAP_SEARCH_BASE,
  300. LDAP_APP_DN,
  301. LDAP_APP_PASSWORD,
  302. LDAP_USE_TLS,
  303. LDAP_CA_CERT_FILE,
  304. LDAP_CIPHERS,
  305. # Misc
  306. ENV,
  307. CACHE_DIR,
  308. STATIC_DIR,
  309. FRONTEND_BUILD_DIR,
  310. CORS_ALLOW_ORIGIN,
  311. DEFAULT_LOCALE,
  312. OAUTH_PROVIDERS,
  313. WEBUI_URL,
  314. # Admin
  315. ENABLE_ADMIN_CHAT_ACCESS,
  316. ENABLE_ADMIN_EXPORT,
  317. # Tasks
  318. TASK_MODEL,
  319. TASK_MODEL_EXTERNAL,
  320. ENABLE_TAGS_GENERATION,
  321. ENABLE_TITLE_GENERATION,
  322. ENABLE_SEARCH_QUERY_GENERATION,
  323. ENABLE_RETRIEVAL_QUERY_GENERATION,
  324. ENABLE_AUTOCOMPLETE_GENERATION,
  325. TITLE_GENERATION_PROMPT_TEMPLATE,
  326. TAGS_GENERATION_PROMPT_TEMPLATE,
  327. IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE,
  328. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
  329. QUERY_GENERATION_PROMPT_TEMPLATE,
  330. AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE,
  331. AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH,
  332. AppConfig,
  333. reset_config,
  334. )
  335. from open_webui.env import (
  336. AUDIT_EXCLUDED_PATHS,
  337. AUDIT_LOG_LEVEL,
  338. CHANGELOG,
  339. REDIS_URL,
  340. REDIS_SENTINEL_HOSTS,
  341. REDIS_SENTINEL_PORT,
  342. GLOBAL_LOG_LEVEL,
  343. MAX_BODY_LOG_SIZE,
  344. SAFE_MODE,
  345. SRC_LOG_LEVELS,
  346. VERSION,
  347. WEBUI_BUILD_HASH,
  348. WEBUI_SECRET_KEY,
  349. WEBUI_SESSION_COOKIE_SAME_SITE,
  350. WEBUI_SESSION_COOKIE_SECURE,
  351. WEBUI_AUTH_TRUSTED_EMAIL_HEADER,
  352. WEBUI_AUTH_TRUSTED_NAME_HEADER,
  353. WEBUI_AUTH_SIGNOUT_REDIRECT_URL,
  354. ENABLE_WEBSOCKET_SUPPORT,
  355. BYPASS_MODEL_ACCESS_CONTROL,
  356. RESET_CONFIG_ON_START,
  357. OFFLINE_MODE,
  358. ENABLE_OTEL,
  359. EXTERNAL_PWA_MANIFEST_URL,
  360. )
  361. from open_webui.utils.models import (
  362. get_all_models,
  363. get_all_base_models,
  364. check_model_access,
  365. )
  366. from open_webui.utils.chat import (
  367. generate_chat_completion as chat_completion_handler,
  368. chat_completed as chat_completed_handler,
  369. chat_action as chat_action_handler,
  370. )
  371. from open_webui.utils.middleware import process_chat_payload, process_chat_response
  372. from open_webui.utils.access_control import has_access
  373. from open_webui.utils.auth import (
  374. get_license_data,
  375. get_http_authorization_cred,
  376. decode_token,
  377. get_admin_user,
  378. get_verified_user,
  379. )
  380. from open_webui.utils.plugin import install_tool_and_function_dependencies
  381. from open_webui.utils.oauth import OAuthManager
  382. from open_webui.utils.security_headers import SecurityHeadersMiddleware
  383. from open_webui.tasks import (
  384. list_task_ids_by_chat_id,
  385. stop_task,
  386. list_tasks,
  387. ) # Import from tasks.py
  388. from open_webui.utils.redis import get_sentinels_from_env
  389. if SAFE_MODE:
  390. print("SAFE MODE ENABLED")
  391. Functions.deactivate_all_functions()
  392. logging.basicConfig(stream=sys.stdout, level=GLOBAL_LOG_LEVEL)
  393. log = logging.getLogger(__name__)
  394. log.setLevel(SRC_LOG_LEVELS["MAIN"])
  395. class SPAStaticFiles(StaticFiles):
  396. async def get_response(self, path: str, scope):
  397. try:
  398. return await super().get_response(path, scope)
  399. except (HTTPException, StarletteHTTPException) as ex:
  400. if ex.status_code == 404:
  401. if path.endswith(".js"):
  402. # Return 404 for javascript files
  403. raise ex
  404. else:
  405. return await super().get_response("index.html", scope)
  406. else:
  407. raise ex
  408. print(
  409. rf"""
  410. ██████╗ ██████╗ ███████╗███╗ ██╗ ██╗ ██╗███████╗██████╗ ██╗ ██╗██╗
  411. ██╔═══██╗██╔══██╗██╔════╝████╗ ██║ ██║ ██║██╔════╝██╔══██╗██║ ██║██║
  412. ██║ ██║██████╔╝█████╗ ██╔██╗ ██║ ██║ █╗ ██║█████╗ ██████╔╝██║ ██║██║
  413. ██║ ██║██╔═══╝ ██╔══╝ ██║╚██╗██║ ██║███╗██║██╔══╝ ██╔══██╗██║ ██║██║
  414. ╚██████╔╝██║ ███████╗██║ ╚████║ ╚███╔███╔╝███████╗██████╔╝╚██████╔╝██║
  415. ╚═════╝ ╚═╝ ╚══════╝╚═╝ ╚═══╝ ╚══╝╚══╝ ╚══════╝╚═════╝ ╚═════╝ ╚═╝
  416. v{VERSION} - building the best AI user interface.
  417. {f"Commit: {WEBUI_BUILD_HASH}" if WEBUI_BUILD_HASH != "dev-build" else ""}
  418. https://github.com/open-webui/open-webui
  419. """
  420. )
  421. @asynccontextmanager
  422. async def lifespan(app: FastAPI):
  423. start_logger()
  424. if RESET_CONFIG_ON_START:
  425. reset_config()
  426. if LICENSE_KEY:
  427. get_license_data(app, LICENSE_KEY)
  428. # This should be blocking (sync) so functions are not deactivated on first /get_models calls
  429. # when the first user lands on the / route.
  430. log.info("Installing external dependencies of functions and tools...")
  431. install_tool_and_function_dependencies()
  432. pool_size = THREAD_POOL_SIZE
  433. if pool_size and pool_size > 0:
  434. limiter = anyio.to_thread.current_default_thread_limiter()
  435. limiter.total_tokens = pool_size
  436. asyncio.create_task(periodic_usage_pool_cleanup())
  437. yield
  438. app = FastAPI(
  439. title="Open WebUI",
  440. docs_url="/docs" if ENV == "dev" else None,
  441. openapi_url="/openapi.json" if ENV == "dev" else None,
  442. redoc_url=None,
  443. lifespan=lifespan,
  444. )
  445. oauth_manager = OAuthManager(app)
  446. app.state.config = AppConfig(
  447. redis_url=REDIS_URL,
  448. redis_sentinels=get_sentinels_from_env(REDIS_SENTINEL_HOSTS, REDIS_SENTINEL_PORT),
  449. )
  450. app.state.WEBUI_NAME = WEBUI_NAME
  451. app.state.LICENSE_METADATA = None
  452. ########################################
  453. #
  454. # OPENTELEMETRY
  455. #
  456. ########################################
  457. if ENABLE_OTEL:
  458. from open_webui.utils.telemetry.setup import setup as setup_opentelemetry
  459. setup_opentelemetry(app=app, db_engine=engine)
  460. ########################################
  461. #
  462. # OLLAMA
  463. #
  464. ########################################
  465. app.state.config.ENABLE_OLLAMA_API = ENABLE_OLLAMA_API
  466. app.state.config.OLLAMA_BASE_URLS = OLLAMA_BASE_URLS
  467. app.state.config.OLLAMA_API_CONFIGS = OLLAMA_API_CONFIGS
  468. app.state.OLLAMA_MODELS = {}
  469. ########################################
  470. #
  471. # OPENAI
  472. #
  473. ########################################
  474. app.state.config.ENABLE_OPENAI_API = ENABLE_OPENAI_API
  475. app.state.config.OPENAI_API_BASE_URLS = OPENAI_API_BASE_URLS
  476. app.state.config.OPENAI_API_KEYS = OPENAI_API_KEYS
  477. app.state.config.OPENAI_API_CONFIGS = OPENAI_API_CONFIGS
  478. app.state.OPENAI_MODELS = {}
  479. ########################################
  480. #
  481. # TOOL SERVERS
  482. #
  483. ########################################
  484. app.state.config.TOOL_SERVER_CONNECTIONS = TOOL_SERVER_CONNECTIONS
  485. app.state.TOOL_SERVERS = []
  486. ########################################
  487. #
  488. # DIRECT CONNECTIONS
  489. #
  490. ########################################
  491. app.state.config.ENABLE_DIRECT_CONNECTIONS = ENABLE_DIRECT_CONNECTIONS
  492. ########################################
  493. #
  494. # WEBUI
  495. #
  496. ########################################
  497. app.state.config.WEBUI_URL = WEBUI_URL
  498. app.state.config.ENABLE_SIGNUP = ENABLE_SIGNUP
  499. app.state.config.ENABLE_LOGIN_FORM = ENABLE_LOGIN_FORM
  500. app.state.config.ENABLE_API_KEY = ENABLE_API_KEY
  501. app.state.config.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS = (
  502. ENABLE_API_KEY_ENDPOINT_RESTRICTIONS
  503. )
  504. app.state.config.API_KEY_ALLOWED_ENDPOINTS = API_KEY_ALLOWED_ENDPOINTS
  505. app.state.config.JWT_EXPIRES_IN = JWT_EXPIRES_IN
  506. app.state.config.SHOW_ADMIN_DETAILS = SHOW_ADMIN_DETAILS
  507. app.state.config.ADMIN_EMAIL = ADMIN_EMAIL
  508. app.state.config.DEFAULT_MODELS = DEFAULT_MODELS
  509. app.state.config.DEFAULT_PROMPT_SUGGESTIONS = DEFAULT_PROMPT_SUGGESTIONS
  510. app.state.config.DEFAULT_USER_ROLE = DEFAULT_USER_ROLE
  511. app.state.config.USER_PERMISSIONS = USER_PERMISSIONS
  512. app.state.config.WEBHOOK_URL = WEBHOOK_URL
  513. app.state.config.BANNERS = WEBUI_BANNERS
  514. app.state.config.MODEL_ORDER_LIST = MODEL_ORDER_LIST
  515. app.state.config.ENABLE_CHANNELS = ENABLE_CHANNELS
  516. app.state.config.ENABLE_NOTES = ENABLE_NOTES
  517. app.state.config.ENABLE_COMMUNITY_SHARING = ENABLE_COMMUNITY_SHARING
  518. app.state.config.ENABLE_MESSAGE_RATING = ENABLE_MESSAGE_RATING
  519. app.state.config.ENABLE_USER_WEBHOOKS = ENABLE_USER_WEBHOOKS
  520. app.state.config.ENABLE_EVALUATION_ARENA_MODELS = ENABLE_EVALUATION_ARENA_MODELS
  521. app.state.config.EVALUATION_ARENA_MODELS = EVALUATION_ARENA_MODELS
  522. app.state.config.OAUTH_USERNAME_CLAIM = OAUTH_USERNAME_CLAIM
  523. app.state.config.OAUTH_PICTURE_CLAIM = OAUTH_PICTURE_CLAIM
  524. app.state.config.OAUTH_EMAIL_CLAIM = OAUTH_EMAIL_CLAIM
  525. app.state.config.ENABLE_OAUTH_ROLE_MANAGEMENT = ENABLE_OAUTH_ROLE_MANAGEMENT
  526. app.state.config.OAUTH_ROLES_CLAIM = OAUTH_ROLES_CLAIM
  527. app.state.config.OAUTH_ALLOWED_ROLES = OAUTH_ALLOWED_ROLES
  528. app.state.config.OAUTH_ADMIN_ROLES = OAUTH_ADMIN_ROLES
  529. app.state.config.ENABLE_LDAP = ENABLE_LDAP
  530. app.state.config.LDAP_SERVER_LABEL = LDAP_SERVER_LABEL
  531. app.state.config.LDAP_SERVER_HOST = LDAP_SERVER_HOST
  532. app.state.config.LDAP_SERVER_PORT = LDAP_SERVER_PORT
  533. app.state.config.LDAP_ATTRIBUTE_FOR_MAIL = LDAP_ATTRIBUTE_FOR_MAIL
  534. app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME = LDAP_ATTRIBUTE_FOR_USERNAME
  535. app.state.config.LDAP_APP_DN = LDAP_APP_DN
  536. app.state.config.LDAP_APP_PASSWORD = LDAP_APP_PASSWORD
  537. app.state.config.LDAP_SEARCH_BASE = LDAP_SEARCH_BASE
  538. app.state.config.LDAP_SEARCH_FILTERS = LDAP_SEARCH_FILTERS
  539. app.state.config.LDAP_USE_TLS = LDAP_USE_TLS
  540. app.state.config.LDAP_CA_CERT_FILE = LDAP_CA_CERT_FILE
  541. app.state.config.LDAP_CIPHERS = LDAP_CIPHERS
  542. app.state.AUTH_TRUSTED_EMAIL_HEADER = WEBUI_AUTH_TRUSTED_EMAIL_HEADER
  543. app.state.AUTH_TRUSTED_NAME_HEADER = WEBUI_AUTH_TRUSTED_NAME_HEADER
  544. app.state.WEBUI_AUTH_SIGNOUT_REDIRECT_URL = WEBUI_AUTH_SIGNOUT_REDIRECT_URL
  545. app.state.EXTERNAL_PWA_MANIFEST_URL = EXTERNAL_PWA_MANIFEST_URL
  546. app.state.USER_COUNT = None
  547. app.state.TOOLS = {}
  548. app.state.FUNCTIONS = {}
  549. ########################################
  550. #
  551. # RETRIEVAL
  552. #
  553. ########################################
  554. app.state.config.TOP_K = RAG_TOP_K
  555. app.state.config.TOP_K_RERANKER = RAG_TOP_K_RERANKER
  556. app.state.config.RELEVANCE_THRESHOLD = RAG_RELEVANCE_THRESHOLD
  557. app.state.config.FILE_MAX_SIZE = RAG_FILE_MAX_SIZE
  558. app.state.config.FILE_MAX_COUNT = RAG_FILE_MAX_COUNT
  559. app.state.config.RAG_FULL_CONTEXT = RAG_FULL_CONTEXT
  560. app.state.config.BYPASS_EMBEDDING_AND_RETRIEVAL = BYPASS_EMBEDDING_AND_RETRIEVAL
  561. app.state.config.ENABLE_RAG_HYBRID_SEARCH = ENABLE_RAG_HYBRID_SEARCH
  562. app.state.config.ENABLE_WEB_LOADER_SSL_VERIFICATION = ENABLE_WEB_LOADER_SSL_VERIFICATION
  563. app.state.config.CONTENT_EXTRACTION_ENGINE = CONTENT_EXTRACTION_ENGINE
  564. app.state.config.TIKA_SERVER_URL = TIKA_SERVER_URL
  565. app.state.config.DOCLING_SERVER_URL = DOCLING_SERVER_URL
  566. app.state.config.DOCLING_OCR_ENGINE = DOCLING_OCR_ENGINE
  567. app.state.config.DOCLING_OCR_LANG = DOCLING_OCR_LANG
  568. app.state.config.DOCUMENT_INTELLIGENCE_ENDPOINT = DOCUMENT_INTELLIGENCE_ENDPOINT
  569. app.state.config.DOCUMENT_INTELLIGENCE_KEY = DOCUMENT_INTELLIGENCE_KEY
  570. app.state.config.MISTRAL_OCR_API_KEY = MISTRAL_OCR_API_KEY
  571. app.state.config.TEXT_SPLITTER = RAG_TEXT_SPLITTER
  572. app.state.config.TIKTOKEN_ENCODING_NAME = TIKTOKEN_ENCODING_NAME
  573. app.state.config.CHUNK_SIZE = CHUNK_SIZE
  574. app.state.config.CHUNK_OVERLAP = CHUNK_OVERLAP
  575. app.state.config.RAG_EMBEDDING_ENGINE = RAG_EMBEDDING_ENGINE
  576. app.state.config.RAG_EMBEDDING_MODEL = RAG_EMBEDDING_MODEL
  577. app.state.config.RAG_EMBEDDING_BATCH_SIZE = RAG_EMBEDDING_BATCH_SIZE
  578. app.state.config.RAG_RERANKING_MODEL = RAG_RERANKING_MODEL
  579. app.state.config.RAG_TEMPLATE = RAG_TEMPLATE
  580. app.state.config.RAG_OPENAI_API_BASE_URL = RAG_OPENAI_API_BASE_URL
  581. app.state.config.RAG_OPENAI_API_KEY = RAG_OPENAI_API_KEY
  582. app.state.config.RAG_OLLAMA_BASE_URL = RAG_OLLAMA_BASE_URL
  583. app.state.config.RAG_OLLAMA_API_KEY = RAG_OLLAMA_API_KEY
  584. app.state.config.PDF_EXTRACT_IMAGES = PDF_EXTRACT_IMAGES
  585. app.state.config.YOUTUBE_LOADER_LANGUAGE = YOUTUBE_LOADER_LANGUAGE
  586. app.state.config.YOUTUBE_LOADER_PROXY_URL = YOUTUBE_LOADER_PROXY_URL
  587. app.state.config.ENABLE_WEB_SEARCH = ENABLE_WEB_SEARCH
  588. app.state.config.WEB_SEARCH_ENGINE = WEB_SEARCH_ENGINE
  589. app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST = WEB_SEARCH_DOMAIN_FILTER_LIST
  590. app.state.config.WEB_SEARCH_RESULT_COUNT = WEB_SEARCH_RESULT_COUNT
  591. app.state.config.WEB_SEARCH_CONCURRENT_REQUESTS = WEB_SEARCH_CONCURRENT_REQUESTS
  592. app.state.config.WEB_LOADER_ENGINE = WEB_LOADER_ENGINE
  593. app.state.config.WEB_SEARCH_TRUST_ENV = WEB_SEARCH_TRUST_ENV
  594. app.state.config.BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL = (
  595. BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL
  596. )
  597. app.state.config.ENABLE_GOOGLE_DRIVE_INTEGRATION = ENABLE_GOOGLE_DRIVE_INTEGRATION
  598. app.state.config.ENABLE_ONEDRIVE_INTEGRATION = ENABLE_ONEDRIVE_INTEGRATION
  599. app.state.config.SEARXNG_QUERY_URL = SEARXNG_QUERY_URL
  600. app.state.config.YACY_QUERY_URL = YACY_QUERY_URL
  601. app.state.config.YACY_USERNAME = YACY_USERNAME
  602. app.state.config.YACY_PASSWORD = YACY_PASSWORD
  603. app.state.config.GOOGLE_PSE_API_KEY = GOOGLE_PSE_API_KEY
  604. app.state.config.GOOGLE_PSE_ENGINE_ID = GOOGLE_PSE_ENGINE_ID
  605. app.state.config.BRAVE_SEARCH_API_KEY = BRAVE_SEARCH_API_KEY
  606. app.state.config.KAGI_SEARCH_API_KEY = KAGI_SEARCH_API_KEY
  607. app.state.config.MOJEEK_SEARCH_API_KEY = MOJEEK_SEARCH_API_KEY
  608. app.state.config.BOCHA_SEARCH_API_KEY = BOCHA_SEARCH_API_KEY
  609. app.state.config.SERPSTACK_API_KEY = SERPSTACK_API_KEY
  610. app.state.config.SERPSTACK_HTTPS = SERPSTACK_HTTPS
  611. app.state.config.SERPER_API_KEY = SERPER_API_KEY
  612. app.state.config.SERPLY_API_KEY = SERPLY_API_KEY
  613. app.state.config.TAVILY_API_KEY = TAVILY_API_KEY
  614. app.state.config.SEARCHAPI_API_KEY = SEARCHAPI_API_KEY
  615. app.state.config.SEARCHAPI_ENGINE = SEARCHAPI_ENGINE
  616. app.state.config.SERPAPI_API_KEY = SERPAPI_API_KEY
  617. app.state.config.SERPAPI_ENGINE = SERPAPI_ENGINE
  618. app.state.config.JINA_API_KEY = JINA_API_KEY
  619. app.state.config.BING_SEARCH_V7_ENDPOINT = BING_SEARCH_V7_ENDPOINT
  620. app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY = BING_SEARCH_V7_SUBSCRIPTION_KEY
  621. app.state.config.EXA_API_KEY = EXA_API_KEY
  622. app.state.config.PERPLEXITY_API_KEY = PERPLEXITY_API_KEY
  623. app.state.config.SOUGOU_API_SID = SOUGOU_API_SID
  624. app.state.config.SOUGOU_API_SK = SOUGOU_API_SK
  625. app.state.config.EXTERNAL_WEB_SEARCH_URL = EXTERNAL_WEB_SEARCH_URL
  626. app.state.config.EXTERNAL_WEB_SEARCH_API_KEY = EXTERNAL_WEB_SEARCH_API_KEY
  627. app.state.config.EXTERNAL_WEB_LOADER_URL = EXTERNAL_WEB_LOADER_URL
  628. app.state.config.EXTERNAL_WEB_LOADER_API_KEY = EXTERNAL_WEB_LOADER_API_KEY
  629. app.state.config.PLAYWRIGHT_WS_URL = PLAYWRIGHT_WS_URL
  630. app.state.config.PLAYWRIGHT_TIMEOUT = PLAYWRIGHT_TIMEOUT
  631. app.state.config.FIRECRAWL_API_BASE_URL = FIRECRAWL_API_BASE_URL
  632. app.state.config.FIRECRAWL_API_KEY = FIRECRAWL_API_KEY
  633. app.state.config.TAVILY_EXTRACT_DEPTH = TAVILY_EXTRACT_DEPTH
  634. app.state.EMBEDDING_FUNCTION = None
  635. app.state.ef = None
  636. app.state.rf = None
  637. app.state.YOUTUBE_LOADER_TRANSLATION = None
  638. try:
  639. app.state.ef = get_ef(
  640. app.state.config.RAG_EMBEDDING_ENGINE,
  641. app.state.config.RAG_EMBEDDING_MODEL,
  642. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  643. )
  644. app.state.rf = get_rf(
  645. app.state.config.RAG_RERANKING_MODEL,
  646. RAG_RERANKING_MODEL_AUTO_UPDATE,
  647. )
  648. except Exception as e:
  649. log.error(f"Error updating models: {e}")
  650. pass
  651. app.state.EMBEDDING_FUNCTION = get_embedding_function(
  652. app.state.config.RAG_EMBEDDING_ENGINE,
  653. app.state.config.RAG_EMBEDDING_MODEL,
  654. app.state.ef,
  655. (
  656. app.state.config.RAG_OPENAI_API_BASE_URL
  657. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  658. else app.state.config.RAG_OLLAMA_BASE_URL
  659. ),
  660. (
  661. app.state.config.RAG_OPENAI_API_KEY
  662. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  663. else app.state.config.RAG_OLLAMA_API_KEY
  664. ),
  665. app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  666. )
  667. ########################################
  668. #
  669. # CODE EXECUTION
  670. #
  671. ########################################
  672. app.state.config.ENABLE_CODE_EXECUTION = ENABLE_CODE_EXECUTION
  673. app.state.config.CODE_EXECUTION_ENGINE = CODE_EXECUTION_ENGINE
  674. app.state.config.CODE_EXECUTION_JUPYTER_URL = CODE_EXECUTION_JUPYTER_URL
  675. app.state.config.CODE_EXECUTION_JUPYTER_AUTH = CODE_EXECUTION_JUPYTER_AUTH
  676. app.state.config.CODE_EXECUTION_JUPYTER_AUTH_TOKEN = CODE_EXECUTION_JUPYTER_AUTH_TOKEN
  677. app.state.config.CODE_EXECUTION_JUPYTER_AUTH_PASSWORD = (
  678. CODE_EXECUTION_JUPYTER_AUTH_PASSWORD
  679. )
  680. app.state.config.CODE_EXECUTION_JUPYTER_TIMEOUT = CODE_EXECUTION_JUPYTER_TIMEOUT
  681. app.state.config.ENABLE_CODE_INTERPRETER = ENABLE_CODE_INTERPRETER
  682. app.state.config.CODE_INTERPRETER_ENGINE = CODE_INTERPRETER_ENGINE
  683. app.state.config.CODE_INTERPRETER_PROMPT_TEMPLATE = CODE_INTERPRETER_PROMPT_TEMPLATE
  684. app.state.config.CODE_INTERPRETER_JUPYTER_URL = CODE_INTERPRETER_JUPYTER_URL
  685. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH = CODE_INTERPRETER_JUPYTER_AUTH
  686. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH_TOKEN = (
  687. CODE_INTERPRETER_JUPYTER_AUTH_TOKEN
  688. )
  689. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD = (
  690. CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD
  691. )
  692. app.state.config.CODE_INTERPRETER_JUPYTER_TIMEOUT = CODE_INTERPRETER_JUPYTER_TIMEOUT
  693. ########################################
  694. #
  695. # IMAGES
  696. #
  697. ########################################
  698. app.state.config.IMAGE_GENERATION_ENGINE = IMAGE_GENERATION_ENGINE
  699. app.state.config.ENABLE_IMAGE_GENERATION = ENABLE_IMAGE_GENERATION
  700. app.state.config.ENABLE_IMAGE_PROMPT_GENERATION = ENABLE_IMAGE_PROMPT_GENERATION
  701. app.state.config.IMAGES_OPENAI_API_BASE_URL = IMAGES_OPENAI_API_BASE_URL
  702. app.state.config.IMAGES_OPENAI_API_KEY = IMAGES_OPENAI_API_KEY
  703. app.state.config.IMAGES_GEMINI_API_BASE_URL = IMAGES_GEMINI_API_BASE_URL
  704. app.state.config.IMAGES_GEMINI_API_KEY = IMAGES_GEMINI_API_KEY
  705. app.state.config.IMAGE_GENERATION_MODEL = IMAGE_GENERATION_MODEL
  706. app.state.config.AUTOMATIC1111_BASE_URL = AUTOMATIC1111_BASE_URL
  707. app.state.config.AUTOMATIC1111_API_AUTH = AUTOMATIC1111_API_AUTH
  708. app.state.config.AUTOMATIC1111_CFG_SCALE = AUTOMATIC1111_CFG_SCALE
  709. app.state.config.AUTOMATIC1111_SAMPLER = AUTOMATIC1111_SAMPLER
  710. app.state.config.AUTOMATIC1111_SCHEDULER = AUTOMATIC1111_SCHEDULER
  711. app.state.config.COMFYUI_BASE_URL = COMFYUI_BASE_URL
  712. app.state.config.COMFYUI_API_KEY = COMFYUI_API_KEY
  713. app.state.config.COMFYUI_WORKFLOW = COMFYUI_WORKFLOW
  714. app.state.config.COMFYUI_WORKFLOW_NODES = COMFYUI_WORKFLOW_NODES
  715. app.state.config.IMAGE_SIZE = IMAGE_SIZE
  716. app.state.config.IMAGE_STEPS = IMAGE_STEPS
  717. ########################################
  718. #
  719. # AUDIO
  720. #
  721. ########################################
  722. app.state.config.STT_OPENAI_API_BASE_URL = AUDIO_STT_OPENAI_API_BASE_URL
  723. app.state.config.STT_OPENAI_API_KEY = AUDIO_STT_OPENAI_API_KEY
  724. app.state.config.STT_ENGINE = AUDIO_STT_ENGINE
  725. app.state.config.STT_MODEL = AUDIO_STT_MODEL
  726. app.state.config.WHISPER_MODEL = WHISPER_MODEL
  727. app.state.config.WHISPER_VAD_FILTER = WHISPER_VAD_FILTER
  728. app.state.config.DEEPGRAM_API_KEY = DEEPGRAM_API_KEY
  729. app.state.config.AUDIO_STT_AZURE_API_KEY = AUDIO_STT_AZURE_API_KEY
  730. app.state.config.AUDIO_STT_AZURE_REGION = AUDIO_STT_AZURE_REGION
  731. app.state.config.AUDIO_STT_AZURE_LOCALES = AUDIO_STT_AZURE_LOCALES
  732. app.state.config.AUDIO_STT_AZURE_BASE_URL = AUDIO_STT_AZURE_BASE_URL
  733. app.state.config.AUDIO_STT_AZURE_MAX_SPEAKERS = AUDIO_STT_AZURE_MAX_SPEAKERS
  734. app.state.config.TTS_OPENAI_API_BASE_URL = AUDIO_TTS_OPENAI_API_BASE_URL
  735. app.state.config.TTS_OPENAI_API_KEY = AUDIO_TTS_OPENAI_API_KEY
  736. app.state.config.TTS_ENGINE = AUDIO_TTS_ENGINE
  737. app.state.config.TTS_MODEL = AUDIO_TTS_MODEL
  738. app.state.config.TTS_VOICE = AUDIO_TTS_VOICE
  739. app.state.config.TTS_API_KEY = AUDIO_TTS_API_KEY
  740. app.state.config.TTS_SPLIT_ON = AUDIO_TTS_SPLIT_ON
  741. app.state.config.TTS_AZURE_SPEECH_REGION = AUDIO_TTS_AZURE_SPEECH_REGION
  742. app.state.config.TTS_AZURE_SPEECH_BASE_URL = AUDIO_TTS_AZURE_SPEECH_BASE_URL
  743. app.state.config.TTS_AZURE_SPEECH_OUTPUT_FORMAT = AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT
  744. app.state.faster_whisper_model = None
  745. app.state.speech_synthesiser = None
  746. app.state.speech_speaker_embeddings_dataset = None
  747. ########################################
  748. #
  749. # TASKS
  750. #
  751. ########################################
  752. app.state.config.TASK_MODEL = TASK_MODEL
  753. app.state.config.TASK_MODEL_EXTERNAL = TASK_MODEL_EXTERNAL
  754. app.state.config.ENABLE_SEARCH_QUERY_GENERATION = ENABLE_SEARCH_QUERY_GENERATION
  755. app.state.config.ENABLE_RETRIEVAL_QUERY_GENERATION = ENABLE_RETRIEVAL_QUERY_GENERATION
  756. app.state.config.ENABLE_AUTOCOMPLETE_GENERATION = ENABLE_AUTOCOMPLETE_GENERATION
  757. app.state.config.ENABLE_TAGS_GENERATION = ENABLE_TAGS_GENERATION
  758. app.state.config.ENABLE_TITLE_GENERATION = ENABLE_TITLE_GENERATION
  759. app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE = TITLE_GENERATION_PROMPT_TEMPLATE
  760. app.state.config.TAGS_GENERATION_PROMPT_TEMPLATE = TAGS_GENERATION_PROMPT_TEMPLATE
  761. app.state.config.IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE = (
  762. IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE
  763. )
  764. app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
  765. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
  766. )
  767. app.state.config.QUERY_GENERATION_PROMPT_TEMPLATE = QUERY_GENERATION_PROMPT_TEMPLATE
  768. app.state.config.AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE = (
  769. AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE
  770. )
  771. app.state.config.AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH = (
  772. AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH
  773. )
  774. ########################################
  775. #
  776. # WEBUI
  777. #
  778. ########################################
  779. app.state.MODELS = {}
  780. class RedirectMiddleware(BaseHTTPMiddleware):
  781. async def dispatch(self, request: Request, call_next):
  782. # Check if the request is a GET request
  783. if request.method == "GET":
  784. path = request.url.path
  785. query_params = dict(parse_qs(urlparse(str(request.url)).query))
  786. # Check for the specific watch path and the presence of 'v' parameter
  787. if path.endswith("/watch") and "v" in query_params:
  788. # Extract the first 'v' parameter
  789. video_id = query_params["v"][0]
  790. encoded_video_id = urlencode({"youtube": video_id})
  791. redirect_url = f"/?{encoded_video_id}"
  792. return RedirectResponse(url=redirect_url)
  793. # Proceed with the normal flow of other requests
  794. response = await call_next(request)
  795. return response
  796. # Add the middleware to the app
  797. app.add_middleware(RedirectMiddleware)
  798. app.add_middleware(SecurityHeadersMiddleware)
  799. @app.middleware("http")
  800. async def commit_session_after_request(request: Request, call_next):
  801. response = await call_next(request)
  802. # log.debug("Commit session after request")
  803. Session.commit()
  804. return response
  805. @app.middleware("http")
  806. async def check_url(request: Request, call_next):
  807. start_time = int(time.time())
  808. request.state.token = get_http_authorization_cred(
  809. request.headers.get("Authorization")
  810. )
  811. request.state.enable_api_key = app.state.config.ENABLE_API_KEY
  812. response = await call_next(request)
  813. process_time = int(time.time()) - start_time
  814. response.headers["X-Process-Time"] = str(process_time)
  815. return response
  816. @app.middleware("http")
  817. async def inspect_websocket(request: Request, call_next):
  818. if (
  819. "/ws/socket.io" in request.url.path
  820. and request.query_params.get("transport") == "websocket"
  821. ):
  822. upgrade = (request.headers.get("Upgrade") or "").lower()
  823. connection = (request.headers.get("Connection") or "").lower().split(",")
  824. # Check that there's the correct headers for an upgrade, else reject the connection
  825. # This is to work around this upstream issue: https://github.com/miguelgrinberg/python-engineio/issues/367
  826. if upgrade != "websocket" or "upgrade" not in connection:
  827. return JSONResponse(
  828. status_code=status.HTTP_400_BAD_REQUEST,
  829. content={"detail": "Invalid WebSocket upgrade request"},
  830. )
  831. return await call_next(request)
  832. app.add_middleware(
  833. CORSMiddleware,
  834. allow_origins=CORS_ALLOW_ORIGIN,
  835. allow_credentials=True,
  836. allow_methods=["*"],
  837. allow_headers=["*"],
  838. )
  839. app.mount("/ws", socket_app)
  840. app.include_router(ollama.router, prefix="/ollama", tags=["ollama"])
  841. app.include_router(openai.router, prefix="/openai", tags=["openai"])
  842. app.include_router(pipelines.router, prefix="/api/v1/pipelines", tags=["pipelines"])
  843. app.include_router(tasks.router, prefix="/api/v1/tasks", tags=["tasks"])
  844. app.include_router(images.router, prefix="/api/v1/images", tags=["images"])
  845. app.include_router(audio.router, prefix="/api/v1/audio", tags=["audio"])
  846. app.include_router(retrieval.router, prefix="/api/v1/retrieval", tags=["retrieval"])
  847. app.include_router(configs.router, prefix="/api/v1/configs", tags=["configs"])
  848. app.include_router(auths.router, prefix="/api/v1/auths", tags=["auths"])
  849. app.include_router(users.router, prefix="/api/v1/users", tags=["users"])
  850. app.include_router(channels.router, prefix="/api/v1/channels", tags=["channels"])
  851. app.include_router(chats.router, prefix="/api/v1/chats", tags=["chats"])
  852. app.include_router(notes.router, prefix="/api/v1/notes", tags=["notes"])
  853. app.include_router(models.router, prefix="/api/v1/models", tags=["models"])
  854. app.include_router(knowledge.router, prefix="/api/v1/knowledge", tags=["knowledge"])
  855. app.include_router(prompts.router, prefix="/api/v1/prompts", tags=["prompts"])
  856. app.include_router(tools.router, prefix="/api/v1/tools", tags=["tools"])
  857. app.include_router(memories.router, prefix="/api/v1/memories", tags=["memories"])
  858. app.include_router(folders.router, prefix="/api/v1/folders", tags=["folders"])
  859. app.include_router(groups.router, prefix="/api/v1/groups", tags=["groups"])
  860. app.include_router(files.router, prefix="/api/v1/files", tags=["files"])
  861. app.include_router(functions.router, prefix="/api/v1/functions", tags=["functions"])
  862. app.include_router(
  863. evaluations.router, prefix="/api/v1/evaluations", tags=["evaluations"]
  864. )
  865. app.include_router(utils.router, prefix="/api/v1/utils", tags=["utils"])
  866. try:
  867. audit_level = AuditLevel(AUDIT_LOG_LEVEL)
  868. except ValueError as e:
  869. logger.error(f"Invalid audit level: {AUDIT_LOG_LEVEL}. Error: {e}")
  870. audit_level = AuditLevel.NONE
  871. if audit_level != AuditLevel.NONE:
  872. app.add_middleware(
  873. AuditLoggingMiddleware,
  874. audit_level=audit_level,
  875. excluded_paths=AUDIT_EXCLUDED_PATHS,
  876. max_body_size=MAX_BODY_LOG_SIZE,
  877. )
  878. ##################################
  879. #
  880. # Chat Endpoints
  881. #
  882. ##################################
  883. @app.get("/api/models")
  884. async def get_models(request: Request, user=Depends(get_verified_user)):
  885. def get_filtered_models(models, user):
  886. filtered_models = []
  887. for model in models:
  888. if model.get("arena"):
  889. if has_access(
  890. user.id,
  891. type="read",
  892. access_control=model.get("info", {})
  893. .get("meta", {})
  894. .get("access_control", {}),
  895. ):
  896. filtered_models.append(model)
  897. continue
  898. model_info = Models.get_model_by_id(model["id"])
  899. if model_info:
  900. if user.id == model_info.user_id or has_access(
  901. user.id, type="read", access_control=model_info.access_control
  902. ):
  903. filtered_models.append(model)
  904. return filtered_models
  905. all_models = await get_all_models(request, user=user)
  906. models = []
  907. for model in all_models:
  908. # Filter out filter pipelines
  909. if "pipeline" in model and model["pipeline"].get("type", None) == "filter":
  910. continue
  911. try:
  912. model_tags = [
  913. tag.get("name")
  914. for tag in model.get("info", {}).get("meta", {}).get("tags", [])
  915. ]
  916. tags = [tag.get("name") for tag in model.get("tags", [])]
  917. tags = list(set(model_tags + tags))
  918. model["tags"] = [{"name": tag} for tag in tags]
  919. except Exception as e:
  920. log.debug(f"Error processing model tags: {e}")
  921. model["tags"] = []
  922. pass
  923. models.append(model)
  924. model_order_list = request.app.state.config.MODEL_ORDER_LIST
  925. if model_order_list:
  926. model_order_dict = {model_id: i for i, model_id in enumerate(model_order_list)}
  927. # Sort models by order list priority, with fallback for those not in the list
  928. models.sort(
  929. key=lambda x: (model_order_dict.get(x["id"], float("inf")), x["name"])
  930. )
  931. # Filter out models that the user does not have access to
  932. if user.role == "user" and not BYPASS_MODEL_ACCESS_CONTROL:
  933. models = get_filtered_models(models, user)
  934. log.debug(
  935. f"/api/models returned filtered models accessible to the user: {json.dumps([model['id'] for model in models])}"
  936. )
  937. return {"data": models}
  938. @app.get("/api/models/base")
  939. async def get_base_models(request: Request, user=Depends(get_admin_user)):
  940. models = await get_all_base_models(request, user=user)
  941. return {"data": models}
  942. @app.post("/api/chat/completions")
  943. async def chat_completion(
  944. request: Request,
  945. form_data: dict,
  946. user=Depends(get_verified_user),
  947. ):
  948. if not request.app.state.MODELS:
  949. await get_all_models(request, user=user)
  950. model_item = form_data.pop("model_item", {})
  951. tasks = form_data.pop("background_tasks", None)
  952. metadata = {}
  953. try:
  954. if not model_item.get("direct", False):
  955. model_id = form_data.get("model", None)
  956. if model_id not in request.app.state.MODELS:
  957. raise Exception("Model not found")
  958. model = request.app.state.MODELS[model_id]
  959. model_info = Models.get_model_by_id(model_id)
  960. # Check if user has access to the model
  961. if not BYPASS_MODEL_ACCESS_CONTROL and user.role == "user":
  962. try:
  963. check_model_access(user, model)
  964. except Exception as e:
  965. raise e
  966. else:
  967. model = model_item
  968. model_info = None
  969. request.state.direct = True
  970. request.state.model = model
  971. metadata = {
  972. "user_id": user.id,
  973. "chat_id": form_data.pop("chat_id", None),
  974. "message_id": form_data.pop("id", None),
  975. "session_id": form_data.pop("session_id", None),
  976. "tool_ids": form_data.get("tool_ids", None),
  977. "tool_servers": form_data.pop("tool_servers", None),
  978. "files": form_data.get("files", None),
  979. "features": form_data.get("features", None),
  980. "variables": form_data.get("variables", None),
  981. "model": model,
  982. "direct": model_item.get("direct", False),
  983. **(
  984. {"function_calling": "native"}
  985. if form_data.get("params", {}).get("function_calling") == "native"
  986. or (
  987. model_info
  988. and model_info.params.model_dump().get("function_calling")
  989. == "native"
  990. )
  991. else {}
  992. ),
  993. }
  994. request.state.metadata = metadata
  995. form_data["metadata"] = metadata
  996. form_data, metadata, events = await process_chat_payload(
  997. request, form_data, user, metadata, model
  998. )
  999. except Exception as e:
  1000. log.debug(f"Error processing chat payload: {e}")
  1001. if metadata.get("chat_id") and metadata.get("message_id"):
  1002. # Update the chat message with the error
  1003. Chats.upsert_message_to_chat_by_id_and_message_id(
  1004. metadata["chat_id"],
  1005. metadata["message_id"],
  1006. {
  1007. "error": {"content": str(e)},
  1008. },
  1009. )
  1010. raise HTTPException(
  1011. status_code=status.HTTP_400_BAD_REQUEST,
  1012. detail=str(e),
  1013. )
  1014. try:
  1015. response = await chat_completion_handler(request, form_data, user)
  1016. return await process_chat_response(
  1017. request, response, form_data, user, metadata, model, events, tasks
  1018. )
  1019. except Exception as e:
  1020. raise HTTPException(
  1021. status_code=status.HTTP_400_BAD_REQUEST,
  1022. detail=str(e),
  1023. )
  1024. # Alias for chat_completion (Legacy)
  1025. generate_chat_completions = chat_completion
  1026. generate_chat_completion = chat_completion
  1027. @app.post("/api/chat/completed")
  1028. async def chat_completed(
  1029. request: Request, form_data: dict, user=Depends(get_verified_user)
  1030. ):
  1031. try:
  1032. model_item = form_data.pop("model_item", {})
  1033. if model_item.get("direct", False):
  1034. request.state.direct = True
  1035. request.state.model = model_item
  1036. return await chat_completed_handler(request, form_data, user)
  1037. except Exception as e:
  1038. raise HTTPException(
  1039. status_code=status.HTTP_400_BAD_REQUEST,
  1040. detail=str(e),
  1041. )
  1042. @app.post("/api/chat/actions/{action_id}")
  1043. async def chat_action(
  1044. request: Request, action_id: str, form_data: dict, user=Depends(get_verified_user)
  1045. ):
  1046. try:
  1047. model_item = form_data.pop("model_item", {})
  1048. if model_item.get("direct", False):
  1049. request.state.direct = True
  1050. request.state.model = model_item
  1051. return await chat_action_handler(request, action_id, form_data, user)
  1052. except Exception as e:
  1053. raise HTTPException(
  1054. status_code=status.HTTP_400_BAD_REQUEST,
  1055. detail=str(e),
  1056. )
  1057. @app.post("/api/tasks/stop/{task_id}")
  1058. async def stop_task_endpoint(task_id: str, user=Depends(get_verified_user)):
  1059. try:
  1060. result = await stop_task(task_id)
  1061. return result
  1062. except ValueError as e:
  1063. raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=str(e))
  1064. @app.get("/api/tasks")
  1065. async def list_tasks_endpoint(user=Depends(get_verified_user)):
  1066. return {"tasks": list_tasks()}
  1067. @app.get("/api/tasks/chat/{chat_id}")
  1068. async def list_tasks_by_chat_id_endpoint(chat_id: str, user=Depends(get_verified_user)):
  1069. chat = Chats.get_chat_by_id(chat_id)
  1070. if chat is None or chat.user_id != user.id:
  1071. return {"task_ids": []}
  1072. task_ids = list_task_ids_by_chat_id(chat_id)
  1073. print(f"Task IDs for chat {chat_id}: {task_ids}")
  1074. return {"task_ids": task_ids}
  1075. ##################################
  1076. #
  1077. # Config Endpoints
  1078. #
  1079. ##################################
  1080. @app.get("/api/config")
  1081. async def get_app_config(request: Request):
  1082. user = None
  1083. if "token" in request.cookies:
  1084. token = request.cookies.get("token")
  1085. try:
  1086. data = decode_token(token)
  1087. except Exception as e:
  1088. log.debug(e)
  1089. raise HTTPException(
  1090. status_code=status.HTTP_401_UNAUTHORIZED,
  1091. detail="Invalid token",
  1092. )
  1093. if data is not None and "id" in data:
  1094. user = Users.get_user_by_id(data["id"])
  1095. user_count = Users.get_num_users()
  1096. onboarding = False
  1097. if user is None:
  1098. onboarding = user_count == 0
  1099. return {
  1100. **({"onboarding": True} if onboarding else {}),
  1101. "status": True,
  1102. "name": app.state.WEBUI_NAME,
  1103. "version": VERSION,
  1104. "default_locale": str(DEFAULT_LOCALE),
  1105. "oauth": {
  1106. "providers": {
  1107. name: config.get("name", name)
  1108. for name, config in OAUTH_PROVIDERS.items()
  1109. }
  1110. },
  1111. "features": {
  1112. "auth": WEBUI_AUTH,
  1113. "auth_trusted_header": bool(app.state.AUTH_TRUSTED_EMAIL_HEADER),
  1114. "enable_ldap": app.state.config.ENABLE_LDAP,
  1115. "enable_api_key": app.state.config.ENABLE_API_KEY,
  1116. "enable_signup": app.state.config.ENABLE_SIGNUP,
  1117. "enable_login_form": app.state.config.ENABLE_LOGIN_FORM,
  1118. "enable_websocket": ENABLE_WEBSOCKET_SUPPORT,
  1119. **(
  1120. {
  1121. "enable_direct_connections": app.state.config.ENABLE_DIRECT_CONNECTIONS,
  1122. "enable_channels": app.state.config.ENABLE_CHANNELS,
  1123. "enable_notes": app.state.config.ENABLE_NOTES,
  1124. "enable_web_search": app.state.config.ENABLE_WEB_SEARCH,
  1125. "enable_code_execution": app.state.config.ENABLE_CODE_EXECUTION,
  1126. "enable_code_interpreter": app.state.config.ENABLE_CODE_INTERPRETER,
  1127. "enable_image_generation": app.state.config.ENABLE_IMAGE_GENERATION,
  1128. "enable_autocomplete_generation": app.state.config.ENABLE_AUTOCOMPLETE_GENERATION,
  1129. "enable_community_sharing": app.state.config.ENABLE_COMMUNITY_SHARING,
  1130. "enable_message_rating": app.state.config.ENABLE_MESSAGE_RATING,
  1131. "enable_user_webhooks": app.state.config.ENABLE_USER_WEBHOOKS,
  1132. "enable_admin_export": ENABLE_ADMIN_EXPORT,
  1133. "enable_admin_chat_access": ENABLE_ADMIN_CHAT_ACCESS,
  1134. "enable_google_drive_integration": app.state.config.ENABLE_GOOGLE_DRIVE_INTEGRATION,
  1135. "enable_onedrive_integration": app.state.config.ENABLE_ONEDRIVE_INTEGRATION,
  1136. }
  1137. if user is not None
  1138. else {}
  1139. ),
  1140. },
  1141. **(
  1142. {
  1143. "default_models": app.state.config.DEFAULT_MODELS,
  1144. "default_prompt_suggestions": app.state.config.DEFAULT_PROMPT_SUGGESTIONS,
  1145. "user_count": user_count,
  1146. "code": {
  1147. "engine": app.state.config.CODE_EXECUTION_ENGINE,
  1148. },
  1149. "audio": {
  1150. "tts": {
  1151. "engine": app.state.config.TTS_ENGINE,
  1152. "voice": app.state.config.TTS_VOICE,
  1153. "split_on": app.state.config.TTS_SPLIT_ON,
  1154. },
  1155. "stt": {
  1156. "engine": app.state.config.STT_ENGINE,
  1157. },
  1158. },
  1159. "file": {
  1160. "max_size": app.state.config.FILE_MAX_SIZE,
  1161. "max_count": app.state.config.FILE_MAX_COUNT,
  1162. },
  1163. "permissions": {**app.state.config.USER_PERMISSIONS},
  1164. "google_drive": {
  1165. "client_id": GOOGLE_DRIVE_CLIENT_ID.value,
  1166. "api_key": GOOGLE_DRIVE_API_KEY.value,
  1167. },
  1168. "onedrive": {
  1169. "client_id": ONEDRIVE_CLIENT_ID.value,
  1170. "sharepoint_url": ONEDRIVE_SHAREPOINT_URL.value,
  1171. "sharepoint_tenant_id": ONEDRIVE_SHAREPOINT_TENANT_ID.value,
  1172. },
  1173. "license_metadata": app.state.LICENSE_METADATA,
  1174. **(
  1175. {
  1176. "active_entries": app.state.USER_COUNT,
  1177. }
  1178. if user.role == "admin"
  1179. else {}
  1180. ),
  1181. }
  1182. if user is not None
  1183. else {}
  1184. ),
  1185. }
  1186. class UrlForm(BaseModel):
  1187. url: str
  1188. @app.get("/api/webhook")
  1189. async def get_webhook_url(user=Depends(get_admin_user)):
  1190. return {
  1191. "url": app.state.config.WEBHOOK_URL,
  1192. }
  1193. @app.post("/api/webhook")
  1194. async def update_webhook_url(form_data: UrlForm, user=Depends(get_admin_user)):
  1195. app.state.config.WEBHOOK_URL = form_data.url
  1196. app.state.WEBHOOK_URL = app.state.config.WEBHOOK_URL
  1197. return {"url": app.state.config.WEBHOOK_URL}
  1198. @app.get("/api/version")
  1199. async def get_app_version():
  1200. return {
  1201. "version": VERSION,
  1202. }
  1203. @app.get("/api/version/updates")
  1204. async def get_app_latest_release_version(user=Depends(get_verified_user)):
  1205. if OFFLINE_MODE:
  1206. log.debug(
  1207. f"Offline mode is enabled, returning current version as latest version"
  1208. )
  1209. return {"current": VERSION, "latest": VERSION}
  1210. try:
  1211. timeout = aiohttp.ClientTimeout(total=1)
  1212. async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
  1213. async with session.get(
  1214. "https://api.github.com/repos/open-webui/open-webui/releases/latest"
  1215. ) as response:
  1216. response.raise_for_status()
  1217. data = await response.json()
  1218. latest_version = data["tag_name"]
  1219. return {"current": VERSION, "latest": latest_version[1:]}
  1220. except Exception as e:
  1221. log.debug(e)
  1222. return {"current": VERSION, "latest": VERSION}
  1223. @app.get("/api/changelog")
  1224. async def get_app_changelog():
  1225. return {key: CHANGELOG[key] for idx, key in enumerate(CHANGELOG) if idx < 5}
  1226. ############################
  1227. # OAuth Login & Callback
  1228. ############################
  1229. # SessionMiddleware is used by authlib for oauth
  1230. if len(OAUTH_PROVIDERS) > 0:
  1231. app.add_middleware(
  1232. SessionMiddleware,
  1233. secret_key=WEBUI_SECRET_KEY,
  1234. session_cookie="oui-session",
  1235. same_site=WEBUI_SESSION_COOKIE_SAME_SITE,
  1236. https_only=WEBUI_SESSION_COOKIE_SECURE,
  1237. )
  1238. @app.get("/oauth/{provider}/login")
  1239. async def oauth_login(provider: str, request: Request):
  1240. return await oauth_manager.handle_login(request, provider)
  1241. # OAuth login logic is as follows:
  1242. # 1. Attempt to find a user with matching subject ID, tied to the provider
  1243. # 2. If OAUTH_MERGE_ACCOUNTS_BY_EMAIL is true, find a user with the email address provided via OAuth
  1244. # - This is considered insecure in general, as OAuth providers do not always verify email addresses
  1245. # 3. If there is no user, and ENABLE_OAUTH_SIGNUP is true, create a user
  1246. # - Email addresses are considered unique, so we fail registration if the email address is already taken
  1247. @app.get("/oauth/{provider}/callback")
  1248. async def oauth_callback(provider: str, request: Request, response: Response):
  1249. return await oauth_manager.handle_callback(request, provider, response)
  1250. @app.get("/manifest.json")
  1251. async def get_manifest_json():
  1252. if app.state.EXTERNAL_PWA_MANIFEST_URL:
  1253. return requests.get(app.state.EXTERNAL_PWA_MANIFEST_URL).json()
  1254. else:
  1255. return {
  1256. "name": app.state.WEBUI_NAME,
  1257. "short_name": app.state.WEBUI_NAME,
  1258. "description": "Open WebUI is an open, extensible, user-friendly interface for AI that adapts to your workflow.",
  1259. "start_url": "/",
  1260. "display": "standalone",
  1261. "background_color": "#343541",
  1262. "orientation": "any",
  1263. "icons": [
  1264. {
  1265. "src": "/static/logo.png",
  1266. "type": "image/png",
  1267. "sizes": "500x500",
  1268. "purpose": "any",
  1269. },
  1270. {
  1271. "src": "/static/logo.png",
  1272. "type": "image/png",
  1273. "sizes": "500x500",
  1274. "purpose": "maskable",
  1275. },
  1276. ],
  1277. }
  1278. @app.get("/opensearch.xml")
  1279. async def get_opensearch_xml():
  1280. xml_content = rf"""
  1281. <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:moz="http://www.mozilla.org/2006/browser/search/">
  1282. <ShortName>{app.state.WEBUI_NAME}</ShortName>
  1283. <Description>Search {app.state.WEBUI_NAME}</Description>
  1284. <InputEncoding>UTF-8</InputEncoding>
  1285. <Image width="16" height="16" type="image/x-icon">{app.state.config.WEBUI_URL}/static/favicon.png</Image>
  1286. <Url type="text/html" method="get" template="{app.state.config.WEBUI_URL}/?q={"{searchTerms}"}"/>
  1287. <moz:SearchForm>{app.state.config.WEBUI_URL}</moz:SearchForm>
  1288. </OpenSearchDescription>
  1289. """
  1290. return Response(content=xml_content, media_type="application/xml")
  1291. @app.get("/health")
  1292. async def healthcheck():
  1293. return {"status": True}
  1294. @app.get("/health/db")
  1295. async def healthcheck_with_db():
  1296. Session.execute(text("SELECT 1;")).all()
  1297. return {"status": True}
  1298. app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
  1299. app.mount("/cache", StaticFiles(directory=CACHE_DIR), name="cache")
  1300. def swagger_ui_html(*args, **kwargs):
  1301. return get_swagger_ui_html(
  1302. *args,
  1303. **kwargs,
  1304. swagger_js_url="/static/swagger-ui/swagger-ui-bundle.js",
  1305. swagger_css_url="/static/swagger-ui/swagger-ui.css",
  1306. swagger_favicon_url="/static/swagger-ui/favicon.png",
  1307. )
  1308. applications.get_swagger_ui_html = swagger_ui_html
  1309. if os.path.exists(FRONTEND_BUILD_DIR):
  1310. mimetypes.add_type("text/javascript", ".js")
  1311. app.mount(
  1312. "/",
  1313. SPAStaticFiles(directory=FRONTEND_BUILD_DIR, html=True),
  1314. name="spa-static-files",
  1315. )
  1316. else:
  1317. log.warning(
  1318. f"Frontend build directory not found at '{FRONTEND_BUILD_DIR}'. Serving API only."
  1319. )