config.py 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425
  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:
  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:
  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:
  148. pass
  149. try:
  150. CONFIG_DATA = json.loads((DATA_DIR / "config.json").read_text())
  151. except:
  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. def load_oauth_providers():
  334. OAUTH_PROVIDERS.clear()
  335. if GOOGLE_CLIENT_ID.value and GOOGLE_CLIENT_SECRET.value:
  336. OAUTH_PROVIDERS["google"] = {
  337. "client_id": GOOGLE_CLIENT_ID.value,
  338. "client_secret": GOOGLE_CLIENT_SECRET.value,
  339. "server_metadata_url": "https://accounts.google.com/.well-known/openid-configuration",
  340. "scope": GOOGLE_OAUTH_SCOPE.value,
  341. "redirect_uri": GOOGLE_REDIRECT_URI.value,
  342. }
  343. if (
  344. MICROSOFT_CLIENT_ID.value
  345. and MICROSOFT_CLIENT_SECRET.value
  346. and MICROSOFT_CLIENT_TENANT_ID.value
  347. ):
  348. OAUTH_PROVIDERS["microsoft"] = {
  349. "client_id": MICROSOFT_CLIENT_ID.value,
  350. "client_secret": MICROSOFT_CLIENT_SECRET.value,
  351. "server_metadata_url": f"https://login.microsoftonline.com/{MICROSOFT_CLIENT_TENANT_ID.value}/v2.0/.well-known/openid-configuration",
  352. "scope": MICROSOFT_OAUTH_SCOPE.value,
  353. "redirect_uri": MICROSOFT_REDIRECT_URI.value,
  354. }
  355. if (
  356. OAUTH_CLIENT_ID.value
  357. and OAUTH_CLIENT_SECRET.value
  358. and OPENID_PROVIDER_URL.value
  359. ):
  360. OAUTH_PROVIDERS["oidc"] = {
  361. "client_id": OAUTH_CLIENT_ID.value,
  362. "client_secret": OAUTH_CLIENT_SECRET.value,
  363. "server_metadata_url": OPENID_PROVIDER_URL.value,
  364. "scope": OAUTH_SCOPES.value,
  365. "name": OAUTH_PROVIDER_NAME.value,
  366. "redirect_uri": OPENID_REDIRECT_URI.value,
  367. }
  368. load_oauth_providers()
  369. ####################################
  370. # Static DIR
  371. ####################################
  372. STATIC_DIR = Path(os.getenv("STATIC_DIR", BACKEND_DIR / "static")).resolve()
  373. frontend_favicon = FRONTEND_BUILD_DIR / "static" / "favicon.png"
  374. if frontend_favicon.exists():
  375. try:
  376. shutil.copyfile(frontend_favicon, STATIC_DIR / "favicon.png")
  377. except Exception as e:
  378. logging.error(f"An error occurred: {e}")
  379. else:
  380. logging.warning(f"Frontend favicon not found at {frontend_favicon}")
  381. frontend_splash = FRONTEND_BUILD_DIR / "static" / "splash.png"
  382. if frontend_splash.exists():
  383. try:
  384. shutil.copyfile(frontend_splash, STATIC_DIR / "splash.png")
  385. except Exception as e:
  386. logging.error(f"An error occurred: {e}")
  387. else:
  388. logging.warning(f"Frontend splash not found at {frontend_splash}")
  389. ####################################
  390. # CUSTOM_NAME
  391. ####################################
  392. CUSTOM_NAME = os.environ.get("CUSTOM_NAME", "")
  393. if CUSTOM_NAME:
  394. try:
  395. r = requests.get(f"https://api.openwebui.com/api/v1/custom/{CUSTOM_NAME}")
  396. data = r.json()
  397. if r.ok:
  398. if "logo" in data:
  399. WEBUI_FAVICON_URL = url = (
  400. f"https://api.openwebui.com{data['logo']}"
  401. if data["logo"][0] == "/"
  402. else data["logo"]
  403. )
  404. r = requests.get(url, stream=True)
  405. if r.status_code == 200:
  406. with open(f"{STATIC_DIR}/favicon.png", "wb") as f:
  407. r.raw.decode_content = True
  408. shutil.copyfileobj(r.raw, f)
  409. if "splash" in data:
  410. url = (
  411. f"https://api.openwebui.com{data['splash']}"
  412. if data["splash"][0] == "/"
  413. else data["splash"]
  414. )
  415. r = requests.get(url, stream=True)
  416. if r.status_code == 200:
  417. with open(f"{STATIC_DIR}/splash.png", "wb") as f:
  418. r.raw.decode_content = True
  419. shutil.copyfileobj(r.raw, f)
  420. WEBUI_NAME = data["name"]
  421. except Exception as e:
  422. log.exception(e)
  423. pass
  424. ####################################
  425. # File Upload DIR
  426. ####################################
  427. UPLOAD_DIR = f"{DATA_DIR}/uploads"
  428. Path(UPLOAD_DIR).mkdir(parents=True, exist_ok=True)
  429. ####################################
  430. # Cache DIR
  431. ####################################
  432. CACHE_DIR = f"{DATA_DIR}/cache"
  433. Path(CACHE_DIR).mkdir(parents=True, exist_ok=True)
  434. ####################################
  435. # Docs DIR
  436. ####################################
  437. DOCS_DIR = os.getenv("DOCS_DIR", f"{DATA_DIR}/docs")
  438. Path(DOCS_DIR).mkdir(parents=True, exist_ok=True)
  439. ####################################
  440. # Tools DIR
  441. ####################################
  442. TOOLS_DIR = os.getenv("TOOLS_DIR", f"{DATA_DIR}/tools")
  443. Path(TOOLS_DIR).mkdir(parents=True, exist_ok=True)
  444. ####################################
  445. # Functions DIR
  446. ####################################
  447. FUNCTIONS_DIR = os.getenv("FUNCTIONS_DIR", f"{DATA_DIR}/functions")
  448. Path(FUNCTIONS_DIR).mkdir(parents=True, exist_ok=True)
  449. ####################################
  450. # LITELLM_CONFIG
  451. ####################################
  452. def create_config_file(file_path):
  453. directory = os.path.dirname(file_path)
  454. # Check if directory exists, if not, create it
  455. if not os.path.exists(directory):
  456. os.makedirs(directory)
  457. # Data to write into the YAML file
  458. config_data = {
  459. "general_settings": {},
  460. "litellm_settings": {},
  461. "model_list": [],
  462. "router_settings": {},
  463. }
  464. # Write data to YAML file
  465. with open(file_path, "w") as file:
  466. yaml.dump(config_data, file)
  467. LITELLM_CONFIG_PATH = f"{DATA_DIR}/litellm/config.yaml"
  468. # if not os.path.exists(LITELLM_CONFIG_PATH):
  469. # log.info("Config file doesn't exist. Creating...")
  470. # create_config_file(LITELLM_CONFIG_PATH)
  471. # log.info("Config file created successfully.")
  472. ####################################
  473. # OLLAMA_BASE_URL
  474. ####################################
  475. ENABLE_OLLAMA_API = PersistentConfig(
  476. "ENABLE_OLLAMA_API",
  477. "ollama.enable",
  478. os.environ.get("ENABLE_OLLAMA_API", "True").lower() == "true",
  479. )
  480. OLLAMA_API_BASE_URL = os.environ.get(
  481. "OLLAMA_API_BASE_URL", "http://localhost:11434/api"
  482. )
  483. OLLAMA_BASE_URL = os.environ.get("OLLAMA_BASE_URL", "")
  484. AIOHTTP_CLIENT_TIMEOUT = os.environ.get("AIOHTTP_CLIENT_TIMEOUT", "")
  485. if AIOHTTP_CLIENT_TIMEOUT == "":
  486. AIOHTTP_CLIENT_TIMEOUT = None
  487. else:
  488. try:
  489. AIOHTTP_CLIENT_TIMEOUT = int(AIOHTTP_CLIENT_TIMEOUT)
  490. except:
  491. AIOHTTP_CLIENT_TIMEOUT = 300
  492. K8S_FLAG = os.environ.get("K8S_FLAG", "")
  493. USE_OLLAMA_DOCKER = os.environ.get("USE_OLLAMA_DOCKER", "false")
  494. if OLLAMA_BASE_URL == "" and OLLAMA_API_BASE_URL != "":
  495. OLLAMA_BASE_URL = (
  496. OLLAMA_API_BASE_URL[:-4]
  497. if OLLAMA_API_BASE_URL.endswith("/api")
  498. else OLLAMA_API_BASE_URL
  499. )
  500. if ENV == "prod":
  501. if OLLAMA_BASE_URL == "/ollama" and not K8S_FLAG:
  502. if USE_OLLAMA_DOCKER.lower() == "true":
  503. # if you use all-in-one docker container (Open WebUI + Ollama)
  504. # with the docker build arg USE_OLLAMA=true (--build-arg="USE_OLLAMA=true") this only works with http://localhost:11434
  505. OLLAMA_BASE_URL = "http://localhost:11434"
  506. else:
  507. OLLAMA_BASE_URL = "http://host.docker.internal:11434"
  508. elif K8S_FLAG:
  509. OLLAMA_BASE_URL = "http://ollama-service.open-webui.svc.cluster.local:11434"
  510. OLLAMA_BASE_URLS = os.environ.get("OLLAMA_BASE_URLS", "")
  511. OLLAMA_BASE_URLS = OLLAMA_BASE_URLS if OLLAMA_BASE_URLS != "" else OLLAMA_BASE_URL
  512. OLLAMA_BASE_URLS = [url.strip() for url in OLLAMA_BASE_URLS.split(";")]
  513. OLLAMA_BASE_URLS = PersistentConfig(
  514. "OLLAMA_BASE_URLS", "ollama.base_urls", OLLAMA_BASE_URLS
  515. )
  516. ####################################
  517. # OPENAI_API
  518. ####################################
  519. ENABLE_OPENAI_API = PersistentConfig(
  520. "ENABLE_OPENAI_API",
  521. "openai.enable",
  522. os.environ.get("ENABLE_OPENAI_API", "True").lower() == "true",
  523. )
  524. OPENAI_API_KEY = os.environ.get("OPENAI_API_KEY", "")
  525. OPENAI_API_BASE_URL = os.environ.get("OPENAI_API_BASE_URL", "")
  526. if OPENAI_API_BASE_URL == "":
  527. OPENAI_API_BASE_URL = "https://api.openai.com/v1"
  528. OPENAI_API_KEYS = os.environ.get("OPENAI_API_KEYS", "")
  529. OPENAI_API_KEYS = OPENAI_API_KEYS if OPENAI_API_KEYS != "" else OPENAI_API_KEY
  530. OPENAI_API_KEYS = [url.strip() for url in OPENAI_API_KEYS.split(";")]
  531. OPENAI_API_KEYS = PersistentConfig(
  532. "OPENAI_API_KEYS", "openai.api_keys", OPENAI_API_KEYS
  533. )
  534. OPENAI_API_BASE_URLS = os.environ.get("OPENAI_API_BASE_URLS", "")
  535. OPENAI_API_BASE_URLS = (
  536. OPENAI_API_BASE_URLS if OPENAI_API_BASE_URLS != "" else OPENAI_API_BASE_URL
  537. )
  538. OPENAI_API_BASE_URLS = [
  539. url.strip() if url != "" else "https://api.openai.com/v1"
  540. for url in OPENAI_API_BASE_URLS.split(";")
  541. ]
  542. OPENAI_API_BASE_URLS = PersistentConfig(
  543. "OPENAI_API_BASE_URLS", "openai.api_base_urls", OPENAI_API_BASE_URLS
  544. )
  545. OPENAI_API_KEY = ""
  546. try:
  547. OPENAI_API_KEY = OPENAI_API_KEYS.value[
  548. OPENAI_API_BASE_URLS.value.index("https://api.openai.com/v1")
  549. ]
  550. except:
  551. pass
  552. OPENAI_API_BASE_URL = "https://api.openai.com/v1"
  553. ####################################
  554. # WEBUI
  555. ####################################
  556. ENABLE_SIGNUP = PersistentConfig(
  557. "ENABLE_SIGNUP",
  558. "ui.enable_signup",
  559. (
  560. False
  561. if not WEBUI_AUTH
  562. else os.environ.get("ENABLE_SIGNUP", "True").lower() == "true"
  563. ),
  564. )
  565. ENABLE_LOGIN_FORM = PersistentConfig(
  566. "ENABLE_LOGIN_FORM",
  567. "ui.ENABLE_LOGIN_FORM",
  568. os.environ.get("ENABLE_LOGIN_FORM", "True").lower() == "true",
  569. )
  570. DEFAULT_LOCALE = PersistentConfig(
  571. "DEFAULT_LOCALE",
  572. "ui.default_locale",
  573. os.environ.get("DEFAULT_LOCALE", ""),
  574. )
  575. DEFAULT_MODELS = PersistentConfig(
  576. "DEFAULT_MODELS", "ui.default_models", os.environ.get("DEFAULT_MODELS", None)
  577. )
  578. DEFAULT_PROMPT_SUGGESTIONS = PersistentConfig(
  579. "DEFAULT_PROMPT_SUGGESTIONS",
  580. "ui.prompt_suggestions",
  581. [
  582. {
  583. "title": ["Help me study", "vocabulary for a college entrance exam"],
  584. "content": "Help me study vocabulary: write a sentence for me to fill in the blank, and I'll try to pick the correct option.",
  585. },
  586. {
  587. "title": ["Give me ideas", "for what to do with my kids' art"],
  588. "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.",
  589. },
  590. {
  591. "title": ["Tell me a fun fact", "about the Roman Empire"],
  592. "content": "Tell me a random fun fact about the Roman Empire",
  593. },
  594. {
  595. "title": ["Show me a code snippet", "of a website's sticky header"],
  596. "content": "Show me a code snippet of a website's sticky header in CSS and JavaScript.",
  597. },
  598. {
  599. "title": [
  600. "Explain options trading",
  601. "if I'm familiar with buying and selling stocks",
  602. ],
  603. "content": "Explain options trading in simple terms if I'm familiar with buying and selling stocks.",
  604. },
  605. {
  606. "title": ["Overcome procrastination", "give me tips"],
  607. "content": "Could you start by asking me about instances when I procrastinate the most and then give me some suggestions to overcome it?",
  608. },
  609. ],
  610. )
  611. DEFAULT_USER_ROLE = PersistentConfig(
  612. "DEFAULT_USER_ROLE",
  613. "ui.default_user_role",
  614. os.getenv("DEFAULT_USER_ROLE", "pending"),
  615. )
  616. USER_PERMISSIONS_CHAT_DELETION = (
  617. os.environ.get("USER_PERMISSIONS_CHAT_DELETION", "True").lower() == "true"
  618. )
  619. USER_PERMISSIONS = PersistentConfig(
  620. "USER_PERMISSIONS",
  621. "ui.user_permissions",
  622. {"chat": {"deletion": USER_PERMISSIONS_CHAT_DELETION}},
  623. )
  624. ENABLE_MODEL_FILTER = PersistentConfig(
  625. "ENABLE_MODEL_FILTER",
  626. "model_filter.enable",
  627. os.environ.get("ENABLE_MODEL_FILTER", "False").lower() == "true",
  628. )
  629. MODEL_FILTER_LIST = os.environ.get("MODEL_FILTER_LIST", "")
  630. MODEL_FILTER_LIST = PersistentConfig(
  631. "MODEL_FILTER_LIST",
  632. "model_filter.list",
  633. [model.strip() for model in MODEL_FILTER_LIST.split(";")],
  634. )
  635. WEBHOOK_URL = PersistentConfig(
  636. "WEBHOOK_URL", "webhook_url", os.environ.get("WEBHOOK_URL", "")
  637. )
  638. ENABLE_ADMIN_EXPORT = os.environ.get("ENABLE_ADMIN_EXPORT", "True").lower() == "true"
  639. ENABLE_ADMIN_CHAT_ACCESS = (
  640. os.environ.get("ENABLE_ADMIN_CHAT_ACCESS", "True").lower() == "true"
  641. )
  642. ENABLE_COMMUNITY_SHARING = PersistentConfig(
  643. "ENABLE_COMMUNITY_SHARING",
  644. "ui.enable_community_sharing",
  645. os.environ.get("ENABLE_COMMUNITY_SHARING", "True").lower() == "true",
  646. )
  647. class BannerModel(BaseModel):
  648. id: str
  649. type: str
  650. title: Optional[str] = None
  651. content: str
  652. dismissible: bool
  653. timestamp: int
  654. try:
  655. banners = json.loads(os.environ.get("WEBUI_BANNERS", "[]"))
  656. banners = [BannerModel(**banner) for banner in banners]
  657. except Exception as e:
  658. print(f"Error loading WEBUI_BANNERS: {e}")
  659. banners = []
  660. WEBUI_BANNERS = PersistentConfig("WEBUI_BANNERS", "ui.banners", banners)
  661. SHOW_ADMIN_DETAILS = PersistentConfig(
  662. "SHOW_ADMIN_DETAILS",
  663. "auth.admin.show",
  664. os.environ.get("SHOW_ADMIN_DETAILS", "true").lower() == "true",
  665. )
  666. ADMIN_EMAIL = PersistentConfig(
  667. "ADMIN_EMAIL",
  668. "auth.admin.email",
  669. os.environ.get("ADMIN_EMAIL", None),
  670. )
  671. ####################################
  672. # TASKS
  673. ####################################
  674. TASK_MODEL = PersistentConfig(
  675. "TASK_MODEL",
  676. "task.model.default",
  677. os.environ.get("TASK_MODEL", ""),
  678. )
  679. TASK_MODEL_EXTERNAL = PersistentConfig(
  680. "TASK_MODEL_EXTERNAL",
  681. "task.model.external",
  682. os.environ.get("TASK_MODEL_EXTERNAL", ""),
  683. )
  684. TITLE_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  685. "TITLE_GENERATION_PROMPT_TEMPLATE",
  686. "task.title.prompt_template",
  687. os.environ.get(
  688. "TITLE_GENERATION_PROMPT_TEMPLATE",
  689. """Here is the query:
  690. {{prompt:middletruncate:8000}}
  691. 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.
  692. Examples of titles:
  693. 📉 Stock Market Trends
  694. 🍪 Perfect Chocolate Chip Recipe
  695. Evolution of Music Streaming
  696. Remote Work Productivity Tips
  697. Artificial Intelligence in Healthcare
  698. 🎮 Video Game Development Insights""",
  699. ),
  700. )
  701. SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  702. "SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE",
  703. "task.search.prompt_template",
  704. os.environ.get(
  705. "SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE",
  706. """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}}.
  707. Question:
  708. {{prompt:end:4000}}""",
  709. ),
  710. )
  711. SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD = PersistentConfig(
  712. "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD",
  713. "task.search.prompt_length_threshold",
  714. int(
  715. os.environ.get(
  716. "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD",
  717. 100,
  718. )
  719. ),
  720. )
  721. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = PersistentConfig(
  722. "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE",
  723. "task.tools.prompt_template",
  724. os.environ.get(
  725. "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE",
  726. """Tools: {{TOOLS}}
  727. If a function tool doesn't match the query, return an empty string. Else, pick a function tool, fill in the parameters from the function tool's schema, and return it in the format { "name": \"functionName\", "parameters": { "key": "value" } }. Only pick a function if the user asks. Only return the object. Do not return any other text.""",
  728. ),
  729. )
  730. ####################################
  731. # WEBUI_SECRET_KEY
  732. ####################################
  733. WEBUI_SECRET_KEY = os.environ.get(
  734. "WEBUI_SECRET_KEY",
  735. os.environ.get(
  736. "WEBUI_JWT_SECRET_KEY", "t0p-s3cr3t"
  737. ), # DEPRECATED: remove at next major version
  738. )
  739. WEBUI_SESSION_COOKIE_SAME_SITE = os.environ.get(
  740. "WEBUI_SESSION_COOKIE_SAME_SITE",
  741. os.environ.get("WEBUI_SESSION_COOKIE_SAME_SITE", "lax"),
  742. )
  743. WEBUI_SESSION_COOKIE_SECURE = os.environ.get(
  744. "WEBUI_SESSION_COOKIE_SECURE",
  745. os.environ.get("WEBUI_SESSION_COOKIE_SECURE", "false").lower() == "true",
  746. )
  747. if WEBUI_AUTH and WEBUI_SECRET_KEY == "":
  748. raise ValueError(ERROR_MESSAGES.ENV_VAR_NOT_FOUND)
  749. ####################################
  750. # RAG document content extraction
  751. ####################################
  752. CONTENT_EXTRACTION_ENGINE = PersistentConfig(
  753. "CONTENT_EXTRACTION_ENGINE",
  754. "rag.CONTENT_EXTRACTION_ENGINE",
  755. os.environ.get("CONTENT_EXTRACTION_ENGINE", "").lower(),
  756. )
  757. TIKA_SERVER_URL = PersistentConfig(
  758. "TIKA_SERVER_URL",
  759. "rag.tika_server_url",
  760. os.getenv("TIKA_SERVER_URL", "http://tika:9998"), # Default for sidecar deployment
  761. )
  762. ####################################
  763. # RAG
  764. ####################################
  765. CHROMA_DATA_PATH = f"{DATA_DIR}/vector_db"
  766. CHROMA_TENANT = os.environ.get("CHROMA_TENANT", chromadb.DEFAULT_TENANT)
  767. CHROMA_DATABASE = os.environ.get("CHROMA_DATABASE", chromadb.DEFAULT_DATABASE)
  768. CHROMA_HTTP_HOST = os.environ.get("CHROMA_HTTP_HOST", "")
  769. CHROMA_HTTP_PORT = int(os.environ.get("CHROMA_HTTP_PORT", "8000"))
  770. # Comma-separated list of header=value pairs
  771. CHROMA_HTTP_HEADERS = os.environ.get("CHROMA_HTTP_HEADERS", "")
  772. if CHROMA_HTTP_HEADERS:
  773. CHROMA_HTTP_HEADERS = dict(
  774. [pair.split("=") for pair in CHROMA_HTTP_HEADERS.split(",")]
  775. )
  776. else:
  777. CHROMA_HTTP_HEADERS = None
  778. CHROMA_HTTP_SSL = os.environ.get("CHROMA_HTTP_SSL", "false").lower() == "true"
  779. # 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)
  780. RAG_TOP_K = PersistentConfig(
  781. "RAG_TOP_K", "rag.top_k", int(os.environ.get("RAG_TOP_K", "5"))
  782. )
  783. RAG_RELEVANCE_THRESHOLD = PersistentConfig(
  784. "RAG_RELEVANCE_THRESHOLD",
  785. "rag.relevance_threshold",
  786. float(os.environ.get("RAG_RELEVANCE_THRESHOLD", "0.0")),
  787. )
  788. ENABLE_RAG_HYBRID_SEARCH = PersistentConfig(
  789. "ENABLE_RAG_HYBRID_SEARCH",
  790. "rag.enable_hybrid_search",
  791. os.environ.get("ENABLE_RAG_HYBRID_SEARCH", "").lower() == "true",
  792. )
  793. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = PersistentConfig(
  794. "ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION",
  795. "rag.enable_web_loader_ssl_verification",
  796. os.environ.get("ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION", "True").lower() == "true",
  797. )
  798. RAG_EMBEDDING_ENGINE = PersistentConfig(
  799. "RAG_EMBEDDING_ENGINE",
  800. "rag.embedding_engine",
  801. os.environ.get("RAG_EMBEDDING_ENGINE", ""),
  802. )
  803. PDF_EXTRACT_IMAGES = PersistentConfig(
  804. "PDF_EXTRACT_IMAGES",
  805. "rag.pdf_extract_images",
  806. os.environ.get("PDF_EXTRACT_IMAGES", "False").lower() == "true",
  807. )
  808. RAG_EMBEDDING_MODEL = PersistentConfig(
  809. "RAG_EMBEDDING_MODEL",
  810. "rag.embedding_model",
  811. os.environ.get("RAG_EMBEDDING_MODEL", "sentence-transformers/all-MiniLM-L6-v2"),
  812. )
  813. log.info(f"Embedding model set: {RAG_EMBEDDING_MODEL.value}"),
  814. RAG_EMBEDDING_MODEL_AUTO_UPDATE = (
  815. os.environ.get("RAG_EMBEDDING_MODEL_AUTO_UPDATE", "").lower() == "true"
  816. )
  817. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE = (
  818. os.environ.get("RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE", "").lower() == "true"
  819. )
  820. RAG_EMBEDDING_OPENAI_BATCH_SIZE = PersistentConfig(
  821. "RAG_EMBEDDING_OPENAI_BATCH_SIZE",
  822. "rag.embedding_openai_batch_size",
  823. os.environ.get("RAG_EMBEDDING_OPENAI_BATCH_SIZE", 1),
  824. )
  825. RAG_RERANKING_MODEL = PersistentConfig(
  826. "RAG_RERANKING_MODEL",
  827. "rag.reranking_model",
  828. os.environ.get("RAG_RERANKING_MODEL", ""),
  829. )
  830. if RAG_RERANKING_MODEL.value != "":
  831. log.info(f"Reranking model set: {RAG_RERANKING_MODEL.value}"),
  832. RAG_RERANKING_MODEL_AUTO_UPDATE = (
  833. os.environ.get("RAG_RERANKING_MODEL_AUTO_UPDATE", "").lower() == "true"
  834. )
  835. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE = (
  836. os.environ.get("RAG_RERANKING_MODEL_TRUST_REMOTE_CODE", "").lower() == "true"
  837. )
  838. if CHROMA_HTTP_HOST != "":
  839. CHROMA_CLIENT = chromadb.HttpClient(
  840. host=CHROMA_HTTP_HOST,
  841. port=CHROMA_HTTP_PORT,
  842. headers=CHROMA_HTTP_HEADERS,
  843. ssl=CHROMA_HTTP_SSL,
  844. tenant=CHROMA_TENANT,
  845. database=CHROMA_DATABASE,
  846. settings=Settings(allow_reset=True, anonymized_telemetry=False),
  847. )
  848. else:
  849. CHROMA_CLIENT = chromadb.PersistentClient(
  850. path=CHROMA_DATA_PATH,
  851. settings=Settings(allow_reset=True, anonymized_telemetry=False),
  852. tenant=CHROMA_TENANT,
  853. database=CHROMA_DATABASE,
  854. )
  855. # device type embedding models - "cpu" (default), "cuda" (nvidia gpu required) or "mps" (apple silicon) - choosing this right can lead to better performance
  856. USE_CUDA = os.environ.get("USE_CUDA_DOCKER", "false")
  857. if USE_CUDA.lower() == "true":
  858. DEVICE_TYPE = "cuda"
  859. else:
  860. DEVICE_TYPE = "cpu"
  861. CHUNK_SIZE = PersistentConfig(
  862. "CHUNK_SIZE", "rag.chunk_size", int(os.environ.get("CHUNK_SIZE", "1500"))
  863. )
  864. CHUNK_OVERLAP = PersistentConfig(
  865. "CHUNK_OVERLAP",
  866. "rag.chunk_overlap",
  867. int(os.environ.get("CHUNK_OVERLAP", "100")),
  868. )
  869. DEFAULT_RAG_TEMPLATE = """Use the following context as your learned knowledge, inside <context></context> XML tags.
  870. <context>
  871. [context]
  872. </context>
  873. When answer to user:
  874. - If you don't know, just say that you don't know.
  875. - If you don't know when you are not sure, ask for clarification.
  876. Avoid mentioning that you obtained the information from the context.
  877. And answer according to the language of the user's question.
  878. Given the context information, answer the query.
  879. Query: [query]"""
  880. RAG_TEMPLATE = PersistentConfig(
  881. "RAG_TEMPLATE",
  882. "rag.template",
  883. os.environ.get("RAG_TEMPLATE", DEFAULT_RAG_TEMPLATE),
  884. )
  885. RAG_OPENAI_API_BASE_URL = PersistentConfig(
  886. "RAG_OPENAI_API_BASE_URL",
  887. "rag.openai_api_base_url",
  888. os.getenv("RAG_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  889. )
  890. RAG_OPENAI_API_KEY = PersistentConfig(
  891. "RAG_OPENAI_API_KEY",
  892. "rag.openai_api_key",
  893. os.getenv("RAG_OPENAI_API_KEY", OPENAI_API_KEY),
  894. )
  895. ENABLE_RAG_LOCAL_WEB_FETCH = (
  896. os.getenv("ENABLE_RAG_LOCAL_WEB_FETCH", "False").lower() == "true"
  897. )
  898. YOUTUBE_LOADER_LANGUAGE = PersistentConfig(
  899. "YOUTUBE_LOADER_LANGUAGE",
  900. "rag.youtube_loader_language",
  901. os.getenv("YOUTUBE_LOADER_LANGUAGE", "en").split(","),
  902. )
  903. ENABLE_RAG_WEB_SEARCH = PersistentConfig(
  904. "ENABLE_RAG_WEB_SEARCH",
  905. "rag.web.search.enable",
  906. os.getenv("ENABLE_RAG_WEB_SEARCH", "False").lower() == "true",
  907. )
  908. RAG_WEB_SEARCH_ENGINE = PersistentConfig(
  909. "RAG_WEB_SEARCH_ENGINE",
  910. "rag.web.search.engine",
  911. os.getenv("RAG_WEB_SEARCH_ENGINE", ""),
  912. )
  913. # You can provide a list of your own websites to filter after performing a web search.
  914. # This ensures the highest level of safety and reliability of the information sources.
  915. RAG_WEB_SEARCH_DOMAIN_FILTER_LIST = PersistentConfig(
  916. "RAG_WEB_SEARCH_DOMAIN_FILTER_LIST",
  917. "rag.rag.web.search.domain.filter_list",
  918. [
  919. # "wikipedia.com",
  920. # "wikimedia.org",
  921. # "wikidata.org",
  922. ],
  923. )
  924. SEARXNG_QUERY_URL = PersistentConfig(
  925. "SEARXNG_QUERY_URL",
  926. "rag.web.search.searxng_query_url",
  927. os.getenv("SEARXNG_QUERY_URL", ""),
  928. )
  929. GOOGLE_PSE_API_KEY = PersistentConfig(
  930. "GOOGLE_PSE_API_KEY",
  931. "rag.web.search.google_pse_api_key",
  932. os.getenv("GOOGLE_PSE_API_KEY", ""),
  933. )
  934. GOOGLE_PSE_ENGINE_ID = PersistentConfig(
  935. "GOOGLE_PSE_ENGINE_ID",
  936. "rag.web.search.google_pse_engine_id",
  937. os.getenv("GOOGLE_PSE_ENGINE_ID", ""),
  938. )
  939. BRAVE_SEARCH_API_KEY = PersistentConfig(
  940. "BRAVE_SEARCH_API_KEY",
  941. "rag.web.search.brave_search_api_key",
  942. os.getenv("BRAVE_SEARCH_API_KEY", ""),
  943. )
  944. SERPSTACK_API_KEY = PersistentConfig(
  945. "SERPSTACK_API_KEY",
  946. "rag.web.search.serpstack_api_key",
  947. os.getenv("SERPSTACK_API_KEY", ""),
  948. )
  949. SERPSTACK_HTTPS = PersistentConfig(
  950. "SERPSTACK_HTTPS",
  951. "rag.web.search.serpstack_https",
  952. os.getenv("SERPSTACK_HTTPS", "True").lower() == "true",
  953. )
  954. SERPER_API_KEY = PersistentConfig(
  955. "SERPER_API_KEY",
  956. "rag.web.search.serper_api_key",
  957. os.getenv("SERPER_API_KEY", ""),
  958. )
  959. SERPLY_API_KEY = PersistentConfig(
  960. "SERPLY_API_KEY",
  961. "rag.web.search.serply_api_key",
  962. os.getenv("SERPLY_API_KEY", ""),
  963. )
  964. TAVILY_API_KEY = PersistentConfig(
  965. "TAVILY_API_KEY",
  966. "rag.web.search.tavily_api_key",
  967. os.getenv("TAVILY_API_KEY", ""),
  968. )
  969. RAG_WEB_SEARCH_RESULT_COUNT = PersistentConfig(
  970. "RAG_WEB_SEARCH_RESULT_COUNT",
  971. "rag.web.search.result_count",
  972. int(os.getenv("RAG_WEB_SEARCH_RESULT_COUNT", "3")),
  973. )
  974. RAG_WEB_SEARCH_CONCURRENT_REQUESTS = PersistentConfig(
  975. "RAG_WEB_SEARCH_CONCURRENT_REQUESTS",
  976. "rag.web.search.concurrent_requests",
  977. int(os.getenv("RAG_WEB_SEARCH_CONCURRENT_REQUESTS", "10")),
  978. )
  979. ####################################
  980. # Transcribe
  981. ####################################
  982. WHISPER_MODEL = os.getenv("WHISPER_MODEL", "base")
  983. WHISPER_MODEL_DIR = os.getenv("WHISPER_MODEL_DIR", f"{CACHE_DIR}/whisper/models")
  984. WHISPER_MODEL_AUTO_UPDATE = (
  985. os.environ.get("WHISPER_MODEL_AUTO_UPDATE", "").lower() == "true"
  986. )
  987. ####################################
  988. # Images
  989. ####################################
  990. IMAGE_GENERATION_ENGINE = PersistentConfig(
  991. "IMAGE_GENERATION_ENGINE",
  992. "image_generation.engine",
  993. os.getenv("IMAGE_GENERATION_ENGINE", ""),
  994. )
  995. ENABLE_IMAGE_GENERATION = PersistentConfig(
  996. "ENABLE_IMAGE_GENERATION",
  997. "image_generation.enable",
  998. os.environ.get("ENABLE_IMAGE_GENERATION", "").lower() == "true",
  999. )
  1000. AUTOMATIC1111_BASE_URL = PersistentConfig(
  1001. "AUTOMATIC1111_BASE_URL",
  1002. "image_generation.automatic1111.base_url",
  1003. os.getenv("AUTOMATIC1111_BASE_URL", ""),
  1004. )
  1005. AUTOMATIC1111_API_AUTH = PersistentConfig(
  1006. "AUTOMATIC1111_API_AUTH",
  1007. "image_generation.automatic1111.api_auth",
  1008. os.getenv("AUTOMATIC1111_API_AUTH", ""),
  1009. )
  1010. COMFYUI_BASE_URL = PersistentConfig(
  1011. "COMFYUI_BASE_URL",
  1012. "image_generation.comfyui.base_url",
  1013. os.getenv("COMFYUI_BASE_URL", ""),
  1014. )
  1015. COMFYUI_CFG_SCALE = PersistentConfig(
  1016. "COMFYUI_CFG_SCALE",
  1017. "image_generation.comfyui.cfg_scale",
  1018. os.getenv("COMFYUI_CFG_SCALE", ""),
  1019. )
  1020. COMFYUI_SAMPLER = PersistentConfig(
  1021. "COMFYUI_SAMPLER",
  1022. "image_generation.comfyui.sampler",
  1023. os.getenv("COMFYUI_SAMPLER", ""),
  1024. )
  1025. COMFYUI_SCHEDULER = PersistentConfig(
  1026. "COMFYUI_SCHEDULER",
  1027. "image_generation.comfyui.scheduler",
  1028. os.getenv("COMFYUI_SCHEDULER", ""),
  1029. )
  1030. COMFYUI_SD3 = PersistentConfig(
  1031. "COMFYUI_SD3",
  1032. "image_generation.comfyui.sd3",
  1033. os.environ.get("COMFYUI_SD3", "").lower() == "true",
  1034. )
  1035. COMFYUI_FLUX = PersistentConfig(
  1036. "COMFYUI_FLUX",
  1037. "image_generation.comfyui.flux",
  1038. os.environ.get("COMFYUI_FLUX", "").lower() == "true",
  1039. )
  1040. COMFYUI_FLUX_WEIGHT_DTYPE = PersistentConfig(
  1041. "COMFYUI_FLUX_WEIGHT_DTYPE",
  1042. "image_generation.comfyui.flux_weight_dtype",
  1043. os.getenv("COMFYUI_FLUX_WEIGHT_DTYPE", ""),
  1044. )
  1045. COMFYUI_FLUX_FP8_CLIP = PersistentConfig(
  1046. "COMFYUI_FLUX_FP8_CLIP",
  1047. "image_generation.comfyui.flux_fp8_clip",
  1048. os.environ.get("COMFYUI_FLUX_FP8_CLIP", "").lower() == "true",
  1049. )
  1050. IMAGES_OPENAI_API_BASE_URL = PersistentConfig(
  1051. "IMAGES_OPENAI_API_BASE_URL",
  1052. "image_generation.openai.api_base_url",
  1053. os.getenv("IMAGES_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1054. )
  1055. IMAGES_OPENAI_API_KEY = PersistentConfig(
  1056. "IMAGES_OPENAI_API_KEY",
  1057. "image_generation.openai.api_key",
  1058. os.getenv("IMAGES_OPENAI_API_KEY", OPENAI_API_KEY),
  1059. )
  1060. IMAGE_SIZE = PersistentConfig(
  1061. "IMAGE_SIZE", "image_generation.size", os.getenv("IMAGE_SIZE", "512x512")
  1062. )
  1063. IMAGE_STEPS = PersistentConfig(
  1064. "IMAGE_STEPS", "image_generation.steps", int(os.getenv("IMAGE_STEPS", 50))
  1065. )
  1066. IMAGE_GENERATION_MODEL = PersistentConfig(
  1067. "IMAGE_GENERATION_MODEL",
  1068. "image_generation.model",
  1069. os.getenv("IMAGE_GENERATION_MODEL", ""),
  1070. )
  1071. ####################################
  1072. # Audio
  1073. ####################################
  1074. AUDIO_STT_OPENAI_API_BASE_URL = PersistentConfig(
  1075. "AUDIO_STT_OPENAI_API_BASE_URL",
  1076. "audio.stt.openai.api_base_url",
  1077. os.getenv("AUDIO_STT_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1078. )
  1079. AUDIO_STT_OPENAI_API_KEY = PersistentConfig(
  1080. "AUDIO_STT_OPENAI_API_KEY",
  1081. "audio.stt.openai.api_key",
  1082. os.getenv("AUDIO_STT_OPENAI_API_KEY", OPENAI_API_KEY),
  1083. )
  1084. AUDIO_STT_ENGINE = PersistentConfig(
  1085. "AUDIO_STT_ENGINE",
  1086. "audio.stt.engine",
  1087. os.getenv("AUDIO_STT_ENGINE", ""),
  1088. )
  1089. AUDIO_STT_MODEL = PersistentConfig(
  1090. "AUDIO_STT_MODEL",
  1091. "audio.stt.model",
  1092. os.getenv("AUDIO_STT_MODEL", "whisper-1"),
  1093. )
  1094. AUDIO_TTS_OPENAI_API_BASE_URL = PersistentConfig(
  1095. "AUDIO_TTS_OPENAI_API_BASE_URL",
  1096. "audio.tts.openai.api_base_url",
  1097. os.getenv("AUDIO_TTS_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1098. )
  1099. AUDIO_TTS_OPENAI_API_KEY = PersistentConfig(
  1100. "AUDIO_TTS_OPENAI_API_KEY",
  1101. "audio.tts.openai.api_key",
  1102. os.getenv("AUDIO_TTS_OPENAI_API_KEY", OPENAI_API_KEY),
  1103. )
  1104. AUDIO_TTS_API_KEY = PersistentConfig(
  1105. "AUDIO_TTS_API_KEY",
  1106. "audio.tts.api_key",
  1107. os.getenv("AUDIO_TTS_API_KEY", ""),
  1108. )
  1109. AUDIO_TTS_ENGINE = PersistentConfig(
  1110. "AUDIO_TTS_ENGINE",
  1111. "audio.tts.engine",
  1112. os.getenv("AUDIO_TTS_ENGINE", ""),
  1113. )
  1114. AUDIO_TTS_MODEL = PersistentConfig(
  1115. "AUDIO_TTS_MODEL",
  1116. "audio.tts.model",
  1117. os.getenv("AUDIO_TTS_MODEL", "tts-1"),
  1118. )
  1119. AUDIO_TTS_VOICE = PersistentConfig(
  1120. "AUDIO_TTS_VOICE",
  1121. "audio.tts.voice",
  1122. os.getenv("AUDIO_TTS_VOICE", "alloy"),
  1123. )
  1124. ####################################
  1125. # Database
  1126. ####################################
  1127. DATABASE_URL = os.environ.get("DATABASE_URL", f"sqlite:///{DATA_DIR}/webui.db")
  1128. # Replace the postgres:// with postgresql://
  1129. if "postgres://" in DATABASE_URL:
  1130. DATABASE_URL = DATABASE_URL.replace("postgres://", "postgresql://")