config.py 36.7 KB
Newer Older
1
import os
2
3
import sys
import logging
Tang Ziya's avatar
Tang Ziya committed
4
5
import importlib.metadata
import pkgutil
6
import chromadb
Timothy J. Baek's avatar
Timothy J. Baek committed
7
from chromadb import Settings
8
from base64 import b64encode
9
from bs4 import BeautifulSoup
10
from typing import TypeVar, Generic, Union
Timothy J. Baek's avatar
Timothy J. Baek committed
11
12
from pydantic import BaseModel
from typing import Optional
13

Timothy J. Baek's avatar
Timothy J. Baek committed
14
from pathlib import Path
Timothy J. Baek's avatar
Timothy J. Baek committed
15
import json
Timothy J. Baek's avatar
Timothy J. Baek committed
16
17
import yaml

Timothy J. Baek's avatar
Timothy J. Baek committed
18
import markdown
19
20
21
22
23
import requests
import shutil

from secrets import token_bytes
from constants import ERROR_MESSAGES
Timothy J. Baek's avatar
Timothy J. Baek committed
24

Timothy J. Baek's avatar
Timothy J. Baek committed
25
26
27
28
####################################
# Load .env file
####################################

29
30
31
BACKEND_DIR = Path(__file__).parent  # the path containing this file
BASE_DIR = BACKEND_DIR.parent  # the path containing the backend/

Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
32
33
print(BASE_DIR)

Timothy J. Baek's avatar
Timothy J. Baek committed
34
35
36
try:
    from dotenv import load_dotenv, find_dotenv

37
    load_dotenv(find_dotenv(str(BASE_DIR / ".env")))
Timothy J. Baek's avatar
Timothy J. Baek committed
38
39
40
except ImportError:
    print("dotenv not installed, skipping...")

41

42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
####################################
# LOGGING
####################################

log_levels = ["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"]

GLOBAL_LOG_LEVEL = os.environ.get("GLOBAL_LOG_LEVEL", "").upper()
if GLOBAL_LOG_LEVEL in log_levels:
    logging.basicConfig(stream=sys.stdout, level=GLOBAL_LOG_LEVEL, force=True)
else:
    GLOBAL_LOG_LEVEL = "INFO"

log = logging.getLogger(__name__)
log.info(f"GLOBAL_LOG_LEVEL: {GLOBAL_LOG_LEVEL}")

log_sources = [
    "AUDIO",
    "COMFYUI",
    "CONFIG",
    "DB",
    "IMAGES",
    "MAIN",
    "MODELS",
    "OLLAMA",
    "OPENAI",
    "RAG",
    "WEBHOOK",
]

SRC_LOG_LEVELS = {}

for source in log_sources:
    log_env_var = source + "_LOG_LEVEL"
    SRC_LOG_LEVELS[source] = os.environ.get(log_env_var, "").upper()
    if SRC_LOG_LEVELS[source] not in log_levels:
        SRC_LOG_LEVELS[source] = GLOBAL_LOG_LEVEL
    log.info(f"{log_env_var}: {SRC_LOG_LEVELS[source]}")

log.setLevel(SRC_LOG_LEVELS["CONFIG"])

82
WEBUI_NAME = os.environ.get("WEBUI_NAME", "Open WebUI")
Timothy J. Baek's avatar
Timothy J. Baek committed
83
84
85
if WEBUI_NAME != "Open WebUI":
    WEBUI_NAME += " (Open WebUI)"

86
87
WEBUI_URL = os.environ.get("WEBUI_URL", "http://localhost:3000")

88
WEBUI_FAVICON_URL = "https://openwebui.com/favicon.png"
Timothy J. Baek's avatar
Timothy J. Baek committed
89

90

Timothy J. Baek's avatar
Timothy J. Baek committed
91
####################################
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
92
# ENV (dev,test,prod)
Timothy J. Baek's avatar
Timothy J. Baek committed
93
94
####################################

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
95
ENV = os.environ.get("ENV", "dev")
Timothy J. Baek's avatar
Timothy J. Baek committed
96

Timothy J. Baek's avatar
Timothy J. Baek committed
97
try:
98
    PACKAGE_DATA = json.loads((BASE_DIR / "package.json").read_text())
Timothy J. Baek's avatar
Timothy J. Baek committed
99
except:
Tang Ziya's avatar
Tang Ziya committed
100
101
102
103
    try:
        PACKAGE_DATA = {"version": importlib.metadata.version("open-webui")}
    except importlib.metadata.PackageNotFoundError:
        PACKAGE_DATA = {"version": "0.0.0"}
Timothy J. Baek's avatar
Timothy J. Baek committed
104
105
106

VERSION = PACKAGE_DATA["version"]

Timothy J. Baek's avatar
Timothy J. Baek committed
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

# Function to parse each section
def parse_section(section):
    items = []
    for li in section.find_all("li"):
        # Extract raw HTML string
        raw_html = str(li)

        # Extract text without HTML tags
        text = li.get_text(separator=" ", strip=True)

        # Split into title and content
        parts = text.split(": ", 1)
        title = parts[0].strip() if len(parts) > 1 else ""
        content = parts[1].strip() if len(parts) > 1 else text

        items.append({"title": title, "content": content, "raw": raw_html})
    return items


try:
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
128
    changelog_path = BASE_DIR / "CHANGELOG.md"
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
129
    with open(str(changelog_path.absolute()), "r", encoding="utf8") as file:
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
130
131
        changelog_content = file.read()

Timothy J. Baek's avatar
Timothy J. Baek committed
132
except:
Tang Ziya's avatar
Tang Ziya committed
133
134
    changelog_content = (pkgutil.get_data("open_webui", "CHANGELOG.md") or b"").decode()

Timothy J. Baek's avatar
Timothy J. Baek committed
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

# Convert markdown content to HTML
html_content = markdown.markdown(changelog_content)

# Parse the HTML content
soup = BeautifulSoup(html_content, "html.parser")

# Initialize JSON structure
changelog_json = {}

# Iterate over each version
for version in soup.find_all("h2"):
    version_number = version.get_text().strip().split(" - ")[0][1:-1]  # Remove brackets
    date = version.get_text().strip().split(" - ")[1]

    version_data = {"date": date}

    # Find the next sibling that is a h3 tag (section title)
    current = version.find_next_sibling()

    while current and current.name != "h2":
        if current.name == "h3":
            section_title = current.get_text().lower()  # e.g., "added", "fixed"
            section_items = parse_section(current.find_next_sibling("ul"))
            version_data[section_title] = section_items

        # Move to the next element
        current = current.find_next_sibling()

    changelog_json[version_number] = version_data

166

Timothy J. Baek's avatar
Timothy J. Baek committed
167
168
CHANGELOG = changelog_json

169

Timothy J. Baek's avatar
Timothy J. Baek committed
170
171
172
173
174
175
####################################
# SAFE_MODE
####################################

SAFE_MODE = os.environ.get("SAFE_MODE", "false").lower() == "true"

176
####################################
177
# WEBUI_BUILD_HASH
178
179
####################################

180
WEBUI_BUILD_HASH = os.environ.get("WEBUI_BUILD_HASH", "dev-build")
181

182
183
184
185
####################################
# DATA/FRONTEND BUILD DIR
####################################

186
187
DATA_DIR = Path(os.getenv("DATA_DIR", BACKEND_DIR / "data")).resolve()
FRONTEND_BUILD_DIR = Path(os.getenv("FRONTEND_BUILD_DIR", BASE_DIR / "build")).resolve()
188

