fix: add moonraker-hmi and moonraker-telegram-bot to the blacklist (#720)

* Add moonraker-hmi and moonraker-telegram-bot to the blacklist of moonraker service detection function

* fix: add "hmi" to SUFFIX_BLACKLIST to prevent instance name conflicts

Signed-off-by: Dominik Willner <th33xitus@gmail.com>

---------

Signed-off-by: Dominik Willner <th33xitus@gmail.com>
Co-authored-by: dw-0 <th33xitus@gmail.com>

.editorconfig

@@ -11,5 +11,5 @@ end_of_line = lf
 [*.py]
 max_line_length = 88
 
-[*.{sh,yml,yaml,json,md}]
+[*.{sh,yml,yaml,json}]
 indent_size = 2

.github/workflows/deploy-docs.yml

@@ -1,31 +0,0 @@
-name: Deploy Documentation
-on:
-  workflow_dispatch:
-  push:
-    branches:
-      - docs
-permissions:
-  contents: write
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Configure Git Credentials
-        run: |
-          git config user.name github-actions[bot]
-          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
-      - uses: actions/cache@v4
-        with:
-          key: mkdocs-material-${{ env.cache_id }}
-          path: .cache
-          restore-keys: |
-            mkdocs-material-
-      - name: Install dependencies
-        run: pip install -r requirements.txt
-      - name: Build and deploy documentation
-        run: mkdocs gh-deploy --force

Dockerfile

@@ -1,6 +0,0 @@
-FROM squidfunk/mkdocs-material:latest
-
-# Install additional plugins required by our mkdocs configuration
-RUN pip install \
-    mkdocs-git-revision-date-localized-plugin \
-    mkdocstrings[python]

docker-compose.yml

@@ -1,8 +0,0 @@
-services:
-  mkdocs:
-    build: .
-    ports:
-      - "8000:8000"
-    volumes:
-      - ./:/docs
-    command: serve --dev-addr=0.0.0.0:8000

docs/changelog.md

@@ -276,7 +276,7 @@ Each service gets its corresponding instance added to the service filename.
 
 * The user can now choose to install Klipper as a systemd service.
 
-* The Shell Command extension and `shell_command.py` got renamed to G-Code Shell Command extension and `gcode_shell_command.py`. In case the [pending PR](https://github.com/KevinOConnor/klipper/pull/2173) will be merged in the future, this was an early attempt to dodge possible incompatibilities. The [G-Code Shell Command docs](extensions/gcode-shell-command) has been updated accordingly.
+* The Shell Command extension and `shell_command.py` got renamed to G-Code Shell Command extension and `gcode_shell_command.py`. In case the [pending PR](https://github.com/KevinOConnor/klipper/pull/2173) will be merged in the future, this was an early attempt to dodge possible incompatibilities. The [G-Code Shell Command docs](gcode_shell_command.md) has been updated accordingly.
 
 * The way how KIAUH interacts and writes to the users printer.cfg got changed. Usually KIAUH wrote everything directly into the printer.cfg. The way it will work from now on is, that a new file called `kiauh.cfg` will be created if there is something that needs to be written to the printer.cfg and everything gets written to `kiauh.cfg` instead. The only thing which then gets written to the users printer.cfg is `[include kiauh.cfg]`. This line will be located at the very top of the existing printer.cfg with a little comment as a note. The user can then decide to either keep the `kiauh.cfg` or take its content, places it into the printer.cfg directly and remove the `[include kiauh.cfg]`.
 

docs/index.md

@@ -1,20 +0,0 @@
-<h1 align="center">
-  KIAUH - Klipper Installation And Update Helper
-</h1>
-
-<p align="center">
-  <img src="assets/logo-large.png" alt="KIAUH logo">
-</p>
-<p align="center">
-  A handy installation script that makes installing Klipper (and more) a breeze!
-</p>
-
-
-## Features
-
-- Easy installation of Klipper and related components
-- Support for multiple instances
-- Extension system for additional functionality
-- Configuration management
-- And more!
-

kiauh/core/instance_manager/base_instance.py

@@ -16,8 +16,9 @@ from typing import List
 
 from utils.fs_utils import get_data_dir
 
-SUFFIX_BLACKLIST: List[str] = ["None", "mcu", "obico", "bambu", "companion"]
-
+# suffixes that are not allowed to be used for instances
+# because they would cause conflicts with other components or are reserved
+SUFFIX_BLACKLIST: List[str] = ["None", "mcu", "obico", "bambu", "companion", "hmi"]
 
 @dataclass(repr=True)
 class BaseInstance:

kiauh/extensions/extensions_menu.py

@@ -150,9 +150,9 @@ class ExtensionSubmenu(BaseMenu):
         if website or repo:
             links_lines: List[str] = ["Links:"]
             if website:
-                links_lines.append(f"- Website: {website}")
+                links_lines.append(f"● {website}")
             if repo:
-                links_lines.append(f"- GitHub: {repo}")
+                links_lines.append(f"● {repo}")
 
             links_text = Logger.format_content(
                 links_lines,

kiauh/extensions/gcode_shell_cmd/metadata.json

@@ -4,6 +4,7 @@
     "module": "gcode_shell_cmd_extension",
     "maintained_by": "dw-0",
     "display_name": "G-Code Shell Command",
-    "description": ["Run a shell commands from gcode."]
+    "description": ["Run a shell commands from gcode."],
+    "updates": false
   }
 }

kiauh/extensions/klipper_backup/metadata.json

@@ -5,6 +5,8 @@
     "maintained_by": "Staubgeborener",
     "display_name": "Klipper-Backup",
     "description": ["Backup all your Klipper files to GitHub"],
+    "website": "https://klipperbackup.xyz",
+    "repo": "https://github.com/Staubgeborener/klipper-backup",
     "updates": true
   }
 }

