config.py 42 KB

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