config.py 25.8 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
11

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

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

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

Timothy J. Baek's avatar
Timothy J. Baek committed
23
24
25
26
####################################
# Load .env file
####################################

27
28
29
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
30
31
print(BASE_DIR)

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

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

39

40
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
####################################
# 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"])

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

84
85
WEBUI_URL = os.environ.get("WEBUI_URL", "http://localhost:3000")

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

88

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

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

Timothy J. Baek's avatar
Timothy J. Baek committed
95
try:
96
    PACKAGE_DATA = json.loads((BASE_DIR / "package.json").read_text())
Timothy J. Baek's avatar
Timothy J. Baek committed
97
except:
Tang Ziya's avatar
Tang Ziya committed
98
99
100
101
    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
102
103
104

VERSION = PACKAGE_DATA["version"]

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

# 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
126
    changelog_path = BASE_DIR / "CHANGELOG.md"
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
127
    with open(str(changelog_path.absolute()), "r", encoding="utf8") as file:
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
128
129
        changelog_content = file.read()

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

Timothy J. Baek's avatar
Timothy J. Baek committed
133
134
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

# 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

164

Timothy J. Baek's avatar
Timothy J. Baek committed
165
166
CHANGELOG = changelog_json

167

168
169
170
171
172
173
####################################
# WEBUI_VERSION
####################################

WEBUI_VERSION = os.environ.get("WEBUI_VERSION", "v1.0.0-alpha.100")

174
175
176
177
####################################
# DATA/FRONTEND BUILD DIR
####################################

178
179
DATA_DIR = Path(os.getenv("DATA_DIR", BACKEND_DIR / "data")).resolve()
FRONTEND_BUILD_DIR = Path(os.getenv("FRONTEND_BUILD_DIR", BASE_DIR / "build")).resolve()
180
181

try:
182
    CONFIG_DATA = json.loads((DATA_DIR / "config.json").read_text())
183
184
185
except:
    CONFIG_DATA = {}

186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213

####################################
# 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
214
class PersistentConfig(Generic[T]):
215
216
217
218
219
220
221
222
223
224
225
226
227
228
    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)

229
230
231
    @property
    def __dict__(self):
        raise TypeError(
Timothy J. Baek's avatar
Timothy J. Baek committed
232
            "PersistentConfig object cannot be converted to dict, use config_get or .value instead."
233
234
235
236
237
        )

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

242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
    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


259
class AppConfig:
Timothy J. Baek's avatar
Timothy J. Baek committed
260
    _state: dict[str, PersistentConfig]
261
262
263
264
265

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

    def __setattr__(self, key, value):
Timothy J. Baek's avatar
Timothy J. Baek committed
266
        if isinstance(value, PersistentConfig):
267
268
269
270
271
272
273
            self._state[key] = value
        else:
            self._state[key].value = value
            self._state[key].save()

    def __getattr__(self, key):
        return self._state[key].value
274
275
276
277
278
279
280
281
282
283


####################################
# 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
284
JWT_EXPIRES_IN = PersistentConfig(
285
286
287
    "JWT_EXPIRES_IN", "auth.jwt_expiry", os.environ.get("JWT_EXPIRES_IN", "-1")
)

288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
####################################
# OAuth config
####################################

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

OAUTH_PROVIDERS = {}

if os.environ.get("GOOGLE_CLIENT_ID") and os.environ.get("GOOGLE_CLIENT_SECRET"):
    OAUTH_PROVIDERS["google"] = {
        "client_id": os.environ.get("GOOGLE_CLIENT_ID"),
        "client_secret": os.environ.get("GOOGLE_CLIENT_SECRET"),
        "server_metadata_url": "https://accounts.google.com/.well-known/openid-configuration",
        "scope": os.environ.get("GOOGLE_OAUTH_SCOPE", "openid email profile"),
    }

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

