main.py 51 KB

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