kiauh/extensions/mainsail_theme_installer/metadata.json

@@ -4,6 +4,8 @@
     "module": "mainsail_theme_installer_extension",
     "maintained_by": "dw-0",
     "display_name": "Mainsail Theme Installer",
-    "description": ["Install Mainsail Themes maintained by the Mainsail community."]
+    "description": ["Install Mainsail Themes maintained by the Mainsail community."],
+    "website": "https://docs.mainsail.xyz/theming/themes",
+    "updates": false
   }
 }

kiauh/extensions/mobileraker/metadata.json

@@ -7,6 +7,7 @@
         "description": [
             "Companion for Mobileraker, enabling push notification for Klipper using Moonraker."
         ],
+        "repo": "https://github.com/Clon1998/mobileraker_companion",
         "updates": true
     }
 }

kiauh/extensions/obico/metadata.json

@@ -11,6 +11,8 @@
         "- 25FPS High-Def Webcam Streaming",
         "- Free 4.9-Star Mobile App"
     ],
+    "website": "https://obico.io",
+    "repo": "github.com/TheSpaghettiDetective/moonraker-obico",
     "updates": true
   }
 }

kiauh/extensions/octoapp/metadata.json

@@ -12,6 +12,7 @@
             "- Live Gcode preview",
             "- And much much more!"
         ],
+        "repo": "https://github.com/crysxd/OctoApp-Plugin",
         "updates": true
     }
 }

kiauh/extensions/octoeverywhere/metadata.json

@@ -11,6 +11,8 @@
             "- Real-time Notifications",
             "- Live Streaming, and More!"
         ],
+        "website": "https://octoeverywhere.com",
+        "repo": "github.com/QuinnDamerell/OctoPrint-OctoEverywhere",
         "updates": true
     }
 }

kiauh/extensions/pretty_gcode/metadata.json

@@ -5,6 +5,7 @@
     "maintained_by": "Kragrathea",
     "display_name": "PrettyGCode for Klipper",
     "description": ["3D G-Code viewer for Klipper"],
+    "repo": "https://github.com/Kragrathea/pgcode",
     "updates": true
   }
 }

kiauh/extensions/simply_print/metadata.json

