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

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

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

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

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

lucasew's avatar
lucasew committed
19
20
try:
    from dotenv import load_dotenv, find_dotenv
21

lucasew's avatar
lucasew committed
22
23
24
    load_dotenv(find_dotenv("../.env"))
except ImportError:
    print("dotenv not installed, skipping...")
Timothy J. Baek's avatar
Timothy J. Baek committed
25

26
WEBUI_NAME = "Open WebUI"
Timothy J. Baek's avatar
Timothy J. Baek committed
27
shutil.copyfile("../build/favicon.png", "./static/favicon.png")
Timothy J. Baek's avatar
Timothy J. Baek committed
28
29

####################################
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
30
# ENV (dev,test,prod)
Timothy J. Baek's avatar
Timothy J. Baek committed
31
32
####################################

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

Timothy J. Baek's avatar
Timothy J. Baek committed
35
36
37
38
39
40
41
42
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
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

# 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

102
103
104
105
106
107
108

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

CUSTOM_NAME = os.environ.get("CUSTOM_NAME", "")
if CUSTOM_NAME:
Timothy J. Baek's avatar
Timothy J. Baek committed
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
    try:
        r = requests.get(f"https://api.openwebui.com/api/v1/custom/{CUSTOM_NAME}")
        data = r.json()
        if r.ok:
            if "logo" in data:
                url = (
                    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:
        print(e)
        pass
130
131


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
132
133
134
####################################
# DATA/FRONTEND BUILD DIR
####################################
lucasew's avatar
lucasew committed
135

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

Timothy J. Baek's avatar
Timothy J. Baek committed
139
140
141
142
143
144
try:
    with open(f"{DATA_DIR}/config.json", "r") as f:
        CONFIG_DATA = json.load(f)
except:
    CONFIG_DATA = {}

145
####################################
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
146
# File Upload DIR
147
148
####################################

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

Timothy J. Baek's avatar
Timothy J. Baek committed
152
153
154
155
156
157
158
159

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

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

160
161
162
163
164
165
166

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

Timothy J. Baek's avatar
Timothy J. Baek committed
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201

####################################
# 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):
    print("Config file doesn't exist. Creating...")
    create_config_file(LITELLM_CONFIG_PATH)
    print("Config file created successfully.")


202
####################################
Timothy J. Baek's avatar
Timothy J. Baek committed
203
# OLLAMA_BASE_URL
204
205
####################################

206
207
208
OLLAMA_API_BASE_URL = os.environ.get(
    "OLLAMA_API_BASE_URL", "http://localhost:11434/api"
)
Timothy J. Baek's avatar
Timothy J. Baek committed
209

210
OLLAMA_BASE_URL = os.environ.get("OLLAMA_BASE_URL", "")
211

212
RUNNING_ON_K8S = os.environ.get("KUBERNETES_SERVICE_HOST", "")
213

214
if OLLAMA_BASE_URL == "" and OLLAMA_API_BASE_URL != "":
215
216
217
218
219
220
    OLLAMA_BASE_URL = (
        OLLAMA_API_BASE_URL[:-4]
        if OLLAMA_API_BASE_URL.endswith("/api")
        else OLLAMA_API_BASE_URL
    )

221
if ENV == "prod" and RUNNING_ON_K8S == "":
Timothy J. Baek's avatar
Timothy J. Baek committed
222
223
    if OLLAMA_BASE_URL == "/ollama":
        OLLAMA_BASE_URL = "http://host.docker.internal:11434"
224
225
226
227
228
229
230
231
232
233
234
235
236
237
    else:
        OLLAMA_BASE_URL = "http://ollama-service.open-webui.svc.cluster.local:11434"
    


def is_running_in_kubernetes():
    return 'KUBERNETES_SERVICE_HOST' in os.environ

# Setze EMV auf True, wenn in Kubernetes
if is_running_in_kubernetes():
    os.environ['EMV'] = 'True'
    print("Läuft in Kubernetes, EMV gesetzt auf True.")
else:
    print("Läuft nicht in Kubernetes.")
Timothy J. Baek's avatar
Timothy J. Baek committed
238
239


240
241
242
OLLAMA_BASE_URLS = os.environ.get("OLLAMA_BASE_URLS", "")
OLLAMA_BASE_URLS = OLLAMA_BASE_URLS if OLLAMA_BASE_URLS != "" else OLLAMA_BASE_URL

243
OLLAMA_BASE_URLS = [url.strip() for url in OLLAMA_BASE_URLS.split(";")]
244

245

Timothy J. Baek's avatar
Timothy J. Baek committed
246
247
248
249
250
####################################
# OPENAI_API
####################################

OPENAI_API_KEY = os.environ.get("OPENAI_API_KEY", "")
251
252
OPENAI_API_BASE_URL = os.environ.get("OPENAI_API_BASE_URL", "")

253

254
255
if OPENAI_API_BASE_URL == "":
    OPENAI_API_BASE_URL = "https://api.openai.com/v1"
Timothy J. Baek's avatar
Timothy J. Baek committed
256

Timothy J. Baek's avatar
Timothy J. Baek committed
257
258
259
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
260
OPENAI_API_KEYS = [url.strip() for url in OPENAI_API_KEYS.split(";")]
Timothy J. Baek's avatar
Timothy J. Baek committed
261
262
263
264
265
266
267


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
268
269
270
271
OPENAI_API_BASE_URLS = [
    url.strip() if url != "" else "https://api.openai.com/v1"
    for url in OPENAI_API_BASE_URLS.split(";")
]
272
273
274
275
276

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

Han Cen's avatar
Han Cen committed
277
ENABLE_SIGNUP = os.environ.get("ENABLE_SIGNUP", "True").lower() == "true"
278
DEFAULT_MODELS = os.environ.get("DEFAULT_MODELS", None)
Timothy J. Baek's avatar
Timothy J. Baek committed
279
280
281
282


DEFAULT_PROMPT_SUGGESTIONS = (
    CONFIG_DATA["ui"]["prompt_suggestions"]
Timothy J. Baek's avatar
Timothy J. Baek committed
283
284
285
    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
286
    else [
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
        {
            "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
303
    ]
304
)
Timothy J. Baek's avatar
Timothy J. Baek committed
305
306


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

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
309
310
311
USER_PERMISSIONS_CHAT_DELETION = (
    os.environ.get("USER_PERMISSIONS_CHAT_DELETION", "True").lower() == "true"
)
312

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

315

316
MODEL_FILTER_ENABLED = os.environ.get("MODEL_FILTER_ENABLED", "False").lower() == "true"
317
318
319
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
320
WEBHOOK_URL = os.environ.get("WEBHOOK_URL", "")
321

322
####################################
323
# WEBUI_VERSION
324
325
####################################

Timothy J. Baek's avatar
Timothy J. Baek committed
326
WEBUI_VERSION = os.environ.get("WEBUI_VERSION", "v1.0.0-alpha.100")
327
328

####################################
329
# WEBUI_AUTH (Required for security)
330
331
####################################

332
WEBUI_AUTH = True
333

Timothy J. Baek's avatar
Timothy J. Baek committed
334
####################################
335
# WEBUI_SECRET_KEY
Timothy J. Baek's avatar
Timothy J. Baek committed
336
337
####################################

338
339
WEBUI_SECRET_KEY = os.environ.get(
    "WEBUI_SECRET_KEY",
Timothy J. Baek's avatar
Timothy J. Baek committed
340
341
342
    os.environ.get(
        "WEBUI_JWT_SECRET_KEY", "t0p-s3cr3t"
    ),  # DEPRECATED: remove at next major version
343
)
344

345
if WEBUI_AUTH and WEBUI_SECRET_KEY == "":
Timothy J. Baek's avatar
Timothy J. Baek committed
346
    raise ValueError(ERROR_MESSAGES.ENV_VAR_NOT_FOUND)
347
348
349
350
351

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

352
CHROMA_DATA_PATH = f"{DATA_DIR}/vector_db"
353
# 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
354
RAG_EMBEDDING_MODEL = os.environ.get("RAG_EMBEDDING_MODEL", "all-MiniLM-L6-v2")
355
# 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
356
357
358
RAG_EMBEDDING_MODEL_DEVICE_TYPE = os.environ.get(
    "RAG_EMBEDDING_MODEL_DEVICE_TYPE", "cpu"
)
Timothy J. Baek's avatar
Timothy J. Baek committed
359
CHROMA_CLIENT = chromadb.PersistentClient(
Timothy J. Baek's avatar
Timothy J. Baek committed
360
361
    path=CHROMA_DATA_PATH,
    settings=Settings(allow_reset=True, anonymized_telemetry=False),
Timothy J. Baek's avatar
Timothy J. Baek committed
362
)
363
364
CHUNK_SIZE = 1500
CHUNK_OVERLAP = 100
Timothy J. Baek's avatar
Timothy J. Baek committed
365

Timothy J. Baek's avatar
Timothy J. Baek committed
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380

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
381
382
383
####################################
# Transcribe
####################################
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
384
385
386

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
387
388
389
390
391
392
393


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

AUTOMATIC1111_BASE_URL = os.getenv("AUTOMATIC1111_BASE_URL", "")