config.py 42 KB

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