Timothy J. Baek's avatar
Timothy J. Baek committed
189
190
191
192
193
194
195
196
197
198
199
RESET_CONFIG_ON_START = (
    os.environ.get("RESET_CONFIG_ON_START", "False").lower() == "true"
)
if RESET_CONFIG_ON_START:
    try:
        os.remove(f"{DATA_DIR}/config.json")
        with open(f"{DATA_DIR}/config.json", "w") as f:
            f.write("{}")
    except:
        pass

200
try:
201
    CONFIG_DATA = json.loads((DATA_DIR / "config.json").read_text())
202
203
204
except:
    CONFIG_DATA = {}

205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232

####################################
# Config helpers
####################################


def save_config():
    try:
        with open(f"{DATA_DIR}/config.json", "w") as f:
            json.dump(CONFIG_DATA, f, indent="\t")
    except Exception as e:
        log.exception(e)


def get_config_value(config_path: str):
    path_parts = config_path.split(".")
    cur_config = CONFIG_DATA
    for key in path_parts:
        if key in cur_config:
            cur_config = cur_config[key]
        else:
            return None
    return cur_config


T = TypeVar("T")


Timothy J. Baek's avatar
Timothy J. Baek committed
233
class PersistentConfig(Generic[T]):
234
235
236
237
238
239
240
241
242
243
244
245
246
247
    def __init__(self, env_name: str, config_path: str, env_value: T):
        self.env_name = env_name
        self.config_path = config_path
        self.env_value = env_value
        self.config_value = get_config_value(config_path)
        if self.config_value is not None:
            log.info(f"'{env_name}' loaded from config.json")
            self.value = self.config_value
        else:
            self.value = env_value

    def __str__(self):
        return str(self.value)

248
249
250
    @property
    def __dict__(self):
        raise TypeError(
Timothy J. Baek's avatar
Timothy J. Baek committed
251
            "PersistentConfig object cannot be converted to dict, use config_get or .value instead."
252
253
254
255
256
        )

    def __getattribute__(self, item):
        if item == "__dict__":
            raise TypeError(
Timothy J. Baek's avatar
Timothy J. Baek committed
257
                "PersistentConfig object cannot be converted to dict, use config_get or .value instead."
258
259
260
            )
        return super().__getattribute__(item)

261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
    def save(self):
        # Don't save if the value is the same as the env value and the config value
        if self.env_value == self.value:
            if self.config_value == self.value:
                return
        log.info(f"Saving '{self.env_name}' to config.json")
        path_parts = self.config_path.split(".")
        config = CONFIG_DATA
        for key in path_parts[:-1]:
            if key not in config:
                config[key] = {}
            config = config[key]
        config[path_parts[-1]] = self.value
        save_config()
        self.config_value = self.value


278
class AppConfig:
Timothy J. Baek's avatar
Timothy J. Baek committed
279
    _state: dict[str, PersistentConfig]
280
281
282
283
284

    def __init__(self):
        super().__setattr__("_state", {})

    def __setattr__(self, key, value):
Timothy J. Baek's avatar
Timothy J. Baek committed
285
        if isinstance(value, PersistentConfig):
286
287
288
289
290
291
292
            self._state[key] = value
        else:
            self._state[key].value = value
            self._state[key].save()

    def __getattr__(self, key):
        return self._state[key].value
293
294
295
296
297
298
299
300
301
302


####################################
# WEBUI_AUTH (Required for security)
####################################

WEBUI_AUTH = os.environ.get("WEBUI_AUTH", "True").lower() == "true"
WEBUI_AUTH_TRUSTED_EMAIL_HEADER = os.environ.get(
    "WEBUI_AUTH_TRUSTED_EMAIL_HEADER", None
)
Timothy J. Baek's avatar
Timothy J. Baek committed
303
WEBUI_AUTH_TRUSTED_NAME_HEADER = os.environ.get("WEBUI_AUTH_TRUSTED_NAME_HEADER", None)
Timothy J. Baek's avatar
Timothy J. Baek committed
304
JWT_EXPIRES_IN = PersistentConfig(
305
306
307
    "JWT_EXPIRES_IN", "auth.jwt_expiry", os.environ.get("JWT_EXPIRES_IN", "-1")
)

308
309
310
311
312
313
314
315
316
317
####################################
# OAuth config
####################################

ENABLE_OAUTH_SIGNUP = PersistentConfig(
    "ENABLE_OAUTH_SIGNUP",
    "oauth.enable_signup",
    os.environ.get("ENABLE_OAUTH_SIGNUP", "False").lower() == "true",
)

318
319
320
321
322
323
OAUTH_MERGE_ACCOUNTS_BY_EMAIL = PersistentConfig(
    "OAUTH_MERGE_ACCOUNTS_BY_EMAIL",
    "oauth.merge_accounts_by_email",
    os.environ.get("OAUTH_MERGE_ACCOUNTS_BY_EMAIL", "False").lower() == "true",
)

324
325
OAUTH_PROVIDERS = {}

326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
GOOGLE_CLIENT_ID = PersistentConfig(
    "GOOGLE_CLIENT_ID",
    "oauth.google.client_id",
    os.environ.get("GOOGLE_CLIENT_ID", ""),
)

GOOGLE_CLIENT_SECRET = PersistentConfig(
    "GOOGLE_CLIENT_SECRET",
    "oauth.google.client_secret",
    os.environ.get("GOOGLE_CLIENT_SECRET", ""),
)

GOOGLE_OAUTH_SCOPE = PersistentConfig(
    "GOOGLE_OAUTH_SCOPE",
    "oauth.google.scope",
    os.environ.get("GOOGLE_OAUTH_SCOPE", "openid email profile"),
)

MICROSOFT_CLIENT_ID = PersistentConfig(
    "MICROSOFT_CLIENT_ID",
    "oauth.microsoft.client_id",
    os.environ.get("MICROSOFT_CLIENT_ID", ""),
)

MICROSOFT_CLIENT_SECRET = PersistentConfig(
    "MICROSOFT_CLIENT_SECRET",
    "oauth.microsoft.client_secret",
    os.environ.get("MICROSOFT_CLIENT_SECRET", ""),
)

MICROSOFT_CLIENT_TENANT_ID = PersistentConfig(
    "MICROSOFT_CLIENT_TENANT_ID",
    "oauth.microsoft.tenant_id",
    os.environ.get("MICROSOFT_CLIENT_TENANT_ID", ""),
)

MICROSOFT_OAUTH_SCOPE = PersistentConfig(
    "MICROSOFT_OAUTH_SCOPE",
    "oauth.microsoft.scope",
    os.environ.get("MICROSOFT_OAUTH_SCOPE", "openid email profile"),
)

OAUTH_CLIENT_ID = PersistentConfig(
    "OAUTH_CLIENT_ID",
    "oauth.oidc.client_id",
    os.environ.get("OAUTH_CLIENT_ID", ""),
)

OAUTH_CLIENT_SECRET = PersistentConfig(
    "OAUTH_CLIENT_SECRET",
    "oauth.oidc.client_secret",
    os.environ.get("OAUTH_CLIENT_SECRET", ""),
)

OPENID_PROVIDER_URL = PersistentConfig(
    "OPENID_PROVIDER_URL",
    "oauth.oidc.provider_url",
    os.environ.get("OPENID_PROVIDER_URL", ""),
)

OAUTH_SCOPES = PersistentConfig(
    "OAUTH_SCOPES",
    "oauth.oidc.scopes",
    os.environ.get("OAUTH_SCOPES", "openid email profile"),
)

