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