@@ -1,13 +1,16 @@
 {
-    "metadata": {
-        "index": 10,
-        "module": "simply_print_extension",
-        "maintained_by": "dw-0",
-        "display_name": "SimplyPrint",
-        "description": [
-            "3D Printer Cloud Management Software.",
-            "\n\n",
-            "3D printing doesn't have to be a complicated, analog, SD card-filled experience; step into the future of modern 3D printing"
-        ]
-    }
+  "metadata": {
+    "index": 10,
+    "module": "simply_print_extension",
+    "maintained_by": "dw-0",
+    "display_name": "SimplyPrint",
+    "description": [
+      "3D Printer Cloud Management Software.",
+      "\n\n",
+      "3D printing doesn't have to be a complicated, analog, SD card-filled experience; step into the future of modern 3D printing"
+    ],
+    "website": "https://simplyprint.io",
+    "repo": "https://github.com/SimplyPrint",
+    "updates": false
+  }
 }

kiauh/extensions/spoolman/metadata.json

@@ -13,6 +13,7 @@
       "\n\n",
       "Note: This extension installs Spoolman using Docker. Docker must be installed on your system before installing Spoolman."
     ],
+    "repo": "https://github.com/Donkie/Spoolman",
     "updates": true
   }
 }

kiauh/extensions/telegram_bot/metadata.json

@@ -5,7 +5,7 @@
     "maintained_by": "nlef",
     "display_name": "Moonraker Telegram Bot",
     "description": ["Control your printer with the Telegram messenger app."],
-    "project_url": "https://github.com/nlef/moonraker-telegram-bot",
+    "repo": "https://github.com/nlef/moonraker-telegram-bot",
     "updates": true
   }
 }

mkdocs.yml

@@ -1,82 +0,0 @@
-site_name: KIAUH Documentation
-site_description: Documentation for the Klipper Installation And Update Helper
-repo_url: https://github.com/dw-0/kiauh
-repo_name: dw-0/kiauh
-edit_uri: edit/master/docs
-
-copyright: Copyright © 2025 Dominik Willner
-
-theme:
-  name: material
-  logo: assets/logo.png
-  favicon: assets/logo.png
-  icon:
-    repo: fontawesome/brands/github
-  palette:
-    - media: "(prefers-color-scheme: light)"
-      scheme: default
-      primary: blue-grey
-      accent: cyan
-      toggle:
-        icon: material/weather-night
-        name: Switch to dark mode
-    - media: "(prefers-color-scheme: dark)"
-      scheme: slate
-      primary: blue-grey
-      accent: cyan
-      toggle:
-        icon: material/weather-sunny
-        name: Switch to light mode
-  features:
-    - navigation.instant
-    - navigation.tracking
-    - navigation.sections
-    - navigation.expand
-    - navigation.indexes
-    - navigation.top
-    - toc.follow
-    - content.code.copy
-
-plugins:
-  - search
-  - git-revision-date-localized:
-      enable_creation_date: true
-  - mkdocstrings:
-      handlers:
-        python:
-          paths: [.]
-          options:
-            docstring_style: google
-
-markdown_extensions:
-  - admonition
-  - pymdownx.details
-  - pymdownx.superfences
-  - pymdownx.highlight:
-      anchor_linenums: true
-  - pymdownx.inlinehilite
-  - pymdownx.snippets
-  - pymdownx.superfences
-  - tables
-  - attr_list
-  - md_in_html
-
-nav:
-  - Home: index.md
-  - Installation: installation.md
-  - Configuration: configuration.md
-  - Extensions:
-      - extensions/index.md
-      - extensions/gcode-shell-command.md
-  - Development:
-      - development/contributing.md
-      - development/changelog.md
-
-extra:
-  social:
-    - icon: simple/github
-      link: https://github.com/dw-0
-    - icon: simple/kofi
-      link: https://ko-fi.com/dw__0
-    - icon: simple/paypal
-      link: https://www.paypal.com/paypalme/dwillner0

requirements.txt

@@ -1,4 +0,0 @@
-mkdocs-material
-mkdocs
-mkdocstrings[python]
-mkdocs-git-revision-date-localized-plugin

scripts/moonraker.sh

@@ -27,7 +27,7 @@ function moonraker_systemd() {
   ###
   # any moonraker client that uses "moonraker" in its own name must be blacklisted using
   # this variable, otherwise they will be falsely recognized as moonraker instances
-  blacklist="obico"
+  blacklist="obico|hmi|telegram-bot"
 
   ignore="${SYSTEMD}/moonraker-(${blacklist}).service"
   match="${SYSTEMD}/moonraker(-[0-9a-zA-Z]+)?.service"