OAUTH_PROVIDER_NAME = PersistentConfig(
    "OAUTH_PROVIDER_NAME",
    "oauth.oidc.provider_name",
    os.environ.get("OAUTH_PROVIDER_NAME", "SSO"),
)

398
399
400
401
402
403
404
405
406
407
408
409
OAUTH_USERNAME_CLAIM = PersistentConfig(
    "OAUTH_USERNAME_CLAIM",
    "oauth.oidc.username_claim",
    os.environ.get("OAUTH_USERNAME_CLAIM", "name"),
)

OAUTH_PICTURE_CLAIM = PersistentConfig(
    "OAUTH_USERNAME_CLAIM",
    "oauth.oidc.avatar_claim",
    os.environ.get("OAUTH_PICTURE_CLAIM", "picture"),
)

410

411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
def load_oauth_providers():
    OAUTH_PROVIDERS.clear()
    if GOOGLE_CLIENT_ID.value and GOOGLE_CLIENT_SECRET.value:
        OAUTH_PROVIDERS["google"] = {
            "client_id": GOOGLE_CLIENT_ID.value,
            "client_secret": GOOGLE_CLIENT_SECRET.value,
            "server_metadata_url": "https://accounts.google.com/.well-known/openid-configuration",
            "scope": GOOGLE_OAUTH_SCOPE.value,
        }

    if (
        MICROSOFT_CLIENT_ID.value
        and MICROSOFT_CLIENT_SECRET.value
        and MICROSOFT_CLIENT_TENANT_ID.value
    ):
        OAUTH_PROVIDERS["microsoft"] = {
            "client_id": MICROSOFT_CLIENT_ID.value,
            "client_secret": MICROSOFT_CLIENT_SECRET.value,
            "server_metadata_url": f"https://login.microsoftonline.com/{MICROSOFT_CLIENT_TENANT_ID.value}/v2.0/.well-known/openid-configuration",
            "scope": MICROSOFT_OAUTH_SCOPE.value,
        }

    if (
        OAUTH_CLIENT_ID.value
        and OAUTH_CLIENT_SECRET.value
        and OPENID_PROVIDER_URL.value
    ):
        OAUTH_PROVIDERS["oidc"] = {
            "client_id": OAUTH_CLIENT_ID.value,
            "client_secret": OAUTH_CLIENT_SECRET.value,
            "server_metadata_url": OPENID_PROVIDER_URL.value,
            "scope": OAUTH_SCOPES.value,
            "name": OAUTH_PROVIDER_NAME.value,
        }


load_oauth_providers()
448

449
450
451
452
####################################
# Static DIR
####################################

453
STATIC_DIR = Path(os.getenv("STATIC_DIR", BACKEND_DIR / "static")).resolve()
454

455
456
frontend_favicon = FRONTEND_BUILD_DIR / "favicon.png"
if frontend_favicon.exists():
457
458
    try:
        shutil.copyfile(frontend_favicon, STATIC_DIR / "favicon.png")
459
460
    except Exception as e:
        logging.error(f"An error occurred: {e}")
461

462
463
else:
    logging.warning(f"Frontend favicon not found at {frontend_favicon}")
464
465
466
467
468
469

####################################
# CUSTOM_NAME
####################################

CUSTOM_NAME = os.environ.get("CUSTOM_NAME", "")
Timothy J. Baek's avatar
Timothy J. Baek committed
470

471
if CUSTOM_NAME:
Timothy J. Baek's avatar
Timothy J. Baek committed
472
473
474
475
476
    try:
        r = requests.get(f"https://api.openwebui.com/api/v1/custom/{CUSTOM_NAME}")
        data = r.json()
        if r.ok:
            if "logo" in data:
477
                WEBUI_FAVICON_URL = url = (
Timothy J. Baek's avatar
Timothy J. Baek committed
478
479
480
481
482
483
484
                    f"https://api.openwebui.com{data['logo']}"
                    if data["logo"][0] == "/"
                    else data["logo"]
                )

                r = requests.get(url, stream=True)
                if r.status_code == 200:
485
                    with open(f"{STATIC_DIR}/favicon.png", "wb") as f:
Timothy J. Baek's avatar
Timothy J. Baek committed
486
487
488
489
490
                        r.raw.decode_content = True
                        shutil.copyfileobj(r.raw, f)

            WEBUI_NAME = data["name"]
    except Exception as e:
491
        log.exception(e)
Timothy J. Baek's avatar
Timothy J. Baek committed
492
        pass
493

494

495
####################################
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
496
# File Upload DIR
497
498
####################################

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
499
500
UPLOAD_DIR = f"{DATA_DIR}/uploads"
Path(UPLOAD_DIR).mkdir(parents=True, exist_ok=True)
Timothy J. Baek's avatar
Timothy J. Baek committed
501

502

Timothy J. Baek's avatar
Timothy J. Baek committed
503
504
505
506
507
508
509
####################################
# Cache DIR
####################################

CACHE_DIR = f"{DATA_DIR}/cache"
Path(CACHE_DIR).mkdir(parents=True, exist_ok=True)

510

511
512
513
514
####################################
# Docs DIR
####################################

515
DOCS_DIR = os.getenv("DOCS_DIR", f"{DATA_DIR}/docs")
516
Path(DOCS_DIR).mkdir(parents=True, exist_ok=True)
Timothy J. Baek's avatar
Timothy J. Baek committed
517

Timothy J. Baek's avatar
Timothy J. Baek committed
518

Timothy J. Baek's avatar
Timothy J. Baek committed
519
520
521
522
523
524
525
526
####################################
# Tools DIR
####################################

TOOLS_DIR = os.getenv("TOOLS_DIR", f"{DATA_DIR}/tools")
Path(TOOLS_DIR).mkdir(parents=True, exist_ok=True)


Timothy J. Baek's avatar
Timothy J. Baek committed
527
528
529
530
531
532
533
534
####################################
# Functions DIR
####################################

FUNCTIONS_DIR = os.getenv("FUNCTIONS_DIR", f"{DATA_DIR}/functions")
Path(FUNCTIONS_DIR).mkdir(parents=True, exist_ok=True)


Timothy J. Baek's avatar
Timothy J. Baek committed
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
####################################
# LITELLM_CONFIG
####################################


def create_config_file(file_path):
    directory = os.path.dirname(file_path)

    # Check if directory exists, if not, create it
    if not os.path.exists(directory):
        os.makedirs(directory)

    # Data to write into the YAML file
    config_data = {
        "general_settings": {},
        "litellm_settings": {},
        "model_list": [],
        "router_settings": {},
    }

    # Write data to YAML file
    with open(file_path, "w") as file:
        yaml.dump(config_data, file)


LITELLM_CONFIG_PATH = f"{DATA_DIR}/litellm/config.yaml"

Timothy J. Baek's avatar
Timothy J. Baek committed
562
563
564
565
# if not os.path.exists(LITELLM_CONFIG_PATH):
#     log.info("Config file doesn't exist. Creating...")
#     create_config_file(LITELLM_CONFIG_PATH)
#     log.info("Config file created successfully.")
Timothy J. Baek's avatar
Timothy J. Baek committed
566

567

568
####################################
Timothy J. Baek's avatar
Timothy J. Baek committed
569
# OLLAMA_BASE_URL
570
571
####################################

Timothy J. Baek's avatar
Timothy J. Baek committed
572
573
574
575
576
577
578

ENABLE_OLLAMA_API = PersistentConfig(
    "ENABLE_OLLAMA_API",
    "ollama.enable",
    os.environ.get("ENABLE_OLLAMA_API", "True").lower() == "true",
)

