feat: 支持通过环境变量修改配置

Author: shaohuzhang1

apps/smartdoc/conf.py

@@ -13,6 +13,7 @@
 import re
 from importlib import import_module
 from urllib.parse import urljoin, urlparse
+
 import yaml
 
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
@@ -75,25 +76,18 @@ class DoesNotExist(Exception):
 class Config(dict):
     defaults = {
         # 数据库相关配置
-        "DB_HOST": "",
-        "DB_PORT": "",
-        "DB_USER": "",
-        "DB_PASSWORD": "",
+        "DB_HOST": "127.0.0.1",
+        "DB_PORT": 5432,
+        "DB_USER": "root",
+        "DB_PASSWORD": "Password123@postgres",
         "DB_ENGINE": "django.db.backends.postgresql_psycopg2",
-        # 邮件相关配置
-        "EMAIL_ADDRESS": "",
-        "EMAIL_USE_TLS": False,
-        "EMAIL_USE_SSL": True,
-        "EMAIL_HOST": "",
-        "EMAIL_PORT": 465,
-        "EMAIL_HOST_USER": "",
-        "EMAIL_HOST_PASSWORD": "",
         # 向量模型
         "EMBEDDING_MODEL_NAME": "shibing624/text2vec-base-chinese",
         "EMBEDDING_DEVICE": "cpu",
         "EMBEDDING_MODEL_PATH": os.path.join(PROJECT_DIR, 'models'),
         # 向量库配置
-        "VECTOR_STORE_NAME": 'pg_vector'
+        "VECTOR_STORE_NAME": 'pg_vector',
+        "DEBUG": False
 
     }
 
@@ -180,8 +174,36 @@ def load_from_yml(self):
             loaded = self.from_yaml(i)
             if loaded:
                 return True
+        msg = f"""
 
-        return False
+                   Error: No config file found.
+
+                   You can run `cp config_example.yml {self.root_path}/config.yml`, and edit it.
+
+                   """
+        raise ImportError(msg)
+
+    def load_from_env(self):
+        keys = os.environ.keys()
+        config = {key.replace('MAXKB_', ''): os.environ.get(key) for key in keys if key.startswith('MAXKB_')}
+        if len(config.keys()) <= 1:
+            msg = f"""
+
+                             Error: No config env found.
+
+                             Please set environment variables
+                                MAXKB_CONFIG_TYPE: 配置文件读取方式 FILE: 使用配置文件配置  ENV: 使用ENV配置
+                                MAXKB_DB_NAME: 数据库名称
+                                MAXKB_DB_HOST: 数据库主机
+                                MAXKB_DB_PORT: 数据库端口
+                                MAXKB_DB_USER: 数据库用户名
+                                MAXKB_DB_PASSWORD: 数据库密码
+                                MAXKB_EMBEDDING_MODEL_PATH: 向量模型目录
+                                MAXKB_EMBEDDING_MODEL_NAME: 向量模型名称
+                             """
+            raise ImportError(msg)
+        self.from_mapping(config)
+        return True
 
     @classmethod
     def load_user_config(cls, root_path=None, config_class=None):
@@ -190,15 +212,10 @@ def load_user_config(cls, root_path=None, config_class=None):
         if not root_path:
             root_path = PROJECT_DIR
         manager = cls(root_path=root_path)
-        if manager.load_from_yml():
-            config = manager.config
+        config_type = os.environ.get('MAXKB_CONFIG_TYPE')
+        if config_type is None or config_type != 'ENV':
+            manager.load_from_yml()
         else:
-            msg = f"""
-
-            Error: No config file found.
-
-            You can run `cp config_example.yml {root_path}/config.yml`, and edit it.
-
-            """
-            raise ImportError(msg)
+            manager.load_from_env()
+        config = manager.config
         return config

config_example.yml

@@ -1,12 +1,3 @@
-# 邮箱配置
-EMAIL_ADDRESS:
-EMAIL_USE_TLS: False
-EMAIL_USE_SSL: True
-EMAIL_HOST: smtp.qq.com
-EMAIL_PORT: 465
-EMAIL_HOST_USER:
-EMAIL_HOST_PASSWORD:
-
 # 数据库链接信息
 DB_NAME: maxkb
 DB_HOST: localhost

installer/Dockerfile

@@ -17,7 +17,6 @@ RUN apt-get update && \
 
 COPY . /opt/maxkb/app
 RUN mkdir -p /opt/maxkb/app /opt/maxkb/model /opt/maxkb/conf && \
-    cp -f /opt/maxkb/app/installer/config.yaml /opt/maxkb/conf && \
     rm -rf /opt/maxkb/app/ui
 COPY --from=web-build ui /opt/maxkb/app/ui
 WORKDIR /opt/maxkb/app
@@ -33,7 +32,16 @@ ARG DOCKER_IMAGE_TAG=dev \
     BUILD_AT \
     GITHUB_COMMIT
 
-ENV MAXKB_VERSION ${DOCKER_IMAGE_TAG} (build at ${BUILD_AT}, commit: ${GITHUB_COMMIT})
+ENV MAXKB_VERSION="${DOCKER_IMAGE_TAG} (build at ${BUILD_AT}, commit: ${GITHUB_COMMIT})" \
+    MAXKB_CONFIG_TYPE=ENV \
+    MAXKB_DB_NAME=maxkb \
+    MAXKB_DB_HOST=127.0.0.1 \
+    MAXKB_DB_PORT=5432  \
+    MAXKB_DB_USER=root \
+    MAXKB_DB_PASSWORD=Password123@postgres \
+    MAXKB_EMBEDDING_MODEL_NAME=/opt/maxkb/model/embedding/shibing624_text2vec-base-chinese \
+    MAXKB_EMBEDDING_MODEL_PATH=/opt/maxkb/model/embedding
+
 WORKDIR /opt/maxkb/app
 COPY --from=stage-build /opt/maxkb /opt/maxkb
 COPY --from=stage-build /opt/py3 /opt/py3