main.py 54 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632
  1. import asyncio
  2. import inspect
  3. import json
  4. import logging
  5. import mimetypes
  6. import os
  7. import shutil
  8. import sys
  9. import time
  10. import random
  11. from contextlib import asynccontextmanager
  12. from urllib.parse import urlencode, parse_qs, urlparse
  13. from pydantic import BaseModel
  14. from sqlalchemy import text
  15. from typing import Optional
  16. from aiocache import cached
  17. import aiohttp
  18. import anyio.to_thread
  19. import requests
  20. from fastapi import (
  21. Depends,
  22. FastAPI,
  23. File,
  24. Form,
  25. HTTPException,
  26. Request,
  27. UploadFile,
  28. status,
  29. applications,
  30. BackgroundTasks,
  31. )
  32. from fastapi.openapi.docs import get_swagger_ui_html
  33. from fastapi.middleware.cors import CORSMiddleware
  34. from fastapi.responses import JSONResponse, RedirectResponse
  35. from fastapi.staticfiles import StaticFiles
  36. from starlette.exceptions import HTTPException as StarletteHTTPException
  37. from starlette.middleware.base import BaseHTTPMiddleware
  38. from starlette.middleware.sessions import SessionMiddleware
  39. from starlette.responses import Response, StreamingResponse
  40. from open_webui.utils import logger
  41. from open_webui.utils.audit import AuditLevel, AuditLoggingMiddleware
  42. from open_webui.utils.logger import start_logger
  43. from open_webui.socket.main import (
  44. app as socket_app,
  45. periodic_usage_pool_cleanup,
  46. )
  47. from open_webui.routers import (
  48. audio,
  49. images,
  50. ollama,
  51. openai,
  52. retrieval,
  53. pipelines,
  54. tasks,
  55. auths,
  56. channels,
  57. chats,
  58. notes,
  59. folders,
  60. configs,
  61. groups,
  62. files,
  63. functions,
  64. memories,
  65. models,
  66. knowledge,
  67. prompts,
  68. evaluations,
  69. tools,
  70. users,
  71. utils,
  72. )
  73. from open_webui.routers.retrieval import (
  74. get_embedding_function,
  75. get_ef,
  76. get_rf,
  77. )
  78. from open_webui.internal.db import Session, engine
  79. from open_webui.models.functions import Functions
  80. from open_webui.models.models import Models
  81. from open_webui.models.users import UserModel, Users
  82. from open_webui.models.chats import Chats
  83. from open_webui.config import (
  84. LICENSE_KEY,
  85. # Ollama
  86. ENABLE_OLLAMA_API,
  87. OLLAMA_BASE_URLS,
  88. OLLAMA_API_CONFIGS,
  89. # OpenAI
  90. ENABLE_OPENAI_API,
  91. ONEDRIVE_CLIENT_ID,
  92. ONEDRIVE_SHAREPOINT_URL,
  93. ONEDRIVE_SHAREPOINT_TENANT_ID,
  94. OPENAI_API_BASE_URLS,
  95. OPENAI_API_KEYS,
  96. OPENAI_API_CONFIGS,
  97. # Direct Connections
  98. ENABLE_DIRECT_CONNECTIONS,
  99. # Thread pool size for FastAPI/AnyIO
  100. THREAD_POOL_SIZE,
  101. # Tool Server Configs
  102. TOOL_SERVER_CONNECTIONS,
  103. # Code Execution
  104. ENABLE_CODE_EXECUTION,
  105. CODE_EXECUTION_ENGINE,
  106. CODE_EXECUTION_JUPYTER_URL,
  107. CODE_EXECUTION_JUPYTER_AUTH,
  108. CODE_EXECUTION_JUPYTER_AUTH_TOKEN,
  109. CODE_EXECUTION_JUPYTER_AUTH_PASSWORD,
  110. CODE_EXECUTION_JUPYTER_TIMEOUT,
  111. ENABLE_CODE_INTERPRETER,
  112. CODE_INTERPRETER_ENGINE,
  113. CODE_INTERPRETER_PROMPT_TEMPLATE,
  114. CODE_INTERPRETER_JUPYTER_URL,
  115. CODE_INTERPRETER_JUPYTER_AUTH,
  116. CODE_INTERPRETER_JUPYTER_AUTH_TOKEN,
  117. CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD,
  118. CODE_INTERPRETER_JUPYTER_TIMEOUT,
  119. # Image
  120. AUTOMATIC1111_API_AUTH,
  121. AUTOMATIC1111_BASE_URL,
  122. AUTOMATIC1111_CFG_SCALE,
  123. AUTOMATIC1111_SAMPLER,
  124. AUTOMATIC1111_SCHEDULER,
  125. COMFYUI_BASE_URL,
  126. COMFYUI_API_KEY,
  127. COMFYUI_WORKFLOW,
  128. COMFYUI_WORKFLOW_NODES,
  129. ENABLE_IMAGE_GENERATION,
  130. ENABLE_IMAGE_PROMPT_GENERATION,
  131. IMAGE_GENERATION_ENGINE,
  132. IMAGE_GENERATION_MODEL,
  133. IMAGE_SIZE,
  134. IMAGE_STEPS,
  135. IMAGES_OPENAI_API_BASE_URL,
  136. IMAGES_OPENAI_API_KEY,
  137. IMAGES_GEMINI_API_BASE_URL,
  138. IMAGES_GEMINI_API_KEY,
  139. # Audio
  140. AUDIO_STT_ENGINE,
  141. AUDIO_STT_MODEL,
  142. AUDIO_STT_OPENAI_API_BASE_URL,
  143. AUDIO_STT_OPENAI_API_KEY,
  144. AUDIO_STT_AZURE_API_KEY,
  145. AUDIO_STT_AZURE_REGION,
  146. AUDIO_STT_AZURE_LOCALES,
  147. AUDIO_STT_AZURE_BASE_URL,
  148. AUDIO_STT_AZURE_MAX_SPEAKERS,
  149. AUDIO_TTS_API_KEY,
  150. AUDIO_TTS_ENGINE,
  151. AUDIO_TTS_MODEL,
  152. AUDIO_TTS_OPENAI_API_BASE_URL,
  153. AUDIO_TTS_OPENAI_API_KEY,
  154. AUDIO_TTS_SPLIT_ON,
  155. AUDIO_TTS_VOICE,
  156. AUDIO_TTS_AZURE_SPEECH_REGION,
  157. AUDIO_TTS_AZURE_SPEECH_BASE_URL,
  158. AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT,
  159. PLAYWRIGHT_WS_URL,
  160. PLAYWRIGHT_TIMEOUT,
  161. FIRECRAWL_API_BASE_URL,
  162. FIRECRAWL_API_KEY,
  163. WEB_LOADER_ENGINE,
  164. WHISPER_MODEL,
  165. WHISPER_VAD_FILTER,
  166. WHISPER_LANGUAGE,
  167. DEEPGRAM_API_KEY,
  168. WHISPER_MODEL_AUTO_UPDATE,
  169. WHISPER_MODEL_DIR,
  170. # Retrieval
  171. RAG_TEMPLATE,
  172. DEFAULT_RAG_TEMPLATE,
  173. RAG_FULL_CONTEXT,
  174. BYPASS_EMBEDDING_AND_RETRIEVAL,
  175. RAG_EMBEDDING_MODEL,
  176. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  177. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE,
  178. RAG_RERANKING_ENGINE,
  179. RAG_RERANKING_MODEL,
  180. RAG_EXTERNAL_RERANKER_URL,
  181. RAG_EXTERNAL_RERANKER_API_KEY,
  182. RAG_RERANKING_MODEL_AUTO_UPDATE,
  183. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE,
  184. RAG_EMBEDDING_ENGINE,
  185. RAG_EMBEDDING_BATCH_SIZE,
  186. RAG_RELEVANCE_THRESHOLD,
  187. RAG_ALLOWED_FILE_EXTENSIONS,
  188. RAG_FILE_MAX_COUNT,
  189. RAG_FILE_MAX_SIZE,
  190. RAG_OPENAI_API_BASE_URL,
  191. RAG_OPENAI_API_KEY,
  192. RAG_AZURE_OPENAI_BASE_URL,
  193. RAG_AZURE_OPENAI_API_KEY,
  194. RAG_AZURE_OPENAI_DEPLOYMENT,
  195. RAG_AZURE_OPENAI_VERSION,
  196. RAG_OLLAMA_BASE_URL,
  197. RAG_OLLAMA_API_KEY,
  198. CHUNK_OVERLAP,
  199. CHUNK_SIZE,
  200. CONTENT_EXTRACTION_ENGINE,
  201. EXTERNAL_DOCUMENT_LOADER_URL,
  202. EXTERNAL_DOCUMENT_LOADER_API_KEY,
  203. TIKA_SERVER_URL,
  204. DOCLING_SERVER_URL,
  205. DOCLING_OCR_ENGINE,
  206. DOCLING_OCR_LANG,
  207. DOCLING_DO_PICTURE_DESCRIPTION,
  208. DOCUMENT_INTELLIGENCE_ENDPOINT,
  209. DOCUMENT_INTELLIGENCE_KEY,
  210. MISTRAL_OCR_API_KEY,
  211. RAG_TOP_K,
  212. RAG_TOP_K_RERANKER,
  213. RAG_TEXT_SPLITTER,
  214. TIKTOKEN_ENCODING_NAME,
  215. PDF_EXTRACT_IMAGES,
  216. YOUTUBE_LOADER_LANGUAGE,
  217. YOUTUBE_LOADER_PROXY_URL,
  218. # Retrieval (Web Search)
  219. ENABLE_WEB_SEARCH,
  220. WEB_SEARCH_ENGINE,
  221. BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL,
  222. WEB_SEARCH_RESULT_COUNT,
  223. WEB_SEARCH_CONCURRENT_REQUESTS,
  224. WEB_SEARCH_TRUST_ENV,
  225. WEB_SEARCH_DOMAIN_FILTER_LIST,
  226. JINA_API_KEY,
  227. SEARCHAPI_API_KEY,
  228. SEARCHAPI_ENGINE,
  229. SERPAPI_API_KEY,
  230. SERPAPI_ENGINE,
  231. SEARXNG_QUERY_URL,
  232. YACY_QUERY_URL,
  233. YACY_USERNAME,
  234. YACY_PASSWORD,
  235. SERPER_API_KEY,
  236. SERPLY_API_KEY,
  237. SERPSTACK_API_KEY,
  238. SERPSTACK_HTTPS,
  239. TAVILY_API_KEY,
  240. TAVILY_EXTRACT_DEPTH,
  241. BING_SEARCH_V7_ENDPOINT,
  242. BING_SEARCH_V7_SUBSCRIPTION_KEY,
  243. BRAVE_SEARCH_API_KEY,
  244. EXA_API_KEY,
  245. PERPLEXITY_API_KEY,
  246. SOUGOU_API_SID,
  247. SOUGOU_API_SK,
  248. KAGI_SEARCH_API_KEY,
  249. MOJEEK_SEARCH_API_KEY,
  250. BOCHA_SEARCH_API_KEY,
  251. GOOGLE_PSE_API_KEY,
  252. GOOGLE_PSE_ENGINE_ID,
  253. GOOGLE_DRIVE_CLIENT_ID,
  254. GOOGLE_DRIVE_API_KEY,
  255. ONEDRIVE_CLIENT_ID,
  256. ONEDRIVE_SHAREPOINT_URL,
  257. ONEDRIVE_SHAREPOINT_TENANT_ID,
  258. ENABLE_RAG_HYBRID_SEARCH,
  259. ENABLE_RAG_LOCAL_WEB_FETCH,
  260. ENABLE_WEB_LOADER_SSL_VERIFICATION,
  261. ENABLE_GOOGLE_DRIVE_INTEGRATION,
  262. ENABLE_ONEDRIVE_INTEGRATION,
  263. UPLOAD_DIR,
  264. EXTERNAL_WEB_SEARCH_URL,
  265. EXTERNAL_WEB_SEARCH_API_KEY,
  266. EXTERNAL_WEB_LOADER_URL,
  267. EXTERNAL_WEB_LOADER_API_KEY,
  268. # WebUI
  269. WEBUI_AUTH,
  270. WEBUI_NAME,
  271. WEBUI_BANNERS,
  272. WEBHOOK_URL,
  273. ADMIN_EMAIL,
  274. SHOW_ADMIN_DETAILS,
  275. JWT_EXPIRES_IN,
  276. ENABLE_SIGNUP,
  277. ENABLE_LOGIN_FORM,
  278. ENABLE_API_KEY,
  279. ENABLE_API_KEY_ENDPOINT_RESTRICTIONS,
  280. API_KEY_ALLOWED_ENDPOINTS,
  281. ENABLE_CHANNELS,
  282. ENABLE_NOTES,
  283. ENABLE_COMMUNITY_SHARING,
  284. ENABLE_MESSAGE_RATING,
  285. ENABLE_USER_WEBHOOKS,
  286. ENABLE_EVALUATION_ARENA_MODELS,
  287. USER_PERMISSIONS,
  288. DEFAULT_USER_ROLE,
  289. PENDING_USER_OVERLAY_CONTENT,
  290. PENDING_USER_OVERLAY_TITLE,
  291. DEFAULT_PROMPT_SUGGESTIONS,
  292. DEFAULT_MODELS,
  293. DEFAULT_ARENA_MODEL,
  294. MODEL_ORDER_LIST,
  295. EVALUATION_ARENA_MODELS,
  296. # WebUI (OAuth)
  297. ENABLE_OAUTH_ROLE_MANAGEMENT,
  298. OAUTH_ROLES_CLAIM,
  299. OAUTH_EMAIL_CLAIM,
  300. OAUTH_PICTURE_CLAIM,
  301. OAUTH_USERNAME_CLAIM,
  302. OAUTH_ALLOWED_ROLES,
  303. OAUTH_ADMIN_ROLES,
  304. # WebUI (LDAP)
  305. ENABLE_LDAP,
  306. LDAP_SERVER_LABEL,
  307. LDAP_SERVER_HOST,
  308. LDAP_SERVER_PORT,
  309. LDAP_ATTRIBUTE_FOR_MAIL,
  310. LDAP_ATTRIBUTE_FOR_USERNAME,
  311. LDAP_SEARCH_FILTERS,
  312. LDAP_SEARCH_BASE,
  313. LDAP_APP_DN,
  314. LDAP_APP_PASSWORD,
  315. LDAP_USE_TLS,
  316. LDAP_CA_CERT_FILE,
  317. LDAP_VALIDATE_CERT,
  318. LDAP_CIPHERS,
  319. # Misc
  320. ENV,
  321. CACHE_DIR,
  322. STATIC_DIR,
  323. FRONTEND_BUILD_DIR,
  324. CORS_ALLOW_ORIGIN,
  325. DEFAULT_LOCALE,
  326. OAUTH_PROVIDERS,
  327. WEBUI_URL,
  328. RESPONSE_WATERMARK,
  329. # Admin
  330. ENABLE_ADMIN_CHAT_ACCESS,
  331. ENABLE_ADMIN_EXPORT,
  332. # Tasks
  333. TASK_MODEL,
  334. TASK_MODEL_EXTERNAL,
  335. ENABLE_TAGS_GENERATION,
  336. ENABLE_TITLE_GENERATION,
  337. ENABLE_SEARCH_QUERY_GENERATION,
  338. ENABLE_RETRIEVAL_QUERY_GENERATION,
  339. ENABLE_AUTOCOMPLETE_GENERATION,
  340. TITLE_GENERATION_PROMPT_TEMPLATE,
  341. TAGS_GENERATION_PROMPT_TEMPLATE,
  342. IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE,
  343. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
  344. QUERY_GENERATION_PROMPT_TEMPLATE,
  345. AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE,
  346. AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH,
  347. AppConfig,
  348. reset_config,
  349. )
  350. from open_webui.env import (
  351. AUDIT_EXCLUDED_PATHS,
  352. AUDIT_LOG_LEVEL,
  353. CHANGELOG,
  354. REDIS_URL,
  355. REDIS_SENTINEL_HOSTS,
  356. REDIS_SENTINEL_PORT,
  357. GLOBAL_LOG_LEVEL,
  358. MAX_BODY_LOG_SIZE,
  359. SAFE_MODE,
  360. SRC_LOG_LEVELS,
  361. VERSION,
  362. WEBUI_BUILD_HASH,
  363. WEBUI_SECRET_KEY,
  364. WEBUI_SESSION_COOKIE_SAME_SITE,
  365. WEBUI_SESSION_COOKIE_SECURE,
  366. WEBUI_AUTH_TRUSTED_EMAIL_HEADER,
  367. WEBUI_AUTH_TRUSTED_NAME_HEADER,
  368. WEBUI_AUTH_SIGNOUT_REDIRECT_URL,
  369. ENABLE_WEBSOCKET_SUPPORT,
  370. BYPASS_MODEL_ACCESS_CONTROL,
  371. RESET_CONFIG_ON_START,
  372. OFFLINE_MODE,
  373. ENABLE_OTEL,
  374. EXTERNAL_PWA_MANIFEST_URL,
  375. AIOHTTP_CLIENT_SESSION_SSL,
  376. )
  377. from open_webui.utils.models import (
  378. get_all_models,
  379. get_all_base_models,
  380. check_model_access,
  381. )
  382. from open_webui.utils.chat import (
  383. generate_chat_completion as chat_completion_handler,
  384. chat_completed as chat_completed_handler,
  385. chat_action as chat_action_handler,
  386. )
  387. from open_webui.utils.middleware import process_chat_payload, process_chat_response
  388. from open_webui.utils.access_control import has_access
  389. from open_webui.utils.auth import (
  390. get_license_data,
  391. get_http_authorization_cred,
  392. decode_token,
  393. get_admin_user,
  394. get_verified_user,
  395. )
  396. from open_webui.utils.plugin import install_tool_and_function_dependencies
  397. from open_webui.utils.oauth import OAuthManager
  398. from open_webui.utils.security_headers import SecurityHeadersMiddleware
  399. from open_webui.tasks import (
  400. list_task_ids_by_chat_id,
  401. stop_task,
  402. list_tasks,
  403. ) # Import from tasks.py
  404. from open_webui.utils.redis import get_sentinels_from_env
  405. if SAFE_MODE:
  406. print("SAFE MODE ENABLED")
  407. Functions.deactivate_all_functions()
  408. logging.basicConfig(stream=sys.stdout, level=GLOBAL_LOG_LEVEL)
  409. log = logging.getLogger(__name__)
  410. log.setLevel(SRC_LOG_LEVELS["MAIN"])
  411. class SPAStaticFiles(StaticFiles):
  412. async def get_response(self, path: str, scope):
  413. try:
  414. return await super().get_response(path, scope)
  415. except (HTTPException, StarletteHTTPException) as ex:
  416. if ex.status_code == 404:
  417. if path.endswith(".js"):
  418. # Return 404 for javascript files
  419. raise ex
  420. else:
  421. return await super().get_response("index.html", scope)
  422. else:
  423. raise ex
  424. print(
  425. rf"""
  426. ██████╗ ██████╗ ███████╗███╗ ██╗ ██╗ ██╗███████╗██████╗ ██╗ ██╗██╗
  427. ██╔═══██╗██╔══██╗██╔════╝████╗ ██║ ██║ ██║██╔════╝██╔══██╗██║ ██║██║
  428. ██║ ██║██████╔╝█████╗ ██╔██╗ ██║ ██║ █╗ ██║█████╗ ██████╔╝██║ ██║██║
  429. ██║ ██║██╔═══╝ ██╔══╝ ██║╚██╗██║ ██║███╗██║██╔══╝ ██╔══██╗██║ ██║██║
  430. ╚██████╔╝██║ ███████╗██║ ╚████║ ╚███╔███╔╝███████╗██████╔╝╚██████╔╝██║
  431. ╚═════╝ ╚═╝ ╚══════╝╚═╝ ╚═══╝ ╚══╝╚══╝ ╚══════╝╚═════╝ ╚═════╝ ╚═╝
  432. v{VERSION} - building the best AI user interface.
  433. {f"Commit: {WEBUI_BUILD_HASH}" if WEBUI_BUILD_HASH != "dev-build" else ""}
  434. https://github.com/open-webui/open-webui
  435. """
  436. )
  437. @asynccontextmanager
  438. async def lifespan(app: FastAPI):
  439. start_logger()
  440. if RESET_CONFIG_ON_START:
  441. reset_config()
  442. if LICENSE_KEY:
  443. get_license_data(app, LICENSE_KEY)
  444. # This should be blocking (sync) so functions are not deactivated on first /get_models calls
  445. # when the first user lands on the / route.
  446. log.info("Installing external dependencies of functions and tools...")
  447. install_tool_and_function_dependencies()
  448. if THREAD_POOL_SIZE and THREAD_POOL_SIZE > 0:
  449. limiter = anyio.to_thread.current_default_thread_limiter()
  450. limiter.total_tokens = THREAD_POOL_SIZE
  451. asyncio.create_task(periodic_usage_pool_cleanup())
  452. yield
  453. app = FastAPI(
  454. title="Open WebUI",
  455. docs_url="/docs" if ENV == "dev" else None,
  456. openapi_url="/openapi.json" if ENV == "dev" else None,
  457. redoc_url=None,
  458. lifespan=lifespan,
  459. )
  460. oauth_manager = OAuthManager(app)
  461. app.state.config = AppConfig(
  462. redis_url=REDIS_URL,
  463. redis_sentinels=get_sentinels_from_env(REDIS_SENTINEL_HOSTS, REDIS_SENTINEL_PORT),
  464. )
  465. app.state.WEBUI_NAME = WEBUI_NAME
  466. app.state.LICENSE_METADATA = None
  467. ########################################
  468. #
  469. # OPENTELEMETRY
  470. #
  471. ########################################
  472. if ENABLE_OTEL:
  473. from open_webui.utils.telemetry.setup import setup as setup_opentelemetry
  474. setup_opentelemetry(app=app, db_engine=engine)
  475. ########################################
  476. #
  477. # OLLAMA
  478. #
  479. ########################################
  480. app.state.config.ENABLE_OLLAMA_API = ENABLE_OLLAMA_API
  481. app.state.config.OLLAMA_BASE_URLS = OLLAMA_BASE_URLS
  482. app.state.config.OLLAMA_API_CONFIGS = OLLAMA_API_CONFIGS
  483. app.state.OLLAMA_MODELS = {}
  484. ########################################
  485. #
  486. # OPENAI
  487. #
  488. ########################################
  489. app.state.config.ENABLE_OPENAI_API = ENABLE_OPENAI_API
  490. app.state.config.OPENAI_API_BASE_URLS = OPENAI_API_BASE_URLS
  491. app.state.config.OPENAI_API_KEYS = OPENAI_API_KEYS
  492. app.state.config.OPENAI_API_CONFIGS = OPENAI_API_CONFIGS
  493. app.state.OPENAI_MODELS = {}
  494. ########################################
  495. #
  496. # TOOL SERVERS
  497. #
  498. ########################################
  499. app.state.config.TOOL_SERVER_CONNECTIONS = TOOL_SERVER_CONNECTIONS
  500. app.state.TOOL_SERVERS = []
  501. ########################################
  502. #
  503. # DIRECT CONNECTIONS
  504. #
  505. ########################################
  506. app.state.config.ENABLE_DIRECT_CONNECTIONS = ENABLE_DIRECT_CONNECTIONS
  507. ########################################
  508. #
  509. # WEBUI
  510. #
  511. ########################################
  512. app.state.config.WEBUI_URL = WEBUI_URL
  513. app.state.config.ENABLE_SIGNUP = ENABLE_SIGNUP
  514. app.state.config.ENABLE_LOGIN_FORM = ENABLE_LOGIN_FORM
  515. app.state.config.ENABLE_API_KEY = ENABLE_API_KEY
  516. app.state.config.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS = (
  517. ENABLE_API_KEY_ENDPOINT_RESTRICTIONS
  518. )
  519. app.state.config.API_KEY_ALLOWED_ENDPOINTS = API_KEY_ALLOWED_ENDPOINTS
  520. app.state.config.JWT_EXPIRES_IN = JWT_EXPIRES_IN
  521. app.state.config.SHOW_ADMIN_DETAILS = SHOW_ADMIN_DETAILS
  522. app.state.config.ADMIN_EMAIL = ADMIN_EMAIL
  523. app.state.config.DEFAULT_MODELS = DEFAULT_MODELS
  524. app.state.config.DEFAULT_PROMPT_SUGGESTIONS = DEFAULT_PROMPT_SUGGESTIONS
  525. app.state.config.DEFAULT_USER_ROLE = DEFAULT_USER_ROLE
  526. app.state.config.PENDING_USER_OVERLAY_CONTENT = PENDING_USER_OVERLAY_CONTENT
  527. app.state.config.PENDING_USER_OVERLAY_TITLE = PENDING_USER_OVERLAY_TITLE
  528. app.state.config.RESPONSE_WATERMARK = RESPONSE_WATERMARK
  529. app.state.config.USER_PERMISSIONS = USER_PERMISSIONS
  530. app.state.config.WEBHOOK_URL = WEBHOOK_URL
  531. app.state.config.BANNERS = WEBUI_BANNERS
  532. app.state.config.MODEL_ORDER_LIST = MODEL_ORDER_LIST
  533. app.state.config.ENABLE_CHANNELS = ENABLE_CHANNELS
  534. app.state.config.ENABLE_NOTES = ENABLE_NOTES
  535. app.state.config.ENABLE_COMMUNITY_SHARING = ENABLE_COMMUNITY_SHARING
  536. app.state.config.ENABLE_MESSAGE_RATING = ENABLE_MESSAGE_RATING
  537. app.state.config.ENABLE_USER_WEBHOOKS = ENABLE_USER_WEBHOOKS
  538. app.state.config.ENABLE_EVALUATION_ARENA_MODELS = ENABLE_EVALUATION_ARENA_MODELS
  539. app.state.config.EVALUATION_ARENA_MODELS = EVALUATION_ARENA_MODELS
  540. app.state.config.OAUTH_USERNAME_CLAIM = OAUTH_USERNAME_CLAIM
  541. app.state.config.OAUTH_PICTURE_CLAIM = OAUTH_PICTURE_CLAIM
  542. app.state.config.OAUTH_EMAIL_CLAIM = OAUTH_EMAIL_CLAIM
  543. app.state.config.ENABLE_OAUTH_ROLE_MANAGEMENT = ENABLE_OAUTH_ROLE_MANAGEMENT
  544. app.state.config.OAUTH_ROLES_CLAIM = OAUTH_ROLES_CLAIM
  545. app.state.config.OAUTH_ALLOWED_ROLES = OAUTH_ALLOWED_ROLES
  546. app.state.config.OAUTH_ADMIN_ROLES = OAUTH_ADMIN_ROLES
  547. app.state.config.ENABLE_LDAP = ENABLE_LDAP
  548. app.state.config.LDAP_SERVER_LABEL = LDAP_SERVER_LABEL
  549. app.state.config.LDAP_SERVER_HOST = LDAP_SERVER_HOST
  550. app.state.config.LDAP_SERVER_PORT = LDAP_SERVER_PORT
  551. app.state.config.LDAP_ATTRIBUTE_FOR_MAIL = LDAP_ATTRIBUTE_FOR_MAIL
  552. app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME = LDAP_ATTRIBUTE_FOR_USERNAME
  553. app.state.config.LDAP_APP_DN = LDAP_APP_DN
  554. app.state.config.LDAP_APP_PASSWORD = LDAP_APP_PASSWORD
  555. app.state.config.LDAP_SEARCH_BASE = LDAP_SEARCH_BASE
  556. app.state.config.LDAP_SEARCH_FILTERS = LDAP_SEARCH_FILTERS
  557. app.state.config.LDAP_USE_TLS = LDAP_USE_TLS
  558. app.state.config.LDAP_CA_CERT_FILE = LDAP_CA_CERT_FILE
  559. app.state.config.LDAP_VALIDATE_CERT = LDAP_VALIDATE_CERT
  560. app.state.config.LDAP_CIPHERS = LDAP_CIPHERS
  561. app.state.AUTH_TRUSTED_EMAIL_HEADER = WEBUI_AUTH_TRUSTED_EMAIL_HEADER
  562. app.state.AUTH_TRUSTED_NAME_HEADER = WEBUI_AUTH_TRUSTED_NAME_HEADER
  563. app.state.WEBUI_AUTH_SIGNOUT_REDIRECT_URL = WEBUI_AUTH_SIGNOUT_REDIRECT_URL
  564. app.state.EXTERNAL_PWA_MANIFEST_URL = EXTERNAL_PWA_MANIFEST_URL
  565. app.state.USER_COUNT = None
  566. app.state.TOOLS = {}
  567. app.state.FUNCTIONS = {}
  568. ########################################
  569. #
  570. # RETRIEVAL
  571. #
  572. ########################################
  573. app.state.config.TOP_K = RAG_TOP_K
  574. app.state.config.TOP_K_RERANKER = RAG_TOP_K_RERANKER
  575. app.state.config.RELEVANCE_THRESHOLD = RAG_RELEVANCE_THRESHOLD
  576. app.state.config.ALLOWED_FILE_EXTENSIONS = RAG_ALLOWED_FILE_EXTENSIONS
  577. app.state.config.FILE_MAX_SIZE = RAG_FILE_MAX_SIZE
  578. app.state.config.FILE_MAX_COUNT = RAG_FILE_MAX_COUNT
  579. app.state.config.RAG_FULL_CONTEXT = RAG_FULL_CONTEXT
  580. app.state.config.BYPASS_EMBEDDING_AND_RETRIEVAL = BYPASS_EMBEDDING_AND_RETRIEVAL
  581. app.state.config.ENABLE_RAG_HYBRID_SEARCH = ENABLE_RAG_HYBRID_SEARCH
  582. app.state.config.ENABLE_WEB_LOADER_SSL_VERIFICATION = ENABLE_WEB_LOADER_SSL_VERIFICATION
  583. app.state.config.CONTENT_EXTRACTION_ENGINE = CONTENT_EXTRACTION_ENGINE
  584. app.state.config.EXTERNAL_DOCUMENT_LOADER_URL = EXTERNAL_DOCUMENT_LOADER_URL
  585. app.state.config.EXTERNAL_DOCUMENT_LOADER_API_KEY = EXTERNAL_DOCUMENT_LOADER_API_KEY
  586. app.state.config.TIKA_SERVER_URL = TIKA_SERVER_URL
  587. app.state.config.DOCLING_SERVER_URL = DOCLING_SERVER_URL
  588. app.state.config.DOCLING_OCR_ENGINE = DOCLING_OCR_ENGINE
  589. app.state.config.DOCLING_OCR_LANG = DOCLING_OCR_LANG
  590. app.state.config.DOCLING_DO_PICTURE_DESCRIPTION = DOCLING_DO_PICTURE_DESCRIPTION
  591. app.state.config.DOCUMENT_INTELLIGENCE_ENDPOINT = DOCUMENT_INTELLIGENCE_ENDPOINT
  592. app.state.config.DOCUMENT_INTELLIGENCE_KEY = DOCUMENT_INTELLIGENCE_KEY
  593. app.state.config.MISTRAL_OCR_API_KEY = MISTRAL_OCR_API_KEY
  594. app.state.config.TEXT_SPLITTER = RAG_TEXT_SPLITTER
  595. app.state.config.TIKTOKEN_ENCODING_NAME = TIKTOKEN_ENCODING_NAME
  596. app.state.config.CHUNK_SIZE = CHUNK_SIZE
  597. app.state.config.CHUNK_OVERLAP = CHUNK_OVERLAP
  598. app.state.config.RAG_EMBEDDING_ENGINE = RAG_EMBEDDING_ENGINE
  599. app.state.config.RAG_EMBEDDING_MODEL = RAG_EMBEDDING_MODEL
  600. app.state.config.RAG_EMBEDDING_BATCH_SIZE = RAG_EMBEDDING_BATCH_SIZE
  601. app.state.config.RAG_RERANKING_ENGINE = RAG_RERANKING_ENGINE
  602. app.state.config.RAG_RERANKING_MODEL = RAG_RERANKING_MODEL
  603. app.state.config.RAG_EXTERNAL_RERANKER_URL = RAG_EXTERNAL_RERANKER_URL
  604. app.state.config.RAG_EXTERNAL_RERANKER_API_KEY = RAG_EXTERNAL_RERANKER_API_KEY
  605. app.state.config.RAG_TEMPLATE = RAG_TEMPLATE
  606. app.state.config.RAG_OPENAI_API_BASE_URL = RAG_OPENAI_API_BASE_URL
  607. app.state.config.RAG_OPENAI_API_KEY = RAG_OPENAI_API_KEY
  608. app.state.config.RAG_AZURE_OPENAI_BASE_URL = RAG_AZURE_OPENAI_BASE_URL
  609. app.state.config.RAG_AZURE_OPENAI_API_KEY = RAG_AZURE_OPENAI_API_KEY
  610. app.state.config.RAG_AZURE_OPENAI_DEPLOYMENT = RAG_AZURE_OPENAI_DEPLOYMENT
  611. app.state.config.RAG_AZURE_OPENAI_VERSION = RAG_AZURE_OPENAI_VERSION
  612. app.state.config.RAG_OLLAMA_BASE_URL = RAG_OLLAMA_BASE_URL
  613. app.state.config.RAG_OLLAMA_API_KEY = RAG_OLLAMA_API_KEY
  614. app.state.config.PDF_EXTRACT_IMAGES = PDF_EXTRACT_IMAGES
  615. app.state.config.YOUTUBE_LOADER_LANGUAGE = YOUTUBE_LOADER_LANGUAGE
  616. app.state.config.YOUTUBE_LOADER_PROXY_URL = YOUTUBE_LOADER_PROXY_URL
  617. app.state.config.ENABLE_WEB_SEARCH = ENABLE_WEB_SEARCH
  618. app.state.config.WEB_SEARCH_ENGINE = WEB_SEARCH_ENGINE
  619. app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST = WEB_SEARCH_DOMAIN_FILTER_LIST
  620. app.state.config.WEB_SEARCH_RESULT_COUNT = WEB_SEARCH_RESULT_COUNT
  621. app.state.config.WEB_SEARCH_CONCURRENT_REQUESTS = WEB_SEARCH_CONCURRENT_REQUESTS
  622. app.state.config.WEB_LOADER_ENGINE = WEB_LOADER_ENGINE
  623. app.state.config.WEB_SEARCH_TRUST_ENV = WEB_SEARCH_TRUST_ENV
  624. app.state.config.BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL = (
  625. BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL
  626. )
  627. app.state.config.ENABLE_GOOGLE_DRIVE_INTEGRATION = ENABLE_GOOGLE_DRIVE_INTEGRATION
  628. app.state.config.ENABLE_ONEDRIVE_INTEGRATION = ENABLE_ONEDRIVE_INTEGRATION
  629. app.state.config.SEARXNG_QUERY_URL = SEARXNG_QUERY_URL
  630. app.state.config.YACY_QUERY_URL = YACY_QUERY_URL
  631. app.state.config.YACY_USERNAME = YACY_USERNAME
  632. app.state.config.YACY_PASSWORD = YACY_PASSWORD
  633. app.state.config.GOOGLE_PSE_API_KEY = GOOGLE_PSE_API_KEY
  634. app.state.config.GOOGLE_PSE_ENGINE_ID = GOOGLE_PSE_ENGINE_ID
  635. app.state.config.BRAVE_SEARCH_API_KEY = BRAVE_SEARCH_API_KEY
  636. app.state.config.KAGI_SEARCH_API_KEY = KAGI_SEARCH_API_KEY
  637. app.state.config.MOJEEK_SEARCH_API_KEY = MOJEEK_SEARCH_API_KEY
  638. app.state.config.BOCHA_SEARCH_API_KEY = BOCHA_SEARCH_API_KEY
  639. app.state.config.SERPSTACK_API_KEY = SERPSTACK_API_KEY
  640. app.state.config.SERPSTACK_HTTPS = SERPSTACK_HTTPS
  641. app.state.config.SERPER_API_KEY = SERPER_API_KEY
  642. app.state.config.SERPLY_API_KEY = SERPLY_API_KEY
  643. app.state.config.TAVILY_API_KEY = TAVILY_API_KEY
  644. app.state.config.SEARCHAPI_API_KEY = SEARCHAPI_API_KEY
  645. app.state.config.SEARCHAPI_ENGINE = SEARCHAPI_ENGINE
  646. app.state.config.SERPAPI_API_KEY = SERPAPI_API_KEY
  647. app.state.config.SERPAPI_ENGINE = SERPAPI_ENGINE
  648. app.state.config.JINA_API_KEY = JINA_API_KEY
  649. app.state.config.BING_SEARCH_V7_ENDPOINT = BING_SEARCH_V7_ENDPOINT
  650. app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY = BING_SEARCH_V7_SUBSCRIPTION_KEY
  651. app.state.config.EXA_API_KEY = EXA_API_KEY
  652. app.state.config.PERPLEXITY_API_KEY = PERPLEXITY_API_KEY
  653. app.state.config.SOUGOU_API_SID = SOUGOU_API_SID
  654. app.state.config.SOUGOU_API_SK = SOUGOU_API_SK
  655. app.state.config.EXTERNAL_WEB_SEARCH_URL = EXTERNAL_WEB_SEARCH_URL
  656. app.state.config.EXTERNAL_WEB_SEARCH_API_KEY = EXTERNAL_WEB_SEARCH_API_KEY
  657. app.state.config.EXTERNAL_WEB_LOADER_URL = EXTERNAL_WEB_LOADER_URL
  658. app.state.config.EXTERNAL_WEB_LOADER_API_KEY = EXTERNAL_WEB_LOADER_API_KEY
  659. app.state.config.PLAYWRIGHT_WS_URL = PLAYWRIGHT_WS_URL
  660. app.state.config.PLAYWRIGHT_TIMEOUT = PLAYWRIGHT_TIMEOUT
  661. app.state.config.FIRECRAWL_API_BASE_URL = FIRECRAWL_API_BASE_URL
  662. app.state.config.FIRECRAWL_API_KEY = FIRECRAWL_API_KEY
  663. app.state.config.TAVILY_EXTRACT_DEPTH = TAVILY_EXTRACT_DEPTH
  664. app.state.EMBEDDING_FUNCTION = None
  665. app.state.ef = None
  666. app.state.rf = None
  667. app.state.YOUTUBE_LOADER_TRANSLATION = None
  668. try:
  669. app.state.ef = get_ef(
  670. app.state.config.RAG_EMBEDDING_ENGINE,
  671. app.state.config.RAG_EMBEDDING_MODEL,
  672. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  673. )
  674. app.state.rf = get_rf(
  675. app.state.config.RAG_RERANKING_ENGINE,
  676. app.state.config.RAG_RERANKING_MODEL,
  677. app.state.config.RAG_EXTERNAL_RERANKER_URL,
  678. app.state.config.RAG_EXTERNAL_RERANKER_API_KEY,
  679. RAG_RERANKING_MODEL_AUTO_UPDATE,
  680. )
  681. except Exception as e:
  682. log.error(f"Error updating models: {e}")
  683. pass
  684. app.state.EMBEDDING_FUNCTION = get_embedding_function(
  685. app.state.config.RAG_EMBEDDING_ENGINE,
  686. app.state.config.RAG_EMBEDDING_MODEL,
  687. app.state.ef,
  688. (
  689. app.state.config.RAG_OPENAI_API_BASE_URL
  690. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  691. else (
  692. app.state.config.RAG_OLLAMA_BASE_URL
  693. if app.state.config.RAG_EMBEDDING_ENGINE == "ollama"
  694. else app.state.config.RAG_AZURE_OPENAI_BASE_URL
  695. )
  696. ),
  697. (
  698. app.state.config.RAG_OPENAI_API_KEY
  699. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  700. else (
  701. app.state.config.RAG_OLLAMA_API_KEY
  702. if app.state.config.RAG_EMBEDDING_ENGINE == "ollama"
  703. else app.state.config.RAG_AZURE_OPENAI_API_KEY
  704. )
  705. ),
  706. app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  707. (
  708. app.state.config.RAG_AZURE_OPENAI_DEPLOYMENT
  709. if app.state.config.RAG_EMBEDDING_ENGINE == "azure_openai"
  710. else None
  711. ),
  712. (
  713. app.state.config.RAG_AZURE_OPENAI_VERSION
  714. if app.state.config.RAG_EMBEDDING_ENGINE == "azure_openai"
  715. else None
  716. ),
  717. )
  718. ########################################
  719. #
  720. # CODE EXECUTION
  721. #
  722. ########################################
  723. app.state.config.ENABLE_CODE_EXECUTION = ENABLE_CODE_EXECUTION
  724. app.state.config.CODE_EXECUTION_ENGINE = CODE_EXECUTION_ENGINE
  725. app.state.config.CODE_EXECUTION_JUPYTER_URL = CODE_EXECUTION_JUPYTER_URL
  726. app.state.config.CODE_EXECUTION_JUPYTER_AUTH = CODE_EXECUTION_JUPYTER_AUTH
  727. app.state.config.CODE_EXECUTION_JUPYTER_AUTH_TOKEN = CODE_EXECUTION_JUPYTER_AUTH_TOKEN
  728. app.state.config.CODE_EXECUTION_JUPYTER_AUTH_PASSWORD = (
  729. CODE_EXECUTION_JUPYTER_AUTH_PASSWORD
  730. )
  731. app.state.config.CODE_EXECUTION_JUPYTER_TIMEOUT = CODE_EXECUTION_JUPYTER_TIMEOUT
  732. app.state.config.ENABLE_CODE_INTERPRETER = ENABLE_CODE_INTERPRETER
  733. app.state.config.CODE_INTERPRETER_ENGINE = CODE_INTERPRETER_ENGINE
  734. app.state.config.CODE_INTERPRETER_PROMPT_TEMPLATE = CODE_INTERPRETER_PROMPT_TEMPLATE
  735. app.state.config.CODE_INTERPRETER_JUPYTER_URL = CODE_INTERPRETER_JUPYTER_URL
  736. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH = CODE_INTERPRETER_JUPYTER_AUTH
  737. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH_TOKEN = (
  738. CODE_INTERPRETER_JUPYTER_AUTH_TOKEN
  739. )
  740. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD = (
  741. CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD
  742. )
  743. app.state.config.CODE_INTERPRETER_JUPYTER_TIMEOUT = CODE_INTERPRETER_JUPYTER_TIMEOUT
  744. ########################################
  745. #
  746. # IMAGES
  747. #
  748. ########################################
  749. app.state.config.IMAGE_GENERATION_ENGINE = IMAGE_GENERATION_ENGINE
  750. app.state.config.ENABLE_IMAGE_GENERATION = ENABLE_IMAGE_GENERATION
  751. app.state.config.ENABLE_IMAGE_PROMPT_GENERATION = ENABLE_IMAGE_PROMPT_GENERATION
  752. app.state.config.IMAGES_OPENAI_API_BASE_URL = IMAGES_OPENAI_API_BASE_URL
  753. app.state.config.IMAGES_OPENAI_API_KEY = IMAGES_OPENAI_API_KEY
  754. app.state.config.IMAGES_GEMINI_API_BASE_URL = IMAGES_GEMINI_API_BASE_URL
  755. app.state.config.IMAGES_GEMINI_API_KEY = IMAGES_GEMINI_API_KEY
  756. app.state.config.IMAGE_GENERATION_MODEL = IMAGE_GENERATION_MODEL
  757. app.state.config.AUTOMATIC1111_BASE_URL = AUTOMATIC1111_BASE_URL
  758. app.state.config.AUTOMATIC1111_API_AUTH = AUTOMATIC1111_API_AUTH
  759. app.state.config.AUTOMATIC1111_CFG_SCALE = AUTOMATIC1111_CFG_SCALE
  760. app.state.config.AUTOMATIC1111_SAMPLER = AUTOMATIC1111_SAMPLER
  761. app.state.config.AUTOMATIC1111_SCHEDULER = AUTOMATIC1111_SCHEDULER
  762. app.state.config.COMFYUI_BASE_URL = COMFYUI_BASE_URL
  763. app.state.config.COMFYUI_API_KEY = COMFYUI_API_KEY
  764. app.state.config.COMFYUI_WORKFLOW = COMFYUI_WORKFLOW
  765. app.state.config.COMFYUI_WORKFLOW_NODES = COMFYUI_WORKFLOW_NODES
  766. app.state.config.IMAGE_SIZE = IMAGE_SIZE
  767. app.state.config.IMAGE_STEPS = IMAGE_STEPS
  768. ########################################
  769. #
  770. # AUDIO
  771. #
  772. ########################################
  773. app.state.config.STT_OPENAI_API_BASE_URL = AUDIO_STT_OPENAI_API_BASE_URL
  774. app.state.config.STT_OPENAI_API_KEY = AUDIO_STT_OPENAI_API_KEY
  775. app.state.config.STT_ENGINE = AUDIO_STT_ENGINE
  776. app.state.config.STT_MODEL = AUDIO_STT_MODEL
  777. app.state.config.WHISPER_MODEL = WHISPER_MODEL
  778. app.state.config.WHISPER_VAD_FILTER = WHISPER_VAD_FILTER
  779. app.state.config.DEEPGRAM_API_KEY = DEEPGRAM_API_KEY
  780. app.state.config.AUDIO_STT_AZURE_API_KEY = AUDIO_STT_AZURE_API_KEY
  781. app.state.config.AUDIO_STT_AZURE_REGION = AUDIO_STT_AZURE_REGION
  782. app.state.config.AUDIO_STT_AZURE_LOCALES = AUDIO_STT_AZURE_LOCALES
  783. app.state.config.AUDIO_STT_AZURE_BASE_URL = AUDIO_STT_AZURE_BASE_URL
  784. app.state.config.AUDIO_STT_AZURE_MAX_SPEAKERS = AUDIO_STT_AZURE_MAX_SPEAKERS
  785. app.state.config.TTS_OPENAI_API_BASE_URL = AUDIO_TTS_OPENAI_API_BASE_URL
  786. app.state.config.TTS_OPENAI_API_KEY = AUDIO_TTS_OPENAI_API_KEY
  787. app.state.config.TTS_ENGINE = AUDIO_TTS_ENGINE
  788. app.state.config.TTS_MODEL = AUDIO_TTS_MODEL
  789. app.state.config.TTS_VOICE = AUDIO_TTS_VOICE
  790. app.state.config.TTS_API_KEY = AUDIO_TTS_API_KEY
  791. app.state.config.TTS_SPLIT_ON = AUDIO_TTS_SPLIT_ON
  792. app.state.config.TTS_AZURE_SPEECH_REGION = AUDIO_TTS_AZURE_SPEECH_REGION
  793. app.state.config.TTS_AZURE_SPEECH_BASE_URL = AUDIO_TTS_AZURE_SPEECH_BASE_URL
  794. app.state.config.TTS_AZURE_SPEECH_OUTPUT_FORMAT = AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT
  795. app.state.faster_whisper_model = None
  796. app.state.speech_synthesiser = None
  797. app.state.speech_speaker_embeddings_dataset = None
  798. ########################################
  799. #
  800. # TASKS
  801. #
  802. ########################################
  803. app.state.config.TASK_MODEL = TASK_MODEL
  804. app.state.config.TASK_MODEL_EXTERNAL = TASK_MODEL_EXTERNAL
  805. app.state.config.ENABLE_SEARCH_QUERY_GENERATION = ENABLE_SEARCH_QUERY_GENERATION
  806. app.state.config.ENABLE_RETRIEVAL_QUERY_GENERATION = ENABLE_RETRIEVAL_QUERY_GENERATION
  807. app.state.config.ENABLE_AUTOCOMPLETE_GENERATION = ENABLE_AUTOCOMPLETE_GENERATION
  808. app.state.config.ENABLE_TAGS_GENERATION = ENABLE_TAGS_GENERATION
  809. app.state.config.ENABLE_TITLE_GENERATION = ENABLE_TITLE_GENERATION
  810. app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE = TITLE_GENERATION_PROMPT_TEMPLATE
  811. app.state.config.TAGS_GENERATION_PROMPT_TEMPLATE = TAGS_GENERATION_PROMPT_TEMPLATE
  812. app.state.config.IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE = (
  813. IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE
  814. )
  815. app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
  816. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
  817. )
  818. app.state.config.QUERY_GENERATION_PROMPT_TEMPLATE = QUERY_GENERATION_PROMPT_TEMPLATE
  819. app.state.config.AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE = (
  820. AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE
  821. )
  822. app.state.config.AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH = (
  823. AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH
  824. )
  825. ########################################
  826. #
  827. # WEBUI
  828. #
  829. ########################################
  830. app.state.MODELS = {}
  831. class RedirectMiddleware(BaseHTTPMiddleware):
  832. async def dispatch(self, request: Request, call_next):
  833. # Check if the request is a GET request
  834. if request.method == "GET":
  835. path = request.url.path
  836. query_params = dict(parse_qs(urlparse(str(request.url)).query))
  837. # Check for the specific watch path and the presence of 'v' parameter
  838. if path.endswith("/watch") and "v" in query_params:
  839. # Extract the first 'v' parameter
  840. video_id = query_params["v"][0]
  841. encoded_video_id = urlencode({"youtube": video_id})
  842. redirect_url = f"/?{encoded_video_id}"
  843. return RedirectResponse(url=redirect_url)
  844. # Proceed with the normal flow of other requests
  845. response = await call_next(request)
  846. return response
  847. # Add the middleware to the app
  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. )