579
580
581
OLLAMA_API_BASE_URL = os.environ.get(
    "OLLAMA_API_BASE_URL", "http://localhost:11434/api"
)
Timothy J. Baek's avatar
Timothy J. Baek committed
582

583
OLLAMA_BASE_URL = os.environ.get("OLLAMA_BASE_URL", "")
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
584
AIOHTTP_CLIENT_TIMEOUT = os.environ.get("AIOHTTP_CLIENT_TIMEOUT", "")
585
586
587
588

if AIOHTTP_CLIENT_TIMEOUT == "":
    AIOHTTP_CLIENT_TIMEOUT = None
else:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
589
590
591
592
    try:
        AIOHTTP_CLIENT_TIMEOUT = int(AIOHTTP_CLIENT_TIMEOUT)
    except:
        AIOHTTP_CLIENT_TIMEOUT = 300
593
594


Timothy J. Baek's avatar
Timothy J. Baek committed
595
K8S_FLAG = os.environ.get("K8S_FLAG", "")
Jannik Streidl's avatar
Jannik Streidl committed
596
USE_OLLAMA_DOCKER = os.environ.get("USE_OLLAMA_DOCKER", "false")
597

598
if OLLAMA_BASE_URL == "" and OLLAMA_API_BASE_URL != "":
599
600
601
602
603
604
    OLLAMA_BASE_URL = (
        OLLAMA_API_BASE_URL[:-4]
        if OLLAMA_API_BASE_URL.endswith("/api")
        else OLLAMA_API_BASE_URL
    )

Timothy J. Baek's avatar
Timothy J. Baek committed
605
if ENV == "prod":
606
    if OLLAMA_BASE_URL == "/ollama" and not K8S_FLAG:
Jannik Streidl's avatar
Jannik Streidl committed
607
        if USE_OLLAMA_DOCKER.lower() == "true":
608
            # if you use all-in-one docker container (Open WebUI + Ollama)
Jannik Streidl's avatar
Jannik Streidl committed
609
            # with the docker build arg USE_OLLAMA=true (--build-arg="USE_OLLAMA=true") this only works with http://localhost:11434
610
            OLLAMA_BASE_URL = "http://localhost:11434"
611
        else:
612
            OLLAMA_BASE_URL = "http://host.docker.internal:11434"
Timothy J. Baek's avatar
Timothy J. Baek committed
613
    elif K8S_FLAG:
614
        OLLAMA_BASE_URL = "http://ollama-service.open-webui.svc.cluster.local:11434"
Timothy J. Baek's avatar
Timothy J. Baek committed
615

616

617
618
619
OLLAMA_BASE_URLS = os.environ.get("OLLAMA_BASE_URLS", "")
OLLAMA_BASE_URLS = OLLAMA_BASE_URLS if OLLAMA_BASE_URLS != "" else OLLAMA_BASE_URL

620
OLLAMA_BASE_URLS = [url.strip() for url in OLLAMA_BASE_URLS.split(";")]
Timothy J. Baek's avatar
Timothy J. Baek committed
621
OLLAMA_BASE_URLS = PersistentConfig(
622
623
    "OLLAMA_BASE_URLS", "ollama.base_urls", OLLAMA_BASE_URLS
)
624

Timothy J. Baek's avatar
Timothy J. Baek committed
625
626
627
628
####################################
# OPENAI_API
####################################

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
629
630
631
632
633
634
635
636

ENABLE_OPENAI_API = PersistentConfig(
    "ENABLE_OPENAI_API",
    "openai.enable",
    os.environ.get("ENABLE_OPENAI_API", "True").lower() == "true",
)


Timothy J. Baek's avatar
Timothy J. Baek committed
637
OPENAI_API_KEY = os.environ.get("OPENAI_API_KEY", "")
638
639
OPENAI_API_BASE_URL = os.environ.get("OPENAI_API_BASE_URL", "")

640

641
642
if OPENAI_API_BASE_URL == "":
    OPENAI_API_BASE_URL = "https://api.openai.com/v1"
Timothy J. Baek's avatar
Timothy J. Baek committed
643

Timothy J. Baek's avatar
Timothy J. Baek committed
644
645
646
OPENAI_API_KEYS = os.environ.get("OPENAI_API_KEYS", "")
OPENAI_API_KEYS = OPENAI_API_KEYS if OPENAI_API_KEYS != "" else OPENAI_API_KEY

Timothy J. Baek's avatar
Timothy J. Baek committed
647
OPENAI_API_KEYS = [url.strip() for url in OPENAI_API_KEYS.split(";")]
Timothy J. Baek's avatar
Timothy J. Baek committed
648
649
650
OPENAI_API_KEYS = PersistentConfig(
    "OPENAI_API_KEYS", "openai.api_keys", OPENAI_API_KEYS
)
Timothy J. Baek's avatar
Timothy J. Baek committed
651
652
653
654
655
656

OPENAI_API_BASE_URLS = os.environ.get("OPENAI_API_BASE_URLS", "")
OPENAI_API_BASE_URLS = (
    OPENAI_API_BASE_URLS if OPENAI_API_BASE_URLS != "" else OPENAI_API_BASE_URL
)

Timothy J. Baek's avatar
Timothy J. Baek committed
657
658
659
660
OPENAI_API_BASE_URLS = [
    url.strip() if url != "" else "https://api.openai.com/v1"
    for url in OPENAI_API_BASE_URLS.split(";")
]
Timothy J. Baek's avatar
Timothy J. Baek committed
661
OPENAI_API_BASE_URLS = PersistentConfig(
662
663
    "OPENAI_API_BASE_URLS", "openai.api_base_urls", OPENAI_API_BASE_URLS
)
664

Timothy J. Baek's avatar
Timothy J. Baek committed
665
OPENAI_API_KEY = ""
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
666
667

try:
668
669
    OPENAI_API_KEY = OPENAI_API_KEYS.value[
        OPENAI_API_BASE_URLS.value.index("https://api.openai.com/v1")
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
670
671
672
673
    ]
except:
    pass

Timothy J. Baek's avatar
Timothy J. Baek committed
674
675
OPENAI_API_BASE_URL = "https://api.openai.com/v1"

676
677
678
679
####################################
# WEBUI
####################################

Timothy J. Baek's avatar
Timothy J. Baek committed
680
ENABLE_SIGNUP = PersistentConfig(
681
682
683
684
685
686
687
688
    "ENABLE_SIGNUP",
    "ui.enable_signup",
    (
        False
        if not WEBUI_AUTH
        else os.environ.get("ENABLE_SIGNUP", "True").lower() == "true"
    ),
)
Timothy J. Baek's avatar
Timothy J. Baek committed
689
DEFAULT_MODELS = PersistentConfig(
690
    "DEFAULT_MODELS", "ui.default_models", os.environ.get("DEFAULT_MODELS", None)
691
)
Timothy J. Baek's avatar
Timothy J. Baek committed
692