if (
321
322
    os.environ.get("OAUTH_CLIENT_ID")
    and os.environ.get("OAUTH_CLIENT_SECRET")
323
324
325
    and os.environ.get("OPENID_PROVIDER_URL")
):
    OAUTH_PROVIDERS["oidc"] = {
326
327
        "client_id": os.environ.get("OAUTH_CLIENT_ID"),
        "client_secret": os.environ.get("OAUTH_CLIENT_SECRET"),
328
        "server_metadata_url": os.environ.get("OPENID_PROVIDER_URL"),
329
330
        "scope": os.environ.get("OAUTH_SCOPES", "openid email profile"),
        "name": os.environ.get("OAUTH_PROVIDER_NAME", "SSO"),
331
332
333
    }


334
335
336
337
####################################
# Static DIR
####################################

338
STATIC_DIR = Path(os.getenv("STATIC_DIR", BACKEND_DIR / "static")).resolve()
339

340
341
342
frontend_favicon = FRONTEND_BUILD_DIR / "favicon.png"
if frontend_favicon.exists():
    shutil.copyfile(frontend_favicon, STATIC_DIR / "favicon.png")
343
344
else:
    logging.warning(f"Frontend favicon not found at {frontend_favicon}")
345
346
347
348
349
350

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

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

352
if CUSTOM_NAME:
Timothy J. Baek's avatar
Timothy J. Baek committed
353
354
355
356
357
    try:
        r = requests.get(f"https://api.openwebui.com/api/v1/custom/{CUSTOM_NAME}")
        data = r.json()
        if r.ok:
            if "logo" in data:
358
                WEBUI_FAVICON_URL = url = (
Timothy J. Baek's avatar
Timothy J. Baek committed
359
360
361
362
363
364
365
                    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:
366
                    with open(f"{STATIC_DIR}/favicon.png", "wb") as f:
Timothy J. Baek's avatar
Timothy J. Baek committed
367
368
369
370
371
                        r.raw.decode_content = True
                        shutil.copyfileobj(r.raw, f)

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

375

376
####################################
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
377
# File Upload DIR
378
379
####################################

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

383

Timothy J. Baek's avatar
Timothy J. Baek committed
384
385
386
387
388
389
390
####################################
# Cache DIR
####################################

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

391

392
393
394
395
####################################
# Docs DIR
####################################

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

Timothy J. Baek's avatar
Timothy J. Baek committed
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426

####################################
# 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
427
428
429
430
# 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
431

432

433
####################################
Timothy J. Baek's avatar
Timothy J. Baek committed
434
# OLLAMA_BASE_URL
435
436
####################################

Timothy J. Baek's avatar
Timothy J. Baek committed
437
438
439
440
441
442
443

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

444
445
446
OLLAMA_API_BASE_URL = os.environ.get(
    "OLLAMA_API_BASE_URL", "http://localhost:11434/api"
)
Timothy J. Baek's avatar
Timothy J. Baek committed
447

448
OLLAMA_BASE_URL = os.environ.get("OLLAMA_BASE_URL", "")
Timothy J. Baek's avatar
Timothy J. Baek committed
449
K8S_FLAG = os.environ.get("K8S_FLAG", "")
Jannik Streidl's avatar
Jannik Streidl committed
450
USE_OLLAMA_DOCKER = os.environ.get("USE_OLLAMA_DOCKER", "false")
451

452
if OLLAMA_BASE_URL == "" and OLLAMA_API_BASE_URL != "":
453
454
455
456
457
458
    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
459
if ENV == "prod":
460
    if OLLAMA_BASE_URL == "/ollama" and not K8S_FLAG:
Jannik Streidl's avatar
Jannik Streidl committed
461
        if USE_OLLAMA_DOCKER.lower() == "true":
462
            # if you use all-in-one docker container (Open WebUI + Ollama)
Jannik Streidl's avatar
Jannik Streidl committed
463
            # with the docker build arg USE_OLLAMA=true (--build-arg="USE_OLLAMA=true") this only works with http://localhost:11434
464
            OLLAMA_BASE_URL = "http://localhost:11434"
465
        else:
466
            OLLAMA_BASE_URL = "http://host.docker.internal:11434"
Timothy J. Baek's avatar
Timothy J. Baek committed
467
    elif K8S_FLAG:
468
        OLLAMA_BASE_URL = "http://ollama-service.open-webui.svc.cluster.local:11434"
Timothy J. Baek's avatar
Timothy J. Baek committed
469

470

471
472
473
OLLAMA_BASE_URLS = os.environ.get("OLLAMA_BASE_URLS", "")
OLLAMA_BASE_URLS = OLLAMA_BASE_URLS if OLLAMA_BASE_URLS != "" else OLLAMA_BASE_URL

474
OLLAMA_BASE_URLS = [url.strip() for url in OLLAMA_BASE_URLS.split(";")]
Timothy J. Baek's avatar
Timothy J. Baek committed
475
OLLAMA_BASE_URLS = PersistentConfig(
476
477
    "OLLAMA_BASE_URLS", "ollama.base_urls", OLLAMA_BASE_URLS
)
478

Timothy J. Baek's avatar
Timothy J. Baek committed
479
480
481
482
####################################
# OPENAI_API
####################################

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
483
484
485
486
487
488
489
490

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
491
OPENAI_API_KEY = os.environ.get("OPENAI_API_KEY", "")
492
493
OPENAI_API_BASE_URL = os.environ.get("OPENAI_API_BASE_URL", "")

494

495
496
if OPENAI_API_BASE_URL == "":
    OPENAI_API_BASE_URL = "https://api.openai.com/v1"
Timothy J. Baek's avatar
Timothy J. Baek committed
497

Timothy J. Baek's avatar
Timothy J. Baek committed
498
499
500
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
501
OPENAI_API_KEYS = [url.strip() for url in OPENAI_API_KEYS.split(";")]
Timothy J. Baek's avatar
Timothy J. Baek committed
502
503
504
OPENAI_API_KEYS = PersistentConfig(
    "OPENAI_API_KEYS", "openai.api_keys", OPENAI_API_KEYS
)
Timothy J. Baek's avatar
Timothy J. Baek committed
505
506
507
508
509
510

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
511
512
513
514
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
515
OPENAI_API_BASE_URLS = PersistentConfig(
516
517
    "OPENAI_API_BASE_URLS", "openai.api_base_urls", OPENAI_API_BASE_URLS
)
518

Timothy J. Baek's avatar
Timothy J. Baek committed
519
OPENAI_API_KEY = ""
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
520
521

try:
522
523
    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
524
525
526
527
    ]
