Implement Web UI for Moodle Mate with authentication and configuration management

This commit introduces a new Web UI for Moodle Mate, enhancing user interaction and configuration management. Key changes include:

- Added a `WebUI` class in `src/web/api.py` to handle web server functionality using FastAPI.
- Implemented authentication via a simple cookie mechanism, allowing secure access to the dashboard.
- Created HTML templates for the login page and main dashboard, providing a user-friendly interface.
- Updated the configuration model to include web settings, enabling dynamic configuration through the UI.
- Introduced a notification history feature to track past notifications within the UI.

These updates aim to improve user experience and streamline configuration management for Moodle Mate.

Author: EvickaStudio

README.md

@@ -29,6 +29,12 @@ Moodle Mate comes with an optional AI-powered summarization feature that will su
   - Optional AI-based content summarization that creates quick TLDRs.
   - Converts HTML notifications to Markdown for improved readability using [turndown-python](https://github.com/EvickaStudio/turndown-python).
 
+- **Web Dashboard**
+  - Monitor system status, logs, and configuration.
+  - Live configuration editing.
+  - Test notifications.
+  - Protected by optional authentication.
+
 - **Multi-Platform Support**
   - Discord (via webhooks)
   - Pushbullet (send to all your devices)
@@ -84,12 +90,14 @@ Moodle Mate comes with an optional AI-powered summarization feature that will su
    Edit `.env` with your settings. Configuration uses environment variables with the `MOODLEMATE_` prefix.
 
    Example `.env`:
-
    ```env
    MOODLEMATE_MOODLE__URL=https://moodle.example.com
    MOODLEMATE_MOODLE__USERNAME=your_username
    MOODLEMATE_MOODLE__PASSWORD=your_password
 
+   # Web UI Protection
+   MOODLEMATE_WEB__AUTH_SECRET=your_secure_password
+
    MOODLEMATE_DISCORD__ENABLED=true
    MOODLEMATE_DISCORD__WEBHOOK_URL=https://discord.com/api/webhooks/...
    ```
@@ -155,14 +163,31 @@ docker compose down
 When running, the application will:
 
 1. Validate your configuration.
-2. Connect to your Moodle instance.
-3. Continuously monitor for new notifications.
-4. Process and deliver notifications according to your settings.
+2. Start the Web Dashboard (default: http://localhost:9095).
+3. Connect to your Moodle instance.
+4. Continuously monitor for new notifications.
+5. Process and deliver notifications according to your settings.
+
+## Web Dashboard
+
+Moodle Mate includes a built-in web dashboard for monitoring and configuration.
+
+- **URL**: `http://0.0.0.0:9095` (default)
+- **Features**:
+  - View current status and metrics.
+  - Trigger test notifications.
+  - Edit configuration live (requires `MOODLEMATE_WEB__AUTH_SECRET` if set).
+
+**Security**: To protect the dashboard, set `MOODLEMATE_WEB__AUTH_SECRET` in your `.env` file. If this variable is set, you will be prompted to enter this password to access the dashboard.
 
 ## Screenshots
 
 *Colors between the screenshots are different because of different themes in Termius.*
 
+### v2.0.3 (Web UI)
+
+![v2.0.3](assets/webui_v2.0.3.png)
+
 ### v2.0.2 (Docker)
 
 ![v2.0.2](assets/running_v2.0.2.png)

assets/webui_v2.0.3.png

@@ -3,13 +3,21 @@ MOODLEMATE_MOODLE__USERNAME=your_username
 MOODLEMATE_MOODLE__PASSWORD=your_password
 MOODLEMATE_MOODLE__INITIAL_FETCH_COUNT=1
 
+# Web UI Configuration
+MOODLEMATE_WEB__ENABLED=false
+MOODLEMATE_WEB__HOST=0.0.0.0
+MOODLEMATE_WEB__PORT=9095
+MOODLEMATE_WEB__AUTH_SECRET=your_secure_password
+
 # AI Configuration (Optional)
 MOODLEMATE_AI__ENABLED=true
 MOODLEMATE_AI__API_KEY=sk-...
 MOODLEMATE_AI__MODEL=gpt-4o-mini
 MOODLEMATE_AI__TEMPERATURE=0.7
 MOODLEMATE_AI__MAX_TOKENS=150
-# MOODLEMATE_AI__ENDPOINT=https://api.openai.com/v1/chat/completions
+MOODLEMATE_AI__SYSTEM_PROMPT=Summarize the message concisely with appropriate emojis, excluding links.
+MOODLEMATE_AI__ENDPOINT=https://api.openai.com/v1/
+# for openrouter change to https://openrouter.ai/api/v1/
 
 # Notification Settings
 MOODLEMATE_NOTIFICATION__MAX_RETRIES=5
@@ -28,4 +36,3 @@ MOODLEMATE_PUSHBULLET__API_KEY=
 # Webhook Site
 MOODLEMATE_WEBHOOK_SITE__ENABLED=false
 MOODLEMATE_WEBHOOK_SITE__WEBHOOK_URL=
-

cleaner.sh

@@ -67,7 +67,7 @@ def main() -> None:
         providers = initialize_providers(settings)
 
         # Notification Processor
-        notification_processor = NotificationProcessor(settings, providers, summarizer)
+        notification_processor = NotificationProcessor(settings, providers, state_manager, summarizer)
 
         # Moodle Handler
         moodle_handler = MoodleNotificationHandler(settings, moodle_api, state_manager)

example.env

@@ -16,4 +16,8 @@ dependencies = [
     "pydantic>=2.10.0",
     "pydantic-settings>=2.0.0",
     "urllib3[secure]>=2.3.0",
+    "fastapi>=0.109.0",
+    "uvicorn>=0.27.0",
+    "jinja2>=3.1.0",
+    "python-multipart>=0.0.9",
 ]

format.sh

@@ -1,11 +1,16 @@
 # This file was autogenerated by uv via the following command:
 #    uv pip compile pyproject.toml -o requirements.txt
+annotated-doc==0.0.4
+    # via fastapi
 annotated-types==0.7.0
     # via pydantic
 anyio==4.10.0
     # via
     #   httpx
     #   openai
+    #   starlette
+bleach==6.3.0
+    # via moodle-mate (pyproject.toml)
 certifi==2025.8.3
     # via
     #   httpcore
@@ -15,16 +20,20 @@ cfgv==3.4.0
     # via pre-commit
 charset-normalizer==3.4.3
     # via requests
-configparser==7.2.0
-    # via moodle-mate (pyproject.toml)
+click==8.3.1
+    # via uvicorn
 distlib==0.4.0
     # via virtualenv
 distro==1.9.0
     # via openai
+fastapi==0.123.4
+    # via moodle-mate (pyproject.toml)
 filelock==3.18.0
     # via virtualenv
 h11==0.16.0
-    # via httpcore
+    # via
+    #   httpcore
+    #   uvicorn
 httpcore==1.0.9
     # via httpx
 httpx==0.28.1
@@ -38,8 +47,12 @@ idna==3.10
     #   requests
 iniconfig==2.1.0
     # via pytest
+jinja2==3.1.6
+    # via moodle-mate (pyproject.toml)
 jiter==0.10.0
     # via openai
+markupsafe==3.0.3
+    # via jinja2
 nodeenv==1.9.1
     # via pre-commit
 openai==1.99.9
@@ -53,13 +66,23 @@ pluggy==1.6.0
 pre-commit==4.3.0
     # via moodle-mate (pyproject.toml)
 pydantic==2.11.7
-    # via openai
+    # via
+    #   moodle-mate (pyproject.toml)
+    #   fastapi
+    #   openai
+    #   pydantic-settings
 pydantic-core==2.33.2
     # via pydantic
+pydantic-settings==2.12.0
+    # via moodle-mate (pyproject.toml)
 pygments==2.19.2
     # via pytest
 pytest==8.4.1
     # via moodle-mate (pyproject.toml)
+python-dotenv==1.2.1
+    # via pydantic-settings
+python-multipart==0.0.20
+    # via moodle-mate (pyproject.toml)
 pyyaml==6.0.2
     # via pre-commit
 regex==2025.7.34
@@ -74,6 +97,8 @@ sniffio==1.3.1
     # via
     #   anyio
     #   openai
+starlette==0.50.0
+    # via fastapi
 tiktoken==0.11.0
     # via moodle-mate (pyproject.toml)
 tqdm==4.67.1
@@ -83,15 +108,24 @@ types-requests==2.32.4.20250809
 typing-extensions==4.14.1
     # via
     #   anyio
+    #   fastapi
     #   openai
     #   pydantic
     #   pydantic-core
+    #   starlette
     #   typing-inspection
 typing-inspection==0.4.1
-    # via pydantic
+    # via
+    #   pydantic
+    #   pydantic-settings
 urllib3==2.5.0
     # via
+    #   moodle-mate (pyproject.toml)
     #   requests
     #   types-requests
+uvicorn==0.38.0
+    # via moodle-mate (pyproject.toml)
 virtualenv==20.34.0
-    # via pre-commit
+    # via pre-commit
+webencodings==0.5.1
+    # via bleach

main.py

@@ -1,9 +1,12 @@
 import logging
+import threading
 import time
 from typing import TYPE_CHECKING
+import uvicorn
 
 from src.core.utils.retry import with_retry
 from src.infrastructure.http.request_manager import request_manager
+from src.web.api import WebUI
 
 if TYPE_CHECKING:
     from src.config import Settings
@@ -30,10 +33,14 @@ def __init__(
         self.moodle_api = moodle_api
         self.state_manager = state_manager
         self._last_heartbeat_sent: float = 0.0
+        self._web_server_thread: threading.Thread = None
 
     def run(self) -> None:
         """Starts the main application loop."""
         try:
+            if self.settings.web.enabled:
+                self._start_web_ui()
+
             self._main_loop()
         except KeyboardInterrupt:
             logging.info("Shutting down gracefully...")
@@ -42,6 +49,25 @@ def run(self) -> None:
             logging.error(f"An unexpected error occurred: {str(e)}")
             raise
 
+    def _start_web_ui(self):
+        """Starts the Web UI server in a separate thread."""
+        web_ui = WebUI(self.settings, self.state_manager, self)
+        app = web_ui.get_app()
+
+        def run_server():
+            host = self.settings.web.host
+            port = self.settings.web.port
+            logging.info(f"Starting Web UI on http://{host}:{port}")
+            uvicorn.run(
+                app,
+                host=host,
+                port=port,
+                log_level="warning"
+            )
+
+        self._web_server_thread = threading.Thread(target=run_server, daemon=True)
+        self._web_server_thread.start()
+
     def _main_loop(self) -> None:
         """The main loop that continuously fetches and processes notifications."""
         consecutive_errors = 0

pyproject.toml

@@ -31,6 +31,12 @@ class HealthConfig(BaseModel):
     failure_alert_threshold: Optional[int] = None
     target_provider: Optional[str] = None
 
+class WebConfig(BaseModel):
+    enabled: bool = True
+    host: str = "0.0.0.0"
+    port: int = 9095
+    auth_secret: Optional[str] = None
+
 # Providers
 class DiscordConfig(BaseModel):
     enabled: bool = False
@@ -62,6 +68,7 @@ class Settings(BaseSettings):
     notification: NotificationConfig = Field(default_factory=NotificationConfig)
     filters: FiltersConfig = Field(default_factory=FiltersConfig)
     health: HealthConfig = Field(default_factory=HealthConfig)
+    web: WebConfig = Field(default_factory=WebConfig)
 
     # Providers
     # To add a new provider, define its config model above and add it here.