Timothy J. Baek's avatar
Timothy J. Baek committed
693
DEFAULT_PROMPT_SUGGESTIONS = PersistentConfig(
694
695
696
    "DEFAULT_PROMPT_SUGGESTIONS",
    "ui.prompt_suggestions",
    [
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
        {
            "title": ["Help me study", "vocabulary for a college entrance exam"],
            "content": "Help me study vocabulary: write a sentence for me to fill in the blank, and I'll try to pick the correct option.",
        },
        {
            "title": ["Give me ideas", "for what to do with my kids' art"],
            "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.",
        },
        {
            "title": ["Tell me a fun fact", "about the Roman Empire"],
            "content": "Tell me a random fun fact about the Roman Empire",
        },
        {
            "title": ["Show me a code snippet", "of a website's sticky header"],
            "content": "Show me a code snippet of a website's sticky header in CSS and JavaScript.",
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
713
714
715
716
717
718
719
720
721
722
723
        {
            "title": [
                "Explain options trading",
                "if I'm familiar with buying and selling stocks",
            ],
            "content": "Explain options trading in simple terms if I'm familiar with buying and selling stocks.",
        },
        {
            "title": ["Overcome procrastination", "give me tips"],
            "content": "Could you start by asking me about instances when I procrastinate the most and then give me some suggestions to overcome it?",
        },
724
    ],
725
)
Timothy J. Baek's avatar
Timothy J. Baek committed
726

Timothy J. Baek's avatar
Timothy J. Baek committed
727
DEFAULT_USER_ROLE = PersistentConfig(
728
729
730
731
    "DEFAULT_USER_ROLE",
    "ui.default_user_role",
    os.getenv("DEFAULT_USER_ROLE", "pending"),
)
Timothy J. Baek's avatar
Timothy J. Baek committed
732

733
734
USER_PERMISSIONS_CHAT_DELETION = (
    os.environ.get("USER_PERMISSIONS_CHAT_DELETION", "True").lower() == "true"
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
735
)
736

Timothy J. Baek's avatar
Timothy J. Baek committed
737
USER_PERMISSIONS = PersistentConfig(
738
739
740
741
    "USER_PERMISSIONS",
    "ui.user_permissions",
    {"chat": {"deletion": USER_PERMISSIONS_CHAT_DELETION}},
)
Timothy J. Baek's avatar
Timothy J. Baek committed
742

Timothy J. Baek's avatar
Timothy J. Baek committed
743
ENABLE_MODEL_FILTER = PersistentConfig(
744
745
746
747
    "ENABLE_MODEL_FILTER",
    "model_filter.enable",
    os.environ.get("ENABLE_MODEL_FILTER", "False").lower() == "true",
)
748
MODEL_FILTER_LIST = os.environ.get("MODEL_FILTER_LIST", "")
Timothy J. Baek's avatar
Timothy J. Baek committed
749
MODEL_FILTER_LIST = PersistentConfig(
750
751
752
753
    "MODEL_FILTER_LIST",
    "model_filter.list",
    [model.strip() for model in MODEL_FILTER_LIST.split(";")],
)
754

Timothy J. Baek's avatar
Timothy J. Baek committed
755
WEBHOOK_URL = PersistentConfig(
756
757
    "WEBHOOK_URL", "webhook_url", os.environ.get("WEBHOOK_URL", "")
)
758

759
ENABLE_ADMIN_EXPORT = os.environ.get("ENABLE_ADMIN_EXPORT", "True").lower() == "true"
760

761
762
763
764
765
766
ENABLE_COMMUNITY_SHARING = PersistentConfig(
    "ENABLE_COMMUNITY_SHARING",
    "ui.enable_community_sharing",
    os.environ.get("ENABLE_COMMUNITY_SHARING", "True").lower() == "true",
)

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
767

Timothy J. Baek's avatar
Timothy J. Baek committed
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
class BannerModel(BaseModel):
    id: str
    type: str
    title: Optional[str] = None
    content: str
    dismissible: bool
    timestamp: int


WEBUI_BANNERS = PersistentConfig(
    "WEBUI_BANNERS",
    "ui.banners",
    [BannerModel(**banner) for banner in json.loads("[]")],
)

783
784
785
786
787
788
789
790
791
792
793
794
795
796

SHOW_ADMIN_DETAILS = PersistentConfig(
    "SHOW_ADMIN_DETAILS",
    "auth.admin.show",
    os.environ.get("SHOW_ADMIN_DETAILS", "true").lower() == "true",
)

ADMIN_EMAIL = PersistentConfig(
    "ADMIN_EMAIL",
    "auth.admin.email",
    os.environ.get("ADMIN_EMAIL", None),
)


Timothy J. Baek's avatar
Timothy J. Baek committed
797
798
799
800
801
####################################
# TASKS
####################################


Timothy J. Baek's avatar
Timothy J. Baek committed
802
803
804
805
806
807
808
809
810
811
812
813
TASK_MODEL = PersistentConfig(
    "TASK_MODEL",
    "task.model.default",
    os.environ.get("TASK_MODEL", ""),
)

TASK_MODEL_EXTERNAL = PersistentConfig(
    "TASK_MODEL_EXTERNAL",
    "task.model.external",
    os.environ.get("TASK_MODEL_EXTERNAL", ""),
)

Timothy J. Baek's avatar
Timothy J. Baek committed
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
TITLE_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
    "TITLE_GENERATION_PROMPT_TEMPLATE",
    "task.title.prompt_template",
    os.environ.get(
        "TITLE_GENERATION_PROMPT_TEMPLATE",
        """Here is the query:
{{prompt:middletruncate:8000}}

Create a concise, 3-5 word phrase with an emoji as a title for the previous query. Suitable Emojis for the summary can be used to enhance understanding but avoid quotation marks or special formatting. RESPOND ONLY WITH THE TITLE TEXT.

Examples of titles:
📉 Stock Market Trends
🍪 Perfect Chocolate Chip Recipe
Evolution of Music Streaming
Remote Work Productivity Tips
Artificial Intelligence in Healthcare
🎮 Video Game Development Insights""",
    ),
)


Timothy J. Baek's avatar
Timothy J. Baek committed
835
836
837
838
839
840
841
842
843
844
845
846
SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE = PersistentConfig(
    "SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE",
    "task.search.prompt_template",
    os.environ.get(
        "SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE",
        """You are tasked with generating web search queries. Give me an appropriate query to answer my question for google search. Answer with only the query. Today is {{CURRENT_DATE}}.
        
Question:
{{prompt:end:4000}}""",
    ),
)

Timothy J. Baek's avatar
Timothy J. Baek committed
847
848
849
SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD = PersistentConfig(
    "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD",
    "task.search.prompt_length_threshold",
Timothy J. Baek's avatar
Timothy J. Baek committed
850
851
852
853
854
    int(
        os.environ.get(
            "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD",
            100,
        )
Timothy J. Baek's avatar
Timothy J. Baek committed
855
856
857
    ),
)

Timothy J. Baek's avatar
Timothy J. Baek committed
858
859
860
861
862
863
864
865
866
867
868
TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = PersistentConfig(
    "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE",
    "task.tools.prompt_template",
    os.environ.get(
        "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE",
        """Tools: {{TOOLS}}
If a function tool doesn't match the query, return an empty string. Else, pick a function tool, fill in the parameters from the function tool's schema, and return it in the format { "name": \"functionName\", "parameters": { "key": "value" } }. Only pick a function if the user asks.  Only return the object. Do not return any other text.""",
    ),
)


Timothy J. Baek's avatar
Timothy J. Baek committed
869
####################################
870
# WEBUI_SECRET_KEY
Timothy J. Baek's avatar
Timothy J. Baek committed
871
872
####################################

873
874
WEBUI_SECRET_KEY = os.environ.get(
    "WEBUI_SECRET_KEY",
Timothy J. Baek's avatar
Timothy J. Baek committed
875
876
877
    os.environ.get(
        "WEBUI_JWT_SECRET_KEY", "t0p-s3cr3t"
    ),  # DEPRECATED: remove at next major version
878
)
879

