main.py 54 KB

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