config.py 41 KB

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