880
881
882
883
884
WEBUI_SESSION_COOKIE_SAME_SITE = os.environ.get(
    "WEBUI_SESSION_COOKIE_SAME_SITE",
    os.environ.get("WEBUI_SESSION_COOKIE_SAME_SITE", "lax"),
)

885
886
887
888
889
WEBUI_SESSION_COOKIE_SECURE = os.environ.get(
    "WEBUI_SESSION_COOKIE_SECURE",
    os.environ.get("WEBUI_SESSION_COOKIE_SECURE", "false").lower() == "true",
)

890
if WEBUI_AUTH and WEBUI_SECRET_KEY == "":
Timothy J. Baek's avatar
Timothy J. Baek committed
891
    raise ValueError(ERROR_MESSAGES.ENV_VAR_NOT_FOUND)
892
893
894
895
896

####################################
# RAG
####################################

897
CHROMA_DATA_PATH = f"{DATA_DIR}/vector_db"
898
899
900
901
902
903
904
905
906
907
908
909
910
CHROMA_TENANT = os.environ.get("CHROMA_TENANT", chromadb.DEFAULT_TENANT)
CHROMA_DATABASE = os.environ.get("CHROMA_DATABASE", chromadb.DEFAULT_DATABASE)
CHROMA_HTTP_HOST = os.environ.get("CHROMA_HTTP_HOST", "")
CHROMA_HTTP_PORT = int(os.environ.get("CHROMA_HTTP_PORT", "8000"))
# Comma-separated list of header=value pairs
CHROMA_HTTP_HEADERS = os.environ.get("CHROMA_HTTP_HEADERS", "")
if CHROMA_HTTP_HEADERS:
    CHROMA_HTTP_HEADERS = dict(
        [pair.split("=") for pair in CHROMA_HTTP_HEADERS.split(",")]
    )
else:
    CHROMA_HTTP_HEADERS = None
CHROMA_HTTP_SSL = os.environ.get("CHROMA_HTTP_SSL", "false").lower() == "true"
911
# 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)
912

Timothy J. Baek's avatar
Timothy J. Baek committed
913
RAG_TOP_K = PersistentConfig(
914
915
    "RAG_TOP_K", "rag.top_k", int(os.environ.get("RAG_TOP_K", "5"))
)
Timothy J. Baek's avatar
Timothy J. Baek committed
916
RAG_RELEVANCE_THRESHOLD = PersistentConfig(
917
918
919
    "RAG_RELEVANCE_THRESHOLD",
    "rag.relevance_threshold",
    float(os.environ.get("RAG_RELEVANCE_THRESHOLD", "0.0")),
Timothy J. Baek's avatar
Timothy J. Baek committed
920
)
921

Timothy J. Baek's avatar
Timothy J. Baek committed
922
ENABLE_RAG_HYBRID_SEARCH = PersistentConfig(
923
924
925
926
    "ENABLE_RAG_HYBRID_SEARCH",
    "rag.enable_hybrid_search",
    os.environ.get("ENABLE_RAG_HYBRID_SEARCH", "").lower() == "true",
)
927

Timothy J. Baek's avatar
Timothy J. Baek committed
928
ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = PersistentConfig(
929
930
931
    "ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION",
    "rag.enable_web_loader_ssl_verification",
    os.environ.get("ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION", "True").lower() == "true",
932
933
)

Timothy J. Baek's avatar
Timothy J. Baek committed
934
RAG_EMBEDDING_ENGINE = PersistentConfig(
935
936
937
938
    "RAG_EMBEDDING_ENGINE",
    "rag.embedding_engine",
    os.environ.get("RAG_EMBEDDING_ENGINE", ""),
)
939

Timothy J. Baek's avatar
Timothy J. Baek committed
940
PDF_EXTRACT_IMAGES = PersistentConfig(
941
942
943
944
    "PDF_EXTRACT_IMAGES",
    "rag.pdf_extract_images",
    os.environ.get("PDF_EXTRACT_IMAGES", "False").lower() == "true",
)
945

Timothy J. Baek's avatar
Timothy J. Baek committed
946
RAG_EMBEDDING_MODEL = PersistentConfig(
947
948
949
    "RAG_EMBEDDING_MODEL",
    "rag.embedding_model",
    os.environ.get("RAG_EMBEDDING_MODEL", "sentence-transformers/all-MiniLM-L6-v2"),
950
)
951
log.info(f"Embedding model set: {RAG_EMBEDDING_MODEL.value}"),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
952

953
954
955
956
RAG_EMBEDDING_MODEL_AUTO_UPDATE = (
    os.environ.get("RAG_EMBEDDING_MODEL_AUTO_UPDATE", "").lower() == "true"
)

957
958
RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE = (
    os.environ.get("RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE", "").lower() == "true"
Steven Kreitzer's avatar
Steven Kreitzer committed
959
960
)

961
962
963
964
965
966
RAG_EMBEDDING_OPENAI_BATCH_SIZE = PersistentConfig(
    "RAG_EMBEDDING_OPENAI_BATCH_SIZE",
    "rag.embedding_openai_batch_size",
    os.environ.get("RAG_EMBEDDING_OPENAI_BATCH_SIZE", 1),
)

Timothy J. Baek's avatar
Timothy J. Baek committed
967
RAG_RERANKING_MODEL = PersistentConfig(
968
969
970
971
972
973
    "RAG_RERANKING_MODEL",
    "rag.reranking_model",
    os.environ.get("RAG_RERANKING_MODEL", ""),
)
if RAG_RERANKING_MODEL.value != "":
    log.info(f"Reranking model set: {RAG_RERANKING_MODEL.value}"),
Steven Kreitzer's avatar
Steven Kreitzer committed
974

975
976
977
978
RAG_RERANKING_MODEL_AUTO_UPDATE = (
    os.environ.get("RAG_RERANKING_MODEL_AUTO_UPDATE", "").lower() == "true"
)

Steven Kreitzer's avatar
Steven Kreitzer committed
979
980
RAG_RERANKING_MODEL_TRUST_REMOTE_CODE = (
    os.environ.get("RAG_RERANKING_MODEL_TRUST_REMOTE_CODE", "").lower() == "true"
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
981
)
982

983

984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
if CHROMA_HTTP_HOST != "":
    CHROMA_CLIENT = chromadb.HttpClient(
        host=CHROMA_HTTP_HOST,
        port=CHROMA_HTTP_PORT,
        headers=CHROMA_HTTP_HEADERS,
        ssl=CHROMA_HTTP_SSL,
        tenant=CHROMA_TENANT,
        database=CHROMA_DATABASE,
        settings=Settings(allow_reset=True, anonymized_telemetry=False),
    )
else:
    CHROMA_CLIENT = chromadb.PersistentClient(
        path=CHROMA_DATA_PATH,
        settings=Settings(allow_reset=True, anonymized_telemetry=False),
        tenant=CHROMA_TENANT,
        database=CHROMA_DATABASE,
    )
Timothy J. Baek's avatar
Timothy J. Baek committed
1001

1002

1003
1004
1005
1006
1007
1008
1009
1010
# device type embedding models - "cpu" (default), "cuda" (nvidia gpu required) or "mps" (apple silicon) - choosing this right can lead to better performance
USE_CUDA = os.environ.get("USE_CUDA_DOCKER", "false")

if USE_CUDA.lower() == "true":
    DEVICE_TYPE = "cuda"
else:
    DEVICE_TYPE = "cpu"

