config.py 42 KB

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