config.py 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884
  1. import os
  2. import sys
  3. import logging
  4. import importlib.metadata
  5. import pkgutil
  6. import chromadb
  7. from chromadb import Settings
  8. from base64 import b64encode
  9. from bs4 import BeautifulSoup
  10. from typing import TypeVar, Generic, Union
  11. from pathlib import Path
  12. import json
  13. import yaml
  14. import markdown
  15. import requests
  16. import shutil
  17. from secrets import token_bytes
  18. from constants import ERROR_MESSAGES
  19. ####################################
  20. # Load .env file
  21. ####################################
  22. BACKEND_DIR = Path(__file__).parent # the path containing this file
  23. BASE_DIR = BACKEND_DIR.parent # the path containing the backend/
  24. print(BASE_DIR)
  25. try:
  26. from dotenv import load_dotenv, find_dotenv
  27. load_dotenv(find_dotenv(str(BASE_DIR / ".env")))
  28. except ImportError:
  29. print("dotenv not installed, skipping...")
  30. ####################################
  31. # LOGGING
  32. ####################################
  33. log_levels = ["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"]
  34. GLOBAL_LOG_LEVEL = os.environ.get("GLOBAL_LOG_LEVEL", "").upper()
  35. if GLOBAL_LOG_LEVEL in log_levels:
  36. logging.basicConfig(stream=sys.stdout, level=GLOBAL_LOG_LEVEL, force=True)
  37. else:
  38. GLOBAL_LOG_LEVEL = "INFO"
  39. log = logging.getLogger(__name__)
  40. log.info(f"GLOBAL_LOG_LEVEL: {GLOBAL_LOG_LEVEL}")
  41. log_sources = [
  42. "AUDIO",
  43. "COMFYUI",
  44. "CONFIG",
  45. "DB",
  46. "IMAGES",
  47. "MAIN",
  48. "MODELS",
  49. "OLLAMA",
  50. "OPENAI",
  51. "RAG",
  52. "WEBHOOK",
  53. ]
  54. SRC_LOG_LEVELS = {}
  55. for source in log_sources:
  56. log_env_var = source + "_LOG_LEVEL"
  57. SRC_LOG_LEVELS[source] = os.environ.get(log_env_var, "").upper()
  58. if SRC_LOG_LEVELS[source] not in log_levels:
  59. SRC_LOG_LEVELS[source] = GLOBAL_LOG_LEVEL
  60. log.info(f"{log_env_var}: {SRC_LOG_LEVELS[source]}")
  61. log.setLevel(SRC_LOG_LEVELS["CONFIG"])
  62. WEBUI_NAME = os.environ.get("WEBUI_NAME", "Open WebUI")
  63. if WEBUI_NAME != "Open WebUI":
  64. WEBUI_NAME += " (Open WebUI)"
  65. WEBUI_URL = os.environ.get("WEBUI_URL", "http://localhost:3000")
  66. WEBUI_FAVICON_URL = "https://openwebui.com/favicon.png"
  67. ####################################
  68. # ENV (dev,test,prod)
  69. ####################################
  70. ENV = os.environ.get("ENV", "dev")
  71. try:
  72. PACKAGE_DATA = json.loads((BASE_DIR / "package.json").read_text())
  73. except:
  74. try:
  75. PACKAGE_DATA = {"version": importlib.metadata.version("open-webui")}
  76. except importlib.metadata.PackageNotFoundError:
  77. PACKAGE_DATA = {"version": "0.0.0"}
  78. VERSION = PACKAGE_DATA["version"]
  79. # Function to parse each section
  80. def parse_section(section):
  81. items = []
  82. for li in section.find_all("li"):
  83. # Extract raw HTML string
  84. raw_html = str(li)
  85. # Extract text without HTML tags
  86. text = li.get_text(separator=" ", strip=True)
  87. # Split into title and content
  88. parts = text.split(": ", 1)
  89. title = parts[0].strip() if len(parts) > 1 else ""
  90. content = parts[1].strip() if len(parts) > 1 else text
  91. items.append({"title": title, "content": content, "raw": raw_html})
  92. return items
  93. try:
  94. changelog_path = BASE_DIR / "CHANGELOG.md"
  95. with open(str(changelog_path.absolute()), "r", encoding="utf8") as file:
  96. changelog_content = file.read()
  97. except:
  98. changelog_content = (pkgutil.get_data("open_webui", "CHANGELOG.md") or b"").decode()
  99. # Convert markdown content to HTML
  100. html_content = markdown.markdown(changelog_content)
  101. # Parse the HTML content
  102. soup = BeautifulSoup(html_content, "html.parser")
  103. # Initialize JSON structure
  104. changelog_json = {}
  105. # Iterate over each version
  106. for version in soup.find_all("h2"):
  107. version_number = version.get_text().strip().split(" - ")[0][1:-1] # Remove brackets
  108. date = version.get_text().strip().split(" - ")[1]
  109. version_data = {"date": date}
  110. # Find the next sibling that is a h3 tag (section title)
  111. current = version.find_next_sibling()
  112. while current and current.name != "h2":
  113. if current.name == "h3":
  114. section_title = current.get_text().lower() # e.g., "added", "fixed"
  115. section_items = parse_section(current.find_next_sibling("ul"))
  116. version_data[section_title] = section_items
  117. # Move to the next element
  118. current = current.find_next_sibling()
  119. changelog_json[version_number] = version_data
  120. CHANGELOG = changelog_json
  121. ####################################
  122. # WEBUI_VERSION
  123. ####################################
  124. WEBUI_VERSION = os.environ.get("WEBUI_VERSION", "v1.0.0-alpha.100")
  125. ####################################
  126. # DATA/FRONTEND BUILD DIR
  127. ####################################
  128. DATA_DIR = Path(os.getenv("DATA_DIR", BACKEND_DIR / "data")).resolve()
  129. FRONTEND_BUILD_DIR = Path(os.getenv("FRONTEND_BUILD_DIR", BASE_DIR / "build")).resolve()
  130. try:
  131. CONFIG_DATA = json.loads((DATA_DIR / "config.json").read_text())
  132. except:
  133. CONFIG_DATA = {}
  134. ####################################
  135. # Config helpers
  136. ####################################
  137. def save_config():
  138. try:
  139. with open(f"{DATA_DIR}/config.json", "w") as f:
  140. json.dump(CONFIG_DATA, f, indent="\t")
  141. except Exception as e:
  142. log.exception(e)
  143. def get_config_value(config_path: str):
  144. path_parts = config_path.split(".")
  145. cur_config = CONFIG_DATA
  146. for key in path_parts:
  147. if key in cur_config:
  148. cur_config = cur_config[key]
  149. else:
  150. return None
  151. return cur_config
  152. T = TypeVar("T")
  153. class PersistentConfig(Generic[T]):
  154. def __init__(self, env_name: str, config_path: str, env_value: T):
  155. self.env_name = env_name
  156. self.config_path = config_path
  157. self.env_value = env_value
  158. self.config_value = get_config_value(config_path)
  159. if self.config_value is not None:
  160. log.info(f"'{env_name}' loaded from config.json")
  161. self.value = self.config_value
  162. else:
  163. self.value = env_value
  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 save(self):
  178. # Don't save if the value is the same as the env value and the config value
  179. if self.env_value == self.value:
  180. if self.config_value == self.value:
  181. return
  182. log.info(f"Saving '{self.env_name}' to config.json")
  183. path_parts = self.config_path.split(".")
  184. config = CONFIG_DATA
  185. for key in path_parts[:-1]:
  186. if key not in config:
  187. config[key] = {}
  188. config = config[key]
  189. config[path_parts[-1]] = self.value
  190. save_config()
  191. self.config_value = self.value
  192. class AppConfig:
  193. _state: dict[str, PersistentConfig]
  194. def __init__(self):
  195. super().__setattr__("_state", {})
  196. def __setattr__(self, key, value):
  197. if isinstance(value, PersistentConfig):
  198. self._state[key] = value
  199. else:
  200. self._state[key].value = value
  201. self._state[key].save()
  202. def __getattr__(self, key):
  203. return self._state[key].value
  204. ####################################
  205. # WEBUI_AUTH (Required for security)
  206. ####################################
  207. WEBUI_AUTH = os.environ.get("WEBUI_AUTH", "True").lower() == "true"
  208. WEBUI_AUTH_TRUSTED_EMAIL_HEADER = os.environ.get(
  209. "WEBUI_AUTH_TRUSTED_EMAIL_HEADER", None
  210. )
  211. JWT_EXPIRES_IN = PersistentConfig(
  212. "JWT_EXPIRES_IN", "auth.jwt_expiry", os.environ.get("JWT_EXPIRES_IN", "-1")
  213. )
  214. ####################################
  215. # OAuth config
  216. ####################################
  217. ENABLE_OAUTH_SIGNUP = PersistentConfig(
  218. "ENABLE_OAUTH_SIGNUP",
  219. "oauth.enable_signup",
  220. os.environ.get("ENABLE_OAUTH_SIGNUP", "False").lower() == "true",
  221. )
  222. OAUTH_PROVIDERS = {}
  223. if os.environ.get("GOOGLE_CLIENT_ID") and os.environ.get("GOOGLE_CLIENT_SECRET"):
  224. OAUTH_PROVIDERS["google"] = {
  225. "client_id": os.environ.get("GOOGLE_CLIENT_ID"),
  226. "client_secret": os.environ.get("GOOGLE_CLIENT_SECRET"),
  227. "server_metadata_url": "https://accounts.google.com/.well-known/openid-configuration",
  228. "scope": os.environ.get("GOOGLE_OAUTH_SCOPE", "openid email profile"),
  229. }
  230. if (
  231. os.environ.get("MICROSOFT_CLIENT_ID")
  232. and os.environ.get("MICROSOFT_CLIENT_SECRET")
  233. and os.environ.get("MICROSOFT_CLIENT_TENANT_ID")
  234. ):
  235. OAUTH_PROVIDERS["microsoft"] = {
  236. "client_id": os.environ.get("MICROSOFT_CLIENT_ID"),
  237. "client_secret": os.environ.get("MICROSOFT_CLIENT_SECRET"),
  238. "server_metadata_url": f"https://login.microsoftonline.com/{os.environ.get('MICROSOFT_CLIENT_TENANT_ID')}/v2.0/.well-known/openid-configuration",
  239. "scope": os.environ.get("MICROSOFT_OAUTH_SCOPE", "openid email profile"),
  240. }
  241. if (
  242. os.environ.get("OPENID_CLIENT_ID")
  243. and os.environ.get("OPENID_CLIENT_SECRET")
  244. and os.environ.get("OPENID_PROVIDER_URL")
  245. ):
  246. OAUTH_PROVIDERS["oidc"] = {
  247. "client_id": os.environ.get("OPENID_CLIENT_ID"),
  248. "client_secret": os.environ.get("OPENID_CLIENT_SECRET"),
  249. "server_metadata_url": os.environ.get("OPENID_PROVIDER_URL"),
  250. "scope": os.environ.get("OPENID_SCOPE", "openid email profile"),
  251. "name": os.environ.get("OPENID_PROVIDER_NAME", "SSO"),
  252. }
  253. ####################################
  254. # Static DIR
  255. ####################################
  256. STATIC_DIR = Path(os.getenv("STATIC_DIR", BACKEND_DIR / "static")).resolve()
  257. frontend_favicon = FRONTEND_BUILD_DIR / "favicon.png"
  258. if frontend_favicon.exists():
  259. shutil.copyfile(frontend_favicon, STATIC_DIR / "favicon.png")
  260. else:
  261. logging.warning(f"Frontend favicon not found at {frontend_favicon}")
  262. ####################################
  263. # CUSTOM_NAME
  264. ####################################
  265. CUSTOM_NAME = os.environ.get("CUSTOM_NAME", "")
  266. if CUSTOM_NAME:
  267. try:
  268. r = requests.get(f"https://api.openwebui.com/api/v1/custom/{CUSTOM_NAME}")
  269. data = r.json()
  270. if r.ok:
  271. if "logo" in data:
  272. WEBUI_FAVICON_URL = url = (
  273. f"https://api.openwebui.com{data['logo']}"
  274. if data["logo"][0] == "/"
  275. else data["logo"]
  276. )
  277. r = requests.get(url, stream=True)
  278. if r.status_code == 200:
  279. with open(f"{STATIC_DIR}/favicon.png", "wb") as f:
  280. r.raw.decode_content = True
  281. shutil.copyfileobj(r.raw, f)
  282. WEBUI_NAME = data["name"]
  283. except Exception as e:
  284. log.exception(e)
  285. pass
  286. ####################################
  287. # File Upload DIR
  288. ####################################
  289. UPLOAD_DIR = f"{DATA_DIR}/uploads"
  290. Path(UPLOAD_DIR).mkdir(parents=True, exist_ok=True)
  291. ####################################
  292. # Cache DIR
  293. ####################################
  294. CACHE_DIR = f"{DATA_DIR}/cache"
  295. Path(CACHE_DIR).mkdir(parents=True, exist_ok=True)
  296. ####################################
  297. # Docs DIR
  298. ####################################
  299. DOCS_DIR = os.getenv("DOCS_DIR", f"{DATA_DIR}/docs")
  300. Path(DOCS_DIR).mkdir(parents=True, exist_ok=True)
  301. ####################################
  302. # LITELLM_CONFIG
  303. ####################################
  304. def create_config_file(file_path):
  305. directory = os.path.dirname(file_path)
  306. # Check if directory exists, if not, create it
  307. if not os.path.exists(directory):
  308. os.makedirs(directory)
  309. # Data to write into the YAML file
  310. config_data = {
  311. "general_settings": {},
  312. "litellm_settings": {},
  313. "model_list": [],
  314. "router_settings": {},
  315. }
  316. # Write data to YAML file
  317. with open(file_path, "w") as file:
  318. yaml.dump(config_data, file)
  319. LITELLM_CONFIG_PATH = f"{DATA_DIR}/litellm/config.yaml"
  320. # if not os.path.exists(LITELLM_CONFIG_PATH):
  321. # log.info("Config file doesn't exist. Creating...")
  322. # create_config_file(LITELLM_CONFIG_PATH)
  323. # log.info("Config file created successfully.")
  324. ####################################
  325. # OLLAMA_BASE_URL
  326. ####################################
  327. ENABLE_OLLAMA_API = PersistentConfig(
  328. "ENABLE_OLLAMA_API",
  329. "ollama.enable",
  330. os.environ.get("ENABLE_OLLAMA_API", "True").lower() == "true",
  331. )
  332. OLLAMA_API_BASE_URL = os.environ.get(
  333. "OLLAMA_API_BASE_URL", "http://localhost:11434/api"
  334. )
  335. OLLAMA_BASE_URL = os.environ.get("OLLAMA_BASE_URL", "")
  336. K8S_FLAG = os.environ.get("K8S_FLAG", "")
  337. USE_OLLAMA_DOCKER = os.environ.get("USE_OLLAMA_DOCKER", "false")
  338. if OLLAMA_BASE_URL == "" and OLLAMA_API_BASE_URL != "":
  339. OLLAMA_BASE_URL = (
  340. OLLAMA_API_BASE_URL[:-4]
  341. if OLLAMA_API_BASE_URL.endswith("/api")
  342. else OLLAMA_API_BASE_URL
  343. )
  344. if ENV == "prod":
  345. if OLLAMA_BASE_URL == "/ollama" and not K8S_FLAG:
  346. if USE_OLLAMA_DOCKER.lower() == "true":
  347. # if you use all-in-one docker container (Open WebUI + Ollama)
  348. # with the docker build arg USE_OLLAMA=true (--build-arg="USE_OLLAMA=true") this only works with http://localhost:11434
  349. OLLAMA_BASE_URL = "http://localhost:11434"
  350. else:
  351. OLLAMA_BASE_URL = "http://host.docker.internal:11434"
  352. elif K8S_FLAG:
  353. OLLAMA_BASE_URL = "http://ollama-service.open-webui.svc.cluster.local:11434"
  354. OLLAMA_BASE_URLS = os.environ.get("OLLAMA_BASE_URLS", "")
  355. OLLAMA_BASE_URLS = OLLAMA_BASE_URLS if OLLAMA_BASE_URLS != "" else OLLAMA_BASE_URL
  356. OLLAMA_BASE_URLS = [url.strip() for url in OLLAMA_BASE_URLS.split(";")]
  357. OLLAMA_BASE_URLS = PersistentConfig(
  358. "OLLAMA_BASE_URLS", "ollama.base_urls", OLLAMA_BASE_URLS
  359. )
  360. ####################################
  361. # OPENAI_API
  362. ####################################
  363. ENABLE_OPENAI_API = PersistentConfig(
  364. "ENABLE_OPENAI_API",
  365. "openai.enable",
  366. os.environ.get("ENABLE_OPENAI_API", "True").lower() == "true",
  367. )
  368. OPENAI_API_KEY = os.environ.get("OPENAI_API_KEY", "")
  369. OPENAI_API_BASE_URL = os.environ.get("OPENAI_API_BASE_URL", "")
  370. if OPENAI_API_BASE_URL == "":
  371. OPENAI_API_BASE_URL = "https://api.openai.com/v1"
  372. OPENAI_API_KEYS = os.environ.get("OPENAI_API_KEYS", "")
  373. OPENAI_API_KEYS = OPENAI_API_KEYS if OPENAI_API_KEYS != "" else OPENAI_API_KEY
  374. OPENAI_API_KEYS = [url.strip() for url in OPENAI_API_KEYS.split(";")]
  375. OPENAI_API_KEYS = PersistentConfig(
  376. "OPENAI_API_KEYS", "openai.api_keys", OPENAI_API_KEYS
  377. )
  378. OPENAI_API_BASE_URLS = os.environ.get("OPENAI_API_BASE_URLS", "")
  379. OPENAI_API_BASE_URLS = (
  380. OPENAI_API_BASE_URLS if OPENAI_API_BASE_URLS != "" else OPENAI_API_BASE_URL
  381. )
  382. OPENAI_API_BASE_URLS = [
  383. url.strip() if url != "" else "https://api.openai.com/v1"
  384. for url in OPENAI_API_BASE_URLS.split(";")
  385. ]
  386. OPENAI_API_BASE_URLS = PersistentConfig(
  387. "OPENAI_API_BASE_URLS", "openai.api_base_urls", OPENAI_API_BASE_URLS
  388. )
  389. OPENAI_API_KEY = ""
  390. try:
  391. OPENAI_API_KEY = OPENAI_API_KEYS.value[
  392. OPENAI_API_BASE_URLS.value.index("https://api.openai.com/v1")
  393. ]
  394. except:
  395. pass
  396. OPENAI_API_BASE_URL = "https://api.openai.com/v1"
  397. ####################################
  398. # WEBUI
  399. ####################################
  400. ENABLE_SIGNUP = PersistentConfig(
  401. "ENABLE_SIGNUP",
  402. "ui.enable_signup",
  403. (
  404. False
  405. if not WEBUI_AUTH
  406. else os.environ.get("ENABLE_SIGNUP", "True").lower() == "true"
  407. ),
  408. )
  409. DEFAULT_MODELS = PersistentConfig(
  410. "DEFAULT_MODELS", "ui.default_models", os.environ.get("DEFAULT_MODELS", None)
  411. )
  412. DEFAULT_PROMPT_SUGGESTIONS = PersistentConfig(
  413. "DEFAULT_PROMPT_SUGGESTIONS",
  414. "ui.prompt_suggestions",
  415. [
  416. {
  417. "title": ["Help me study", "vocabulary for a college entrance exam"],
  418. "content": "Help me study vocabulary: write a sentence for me to fill in the blank, and I'll try to pick the correct option.",
  419. },
  420. {
  421. "title": ["Give me ideas", "for what to do with my kids' art"],
  422. "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.",
  423. },
  424. {
  425. "title": ["Tell me a fun fact", "about the Roman Empire"],
  426. "content": "Tell me a random fun fact about the Roman Empire",
  427. },
  428. {
  429. "title": ["Show me a code snippet", "of a website's sticky header"],
  430. "content": "Show me a code snippet of a website's sticky header in CSS and JavaScript.",
  431. },
  432. {
  433. "title": [
  434. "Explain options trading",
  435. "if I'm familiar with buying and selling stocks",
  436. ],
  437. "content": "Explain options trading in simple terms if I'm familiar with buying and selling stocks.",
  438. },
  439. {
  440. "title": ["Overcome procrastination", "give me tips"],
  441. "content": "Could you start by asking me about instances when I procrastinate the most and then give me some suggestions to overcome it?",
  442. },
  443. ],
  444. )
  445. DEFAULT_USER_ROLE = PersistentConfig(
  446. "DEFAULT_USER_ROLE",
  447. "ui.default_user_role",
  448. os.getenv("DEFAULT_USER_ROLE", "pending"),
  449. )
  450. USER_PERMISSIONS_CHAT_DELETION = (
  451. os.environ.get("USER_PERMISSIONS_CHAT_DELETION", "True").lower() == "true"
  452. )
  453. USER_PERMISSIONS = PersistentConfig(
  454. "USER_PERMISSIONS",
  455. "ui.user_permissions",
  456. {"chat": {"deletion": USER_PERMISSIONS_CHAT_DELETION}},
  457. )
  458. ENABLE_MODEL_FILTER = PersistentConfig(
  459. "ENABLE_MODEL_FILTER",
  460. "model_filter.enable",
  461. os.environ.get("ENABLE_MODEL_FILTER", "False").lower() == "true",
  462. )
  463. MODEL_FILTER_LIST = os.environ.get("MODEL_FILTER_LIST", "")
  464. MODEL_FILTER_LIST = PersistentConfig(
  465. "MODEL_FILTER_LIST",
  466. "model_filter.list",
  467. [model.strip() for model in MODEL_FILTER_LIST.split(";")],
  468. )
  469. WEBHOOK_URL = PersistentConfig(
  470. "WEBHOOK_URL", "webhook_url", os.environ.get("WEBHOOK_URL", "")
  471. )
  472. ENABLE_ADMIN_EXPORT = os.environ.get("ENABLE_ADMIN_EXPORT", "True").lower() == "true"
  473. ####################################
  474. # WEBUI_SECRET_KEY
  475. ####################################
  476. WEBUI_SECRET_KEY = os.environ.get(
  477. "WEBUI_SECRET_KEY",
  478. os.environ.get(
  479. "WEBUI_JWT_SECRET_KEY", "t0p-s3cr3t"
  480. ), # DEPRECATED: remove at next major version
  481. )
  482. if WEBUI_AUTH and WEBUI_SECRET_KEY == "":
  483. raise ValueError(ERROR_MESSAGES.ENV_VAR_NOT_FOUND)
  484. ####################################
  485. # RAG
  486. ####################################
  487. CHROMA_DATA_PATH = f"{DATA_DIR}/vector_db"
  488. CHROMA_TENANT = os.environ.get("CHROMA_TENANT", chromadb.DEFAULT_TENANT)
  489. CHROMA_DATABASE = os.environ.get("CHROMA_DATABASE", chromadb.DEFAULT_DATABASE)
  490. CHROMA_HTTP_HOST = os.environ.get("CHROMA_HTTP_HOST", "")
  491. CHROMA_HTTP_PORT = int(os.environ.get("CHROMA_HTTP_PORT", "8000"))
  492. # Comma-separated list of header=value pairs
  493. CHROMA_HTTP_HEADERS = os.environ.get("CHROMA_HTTP_HEADERS", "")
  494. if CHROMA_HTTP_HEADERS:
  495. CHROMA_HTTP_HEADERS = dict(
  496. [pair.split("=") for pair in CHROMA_HTTP_HEADERS.split(",")]
  497. )
  498. else:
  499. CHROMA_HTTP_HEADERS = None
  500. CHROMA_HTTP_SSL = os.environ.get("CHROMA_HTTP_SSL", "false").lower() == "true"
  501. # 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)
  502. RAG_TOP_K = PersistentConfig(
  503. "RAG_TOP_K", "rag.top_k", int(os.environ.get("RAG_TOP_K", "5"))
  504. )
  505. RAG_RELEVANCE_THRESHOLD = PersistentConfig(
  506. "RAG_RELEVANCE_THRESHOLD",
  507. "rag.relevance_threshold",
  508. float(os.environ.get("RAG_RELEVANCE_THRESHOLD", "0.0")),
  509. )
  510. ENABLE_RAG_HYBRID_SEARCH = PersistentConfig(
  511. "ENABLE_RAG_HYBRID_SEARCH",
  512. "rag.enable_hybrid_search",
  513. os.environ.get("ENABLE_RAG_HYBRID_SEARCH", "").lower() == "true",
  514. )
  515. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = PersistentConfig(
  516. "ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION",
  517. "rag.enable_web_loader_ssl_verification",
  518. os.environ.get("ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION", "True").lower() == "true",
  519. )
  520. RAG_EMBEDDING_ENGINE = PersistentConfig(
  521. "RAG_EMBEDDING_ENGINE",
  522. "rag.embedding_engine",
  523. os.environ.get("RAG_EMBEDDING_ENGINE", ""),
  524. )
  525. PDF_EXTRACT_IMAGES = PersistentConfig(
  526. "PDF_EXTRACT_IMAGES",
  527. "rag.pdf_extract_images",
  528. os.environ.get("PDF_EXTRACT_IMAGES", "False").lower() == "true",
  529. )
  530. RAG_EMBEDDING_MODEL = PersistentConfig(
  531. "RAG_EMBEDDING_MODEL",
  532. "rag.embedding_model",
  533. os.environ.get("RAG_EMBEDDING_MODEL", "sentence-transformers/all-MiniLM-L6-v2"),
  534. )
  535. log.info(f"Embedding model set: {RAG_EMBEDDING_MODEL.value}"),
  536. RAG_EMBEDDING_MODEL_AUTO_UPDATE = (
  537. os.environ.get("RAG_EMBEDDING_MODEL_AUTO_UPDATE", "").lower() == "true"
  538. )
  539. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE = (
  540. os.environ.get("RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE", "").lower() == "true"
  541. )
  542. RAG_RERANKING_MODEL = PersistentConfig(
  543. "RAG_RERANKING_MODEL",
  544. "rag.reranking_model",
  545. os.environ.get("RAG_RERANKING_MODEL", ""),
  546. )
  547. if RAG_RERANKING_MODEL.value != "":
  548. log.info(f"Reranking model set: {RAG_RERANKING_MODEL.value}"),
  549. RAG_RERANKING_MODEL_AUTO_UPDATE = (
  550. os.environ.get("RAG_RERANKING_MODEL_AUTO_UPDATE", "").lower() == "true"
  551. )
  552. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE = (
  553. os.environ.get("RAG_RERANKING_MODEL_TRUST_REMOTE_CODE", "").lower() == "true"
  554. )
  555. if CHROMA_HTTP_HOST != "":
  556. CHROMA_CLIENT = chromadb.HttpClient(
  557. host=CHROMA_HTTP_HOST,
  558. port=CHROMA_HTTP_PORT,
  559. headers=CHROMA_HTTP_HEADERS,
  560. ssl=CHROMA_HTTP_SSL,
  561. tenant=CHROMA_TENANT,
  562. database=CHROMA_DATABASE,
  563. settings=Settings(allow_reset=True, anonymized_telemetry=False),
  564. )
  565. else:
  566. CHROMA_CLIENT = chromadb.PersistentClient(
  567. path=CHROMA_DATA_PATH,
  568. settings=Settings(allow_reset=True, anonymized_telemetry=False),
  569. tenant=CHROMA_TENANT,
  570. database=CHROMA_DATABASE,
  571. )
  572. # device type embedding models - "cpu" (default), "cuda" (nvidia gpu required) or "mps" (apple silicon) - choosing this right can lead to better performance
  573. USE_CUDA = os.environ.get("USE_CUDA_DOCKER", "false")
  574. if USE_CUDA.lower() == "true":
  575. DEVICE_TYPE = "cuda"
  576. else:
  577. DEVICE_TYPE = "cpu"
  578. CHUNK_SIZE = PersistentConfig(
  579. "CHUNK_SIZE", "rag.chunk_size", int(os.environ.get("CHUNK_SIZE", "1500"))
  580. )
  581. CHUNK_OVERLAP = PersistentConfig(
  582. "CHUNK_OVERLAP",
  583. "rag.chunk_overlap",
  584. int(os.environ.get("CHUNK_OVERLAP", "100")),
  585. )
  586. DEFAULT_RAG_TEMPLATE = """Use the following context as your learned knowledge, inside <context></context> XML tags.
  587. <context>
  588. [context]
  589. </context>
  590. When answer to user:
  591. - If you don't know, just say that you don't know.
  592. - If you don't know when you are not sure, ask for clarification.
  593. Avoid mentioning that you obtained the information from the context.
  594. And answer according to the language of the user's question.
  595. Given the context information, answer the query.
  596. Query: [query]"""
  597. RAG_TEMPLATE = PersistentConfig(
  598. "RAG_TEMPLATE",
  599. "rag.template",
  600. os.environ.get("RAG_TEMPLATE", DEFAULT_RAG_TEMPLATE),
  601. )
  602. RAG_OPENAI_API_BASE_URL = PersistentConfig(
  603. "RAG_OPENAI_API_BASE_URL",
  604. "rag.openai_api_base_url",
  605. os.getenv("RAG_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  606. )
  607. RAG_OPENAI_API_KEY = PersistentConfig(
  608. "RAG_OPENAI_API_KEY",
  609. "rag.openai_api_key",
  610. os.getenv("RAG_OPENAI_API_KEY", OPENAI_API_KEY),
  611. )
  612. ENABLE_RAG_LOCAL_WEB_FETCH = (
  613. os.getenv("ENABLE_RAG_LOCAL_WEB_FETCH", "False").lower() == "true"
  614. )
  615. YOUTUBE_LOADER_LANGUAGE = PersistentConfig(
  616. "YOUTUBE_LOADER_LANGUAGE",
  617. "rag.youtube_loader_language",
  618. os.getenv("YOUTUBE_LOADER_LANGUAGE", "en").split(","),
  619. )
  620. ####################################
  621. # Transcribe
  622. ####################################
  623. WHISPER_MODEL = os.getenv("WHISPER_MODEL", "base")
  624. WHISPER_MODEL_DIR = os.getenv("WHISPER_MODEL_DIR", f"{CACHE_DIR}/whisper/models")
  625. WHISPER_MODEL_AUTO_UPDATE = (
  626. os.environ.get("WHISPER_MODEL_AUTO_UPDATE", "").lower() == "true"
  627. )
  628. ####################################
  629. # Images
  630. ####################################
  631. IMAGE_GENERATION_ENGINE = PersistentConfig(
  632. "IMAGE_GENERATION_ENGINE",
  633. "image_generation.engine",
  634. os.getenv("IMAGE_GENERATION_ENGINE", ""),
  635. )
  636. ENABLE_IMAGE_GENERATION = PersistentConfig(
  637. "ENABLE_IMAGE_GENERATION",
  638. "image_generation.enable",
  639. os.environ.get("ENABLE_IMAGE_GENERATION", "").lower() == "true",
  640. )
  641. AUTOMATIC1111_BASE_URL = PersistentConfig(
  642. "AUTOMATIC1111_BASE_URL",
  643. "image_generation.automatic1111.base_url",
  644. os.getenv("AUTOMATIC1111_BASE_URL", ""),
  645. )
  646. COMFYUI_BASE_URL = PersistentConfig(
  647. "COMFYUI_BASE_URL",
  648. "image_generation.comfyui.base_url",
  649. os.getenv("COMFYUI_BASE_URL", ""),
  650. )
  651. IMAGES_OPENAI_API_BASE_URL = PersistentConfig(
  652. "IMAGES_OPENAI_API_BASE_URL",
  653. "image_generation.openai.api_base_url",
  654. os.getenv("IMAGES_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  655. )
  656. IMAGES_OPENAI_API_KEY = PersistentConfig(
  657. "IMAGES_OPENAI_API_KEY",
  658. "image_generation.openai.api_key",
  659. os.getenv("IMAGES_OPENAI_API_KEY", OPENAI_API_KEY),
  660. )
  661. IMAGE_SIZE = PersistentConfig(
  662. "IMAGE_SIZE", "image_generation.size", os.getenv("IMAGE_SIZE", "512x512")
  663. )
  664. IMAGE_STEPS = PersistentConfig(
  665. "IMAGE_STEPS", "image_generation.steps", int(os.getenv("IMAGE_STEPS", 50))
  666. )
  667. IMAGE_GENERATION_MODEL = PersistentConfig(
  668. "IMAGE_GENERATION_MODEL",
  669. "image_generation.model",
  670. os.getenv("IMAGE_GENERATION_MODEL", ""),
  671. )
  672. ####################################
  673. # Audio
  674. ####################################
  675. AUDIO_OPENAI_API_BASE_URL = PersistentConfig(
  676. "AUDIO_OPENAI_API_BASE_URL",
  677. "audio.openai.api_base_url",
  678. os.getenv("AUDIO_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  679. )
  680. AUDIO_OPENAI_API_KEY = PersistentConfig(
  681. "AUDIO_OPENAI_API_KEY",
  682. "audio.openai.api_key",
  683. os.getenv("AUDIO_OPENAI_API_KEY", OPENAI_API_KEY),
  684. )
  685. AUDIO_OPENAI_API_MODEL = PersistentConfig(
  686. "AUDIO_OPENAI_API_MODEL",
  687. "audio.openai.api_model",
  688. os.getenv("AUDIO_OPENAI_API_MODEL", "tts-1"),
  689. )
  690. AUDIO_OPENAI_API_VOICE = PersistentConfig(
  691. "AUDIO_OPENAI_API_VOICE",
  692. "audio.openai.api_voice",
  693. os.getenv("AUDIO_OPENAI_API_VOICE", "alloy"),
  694. )
  695. ####################################
  696. # Database
  697. ####################################
  698. DATABASE_URL = os.environ.get("DATABASE_URL", f"sqlite:///{DATA_DIR}/webui.db")