Timothy J. Baek's avatar
Timothy J. Baek committed
1011
CHUNK_SIZE = PersistentConfig(
1012
1013
    "CHUNK_SIZE", "rag.chunk_size", int(os.environ.get("CHUNK_SIZE", "1500"))
)
Timothy J. Baek's avatar
Timothy J. Baek committed
1014
CHUNK_OVERLAP = PersistentConfig(
1015
1016
1017
1018
    "CHUNK_OVERLAP",
    "rag.chunk_overlap",
    int(os.environ.get("CHUNK_OVERLAP", "100")),
)
Timothy J. Baek's avatar
Timothy J. Baek committed
1019

1020
DEFAULT_RAG_TEMPLATE = """Use the following context as your learned knowledge, inside <context></context> XML tags.
Timothy J. Baek's avatar
Timothy J. Baek committed
1021
1022
1023
1024
1025
1026
1027
1028
1029
<context>
    [context]
</context>

When answer to user:
- If you don't know, just say that you don't know.
- If you don't know when you are not sure, ask for clarification.
Avoid mentioning that you obtained the information from the context.
And answer according to the language of the user's question.
1030

Timothy J. Baek's avatar
Timothy J. Baek committed
1031
1032
1033
Given the context information, answer the query.
Query: [query]"""

Timothy J. Baek's avatar
Timothy J. Baek committed
1034
RAG_TEMPLATE = PersistentConfig(
1035
1036
1037
1038
    "RAG_TEMPLATE",
    "rag.template",
    os.environ.get("RAG_TEMPLATE", DEFAULT_RAG_TEMPLATE),
)
1039

