config.py 11.9 KB
Newer Older
1
import os
2
3
import sys
import logging
4
import chromadb
Timothy J. Baek's avatar
Timothy J. Baek committed
5
from chromadb import Settings
6
from base64 import b64encode
7
8
from bs4 import BeautifulSoup

Timothy J. Baek's avatar
Timothy J. Baek committed
9
from pathlib import Path
Timothy J. Baek's avatar
Timothy J. Baek committed
10
import json
Timothy J. Baek's avatar
Timothy J. Baek committed
11
12
import yaml

Timothy J. Baek's avatar
Timothy J. Baek committed
13
import markdown
14
15
16
17
18
import requests
import shutil

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

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

lucasew's avatar
lucasew committed
21
22
try:
    from dotenv import load_dotenv, find_dotenv
23

lucasew's avatar
lucasew committed
24
25
    load_dotenv(find_dotenv("../.env"))
except ImportError:
26
    log.warning("dotenv not installed, skipping...")
Timothy J. Baek's avatar
Timothy J. Baek committed
27

28
WEBUI_NAME = "Open WebUI"
29
WEBUI_FAVICON_URL = "https://openwebui.com/favicon.png"
Timothy J. Baek's avatar
Timothy J. Baek committed
30
shutil.copyfile("../build/favicon.png", "./static/favicon.png")
Timothy J. Baek's avatar
Timothy J. Baek committed
31
32

####################################
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
33
# ENV (dev,test,prod)
Timothy J. Baek's avatar
Timothy J. Baek committed
34
35
####################################

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

Timothy J. Baek's avatar
Timothy J. Baek committed
38
39
40
41
42
43
44
45
try:
    with open(f"../package.json", "r") as f:
        PACKAGE_DATA = json.load(f)
except:
    PACKAGE_DATA = {"version": "0.0.0"}

VERSION = PACKAGE_DATA["version"]

Timothy J. Baek's avatar
Timothy J. Baek committed
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

# 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:
    with open("../CHANGELOG.md", "r") as file:
        changelog_content = file.read()
except:
    changelog_content = ""

# 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


CHANGELOG = changelog_json

105

106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
####################################
# 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", "CONFIG", "DB", "IMAGES", "LITELLM", "MAIN", "MODELS", "OLLAMA", "OPENAI", "RAG"]

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


134
135
136
137
138
139
####################################
# CUSTOM_NAME
####################################

CUSTOM_NAME = os.environ.get("CUSTOM_NAME", "")
if CUSTOM_NAME:
Timothy J. Baek's avatar
Timothy J. Baek committed
140
141
142
143
144
    try:
        r = requests.get(f"https://api.openwebui.com/api/v1/custom/{CUSTOM_NAME}")
        data = r.json()
        if r.ok:
            if "logo" in data:
145
                WEBUI_FAVICON_URL = url = (
Timothy J. Baek's avatar
Timothy J. Baek committed
146
147
148
149
150
151
152
153
154
155
156
157
158
                    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:
                    with open("./static/favicon.png", "wb") as f:
                        r.raw.decode_content = True
                        shutil.copyfileobj(r.raw, f)

            WEBUI_NAME = data["name"]
    except Exception as e:
159
        log.exception(e)
Timothy J. Baek's avatar
Timothy J. Baek committed
160
        pass
161
162


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
163
164
165
####################################
# DATA/FRONTEND BUILD DIR
####################################
lucasew's avatar
lucasew committed
166

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
167
DATA_DIR = str(Path(os.getenv("DATA_DIR", "./data")).resolve())
lucasew's avatar
lucasew committed
168
FRONTEND_BUILD_DIR = str(Path(os.getenv("FRONTEND_BUILD_DIR", "../build")))
Timothy J. Baek's avatar
Timothy J. Baek committed
169

Timothy J. Baek's avatar
Timothy J. Baek committed
170
171
172
173
174
175
try:
    with open(f"{DATA_DIR}/config.json", "r") as f:
        CONFIG_DATA = json.load(f)
except:
    CONFIG_DATA = {}

176
####################################
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
177
# File Upload DIR
178
179
####################################

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

Timothy J. Baek's avatar
Timothy J. Baek committed
183
184
185
186
187
188
189
190

####################################
# Cache DIR
####################################

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

191
192
193
194
195
196
197

####################################
# Docs DIR
####################################

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

Timothy J. Baek's avatar
Timothy J. Baek committed
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227

####################################
# 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"

if not os.path.exists(LITELLM_CONFIG_PATH):
228
    log.info("Config file doesn't exist. Creating...")
Timothy J. Baek's avatar
Timothy J. Baek committed
229
    create_config_file(LITELLM_CONFIG_PATH)
230
    log.info("Config file created successfully.")
Timothy J. Baek's avatar
Timothy J. Baek committed
231
232


233
####################################
Timothy J. Baek's avatar
Timothy J. Baek committed
234
# OLLAMA_BASE_URL
235
236
####################################

237
238
239
OLLAMA_API_BASE_URL = os.environ.get(
    "OLLAMA_API_BASE_URL", "http://localhost:11434/api"
)
Timothy J. Baek's avatar
Timothy J. Baek committed
240

241
OLLAMA_BASE_URL = os.environ.get("OLLAMA_BASE_URL", "")
Timothy J. Baek's avatar
Timothy J. Baek committed
242
KUBERNETES_SERVICE_HOST = os.environ.get("KUBERNETES_SERVICE_HOST", "")
243

244
if OLLAMA_BASE_URL == "" and OLLAMA_API_BASE_URL != "":
245
246
247
248
249
250
    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
251
if ENV == "prod":
Timothy J. Baek's avatar
Timothy J. Baek committed
252
    if OLLAMA_BASE_URL == "/ollama" and KUBERNETES_SERVICE_HOST == "":
Timothy J. Baek's avatar
Timothy J. Baek committed
253
        OLLAMA_BASE_URL = "http://host.docker.internal:11434"
254
255
    else:
        OLLAMA_BASE_URL = "http://ollama-service.open-webui.svc.cluster.local:11434"
Timothy J. Baek's avatar
Timothy J. Baek committed
256
257


258
259
260
OLLAMA_BASE_URLS = os.environ.get("OLLAMA_BASE_URLS", "")
OLLAMA_BASE_URLS = OLLAMA_BASE_URLS if OLLAMA_BASE_URLS != "" else OLLAMA_BASE_URL

261
OLLAMA_BASE_URLS = [url.strip() for url in OLLAMA_BASE_URLS.split(";")]
262

263

Timothy J. Baek's avatar
Timothy J. Baek committed
264
265
266
267
268
####################################
# OPENAI_API
####################################

OPENAI_API_KEY = os.environ.get("OPENAI_API_KEY", "")
269
270
OPENAI_API_BASE_URL = os.environ.get("OPENAI_API_BASE_URL", "")

271

272
273
if OPENAI_API_BASE_URL == "":
    OPENAI_API_BASE_URL = "https://api.openai.com/v1"
Timothy J. Baek's avatar
Timothy J. Baek committed
274

Timothy J. Baek's avatar
Timothy J. Baek committed
275
276
277
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
278
OPENAI_API_KEYS = [url.strip() for url in OPENAI_API_KEYS.split(";")]
Timothy J. Baek's avatar
Timothy J. Baek committed
279
280
281
282
283
284
285


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
286
287
288
289
OPENAI_API_BASE_URLS = [
    url.strip() if url != "" else "https://api.openai.com/v1"
    for url in OPENAI_API_BASE_URLS.split(";")
]
290
291
292
293
294

####################################
# WEBUI
####################################

Han Cen's avatar
Han Cen committed
295
ENABLE_SIGNUP = os.environ.get("ENABLE_SIGNUP", "True").lower() == "true"
296
DEFAULT_MODELS = os.environ.get("DEFAULT_MODELS", None)
Timothy J. Baek's avatar
Timothy J. Baek committed
297
298
299
300


DEFAULT_PROMPT_SUGGESTIONS = (
    CONFIG_DATA["ui"]["prompt_suggestions"]
Timothy J. Baek's avatar
Timothy J. Baek committed
301
302
303
    if "ui" in CONFIG_DATA
    and "prompt_suggestions" in CONFIG_DATA["ui"]
    and type(CONFIG_DATA["ui"]["prompt_suggestions"]) is list
Timothy J. Baek's avatar
Timothy J. Baek committed
304
    else [
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
        {
            "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
321
    ]
322
)
Timothy J. Baek's avatar
Timothy J. Baek committed
323
324


David Girón's avatar
David Girón committed
325
DEFAULT_USER_ROLE = os.getenv("DEFAULT_USER_ROLE", "pending")
326

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
327
328
329
USER_PERMISSIONS_CHAT_DELETION = (
    os.environ.get("USER_PERMISSIONS_CHAT_DELETION", "True").lower() == "true"
)
330

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
331
USER_PERMISSIONS = {"chat": {"deletion": USER_PERMISSIONS_CHAT_DELETION}}
Timothy J. Baek's avatar
Timothy J. Baek committed
332

333

334
MODEL_FILTER_ENABLED = os.environ.get("MODEL_FILTER_ENABLED", "False").lower() == "true"
335
336
337
MODEL_FILTER_LIST = os.environ.get("MODEL_FILTER_LIST", "")
MODEL_FILTER_LIST = [model.strip() for model in MODEL_FILTER_LIST.split(";")]

Timothy J. Baek's avatar
Timothy J. Baek committed
338
WEBHOOK_URL = os.environ.get("WEBHOOK_URL", "")
339

340
####################################
341
# WEBUI_VERSION
342
343
####################################

Timothy J. Baek's avatar
Timothy J. Baek committed
344
WEBUI_VERSION = os.environ.get("WEBUI_VERSION", "v1.0.0-alpha.100")
345
346

####################################
347
# WEBUI_AUTH (Required for security)
348
349
####################################

350
WEBUI_AUTH = True
351

Timothy J. Baek's avatar
Timothy J. Baek committed
352
####################################
353
# WEBUI_SECRET_KEY
Timothy J. Baek's avatar
Timothy J. Baek committed
354
355
####################################

356
357
WEBUI_SECRET_KEY = os.environ.get(
    "WEBUI_SECRET_KEY",
Timothy J. Baek's avatar
Timothy J. Baek committed
358
359
360
    os.environ.get(
        "WEBUI_JWT_SECRET_KEY", "t0p-s3cr3t"
    ),  # DEPRECATED: remove at next major version
361
)
362

363
if WEBUI_AUTH and WEBUI_SECRET_KEY == "":
Timothy J. Baek's avatar
Timothy J. Baek committed
364
    raise ValueError(ERROR_MESSAGES.ENV_VAR_NOT_FOUND)
365
366
367
368
369

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

370
CHROMA_DATA_PATH = f"{DATA_DIR}/vector_db"
371
# 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 (all-MiniLM-L6-v2)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
372
RAG_EMBEDDING_MODEL = os.environ.get("RAG_EMBEDDING_MODEL", "all-MiniLM-L6-v2")
373
# device type ebbeding models - "cpu" (default), "cuda" (nvidia gpu required) or "mps" (apple silicon) - choosing this right can lead to better performance
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
374
375
376
RAG_EMBEDDING_MODEL_DEVICE_TYPE = os.environ.get(
    "RAG_EMBEDDING_MODEL_DEVICE_TYPE", "cpu"
)
Timothy J. Baek's avatar
Timothy J. Baek committed
377
CHROMA_CLIENT = chromadb.PersistentClient(
Timothy J. Baek's avatar
Timothy J. Baek committed
378
379
    path=CHROMA_DATA_PATH,
    settings=Settings(allow_reset=True, anonymized_telemetry=False),
Timothy J. Baek's avatar
Timothy J. Baek committed
380
)
381
382
CHUNK_SIZE = 1500
CHUNK_OVERLAP = 100
Timothy J. Baek's avatar
Timothy J. Baek committed
383

Timothy J. Baek's avatar
Timothy J. Baek committed
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398

RAG_TEMPLATE = """Use the following context as your learned knowledge, inside <context></context> XML tags.
<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.
        
Given the context information, answer the query.
Query: [query]"""

Timothy J. Baek's avatar
Timothy J. Baek committed
399
400
401
####################################
# Transcribe
####################################
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
402
403
404

WHISPER_MODEL = os.getenv("WHISPER_MODEL", "base")
WHISPER_MODEL_DIR = os.getenv("WHISPER_MODEL_DIR", f"{CACHE_DIR}/whisper/models")
Timothy J. Baek's avatar
Timothy J. Baek committed
405
406
407
408
409
410
411


####################################
# Images
####################################

AUTOMATIC1111_BASE_URL = os.getenv("AUTOMATIC1111_BASE_URL", "")
Timothy J. Baek's avatar
Timothy J. Baek committed
412
COMFYUI_BASE_URL = os.getenv("COMFYUI_BASE_URL", "")