config.py 47 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696
  1. import json
  2. import logging
  3. import os
  4. import shutil
  5. from datetime import datetime
  6. from pathlib import Path
  7. from typing import Generic, Optional, TypeVar
  8. from urllib.parse import urlparse
  9. import chromadb
  10. import requests
  11. import yaml
  12. from open_webui.apps.webui.internal.db import Base, get_db
  13. from open_webui.env import (
  14. OPEN_WEBUI_DIR,
  15. DATA_DIR,
  16. ENV,
  17. FRONTEND_BUILD_DIR,
  18. WEBUI_AUTH,
  19. WEBUI_FAVICON_URL,
  20. WEBUI_NAME,
  21. log,
  22. DATABASE_URL,
  23. )
  24. from pydantic import BaseModel
  25. from sqlalchemy import JSON, Column, DateTime, Integer, func
  26. class EndpointFilter(logging.Filter):
  27. def filter(self, record: logging.LogRecord) -> bool:
  28. return record.getMessage().find("/health") == -1
  29. # Filter out /endpoint
  30. logging.getLogger("uvicorn.access").addFilter(EndpointFilter())
  31. ####################################
  32. # Config helpers
  33. ####################################
  34. # Function to run the alembic migrations
  35. def run_migrations():
  36. print("Running migrations")
  37. try:
  38. from alembic import command
  39. from alembic.config import Config
  40. alembic_cfg = Config(OPEN_WEBUI_DIR / "alembic.ini")
  41. # Set the script location dynamically
  42. migrations_path = OPEN_WEBUI_DIR / "migrations"
  43. alembic_cfg.set_main_option("script_location", str(migrations_path))
  44. command.upgrade(alembic_cfg, "head")
  45. except Exception as e:
  46. print(f"Error: {e}")
  47. run_migrations()
  48. class Config(Base):
  49. __tablename__ = "config"
  50. id = Column(Integer, primary_key=True)
  51. data = Column(JSON, nullable=False)
  52. version = Column(Integer, nullable=False, default=0)
  53. created_at = Column(DateTime, nullable=False, server_default=func.now())
  54. updated_at = Column(DateTime, nullable=True, onupdate=func.now())
  55. def load_json_config():
  56. with open(f"{DATA_DIR}/config.json", "r") as file:
  57. return json.load(file)
  58. def save_to_db(data):
  59. with get_db() as db:
  60. existing_config = db.query(Config).first()
  61. if not existing_config:
  62. new_config = Config(data=data, version=0)
  63. db.add(new_config)
  64. else:
  65. existing_config.data = data
  66. existing_config.updated_at = datetime.now()
  67. db.add(existing_config)
  68. db.commit()
  69. def reset_config():
  70. with get_db() as db:
  71. db.query(Config).delete()
  72. db.commit()
  73. # When initializing, check if config.json exists and migrate it to the database
  74. if os.path.exists(f"{DATA_DIR}/config.json"):
  75. data = load_json_config()
  76. save_to_db(data)
  77. os.rename(f"{DATA_DIR}/config.json", f"{DATA_DIR}/old_config.json")
  78. DEFAULT_CONFIG = {
  79. "version": 0,
  80. "ui": {
  81. "default_locale": "",
  82. "prompt_suggestions": [
  83. {
  84. "title": [
  85. "Help me study",
  86. "vocabulary for a college entrance exam",
  87. ],
  88. "content": "Help me study vocabulary: write a sentence for me to fill in the blank, and I'll try to pick the correct option.",
  89. },
  90. {
  91. "title": [
  92. "Give me ideas",
  93. "for what to do with my kids' art",
  94. ],
  95. "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.",
  96. },
  97. {
  98. "title": ["Tell me a fun fact", "about the Roman Empire"],
  99. "content": "Tell me a random fun fact about the Roman Empire",
  100. },
  101. {
  102. "title": [
  103. "Show me a code snippet",
  104. "of a website's sticky header",
  105. ],
  106. "content": "Show me a code snippet of a website's sticky header in CSS and JavaScript.",
  107. },
  108. {
  109. "title": [
  110. "Explain options trading",
  111. "if I'm familiar with buying and selling stocks",
  112. ],
  113. "content": "Explain options trading in simple terms if I'm familiar with buying and selling stocks.",
  114. },
  115. {
  116. "title": ["Overcome procrastination", "give me tips"],
  117. "content": "Could you start by asking me about instances when I procrastinate the most and then give me some suggestions to overcome it?",
  118. },
  119. {
  120. "title": [
  121. "Grammar check",
  122. "rewrite it for better readability ",
  123. ],
  124. "content": 'Check the following sentence for grammar and clarity: "[sentence]". Rewrite it for better readability while maintaining its original meaning.',
  125. },
  126. ],
  127. },
  128. }
  129. def get_config():
  130. with get_db() as db:
  131. config_entry = db.query(Config).order_by(Config.id.desc()).first()
  132. return config_entry.data if config_entry else DEFAULT_CONFIG
  133. CONFIG_DATA = get_config()
  134. def get_config_value(config_path: str):
  135. path_parts = config_path.split(".")
  136. cur_config = CONFIG_DATA
  137. for key in path_parts:
  138. if key in cur_config:
  139. cur_config = cur_config[key]
  140. else:
  141. return None
  142. return cur_config
  143. PERSISTENT_CONFIG_REGISTRY = []
  144. def save_config(config):
  145. global CONFIG_DATA
  146. global PERSISTENT_CONFIG_REGISTRY
  147. try:
  148. save_to_db(config)
  149. CONFIG_DATA = config
  150. # Trigger updates on all registered PersistentConfig entries
  151. for config_item in PERSISTENT_CONFIG_REGISTRY:
  152. config_item.update()
  153. except Exception as e:
  154. log.exception(e)
  155. return False
  156. return True
  157. T = TypeVar("T")
  158. class PersistentConfig(Generic[T]):
  159. def __init__(self, env_name: str, config_path: str, env_value: T):
  160. self.env_name = env_name
  161. self.config_path = config_path
  162. self.env_value = env_value
  163. self.config_value = get_config_value(config_path)
  164. if self.config_value is not None:
  165. log.info(f"'{env_name}' loaded from the latest database entry")
  166. self.value = self.config_value
  167. else:
  168. self.value = env_value
  169. PERSISTENT_CONFIG_REGISTRY.append(self)
  170. def __str__(self):
  171. return str(self.value)
  172. @property
  173. def __dict__(self):
  174. raise TypeError(
  175. "PersistentConfig object cannot be converted to dict, use config_get or .value instead."
  176. )
  177. def __getattribute__(self, item):
  178. if item == "__dict__":
  179. raise TypeError(
  180. "PersistentConfig object cannot be converted to dict, use config_get or .value instead."
  181. )
  182. return super().__getattribute__(item)
  183. def update(self):
  184. new_value = get_config_value(self.config_path)
  185. if new_value is not None:
  186. self.value = new_value
  187. log.info(f"Updated {self.env_name} to new value {self.value}")
  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_PICTURE_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. ENABLE_OAUTH_ROLE_MANAGEMENT = PersistentConfig(
  322. "ENABLE_OAUTH_ROLE_MANAGEMENT",
  323. "oauth.enable_role_mapping",
  324. os.environ.get("ENABLE_OAUTH_ROLE_MANAGEMENT", "False").lower() == "true",
  325. )
  326. OAUTH_ROLES_CLAIM = PersistentConfig(
  327. "OAUTH_ROLES_CLAIM",
  328. "oauth.roles_claim",
  329. os.environ.get("OAUTH_ROLES_CLAIM", "roles"),
  330. )
  331. OAUTH_ALLOWED_ROLES = PersistentConfig(
  332. "OAUTH_ALLOWED_ROLES",
  333. "oauth.allowed_roles",
  334. [
  335. role.strip()
  336. for role in os.environ.get("OAUTH_ALLOWED_ROLES", "user,admin").split(",")
  337. ],
  338. )
  339. OAUTH_ADMIN_ROLES = PersistentConfig(
  340. "OAUTH_ADMIN_ROLES",
  341. "oauth.admin_roles",
  342. [role.strip() for role in os.environ.get("OAUTH_ADMIN_ROLES", "admin").split(",")],
  343. )
  344. def load_oauth_providers():
  345. OAUTH_PROVIDERS.clear()
  346. if GOOGLE_CLIENT_ID.value and GOOGLE_CLIENT_SECRET.value:
  347. OAUTH_PROVIDERS["google"] = {
  348. "client_id": GOOGLE_CLIENT_ID.value,
  349. "client_secret": GOOGLE_CLIENT_SECRET.value,
  350. "server_metadata_url": "https://accounts.google.com/.well-known/openid-configuration",
  351. "scope": GOOGLE_OAUTH_SCOPE.value,
  352. "redirect_uri": GOOGLE_REDIRECT_URI.value,
  353. }
  354. if (
  355. MICROSOFT_CLIENT_ID.value
  356. and MICROSOFT_CLIENT_SECRET.value
  357. and MICROSOFT_CLIENT_TENANT_ID.value
  358. ):
  359. OAUTH_PROVIDERS["microsoft"] = {
  360. "client_id": MICROSOFT_CLIENT_ID.value,
  361. "client_secret": MICROSOFT_CLIENT_SECRET.value,
  362. "server_metadata_url": f"https://login.microsoftonline.com/{MICROSOFT_CLIENT_TENANT_ID.value}/v2.0/.well-known/openid-configuration",
  363. "scope": MICROSOFT_OAUTH_SCOPE.value,
  364. "redirect_uri": MICROSOFT_REDIRECT_URI.value,
  365. }
  366. if (
  367. OAUTH_CLIENT_ID.value
  368. and OAUTH_CLIENT_SECRET.value
  369. and OPENID_PROVIDER_URL.value
  370. ):
  371. OAUTH_PROVIDERS["oidc"] = {
  372. "client_id": OAUTH_CLIENT_ID.value,
  373. "client_secret": OAUTH_CLIENT_SECRET.value,
  374. "server_metadata_url": OPENID_PROVIDER_URL.value,
  375. "scope": OAUTH_SCOPES.value,
  376. "name": OAUTH_PROVIDER_NAME.value,
  377. "redirect_uri": OPENID_REDIRECT_URI.value,
  378. }
  379. load_oauth_providers()
  380. ####################################
  381. # Static DIR
  382. ####################################
  383. STATIC_DIR = Path(os.getenv("STATIC_DIR", OPEN_WEBUI_DIR / "static")).resolve()
  384. frontend_favicon = FRONTEND_BUILD_DIR / "static" / "favicon.png"
  385. if frontend_favicon.exists():
  386. try:
  387. shutil.copyfile(frontend_favicon, STATIC_DIR / "favicon.png")
  388. except Exception as e:
  389. logging.error(f"An error occurred: {e}")
  390. else:
  391. logging.warning(f"Frontend favicon not found at {frontend_favicon}")
  392. frontend_splash = FRONTEND_BUILD_DIR / "static" / "splash.png"
  393. if frontend_splash.exists():
  394. try:
  395. shutil.copyfile(frontend_splash, STATIC_DIR / "splash.png")
  396. except Exception as e:
  397. logging.error(f"An error occurred: {e}")
  398. else:
  399. logging.warning(f"Frontend splash not found at {frontend_splash}")
  400. ####################################
  401. # CUSTOM_NAME
  402. ####################################
  403. CUSTOM_NAME = os.environ.get("CUSTOM_NAME", "")
  404. if CUSTOM_NAME:
  405. try:
  406. r = requests.get(f"https://api.openwebui.com/api/v1/custom/{CUSTOM_NAME}")
  407. data = r.json()
  408. if r.ok:
  409. if "logo" in data:
  410. WEBUI_FAVICON_URL = url = (
  411. f"https://api.openwebui.com{data['logo']}"
  412. if data["logo"][0] == "/"
  413. else data["logo"]
  414. )
  415. r = requests.get(url, stream=True)
  416. if r.status_code == 200:
  417. with open(f"{STATIC_DIR}/favicon.png", "wb") as f:
  418. r.raw.decode_content = True
  419. shutil.copyfileobj(r.raw, f)
  420. if "splash" in data:
  421. url = (
  422. f"https://api.openwebui.com{data['splash']}"
  423. if data["splash"][0] == "/"
  424. else data["splash"]
  425. )
  426. r = requests.get(url, stream=True)
  427. if r.status_code == 200:
  428. with open(f"{STATIC_DIR}/splash.png", "wb") as f:
  429. r.raw.decode_content = True
  430. shutil.copyfileobj(r.raw, f)
  431. WEBUI_NAME = data["name"]
  432. except Exception as e:
  433. log.exception(e)
  434. pass
  435. ####################################
  436. # STORAGE PROVIDER
  437. ####################################
  438. STORAGE_PROVIDER = os.environ.get("STORAGE_PROVIDER", "") # defaults to local, s3
  439. S3_ACCESS_KEY_ID = os.environ.get("S3_ACCESS_KEY_ID", None)
  440. S3_SECRET_ACCESS_KEY = os.environ.get("S3_SECRET_ACCESS_KEY", None)
  441. S3_REGION_NAME = os.environ.get("S3_REGION_NAME", None)
  442. S3_BUCKET_NAME = os.environ.get("S3_BUCKET_NAME", None)
  443. S3_ENDPOINT_URL = os.environ.get("S3_ENDPOINT_URL", None)
  444. ####################################
  445. # File Upload DIR
  446. ####################################
  447. UPLOAD_DIR = f"{DATA_DIR}/uploads"
  448. Path(UPLOAD_DIR).mkdir(parents=True, exist_ok=True)
  449. ####################################
  450. # Cache DIR
  451. ####################################
  452. CACHE_DIR = f"{DATA_DIR}/cache"
  453. Path(CACHE_DIR).mkdir(parents=True, exist_ok=True)
  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. K8S_FLAG = os.environ.get("K8S_FLAG", "")
  467. USE_OLLAMA_DOCKER = os.environ.get("USE_OLLAMA_DOCKER", "false")
  468. if OLLAMA_BASE_URL == "" and OLLAMA_API_BASE_URL != "":
  469. OLLAMA_BASE_URL = (
  470. OLLAMA_API_BASE_URL[:-4]
  471. if OLLAMA_API_BASE_URL.endswith("/api")
  472. else OLLAMA_API_BASE_URL
  473. )
  474. if ENV == "prod":
  475. if OLLAMA_BASE_URL == "/ollama" and not K8S_FLAG:
  476. if USE_OLLAMA_DOCKER.lower() == "true":
  477. # if you use all-in-one docker container (Open WebUI + Ollama)
  478. # with the docker build arg USE_OLLAMA=true (--build-arg="USE_OLLAMA=true") this only works with http://localhost:11434
  479. OLLAMA_BASE_URL = "http://localhost:11434"
  480. else:
  481. OLLAMA_BASE_URL = "http://host.docker.internal:11434"
  482. elif K8S_FLAG:
  483. OLLAMA_BASE_URL = "http://ollama-service.open-webui.svc.cluster.local:11434"
  484. OLLAMA_BASE_URLS = os.environ.get("OLLAMA_BASE_URLS", "")
  485. OLLAMA_BASE_URLS = OLLAMA_BASE_URLS if OLLAMA_BASE_URLS != "" else OLLAMA_BASE_URL
  486. OLLAMA_BASE_URLS = [url.strip() for url in OLLAMA_BASE_URLS.split(";")]
  487. OLLAMA_BASE_URLS = PersistentConfig(
  488. "OLLAMA_BASE_URLS", "ollama.base_urls", OLLAMA_BASE_URLS
  489. )
  490. OLLAMA_API_CONFIGS = PersistentConfig(
  491. "OLLAMA_API_CONFIGS",
  492. "ollama.api_configs",
  493. {},
  494. )
  495. ####################################
  496. # OPENAI_API
  497. ####################################
  498. ENABLE_OPENAI_API = PersistentConfig(
  499. "ENABLE_OPENAI_API",
  500. "openai.enable",
  501. os.environ.get("ENABLE_OPENAI_API", "True").lower() == "true",
  502. )
  503. OPENAI_API_KEY = os.environ.get("OPENAI_API_KEY", "")
  504. OPENAI_API_BASE_URL = os.environ.get("OPENAI_API_BASE_URL", "")
  505. if OPENAI_API_BASE_URL == "":
  506. OPENAI_API_BASE_URL = "https://api.openai.com/v1"
  507. OPENAI_API_KEYS = os.environ.get("OPENAI_API_KEYS", "")
  508. OPENAI_API_KEYS = OPENAI_API_KEYS if OPENAI_API_KEYS != "" else OPENAI_API_KEY
  509. OPENAI_API_KEYS = [url.strip() for url in OPENAI_API_KEYS.split(";")]
  510. OPENAI_API_KEYS = PersistentConfig(
  511. "OPENAI_API_KEYS", "openai.api_keys", OPENAI_API_KEYS
  512. )
  513. OPENAI_API_BASE_URLS = os.environ.get("OPENAI_API_BASE_URLS", "")
  514. OPENAI_API_BASE_URLS = (
  515. OPENAI_API_BASE_URLS if OPENAI_API_BASE_URLS != "" else OPENAI_API_BASE_URL
  516. )
  517. OPENAI_API_BASE_URLS = [
  518. url.strip() if url != "" else "https://api.openai.com/v1"
  519. for url in OPENAI_API_BASE_URLS.split(";")
  520. ]
  521. OPENAI_API_BASE_URLS = PersistentConfig(
  522. "OPENAI_API_BASE_URLS", "openai.api_base_urls", OPENAI_API_BASE_URLS
  523. )
  524. OPENAI_API_CONFIGS = PersistentConfig(
  525. "OPENAI_API_CONFIGS",
  526. "openai.api_configs",
  527. {},
  528. )
  529. # Get the actual OpenAI API key based on the base URL
  530. OPENAI_API_KEY = ""
  531. try:
  532. OPENAI_API_KEY = OPENAI_API_KEYS.value[
  533. OPENAI_API_BASE_URLS.value.index("https://api.openai.com/v1")
  534. ]
  535. except Exception:
  536. pass
  537. OPENAI_API_BASE_URL = "https://api.openai.com/v1"
  538. ####################################
  539. # WEBUI
  540. ####################################
  541. ENABLE_SIGNUP = PersistentConfig(
  542. "ENABLE_SIGNUP",
  543. "ui.enable_signup",
  544. (
  545. False
  546. if not WEBUI_AUTH
  547. else os.environ.get("ENABLE_SIGNUP", "True").lower() == "true"
  548. ),
  549. )
  550. ENABLE_LOGIN_FORM = PersistentConfig(
  551. "ENABLE_LOGIN_FORM",
  552. "ui.ENABLE_LOGIN_FORM",
  553. os.environ.get("ENABLE_LOGIN_FORM", "True").lower() == "true",
  554. )
  555. DEFAULT_LOCALE = PersistentConfig(
  556. "DEFAULT_LOCALE",
  557. "ui.default_locale",
  558. os.environ.get("DEFAULT_LOCALE", ""),
  559. )
  560. DEFAULT_MODELS = PersistentConfig(
  561. "DEFAULT_MODELS", "ui.default_models", os.environ.get("DEFAULT_MODELS", None)
  562. )
  563. DEFAULT_PROMPT_SUGGESTIONS = PersistentConfig(
  564. "DEFAULT_PROMPT_SUGGESTIONS",
  565. "ui.prompt_suggestions",
  566. [
  567. {
  568. "title": ["Help me study", "vocabulary for a college entrance exam"],
  569. "content": "Help me study vocabulary: write a sentence for me to fill in the blank, and I'll try to pick the correct option.",
  570. },
  571. {
  572. "title": ["Give me ideas", "for what to do with my kids' art"],
  573. "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.",
  574. },
  575. {
  576. "title": ["Tell me a fun fact", "about the Roman Empire"],
  577. "content": "Tell me a random fun fact about the Roman Empire",
  578. },
  579. {
  580. "title": ["Show me a code snippet", "of a website's sticky header"],
  581. "content": "Show me a code snippet of a website's sticky header in CSS and JavaScript.",
  582. },
  583. {
  584. "title": [
  585. "Explain options trading",
  586. "if I'm familiar with buying and selling stocks",
  587. ],
  588. "content": "Explain options trading in simple terms if I'm familiar with buying and selling stocks.",
  589. },
  590. {
  591. "title": ["Overcome procrastination", "give me tips"],
  592. "content": "Could you start by asking me about instances when I procrastinate the most and then give me some suggestions to overcome it?",
  593. },
  594. ],
  595. )
  596. DEFAULT_USER_ROLE = PersistentConfig(
  597. "DEFAULT_USER_ROLE",
  598. "ui.default_user_role",
  599. os.getenv("DEFAULT_USER_ROLE", "pending"),
  600. )
  601. USER_PERMISSIONS_WORKSPACE_MODELS_ACCESS = (
  602. os.environ.get("USER_PERMISSIONS_WORKSPACE_MODELS_ACCESS", "False").lower()
  603. == "true"
  604. )
  605. USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ACCESS = (
  606. os.environ.get("USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ACCESS", "False").lower()
  607. == "true"
  608. )
  609. USER_PERMISSIONS_WORKSPACE_PROMPTS_ACCESS = (
  610. os.environ.get("USER_PERMISSIONS_WORKSPACE_PROMPTS_ACCESS", "False").lower()
  611. == "true"
  612. )
  613. USER_PERMISSIONS_WORKSPACE_TOOLS_ACCESS = (
  614. os.environ.get("USER_PERMISSIONS_WORKSPACE_TOOLS_ACCESS", "False").lower() == "true"
  615. )
  616. USER_PERMISSIONS_CHAT_FILE_UPLOAD = (
  617. os.environ.get("USER_PERMISSIONS_CHAT_FILE_UPLOAD", "True").lower() == "true"
  618. )
  619. USER_PERMISSIONS_CHAT_DELETE = (
  620. os.environ.get("USER_PERMISSIONS_CHAT_DELETE", "True").lower() == "true"
  621. )
  622. USER_PERMISSIONS_CHAT_EDIT = (
  623. os.environ.get("USER_PERMISSIONS_CHAT_EDIT", "True").lower() == "true"
  624. )
  625. USER_PERMISSIONS_CHAT_TEMPORARY = (
  626. os.environ.get("USER_PERMISSIONS_CHAT_TEMPORARY", "True").lower() == "true"
  627. )
  628. USER_PERMISSIONS = PersistentConfig(
  629. "USER_PERMISSIONS",
  630. "user.permissions",
  631. {
  632. "workspace": {
  633. "models": USER_PERMISSIONS_WORKSPACE_MODELS_ACCESS,
  634. "knowledge": USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ACCESS,
  635. "prompts": USER_PERMISSIONS_WORKSPACE_PROMPTS_ACCESS,
  636. "tools": USER_PERMISSIONS_WORKSPACE_TOOLS_ACCESS,
  637. },
  638. "chat": {
  639. "file_upload": USER_PERMISSIONS_CHAT_FILE_UPLOAD,
  640. "delete": USER_PERMISSIONS_CHAT_DELETE,
  641. "edit": USER_PERMISSIONS_CHAT_EDIT,
  642. "temporary": USER_PERMISSIONS_CHAT_TEMPORARY,
  643. },
  644. },
  645. )
  646. ENABLE_EVALUATION_ARENA_MODELS = PersistentConfig(
  647. "ENABLE_EVALUATION_ARENA_MODELS",
  648. "evaluation.arena.enable",
  649. os.environ.get("ENABLE_EVALUATION_ARENA_MODELS", "True").lower() == "true",
  650. )
  651. EVALUATION_ARENA_MODELS = PersistentConfig(
  652. "EVALUATION_ARENA_MODELS",
  653. "evaluation.arena.models",
  654. [],
  655. )
  656. DEFAULT_ARENA_MODEL = {
  657. "id": "arena-model",
  658. "name": "Arena Model",
  659. "meta": {
  660. "profile_image_url": "/favicon.png",
  661. "description": "Submit your questions to anonymous AI chatbots and vote on the best response.",
  662. "model_ids": None,
  663. },
  664. }
  665. WEBHOOK_URL = PersistentConfig(
  666. "WEBHOOK_URL", "webhook_url", os.environ.get("WEBHOOK_URL", "")
  667. )
  668. ENABLE_ADMIN_EXPORT = os.environ.get("ENABLE_ADMIN_EXPORT", "True").lower() == "true"
  669. ENABLE_ADMIN_CHAT_ACCESS = (
  670. os.environ.get("ENABLE_ADMIN_CHAT_ACCESS", "True").lower() == "true"
  671. )
  672. ENABLE_COMMUNITY_SHARING = PersistentConfig(
  673. "ENABLE_COMMUNITY_SHARING",
  674. "ui.enable_community_sharing",
  675. os.environ.get("ENABLE_COMMUNITY_SHARING", "True").lower() == "true",
  676. )
  677. ENABLE_MESSAGE_RATING = PersistentConfig(
  678. "ENABLE_MESSAGE_RATING",
  679. "ui.enable_message_rating",
  680. os.environ.get("ENABLE_MESSAGE_RATING", "True").lower() == "true",
  681. )
  682. def validate_cors_origins(origins):
  683. for origin in origins:
  684. if origin != "*":
  685. validate_cors_origin(origin)
  686. def validate_cors_origin(origin):
  687. parsed_url = urlparse(origin)
  688. # Check if the scheme is either http or https
  689. if parsed_url.scheme not in ["http", "https"]:
  690. raise ValueError(
  691. f"Invalid scheme in CORS_ALLOW_ORIGIN: '{origin}'. Only 'http' and 'https' are allowed."
  692. )
  693. # Ensure that the netloc (domain + port) is present, indicating it's a valid URL
  694. if not parsed_url.netloc:
  695. raise ValueError(f"Invalid URL structure in CORS_ALLOW_ORIGIN: '{origin}'.")
  696. # For production, you should only need one host as
  697. # fastapi serves the svelte-kit built frontend and backend from the same host and port.
  698. # To test CORS_ALLOW_ORIGIN locally, you can set something like
  699. # CORS_ALLOW_ORIGIN=http://localhost:5173;http://localhost:8080
  700. # in your .env file depending on your frontend port, 5173 in this case.
  701. CORS_ALLOW_ORIGIN = os.environ.get("CORS_ALLOW_ORIGIN", "*").split(";")
  702. if "*" in CORS_ALLOW_ORIGIN:
  703. log.warning(
  704. "\n\nWARNING: CORS_ALLOW_ORIGIN IS SET TO '*' - NOT RECOMMENDED FOR PRODUCTION DEPLOYMENTS.\n"
  705. )
  706. validate_cors_origins(CORS_ALLOW_ORIGIN)
  707. class BannerModel(BaseModel):
  708. id: str
  709. type: str
  710. title: Optional[str] = None
  711. content: str
  712. dismissible: bool
  713. timestamp: int
  714. try:
  715. banners = json.loads(os.environ.get("WEBUI_BANNERS", "[]"))
  716. banners = [BannerModel(**banner) for banner in banners]
  717. except Exception as e:
  718. print(f"Error loading WEBUI_BANNERS: {e}")
  719. banners = []
  720. WEBUI_BANNERS = PersistentConfig("WEBUI_BANNERS", "ui.banners", banners)
  721. SHOW_ADMIN_DETAILS = PersistentConfig(
  722. "SHOW_ADMIN_DETAILS",
  723. "auth.admin.show",
  724. os.environ.get("SHOW_ADMIN_DETAILS", "true").lower() == "true",
  725. )
  726. ADMIN_EMAIL = PersistentConfig(
  727. "ADMIN_EMAIL",
  728. "auth.admin.email",
  729. os.environ.get("ADMIN_EMAIL", None),
  730. )
  731. ####################################
  732. # TASKS
  733. ####################################
  734. TASK_MODEL = PersistentConfig(
  735. "TASK_MODEL",
  736. "task.model.default",
  737. os.environ.get("TASK_MODEL", ""),
  738. )
  739. TASK_MODEL_EXTERNAL = PersistentConfig(
  740. "TASK_MODEL_EXTERNAL",
  741. "task.model.external",
  742. os.environ.get("TASK_MODEL_EXTERNAL", ""),
  743. )
  744. TITLE_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  745. "TITLE_GENERATION_PROMPT_TEMPLATE",
  746. "task.title.prompt_template",
  747. os.environ.get("TITLE_GENERATION_PROMPT_TEMPLATE", ""),
  748. )
  749. TAGS_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  750. "TAGS_GENERATION_PROMPT_TEMPLATE",
  751. "task.tags.prompt_template",
  752. os.environ.get("TAGS_GENERATION_PROMPT_TEMPLATE", ""),
  753. )
  754. ENABLE_TAGS_GENERATION = PersistentConfig(
  755. "ENABLE_TAGS_GENERATION",
  756. "task.tags.enable",
  757. os.environ.get("ENABLE_TAGS_GENERATION", "True").lower() == "true",
  758. )
  759. ENABLE_SEARCH_QUERY = PersistentConfig(
  760. "ENABLE_SEARCH_QUERY",
  761. "task.search.enable",
  762. os.environ.get("ENABLE_SEARCH_QUERY", "True").lower() == "true",
  763. )
  764. SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
  765. "SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE",
  766. "task.search.prompt_template",
  767. os.environ.get("SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE", ""),
  768. )
  769. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = PersistentConfig(
  770. "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE",
  771. "task.tools.prompt_template",
  772. os.environ.get("TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE", ""),
  773. )
  774. ####################################
  775. # Vector Database
  776. ####################################
  777. VECTOR_DB = os.environ.get("VECTOR_DB", "chroma")
  778. # Chroma
  779. CHROMA_DATA_PATH = f"{DATA_DIR}/vector_db"
  780. CHROMA_TENANT = os.environ.get("CHROMA_TENANT", chromadb.DEFAULT_TENANT)
  781. CHROMA_DATABASE = os.environ.get("CHROMA_DATABASE", chromadb.DEFAULT_DATABASE)
  782. CHROMA_HTTP_HOST = os.environ.get("CHROMA_HTTP_HOST", "")
  783. CHROMA_HTTP_PORT = int(os.environ.get("CHROMA_HTTP_PORT", "8000"))
  784. CHROMA_CLIENT_AUTH_PROVIDER = os.environ.get("CHROMA_CLIENT_AUTH_PROVIDER", "")
  785. CHROMA_CLIENT_AUTH_CREDENTIALS = os.environ.get("CHROMA_CLIENT_AUTH_CREDENTIALS", "")
  786. # Comma-separated list of header=value pairs
  787. CHROMA_HTTP_HEADERS = os.environ.get("CHROMA_HTTP_HEADERS", "")
  788. if CHROMA_HTTP_HEADERS:
  789. CHROMA_HTTP_HEADERS = dict(
  790. [pair.split("=") for pair in CHROMA_HTTP_HEADERS.split(",")]
  791. )
  792. else:
  793. CHROMA_HTTP_HEADERS = None
  794. CHROMA_HTTP_SSL = os.environ.get("CHROMA_HTTP_SSL", "false").lower() == "true"
  795. # 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)
  796. # Milvus
  797. MILVUS_URI = os.environ.get("MILVUS_URI", f"{DATA_DIR}/vector_db/milvus.db")
  798. # Qdrant
  799. QDRANT_URI = os.environ.get("QDRANT_URI", None)
  800. QDRANT_API_KEY = os.environ.get("QDRANT_API_KEY", None)
  801. # OpenSearch
  802. OPENSEARCH_URI = os.environ.get("OPENSEARCH_URI", "https://localhost:9200")
  803. OPENSEARCH_SSL = os.environ.get("OPENSEARCH_SSL", True)
  804. OPENSEARCH_CERT_VERIFY = os.environ.get("OPENSEARCH_CERT_VERIFY", False)
  805. OPENSEARCH_USERNAME = os.environ.get("OPENSEARCH_USERNAME", None)
  806. OPENSEARCH_PASSWORD = os.environ.get("OPENSEARCH_PASSWORD", None)
  807. # Pgvector
  808. PGVECTOR_DB_URL = os.environ.get("PGVECTOR_DB_URL", DATABASE_URL)
  809. if VECTOR_DB == "pgvector" and not PGVECTOR_DB_URL.startswith("postgres"):
  810. raise ValueError(
  811. "Pgvector requires setting PGVECTOR_DB_URL or using Postgres with vector extension as the primary database."
  812. )
  813. ####################################
  814. # Information Retrieval (RAG)
  815. ####################################
  816. # RAG Content Extraction
  817. CONTENT_EXTRACTION_ENGINE = PersistentConfig(
  818. "CONTENT_EXTRACTION_ENGINE",
  819. "rag.CONTENT_EXTRACTION_ENGINE",
  820. os.environ.get("CONTENT_EXTRACTION_ENGINE", "").lower(),
  821. )
  822. TIKA_SERVER_URL = PersistentConfig(
  823. "TIKA_SERVER_URL",
  824. "rag.tika_server_url",
  825. os.getenv("TIKA_SERVER_URL", "http://tika:9998"), # Default for sidecar deployment
  826. )
  827. RAG_TOP_K = PersistentConfig(
  828. "RAG_TOP_K", "rag.top_k", int(os.environ.get("RAG_TOP_K", "3"))
  829. )
  830. RAG_RELEVANCE_THRESHOLD = PersistentConfig(
  831. "RAG_RELEVANCE_THRESHOLD",
  832. "rag.relevance_threshold",
  833. float(os.environ.get("RAG_RELEVANCE_THRESHOLD", "0.0")),
  834. )
  835. ENABLE_RAG_HYBRID_SEARCH = PersistentConfig(
  836. "ENABLE_RAG_HYBRID_SEARCH",
  837. "rag.enable_hybrid_search",
  838. os.environ.get("ENABLE_RAG_HYBRID_SEARCH", "").lower() == "true",
  839. )
  840. RAG_FILE_MAX_COUNT = PersistentConfig(
  841. "RAG_FILE_MAX_COUNT",
  842. "rag.file.max_count",
  843. (
  844. int(os.environ.get("RAG_FILE_MAX_COUNT"))
  845. if os.environ.get("RAG_FILE_MAX_COUNT")
  846. else None
  847. ),
  848. )
  849. RAG_FILE_MAX_SIZE = PersistentConfig(
  850. "RAG_FILE_MAX_SIZE",
  851. "rag.file.max_size",
  852. (
  853. int(os.environ.get("RAG_FILE_MAX_SIZE"))
  854. if os.environ.get("RAG_FILE_MAX_SIZE")
  855. else None
  856. ),
  857. )
  858. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = PersistentConfig(
  859. "ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION",
  860. "rag.enable_web_loader_ssl_verification",
  861. os.environ.get("ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION", "True").lower() == "true",
  862. )
  863. RAG_EMBEDDING_ENGINE = PersistentConfig(
  864. "RAG_EMBEDDING_ENGINE",
  865. "rag.embedding_engine",
  866. os.environ.get("RAG_EMBEDDING_ENGINE", ""),
  867. )
  868. PDF_EXTRACT_IMAGES = PersistentConfig(
  869. "PDF_EXTRACT_IMAGES",
  870. "rag.pdf_extract_images",
  871. os.environ.get("PDF_EXTRACT_IMAGES", "False").lower() == "true",
  872. )
  873. RAG_EMBEDDING_MODEL = PersistentConfig(
  874. "RAG_EMBEDDING_MODEL",
  875. "rag.embedding_model",
  876. os.environ.get("RAG_EMBEDDING_MODEL", "sentence-transformers/all-MiniLM-L6-v2"),
  877. )
  878. log.info(f"Embedding model set: {RAG_EMBEDDING_MODEL.value}")
  879. RAG_EMBEDDING_MODEL_AUTO_UPDATE = (
  880. os.environ.get("RAG_EMBEDDING_MODEL_AUTO_UPDATE", "True").lower() == "true"
  881. )
  882. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE = (
  883. os.environ.get("RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE", "True").lower() == "true"
  884. )
  885. RAG_EMBEDDING_BATCH_SIZE = PersistentConfig(
  886. "RAG_EMBEDDING_BATCH_SIZE",
  887. "rag.embedding_batch_size",
  888. int(
  889. os.environ.get("RAG_EMBEDDING_BATCH_SIZE")
  890. or os.environ.get("RAG_EMBEDDING_OPENAI_BATCH_SIZE", "1")
  891. ),
  892. )
  893. RAG_RERANKING_MODEL = PersistentConfig(
  894. "RAG_RERANKING_MODEL",
  895. "rag.reranking_model",
  896. os.environ.get("RAG_RERANKING_MODEL", ""),
  897. )
  898. if RAG_RERANKING_MODEL.value != "":
  899. log.info(f"Reranking model set: {RAG_RERANKING_MODEL.value}")
  900. RAG_RERANKING_MODEL_AUTO_UPDATE = (
  901. os.environ.get("RAG_RERANKING_MODEL_AUTO_UPDATE", "True").lower() == "true"
  902. )
  903. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE = (
  904. os.environ.get("RAG_RERANKING_MODEL_TRUST_REMOTE_CODE", "True").lower() == "true"
  905. )
  906. RAG_TEXT_SPLITTER = PersistentConfig(
  907. "RAG_TEXT_SPLITTER",
  908. "rag.text_splitter",
  909. os.environ.get("RAG_TEXT_SPLITTER", ""),
  910. )
  911. TIKTOKEN_CACHE_DIR = os.environ.get("TIKTOKEN_CACHE_DIR", f"{CACHE_DIR}/tiktoken")
  912. TIKTOKEN_ENCODING_NAME = PersistentConfig(
  913. "TIKTOKEN_ENCODING_NAME",
  914. "rag.tiktoken_encoding_name",
  915. os.environ.get("TIKTOKEN_ENCODING_NAME", "cl100k_base"),
  916. )
  917. CHUNK_SIZE = PersistentConfig(
  918. "CHUNK_SIZE", "rag.chunk_size", int(os.environ.get("CHUNK_SIZE", "1000"))
  919. )
  920. CHUNK_OVERLAP = PersistentConfig(
  921. "CHUNK_OVERLAP",
  922. "rag.chunk_overlap",
  923. int(os.environ.get("CHUNK_OVERLAP", "100")),
  924. )
  925. DEFAULT_RAG_TEMPLATE = """You are given a user query, some textual context and rules, all inside xml tags. You have to answer the query based on the context while respecting the rules.
  926. <context>
  927. {{CONTEXT}}
  928. </context>
  929. <rules>
  930. - If you don't know, just say so.
  931. - If you are not sure, ask for clarification.
  932. - Answer in the same language as the user query.
  933. - If the context appears unreadable or of poor quality, tell the user then answer as best as you can.
  934. - If the answer is not in the context but you think you know the answer, explain that to the user then answer with your own knowledge.
  935. - Answer directly and without using xml tags.
  936. </rules>
  937. <user_query>
  938. {{QUERY}}
  939. </user_query>
  940. """
  941. RAG_TEMPLATE = PersistentConfig(
  942. "RAG_TEMPLATE",
  943. "rag.template",
  944. os.environ.get("RAG_TEMPLATE", DEFAULT_RAG_TEMPLATE),
  945. )
  946. RAG_OPENAI_API_BASE_URL = PersistentConfig(
  947. "RAG_OPENAI_API_BASE_URL",
  948. "rag.openai_api_base_url",
  949. os.getenv("RAG_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  950. )
  951. RAG_OPENAI_API_KEY = PersistentConfig(
  952. "RAG_OPENAI_API_KEY",
  953. "rag.openai_api_key",
  954. os.getenv("RAG_OPENAI_API_KEY", OPENAI_API_KEY),
  955. )
  956. ENABLE_RAG_LOCAL_WEB_FETCH = (
  957. os.getenv("ENABLE_RAG_LOCAL_WEB_FETCH", "False").lower() == "true"
  958. )
  959. YOUTUBE_LOADER_LANGUAGE = PersistentConfig(
  960. "YOUTUBE_LOADER_LANGUAGE",
  961. "rag.youtube_loader_language",
  962. os.getenv("YOUTUBE_LOADER_LANGUAGE", "en").split(","),
  963. )
  964. ENABLE_RAG_WEB_SEARCH = PersistentConfig(
  965. "ENABLE_RAG_WEB_SEARCH",
  966. "rag.web.search.enable",
  967. os.getenv("ENABLE_RAG_WEB_SEARCH", "False").lower() == "true",
  968. )
  969. RAG_WEB_SEARCH_ENGINE = PersistentConfig(
  970. "RAG_WEB_SEARCH_ENGINE",
  971. "rag.web.search.engine",
  972. os.getenv("RAG_WEB_SEARCH_ENGINE", ""),
  973. )
  974. # You can provide a list of your own websites to filter after performing a web search.
  975. # This ensures the highest level of safety and reliability of the information sources.
  976. RAG_WEB_SEARCH_DOMAIN_FILTER_LIST = PersistentConfig(
  977. "RAG_WEB_SEARCH_DOMAIN_FILTER_LIST",
  978. "rag.rag.web.search.domain.filter_list",
  979. [
  980. # "wikipedia.com",
  981. # "wikimedia.org",
  982. # "wikidata.org",
  983. ],
  984. )
  985. SEARXNG_QUERY_URL = PersistentConfig(
  986. "SEARXNG_QUERY_URL",
  987. "rag.web.search.searxng_query_url",
  988. os.getenv("SEARXNG_QUERY_URL", ""),
  989. )
  990. GOOGLE_PSE_API_KEY = PersistentConfig(
  991. "GOOGLE_PSE_API_KEY",
  992. "rag.web.search.google_pse_api_key",
  993. os.getenv("GOOGLE_PSE_API_KEY", ""),
  994. )
  995. GOOGLE_PSE_ENGINE_ID = PersistentConfig(
  996. "GOOGLE_PSE_ENGINE_ID",
  997. "rag.web.search.google_pse_engine_id",
  998. os.getenv("GOOGLE_PSE_ENGINE_ID", ""),
  999. )
  1000. BRAVE_SEARCH_API_KEY = PersistentConfig(
  1001. "BRAVE_SEARCH_API_KEY",
  1002. "rag.web.search.brave_search_api_key",
  1003. os.getenv("BRAVE_SEARCH_API_KEY", ""),
  1004. )
  1005. SERPSTACK_API_KEY = PersistentConfig(
  1006. "SERPSTACK_API_KEY",
  1007. "rag.web.search.serpstack_api_key",
  1008. os.getenv("SERPSTACK_API_KEY", ""),
  1009. )
  1010. SERPSTACK_HTTPS = PersistentConfig(
  1011. "SERPSTACK_HTTPS",
  1012. "rag.web.search.serpstack_https",
  1013. os.getenv("SERPSTACK_HTTPS", "True").lower() == "true",
  1014. )
  1015. SERPER_API_KEY = PersistentConfig(
  1016. "SERPER_API_KEY",
  1017. "rag.web.search.serper_api_key",
  1018. os.getenv("SERPER_API_KEY", ""),
  1019. )
  1020. SERPLY_API_KEY = PersistentConfig(
  1021. "SERPLY_API_KEY",
  1022. "rag.web.search.serply_api_key",
  1023. os.getenv("SERPLY_API_KEY", ""),
  1024. )
  1025. TAVILY_API_KEY = PersistentConfig(
  1026. "TAVILY_API_KEY",
  1027. "rag.web.search.tavily_api_key",
  1028. os.getenv("TAVILY_API_KEY", ""),
  1029. )
  1030. JINA_API_KEY = PersistentConfig(
  1031. "JINA_API_KEY",
  1032. "rag.web.search.jina_api_key",
  1033. os.getenv("JINA_API_KEY", ""),
  1034. )
  1035. SEARCHAPI_API_KEY = PersistentConfig(
  1036. "SEARCHAPI_API_KEY",
  1037. "rag.web.search.searchapi_api_key",
  1038. os.getenv("SEARCHAPI_API_KEY", ""),
  1039. )
  1040. SEARCHAPI_ENGINE = PersistentConfig(
  1041. "SEARCHAPI_ENGINE",
  1042. "rag.web.search.searchapi_engine",
  1043. os.getenv("SEARCHAPI_ENGINE", ""),
  1044. )
  1045. BING_SEARCH_V7_ENDPOINT = PersistentConfig(
  1046. "BING_SEARCH_V7_ENDPOINT",
  1047. "rag.web.search.bing_search_v7_endpoint",
  1048. os.environ.get(
  1049. "BING_SEARCH_V7_ENDPOINT", "https://api.bing.microsoft.com/v7.0/search"
  1050. ),
  1051. )
  1052. BING_SEARCH_V7_SUBSCRIPTION_KEY = PersistentConfig(
  1053. "BING_SEARCH_V7_SUBSCRIPTION_KEY",
  1054. "rag.web.search.bing_search_v7_subscription_key",
  1055. os.environ.get("BING_SEARCH_V7_SUBSCRIPTION_KEY", ""),
  1056. )
  1057. RAG_WEB_SEARCH_RESULT_COUNT = PersistentConfig(
  1058. "RAG_WEB_SEARCH_RESULT_COUNT",
  1059. "rag.web.search.result_count",
  1060. int(os.getenv("RAG_WEB_SEARCH_RESULT_COUNT", "3")),
  1061. )
  1062. RAG_WEB_SEARCH_CONCURRENT_REQUESTS = PersistentConfig(
  1063. "RAG_WEB_SEARCH_CONCURRENT_REQUESTS",
  1064. "rag.web.search.concurrent_requests",
  1065. int(os.getenv("RAG_WEB_SEARCH_CONCURRENT_REQUESTS", "10")),
  1066. )
  1067. ####################################
  1068. # Images
  1069. ####################################
  1070. IMAGE_GENERATION_ENGINE = PersistentConfig(
  1071. "IMAGE_GENERATION_ENGINE",
  1072. "image_generation.engine",
  1073. os.getenv("IMAGE_GENERATION_ENGINE", "openai"),
  1074. )
  1075. ENABLE_IMAGE_GENERATION = PersistentConfig(
  1076. "ENABLE_IMAGE_GENERATION",
  1077. "image_generation.enable",
  1078. os.environ.get("ENABLE_IMAGE_GENERATION", "").lower() == "true",
  1079. )
  1080. AUTOMATIC1111_BASE_URL = PersistentConfig(
  1081. "AUTOMATIC1111_BASE_URL",
  1082. "image_generation.automatic1111.base_url",
  1083. os.getenv("AUTOMATIC1111_BASE_URL", ""),
  1084. )
  1085. AUTOMATIC1111_API_AUTH = PersistentConfig(
  1086. "AUTOMATIC1111_API_AUTH",
  1087. "image_generation.automatic1111.api_auth",
  1088. os.getenv("AUTOMATIC1111_API_AUTH", ""),
  1089. )
  1090. AUTOMATIC1111_CFG_SCALE = PersistentConfig(
  1091. "AUTOMATIC1111_CFG_SCALE",
  1092. "image_generation.automatic1111.cfg_scale",
  1093. (
  1094. float(os.environ.get("AUTOMATIC1111_CFG_SCALE"))
  1095. if os.environ.get("AUTOMATIC1111_CFG_SCALE")
  1096. else None
  1097. ),
  1098. )
  1099. AUTOMATIC1111_SAMPLER = PersistentConfig(
  1100. "AUTOMATIC1111_SAMPLER",
  1101. "image_generation.automatic1111.sampler",
  1102. (
  1103. os.environ.get("AUTOMATIC1111_SAMPLER")
  1104. if os.environ.get("AUTOMATIC1111_SAMPLER")
  1105. else None
  1106. ),
  1107. )
  1108. AUTOMATIC1111_SCHEDULER = PersistentConfig(
  1109. "AUTOMATIC1111_SCHEDULER",
  1110. "image_generation.automatic1111.scheduler",
  1111. (
  1112. os.environ.get("AUTOMATIC1111_SCHEDULER")
  1113. if os.environ.get("AUTOMATIC1111_SCHEDULER")
  1114. else None
  1115. ),
  1116. )
  1117. COMFYUI_BASE_URL = PersistentConfig(
  1118. "COMFYUI_BASE_URL",
  1119. "image_generation.comfyui.base_url",
  1120. os.getenv("COMFYUI_BASE_URL", ""),
  1121. )
  1122. COMFYUI_DEFAULT_WORKFLOW = """
  1123. {
  1124. "3": {
  1125. "inputs": {
  1126. "seed": 0,
  1127. "steps": 20,
  1128. "cfg": 8,
  1129. "sampler_name": "euler",
  1130. "scheduler": "normal",
  1131. "denoise": 1,
  1132. "model": [
  1133. "4",
  1134. 0
  1135. ],
  1136. "positive": [
  1137. "6",
  1138. 0
  1139. ],
  1140. "negative": [
  1141. "7",
  1142. 0
  1143. ],
  1144. "latent_image": [
  1145. "5",
  1146. 0
  1147. ]
  1148. },
  1149. "class_type": "KSampler",
  1150. "_meta": {
  1151. "title": "KSampler"
  1152. }
  1153. },
  1154. "4": {
  1155. "inputs": {
  1156. "ckpt_name": "model.safetensors"
  1157. },
  1158. "class_type": "CheckpointLoaderSimple",
  1159. "_meta": {
  1160. "title": "Load Checkpoint"
  1161. }
  1162. },
  1163. "5": {
  1164. "inputs": {
  1165. "width": 512,
  1166. "height": 512,
  1167. "batch_size": 1
  1168. },
  1169. "class_type": "EmptyLatentImage",
  1170. "_meta": {
  1171. "title": "Empty Latent Image"
  1172. }
  1173. },
  1174. "6": {
  1175. "inputs": {
  1176. "text": "Prompt",
  1177. "clip": [
  1178. "4",
  1179. 1
  1180. ]
  1181. },
  1182. "class_type": "CLIPTextEncode",
  1183. "_meta": {
  1184. "title": "CLIP Text Encode (Prompt)"
  1185. }
  1186. },
  1187. "7": {
  1188. "inputs": {
  1189. "text": "",
  1190. "clip": [
  1191. "4",
  1192. 1
  1193. ]
  1194. },
  1195. "class_type": "CLIPTextEncode",
  1196. "_meta": {
  1197. "title": "CLIP Text Encode (Prompt)"
  1198. }
  1199. },
  1200. "8": {
  1201. "inputs": {
  1202. "samples": [
  1203. "3",
  1204. 0
  1205. ],
  1206. "vae": [
  1207. "4",
  1208. 2
  1209. ]
  1210. },
  1211. "class_type": "VAEDecode",
  1212. "_meta": {
  1213. "title": "VAE Decode"
  1214. }
  1215. },
  1216. "9": {
  1217. "inputs": {
  1218. "filename_prefix": "ComfyUI",
  1219. "images": [
  1220. "8",
  1221. 0
  1222. ]
  1223. },
  1224. "class_type": "SaveImage",
  1225. "_meta": {
  1226. "title": "Save Image"
  1227. }
  1228. }
  1229. }
  1230. """
  1231. COMFYUI_WORKFLOW = PersistentConfig(
  1232. "COMFYUI_WORKFLOW",
  1233. "image_generation.comfyui.workflow",
  1234. os.getenv("COMFYUI_WORKFLOW", COMFYUI_DEFAULT_WORKFLOW),
  1235. )
  1236. COMFYUI_WORKFLOW_NODES = PersistentConfig(
  1237. "COMFYUI_WORKFLOW",
  1238. "image_generation.comfyui.nodes",
  1239. [],
  1240. )
  1241. IMAGES_OPENAI_API_BASE_URL = PersistentConfig(
  1242. "IMAGES_OPENAI_API_BASE_URL",
  1243. "image_generation.openai.api_base_url",
  1244. os.getenv("IMAGES_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1245. )
  1246. IMAGES_OPENAI_API_KEY = PersistentConfig(
  1247. "IMAGES_OPENAI_API_KEY",
  1248. "image_generation.openai.api_key",
  1249. os.getenv("IMAGES_OPENAI_API_KEY", OPENAI_API_KEY),
  1250. )
  1251. IMAGE_SIZE = PersistentConfig(
  1252. "IMAGE_SIZE", "image_generation.size", os.getenv("IMAGE_SIZE", "512x512")
  1253. )
  1254. IMAGE_STEPS = PersistentConfig(
  1255. "IMAGE_STEPS", "image_generation.steps", int(os.getenv("IMAGE_STEPS", 50))
  1256. )
  1257. IMAGE_GENERATION_MODEL = PersistentConfig(
  1258. "IMAGE_GENERATION_MODEL",
  1259. "image_generation.model",
  1260. os.getenv("IMAGE_GENERATION_MODEL", ""),
  1261. )
  1262. ####################################
  1263. # Audio
  1264. ####################################
  1265. # Transcription
  1266. WHISPER_MODEL = PersistentConfig(
  1267. "WHISPER_MODEL",
  1268. "audio.stt.whisper_model",
  1269. os.getenv("WHISPER_MODEL", "base"),
  1270. )
  1271. WHISPER_MODEL_DIR = os.getenv("WHISPER_MODEL_DIR", f"{CACHE_DIR}/whisper/models")
  1272. WHISPER_MODEL_AUTO_UPDATE = (
  1273. os.environ.get("WHISPER_MODEL_AUTO_UPDATE", "").lower() == "true"
  1274. )
  1275. AUDIO_STT_OPENAI_API_BASE_URL = PersistentConfig(
  1276. "AUDIO_STT_OPENAI_API_BASE_URL",
  1277. "audio.stt.openai.api_base_url",
  1278. os.getenv("AUDIO_STT_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1279. )
  1280. AUDIO_STT_OPENAI_API_KEY = PersistentConfig(
  1281. "AUDIO_STT_OPENAI_API_KEY",
  1282. "audio.stt.openai.api_key",
  1283. os.getenv("AUDIO_STT_OPENAI_API_KEY", OPENAI_API_KEY),
  1284. )
  1285. AUDIO_STT_ENGINE = PersistentConfig(
  1286. "AUDIO_STT_ENGINE",
  1287. "audio.stt.engine",
  1288. os.getenv("AUDIO_STT_ENGINE", ""),
  1289. )
  1290. AUDIO_STT_MODEL = PersistentConfig(
  1291. "AUDIO_STT_MODEL",
  1292. "audio.stt.model",
  1293. os.getenv("AUDIO_STT_MODEL", ""),
  1294. )
  1295. AUDIO_TTS_OPENAI_API_BASE_URL = PersistentConfig(
  1296. "AUDIO_TTS_OPENAI_API_BASE_URL",
  1297. "audio.tts.openai.api_base_url",
  1298. os.getenv("AUDIO_TTS_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
  1299. )
  1300. AUDIO_TTS_OPENAI_API_KEY = PersistentConfig(
  1301. "AUDIO_TTS_OPENAI_API_KEY",
  1302. "audio.tts.openai.api_key",
  1303. os.getenv("AUDIO_TTS_OPENAI_API_KEY", OPENAI_API_KEY),
  1304. )
  1305. AUDIO_TTS_API_KEY = PersistentConfig(
  1306. "AUDIO_TTS_API_KEY",
  1307. "audio.tts.api_key",
  1308. os.getenv("AUDIO_TTS_API_KEY", ""),
  1309. )
  1310. AUDIO_TTS_ENGINE = PersistentConfig(
  1311. "AUDIO_TTS_ENGINE",
  1312. "audio.tts.engine",
  1313. os.getenv("AUDIO_TTS_ENGINE", ""),
  1314. )
  1315. AUDIO_TTS_MODEL = PersistentConfig(
  1316. "AUDIO_TTS_MODEL",
  1317. "audio.tts.model",
  1318. os.getenv("AUDIO_TTS_MODEL", "tts-1"), # OpenAI default model
  1319. )
  1320. AUDIO_TTS_VOICE = PersistentConfig(
  1321. "AUDIO_TTS_VOICE",
  1322. "audio.tts.voice",
  1323. os.getenv("AUDIO_TTS_VOICE", "alloy"), # OpenAI default voice
  1324. )
  1325. AUDIO_TTS_SPLIT_ON = PersistentConfig(
  1326. "AUDIO_TTS_SPLIT_ON",
  1327. "audio.tts.split_on",
  1328. os.getenv("AUDIO_TTS_SPLIT_ON", "punctuation"),
  1329. )
  1330. AUDIO_TTS_AZURE_SPEECH_REGION = PersistentConfig(
  1331. "AUDIO_TTS_AZURE_SPEECH_REGION",
  1332. "audio.tts.azure.speech_region",
  1333. os.getenv("AUDIO_TTS_AZURE_SPEECH_REGION", "eastus"),
  1334. )
  1335. AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT = PersistentConfig(
  1336. "AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT",
  1337. "audio.tts.azure.speech_output_format",
  1338. os.getenv(
  1339. "AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT", "audio-24khz-160kbitrate-mono-mp3"
  1340. ),
  1341. )
  1342. ####################################
  1343. # LDAP
  1344. ####################################
  1345. ENABLE_LDAP = PersistentConfig(
  1346. "ENABLE_LDAP",
  1347. "ldap.enable",
  1348. os.environ.get("ENABLE_LDAP", "false").lower() == "true",
  1349. )
  1350. LDAP_SERVER_LABEL = PersistentConfig(
  1351. "LDAP_SERVER_LABEL",
  1352. "ldap.server.label",
  1353. os.environ.get("LDAP_SERVER_LABEL", "LDAP Server"),
  1354. )
  1355. LDAP_SERVER_HOST = PersistentConfig(
  1356. "LDAP_SERVER_HOST",
  1357. "ldap.server.host",
  1358. os.environ.get("LDAP_SERVER_HOST", "localhost"),
  1359. )
  1360. LDAP_SERVER_PORT = PersistentConfig(
  1361. "LDAP_SERVER_PORT",
  1362. "ldap.server.port",
  1363. int(os.environ.get("LDAP_SERVER_PORT", "389")),
  1364. )
  1365. LDAP_ATTRIBUTE_FOR_USERNAME = PersistentConfig(
  1366. "LDAP_ATTRIBUTE_FOR_USERNAME",
  1367. "ldap.server.attribute_for_username",
  1368. os.environ.get("LDAP_ATTRIBUTE_FOR_USERNAME", "uid"),
  1369. )
  1370. LDAP_APP_DN = PersistentConfig(
  1371. "LDAP_APP_DN", "ldap.server.app_dn", os.environ.get("LDAP_APP_DN", "")
  1372. )
  1373. LDAP_APP_PASSWORD = PersistentConfig(
  1374. "LDAP_APP_PASSWORD",
  1375. "ldap.server.app_password",
  1376. os.environ.get("LDAP_APP_PASSWORD", ""),
  1377. )
  1378. LDAP_SEARCH_BASE = PersistentConfig(
  1379. "LDAP_SEARCH_BASE", "ldap.server.users_dn", os.environ.get("LDAP_SEARCH_BASE", "")
  1380. )
  1381. LDAP_SEARCH_FILTERS = PersistentConfig(
  1382. "LDAP_SEARCH_FILTER",
  1383. "ldap.server.search_filter",
  1384. os.environ.get("LDAP_SEARCH_FILTER", ""),
  1385. )
  1386. LDAP_USE_TLS = PersistentConfig(
  1387. "LDAP_USE_TLS",
  1388. "ldap.server.use_tls",
  1389. os.environ.get("LDAP_USE_TLS", "True").lower() == "true",
  1390. )
  1391. LDAP_CA_CERT_FILE = PersistentConfig(
  1392. "LDAP_CA_CERT_FILE",
  1393. "ldap.server.ca_cert_file",
  1394. os.environ.get("LDAP_CA_CERT_FILE", ""),
  1395. )
  1396. LDAP_CIPHERS = PersistentConfig(
  1397. "LDAP_CIPHERS", "ldap.server.ciphers", os.environ.get("LDAP_CIPHERS", "ALL")
  1398. )