Timothy J. Baek's avatar
Timothy J. Baek committed
1040
RAG_OPENAI_API_BASE_URL = PersistentConfig(
1041
1042
1043
1044
    "RAG_OPENAI_API_BASE_URL",
    "rag.openai_api_base_url",
    os.getenv("RAG_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
)
Timothy J. Baek's avatar
Timothy J. Baek committed
1045
RAG_OPENAI_API_KEY = PersistentConfig(
1046
1047
1048
1049
    "RAG_OPENAI_API_KEY",
    "rag.openai_api_key",
    os.getenv("RAG_OPENAI_API_KEY", OPENAI_API_KEY),
)
Timothy J. Baek's avatar
Timothy J. Baek committed
1050

1051
1052
1053
ENABLE_RAG_LOCAL_WEB_FETCH = (
    os.getenv("ENABLE_RAG_LOCAL_WEB_FETCH", "False").lower() == "true"
)
1054

Timothy J. Baek's avatar
Timothy J. Baek committed
1055
YOUTUBE_LOADER_LANGUAGE = PersistentConfig(
1056
1057
1058
1059
    "YOUTUBE_LOADER_LANGUAGE",
    "rag.youtube_loader_language",
    os.getenv("YOUTUBE_LOADER_LANGUAGE", "en").split(","),
)
1060

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1061

Timothy J. Baek's avatar
Timothy J. Baek committed
1062
1063
1064
1065
1066
1067
ENABLE_RAG_WEB_SEARCH = PersistentConfig(
    "ENABLE_RAG_WEB_SEARCH",
    "rag.web.search.enable",
    os.getenv("ENABLE_RAG_WEB_SEARCH", "False").lower() == "true",
)

Timothy J. Baek's avatar
Timothy J. Baek committed
1068
1069
1070
1071
1072
RAG_WEB_SEARCH_ENGINE = PersistentConfig(
    "RAG_WEB_SEARCH_ENGINE",
    "rag.web.search.engine",
    os.getenv("RAG_WEB_SEARCH_ENGINE", ""),
)
Timothy J. Baek's avatar
Timothy J. Baek committed
1073

Timothy J. Baek's avatar
Timothy J. Baek committed
1074
# You can provide a list of your own websites to filter after performing a web search.
Que Nguyen's avatar
Que Nguyen committed
1075
1076
1077
1078
# This ensures the highest level of safety and reliability of the information sources.
RAG_WEB_SEARCH_DOMAIN_FILTER_LIST = PersistentConfig(
    "RAG_WEB_SEARCH_DOMAIN_FILTER_LIST",
    "rag.rag.web.search.domain.filter_list",
1079
    [
Timothy J. Baek's avatar
Timothy J. Baek committed
1080
1081
        # "wikipedia.com",
        # "wikimedia.org",
Que Nguyen's avatar
Que Nguyen committed
1082
        # "wikidata.org",
1083
1084
1085
    ],
)

Timothy J. Baek's avatar
Timothy J. Baek committed
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
SEARXNG_QUERY_URL = PersistentConfig(
    "SEARXNG_QUERY_URL",
    "rag.web.search.searxng_query_url",
    os.getenv("SEARXNG_QUERY_URL", ""),
)

GOOGLE_PSE_API_KEY = PersistentConfig(
    "GOOGLE_PSE_API_KEY",
    "rag.web.search.google_pse_api_key",
    os.getenv("GOOGLE_PSE_API_KEY", ""),
)

GOOGLE_PSE_ENGINE_ID = PersistentConfig(
    "GOOGLE_PSE_ENGINE_ID",
    "rag.web.search.google_pse_engine_id",
    os.getenv("GOOGLE_PSE_ENGINE_ID", ""),
)

BRAVE_SEARCH_API_KEY = PersistentConfig(
    "BRAVE_SEARCH_API_KEY",
    "rag.web.search.brave_search_api_key",
    os.getenv("BRAVE_SEARCH_API_KEY", ""),
)

SERPSTACK_API_KEY = PersistentConfig(
    "SERPSTACK_API_KEY",
    "rag.web.search.serpstack_api_key",
    os.getenv("SERPSTACK_API_KEY", ""),
)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1115

Timothy J. Baek's avatar
Timothy J. Baek committed
1116
1117
1118
1119
SERPSTACK_HTTPS = PersistentConfig(
    "SERPSTACK_HTTPS",
    "rag.web.search.serpstack_https",
    os.getenv("SERPSTACK_HTTPS", "True").lower() == "true",
1120
)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1121

Timothy J. Baek's avatar
Timothy J. Baek committed
1122
1123
1124
1125
SERPER_API_KEY = PersistentConfig(
    "SERPER_API_KEY",
    "rag.web.search.serper_api_key",
    os.getenv("SERPER_API_KEY", ""),
1126
)
1127

1128
1129
1130
1131
1132
1133
SERPLY_API_KEY = PersistentConfig(
    "SERPLY_API_KEY",
    "rag.web.search.serply_api_key",
    os.getenv("SERPLY_API_KEY", ""),
)

1134
1135
1136
1137
1138
TAVILY_API_KEY = PersistentConfig(
    "TAVILY_API_KEY",
    "rag.web.search.tavily_api_key",
    os.getenv("TAVILY_API_KEY", ""),
)
Timothy J. Baek's avatar
Timothy J. Baek committed
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152

RAG_WEB_SEARCH_RESULT_COUNT = PersistentConfig(
    "RAG_WEB_SEARCH_RESULT_COUNT",
    "rag.web.search.result_count",
    int(os.getenv("RAG_WEB_SEARCH_RESULT_COUNT", "3")),
)

RAG_WEB_SEARCH_CONCURRENT_REQUESTS = PersistentConfig(
    "RAG_WEB_SEARCH_CONCURRENT_REQUESTS",
    "rag.web.search.concurrent_requests",
    int(os.getenv("RAG_WEB_SEARCH_CONCURRENT_REQUESTS", "10")),
)


Timothy J. Baek's avatar
Timothy J. Baek committed
1153
1154
1155
####################################
# Transcribe
####################################
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1156
1157
1158

WHISPER_MODEL = os.getenv("WHISPER_MODEL", "base")
WHISPER_MODEL_DIR = os.getenv("WHISPER_MODEL_DIR", f"{CACHE_DIR}/whisper/models")
1159
1160
1161
WHISPER_MODEL_AUTO_UPDATE = (
    os.environ.get("WHISPER_MODEL_AUTO_UPDATE", "").lower() == "true"
)
Timothy J. Baek's avatar
Timothy J. Baek committed
1162

1163

Timothy J. Baek's avatar
Timothy J. Baek committed
1164
1165
1166
1167
####################################
# Images
####################################

Timothy J. Baek's avatar
Timothy J. Baek committed
1168
IMAGE_GENERATION_ENGINE = PersistentConfig(
1169
1170
1171
1172
    "IMAGE_GENERATION_ENGINE",
    "image_generation.engine",
    os.getenv("IMAGE_GENERATION_ENGINE", ""),
)
1173

Timothy J. Baek's avatar
Timothy J. Baek committed
1174
ENABLE_IMAGE_GENERATION = PersistentConfig(
1175
1176
1177
1178
    "ENABLE_IMAGE_GENERATION",
    "image_generation.enable",
    os.environ.get("ENABLE_IMAGE_GENERATION", "").lower() == "true",
)
Timothy J. Baek's avatar
Timothy J. Baek committed
1179
AUTOMATIC1111_BASE_URL = PersistentConfig(
1180
1181
1182
    "AUTOMATIC1111_BASE_URL",
    "image_generation.automatic1111.base_url",
    os.getenv("AUTOMATIC1111_BASE_URL", ""),
1183
)
1184
1185
1186
1187
1188
AUTOMATIC1111_API_AUTH = PersistentConfig(
    "AUTOMATIC1111_API_AUTH",
    "image_generation.automatic1111.api_auth",
    os.getenv("AUTOMATIC1111_API_AUTH", ""),
)
Timothy J. Baek's avatar
Timothy J. Baek committed
1189

Timothy J. Baek's avatar
Timothy J. Baek committed
1190
COMFYUI_BASE_URL = PersistentConfig(
1191
1192
1193
1194
    "COMFYUI_BASE_URL",
    "image_generation.comfyui.base_url",
    os.getenv("COMFYUI_BASE_URL", ""),
)
Timothy J. Baek's avatar
Timothy J. Baek committed
1195

1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
COMFYUI_CFG_SCALE = PersistentConfig(
    "COMFYUI_CFG_SCALE",
    "image_generation.comfyui.cfg_scale",
    os.getenv("COMFYUI_CFG_SCALE", ""),
)

COMFYUI_SAMPLER = PersistentConfig(
    "COMFYUI_SAMPLER",
    "image_generation.comfyui.sampler",
    os.getenv("COMFYUI_SAMPLER", ""),
)

COMFYUI_SCHEDULER = PersistentConfig(
    "COMFYUI_SCHEDULER",
    "image_generation.comfyui.scheduler",
    os.getenv("COMFYUI_SCHEDULER", ""),
)

COMFYUI_SD3 = PersistentConfig(
    "COMFYUI_SD3",
    "image_generation.comfyui.sd3",
    os.environ.get("COMFYUI_SD3", "").lower() == "true",
)

Timothy J. Baek's avatar
Timothy J. Baek committed
1220
IMAGES_OPENAI_API_BASE_URL = PersistentConfig(
1221
1222
1223
1224
    "IMAGES_OPENAI_API_BASE_URL",
    "image_generation.openai.api_base_url",
    os.getenv("IMAGES_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
)
Timothy J. Baek's avatar
Timothy J. Baek committed
1225
IMAGES_OPENAI_API_KEY = PersistentConfig(
1226
1227
1228
    "IMAGES_OPENAI_API_KEY",
    "image_generation.openai.api_key",
    os.getenv("IMAGES_OPENAI_API_KEY", OPENAI_API_KEY),
Timothy J. Baek's avatar
Timothy J. Baek committed
1229
)
Timothy J. Baek's avatar
Timothy J. Baek committed
1230

Timothy J. Baek's avatar
Timothy J. Baek committed
1231
IMAGE_SIZE = PersistentConfig(
1232
1233
    "IMAGE_SIZE", "image_generation.size", os.getenv("IMAGE_SIZE", "512x512")
)
1234

Timothy J. Baek's avatar
Timothy J. Baek committed
1235
IMAGE_STEPS = PersistentConfig(
1236
1237
    "IMAGE_STEPS", "image_generation.steps", int(os.getenv("IMAGE_STEPS", 50))
)
1238

Timothy J. Baek's avatar
Timothy J. Baek committed
1239
IMAGE_GENERATION_MODEL = PersistentConfig(
1240
1241
1242
1243
    "IMAGE_GENERATION_MODEL",
    "image_generation.model",
    os.getenv("IMAGE_GENERATION_MODEL", ""),
)
Timothy J. Baek's avatar
Timothy J. Baek committed
1244

Timothy J. Baek's avatar
Timothy J. Baek committed
1245
1246
1247
1248
####################################
# Audio
####################################

Timothy J. Baek's avatar
Timothy J. Baek committed
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
AUDIO_STT_OPENAI_API_BASE_URL = PersistentConfig(
    "AUDIO_STT_OPENAI_API_BASE_URL",
    "audio.stt.openai.api_base_url",
    os.getenv("AUDIO_STT_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
)

AUDIO_STT_OPENAI_API_KEY = PersistentConfig(
    "AUDIO_STT_OPENAI_API_KEY",
    "audio.stt.openai.api_key",
    os.getenv("AUDIO_STT_OPENAI_API_KEY", OPENAI_API_KEY),
)

AUDIO_STT_ENGINE = PersistentConfig(
    "AUDIO_STT_ENGINE",
    "audio.stt.engine",
    os.getenv("AUDIO_STT_ENGINE", ""),
)

AUDIO_STT_MODEL = PersistentConfig(
    "AUDIO_STT_MODEL",
    "audio.stt.model",
    os.getenv("AUDIO_STT_MODEL", "whisper-1"),
)

AUDIO_TTS_OPENAI_API_BASE_URL = PersistentConfig(
    "AUDIO_TTS_OPENAI_API_BASE_URL",
    "audio.tts.openai.api_base_url",
    os.getenv("AUDIO_TTS_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
)
AUDIO_TTS_OPENAI_API_KEY = PersistentConfig(
    "AUDIO_TTS_OPENAI_API_KEY",
    "audio.tts.openai.api_key",
    os.getenv("AUDIO_TTS_OPENAI_API_KEY", OPENAI_API_KEY),
)


AUDIO_TTS_ENGINE = PersistentConfig(
    "AUDIO_TTS_ENGINE",
    "audio.tts.engine",
    os.getenv("AUDIO_TTS_ENGINE", ""),
)


AUDIO_TTS_MODEL = PersistentConfig(
    "AUDIO_TTS_MODEL",
    "audio.tts.model",
    os.getenv("AUDIO_TTS_MODEL", "tts-1"),
)

AUDIO_TTS_VOICE = PersistentConfig(
    "AUDIO_TTS_VOICE",
    "audio.tts.voice",
    os.getenv("AUDIO_TTS_VOICE", "alloy"),
1302
)
1303

1304

1305
1306
1307
1308
1309
####################################
# Database
####################################

DATABASE_URL = os.environ.get("DATABASE_URL", f"sqlite:///{DATA_DIR}/webui.db")