except:
    pass

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

530
531
532
533
####################################
# WEBUI
####################################

Timothy J. Baek's avatar
Timothy J. Baek committed
534
ENABLE_SIGNUP = PersistentConfig(
535
536
537
538
539
540
541
542
    "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
543
DEFAULT_MODELS = PersistentConfig(
544
    "DEFAULT_MODELS", "ui.default_models", os.environ.get("DEFAULT_MODELS", None)
545
)
Timothy J. Baek's avatar
Timothy J. Baek committed
546

Timothy J. Baek's avatar
Timothy J. Baek committed
547
DEFAULT_PROMPT_SUGGESTIONS = PersistentConfig(
548
549
550
    "DEFAULT_PROMPT_SUGGESTIONS",
    "ui.prompt_suggestions",
    [
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
        {
            "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
567
568
569
570
571
572
573
574
575
576
577
        {
            "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?",
        },
578
    ],
579
)
Timothy J. Baek's avatar
Timothy J. Baek committed
580

Timothy J. Baek's avatar
Timothy J. Baek committed
581
DEFAULT_USER_ROLE = PersistentConfig(
582
583
584
585
    "DEFAULT_USER_ROLE",
    "ui.default_user_role",
    os.getenv("DEFAULT_USER_ROLE", "pending"),
)
Timothy J. Baek's avatar
Timothy J. Baek committed
586

587
588
USER_PERMISSIONS_CHAT_DELETION = (
    os.environ.get("USER_PERMISSIONS_CHAT_DELETION", "True").lower() == "true"
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
589
)
590

Timothy J. Baek's avatar
Timothy J. Baek committed
591
USER_PERMISSIONS = PersistentConfig(
592
593
594
595
    "USER_PERMISSIONS",
    "ui.user_permissions",
    {"chat": {"deletion": USER_PERMISSIONS_CHAT_DELETION}},
)
Timothy J. Baek's avatar
Timothy J. Baek committed
596

Timothy J. Baek's avatar
Timothy J. Baek committed
597
ENABLE_MODEL_FILTER = PersistentConfig(
598
599
600
601
    "ENABLE_MODEL_FILTER",
    "model_filter.enable",
    os.environ.get("ENABLE_MODEL_FILTER", "False").lower() == "true",
)
602
MODEL_FILTER_LIST = os.environ.get("MODEL_FILTER_LIST", "")
Timothy J. Baek's avatar
Timothy J. Baek committed
603
MODEL_FILTER_LIST = PersistentConfig(
604
605
606
607
    "MODEL_FILTER_LIST",
    "model_filter.list",
    [model.strip() for model in MODEL_FILTER_LIST.split(";")],
)
608

Timothy J. Baek's avatar
Timothy J. Baek committed
609
WEBHOOK_URL = PersistentConfig(
610
611
    "WEBHOOK_URL", "webhook_url", os.environ.get("WEBHOOK_URL", "")
)
612

613
ENABLE_ADMIN_EXPORT = os.environ.get("ENABLE_ADMIN_EXPORT", "True").lower() == "true"
614

Timothy J. Baek's avatar
Timothy J. Baek committed
615
####################################
616
# WEBUI_SECRET_KEY
Timothy J. Baek's avatar
Timothy J. Baek committed
617
618
####################################

619
620
WEBUI_SECRET_KEY = os.environ.get(
    "WEBUI_SECRET_KEY",
Timothy J. Baek's avatar
Timothy J. Baek committed
621
622
623
    os.environ.get(
        "WEBUI_JWT_SECRET_KEY", "t0p-s3cr3t"
    ),  # DEPRECATED: remove at next major version
624
)
625

626
if WEBUI_AUTH and WEBUI_SECRET_KEY == "":
Timothy J. Baek's avatar
Timothy J. Baek committed
627
    raise ValueError(ERROR_MESSAGES.ENV_VAR_NOT_FOUND)
628
629
630
631
632

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

633
CHROMA_DATA_PATH = f"{DATA_DIR}/vector_db"
634
635
636
637
638
639
640
641
642
643
644
645
646
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"
647
# 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)
648

Timothy J. Baek's avatar
Timothy J. Baek committed
649
RAG_TOP_K = PersistentConfig(
650
651
    "RAG_TOP_K", "rag.top_k", int(os.environ.get("RAG_TOP_K", "5"))
)
Timothy J. Baek's avatar
Timothy J. Baek committed
652
RAG_RELEVANCE_THRESHOLD = PersistentConfig(
653
654
655
    "RAG_RELEVANCE_THRESHOLD",
    "rag.relevance_threshold",
    float(os.environ.get("RAG_RELEVANCE_THRESHOLD", "0.0")),
Timothy J. Baek's avatar
Timothy J. Baek committed
656
)
657

Timothy J. Baek's avatar
Timothy J. Baek committed
658
ENABLE_RAG_HYBRID_SEARCH = PersistentConfig(
659
660
661
662
    "ENABLE_RAG_HYBRID_SEARCH",
    "rag.enable_hybrid_search",
    os.environ.get("ENABLE_RAG_HYBRID_SEARCH", "").lower() == "true",
)
663

Timothy J. Baek's avatar
Timothy J. Baek committed
664
ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = PersistentConfig(
665
666
667
    "ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION",
    "rag.enable_web_loader_ssl_verification",
    os.environ.get("ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION", "True").lower() == "true",
668
669
)

Timothy J. Baek's avatar
Timothy J. Baek committed
670
RAG_EMBEDDING_ENGINE = PersistentConfig(
671
672
673
674
    "RAG_EMBEDDING_ENGINE",
    "rag.embedding_engine",
    os.environ.get("RAG_EMBEDDING_ENGINE", ""),
)
675

Timothy J. Baek's avatar
Timothy J. Baek committed
676
PDF_EXTRACT_IMAGES = PersistentConfig(
677
678
679
680
    "PDF_EXTRACT_IMAGES",
    "rag.pdf_extract_images",
    os.environ.get("PDF_EXTRACT_IMAGES", "False").lower() == "true",
)
681

Timothy J. Baek's avatar
Timothy J. Baek committed
682
RAG_EMBEDDING_MODEL = PersistentConfig(
683
684
685
    "RAG_EMBEDDING_MODEL",
    "rag.embedding_model",
    os.environ.get("RAG_EMBEDDING_MODEL", "sentence-transformers/all-MiniLM-L6-v2"),
686
)
687
log.info(f"Embedding model set: {RAG_EMBEDDING_MODEL.value}"),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
688

689
690
691
692
RAG_EMBEDDING_MODEL_AUTO_UPDATE = (
    os.environ.get("RAG_EMBEDDING_MODEL_AUTO_UPDATE", "").lower() == "true"
)

693
694
RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE = (
    os.environ.get("RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE", "").lower() == "true"
Steven Kreitzer's avatar
Steven Kreitzer committed
695
696
)

Timothy J. Baek's avatar
Timothy J. Baek committed
697
RAG_RERANKING_MODEL = PersistentConfig(
698
699
700
701
702
703
    "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
704

705
706
707
708
RAG_RERANKING_MODEL_AUTO_UPDATE = (
    os.environ.get("RAG_RERANKING_MODEL_AUTO_UPDATE", "").lower() == "true"
)

Steven Kreitzer's avatar
Steven Kreitzer committed
709
710
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
711
)
712

713

714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
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
731

732

733
734
735
736
737
738
739
740
# 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
741
CHUNK_SIZE = PersistentConfig(
742
743
    "CHUNK_SIZE", "rag.chunk_size", int(os.environ.get("CHUNK_SIZE", "1500"))
)
Timothy J. Baek's avatar
Timothy J. Baek committed
744
CHUNK_OVERLAP = PersistentConfig(
745
746
747
748
    "CHUNK_OVERLAP",
    "rag.chunk_overlap",
    int(os.environ.get("CHUNK_OVERLAP", "100")),
)
Timothy J. Baek's avatar
Timothy J. Baek committed
749

750
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
751
752
753
754
755
756
757
758
759
<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.
760

Timothy J. Baek's avatar
Timothy J. Baek committed
761
762
763
Given the context information, answer the query.
Query: [query]"""

Timothy J. Baek's avatar
Timothy J. Baek committed
764
RAG_TEMPLATE = PersistentConfig(
765
766
767
768
    "RAG_TEMPLATE",
    "rag.template",
    os.environ.get("RAG_TEMPLATE", DEFAULT_RAG_TEMPLATE),
)
769

Timothy J. Baek's avatar
Timothy J. Baek committed
770
RAG_OPENAI_API_BASE_URL = PersistentConfig(
771
772
773
774
    "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
775
RAG_OPENAI_API_KEY = PersistentConfig(
776
777
778
779
    "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
780

781
782
783
ENABLE_RAG_LOCAL_WEB_FETCH = (
    os.getenv("ENABLE_RAG_LOCAL_WEB_FETCH", "False").lower() == "true"
)
784

Timothy J. Baek's avatar
Timothy J. Baek committed
785
YOUTUBE_LOADER_LANGUAGE = PersistentConfig(
786
787
788
789
    "YOUTUBE_LOADER_LANGUAGE",
    "rag.youtube_loader_language",
    os.getenv("YOUTUBE_LOADER_LANGUAGE", "en").split(","),
)
790

Timothy J. Baek's avatar
Timothy J. Baek committed
791
792
793
####################################
# Transcribe
####################################
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
794
795
796

WHISPER_MODEL = os.getenv("WHISPER_MODEL", "base")
WHISPER_MODEL_DIR = os.getenv("WHISPER_MODEL_DIR", f"{CACHE_DIR}/whisper/models")
797
798
799
WHISPER_MODEL_AUTO_UPDATE = (
    os.environ.get("WHISPER_MODEL_AUTO_UPDATE", "").lower() == "true"
)
Timothy J. Baek's avatar
Timothy J. Baek committed
800

801

Timothy J. Baek's avatar
Timothy J. Baek committed
802
803
804
805
####################################
# Images
####################################

Timothy J. Baek's avatar
Timothy J. Baek committed
806
IMAGE_GENERATION_ENGINE = PersistentConfig(
807
808
809
810
    "IMAGE_GENERATION_ENGINE",
    "image_generation.engine",
    os.getenv("IMAGE_GENERATION_ENGINE", ""),
)
811

Timothy J. Baek's avatar
Timothy J. Baek committed
812
ENABLE_IMAGE_GENERATION = PersistentConfig(
813
814
815
816
    "ENABLE_IMAGE_GENERATION",
    "image_generation.enable",
    os.environ.get("ENABLE_IMAGE_GENERATION", "").lower() == "true",
)
Timothy J. Baek's avatar
Timothy J. Baek committed
817
AUTOMATIC1111_BASE_URL = PersistentConfig(
818
819
820
    "AUTOMATIC1111_BASE_URL",
    "image_generation.automatic1111.base_url",
    os.getenv("AUTOMATIC1111_BASE_URL", ""),
821
)
Timothy J. Baek's avatar
Timothy J. Baek committed
822

Timothy J. Baek's avatar
Timothy J. Baek committed
823
COMFYUI_BASE_URL = PersistentConfig(
824
825
826
827
    "COMFYUI_BASE_URL",
    "image_generation.comfyui.base_url",
    os.getenv("COMFYUI_BASE_URL", ""),
)
Timothy J. Baek's avatar
Timothy J. Baek committed
828

Timothy J. Baek's avatar
Timothy J. Baek committed
829
IMAGES_OPENAI_API_BASE_URL = PersistentConfig(
830
831
832
833
    "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
834
IMAGES_OPENAI_API_KEY = PersistentConfig(
835
836
837
    "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
838
)
Timothy J. Baek's avatar
Timothy J. Baek committed
839

Timothy J. Baek's avatar
Timothy J. Baek committed
840
IMAGE_SIZE = PersistentConfig(
841
842
    "IMAGE_SIZE", "image_generation.size", os.getenv("IMAGE_SIZE", "512x512")
)
843

Timothy J. Baek's avatar
Timothy J. Baek committed
844
IMAGE_STEPS = PersistentConfig(
845
846
    "IMAGE_STEPS", "image_generation.steps", int(os.getenv("IMAGE_STEPS", 50))
)
847

Timothy J. Baek's avatar
Timothy J. Baek committed
848
IMAGE_GENERATION_MODEL = PersistentConfig(
849
850
851
852
    "IMAGE_GENERATION_MODEL",
    "image_generation.model",
    os.getenv("IMAGE_GENERATION_MODEL", ""),
)
Timothy J. Baek's avatar
Timothy J. Baek committed
853

Timothy J. Baek's avatar
Timothy J. Baek committed
854
855
856
857
####################################
# Audio
####################################

Timothy J. Baek's avatar
Timothy J. Baek committed
858
AUDIO_OPENAI_API_BASE_URL = PersistentConfig(
859
860
861
862
    "AUDIO_OPENAI_API_BASE_URL",
    "audio.openai.api_base_url",
    os.getenv("AUDIO_OPENAI_API_BASE_URL", OPENAI_API_BASE_URL),
)
Timothy J. Baek's avatar
Timothy J. Baek committed
863
AUDIO_OPENAI_API_KEY = PersistentConfig(
864
865
866
867
    "AUDIO_OPENAI_API_KEY",
    "audio.openai.api_key",
    os.getenv("AUDIO_OPENAI_API_KEY", OPENAI_API_KEY),
)
Timothy J. Baek's avatar
Timothy J. Baek committed
868
AUDIO_OPENAI_API_MODEL = PersistentConfig(
869
870
871
872
    "AUDIO_OPENAI_API_MODEL",
    "audio.openai.api_model",
    os.getenv("AUDIO_OPENAI_API_MODEL", "tts-1"),
)
Timothy J. Baek's avatar
Timothy J. Baek committed
873
AUDIO_OPENAI_API_VOICE = PersistentConfig(
874
875
876
877
    "AUDIO_OPENAI_API_VOICE",
    "audio.openai.api_voice",
    os.getenv("AUDIO_OPENAI_API_VOICE", "alloy"),
)
878

879

880
881
882
883
884
####################################
# Database
####################################

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