config.py 42 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520
  1. import json
  2. import logging
  3. import os
  4. import shutil
  5. from datetime import datetime
  6. from pathlib import Path
  7. from typing import Generic, Optional, TypeVar
  8. from urllib.parse import urlparse
  9. import chromadb
  10. import requests
  11. import yaml
  12. from open_webui.apps.webui.internal.db import Base, get_db
  13. from open_webui.env import (
  14. OPEN_WEBUI_DIR,
  15. DATA_DIR,
  16. ENV,
  17. FRONTEND_BUILD_DIR,
  18. WEBUI_AUTH,
  19. WEBUI_FAVICON_URL,
  20. WEBUI_NAME,
  21. log,
  22. )
  23. from pydantic import BaseModel
  24. from sqlalchemy import JSON, Column, DateTime, Integer, func
  25. class EndpointFilter(logging.Filter):
  26. def filter(self, record: logging.LogRecord) -> bool:
  27. return record.getMessage().find("/health") == -1
  28. # Filter out /endpoint
  29. logging.getLogger("uvicorn.access").addFilter(EndpointFilter())
  30. ####################################
  31. # Config helpers
  32. ####################################
  33. # Function to run the alembic migrations
  34. def run_migrations():
  35. print("Running migrations")
  36. try:
  37. from alembic import command
  38. from alembic.config import Config
  39. alembic_cfg = Config(OPEN_WEBUI_DIR / "alembic.ini")
  40. # Set the script location dynamically
  41. migrations_path = OPEN_WEBUI_DIR / "migrations"
  42. alembic_cfg.set_main_option("script_location", str(migrations_path))
  43. command.upgrade(alembic_cfg, "head")
  44. except Exception as e:
  45. print(f"Error: {e}")
  46. run_migrations()
  47. class Config(Base):
  48. __tablename__ = "config"
  49. id = Column(Integer, primary_key=True)
  50. data = Column(JSON, nullable=False)
  51. version = Column(Integer, nullable=False, default=0)
  52. created_at = Column(DateTime, nullable=False, server_default=func.now())
  53. updated_at = Column(DateTime, nullable=True, onupdate=func.now())
  54. def load_json_config():
  55. with open(f"{DATA_DIR}/config.json", "r") as file:
  56. return json.load(file)
  57. def save_to_db(data):
  58. with get_db() as db:
  59. existing_config = db.query(Config).first()
  60. if not existing_config:
  61. new_config = Config(data=data, version=0)
  62. db.add(new_config)
  63. else:
  64. existing_config.data = data
  65. existing_config.updated_at = datetime.now()
  66. db.add(existing_config)
  67. db.commit()
  68. def reset_config():
  69. with get_db() as db:
  70. db.query(Config).delete()
  71. db.commit()
  72. # When initializing, check if config.json exists and migrate it to the database
  73. if os.path.exists(f"{DATA_DIR}/config.json"):
  74. data = load_json_config()
  75. save_to_db(data)
  76. os.rename(f"{DATA_DIR}/config.json", f"{DATA_DIR}/old_config.json")
  77. DEFAULT_CONFIG = {
  78. "version": 0,
  79. "ui": {
  80. "default_locale": "",
  81. "prompt_suggestions": [
  82. {
  83. "title": [
  84. "Help me study",
  85. "vocabulary for a college entrance exam",
  86. ],
  87. "content": "Help me study vocabulary: write a sentence for me to fill in the blank, and I'll try to pick the correct option.",
  88. },
  89. {
  90. "title": [
  91. "Give me ideas",
  92. "for what to do with my kids' art",
  93. ],
  94. "content": "What are 5 creative things I could do with my kids' art? I don't want to throw them away, but it's also so much clutter.",
  95. },
  96. {
  97. "title": ["Tell me a fun fact", "about the Roman Empire"],
  98. "content": "Tell me a random fun fact about the Roman Empire",
  99. },
  100. {
  101. "title": [
  102. "Show me a code snippet",
  103. "of a website's sticky header",
  104. ],
  105. "content": "Show me a code snippet of a website's sticky header in CSS and JavaScript.",
  106. },
  107. {
  108. "title": [
  109. "Explain options trading",
  110. "if I'm familiar with buying and selling stocks",
  111. ],
  112. "content": "Explain options trading in simple terms if I'm familiar with buying and selling stocks.",
  113. },
  114. {
  115. "title": ["Overcome procrastination", "give me tips"],
  116. "content": "Could you start by asking me about instances when I procrastinate the most and then give me some suggestions to overcome it?",
  117. },
  118. {
  119. "title": [
  120. "Grammar check",
  121. "rewrite it for better readability ",
  122. ],
  123. "content": 'Check the following sentence for grammar and clarity: "[sentence]". Rewrite it for better readability while maintaining its original meaning.',
  124. },
  125. ],
  126. },
  127. }
  128. def get_config():
  129. with get_db() as db:
  130. config_entry = db.query(Config).order_by(Config.id.desc()).first()
  131. return config_entry.data if config_entry else DEFAULT_CONFIG
  132. CONFIG_DATA = get_config()
  133. def get_config_value(config_path: str):
  134. path_parts = config_path.split(".")
  135. cur_config = CONFIG_DATA
  136. for key in path_parts:
  137. if key in cur_config:
  138. cur_config = cur_config[key]
  139. else:
  140. return None
  141. return cur_config
  142. PERSISTENT_CONFIG_REGISTRY = []
  143. def save_config(config):
  144. global CONFIG_DATA
  145. global PERSISTENT_CONFIG_REGISTRY
  146. try:
  147. save_to_db(config)
  148. CONFIG_DATA = config
  149. # Trigger updates on all registered PersistentConfig entries
  150. for config_item in PERSISTENT_CONFIG_REGISTRY:
  151. config_item.update()
  152. except Exception as e:
  153. log.exception(e)
  154. return False
  155. return True
  156. T = TypeVar("T")
  157. class PersistentConfig(Generic[T]):
  158. def __init__(self, env_name: str, config_path: str, env_value: T):
  159. self.env_name = env_name
  160. self.config_path = config_path
  161. self.env_value = env_value
  162. self.config_value = get_config_value(config_path)
  163. if self.config_value is not None:
  164. log.info(f"'{env_name}' loaded from the latest database entry")
  165. self.value = self.config_value
  166. else:
  167. self.value = env_value
  168. PERSISTENT_CONFIG_REGISTRY.append(self)
  169. def __str__(self):
  170. return str(self.value)
  171. @property
  172. def __dict__(self):
  173. raise TypeError(
  174. "PersistentConfig object cannot be converted to dict, use config_get or .value instead."
  175. )
  176. def __getattribute__(self, item):
  177. if item == "__dict__":
  178. raise TypeError(
  179. "PersistentConfig object cannot be converted to dict, use config_get or .value instead."
  180. )
  181. return super().__getattribute__(item)
  182. def update(self):
  183. new_value = get_config_value(self.config_path)
  184. if new_value is not None:
  185. self.value = new_value
  186. log.info(f"Updated {self.env_name} to new value {self.value}")
  187. def save(self):
  188. log.info(f"Saving '{self.env_name}' to the database")
  189. path_parts = self.config_path.split(".")
  190. sub_config = CONFIG_DATA
  191. for key in path_parts[:-1]:
  192. if key not in sub_config:
  193. sub_config[key] = {}
  194. sub_config = sub_config[key]
  195. sub_config[path_parts[-1]] = self.value
  196. save_to_db(CONFIG_DATA)
  197. self.config_value = self.value
  198. class AppConfig:
  199. _state: dict[str, PersistentConfig]
  200. def __init__(self):
  201. super().__setattr__("_state", {})
  202. def __setattr__(self, key, value):
  203. if isinstance(value, PersistentConfig):
  204. self._state[key] = value
  205. else:
  206. self._state[key].value = value
  207. self._state[key].save()
  208. def __getattr__(self, key):
  209. return self._state[key].value
  210. ####################################
  211. # WEBUI_AUTH (Required for security)
  212. ####################################
  213. JWT_EXPIRES_IN = PersistentConfig(
  214. "JWT_EXPIRES_IN", "auth.jwt_expiry", os.environ.get("JWT_EXPIRES_IN", "-1")
  215. )
  216. ####################################
  217. # OAuth config
  218. ####################################
  219. ENABLE_OAUTH_SIGNUP = PersistentConfig(
  220. "ENABLE_OAUTH_SIGNUP",
  221. "oauth.enable_signup",
  222. os.environ.get("ENABLE_OAUTH_SIGNUP", "False").lower() == "true",
  223. )
  224. OAUTH_MERGE_ACCOUNTS_BY_EMAIL = PersistentConfig(
  225. "OAUTH_MERGE_ACCOUNTS_BY_EMAIL",
  226. "oauth.merge_accounts_by_email",
  227. os.environ.get("OAUTH_MERGE_ACCOUNTS_BY_EMAIL", "False").lower() == "true",
  228. )
  229. OAUTH_PROVIDERS = {}
  230. GOOGLE_CLIENT_ID = PersistentConfig(
  231. "GOOGLE_CLIENT_ID",
  232. "oauth.google.client_id",
  233. os.environ.get("GOOGLE_CLIENT_ID", ""),
  234. )
  235. GOOGLE_CLIENT_SECRET = PersistentConfig(
  236. "GOOGLE_CLIENT_SECRET",
  237. "oauth.google.client_secret",
  238. os.environ.get("GOOGLE_CLIENT_SECRET", ""),
  239. )
  240. GOOGLE_OAUTH_SCOPE = PersistentConfig(
  241. "GOOGLE_OAUTH_SCOPE",
  242. "oauth.google.scope",
  243. os.environ.get("GOOGLE_OAUTH_SCOPE", "openid email profile"),
  244. )
  245. GOOGLE_REDIRECT_URI = PersistentConfig(
  246. "GOOGLE_REDIRECT_URI",
  247. "oauth.google.redirect_uri",
  248. os.environ.get("GOOGLE_REDIRECT_URI", ""),
  249. )
  250. MICROSOFT_CLIENT_ID = PersistentConfig(
  251. "MICROSOFT_CLIENT_ID",
  252. "oauth.microsoft.client_id",
  253. os.environ.get("MICROSOFT_CLIENT_ID", ""),
  254. )
  255. MICROSOFT_CLIENT_SECRET = PersistentConfig(
  256. "MICROSOFT_CLIENT_SECRET",
  257. "oauth.microsoft.client_secret",
  258. os.environ.get("MICROSOFT_CLIENT_SECRET", ""),
  259. )
  260. MICROSOFT_CLIENT_TENANT_ID = PersistentConfig(
  261. "MICROSOFT_CLIENT_TENANT_ID",
  262. "oauth.microsoft.tenant_id",
  263. os.environ.get("MICROSOFT_CLIENT_TENANT_ID", ""),
  264. )
  265. MICROSOFT_OAUTH_SCOPE = PersistentConfig(
  266. "MICROSOFT_OAUTH_SCOPE",
  267. "oauth.microsoft.scope",
  268. os.environ.get("MICROSOFT_OAUTH_SCOPE", "openid email profile"),
  269. )
  270. MICROSOFT_REDIRECT_URI = PersistentConfig(
  271. "MICROSOFT_REDIRECT_URI",
  272. "oauth.microsoft.redirect_uri",
  273. os.environ.get("MICROSOFT_REDIRECT_URI", ""),
  274. )
  275. OAUTH_CLIENT_ID = PersistentConfig(
  276. "OAUTH_CLIENT_ID",
  277. "oauth.oidc.client_id",
  278. os.environ.get("OAUTH_CLIENT_ID", ""),
  279. )
  280. OAUTH_CLIENT_SECRET = PersistentConfig(
  281. "OAUTH_CLIENT_SECRET",
  282. "oauth.oidc.client_secret",
  283. os.environ.get("OAUTH_CLIENT_SECRET", ""),
  284. )
  285. OPENID_PROVIDER_URL = PersistentConfig(
  286. "OPENID_PROVIDER_URL",
  287. "oauth.oidc.provider_url",
  288. os.environ.get("OPENID_PROVIDER_URL", ""),
  289. )
  290. OPENID_REDIRECT_URI = PersistentConfig(
  291. "OPENID_REDIRECT_URI",
  292. "oauth.oidc.redirect_uri",
  293. os.environ.get("OPENID_REDIRECT_URI", ""),
  294. )
  295. OAUTH_SCOPES = PersistentConfig(
  296. "OAUTH_SCOPES",
  297. "oauth.oidc.scopes",
  298. os.environ.get("OAUTH_SCOPES", "openid email profile"),
  299. )
  300. OAUTH_PROVIDER_NAME = PersistentConfig(
  301. "OAUTH_PROVIDER_NAME",
  302. "oauth.oidc.provider_name",
  303. os.environ.get("OAUTH_PROVIDER_NAME", "SSO"),
  304. )
  305. OAUTH_USERNAME_CLAIM = PersistentConfig(
  306. "OAUTH_USERNAME_CLAIM",
  307. "oauth.oidc.username_claim",
  308. os.environ.get("OAUTH_USERNAME_CLAIM", "name"),
  309. )
  310. OAUTH_PICTURE_CLAIM = PersistentConfig(
  311. "OAUTH_PICTURE_CLAIM",
  312. "oauth.oidc.avatar_claim",
  313. os.environ.get("OAUTH_PICTURE_CLAIM", "picture"),
  314. )
  315. OAUTH_EMAIL_CLAIM = PersistentConfig(
  316. "OAUTH_EMAIL_CLAIM",
  317. "oauth.oidc.email_claim",
  318. os.environ.get("OAUTH_EMAIL_CLAIM", "email"),
  319. )
  320. ENABLE_OAUTH_ROLE_MANAGEMENT = PersistentConfig(
  321. "ENABLE_OAUTH_ROLE_MANAGEMENT",
  322. "oauth.enable_role_mapping",
  323. os.environ.get("ENABLE_OAUTH_ROLE_MANAGEMENT", "False").lower() == "true",
  324. )
  325. OAUTH_ROLES_CLAIM = PersistentConfig(
  326. "OAUTH_ROLES_CLAIM",
  327. "oauth.roles_claim",
  328. os.environ.get("OAUTH_ROLES_CLAIM", "roles"),
  329. )
  330. OAUTH_ALLOWED_ROLES = PersistentConfig(
  331. "OAUTH_ALLOWED_ROLES",
  332. "oauth.allowed_roles",
  333. [role.strip() for role in os.environ.get("OAUTH_ALLOWED_ROLES", "pending,user,admin").split(",")],
  334. )
  335. OAUTH_ADMIN_ROLES = PersistentConfig(
  336. "OAUTH_ADMIN_ROLES",
  337. "oauth.admin_roles",
  338. [role.strip() for role in os.environ.get("OAUTH_ADMIN_ROLES", "admin").split(",")],
  339. )
  340. def load_oauth_providers():
  341. OAUTH_PROVIDERS.clear()
  342. if GOOGLE_CLIENT_ID.value and GOOGLE_CLIENT_SECRET.value:
  343. OAUTH_PROVIDERS["google"] = {
  344. "client_id": GOOGLE_CLIENT_ID.value,
  345. "client_secret": GOOGLE_CLIENT_SECRET.value,
  346. "server_metadata_url": "https://accounts.google.com/.well-known/openid-configuration",
  347. "scope": GOOGLE_OAUTH_SCOPE.value,
  348. "redirect_uri": GOOGLE_REDIRECT_URI.value,
  349. }
  350. if (
  351. MICROSOFT_CLIENT_ID.value
  352. and MICROSOFT_CLIENT_SECRET.value
  353. and MICROSOFT_CLIENT_TENANT_ID.value
  354. ):
  355. OAUTH_PROVIDERS["microsoft"] = {
  356. "client_id": MICROSOFT_CLIENT_ID.value,
  357. "client_secret": MICROSOFT_CLIENT_SECRET.value,
  358. "server_metadata_url": f"https://login.microsoftonline.com/{MICROSOFT_CLIENT_TENANT_ID.value}/v2.0/.well-known/openid-configuration",
  359. "scope": MICROSOFT_OAUTH_SCOPE.value,
  360. "redirect_uri": MICROSOFT_REDIRECT_URI.value,
  361. }
  362. if (
  363. OAUTH_CLIENT_ID.value
  364. and OAUTH_CLIENT_SECRET.value
  365. and OPENID_PROVIDER_URL.value
  366. ):
  367. OAUTH_PROVIDERS["oidc"] = {
  368. "client_id": OAUTH_CLIENT_ID.value,
  369. "client_secret": OAUTH_CLIENT_SECRET.value,
  370. "server_metadata_url": OPENID_PROVIDER_URL.value,
  371. "scope": OAUTH_SCOPES.value,
  372. "name": OAUTH_PROVIDER_NAME.value,
  373. "redirect_uri": OPENID_REDIRECT_URI.value,
  374. }
  375. load_oauth_providers()
  376. ####################################
  377. # Static DIR
  378. ####################################
  379. STATIC_DIR = Path(os.getenv("STATIC_DIR", OPEN_WEBUI_DIR / "static")).resolve()
  380. frontend_favicon = FRONTEND_BUILD_DIR / "static" / "favicon.png"
  381. if frontend_favicon.exists():
  382. try:
  383. shutil.copyfile(frontend_favicon, STATIC_DIR / "favicon.png")
  384. except Exception as e:
  385. logging.error(f"An error occurred: {e}")
  386. else:
  387. logging.warning(f"Frontend favicon not found at {frontend_favicon}")
  388. frontend_splash = FRONTEND_BUILD_DIR / "static" / "splash.png"
  389. if frontend_splash.exists():
  390. try:
  391. shutil.copyfile(frontend_splash, STATIC_DIR / "splash.png")
  392. except Exception as e:
  393. logging.error(f"An error occurred: {e}")
  394. else:
  395. logging.warning(f"Frontend splash not found at {frontend_splash}")
  396. ####################################
  397. # CUSTOM_NAME
  398. ####################################
  399. CUSTOM_NAME = os.environ.get("CUSTOM_NAME", "")
  400. if CUSTOM_NAME:
  401. try:
  402. r = requests.get(f"https://api.openwebui.com/api/v1/custom/{CUSTOM_NAME}")
  403. data = r.json()
  404. if r.ok:
  405. if "logo" in data:
  406. WEBUI_FAVICON_URL = url = (
  407. f"https://api.openwebui.com{data['logo']}"
  408. if data["logo"][0] == "/"
  409. else data["logo"]
  410. )
  411. r = requests.get(url, stream=True)
  412. if r.status_code == 200:
  413. with open(f"{STATIC_DIR}/favicon.png", "wb") as f:
  414. r.raw.decode_content = True
  415. shutil.copyfileobj(r.raw, f)
  416. if "splash" in data:
  417. url = (
  418. f"https://api.openwebui.com{data['splash']}"
  419. if data["splash"][0] == "/"
  420. else data["splash"]
  421. )
  422. r = requests.get(url, stream=True)
  423. if r.status_code == 200:
  424. with open(f"{STATIC_DIR}/splash.png", "wb") as f:
  425. r.raw.decode_content = True
  426. shutil.copyfileobj(r.raw, f)
  427. WEBUI_NAME = data["name"]
  428. except Exception as e:
  429. log.exception(e)
  430. pass
  431. ####################################
  432. # File Upload DIR
  433. ####################################
  434. UPLOAD_DIR = f"{DATA_DIR}/uploads"
  435. Path(UPLOAD_DIR).mkdir(parents=True, exist_ok=True)
  436. ####################################
  437. # Cache DIR
  438. ####################################
  439. CACHE_DIR = f"{DATA_DIR}/cache"
  440. Path(CACHE_DIR).mkdir(parents=True, exist_ok=True)
  441. ####################################
  442. # Tools DIR
  443. ####################################
  444. TOOLS_DIR = os.getenv("TOOLS_DIR", f"{DATA_DIR}/tools")
  445. Path(TOOLS_DIR).mkdir(parents=True, exist_ok=True)
  446. ####################################
  447. # Functions DIR
  448. ####################################
  449. FUNCTIONS_DIR = os.getenv("FUNCTIONS_DIR", f"{DATA_DIR}/functions")
  450. Path(FUNCTIONS_DIR).mkdir(parents=True, exist_ok=True)
  451. ####################################
  452. # OLLAMA_BASE_URL
  453. ####################################
  454. ENABLE_OLLAMA_API = PersistentConfig(
  455. "ENABLE_OLLAMA_API",
  456. "ollama.enable",
  457. os.environ.get("ENABLE_OLLAMA_API", "True").lower() == "true",
  458. )
  459. OLLAMA_API_BASE_URL = os.environ.get(
  460. "OLLAMA_API_BASE_URL", "http://localhost:11434/api"
  461. )
  462. OLLAMA_BASE_URL = os.environ.get("OLLAMA_BASE_URL", "")
  463. K8S_FLAG = os.environ.get("K8S_FLAG", "")
  464. USE_OLLAMA_DOCKER = os.environ.get("USE_OLLAMA_DOCKER", "false")
  465. if OLLAMA_BASE_URL == "" and OLLAMA_API_BASE_URL != "":
  466. OLLAMA_BASE_URL = (
  467. OLLAMA_API_BASE_URL[:-4]
  468. if OLLAMA_API_BASE_URL.endswith("/api")
  469. else OLLAMA_API_BASE_URL
  470. )
  471. if ENV == "prod":
  472. if OLLAMA_BASE_URL == "/ollama" and not K8S_FLAG:
  473. if USE_OLLAMA_DOCKER.lower() == "true":
  474. # if you use all-in-one docker container (Open WebUI + Ollama)
  475. # with the docker build arg USE_OLLAMA=true (--build-arg="USE_OLLAMA=true") this only works with http://localhost:11434
  476. OLLAMA_BASE_URL = "http://localhost:11434"
  477. else:
  478. OLLAMA_BASE_URL = "http://host.docker.internal:11434"
  479. elif K8S_FLAG:
  480. OLLAMA_BASE_URL = "http://ollama-service.open-webui.svc.cluster.local:11434"
  481. OLLAMA_BASE_URLS = os.environ.get("OLLAMA_BASE_URLS", "")
  482. OLLAMA_BASE_URLS = OLLAMA_BASE_URLS if OLLAMA_BASE_URLS != "" else OLLAMA_BASE_URL
  483. OLLAMA_BASE_URLS = [url.strip() for url in OLLAMA_BASE_URLS.split(";")]
  484. OLLAMA_BASE_URLS = PersistentConfig(
  485. "OLLAMA_BASE_URLS", "ollama.base_urls", OLLAMA_BASE_URLS
  486. )
  487. ####################################
  488. # OPENAI_API
  489. ####################################
  490. ENABLE_OPENAI_API = PersistentConfig(
  491. "ENABLE_OPENAI_API",
  492. "openai.enable",
  493. os.environ.get("ENABLE_OPENAI_API", "True").lower() == "true",
  494. )
  495. OPENAI_API_KEY = os.environ.get("OPENAI_API_KEY", "")
  496. OPENAI_API_BASE_URL = os.environ.get("OPENAI_API_BASE_URL", "")
  497. if OPENAI_API_BASE_URL == "":
  498. OPENAI_API_BASE_URL = "https://api.openai.com/v1"
  499. OPENAI_API_KEYS = os.environ.get("OPENAI_API_KEYS", "")
  500. OPENAI_API_KEYS = OPENAI_API_KEYS if OPENAI_API_KEYS != "" else OPENAI_API_KEY
  501. OPENAI_API_KEYS = [url.strip() for url in OPENAI_API_KEYS.split(";")]
  502. OPENAI_API_KEYS = PersistentConfig(
  503. "OPENAI_API_KEYS", "openai.api_keys", OPENAI_API_KEYS
  504. )
  505. OPENAI_API_BASE_URLS = os.environ.get("OPENAI_API_BASE_URLS", "")
  506. OPENAI_API_BASE_URLS = (
  507. OPENAI_API_BASE_URLS if OPENAI_API_BASE_URLS != "" else OPENAI_API_BASE_URL
  508. )
  509. OPENAI_API_BASE_URLS = [
  510. url.strip() if url != "" else "https://api.openai.com/v1"
  511. for url in OPENAI_API_BASE_URLS.split(";")
  512. ]
  513. OPENAI_API_BASE_URLS = PersistentConfig(
  514. "OPENAI_API_BASE_URLS", "openai.api_base_urls", OPENAI_API_BASE_URLS
  515. )
  516. OPENAI_API_KEY = ""
  517. try:
  518. OPENAI_API_KEY = OPENAI_API_KEYS.value[
  519. OPENAI_API_BASE_URLS.value.index("https://api.openai.com/v1")
  520. ]
  521. except Exception:
  522. pass
  523. OPENAI_API_BASE_URL = "https://api.openai.com/v1"
  524. ####################################
  525. # WEBUI
  526. ####################################
  527. ENABLE_SIGNUP = PersistentConfig(
  528. "ENABLE_SIGNUP",
  529. "ui.enable_signup",
  530. (
  531. False
  532. if not WEBUI_AUTH
  533. else os.environ.get("ENABLE_SIGNUP", "True").lower() == "true"
  534. ),
  535. )
  536. ENABLE_LOGIN_FORM = PersistentConfig(
  537. "ENABLE_LOGIN_FORM",
  538. "ui.ENABLE_LOGIN_FORM",
  539. os.environ.get("ENABLE_LOGIN_FORM", "True").lower() == "true",
  540. )
  541. DEFAULT_LOCALE = PersistentConfig(
  542. "DEFAULT_LOCALE",
  543. "ui.default_locale",
  544. os.environ.get("DEFAULT_LOCALE", ""),
  545. )
  546. DEFAULT_MODELS = PersistentConfig(
  547. "DEFAULT_MODELS", "ui.default_models", os.environ.get("DEFAULT_MODELS", None)
  548. )
  549. DEFAULT_PROMPT_SUGGESTIONS = PersistentConfig(
  550. "DEFAULT_PROMPT_SUGGESTIONS",
  551. "ui.prompt_suggestions",
  552. [
  553. {
  554. "title": ["Help me study", "vocabulary for a college entrance exam"],
  555. "content": "Help me study vocabulary: write a sentence for me to fill in the blank, and I'll try to pick the correct option.",
  556. },
  557. {
  558. "title": ["Give me ideas", "for what to do with my kids' art"],
  559. "content": "What are 5 creative things I could do with my kids' art? I don't want to throw them away, but it's also so much clutter.",
  560. },
  561. {
  562. "title": ["Tell me a fun fact", "about the Roman Empire"],
  563. "content": "Tell me a random fun fact about the Roman Empire",
  564. },
  565. {
  566. "title": ["Show me a code snippet", "of a website's sticky header"],
  567. "content": "Show me a code snippet of a website's sticky header in CSS and JavaScript.",
  568. },
  569. {
  570. "title": [
  571. "Explain options trading",
  572. "if I'm familiar with buying and selling stocks",
  573. ],
  574. "content": "Explain options trading in simple terms if I'm familiar with buying and selling stocks.",
  575. },
  576. {
  577. "title": ["Overcome procrastination", "give me tips"],
  578. "content": "Could you start by asking me about instances when I procrastinate the most and then give me some suggestions to overcome it?",
  579. },
  580. ],
  581. )
  582. DEFAULT_USER_ROLE = PersistentConfig(
  583. "DEFAULT_USER_ROLE",
  584. "ui.default_user_role",
  585. os.getenv("DEFAULT_USER_ROLE", "pending"),
  586. )
  587. USER_PERMISSIONS_CHAT_DELETION = (
  588. os.environ.get("USER_PERMISSIONS_CHAT_DELETION", "True").lower() == "true"
  589. )
  590. USER_PERMISSIONS_CHAT_EDITING = (
  591. os.environ.get("USER_PERMISSIONS_CHAT_EDITING", "True").lower() == "true"
  592. )
  593. USER_PERMISSIONS_CHAT_TEMPORARY = (
  594. os.environ.get("USER_PERMISSIONS_CHAT_TEMPORARY", "True").lower() == "true"
  595. )
  596. USER_PERMISSIONS = PersistentConfig(
  597. "USER_PERMISSIONS",
  598. "ui.user_permissions",
  599. {
  600. "chat": {
  601. "deletion": USER_PERMISSIONS_CHAT_DELETION,
  602. "editing": USER_PERMISSIONS_CHAT_EDITING,
  603. "temporary": USER_PERMISSIONS_CHAT_TEMPORARY,
  604. }
  605. },
  606. )
  607. ENABLE_MODEL_FILTER = PersistentConfig(
  608. "ENABLE_MODEL_FILTER",
  609. "model_filter.enable",
  610. os.environ.get("ENABLE_MODEL_FILTER", "False").lower() == "true",
  611. )
  612. MODEL_FILTER_LIST = os.environ.get("MODEL_FILTER_LIST", "")
  613. MODEL_FILTER_LIST = PersistentConfig(
  614. "MODEL_FILTER_LIST",
  615. "model_filter.list",
  616. [model.strip() for model in MODEL_FILTER_LIST.split(";")],
  617. )
  618. WEBHOOK_URL = PersistentConfig(
  619. "WEBHOOK_URL", "webhook_url", os.environ.get("WEBHOOK_URL", "")
  620. )
  621. ENABLE_ADMIN_EXPORT = os.environ.get("ENABLE_ADMIN_EXPORT", "True").lower() == "true"
  622. ENABLE_ADMIN_CHAT_ACCESS = (
  623. os.environ.get("ENABLE_ADMIN_CHAT_ACCESS", "True").lower() == "true"
  624. )
  625. ENABLE_COMMUNITY_SHARING = PersistentConfig(
  626. "ENABLE_COMMUNITY_SHARING",
  627. "ui.enable_community_sharing",
  628. os.environ.get("ENABLE_COMMUNITY_SHARING", "True").lower() == "true",
  629. )
  630. ENABLE_MESSAGE_RATING = PersistentConfig(
  631. "ENABLE_MESSAGE_RATING",
  632. "ui.enable_message_rating",
  633. os.environ.get("ENABLE_MESSAGE_RATING", "True").lower() == "true",
  634. )
  635. def validate_cors_origins(origins):
  636. for origin in origins:
  637. if origin != "*":
  638. validate_cors_origin(origin)
  639. def validate_cors_origin(origin):
  640. parsed_url = urlparse(origin)
  641. # Check if the scheme is either http or https
  642. if parsed_url.scheme not in ["http", "https"]:
  643. raise ValueError(
  644. f"Invalid scheme in CORS_ALLOW_ORIGIN: '{origin}'. Only 'http' and 'https' are allowed."
  645. )
  646. # Ensure that the netloc (domain + port) is present, indicating it's a valid URL
  647. if not parsed_url.netloc:
  648. raise ValueError(f"Invalid URL structure in CORS_ALLOW_ORIGIN: '{origin}'.")
  649. # For production, you should only need one host as
  650. # fastapi serves the svelte-kit built frontend and backend from the same host and port.
  651. # To test CORS_ALLOW_ORIGIN locally, you can set something like
  652. # CORS_ALLOW_ORIGIN=http://localhost:5173;http://localhost:8080
  653. # in your .env file depending on your frontend port, 5173 in this case.
  654. CORS_ALLOW_ORIGIN = os.environ.get("CORS_ALLOW_ORIGIN", "*").split(";")
  655. if "*" in CORS_ALLOW_ORIGIN:
  656. log.warning(
  657. "\n\nWARNING: CORS_ALLOW_ORIGIN IS SET TO '*' - NOT RECOMMENDED FOR PRODUCTION DEPLOYMENTS.\n"
  658. )
  659. validate_cors_origins(CORS_ALLOW_ORIGIN)
  660. class BannerModel(BaseModel):
  661. id: str
  662. type: str
  663. title: Optional[str] = None
  664. content: str
  665. dismissible: bool
  666. timestamp: int
  667. try:
  668. banners = json.loads(os.environ.get("WEBUI_BANNERS", "[]"))
  669. banners = [BannerModel(**banner) for banner in banners]
  670. except Exception as e:
  671. print(f"Error loading WEBUI_BANNERS: {e}")
  672. banners = []
  673. WEBUI_BANNERS = PersistentConfig("WEBUI_BANNERS", "ui.banners", banners)
  674. SHOW_ADMIN_DETAILS = PersistentConfig(
  675. "SHOW_ADMIN_DETAILS",
  676. "auth.admin.show",
  677. os.environ.get("SHOW_ADMIN_DETAILS", "true").lower() == "true",
  678. )
  679. ADMIN_EMAIL = PersistentConfig(
  680. "ADMIN_EMAIL",
  681. "auth.admin.email",
  682. os.environ.get("ADMIN_EMAIL", None),
  683. )
  684. ####################################
  685. # TASKS
  686. ####################################
  687. TASK_MODEL = PersistentConfig(
  688. "TASK_MODEL",
  689. "task.model.default",
  690. os.environ.get("TASK_MODEL", ""),
  691. )
  692. TASK_MODEL_EXTERNAL = PersistentConfig(
  693. "TASK_MODEL_EXTERNAL",
  694. "task.model.external",
  695. os.environ.get("TASK_MODEL_EXTERNAL", ""),
  696. )
  697. TITLE_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  698. "TITLE_GENERATION_PROMPT_TEMPLATE",
  699. "task.title.prompt_template",
  700. os.environ.get("TITLE_GENERATION_PROMPT_TEMPLATE", ""),
  701. )
  702. ENABLE_SEARCH_QUERY = PersistentConfig(
  703. "ENABLE_SEARCH_QUERY",
  704. "task.search.enable",
  705. os.environ.get("ENABLE_SEARCH_QUERY", "True").lower() == "true",
  706. )
  707. SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  708. "SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE",
  709. "task.search.prompt_template",
  710. os.environ.get("SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE", ""),
  711. )
  712. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = PersistentConfig(
  713. "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE",
  714. "task.tools.prompt_template",
  715. os.environ.get("TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE", ""),
  716. )
  717. ####################################
  718. # Vector Database
  719. ####################################
  720. VECTOR_DB = os.environ.get("VECTOR_DB", "chroma")
  721. # Chroma
  722. CHROMA_DATA_PATH = f"{DATA_DIR}/vector_db"
  723. CHROMA_TENANT = os.environ.get("CHROMA_TENANT", chromadb.DEFAULT_TENANT)
  724. CHROMA_DATABASE = os.environ.get("CHROMA_DATABASE", chromadb.DEFAULT_DATABASE)
  725. CHROMA_HTTP_HOST = os.environ.get("CHROMA_HTTP_HOST", "")
  726. CHROMA_HTTP_PORT = int(os.environ.get("CHROMA_HTTP_PORT", "8000"))
  727. # Comma-separated list of header=value pairs
  728. CHROMA_HTTP_HEADERS = os.environ.get("CHROMA_HTTP_HEADERS", "")
  729. if CHROMA_HTTP_HEADERS:
  730. CHROMA_HTTP_HEADERS = dict(
  731. [pair.split("=") for pair in CHROMA_HTTP_HEADERS.split(",")]
  732. )
  733. else:
  734. CHROMA_HTTP_HEADERS = None
  735. CHROMA_HTTP_SSL = os.environ.get("CHROMA_HTTP_SSL", "false").lower() == "true"
  736. # this uses the model defined in the Dockerfile ENV variable. If you dont use docker or docker based deployments such as k8s, the default embedding model will be used (sentence-transformers/all-MiniLM-L6-v2)
  737. # Milvus
  738. MILVUS_URI = os.environ.get("MILVUS_URI", f"{DATA_DIR}/vector_db/milvus.db")
  739. # Qdrant
  740. QDRANT_URI = os.environ.get("QDRANT_URI", None)
  741. ####################################
  742. # Information Retrieval (RAG)
  743. ####################################
  744. # RAG Content Extraction
  745. CONTENT_EXTRACTION_ENGINE = PersistentConfig(
  746. "CONTENT_EXTRACTION_ENGINE",
  747. "rag.CONTENT_EXTRACTION_ENGINE",
  748. os.environ.get("CONTENT_EXTRACTION_ENGINE", "").lower(),
  749. )
  750. TIKA_SERVER_URL = PersistentConfig(
  751. "TIKA_SERVER_URL",
  752. "rag.tika_server_url",
  753. os.getenv("TIKA_SERVER_URL", "http://tika:9998"), # Default for sidecar deployment
  754. )
  755. RAG_TOP_K = PersistentConfig(
  756. "RAG_TOP_K", "rag.top_k", int(os.environ.get("RAG_TOP_K", "3"))
  757. )
  758. RAG_RELEVANCE_THRESHOLD = PersistentConfig(
  759. "RAG_RELEVANCE_THRESHOLD",
  760. "rag.relevance_threshold",
  761. float(os.environ.get("RAG_RELEVANCE_THRESHOLD", "0.0")),
  762. )
  763. ENABLE_RAG_HYBRID_SEARCH = PersistentConfig(
  764. "ENABLE_RAG_HYBRID_SEARCH",
  765. "rag.enable_hybrid_search",
  766. os.environ.get("ENABLE_RAG_HYBRID_SEARCH", "").lower() == "true",
  767. )
  768. RAG_FILE_MAX_COUNT = PersistentConfig(
  769. "RAG_FILE_MAX_COUNT",
  770. "rag.file.max_count",
  771. (
  772. int(os.environ.get("RAG_FILE_MAX_COUNT"))
  773. if os.environ.get("RAG_FILE_MAX_COUNT")
  774. else None
  775. ),
  776. )
  777. RAG_FILE_MAX_SIZE = PersistentConfig(
  778. "RAG_FILE_MAX_SIZE",
  779. "rag.file.max_size",
  780. (
  781. int(os.environ.get("RAG_FILE_MAX_SIZE"))
  782. if os.environ.get("RAG_FILE_MAX_SIZE")
  783. else None
  784. ),
  785. )
  786. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = PersistentConfig(
  787. "ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION",
  788. "rag.enable_web_loader_ssl_verification",
  789. os.environ.get("ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION", "True").lower() == "true",
  790. )
  791. RAG_EMBEDDING_ENGINE = PersistentConfig(
  792. "RAG_EMBEDDING_ENGINE",
  793. "rag.embedding_engine",
  794. os.environ.get("RAG_EMBEDDING_ENGINE", ""),
  795. )
  796. PDF_EXTRACT_IMAGES = PersistentConfig(
  797. "PDF_EXTRACT_IMAGES",
  798. "rag.pdf_extract_images",
  799. os.environ.get("PDF_EXTRACT_IMAGES", "False").lower() == "true",
  800. )
  801. RAG_EMBEDDING_MODEL = PersistentConfig(
  802. "RAG_EMBEDDING_MODEL",
  803. "rag.embedding_model",
  804. os.environ.get("RAG_EMBEDDING_MODEL", "sentence-transformers/all-MiniLM-L6-v2"),
  805. )
  806. log.info(f"Embedding model set: {RAG_EMBEDDING_MODEL.value}")
  807. RAG_EMBEDDING_MODEL_AUTO_UPDATE = (
  808. os.environ.get("RAG_EMBEDDING_MODEL_AUTO_UPDATE", "").lower() == "true"
  809. )
  810. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE = (
  811. os.environ.get("RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE", "").lower() == "true"
  812. )
  813. RAG_EMBEDDING_BATCH_SIZE = PersistentConfig(
  814. "RAG_EMBEDDING_BATCH_SIZE",
  815. "rag.embedding_batch_size",
  816. int(
  817. os.environ.get("RAG_EMBEDDING_BATCH_SIZE")
  818. or os.environ.get("RAG_EMBEDDING_OPENAI_BATCH_SIZE", "1")
  819. ),
  820. )
  821. RAG_RERANKING_MODEL = PersistentConfig(
  822. "RAG_RERANKING_MODEL",
  823. "rag.reranking_model",
  824. os.environ.get("RAG_RERANKING_MODEL", ""),
  825. )
  826. if RAG_RERANKING_MODEL.value != "":
  827. log.info(f"Reranking model set: {RAG_RERANKING_MODEL.value}")
  828. RAG_RERANKING_MODEL_AUTO_UPDATE = (
  829. os.environ.get("RAG_RERANKING_MODEL_AUTO_UPDATE", "").lower() == "true"
  830. )
  831. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE = (
  832. os.environ.get("RAG_RERANKING_MODEL_TRUST_REMOTE_CODE", "").lower() == "true"
  833. )
  834. RAG_TEXT_SPLITTER = PersistentConfig(
  835. "RAG_TEXT_SPLITTER",
  836. "rag.text_splitter",
  837. os.environ.get("RAG_TEXT_SPLITTER", ""),
  838. )
  839. TIKTOKEN_CACHE_DIR = os.environ.get("TIKTOKEN_CACHE_DIR", f"{CACHE_DIR}/tiktoken")
  840. TIKTOKEN_ENCODING_NAME = PersistentConfig(
  841. "TIKTOKEN_ENCODING_NAME",
  842. "rag.tiktoken_encoding_name",
  843. os.environ.get("TIKTOKEN_ENCODING_NAME", "cl100k_base"),
  844. )
  845. CHUNK_SIZE = PersistentConfig(
  846. "CHUNK_SIZE", "rag.chunk_size", int(os.environ.get("CHUNK_SIZE", "1000"))
  847. )
  848. CHUNK_OVERLAP = PersistentConfig(
  849. "CHUNK_OVERLAP",
  850. "rag.chunk_overlap",
  851. int(os.environ.get("CHUNK_OVERLAP", "100")),
  852. )
  853. DEFAULT_RAG_TEMPLATE = """You are given a user query, some textual context and rules, all inside xml tags. You have to answer the query based on the context while respecting the rules.
  854. <context>
  855. {{CONTEXT}}
  856. </context>
  857. <rules>
  858. - If you don't know, just say so.
  859. - If you are not sure, ask for clarification.
  860. - Answer in the same language as the user query.
  861. - If the context appears unreadable or of poor quality, tell the user then answer as best as you can.
  862. - If the answer is not in the context but you think you know the answer, explain that to the user then answer with your own knowledge.
  863. - Answer directly and without using xml tags.
  864. </rules>
  865. <user_query>
  866. {{QUERY}}
  867. </user_query>
  868. """
  869. RAG_TEMPLATE = PersistentConfig(
  870. "RAG_TEMPLATE",
  871. "rag.template",
  872. os.environ.get("RAG_TEMPLATE", DEFAULT_RAG_TEMPLATE),
  873. )
  874. RAG_OPENAI_API_BASE_URL = PersistentConfig(
  875. "RAG_OPENAI_API_BASE_URL",
  876. "rag.openai_api_base_url",
  877. os.getenv("RAG_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  878. )
  879. RAG_OPENAI_API_KEY = PersistentConfig(
  880. "RAG_OPENAI_API_KEY",
  881. "rag.openai_api_key",
  882. os.getenv("RAG_OPENAI_API_KEY", OPENAI_API_KEY),
  883. )
  884. ENABLE_RAG_LOCAL_WEB_FETCH = (
  885. os.getenv("ENABLE_RAG_LOCAL_WEB_FETCH", "False").lower() == "true"
  886. )
  887. YOUTUBE_LOADER_LANGUAGE = PersistentConfig(
  888. "YOUTUBE_LOADER_LANGUAGE",
  889. "rag.youtube_loader_language",
  890. os.getenv("YOUTUBE_LOADER_LANGUAGE", "en").split(","),
  891. )
  892. ENABLE_RAG_WEB_SEARCH = PersistentConfig(
  893. "ENABLE_RAG_WEB_SEARCH",
  894. "rag.web.search.enable",
  895. os.getenv("ENABLE_RAG_WEB_SEARCH", "False").lower() == "true",
  896. )
  897. RAG_WEB_SEARCH_ENGINE = PersistentConfig(
  898. "RAG_WEB_SEARCH_ENGINE",
  899. "rag.web.search.engine",
  900. os.getenv("RAG_WEB_SEARCH_ENGINE", ""),
  901. )
  902. # You can provide a list of your own websites to filter after performing a web search.
  903. # This ensures the highest level of safety and reliability of the information sources.
  904. RAG_WEB_SEARCH_DOMAIN_FILTER_LIST = PersistentConfig(
  905. "RAG_WEB_SEARCH_DOMAIN_FILTER_LIST",
  906. "rag.rag.web.search.domain.filter_list",
  907. [
  908. # "wikipedia.com",
  909. # "wikimedia.org",
  910. # "wikidata.org",
  911. ],
  912. )
  913. SEARXNG_QUERY_URL = PersistentConfig(
  914. "SEARXNG_QUERY_URL",
  915. "rag.web.search.searxng_query_url",
  916. os.getenv("SEARXNG_QUERY_URL", ""),
  917. )
  918. GOOGLE_PSE_API_KEY = PersistentConfig(
  919. "GOOGLE_PSE_API_KEY",
  920. "rag.web.search.google_pse_api_key",
  921. os.getenv("GOOGLE_PSE_API_KEY", ""),
  922. )
  923. GOOGLE_PSE_ENGINE_ID = PersistentConfig(
  924. "GOOGLE_PSE_ENGINE_ID",
  925. "rag.web.search.google_pse_engine_id",
  926. os.getenv("GOOGLE_PSE_ENGINE_ID", ""),
  927. )
  928. BRAVE_SEARCH_API_KEY = PersistentConfig(
  929. "BRAVE_SEARCH_API_KEY",
  930. "rag.web.search.brave_search_api_key",
  931. os.getenv("BRAVE_SEARCH_API_KEY", ""),
  932. )
  933. SERPSTACK_API_KEY = PersistentConfig(
  934. "SERPSTACK_API_KEY",
  935. "rag.web.search.serpstack_api_key",
  936. os.getenv("SERPSTACK_API_KEY", ""),
  937. )
  938. SERPSTACK_HTTPS = PersistentConfig(
  939. "SERPSTACK_HTTPS",
  940. "rag.web.search.serpstack_https",
  941. os.getenv("SERPSTACK_HTTPS", "True").lower() == "true",
  942. )
  943. SERPER_API_KEY = PersistentConfig(
  944. "SERPER_API_KEY",
  945. "rag.web.search.serper_api_key",
  946. os.getenv("SERPER_API_KEY", ""),
  947. )
  948. SERPLY_API_KEY = PersistentConfig(
  949. "SERPLY_API_KEY",
  950. "rag.web.search.serply_api_key",
  951. os.getenv("SERPLY_API_KEY", ""),
  952. )
  953. TAVILY_API_KEY = PersistentConfig(
  954. "TAVILY_API_KEY",
  955. "rag.web.search.tavily_api_key",
  956. os.getenv("TAVILY_API_KEY", ""),
  957. )
  958. SEARCHAPI_API_KEY = PersistentConfig(
  959. "SEARCHAPI_API_KEY",
  960. "rag.web.search.searchapi_api_key",
  961. os.getenv("SEARCHAPI_API_KEY", ""),
  962. )
  963. SEARCHAPI_ENGINE = PersistentConfig(
  964. "SEARCHAPI_ENGINE",
  965. "rag.web.search.searchapi_engine",
  966. os.getenv("SEARCHAPI_ENGINE", ""),
  967. )
  968. RAG_WEB_SEARCH_RESULT_COUNT = PersistentConfig(
  969. "RAG_WEB_SEARCH_RESULT_COUNT",
  970. "rag.web.search.result_count",
  971. int(os.getenv("RAG_WEB_SEARCH_RESULT_COUNT", "3")),
  972. )
  973. RAG_WEB_SEARCH_CONCURRENT_REQUESTS = PersistentConfig(
  974. "RAG_WEB_SEARCH_CONCURRENT_REQUESTS",
  975. "rag.web.search.concurrent_requests",
  976. int(os.getenv("RAG_WEB_SEARCH_CONCURRENT_REQUESTS", "10")),
  977. )
  978. ####################################
  979. # Transcribe
  980. ####################################
  981. WHISPER_MODEL = os.getenv("WHISPER_MODEL", "base")
  982. WHISPER_MODEL_DIR = os.getenv("WHISPER_MODEL_DIR", f"{CACHE_DIR}/whisper/models")
  983. WHISPER_MODEL_AUTO_UPDATE = (
  984. os.environ.get("WHISPER_MODEL_AUTO_UPDATE", "").lower() == "true"
  985. )
  986. ####################################
  987. # Images
  988. ####################################
  989. IMAGE_GENERATION_ENGINE = PersistentConfig(
  990. "IMAGE_GENERATION_ENGINE",
  991. "image_generation.engine",
  992. os.getenv("IMAGE_GENERATION_ENGINE", "openai"),
  993. )
  994. ENABLE_IMAGE_GENERATION = PersistentConfig(
  995. "ENABLE_IMAGE_GENERATION",
  996. "image_generation.enable",
  997. os.environ.get("ENABLE_IMAGE_GENERATION", "").lower() == "true",
  998. )
  999. AUTOMATIC1111_BASE_URL = PersistentConfig(
  1000. "AUTOMATIC1111_BASE_URL",
  1001. "image_generation.automatic1111.base_url",
  1002. os.getenv("AUTOMATIC1111_BASE_URL", ""),
  1003. )
  1004. AUTOMATIC1111_API_AUTH = PersistentConfig(
  1005. "AUTOMATIC1111_API_AUTH",
  1006. "image_generation.automatic1111.api_auth",
  1007. os.getenv("AUTOMATIC1111_API_AUTH", ""),
  1008. )
  1009. AUTOMATIC1111_CFG_SCALE = PersistentConfig(
  1010. "AUTOMATIC1111_CFG_SCALE",
  1011. "image_generation.automatic1111.cfg_scale",
  1012. (
  1013. float(os.environ.get("AUTOMATIC1111_CFG_SCALE"))
  1014. if os.environ.get("AUTOMATIC1111_CFG_SCALE")
  1015. else None
  1016. ),
  1017. )
  1018. AUTOMATIC1111_SAMPLER = PersistentConfig(
  1019. "AUTOMATIC1111_SAMPLERE",
  1020. "image_generation.automatic1111.sampler",
  1021. (
  1022. os.environ.get("AUTOMATIC1111_SAMPLER")
  1023. if os.environ.get("AUTOMATIC1111_SAMPLER")
  1024. else None
  1025. ),
  1026. )
  1027. AUTOMATIC1111_SCHEDULER = PersistentConfig(
  1028. "AUTOMATIC1111_SCHEDULER",
  1029. "image_generation.automatic1111.scheduler",
  1030. (
  1031. os.environ.get("AUTOMATIC1111_SCHEDULER")
  1032. if os.environ.get("AUTOMATIC1111_SCHEDULER")
  1033. else None
  1034. ),
  1035. )
  1036. COMFYUI_BASE_URL = PersistentConfig(
  1037. "COMFYUI_BASE_URL",
  1038. "image_generation.comfyui.base_url",
  1039. os.getenv("COMFYUI_BASE_URL", ""),
  1040. )
  1041. COMFYUI_DEFAULT_WORKFLOW = """
  1042. {
  1043. "3": {
  1044. "inputs": {
  1045. "seed": 0,
  1046. "steps": 20,
  1047. "cfg": 8,
  1048. "sampler_name": "euler",
  1049. "scheduler": "normal",
  1050. "denoise": 1,
  1051. "model": [
  1052. "4",
  1053. 0
  1054. ],
  1055. "positive": [
  1056. "6",
  1057. 0
  1058. ],
  1059. "negative": [
  1060. "7",
  1061. 0
  1062. ],
  1063. "latent_image": [
  1064. "5",
  1065. 0
  1066. ]
  1067. },
  1068. "class_type": "KSampler",
  1069. "_meta": {
  1070. "title": "KSampler"
  1071. }
  1072. },
  1073. "4": {
  1074. "inputs": {
  1075. "ckpt_name": "model.safetensors"
  1076. },
  1077. "class_type": "CheckpointLoaderSimple",
  1078. "_meta": {
  1079. "title": "Load Checkpoint"
  1080. }
  1081. },
  1082. "5": {
  1083. "inputs": {
  1084. "width": 512,
  1085. "height": 512,
  1086. "batch_size": 1
  1087. },
  1088. "class_type": "EmptyLatentImage",
  1089. "_meta": {
  1090. "title": "Empty Latent Image"
  1091. }
  1092. },
  1093. "6": {
  1094. "inputs": {
  1095. "text": "Prompt",
  1096. "clip": [
  1097. "4",
  1098. 1
  1099. ]
  1100. },
  1101. "class_type": "CLIPTextEncode",
  1102. "_meta": {
  1103. "title": "CLIP Text Encode (Prompt)"
  1104. }
  1105. },
  1106. "7": {
  1107. "inputs": {
  1108. "text": "",
  1109. "clip": [
  1110. "4",
  1111. 1
  1112. ]
  1113. },
  1114. "class_type": "CLIPTextEncode",
  1115. "_meta": {
  1116. "title": "CLIP Text Encode (Prompt)"
  1117. }
  1118. },
  1119. "8": {
  1120. "inputs": {
  1121. "samples": [
  1122. "3",
  1123. 0
  1124. ],
  1125. "vae": [
  1126. "4",
  1127. 2
  1128. ]
  1129. },
  1130. "class_type": "VAEDecode",
  1131. "_meta": {
  1132. "title": "VAE Decode"
  1133. }
  1134. },
  1135. "9": {
  1136. "inputs": {
  1137. "filename_prefix": "ComfyUI",
  1138. "images": [
  1139. "8",
  1140. 0
  1141. ]
  1142. },
  1143. "class_type": "SaveImage",
  1144. "_meta": {
  1145. "title": "Save Image"
  1146. }
  1147. }
  1148. }
  1149. """
  1150. COMFYUI_WORKFLOW = PersistentConfig(
  1151. "COMFYUI_WORKFLOW",
  1152. "image_generation.comfyui.workflow",
  1153. os.getenv("COMFYUI_WORKFLOW", COMFYUI_DEFAULT_WORKFLOW),
  1154. )
  1155. COMFYUI_WORKFLOW_NODES = PersistentConfig(
  1156. "COMFYUI_WORKFLOW",
  1157. "image_generation.comfyui.nodes",
  1158. [],
  1159. )
  1160. IMAGES_OPENAI_API_BASE_URL = PersistentConfig(
  1161. "IMAGES_OPENAI_API_BASE_URL",
  1162. "image_generation.openai.api_base_url",
  1163. os.getenv("IMAGES_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1164. )
  1165. IMAGES_OPENAI_API_KEY = PersistentConfig(
  1166. "IMAGES_OPENAI_API_KEY",
  1167. "image_generation.openai.api_key",
  1168. os.getenv("IMAGES_OPENAI_API_KEY", OPENAI_API_KEY),
  1169. )
  1170. IMAGE_SIZE = PersistentConfig(
  1171. "IMAGE_SIZE", "image_generation.size", os.getenv("IMAGE_SIZE", "512x512")
  1172. )
  1173. IMAGE_STEPS = PersistentConfig(
  1174. "IMAGE_STEPS", "image_generation.steps", int(os.getenv("IMAGE_STEPS", 50))
  1175. )
  1176. IMAGE_GENERATION_MODEL = PersistentConfig(
  1177. "IMAGE_GENERATION_MODEL",
  1178. "image_generation.model",
  1179. os.getenv("IMAGE_GENERATION_MODEL", ""),
  1180. )
  1181. ####################################
  1182. # Audio
  1183. ####################################
  1184. AUDIO_STT_OPENAI_API_BASE_URL = PersistentConfig(
  1185. "AUDIO_STT_OPENAI_API_BASE_URL",
  1186. "audio.stt.openai.api_base_url",
  1187. os.getenv("AUDIO_STT_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1188. )
  1189. AUDIO_STT_OPENAI_API_KEY = PersistentConfig(
  1190. "AUDIO_STT_OPENAI_API_KEY",
  1191. "audio.stt.openai.api_key",
  1192. os.getenv("AUDIO_STT_OPENAI_API_KEY", OPENAI_API_KEY),
  1193. )
  1194. AUDIO_STT_ENGINE = PersistentConfig(
  1195. "AUDIO_STT_ENGINE",
  1196. "audio.stt.engine",
  1197. os.getenv("AUDIO_STT_ENGINE", ""),
  1198. )
  1199. AUDIO_STT_MODEL = PersistentConfig(
  1200. "AUDIO_STT_MODEL",
  1201. "audio.stt.model",
  1202. os.getenv("AUDIO_STT_MODEL", "whisper-1"),
  1203. )
  1204. AUDIO_TTS_OPENAI_API_BASE_URL = PersistentConfig(
  1205. "AUDIO_TTS_OPENAI_API_BASE_URL",
  1206. "audio.tts.openai.api_base_url",
  1207. os.getenv("AUDIO_TTS_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1208. )
  1209. AUDIO_TTS_OPENAI_API_KEY = PersistentConfig(
  1210. "AUDIO_TTS_OPENAI_API_KEY",
  1211. "audio.tts.openai.api_key",
  1212. os.getenv("AUDIO_TTS_OPENAI_API_KEY", OPENAI_API_KEY),
  1213. )
  1214. AUDIO_TTS_API_KEY = PersistentConfig(
  1215. "AUDIO_TTS_API_KEY",
  1216. "audio.tts.api_key",
  1217. os.getenv("AUDIO_TTS_API_KEY", ""),
  1218. )
  1219. AUDIO_TTS_ENGINE = PersistentConfig(
  1220. "AUDIO_TTS_ENGINE",
  1221. "audio.tts.engine",
  1222. os.getenv("AUDIO_TTS_ENGINE", ""),
  1223. )
  1224. AUDIO_TTS_MODEL = PersistentConfig(
  1225. "AUDIO_TTS_MODEL",
  1226. "audio.tts.model",
  1227. os.getenv("AUDIO_TTS_MODEL", "tts-1"), # OpenAI default model
  1228. )
  1229. AUDIO_TTS_VOICE = PersistentConfig(
  1230. "AUDIO_TTS_VOICE",
  1231. "audio.tts.voice",
  1232. os.getenv("AUDIO_TTS_VOICE", "alloy"), # OpenAI default voice
  1233. )
  1234. AUDIO_TTS_SPLIT_ON = PersistentConfig(
  1235. "AUDIO_TTS_SPLIT_ON",
  1236. "audio.tts.split_on",
  1237. os.getenv("AUDIO_TTS_SPLIT_ON", "punctuation"),
  1238. )
  1239. AUDIO_TTS_AZURE_SPEECH_REGION = PersistentConfig(
  1240. "AUDIO_TTS_AZURE_SPEECH_REGION",
  1241. "audio.tts.azure.speech_region",
  1242. os.getenv("AUDIO_TTS_AZURE_SPEECH_REGION", "eastus"),
  1243. )
  1244. AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT = PersistentConfig(
  1245. "AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT",
  1246. "audio.tts.azure.speech_output_format",
  1247. os.getenv(
  1248. "AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT", "audio-24khz-160kbitrate-mono-mp3"
  1249. ),
  1250. )