config.py 40 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429
  1. import os
  2. import sys
  3. import logging
  4. import importlib.metadata
  5. import pkgutil
  6. import chromadb
  7. from chromadb import Settings
  8. from bs4 import BeautifulSoup
  9. from typing import TypeVar, Generic
  10. from pydantic import BaseModel
  11. from typing import Optional
  12. from pathlib import Path
  13. import json
  14. import yaml
  15. import markdown
  16. import requests
  17. import shutil
  18. from constants import ERROR_MESSAGES
  19. ####################################
  20. # Load .env file
  21. ####################################
  22. BACKEND_DIR = Path(__file__).parent # the path containing this file
  23. BASE_DIR = BACKEND_DIR.parent # the path containing the backend/
  24. print(BASE_DIR)
  25. try:
  26. from dotenv import load_dotenv, find_dotenv
  27. load_dotenv(find_dotenv(str(BASE_DIR / ".env")))
  28. except ImportError:
  29. print("dotenv not installed, skipping...")
  30. ####################################
  31. # LOGGING
  32. ####################################
  33. log_levels = ["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"]
  34. GLOBAL_LOG_LEVEL = os.environ.get("GLOBAL_LOG_LEVEL", "").upper()
  35. if GLOBAL_LOG_LEVEL in log_levels:
  36. logging.basicConfig(stream=sys.stdout, level=GLOBAL_LOG_LEVEL, force=True)
  37. else:
  38. GLOBAL_LOG_LEVEL = "INFO"
  39. log = logging.getLogger(__name__)
  40. log.info(f"GLOBAL_LOG_LEVEL: {GLOBAL_LOG_LEVEL}")
  41. log_sources = [
  42. "AUDIO",
  43. "COMFYUI",
  44. "CONFIG",
  45. "DB",
  46. "IMAGES",
  47. "MAIN",
  48. "MODELS",
  49. "OLLAMA",
  50. "OPENAI",
  51. "RAG",
  52. "WEBHOOK",
  53. ]
  54. SRC_LOG_LEVELS = {}
  55. for source in log_sources:
  56. log_env_var = source + "_LOG_LEVEL"
  57. SRC_LOG_LEVELS[source] = os.environ.get(log_env_var, "").upper()
  58. if SRC_LOG_LEVELS[source] not in log_levels:
  59. SRC_LOG_LEVELS[source] = GLOBAL_LOG_LEVEL
  60. log.info(f"{log_env_var}: {SRC_LOG_LEVELS[source]}")
  61. log.setLevel(SRC_LOG_LEVELS["CONFIG"])
  62. class EndpointFilter(logging.Filter):
  63. def filter(self, record: logging.LogRecord) -> bool:
  64. return record.getMessage().find("/health") == -1
  65. # Filter out /endpoint
  66. logging.getLogger("uvicorn.access").addFilter(EndpointFilter())
  67. WEBUI_NAME = os.environ.get("WEBUI_NAME", "Open WebUI")
  68. if WEBUI_NAME != "Open WebUI":
  69. WEBUI_NAME += " (Open WebUI)"
  70. WEBUI_URL = os.environ.get("WEBUI_URL", "http://localhost:3000")
  71. WEBUI_FAVICON_URL = "https://openwebui.com/favicon.png"
  72. ####################################
  73. # ENV (dev,test,prod)
  74. ####################################
  75. ENV = os.environ.get("ENV", "dev")
  76. try:
  77. PACKAGE_DATA = json.loads((BASE_DIR / "package.json").read_text())
  78. except Exception:
  79. try:
  80. PACKAGE_DATA = {"version": importlib.metadata.version("open-webui")}
  81. except importlib.metadata.PackageNotFoundError:
  82. PACKAGE_DATA = {"version": "0.0.0"}
  83. VERSION = PACKAGE_DATA["version"]
  84. # Function to parse each section
  85. def parse_section(section):
  86. items = []
  87. for li in section.find_all("li"):
  88. # Extract raw HTML string
  89. raw_html = str(li)
  90. # Extract text without HTML tags
  91. text = li.get_text(separator=" ", strip=True)
  92. # Split into title and content
  93. parts = text.split(": ", 1)
  94. title = parts[0].strip() if len(parts) > 1 else ""
  95. content = parts[1].strip() if len(parts) > 1 else text
  96. items.append({"title": title, "content": content, "raw": raw_html})
  97. return items
  98. try:
  99. changelog_path = BASE_DIR / "CHANGELOG.md"
  100. with open(str(changelog_path.absolute()), "r", encoding="utf8") as file:
  101. changelog_content = file.read()
  102. except Exception:
  103. changelog_content = (pkgutil.get_data("open_webui", "CHANGELOG.md") or b"").decode()
  104. # Convert markdown content to HTML
  105. html_content = markdown.markdown(changelog_content)
  106. # Parse the HTML content
  107. soup = BeautifulSoup(html_content, "html.parser")
  108. # Initialize JSON structure
  109. changelog_json = {}
  110. # Iterate over each version
  111. for version in soup.find_all("h2"):
  112. version_number = version.get_text().strip().split(" - ")[0][1:-1] # Remove brackets
  113. date = version.get_text().strip().split(" - ")[1]
  114. version_data = {"date": date}
  115. # Find the next sibling that is a h3 tag (section title)
  116. current = version.find_next_sibling()
  117. while current and current.name != "h2":
  118. if current.name == "h3":
  119. section_title = current.get_text().lower() # e.g., "added", "fixed"
  120. section_items = parse_section(current.find_next_sibling("ul"))
  121. version_data[section_title] = section_items
  122. # Move to the next element
  123. current = current.find_next_sibling()
  124. changelog_json[version_number] = version_data
  125. CHANGELOG = changelog_json
  126. ####################################
  127. # SAFE_MODE
  128. ####################################
  129. SAFE_MODE = os.environ.get("SAFE_MODE", "false").lower() == "true"
  130. ####################################
  131. # WEBUI_BUILD_HASH
  132. ####################################
  133. WEBUI_BUILD_HASH = os.environ.get("WEBUI_BUILD_HASH", "dev-build")
  134. ####################################
  135. # DATA/FRONTEND BUILD DIR
  136. ####################################
  137. DATA_DIR = Path(os.getenv("DATA_DIR", BACKEND_DIR / "data")).resolve()
  138. FRONTEND_BUILD_DIR = Path(os.getenv("FRONTEND_BUILD_DIR", BASE_DIR / "build")).resolve()
  139. RESET_CONFIG_ON_START = (
  140. os.environ.get("RESET_CONFIG_ON_START", "False").lower() == "true"
  141. )
  142. if RESET_CONFIG_ON_START:
  143. try:
  144. os.remove(f"{DATA_DIR}/config.json")
  145. with open(f"{DATA_DIR}/config.json", "w") as f:
  146. f.write("{}")
  147. except Exception:
  148. pass
  149. try:
  150. CONFIG_DATA = json.loads((DATA_DIR / "config.json").read_text())
  151. except Exception:
  152. CONFIG_DATA = {}
  153. ####################################
  154. # Config helpers
  155. ####################################
  156. def save_config():
  157. try:
  158. with open(f"{DATA_DIR}/config.json", "w") as f:
  159. json.dump(CONFIG_DATA, f, indent="\t")
  160. except Exception as e:
  161. log.exception(e)
  162. def get_config_value(config_path: str):
  163. path_parts = config_path.split(".")
  164. cur_config = CONFIG_DATA
  165. for key in path_parts:
  166. if key in cur_config:
  167. cur_config = cur_config[key]
  168. else:
  169. return None
  170. return cur_config
  171. T = TypeVar("T")
  172. class PersistentConfig(Generic[T]):
  173. def __init__(self, env_name: str, config_path: str, env_value: T):
  174. self.env_name = env_name
  175. self.config_path = config_path
  176. self.env_value = env_value
  177. self.config_value = get_config_value(config_path)
  178. if self.config_value is not None:
  179. log.info(f"'{env_name}' loaded from config.json")
  180. self.value = self.config_value
  181. else:
  182. self.value = env_value
  183. def __str__(self):
  184. return str(self.value)
  185. @property
  186. def __dict__(self):
  187. raise TypeError(
  188. "PersistentConfig object cannot be converted to dict, use config_get or .value instead."
  189. )
  190. def __getattribute__(self, item):
  191. if item == "__dict__":
  192. raise TypeError(
  193. "PersistentConfig object cannot be converted to dict, use config_get or .value instead."
  194. )
  195. return super().__getattribute__(item)
  196. def save(self):
  197. # Don't save if the value is the same as the env value and the config value
  198. if self.env_value == self.value:
  199. if self.config_value == self.value:
  200. return
  201. log.info(f"Saving '{self.env_name}' to config.json")
  202. path_parts = self.config_path.split(".")
  203. config = CONFIG_DATA
  204. for key in path_parts[:-1]:
  205. if key not in config:
  206. config[key] = {}
  207. config = config[key]
  208. config[path_parts[-1]] = self.value
  209. save_config()
  210. self.config_value = self.value
  211. class AppConfig:
  212. _state: dict[str, PersistentConfig]
  213. def __init__(self):
  214. super().__setattr__("_state", {})
  215. def __setattr__(self, key, value):
  216. if isinstance(value, PersistentConfig):
  217. self._state[key] = value
  218. else:
  219. self._state[key].value = value
  220. self._state[key].save()
  221. def __getattr__(self, key):
  222. return self._state[key].value
  223. ####################################
  224. # WEBUI_AUTH (Required for security)
  225. ####################################
  226. WEBUI_AUTH = os.environ.get("WEBUI_AUTH", "True").lower() == "true"
  227. WEBUI_AUTH_TRUSTED_EMAIL_HEADER = os.environ.get(
  228. "WEBUI_AUTH_TRUSTED_EMAIL_HEADER", None
  229. )
  230. WEBUI_AUTH_TRUSTED_NAME_HEADER = os.environ.get("WEBUI_AUTH_TRUSTED_NAME_HEADER", None)
  231. JWT_EXPIRES_IN = PersistentConfig(
  232. "JWT_EXPIRES_IN", "auth.jwt_expiry", os.environ.get("JWT_EXPIRES_IN", "-1")
  233. )
  234. ####################################
  235. # OAuth config
  236. ####################################
  237. ENABLE_OAUTH_SIGNUP = PersistentConfig(
  238. "ENABLE_OAUTH_SIGNUP",
  239. "oauth.enable_signup",
  240. os.environ.get("ENABLE_OAUTH_SIGNUP", "False").lower() == "true",
  241. )
  242. OAUTH_MERGE_ACCOUNTS_BY_EMAIL = PersistentConfig(
  243. "OAUTH_MERGE_ACCOUNTS_BY_EMAIL",
  244. "oauth.merge_accounts_by_email",
  245. os.environ.get("OAUTH_MERGE_ACCOUNTS_BY_EMAIL", "False").lower() == "true",
  246. )
  247. OAUTH_PROVIDERS = {}
  248. GOOGLE_CLIENT_ID = PersistentConfig(
  249. "GOOGLE_CLIENT_ID",
  250. "oauth.google.client_id",
  251. os.environ.get("GOOGLE_CLIENT_ID", ""),
  252. )
  253. GOOGLE_CLIENT_SECRET = PersistentConfig(
  254. "GOOGLE_CLIENT_SECRET",
  255. "oauth.google.client_secret",
  256. os.environ.get("GOOGLE_CLIENT_SECRET", ""),
  257. )
  258. GOOGLE_OAUTH_SCOPE = PersistentConfig(
  259. "GOOGLE_OAUTH_SCOPE",
  260. "oauth.google.scope",
  261. os.environ.get("GOOGLE_OAUTH_SCOPE", "openid email profile"),
  262. )
  263. GOOGLE_REDIRECT_URI = PersistentConfig(
  264. "GOOGLE_REDIRECT_URI",
  265. "oauth.google.redirect_uri",
  266. os.environ.get("GOOGLE_REDIRECT_URI", ""),
  267. )
  268. MICROSOFT_CLIENT_ID = PersistentConfig(
  269. "MICROSOFT_CLIENT_ID",
  270. "oauth.microsoft.client_id",
  271. os.environ.get("MICROSOFT_CLIENT_ID", ""),
  272. )
  273. MICROSOFT_CLIENT_SECRET = PersistentConfig(
  274. "MICROSOFT_CLIENT_SECRET",
  275. "oauth.microsoft.client_secret",
  276. os.environ.get("MICROSOFT_CLIENT_SECRET", ""),
  277. )
  278. MICROSOFT_CLIENT_TENANT_ID = PersistentConfig(
  279. "MICROSOFT_CLIENT_TENANT_ID",
  280. "oauth.microsoft.tenant_id",
  281. os.environ.get("MICROSOFT_CLIENT_TENANT_ID", ""),
  282. )
  283. MICROSOFT_OAUTH_SCOPE = PersistentConfig(
  284. "MICROSOFT_OAUTH_SCOPE",
  285. "oauth.microsoft.scope",
  286. os.environ.get("MICROSOFT_OAUTH_SCOPE", "openid email profile"),
  287. )
  288. MICROSOFT_REDIRECT_URI = PersistentConfig(
  289. "MICROSOFT_REDIRECT_URI",
  290. "oauth.microsoft.redirect_uri",
  291. os.environ.get("MICROSOFT_REDIRECT_URI", ""),
  292. )
  293. OAUTH_CLIENT_ID = PersistentConfig(
  294. "OAUTH_CLIENT_ID",
  295. "oauth.oidc.client_id",
  296. os.environ.get("OAUTH_CLIENT_ID", ""),
  297. )
  298. OAUTH_CLIENT_SECRET = PersistentConfig(
  299. "OAUTH_CLIENT_SECRET",
  300. "oauth.oidc.client_secret",
  301. os.environ.get("OAUTH_CLIENT_SECRET", ""),
  302. )
  303. OPENID_PROVIDER_URL = PersistentConfig(
  304. "OPENID_PROVIDER_URL",
  305. "oauth.oidc.provider_url",
  306. os.environ.get("OPENID_PROVIDER_URL", ""),
  307. )
  308. OPENID_REDIRECT_URI = PersistentConfig(
  309. "OPENID_REDIRECT_URI",
  310. "oauth.oidc.redirect_uri",
  311. os.environ.get("OPENID_REDIRECT_URI", ""),
  312. )
  313. OAUTH_SCOPES = PersistentConfig(
  314. "OAUTH_SCOPES",
  315. "oauth.oidc.scopes",
  316. os.environ.get("OAUTH_SCOPES", "openid email profile"),
  317. )
  318. OAUTH_PROVIDER_NAME = PersistentConfig(
  319. "OAUTH_PROVIDER_NAME",
  320. "oauth.oidc.provider_name",
  321. os.environ.get("OAUTH_PROVIDER_NAME", "SSO"),
  322. )
  323. OAUTH_USERNAME_CLAIM = PersistentConfig(
  324. "OAUTH_USERNAME_CLAIM",
  325. "oauth.oidc.username_claim",
  326. os.environ.get("OAUTH_USERNAME_CLAIM", "name"),
  327. )
  328. OAUTH_PICTURE_CLAIM = PersistentConfig(
  329. "OAUTH_USERNAME_CLAIM",
  330. "oauth.oidc.avatar_claim",
  331. os.environ.get("OAUTH_PICTURE_CLAIM", "picture"),
  332. )
  333. OAUTH_EMAIL_CLAIM = PersistentConfig(
  334. "OAUTH_EMAIL_CLAIM",
  335. "oauth.oidc.email_claim",
  336. os.environ.get("OAUTH_EMAIL_CLAIM", "email"),
  337. )
  338. def load_oauth_providers():
  339. OAUTH_PROVIDERS.clear()
  340. if GOOGLE_CLIENT_ID.value and GOOGLE_CLIENT_SECRET.value:
  341. OAUTH_PROVIDERS["google"] = {
  342. "client_id": GOOGLE_CLIENT_ID.value,
  343. "client_secret": GOOGLE_CLIENT_SECRET.value,
  344. "server_metadata_url": "https://accounts.google.com/.well-known/openid-configuration",
  345. "scope": GOOGLE_OAUTH_SCOPE.value,
  346. "redirect_uri": GOOGLE_REDIRECT_URI.value,
  347. }
  348. if (
  349. MICROSOFT_CLIENT_ID.value
  350. and MICROSOFT_CLIENT_SECRET.value
  351. and MICROSOFT_CLIENT_TENANT_ID.value
  352. ):
  353. OAUTH_PROVIDERS["microsoft"] = {
  354. "client_id": MICROSOFT_CLIENT_ID.value,
  355. "client_secret": MICROSOFT_CLIENT_SECRET.value,
  356. "server_metadata_url": f"https://login.microsoftonline.com/{MICROSOFT_CLIENT_TENANT_ID.value}/v2.0/.well-known/openid-configuration",
  357. "scope": MICROSOFT_OAUTH_SCOPE.value,
  358. "redirect_uri": MICROSOFT_REDIRECT_URI.value,
  359. }
  360. if (
  361. OAUTH_CLIENT_ID.value
  362. and OAUTH_CLIENT_SECRET.value
  363. and OPENID_PROVIDER_URL.value
  364. ):
  365. OAUTH_PROVIDERS["oidc"] = {
  366. "client_id": OAUTH_CLIENT_ID.value,
  367. "client_secret": OAUTH_CLIENT_SECRET.value,
  368. "server_metadata_url": OPENID_PROVIDER_URL.value,
  369. "scope": OAUTH_SCOPES.value,
  370. "name": OAUTH_PROVIDER_NAME.value,
  371. "redirect_uri": OPENID_REDIRECT_URI.value,
  372. }
  373. load_oauth_providers()
  374. ####################################
  375. # Static DIR
  376. ####################################
  377. STATIC_DIR = Path(os.getenv("STATIC_DIR", BACKEND_DIR / "static")).resolve()
  378. frontend_favicon = FRONTEND_BUILD_DIR / "static" / "favicon.png"
  379. if frontend_favicon.exists():
  380. try:
  381. shutil.copyfile(frontend_favicon, STATIC_DIR / "favicon.png")
  382. except Exception as e:
  383. logging.error(f"An error occurred: {e}")
  384. else:
  385. logging.warning(f"Frontend favicon not found at {frontend_favicon}")
  386. frontend_splash = FRONTEND_BUILD_DIR / "static" / "splash.png"
  387. if frontend_splash.exists():
  388. try:
  389. shutil.copyfile(frontend_splash, STATIC_DIR / "splash.png")
  390. except Exception as e:
  391. logging.error(f"An error occurred: {e}")
  392. else:
  393. logging.warning(f"Frontend splash not found at {frontend_splash}")
  394. ####################################
  395. # CUSTOM_NAME
  396. ####################################
  397. CUSTOM_NAME = os.environ.get("CUSTOM_NAME", "")
  398. if CUSTOM_NAME:
  399. try:
  400. r = requests.get(f"https://api.openwebui.com/api/v1/custom/{CUSTOM_NAME}")
  401. data = r.json()
  402. if r.ok:
  403. if "logo" in data:
  404. WEBUI_FAVICON_URL = url = (
  405. f"https://api.openwebui.com{data['logo']}"
  406. if data["logo"][0] == "/"
  407. else data["logo"]
  408. )
  409. r = requests.get(url, stream=True)
  410. if r.status_code == 200:
  411. with open(f"{STATIC_DIR}/favicon.png", "wb") as f:
  412. r.raw.decode_content = True
  413. shutil.copyfileobj(r.raw, f)
  414. if "splash" in data:
  415. url = (
  416. f"https://api.openwebui.com{data['splash']}"
  417. if data["splash"][0] == "/"
  418. else data["splash"]
  419. )
  420. r = requests.get(url, stream=True)
  421. if r.status_code == 200:
  422. with open(f"{STATIC_DIR}/splash.png", "wb") as f:
  423. r.raw.decode_content = True
  424. shutil.copyfileobj(r.raw, f)
  425. WEBUI_NAME = data["name"]
  426. except Exception as e:
  427. log.exception(e)
  428. pass
  429. ####################################
  430. # File Upload DIR
  431. ####################################
  432. UPLOAD_DIR = f"{DATA_DIR}/uploads"
  433. Path(UPLOAD_DIR).mkdir(parents=True, exist_ok=True)
  434. ####################################
  435. # Cache DIR
  436. ####################################
  437. CACHE_DIR = f"{DATA_DIR}/cache"
  438. Path(CACHE_DIR).mkdir(parents=True, exist_ok=True)
  439. ####################################
  440. # Docs DIR
  441. ####################################
  442. DOCS_DIR = os.getenv("DOCS_DIR", f"{DATA_DIR}/docs")
  443. Path(DOCS_DIR).mkdir(parents=True, exist_ok=True)
  444. ####################################
  445. # Tools DIR
  446. ####################################
  447. TOOLS_DIR = os.getenv("TOOLS_DIR", f"{DATA_DIR}/tools")
  448. Path(TOOLS_DIR).mkdir(parents=True, exist_ok=True)
  449. ####################################
  450. # Functions DIR
  451. ####################################
  452. FUNCTIONS_DIR = os.getenv("FUNCTIONS_DIR", f"{DATA_DIR}/functions")
  453. Path(FUNCTIONS_DIR).mkdir(parents=True, exist_ok=True)
  454. ####################################
  455. # LITELLM_CONFIG
  456. ####################################
  457. def create_config_file(file_path):
  458. directory = os.path.dirname(file_path)
  459. # Check if directory exists, if not, create it
  460. if not os.path.exists(directory):
  461. os.makedirs(directory)
  462. # Data to write into the YAML file
  463. config_data = {
  464. "general_settings": {},
  465. "litellm_settings": {},
  466. "model_list": [],
  467. "router_settings": {},
  468. }
  469. # Write data to YAML file
  470. with open(file_path, "w") as file:
  471. yaml.dump(config_data, file)
  472. LITELLM_CONFIG_PATH = f"{DATA_DIR}/litellm/config.yaml"
  473. # if not os.path.exists(LITELLM_CONFIG_PATH):
  474. # log.info("Config file doesn't exist. Creating...")
  475. # create_config_file(LITELLM_CONFIG_PATH)
  476. # log.info("Config file created successfully.")
  477. ####################################
  478. # OLLAMA_BASE_URL
  479. ####################################
  480. ENABLE_OLLAMA_API = PersistentConfig(
  481. "ENABLE_OLLAMA_API",
  482. "ollama.enable",
  483. os.environ.get("ENABLE_OLLAMA_API", "True").lower() == "true",
  484. )
  485. OLLAMA_API_BASE_URL = os.environ.get(
  486. "OLLAMA_API_BASE_URL", "http://localhost:11434/api"
  487. )
  488. OLLAMA_BASE_URL = os.environ.get("OLLAMA_BASE_URL", "")
  489. AIOHTTP_CLIENT_TIMEOUT = os.environ.get("AIOHTTP_CLIENT_TIMEOUT", "")
  490. if AIOHTTP_CLIENT_TIMEOUT == "":
  491. AIOHTTP_CLIENT_TIMEOUT = None
  492. else:
  493. try:
  494. AIOHTTP_CLIENT_TIMEOUT = int(AIOHTTP_CLIENT_TIMEOUT)
  495. except Exception:
  496. AIOHTTP_CLIENT_TIMEOUT = 300
  497. K8S_FLAG = os.environ.get("K8S_FLAG", "")
  498. USE_OLLAMA_DOCKER = os.environ.get("USE_OLLAMA_DOCKER", "false")
  499. if OLLAMA_BASE_URL == "" and OLLAMA_API_BASE_URL != "":
  500. OLLAMA_BASE_URL = (
  501. OLLAMA_API_BASE_URL[:-4]
  502. if OLLAMA_API_BASE_URL.endswith("/api")
  503. else OLLAMA_API_BASE_URL
  504. )
  505. if ENV == "prod":
  506. if OLLAMA_BASE_URL == "/ollama" and not K8S_FLAG:
  507. if USE_OLLAMA_DOCKER.lower() == "true":
  508. # if you use all-in-one docker container (Open WebUI + Ollama)
  509. # with the docker build arg USE_OLLAMA=true (--build-arg="USE_OLLAMA=true") this only works with http://localhost:11434
  510. OLLAMA_BASE_URL = "http://localhost:11434"
  511. else:
  512. OLLAMA_BASE_URL = "http://host.docker.internal:11434"
  513. elif K8S_FLAG:
  514. OLLAMA_BASE_URL = "http://ollama-service.open-webui.svc.cluster.local:11434"
  515. OLLAMA_BASE_URLS = os.environ.get("OLLAMA_BASE_URLS", "")
  516. OLLAMA_BASE_URLS = OLLAMA_BASE_URLS if OLLAMA_BASE_URLS != "" else OLLAMA_BASE_URL
  517. OLLAMA_BASE_URLS = [url.strip() for url in OLLAMA_BASE_URLS.split(";")]
  518. OLLAMA_BASE_URLS = PersistentConfig(
  519. "OLLAMA_BASE_URLS", "ollama.base_urls", OLLAMA_BASE_URLS
  520. )
  521. ####################################
  522. # OPENAI_API
  523. ####################################
  524. ENABLE_OPENAI_API = PersistentConfig(
  525. "ENABLE_OPENAI_API",
  526. "openai.enable",
  527. os.environ.get("ENABLE_OPENAI_API", "True").lower() == "true",
  528. )
  529. OPENAI_API_KEY = os.environ.get("OPENAI_API_KEY", "")
  530. OPENAI_API_BASE_URL = os.environ.get("OPENAI_API_BASE_URL", "")
  531. if OPENAI_API_BASE_URL == "":
  532. OPENAI_API_BASE_URL = "https://api.openai.com/v1"
  533. OPENAI_API_KEYS = os.environ.get("OPENAI_API_KEYS", "")
  534. OPENAI_API_KEYS = OPENAI_API_KEYS if OPENAI_API_KEYS != "" else OPENAI_API_KEY
  535. OPENAI_API_KEYS = [url.strip() for url in OPENAI_API_KEYS.split(";")]
  536. OPENAI_API_KEYS = PersistentConfig(
  537. "OPENAI_API_KEYS", "openai.api_keys", OPENAI_API_KEYS
  538. )
  539. OPENAI_API_BASE_URLS = os.environ.get("OPENAI_API_BASE_URLS", "")
  540. OPENAI_API_BASE_URLS = (
  541. OPENAI_API_BASE_URLS if OPENAI_API_BASE_URLS != "" else OPENAI_API_BASE_URL
  542. )
  543. OPENAI_API_BASE_URLS = [
  544. url.strip() if url != "" else "https://api.openai.com/v1"
  545. for url in OPENAI_API_BASE_URLS.split(";")
  546. ]
  547. OPENAI_API_BASE_URLS = PersistentConfig(
  548. "OPENAI_API_BASE_URLS", "openai.api_base_urls", OPENAI_API_BASE_URLS
  549. )
  550. OPENAI_API_KEY = ""
  551. try:
  552. OPENAI_API_KEY = OPENAI_API_KEYS.value[
  553. OPENAI_API_BASE_URLS.value.index("https://api.openai.com/v1")
  554. ]
  555. except Exception:
  556. pass
  557. OPENAI_API_BASE_URL = "https://api.openai.com/v1"
  558. ####################################
  559. # WEBUI
  560. ####################################
  561. ENABLE_SIGNUP = PersistentConfig(
  562. "ENABLE_SIGNUP",
  563. "ui.enable_signup",
  564. (
  565. False
  566. if not WEBUI_AUTH
  567. else os.environ.get("ENABLE_SIGNUP", "True").lower() == "true"
  568. ),
  569. )
  570. ENABLE_LOGIN_FORM = PersistentConfig(
  571. "ENABLE_LOGIN_FORM",
  572. "ui.ENABLE_LOGIN_FORM",
  573. os.environ.get("ENABLE_LOGIN_FORM", "True").lower() == "true",
  574. )
  575. DEFAULT_LOCALE = PersistentConfig(
  576. "DEFAULT_LOCALE",
  577. "ui.default_locale",
  578. os.environ.get("DEFAULT_LOCALE", ""),
  579. )
  580. DEFAULT_MODELS = PersistentConfig(
  581. "DEFAULT_MODELS", "ui.default_models", os.environ.get("DEFAULT_MODELS", None)
  582. )
  583. DEFAULT_PROMPT_SUGGESTIONS = PersistentConfig(
  584. "DEFAULT_PROMPT_SUGGESTIONS",
  585. "ui.prompt_suggestions",
  586. [
  587. {
  588. "title": ["Help me study", "vocabulary for a college entrance exam"],
  589. "content": "Help me study vocabulary: write a sentence for me to fill in the blank, and I'll try to pick the correct option.",
  590. },
  591. {
  592. "title": ["Give me ideas", "for what to do with my kids' art"],
  593. "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.",
  594. },
  595. {
  596. "title": ["Tell me a fun fact", "about the Roman Empire"],
  597. "content": "Tell me a random fun fact about the Roman Empire",
  598. },
  599. {
  600. "title": ["Show me a code snippet", "of a website's sticky header"],
  601. "content": "Show me a code snippet of a website's sticky header in CSS and JavaScript.",
  602. },
  603. {
  604. "title": [
  605. "Explain options trading",
  606. "if I'm familiar with buying and selling stocks",
  607. ],
  608. "content": "Explain options trading in simple terms if I'm familiar with buying and selling stocks.",
  609. },
  610. {
  611. "title": ["Overcome procrastination", "give me tips"],
  612. "content": "Could you start by asking me about instances when I procrastinate the most and then give me some suggestions to overcome it?",
  613. },
  614. ],
  615. )
  616. DEFAULT_USER_ROLE = PersistentConfig(
  617. "DEFAULT_USER_ROLE",
  618. "ui.default_user_role",
  619. os.getenv("DEFAULT_USER_ROLE", "pending"),
  620. )
  621. USER_PERMISSIONS_CHAT_DELETION = (
  622. os.environ.get("USER_PERMISSIONS_CHAT_DELETION", "True").lower() == "true"
  623. )
  624. USER_PERMISSIONS = PersistentConfig(
  625. "USER_PERMISSIONS",
  626. "ui.user_permissions",
  627. {"chat": {"deletion": USER_PERMISSIONS_CHAT_DELETION}},
  628. )
  629. ENABLE_MODEL_FILTER = PersistentConfig(
  630. "ENABLE_MODEL_FILTER",
  631. "model_filter.enable",
  632. os.environ.get("ENABLE_MODEL_FILTER", "False").lower() == "true",
  633. )
  634. MODEL_FILTER_LIST = os.environ.get("MODEL_FILTER_LIST", "")
  635. MODEL_FILTER_LIST = PersistentConfig(
  636. "MODEL_FILTER_LIST",
  637. "model_filter.list",
  638. [model.strip() for model in MODEL_FILTER_LIST.split(";")],
  639. )
  640. WEBHOOK_URL = PersistentConfig(
  641. "WEBHOOK_URL", "webhook_url", os.environ.get("WEBHOOK_URL", "")
  642. )
  643. ENABLE_ADMIN_EXPORT = os.environ.get("ENABLE_ADMIN_EXPORT", "True").lower() == "true"
  644. ENABLE_ADMIN_CHAT_ACCESS = (
  645. os.environ.get("ENABLE_ADMIN_CHAT_ACCESS", "True").lower() == "true"
  646. )
  647. ENABLE_COMMUNITY_SHARING = PersistentConfig(
  648. "ENABLE_COMMUNITY_SHARING",
  649. "ui.enable_community_sharing",
  650. os.environ.get("ENABLE_COMMUNITY_SHARING", "True").lower() == "true",
  651. )
  652. class BannerModel(BaseModel):
  653. id: str
  654. type: str
  655. title: Optional[str] = None
  656. content: str
  657. dismissible: bool
  658. timestamp: int
  659. try:
  660. banners = json.loads(os.environ.get("WEBUI_BANNERS", "[]"))
  661. banners = [BannerModel(**banner) for banner in banners]
  662. except Exception as e:
  663. print(f"Error loading WEBUI_BANNERS: {e}")
  664. banners = []
  665. WEBUI_BANNERS = PersistentConfig("WEBUI_BANNERS", "ui.banners", banners)
  666. SHOW_ADMIN_DETAILS = PersistentConfig(
  667. "SHOW_ADMIN_DETAILS",
  668. "auth.admin.show",
  669. os.environ.get("SHOW_ADMIN_DETAILS", "true").lower() == "true",
  670. )
  671. ADMIN_EMAIL = PersistentConfig(
  672. "ADMIN_EMAIL",
  673. "auth.admin.email",
  674. os.environ.get("ADMIN_EMAIL", None),
  675. )
  676. ####################################
  677. # TASKS
  678. ####################################
  679. TASK_MODEL = PersistentConfig(
  680. "TASK_MODEL",
  681. "task.model.default",
  682. os.environ.get("TASK_MODEL", ""),
  683. )
  684. TASK_MODEL_EXTERNAL = PersistentConfig(
  685. "TASK_MODEL_EXTERNAL",
  686. "task.model.external",
  687. os.environ.get("TASK_MODEL_EXTERNAL", ""),
  688. )
  689. TITLE_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  690. "TITLE_GENERATION_PROMPT_TEMPLATE",
  691. "task.title.prompt_template",
  692. os.environ.get(
  693. "TITLE_GENERATION_PROMPT_TEMPLATE",
  694. """Here is the query:
  695. {{prompt:middletruncate:8000}}
  696. Create a concise, 3-5 word phrase with an emoji as a title for the previous query. Suitable Emojis for the summary can be used to enhance understanding but avoid quotation marks or special formatting. RESPOND ONLY WITH THE TITLE TEXT.
  697. Examples of titles:
  698. 📉 Stock Market Trends
  699. 🍪 Perfect Chocolate Chip Recipe
  700. Evolution of Music Streaming
  701. Remote Work Productivity Tips
  702. Artificial Intelligence in Healthcare
  703. 🎮 Video Game Development Insights""",
  704. ),
  705. )
  706. SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  707. "SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE",
  708. "task.search.prompt_template",
  709. os.environ.get(
  710. "SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE",
  711. """You are tasked with generating web search queries. Give me an appropriate query to answer my question for google search. Answer with only the query. Today is {{CURRENT_DATE}}.
  712. Question:
  713. {{prompt:end:4000}}""",
  714. ),
  715. )
  716. SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD = PersistentConfig(
  717. "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD",
  718. "task.search.prompt_length_threshold",
  719. int(
  720. os.environ.get(
  721. "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD",
  722. 100,
  723. )
  724. ),
  725. )
  726. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = PersistentConfig(
  727. "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE",
  728. "task.tools.prompt_template",
  729. os.environ.get(
  730. "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE",
  731. """Available Tools: {{TOOLS}}\nReturn an empty string if no tools match the query. If a function tool matches, construct and return a JSON object in the format {\"name\": \"functionName\", \"parameters\": {\"requiredFunctionParamKey\": \"requiredFunctionParamValue\"}} using the appropriate tool and its parameters. Only return the object and limit the response to the JSON object without additional text.""",
  732. ),
  733. )
  734. ####################################
  735. # WEBUI_SECRET_KEY
  736. ####################################
  737. WEBUI_SECRET_KEY = os.environ.get(
  738. "WEBUI_SECRET_KEY",
  739. os.environ.get(
  740. "WEBUI_JWT_SECRET_KEY", "t0p-s3cr3t"
  741. ), # DEPRECATED: remove at next major version
  742. )
  743. WEBUI_SESSION_COOKIE_SAME_SITE = os.environ.get(
  744. "WEBUI_SESSION_COOKIE_SAME_SITE",
  745. os.environ.get("WEBUI_SESSION_COOKIE_SAME_SITE", "lax"),
  746. )
  747. WEBUI_SESSION_COOKIE_SECURE = os.environ.get(
  748. "WEBUI_SESSION_COOKIE_SECURE",
  749. os.environ.get("WEBUI_SESSION_COOKIE_SECURE", "false").lower() == "true",
  750. )
  751. if WEBUI_AUTH and WEBUI_SECRET_KEY == "":
  752. raise ValueError(ERROR_MESSAGES.ENV_VAR_NOT_FOUND)
  753. ####################################
  754. # RAG document content extraction
  755. ####################################
  756. CONTENT_EXTRACTION_ENGINE = PersistentConfig(
  757. "CONTENT_EXTRACTION_ENGINE",
  758. "rag.CONTENT_EXTRACTION_ENGINE",
  759. os.environ.get("CONTENT_EXTRACTION_ENGINE", "").lower(),
  760. )
  761. TIKA_SERVER_URL = PersistentConfig(
  762. "TIKA_SERVER_URL",
  763. "rag.tika_server_url",
  764. os.getenv("TIKA_SERVER_URL", "http://tika:9998"), # Default for sidecar deployment
  765. )
  766. ####################################
  767. # RAG
  768. ####################################
  769. CHROMA_DATA_PATH = f"{DATA_DIR}/vector_db"
  770. CHROMA_TENANT = os.environ.get("CHROMA_TENANT", chromadb.DEFAULT_TENANT)
  771. CHROMA_DATABASE = os.environ.get("CHROMA_DATABASE", chromadb.DEFAULT_DATABASE)
  772. CHROMA_HTTP_HOST = os.environ.get("CHROMA_HTTP_HOST", "")
  773. CHROMA_HTTP_PORT = int(os.environ.get("CHROMA_HTTP_PORT", "8000"))
  774. # Comma-separated list of header=value pairs
  775. CHROMA_HTTP_HEADERS = os.environ.get("CHROMA_HTTP_HEADERS", "")
  776. if CHROMA_HTTP_HEADERS:
  777. CHROMA_HTTP_HEADERS = dict(
  778. [pair.split("=") for pair in CHROMA_HTTP_HEADERS.split(",")]
  779. )
  780. else:
  781. CHROMA_HTTP_HEADERS = None
  782. CHROMA_HTTP_SSL = os.environ.get("CHROMA_HTTP_SSL", "false").lower() == "true"
  783. # 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)
  784. RAG_TOP_K = PersistentConfig(
  785. "RAG_TOP_K", "rag.top_k", int(os.environ.get("RAG_TOP_K", "5"))
  786. )
  787. RAG_RELEVANCE_THRESHOLD = PersistentConfig(
  788. "RAG_RELEVANCE_THRESHOLD",
  789. "rag.relevance_threshold",
  790. float(os.environ.get("RAG_RELEVANCE_THRESHOLD", "0.0")),
  791. )
  792. ENABLE_RAG_HYBRID_SEARCH = PersistentConfig(
  793. "ENABLE_RAG_HYBRID_SEARCH",
  794. "rag.enable_hybrid_search",
  795. os.environ.get("ENABLE_RAG_HYBRID_SEARCH", "").lower() == "true",
  796. )
  797. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = PersistentConfig(
  798. "ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION",
  799. "rag.enable_web_loader_ssl_verification",
  800. os.environ.get("ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION", "True").lower() == "true",
  801. )
  802. RAG_EMBEDDING_ENGINE = PersistentConfig(
  803. "RAG_EMBEDDING_ENGINE",
  804. "rag.embedding_engine",
  805. os.environ.get("RAG_EMBEDDING_ENGINE", ""),
  806. )
  807. PDF_EXTRACT_IMAGES = PersistentConfig(
  808. "PDF_EXTRACT_IMAGES",
  809. "rag.pdf_extract_images",
  810. os.environ.get("PDF_EXTRACT_IMAGES", "False").lower() == "true",
  811. )
  812. RAG_EMBEDDING_MODEL = PersistentConfig(
  813. "RAG_EMBEDDING_MODEL",
  814. "rag.embedding_model",
  815. os.environ.get("RAG_EMBEDDING_MODEL", "sentence-transformers/all-MiniLM-L6-v2"),
  816. )
  817. log.info(f"Embedding model set: {RAG_EMBEDDING_MODEL.value}")
  818. RAG_EMBEDDING_MODEL_AUTO_UPDATE = (
  819. os.environ.get("RAG_EMBEDDING_MODEL_AUTO_UPDATE", "").lower() == "true"
  820. )
  821. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE = (
  822. os.environ.get("RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE", "").lower() == "true"
  823. )
  824. RAG_EMBEDDING_OPENAI_BATCH_SIZE = PersistentConfig(
  825. "RAG_EMBEDDING_OPENAI_BATCH_SIZE",
  826. "rag.embedding_openai_batch_size",
  827. int(os.environ.get("RAG_EMBEDDING_OPENAI_BATCH_SIZE", "1")),
  828. )
  829. RAG_RERANKING_MODEL = PersistentConfig(
  830. "RAG_RERANKING_MODEL",
  831. "rag.reranking_model",
  832. os.environ.get("RAG_RERANKING_MODEL", ""),
  833. )
  834. if RAG_RERANKING_MODEL.value != "":
  835. log.info(f"Reranking model set: {RAG_RERANKING_MODEL.value}")
  836. RAG_RERANKING_MODEL_AUTO_UPDATE = (
  837. os.environ.get("RAG_RERANKING_MODEL_AUTO_UPDATE", "").lower() == "true"
  838. )
  839. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE = (
  840. os.environ.get("RAG_RERANKING_MODEL_TRUST_REMOTE_CODE", "").lower() == "true"
  841. )
  842. if CHROMA_HTTP_HOST != "":
  843. CHROMA_CLIENT = chromadb.HttpClient(
  844. host=CHROMA_HTTP_HOST,
  845. port=CHROMA_HTTP_PORT,
  846. headers=CHROMA_HTTP_HEADERS,
  847. ssl=CHROMA_HTTP_SSL,
  848. tenant=CHROMA_TENANT,
  849. database=CHROMA_DATABASE,
  850. settings=Settings(allow_reset=True, anonymized_telemetry=False),
  851. )
  852. else:
  853. CHROMA_CLIENT = chromadb.PersistentClient(
  854. path=CHROMA_DATA_PATH,
  855. settings=Settings(allow_reset=True, anonymized_telemetry=False),
  856. tenant=CHROMA_TENANT,
  857. database=CHROMA_DATABASE,
  858. )
  859. # device type embedding models - "cpu" (default), "cuda" (nvidia gpu required) or "mps" (apple silicon) - choosing this right can lead to better performance
  860. USE_CUDA = os.environ.get("USE_CUDA_DOCKER", "false")
  861. if USE_CUDA.lower() == "true":
  862. DEVICE_TYPE = "cuda"
  863. else:
  864. DEVICE_TYPE = "cpu"
  865. CHUNK_SIZE = PersistentConfig(
  866. "CHUNK_SIZE", "rag.chunk_size", int(os.environ.get("CHUNK_SIZE", "1500"))
  867. )
  868. CHUNK_OVERLAP = PersistentConfig(
  869. "CHUNK_OVERLAP",
  870. "rag.chunk_overlap",
  871. int(os.environ.get("CHUNK_OVERLAP", "100")),
  872. )
  873. DEFAULT_RAG_TEMPLATE = """Use the following context as your learned knowledge, inside <context></context> XML tags.
  874. <context>
  875. [context]
  876. </context>
  877. When answer to user:
  878. - If you don't know, just say that you don't know.
  879. - If you don't know when you are not sure, ask for clarification.
  880. Avoid mentioning that you obtained the information from the context.
  881. And answer according to the language of the user's question.
  882. Given the context information, answer the query.
  883. Query: [query]"""
  884. RAG_TEMPLATE = PersistentConfig(
  885. "RAG_TEMPLATE",
  886. "rag.template",
  887. os.environ.get("RAG_TEMPLATE", DEFAULT_RAG_TEMPLATE),
  888. )
  889. RAG_OPENAI_API_BASE_URL = PersistentConfig(
  890. "RAG_OPENAI_API_BASE_URL",
  891. "rag.openai_api_base_url",
  892. os.getenv("RAG_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  893. )
  894. RAG_OPENAI_API_KEY = PersistentConfig(
  895. "RAG_OPENAI_API_KEY",
  896. "rag.openai_api_key",
  897. os.getenv("RAG_OPENAI_API_KEY", OPENAI_API_KEY),
  898. )
  899. ENABLE_RAG_LOCAL_WEB_FETCH = (
  900. os.getenv("ENABLE_RAG_LOCAL_WEB_FETCH", "False").lower() == "true"
  901. )
  902. YOUTUBE_LOADER_LANGUAGE = PersistentConfig(
  903. "YOUTUBE_LOADER_LANGUAGE",
  904. "rag.youtube_loader_language",
  905. os.getenv("YOUTUBE_LOADER_LANGUAGE", "en").split(","),
  906. )
  907. ENABLE_RAG_WEB_SEARCH = PersistentConfig(
  908. "ENABLE_RAG_WEB_SEARCH",
  909. "rag.web.search.enable",
  910. os.getenv("ENABLE_RAG_WEB_SEARCH", "False").lower() == "true",
  911. )
  912. RAG_WEB_SEARCH_ENGINE = PersistentConfig(
  913. "RAG_WEB_SEARCH_ENGINE",
  914. "rag.web.search.engine",
  915. os.getenv("RAG_WEB_SEARCH_ENGINE", ""),
  916. )
  917. # You can provide a list of your own websites to filter after performing a web search.
  918. # This ensures the highest level of safety and reliability of the information sources.
  919. RAG_WEB_SEARCH_DOMAIN_FILTER_LIST = PersistentConfig(
  920. "RAG_WEB_SEARCH_DOMAIN_FILTER_LIST",
  921. "rag.rag.web.search.domain.filter_list",
  922. [
  923. # "wikipedia.com",
  924. # "wikimedia.org",
  925. # "wikidata.org",
  926. ],
  927. )
  928. SEARXNG_QUERY_URL = PersistentConfig(
  929. "SEARXNG_QUERY_URL",
  930. "rag.web.search.searxng_query_url",
  931. os.getenv("SEARXNG_QUERY_URL", ""),
  932. )
  933. GOOGLE_PSE_API_KEY = PersistentConfig(
  934. "GOOGLE_PSE_API_KEY",
  935. "rag.web.search.google_pse_api_key",
  936. os.getenv("GOOGLE_PSE_API_KEY", ""),
  937. )
  938. GOOGLE_PSE_ENGINE_ID = PersistentConfig(
  939. "GOOGLE_PSE_ENGINE_ID",
  940. "rag.web.search.google_pse_engine_id",
  941. os.getenv("GOOGLE_PSE_ENGINE_ID", ""),
  942. )
  943. BRAVE_SEARCH_API_KEY = PersistentConfig(
  944. "BRAVE_SEARCH_API_KEY",
  945. "rag.web.search.brave_search_api_key",
  946. os.getenv("BRAVE_SEARCH_API_KEY", ""),
  947. )
  948. SERPSTACK_API_KEY = PersistentConfig(
  949. "SERPSTACK_API_KEY",
  950. "rag.web.search.serpstack_api_key",
  951. os.getenv("SERPSTACK_API_KEY", ""),
  952. )
  953. SERPSTACK_HTTPS = PersistentConfig(
  954. "SERPSTACK_HTTPS",
  955. "rag.web.search.serpstack_https",
  956. os.getenv("SERPSTACK_HTTPS", "True").lower() == "true",
  957. )
  958. SERPER_API_KEY = PersistentConfig(
  959. "SERPER_API_KEY",
  960. "rag.web.search.serper_api_key",
  961. os.getenv("SERPER_API_KEY", ""),
  962. )
  963. SERPLY_API_KEY = PersistentConfig(
  964. "SERPLY_API_KEY",
  965. "rag.web.search.serply_api_key",
  966. os.getenv("SERPLY_API_KEY", ""),
  967. )
  968. TAVILY_API_KEY = PersistentConfig(
  969. "TAVILY_API_KEY",
  970. "rag.web.search.tavily_api_key",
  971. os.getenv("TAVILY_API_KEY", ""),
  972. )
  973. RAG_WEB_SEARCH_RESULT_COUNT = PersistentConfig(
  974. "RAG_WEB_SEARCH_RESULT_COUNT",
  975. "rag.web.search.result_count",
  976. int(os.getenv("RAG_WEB_SEARCH_RESULT_COUNT", "3")),
  977. )
  978. RAG_WEB_SEARCH_CONCURRENT_REQUESTS = PersistentConfig(
  979. "RAG_WEB_SEARCH_CONCURRENT_REQUESTS",
  980. "rag.web.search.concurrent_requests",
  981. int(os.getenv("RAG_WEB_SEARCH_CONCURRENT_REQUESTS", "10")),
  982. )
  983. ####################################
  984. # Transcribe
  985. ####################################
  986. WHISPER_MODEL = os.getenv("WHISPER_MODEL", "base")
  987. WHISPER_MODEL_DIR = os.getenv("WHISPER_MODEL_DIR", f"{CACHE_DIR}/whisper/models")
  988. WHISPER_MODEL_AUTO_UPDATE = (
  989. os.environ.get("WHISPER_MODEL_AUTO_UPDATE", "").lower() == "true"
  990. )
  991. ####################################
  992. # Images
  993. ####################################
  994. IMAGE_GENERATION_ENGINE = PersistentConfig(
  995. "IMAGE_GENERATION_ENGINE",
  996. "image_generation.engine",
  997. os.getenv("IMAGE_GENERATION_ENGINE", ""),
  998. )
  999. ENABLE_IMAGE_GENERATION = PersistentConfig(
  1000. "ENABLE_IMAGE_GENERATION",
  1001. "image_generation.enable",
  1002. os.environ.get("ENABLE_IMAGE_GENERATION", "").lower() == "true",
  1003. )
  1004. AUTOMATIC1111_BASE_URL = PersistentConfig(
  1005. "AUTOMATIC1111_BASE_URL",
  1006. "image_generation.automatic1111.base_url",
  1007. os.getenv("AUTOMATIC1111_BASE_URL", ""),
  1008. )
  1009. AUTOMATIC1111_API_AUTH = PersistentConfig(
  1010. "AUTOMATIC1111_API_AUTH",
  1011. "image_generation.automatic1111.api_auth",
  1012. os.getenv("AUTOMATIC1111_API_AUTH", ""),
  1013. )
  1014. COMFYUI_BASE_URL = PersistentConfig(
  1015. "COMFYUI_BASE_URL",
  1016. "image_generation.comfyui.base_url",
  1017. os.getenv("COMFYUI_BASE_URL", ""),
  1018. )
  1019. COMFYUI_CFG_SCALE = PersistentConfig(
  1020. "COMFYUI_CFG_SCALE",
  1021. "image_generation.comfyui.cfg_scale",
  1022. os.getenv("COMFYUI_CFG_SCALE", ""),
  1023. )
  1024. COMFYUI_SAMPLER = PersistentConfig(
  1025. "COMFYUI_SAMPLER",
  1026. "image_generation.comfyui.sampler",
  1027. os.getenv("COMFYUI_SAMPLER", ""),
  1028. )
  1029. COMFYUI_SCHEDULER = PersistentConfig(
  1030. "COMFYUI_SCHEDULER",
  1031. "image_generation.comfyui.scheduler",
  1032. os.getenv("COMFYUI_SCHEDULER", ""),
  1033. )
  1034. COMFYUI_SD3 = PersistentConfig(
  1035. "COMFYUI_SD3",
  1036. "image_generation.comfyui.sd3",
  1037. os.environ.get("COMFYUI_SD3", "").lower() == "true",
  1038. )
  1039. COMFYUI_FLUX = PersistentConfig(
  1040. "COMFYUI_FLUX",
  1041. "image_generation.comfyui.flux",
  1042. os.environ.get("COMFYUI_FLUX", "").lower() == "true",
  1043. )
  1044. COMFYUI_FLUX_WEIGHT_DTYPE = PersistentConfig(
  1045. "COMFYUI_FLUX_WEIGHT_DTYPE",
  1046. "image_generation.comfyui.flux_weight_dtype",
  1047. os.getenv("COMFYUI_FLUX_WEIGHT_DTYPE", ""),
  1048. )
  1049. COMFYUI_FLUX_FP8_CLIP = PersistentConfig(
  1050. "COMFYUI_FLUX_FP8_CLIP",
  1051. "image_generation.comfyui.flux_fp8_clip",
  1052. os.environ.get("COMFYUI_FLUX_FP8_CLIP", "").lower() == "true",
  1053. )
  1054. IMAGES_OPENAI_API_BASE_URL = PersistentConfig(
  1055. "IMAGES_OPENAI_API_BASE_URL",
  1056. "image_generation.openai.api_base_url",
  1057. os.getenv("IMAGES_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1058. )
  1059. IMAGES_OPENAI_API_KEY = PersistentConfig(
  1060. "IMAGES_OPENAI_API_KEY",
  1061. "image_generation.openai.api_key",
  1062. os.getenv("IMAGES_OPENAI_API_KEY", OPENAI_API_KEY),
  1063. )
  1064. IMAGE_SIZE = PersistentConfig(
  1065. "IMAGE_SIZE", "image_generation.size", os.getenv("IMAGE_SIZE", "512x512")
  1066. )
  1067. IMAGE_STEPS = PersistentConfig(
  1068. "IMAGE_STEPS", "image_generation.steps", int(os.getenv("IMAGE_STEPS", 50))
  1069. )
  1070. IMAGE_GENERATION_MODEL = PersistentConfig(
  1071. "IMAGE_GENERATION_MODEL",
  1072. "image_generation.model",
  1073. os.getenv("IMAGE_GENERATION_MODEL", ""),
  1074. )
  1075. ####################################
  1076. # Audio
  1077. ####################################
  1078. AUDIO_STT_OPENAI_API_BASE_URL = PersistentConfig(
  1079. "AUDIO_STT_OPENAI_API_BASE_URL",
  1080. "audio.stt.openai.api_base_url",
  1081. os.getenv("AUDIO_STT_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1082. )
  1083. AUDIO_STT_OPENAI_API_KEY = PersistentConfig(
  1084. "AUDIO_STT_OPENAI_API_KEY",
  1085. "audio.stt.openai.api_key",
  1086. os.getenv("AUDIO_STT_OPENAI_API_KEY", OPENAI_API_KEY),
  1087. )
  1088. AUDIO_STT_ENGINE = PersistentConfig(
  1089. "AUDIO_STT_ENGINE",
  1090. "audio.stt.engine",
  1091. os.getenv("AUDIO_STT_ENGINE", ""),
  1092. )
  1093. AUDIO_STT_MODEL = PersistentConfig(
  1094. "AUDIO_STT_MODEL",
  1095. "audio.stt.model",
  1096. os.getenv("AUDIO_STT_MODEL", "whisper-1"),
  1097. )
  1098. AUDIO_TTS_OPENAI_API_BASE_URL = PersistentConfig(
  1099. "AUDIO_TTS_OPENAI_API_BASE_URL",
  1100. "audio.tts.openai.api_base_url",
  1101. os.getenv("AUDIO_TTS_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1102. )
  1103. AUDIO_TTS_OPENAI_API_KEY = PersistentConfig(
  1104. "AUDIO_TTS_OPENAI_API_KEY",
  1105. "audio.tts.openai.api_key",
  1106. os.getenv("AUDIO_TTS_OPENAI_API_KEY", OPENAI_API_KEY),
  1107. )
  1108. AUDIO_TTS_API_KEY = PersistentConfig(
  1109. "AUDIO_TTS_API_KEY",
  1110. "audio.tts.api_key",
  1111. os.getenv("AUDIO_TTS_API_KEY", ""),
  1112. )
  1113. AUDIO_TTS_ENGINE = PersistentConfig(
  1114. "AUDIO_TTS_ENGINE",
  1115. "audio.tts.engine",
  1116. os.getenv("AUDIO_TTS_ENGINE", ""),
  1117. )
  1118. AUDIO_TTS_MODEL = PersistentConfig(
  1119. "AUDIO_TTS_MODEL",
  1120. "audio.tts.model",
  1121. os.getenv("AUDIO_TTS_MODEL", "tts-1"), # OpenAI default model
  1122. )
  1123. AUDIO_TTS_VOICE = PersistentConfig(
  1124. "AUDIO_TTS_VOICE",
  1125. "audio.tts.voice",
  1126. os.getenv("AUDIO_TTS_VOICE", "alloy"), # OpenAI default voice
  1127. )
  1128. ####################################
  1129. # Database
  1130. ####################################
  1131. DATABASE_URL = os.environ.get("DATABASE_URL", f"sqlite:///{DATA_DIR}/webui.db")
  1132. # Replace the postgres:// with postgresql://
  1133. if "postgres://" in DATABASE_URL:
  1134. DATABASE_URL = DATABASE_URL.replace("postgres://", "postgresql://")