env.py 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773
  1. import importlib.metadata
  2. import json
  3. import logging
  4. import os
  5. import pkgutil
  6. import sys
  7. import shutil
  8. from uuid import uuid4
  9. from pathlib import Path
  10. from cryptography.hazmat.primitives import serialization
  11. import markdown
  12. from bs4 import BeautifulSoup
  13. from open_webui.constants import ERROR_MESSAGES
  14. ####################################
  15. # Load .env file
  16. ####################################
  17. # Use .resolve() to get the canonical path, removing any '..' or '.' components
  18. ENV_FILE_PATH = Path(__file__).resolve()
  19. # OPEN_WEBUI_DIR should be the directory where env.py resides (open_webui/)
  20. OPEN_WEBUI_DIR = ENV_FILE_PATH.parent
  21. # BACKEND_DIR is the parent of OPEN_WEBUI_DIR (backend/)
  22. BACKEND_DIR = OPEN_WEBUI_DIR.parent
  23. # BASE_DIR is the parent of BACKEND_DIR (open-webui-dev/)
  24. BASE_DIR = BACKEND_DIR.parent
  25. try:
  26. from dotenv import find_dotenv, load_dotenv
  27. load_dotenv(find_dotenv(str(BASE_DIR / ".env")))
  28. except ImportError:
  29. print("dotenv not installed, skipping...")
  30. DOCKER = os.environ.get("DOCKER", "False").lower() == "true"
  31. # device type embedding models - "cpu" (default), "cuda" (nvidia gpu required) or "mps" (apple silicon) - choosing this right can lead to better performance
  32. USE_CUDA = os.environ.get("USE_CUDA_DOCKER", "false")
  33. if USE_CUDA.lower() == "true":
  34. try:
  35. import torch
  36. assert torch.cuda.is_available(), "CUDA not available"
  37. DEVICE_TYPE = "cuda"
  38. except Exception as e:
  39. cuda_error = (
  40. "Error when testing CUDA but USE_CUDA_DOCKER is true. "
  41. f"Resetting USE_CUDA_DOCKER to false: {e}"
  42. )
  43. os.environ["USE_CUDA_DOCKER"] = "false"
  44. USE_CUDA = "false"
  45. DEVICE_TYPE = "cpu"
  46. else:
  47. DEVICE_TYPE = "cpu"
  48. try:
  49. import torch
  50. if torch.backends.mps.is_available() and torch.backends.mps.is_built():
  51. DEVICE_TYPE = "mps"
  52. except Exception:
  53. pass
  54. ####################################
  55. # LOGGING
  56. ####################################
  57. GLOBAL_LOG_LEVEL = os.environ.get("GLOBAL_LOG_LEVEL", "").upper()
  58. if GLOBAL_LOG_LEVEL in logging.getLevelNamesMapping():
  59. logging.basicConfig(stream=sys.stdout, level=GLOBAL_LOG_LEVEL, force=True)
  60. else:
  61. GLOBAL_LOG_LEVEL = "INFO"
  62. log = logging.getLogger(__name__)
  63. log.info(f"GLOBAL_LOG_LEVEL: {GLOBAL_LOG_LEVEL}")
  64. if "cuda_error" in locals():
  65. log.exception(cuda_error)
  66. del cuda_error
  67. log_sources = [
  68. "AUDIO",
  69. "COMFYUI",
  70. "CONFIG",
  71. "DB",
  72. "IMAGES",
  73. "MAIN",
  74. "MODELS",
  75. "OLLAMA",
  76. "OPENAI",
  77. "RAG",
  78. "WEBHOOK",
  79. "SOCKET",
  80. "OAUTH",
  81. ]
  82. SRC_LOG_LEVELS = {}
  83. for source in log_sources:
  84. log_env_var = source + "_LOG_LEVEL"
  85. SRC_LOG_LEVELS[source] = os.environ.get(log_env_var, "").upper()
  86. if SRC_LOG_LEVELS[source] not in logging.getLevelNamesMapping():
  87. SRC_LOG_LEVELS[source] = GLOBAL_LOG_LEVEL
  88. log.info(f"{log_env_var}: {SRC_LOG_LEVELS[source]}")
  89. log.setLevel(SRC_LOG_LEVELS["CONFIG"])
  90. WEBUI_NAME = os.environ.get("WEBUI_NAME", "Open WebUI")
  91. if WEBUI_NAME != "Open WebUI":
  92. WEBUI_NAME += " (Open WebUI)"
  93. WEBUI_FAVICON_URL = "https://openwebui.com/favicon.png"
  94. TRUSTED_SIGNATURE_KEY = os.environ.get("TRUSTED_SIGNATURE_KEY", "")
  95. ####################################
  96. # ENV (dev,test,prod)
  97. ####################################
  98. ENV = os.environ.get("ENV", "dev")
  99. FROM_INIT_PY = os.environ.get("FROM_INIT_PY", "False").lower() == "true"
  100. if FROM_INIT_PY:
  101. PACKAGE_DATA = {"version": importlib.metadata.version("open-webui")}
  102. else:
  103. try:
  104. PACKAGE_DATA = json.loads((BASE_DIR / "package.json").read_text())
  105. except Exception:
  106. PACKAGE_DATA = {"version": "0.0.0"}
  107. VERSION = PACKAGE_DATA["version"]
  108. INSTANCE_ID = os.environ.get("INSTANCE_ID", str(uuid4()))
  109. # Function to parse each section
  110. def parse_section(section):
  111. items = []
  112. for li in section.find_all("li"):
  113. # Extract raw HTML string
  114. raw_html = str(li)
  115. # Extract text without HTML tags
  116. text = li.get_text(separator=" ", strip=True)
  117. # Split into title and content
  118. parts = text.split(": ", 1)
  119. title = parts[0].strip() if len(parts) > 1 else ""
  120. content = parts[1].strip() if len(parts) > 1 else text
  121. items.append({"title": title, "content": content, "raw": raw_html})
  122. return items
  123. try:
  124. changelog_path = BASE_DIR / "CHANGELOG.md"
  125. with open(str(changelog_path.absolute()), "r", encoding="utf8") as file:
  126. changelog_content = file.read()
  127. except Exception:
  128. changelog_content = (pkgutil.get_data("open_webui", "CHANGELOG.md") or b"").decode()
  129. # Convert markdown content to HTML
  130. html_content = markdown.markdown(changelog_content)
  131. # Parse the HTML content
  132. soup = BeautifulSoup(html_content, "html.parser")
  133. # Initialize JSON structure
  134. changelog_json = {}
  135. # Iterate over each version
  136. for version in soup.find_all("h2"):
  137. version_number = version.get_text().strip().split(" - ")[0][1:-1] # Remove brackets
  138. date = version.get_text().strip().split(" - ")[1]
  139. version_data = {"date": date}
  140. # Find the next sibling that is a h3 tag (section title)
  141. current = version.find_next_sibling()
  142. while current and current.name != "h2":
  143. if current.name == "h3":
  144. section_title = current.get_text().lower() # e.g., "added", "fixed"
  145. section_items = parse_section(current.find_next_sibling("ul"))
  146. version_data[section_title] = section_items
  147. # Move to the next element
  148. current = current.find_next_sibling()
  149. changelog_json[version_number] = version_data
  150. CHANGELOG = changelog_json
  151. ####################################
  152. # SAFE_MODE
  153. ####################################
  154. SAFE_MODE = os.environ.get("SAFE_MODE", "false").lower() == "true"
  155. ####################################
  156. # ENABLE_FORWARD_USER_INFO_HEADERS
  157. ####################################
  158. ENABLE_FORWARD_USER_INFO_HEADERS = (
  159. os.environ.get("ENABLE_FORWARD_USER_INFO_HEADERS", "False").lower() == "true"
  160. )
  161. ####################################
  162. # WEBUI_BUILD_HASH
  163. ####################################
  164. WEBUI_BUILD_HASH = os.environ.get("WEBUI_BUILD_HASH", "dev-build")
  165. ####################################
  166. # DATA/FRONTEND BUILD DIR
  167. ####################################
  168. DATA_DIR = Path(os.getenv("DATA_DIR", BACKEND_DIR / "data")).resolve()
  169. if FROM_INIT_PY:
  170. NEW_DATA_DIR = Path(os.getenv("DATA_DIR", OPEN_WEBUI_DIR / "data")).resolve()
  171. NEW_DATA_DIR.mkdir(parents=True, exist_ok=True)
  172. # Check if the data directory exists in the package directory
  173. if DATA_DIR.exists() and DATA_DIR != NEW_DATA_DIR:
  174. log.info(f"Moving {DATA_DIR} to {NEW_DATA_DIR}")
  175. for item in DATA_DIR.iterdir():
  176. dest = NEW_DATA_DIR / item.name
  177. if item.is_dir():
  178. shutil.copytree(item, dest, dirs_exist_ok=True)
  179. else:
  180. shutil.copy2(item, dest)
  181. # Zip the data directory
  182. shutil.make_archive(DATA_DIR.parent / "open_webui_data", "zip", DATA_DIR)
  183. # Remove the old data directory
  184. shutil.rmtree(DATA_DIR)
  185. DATA_DIR = Path(os.getenv("DATA_DIR", OPEN_WEBUI_DIR / "data"))
  186. STATIC_DIR = Path(os.getenv("STATIC_DIR", OPEN_WEBUI_DIR / "static"))
  187. FONTS_DIR = Path(os.getenv("FONTS_DIR", OPEN_WEBUI_DIR / "static" / "fonts"))
  188. FRONTEND_BUILD_DIR = Path(os.getenv("FRONTEND_BUILD_DIR", BASE_DIR / "build")).resolve()
  189. if FROM_INIT_PY:
  190. FRONTEND_BUILD_DIR = Path(
  191. os.getenv("FRONTEND_BUILD_DIR", OPEN_WEBUI_DIR / "frontend")
  192. ).resolve()
  193. ####################################
  194. # Database
  195. ####################################
  196. # Check if the file exists
  197. if os.path.exists(f"{DATA_DIR}/ollama.db"):
  198. # Rename the file
  199. os.rename(f"{DATA_DIR}/ollama.db", f"{DATA_DIR}/webui.db")
  200. log.info("Database migrated from Ollama-WebUI successfully.")
  201. else:
  202. pass
  203. DATABASE_URL = os.environ.get("DATABASE_URL", f"sqlite:///{DATA_DIR}/webui.db")
  204. DATABASE_TYPE = os.environ.get("DATABASE_TYPE")
  205. DATABASE_USER = os.environ.get("DATABASE_USER")
  206. DATABASE_PASSWORD = os.environ.get("DATABASE_PASSWORD")
  207. DATABASE_CRED = ""
  208. if DATABASE_USER:
  209. DATABASE_CRED += f"{DATABASE_USER}"
  210. if DATABASE_PASSWORD:
  211. DATABASE_CRED += f":{DATABASE_PASSWORD}"
  212. DB_VARS = {
  213. "db_type": DATABASE_TYPE,
  214. "db_cred": DATABASE_CRED,
  215. "db_host": os.environ.get("DATABASE_HOST"),
  216. "db_port": os.environ.get("DATABASE_PORT"),
  217. "db_name": os.environ.get("DATABASE_NAME"),
  218. }
  219. if all(DB_VARS.values()):
  220. DATABASE_URL = f"{DB_VARS['db_type']}://{DB_VARS['db_cred']}@{DB_VARS['db_host']}:{DB_VARS['db_port']}/{DB_VARS['db_name']}"
  221. elif DATABASE_TYPE == "sqlite+sqlcipher" and not os.environ.get("DATABASE_URL"):
  222. # Handle SQLCipher with local file when DATABASE_URL wasn't explicitly set
  223. DATABASE_URL = f"sqlite+sqlcipher:///{DATA_DIR}/webui.db"
  224. # Replace the postgres:// with postgresql://
  225. if "postgres://" in DATABASE_URL:
  226. DATABASE_URL = DATABASE_URL.replace("postgres://", "postgresql://")
  227. DATABASE_SCHEMA = os.environ.get("DATABASE_SCHEMA", None)
  228. DATABASE_POOL_SIZE = os.environ.get("DATABASE_POOL_SIZE", None)
  229. if DATABASE_POOL_SIZE != None:
  230. try:
  231. DATABASE_POOL_SIZE = int(DATABASE_POOL_SIZE)
  232. except Exception:
  233. DATABASE_POOL_SIZE = None
  234. DATABASE_POOL_MAX_OVERFLOW = os.environ.get("DATABASE_POOL_MAX_OVERFLOW", 0)
  235. if DATABASE_POOL_MAX_OVERFLOW == "":
  236. DATABASE_POOL_MAX_OVERFLOW = 0
  237. else:
  238. try:
  239. DATABASE_POOL_MAX_OVERFLOW = int(DATABASE_POOL_MAX_OVERFLOW)
  240. except Exception:
  241. DATABASE_POOL_MAX_OVERFLOW = 0
  242. DATABASE_POOL_TIMEOUT = os.environ.get("DATABASE_POOL_TIMEOUT", 30)
  243. if DATABASE_POOL_TIMEOUT == "":
  244. DATABASE_POOL_TIMEOUT = 30
  245. else:
  246. try:
  247. DATABASE_POOL_TIMEOUT = int(DATABASE_POOL_TIMEOUT)
  248. except Exception:
  249. DATABASE_POOL_TIMEOUT = 30
  250. DATABASE_POOL_RECYCLE = os.environ.get("DATABASE_POOL_RECYCLE", 3600)
  251. if DATABASE_POOL_RECYCLE == "":
  252. DATABASE_POOL_RECYCLE = 3600
  253. else:
  254. try:
  255. DATABASE_POOL_RECYCLE = int(DATABASE_POOL_RECYCLE)
  256. except Exception:
  257. DATABASE_POOL_RECYCLE = 3600
  258. DATABASE_ENABLE_SQLITE_WAL = (
  259. os.environ.get("DATABASE_ENABLE_SQLITE_WAL", "False").lower() == "true"
  260. )
  261. DATABASE_USER_ACTIVE_STATUS_UPDATE_INTERVAL = os.environ.get(
  262. "DATABASE_USER_ACTIVE_STATUS_UPDATE_INTERVAL", None
  263. )
  264. if DATABASE_USER_ACTIVE_STATUS_UPDATE_INTERVAL is not None:
  265. try:
  266. DATABASE_USER_ACTIVE_STATUS_UPDATE_INTERVAL = float(
  267. DATABASE_USER_ACTIVE_STATUS_UPDATE_INTERVAL
  268. )
  269. except Exception:
  270. DATABASE_USER_ACTIVE_STATUS_UPDATE_INTERVAL = 0.0
  271. RESET_CONFIG_ON_START = (
  272. os.environ.get("RESET_CONFIG_ON_START", "False").lower() == "true"
  273. )
  274. ENABLE_REALTIME_CHAT_SAVE = (
  275. os.environ.get("ENABLE_REALTIME_CHAT_SAVE", "False").lower() == "true"
  276. )
  277. ####################################
  278. # REDIS
  279. ####################################
  280. REDIS_URL = os.environ.get("REDIS_URL", "")
  281. REDIS_CLUSTER = os.environ.get("REDIS_CLUSTER", "False").lower() == "true"
  282. REDIS_KEY_PREFIX = os.environ.get("REDIS_KEY_PREFIX", "open-webui")
  283. REDIS_SENTINEL_HOSTS = os.environ.get("REDIS_SENTINEL_HOSTS", "")
  284. REDIS_SENTINEL_PORT = os.environ.get("REDIS_SENTINEL_PORT", "26379")
  285. # Maximum number of retries for Redis operations when using Sentinel fail-over
  286. REDIS_SENTINEL_MAX_RETRY_COUNT = os.environ.get("REDIS_SENTINEL_MAX_RETRY_COUNT", "2")
  287. try:
  288. REDIS_SENTINEL_MAX_RETRY_COUNT = int(REDIS_SENTINEL_MAX_RETRY_COUNT)
  289. if REDIS_SENTINEL_MAX_RETRY_COUNT < 1:
  290. REDIS_SENTINEL_MAX_RETRY_COUNT = 2
  291. except ValueError:
  292. REDIS_SENTINEL_MAX_RETRY_COUNT = 2
  293. ####################################
  294. # UVICORN WORKERS
  295. ####################################
  296. # Number of uvicorn worker processes for handling requests
  297. UVICORN_WORKERS = os.environ.get("UVICORN_WORKERS", "1")
  298. try:
  299. UVICORN_WORKERS = int(UVICORN_WORKERS)
  300. if UVICORN_WORKERS < 1:
  301. UVICORN_WORKERS = 1
  302. except ValueError:
  303. UVICORN_WORKERS = 1
  304. log.info(f"Invalid UVICORN_WORKERS value, defaulting to {UVICORN_WORKERS}")
  305. ####################################
  306. # WEBUI_AUTH (Required for security)
  307. ####################################
  308. WEBUI_AUTH = os.environ.get("WEBUI_AUTH", "True").lower() == "true"
  309. ENABLE_SIGNUP_PASSWORD_CONFIRMATION = (
  310. os.environ.get("ENABLE_SIGNUP_PASSWORD_CONFIRMATION", "False").lower() == "true"
  311. )
  312. WEBUI_AUTH_TRUSTED_EMAIL_HEADER = os.environ.get(
  313. "WEBUI_AUTH_TRUSTED_EMAIL_HEADER", None
  314. )
  315. WEBUI_AUTH_TRUSTED_NAME_HEADER = os.environ.get("WEBUI_AUTH_TRUSTED_NAME_HEADER", None)
  316. WEBUI_AUTH_TRUSTED_GROUPS_HEADER = os.environ.get(
  317. "WEBUI_AUTH_TRUSTED_GROUPS_HEADER", None
  318. )
  319. BYPASS_MODEL_ACCESS_CONTROL = (
  320. os.environ.get("BYPASS_MODEL_ACCESS_CONTROL", "False").lower() == "true"
  321. )
  322. WEBUI_AUTH_SIGNOUT_REDIRECT_URL = os.environ.get(
  323. "WEBUI_AUTH_SIGNOUT_REDIRECT_URL", None
  324. )
  325. ####################################
  326. # WEBUI_SECRET_KEY
  327. ####################################
  328. WEBUI_SECRET_KEY = os.environ.get(
  329. "WEBUI_SECRET_KEY",
  330. os.environ.get(
  331. "WEBUI_JWT_SECRET_KEY", "t0p-s3cr3t"
  332. ), # DEPRECATED: remove at next major version
  333. )
  334. WEBUI_SESSION_COOKIE_SAME_SITE = os.environ.get("WEBUI_SESSION_COOKIE_SAME_SITE", "lax")
  335. WEBUI_SESSION_COOKIE_SECURE = (
  336. os.environ.get("WEBUI_SESSION_COOKIE_SECURE", "false").lower() == "true"
  337. )
  338. WEBUI_AUTH_COOKIE_SAME_SITE = os.environ.get(
  339. "WEBUI_AUTH_COOKIE_SAME_SITE", WEBUI_SESSION_COOKIE_SAME_SITE
  340. )
  341. WEBUI_AUTH_COOKIE_SECURE = (
  342. os.environ.get(
  343. "WEBUI_AUTH_COOKIE_SECURE",
  344. os.environ.get("WEBUI_SESSION_COOKIE_SECURE", "false"),
  345. ).lower()
  346. == "true"
  347. )
  348. if WEBUI_AUTH and WEBUI_SECRET_KEY == "":
  349. raise ValueError(ERROR_MESSAGES.ENV_VAR_NOT_FOUND)
  350. ENABLE_COMPRESSION_MIDDLEWARE = (
  351. os.environ.get("ENABLE_COMPRESSION_MIDDLEWARE", "True").lower() == "true"
  352. )
  353. ####################################
  354. # SCIM Configuration
  355. ####################################
  356. SCIM_ENABLED = os.environ.get("SCIM_ENABLED", "False").lower() == "true"
  357. SCIM_TOKEN = os.environ.get("SCIM_TOKEN", "")
  358. ####################################
  359. # LICENSE_KEY
  360. ####################################
  361. LICENSE_KEY = os.environ.get("LICENSE_KEY", "")
  362. LICENSE_BLOB = None
  363. LICENSE_BLOB_PATH = os.environ.get("LICENSE_BLOB_PATH", DATA_DIR / "l.data")
  364. if LICENSE_BLOB_PATH and os.path.exists(LICENSE_BLOB_PATH):
  365. with open(LICENSE_BLOB_PATH, "rb") as f:
  366. LICENSE_BLOB = f.read()
  367. LICENSE_PUBLIC_KEY = os.environ.get("LICENSE_PUBLIC_KEY", "")
  368. pk = None
  369. if LICENSE_PUBLIC_KEY:
  370. pk = serialization.load_pem_public_key(
  371. f"""
  372. -----BEGIN PUBLIC KEY-----
  373. {LICENSE_PUBLIC_KEY}
  374. -----END PUBLIC KEY-----
  375. """.encode(
  376. "utf-8"
  377. )
  378. )
  379. ####################################
  380. # MODELS
  381. ####################################
  382. MODELS_CACHE_TTL = os.environ.get("MODELS_CACHE_TTL", "1")
  383. if MODELS_CACHE_TTL == "":
  384. MODELS_CACHE_TTL = None
  385. else:
  386. try:
  387. MODELS_CACHE_TTL = int(MODELS_CACHE_TTL)
  388. except Exception:
  389. MODELS_CACHE_TTL = 1
  390. ####################################
  391. # CHAT
  392. ####################################
  393. CHAT_RESPONSE_STREAM_DELTA_CHUNK_SIZE = os.environ.get(
  394. "CHAT_RESPONSE_STREAM_DELTA_CHUNK_SIZE", "1"
  395. )
  396. if CHAT_RESPONSE_STREAM_DELTA_CHUNK_SIZE == "":
  397. CHAT_RESPONSE_STREAM_DELTA_CHUNK_SIZE = 1
  398. else:
  399. try:
  400. CHAT_RESPONSE_STREAM_DELTA_CHUNK_SIZE = int(
  401. CHAT_RESPONSE_STREAM_DELTA_CHUNK_SIZE
  402. )
  403. except Exception:
  404. CHAT_RESPONSE_STREAM_DELTA_CHUNK_SIZE = 1
  405. ####################################
  406. # WEBSOCKET SUPPORT
  407. ####################################
  408. ENABLE_WEBSOCKET_SUPPORT = (
  409. os.environ.get("ENABLE_WEBSOCKET_SUPPORT", "True").lower() == "true"
  410. )
  411. WEBSOCKET_MANAGER = os.environ.get("WEBSOCKET_MANAGER", "")
  412. WEBSOCKET_REDIS_URL = os.environ.get("WEBSOCKET_REDIS_URL", REDIS_URL)
  413. WEBSOCKET_REDIS_CLUSTER = (
  414. os.environ.get("WEBSOCKET_REDIS_CLUSTER", str(REDIS_CLUSTER)).lower() == "true"
  415. )
  416. websocket_redis_lock_timeout = os.environ.get("WEBSOCKET_REDIS_LOCK_TIMEOUT", "60")
  417. try:
  418. WEBSOCKET_REDIS_LOCK_TIMEOUT = int(websocket_redis_lock_timeout)
  419. except ValueError:
  420. WEBSOCKET_REDIS_LOCK_TIMEOUT = 60
  421. WEBSOCKET_SENTINEL_HOSTS = os.environ.get("WEBSOCKET_SENTINEL_HOSTS", "")
  422. WEBSOCKET_SENTINEL_PORT = os.environ.get("WEBSOCKET_SENTINEL_PORT", "26379")
  423. AIOHTTP_CLIENT_TIMEOUT = os.environ.get("AIOHTTP_CLIENT_TIMEOUT", "")
  424. if AIOHTTP_CLIENT_TIMEOUT == "":
  425. AIOHTTP_CLIENT_TIMEOUT = None
  426. else:
  427. try:
  428. AIOHTTP_CLIENT_TIMEOUT = int(AIOHTTP_CLIENT_TIMEOUT)
  429. except Exception:
  430. AIOHTTP_CLIENT_TIMEOUT = 300
  431. AIOHTTP_CLIENT_SESSION_SSL = (
  432. os.environ.get("AIOHTTP_CLIENT_SESSION_SSL", "True").lower() == "true"
  433. )
  434. AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST = os.environ.get(
  435. "AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST",
  436. os.environ.get("AIOHTTP_CLIENT_TIMEOUT_OPENAI_MODEL_LIST", "10"),
  437. )
  438. if AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST == "":
  439. AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST = None
  440. else:
  441. try:
  442. AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST = int(AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST)
  443. except Exception:
  444. AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST = 10
  445. AIOHTTP_CLIENT_TIMEOUT_TOOL_SERVER_DATA = os.environ.get(
  446. "AIOHTTP_CLIENT_TIMEOUT_TOOL_SERVER_DATA", "10"
  447. )
  448. if AIOHTTP_CLIENT_TIMEOUT_TOOL_SERVER_DATA == "":
  449. AIOHTTP_CLIENT_TIMEOUT_TOOL_SERVER_DATA = None
  450. else:
  451. try:
  452. AIOHTTP_CLIENT_TIMEOUT_TOOL_SERVER_DATA = int(
  453. AIOHTTP_CLIENT_TIMEOUT_TOOL_SERVER_DATA
  454. )
  455. except Exception:
  456. AIOHTTP_CLIENT_TIMEOUT_TOOL_SERVER_DATA = 10
  457. AIOHTTP_CLIENT_SESSION_TOOL_SERVER_SSL = (
  458. os.environ.get("AIOHTTP_CLIENT_SESSION_TOOL_SERVER_SSL", "True").lower() == "true"
  459. )
  460. ####################################
  461. # SENTENCE TRANSFORMERS
  462. ####################################
  463. SENTENCE_TRANSFORMERS_BACKEND = os.environ.get("SENTENCE_TRANSFORMERS_BACKEND", "")
  464. if SENTENCE_TRANSFORMERS_BACKEND == "":
  465. SENTENCE_TRANSFORMERS_BACKEND = "torch"
  466. SENTENCE_TRANSFORMERS_MODEL_KWARGS = os.environ.get(
  467. "SENTENCE_TRANSFORMERS_MODEL_KWARGS", ""
  468. )
  469. if SENTENCE_TRANSFORMERS_MODEL_KWARGS == "":
  470. SENTENCE_TRANSFORMERS_MODEL_KWARGS = None
  471. else:
  472. try:
  473. SENTENCE_TRANSFORMERS_MODEL_KWARGS = json.loads(
  474. SENTENCE_TRANSFORMERS_MODEL_KWARGS
  475. )
  476. except Exception:
  477. SENTENCE_TRANSFORMERS_MODEL_KWARGS = None
  478. SENTENCE_TRANSFORMERS_CROSS_ENCODER_BACKEND = os.environ.get(
  479. "SENTENCE_TRANSFORMERS_CROSS_ENCODER_BACKEND", ""
  480. )
  481. if SENTENCE_TRANSFORMERS_CROSS_ENCODER_BACKEND == "":
  482. SENTENCE_TRANSFORMERS_CROSS_ENCODER_BACKEND = "torch"
  483. SENTENCE_TRANSFORMERS_CROSS_ENCODER_MODEL_KWARGS = os.environ.get(
  484. "SENTENCE_TRANSFORMERS_CROSS_ENCODER_MODEL_KWARGS", ""
  485. )
  486. if SENTENCE_TRANSFORMERS_CROSS_ENCODER_MODEL_KWARGS == "":
  487. SENTENCE_TRANSFORMERS_CROSS_ENCODER_MODEL_KWARGS = None
  488. else:
  489. try:
  490. SENTENCE_TRANSFORMERS_CROSS_ENCODER_MODEL_KWARGS = json.loads(
  491. SENTENCE_TRANSFORMERS_CROSS_ENCODER_MODEL_KWARGS
  492. )
  493. except Exception:
  494. SENTENCE_TRANSFORMERS_CROSS_ENCODER_MODEL_KWARGS = None
  495. ####################################
  496. # OFFLINE_MODE
  497. ####################################
  498. ENABLE_VERSION_UPDATE_CHECK = (
  499. os.environ.get("ENABLE_VERSION_UPDATE_CHECK", "true").lower() == "true"
  500. )
  501. OFFLINE_MODE = os.environ.get("OFFLINE_MODE", "false").lower() == "true"
  502. if OFFLINE_MODE:
  503. os.environ["HF_HUB_OFFLINE"] = "1"
  504. ENABLE_VERSION_UPDATE_CHECK = False
  505. ####################################
  506. # AUDIT LOGGING
  507. ####################################
  508. # Where to store log file
  509. AUDIT_LOGS_FILE_PATH = f"{DATA_DIR}/audit.log"
  510. # Maximum size of a file before rotating into a new log file
  511. AUDIT_LOG_FILE_ROTATION_SIZE = os.getenv("AUDIT_LOG_FILE_ROTATION_SIZE", "10MB")
  512. # Comma separated list of logger names to use for audit logging
  513. # Default is "uvicorn.access" which is the access log for Uvicorn
  514. # You can add more logger names to this list if you want to capture more logs
  515. AUDIT_UVICORN_LOGGER_NAMES = os.getenv(
  516. "AUDIT_UVICORN_LOGGER_NAMES", "uvicorn.access"
  517. ).split(",")
  518. # METADATA | REQUEST | REQUEST_RESPONSE
  519. AUDIT_LOG_LEVEL = os.getenv("AUDIT_LOG_LEVEL", "NONE").upper()
  520. try:
  521. MAX_BODY_LOG_SIZE = int(os.environ.get("MAX_BODY_LOG_SIZE") or 2048)
  522. except ValueError:
  523. MAX_BODY_LOG_SIZE = 2048
  524. # Comma separated list for urls to exclude from audit
  525. AUDIT_EXCLUDED_PATHS = os.getenv("AUDIT_EXCLUDED_PATHS", "/chats,/chat,/folders").split(
  526. ","
  527. )
  528. AUDIT_EXCLUDED_PATHS = [path.strip() for path in AUDIT_EXCLUDED_PATHS]
  529. AUDIT_EXCLUDED_PATHS = [path.lstrip("/") for path in AUDIT_EXCLUDED_PATHS]
  530. ####################################
  531. # OPENTELEMETRY
  532. ####################################
  533. ENABLE_OTEL = os.environ.get("ENABLE_OTEL", "False").lower() == "true"
  534. ENABLE_OTEL_TRACES = os.environ.get("ENABLE_OTEL_TRACES", "False").lower() == "true"
  535. ENABLE_OTEL_METRICS = os.environ.get("ENABLE_OTEL_METRICS", "False").lower() == "true"
  536. ENABLE_OTEL_LOGS = os.environ.get("ENABLE_OTEL_LOGS", "False").lower() == "true"
  537. OTEL_EXPORTER_OTLP_ENDPOINT = os.environ.get(
  538. "OTEL_EXPORTER_OTLP_ENDPOINT", "http://localhost:4317"
  539. )
  540. OTEL_METRICS_EXPORTER_OTLP_ENDPOINT = os.environ.get(
  541. "OTEL_METRICS_EXPORTER_OTLP_ENDPOINT", OTEL_EXPORTER_OTLP_ENDPOINT
  542. )
  543. OTEL_LOGS_EXPORTER_OTLP_ENDPOINT = os.environ.get(
  544. "OTEL_LOGS_EXPORTER_OTLP_ENDPOINT", OTEL_EXPORTER_OTLP_ENDPOINT
  545. )
  546. OTEL_EXPORTER_OTLP_INSECURE = (
  547. os.environ.get("OTEL_EXPORTER_OTLP_INSECURE", "False").lower() == "true"
  548. )
  549. OTEL_METRICS_EXPORTER_OTLP_INSECURE = (
  550. os.environ.get(
  551. "OTEL_METRICS_EXPORTER_OTLP_INSECURE", str(OTEL_EXPORTER_OTLP_INSECURE)
  552. ).lower()
  553. == "true"
  554. )
  555. OTEL_LOGS_EXPORTER_OTLP_INSECURE = (
  556. os.environ.get(
  557. "OTEL_LOGS_EXPORTER_OTLP_INSECURE", str(OTEL_EXPORTER_OTLP_INSECURE)
  558. ).lower()
  559. == "true"
  560. )
  561. OTEL_SERVICE_NAME = os.environ.get("OTEL_SERVICE_NAME", "open-webui")
  562. OTEL_RESOURCE_ATTRIBUTES = os.environ.get(
  563. "OTEL_RESOURCE_ATTRIBUTES", ""
  564. ) # e.g. key1=val1,key2=val2
  565. OTEL_TRACES_SAMPLER = os.environ.get(
  566. "OTEL_TRACES_SAMPLER", "parentbased_always_on"
  567. ).lower()
  568. OTEL_BASIC_AUTH_USERNAME = os.environ.get("OTEL_BASIC_AUTH_USERNAME", "")
  569. OTEL_BASIC_AUTH_PASSWORD = os.environ.get("OTEL_BASIC_AUTH_PASSWORD", "")
  570. OTEL_METRICS_BASIC_AUTH_USERNAME = os.environ.get(
  571. "OTEL_METRICS_BASIC_AUTH_USERNAME", OTEL_BASIC_AUTH_USERNAME
  572. )
  573. OTEL_METRICS_BASIC_AUTH_PASSWORD = os.environ.get(
  574. "OTEL_METRICS_BASIC_AUTH_PASSWORD", OTEL_BASIC_AUTH_PASSWORD
  575. )
  576. OTEL_LOGS_BASIC_AUTH_USERNAME = os.environ.get(
  577. "OTEL_LOGS_BASIC_AUTH_USERNAME", OTEL_BASIC_AUTH_USERNAME
  578. )
  579. OTEL_LOGS_BASIC_AUTH_PASSWORD = os.environ.get(
  580. "OTEL_LOGS_BASIC_AUTH_PASSWORD", OTEL_BASIC_AUTH_PASSWORD
  581. )
  582. OTEL_OTLP_SPAN_EXPORTER = os.environ.get(
  583. "OTEL_OTLP_SPAN_EXPORTER", "grpc"
  584. ).lower() # grpc or http
  585. OTEL_METRICS_OTLP_SPAN_EXPORTER = os.environ.get(
  586. "OTEL_METRICS_OTLP_SPAN_EXPORTER", OTEL_OTLP_SPAN_EXPORTER
  587. ).lower() # grpc or http
  588. OTEL_LOGS_OTLP_SPAN_EXPORTER = os.environ.get(
  589. "OTEL_LOGS_OTLP_SPAN_EXPORTER", OTEL_OTLP_SPAN_EXPORTER
  590. ).lower() # grpc or http
  591. ####################################
  592. # TOOLS/FUNCTIONS PIP OPTIONS
  593. ####################################
  594. PIP_OPTIONS = os.getenv("PIP_OPTIONS", "").split()
  595. PIP_PACKAGE_INDEX_OPTIONS = os.getenv("PIP_PACKAGE_INDEX_OPTIONS", "").split()
  596. ####################################
  597. # PROGRESSIVE WEB APP OPTIONS
  598. ####################################
  599. EXTERNAL_PWA_MANIFEST_URL = os.environ.get("EXTERNAL_PWA_MANIFEST_URL")