docs: add Raspberry Pi setup guide and update installation instructions

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

.editorconfig

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

.github/workflows/deploy-docs.yml

@@ -0,0 +1,31 @@
+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

.gitignore

@@ -10,4 +10,3 @@ __pycache__
 *.code-workspace
 *.iml
 kiauh.cfg
-klipper_repos.txt

.shellcheckrc

@@ -0,0 +1,15 @@
+source=scripts
+
+enable=avoid-nullary-conditions
+enable=deprecate-which
+enable=quote-safe-variables
+enable=require-variable-braces
+enable=require-double-brackets
+
+# SC2162: `read` without `-r` will mangle backslashes.
+# https://github.com/koalaman/shellcheck/wiki/SC2162
+disable=SC2162
+
+# SC2164: Use `cd ... || exit` in case `cd` fails
+# https://github.com/koalaman/shellcheck/wiki/SC2164
+disable=SC2164

Dockerfile

@@ -0,0 +1,6 @@
+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

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

docs/development/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](gcode_shell_command.md) 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](extensions/gcode-shell-command) 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/extensions/index.md

@@ -0,0 +1 @@
+# Community Extensions

docs/index.md

@@ -0,0 +1,23 @@
+!!! tip "Important"
+    This documentation is for KIAUH version 6 and still work in progress!
+
+<h1 align="center">
+  KIAUH - Klipper Installation And Update Helper
+</h1>
+
+<p align="center">
+  <img src="assets/logo-large.png" alt="KIAUH logo" width="400"/>
+</p>
+<p align="center" style="font-size: 1.2em; font-weight: bold;">
+  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!
+

docs/setup/installation.md

@@ -0,0 +1,39 @@
+# Installing KIAUH
+
+In the following sections, you will be guided through the installation
+process step-by-step.
+
+To use KIAUH, it is enough to download the script and run it on your
+Raspberry Pi or other compatible device. If you need to know how to
+set up a Raspberry Pi or if you are unsure whether your current setup
+is sufficient, please refer to the [Raspberry Pi Installation Guide](raspberry-pi-setup.md)
+and follow the steps therein. Afterwards, you can return to this guide to install KIAUH.
+
+### Prerequisites
+Before you can download and run KIAUH, you need to ensure that ``git`` is
+installed on your system. Open a terminal and run the following command:
+
+```bash
+sudo apt-get update && sudo apt-get install git -y
+```
+
+### Downloading KIAUH
+After `git` was successfully installed, you can download KIAUH by
+cloning the repository from GitHub. It is recommended to clone it into
+your home directory. Run the following command in your terminal:
+```bash
+cd ~ && git clone https://github.com/dw-0/kiauh.git
+```
+
+### Running KIAUH
+Once the repository is cloned, you can start KIAUH. Make sure you are in
+your home directory and execute the script by running the following
+command:
+```bash
+./kiauh/kiauh.sh
+```
+
+After executing the command, you will be presented with the KIAUH menu,
+which allows you to install and manage various 3D printing software.
+For more information on how to use KIAUH, please refer to the
+[Usage Guide](usage.md).

docs/setup/raspberry-pi-setup.md

@@ -0,0 +1,49 @@
+# Raspberry Pi Setup
+
+This guide will help you set up a Raspberry Pi for running Klipper and other,
+Klipper related 3D printing software. In case you are using a different single-board
+computer (SBC), please refer to the manufacturer's instructions for installing
+a compatible version of Linux on your device.
+
+It is assumed that you have at least a Raspberry Pi 3 or newer, along with a
+microSD card (at least 8GB, preferably 16GB or more) and a power supply.
+Additionally, you will need a computer with an SD card reader to prepare
+the microSD card.
+
+KIAUH requires a Linux operating system that has already been flashed to your
+Raspberry Pi's (or other SBC's) microSD card. As a result, you must ensure that you
+already have a functional Linux system on hand before you can proceed with
+installing KIAUH. `Raspberry Pi OS Lite` (either 32bit or 64bit) is a recommended Linux image
+if you are using a Raspberry Pi.
+
+---
+
+To flash `Raspberry Pi OS Lite` to your microSD card using the official [Raspberry Pi Imager](https://www.raspberrypi.com/software/),
+follow the steps below. If you encounter any issues or need further assistance, please refer to the [official Raspberry Pi documentation](https://www.raspberrypi.com/documentation/computers/getting-started.html).
+
+1. Open the Raspberry Pi Imager application on your computer.
+2. Click on `Choose OS` and select `Raspberry Pi OS (other)`.
+   ![OS selection](https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager1.png)
+3. Choose `Raspberry Pi OS Lite (32bit)` (or 64bit if desired).
+   ![Lite selection](https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager2.png)
+4. Insert the microSD card into your computer's SD card reader.
+5. In the main menu of the Imager, select the correct microSD card.
+6. Click the gear icon at the bottom left of the main menu to open advanced options.
+7. Enable SSH and enter your Wi-Fi credentials.
+
+    !!! info
+        Wi-Fi is only necessary if you want to connect to your Raspberry Pi over a wireless network. If you plan to use a wired Ethernet connection, you can skip this step. SSH is required for remote access to your Raspberry Pi, so make sure to enable it.
+
+8. Click `Save` to close the advanced options menu.
+9. Click `Write` to start flashing the image to the microSD card.
+
+    !!! warning
+        All data on the microSD card will be overwritten!
+
+10. Once the flashing process is complete, safely eject the microSD card from your computer.
+11. Insert the microSD card into your Raspberry Pi.
+12. Connect your Raspberry Pi to a power source to boot it up.
+13. Wait for a few minutes to allow the Raspberry Pi to complete its initial setup.
+14. You can now connect to your Raspberry Pi via SSH using the IP address assigned by your router. The default username is `pi` and the default password is `raspberry`.
+
+If you successfully connected to your Raspberry Pi via SSH, you can proceed to install KIAUH by following the instructions in the [Installation Guide](installation.md).

kiauh.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from kiauh.main import main
+
+if __name__ == "__main__":
+    main()

kiauh.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>       #
+# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
 #                                                                       #
 # This file is part of KIAUH - Klipper Installation And Update Helper   #
 # https://github.com/dw-0/kiauh                                         #
@@ -15,6 +15,11 @@ clear -x
 # make sure we have the correct permissions while running the script
 umask 022
 
+### sourcing all additional scripts
+KIAUH_SRCDIR="$(dirname -- "$(readlink -f "${BASH_SOURCE[0]}")")"
+for script in "${KIAUH_SRCDIR}/scripts/"*.sh; do . "${script}"; done
+for script in "${KIAUH_SRCDIR}/scripts/ui/"*.sh; do . "${script}"; done
+
 #===================================================#
 #=================== UPDATE KIAUH ==================#
 #===================================================#
@@ -52,6 +57,15 @@ function kiauh_update_avail() {
   fi
 }
 
+function save_startup_version() {
+  local launch_version
+
+  echo "${1}"
+
+  sed -i "/^version_to_launch=/d" "${INI_FILE}"
+  sed -i '$a'"version_to_launch=${1}" "${INI_FILE}"
+}
+
 function kiauh_update_dialog() {
   [[ ! $(kiauh_update_avail) == "true" ]] && return
   top_border
@@ -79,35 +93,11 @@ function kiauh_update_dialog() {
   done
 }
 
-function check_euid() {
-  if [[ ${EUID} -eq 0 ]]; then
-    echo -e "${red}"
-    top_border
-    echo -e "|       !!! THIS SCRIPT MUST NOT RUN AS ROOT !!!        |"
-    echo -e "|                                                       |"
-    echo -e "|        It will ask for credentials as needed.         |"
-    bottom_border
-    echo -e "${white}"
-    exit 1
-  fi
+function launch_kiauh_v5() {
+    main_menu
 }
 
-function check_if_ratos() {
-  if [[ -n $(which ratos) ]]; then
-    echo -e "${red}"
-    top_border
-    echo -e "|        !!! RatOS 2.1 or greater detected !!!          |"
-    echo -e "|                                                       |"
-    echo -e "|        KIAUH does currently not support RatOS.        |"
-    echo -e "| If you have any questions, please ask for help on the |"
-    echo -e "| RatRig Community Discord: https://discord.gg/ratrig   |"
-    bottom_border
-    echo -e "${white}"
-    exit 1
-  fi
-}
-
-function main() {
+function launch_kiauh_v6() {
   local entrypoint
 
   if ! command -v python3 &>/dev/null || [[ $(python3 -V | cut -d " " -f2 | cut -d "." -f2) -lt 8 ]]; then
@@ -121,10 +111,67 @@ function main() {
   export PYTHONPATH="${entrypoint}"
 
   clear -x
-   python3 "${entrypoint}/kiauh/main.py"
+  python3 "${entrypoint}/kiauh.py"
+}
+
+function main() {
+  read_kiauh_ini "${FUNCNAME[0]}"
+
+  if [[ ${version_to_launch} -eq 5 ]]; then
+    launch_kiauh_v5
+  elif [[ ${version_to_launch} -eq 6 ]]; then
+    launch_kiauh_v6
+  else
+    top_border
+    echo -e "|         ${green}KIAUH v6.0.0-alpha1 is available now!${white}         |"
+    hr
+    echo -e "|         View Changelog: ${magenta}https://git.io/JnmlX${white}          |"
+    blank_line
+    echo -e "| KIAUH v6 was completely rewritten from the ground up. |"
+    echo -e "| It's based on Python 3.8 and has many improvements.   |"
+    blank_line
+    echo -e "| ${yellow}NOTE: Version 6 is still in alpha, so bugs may occur!${white} |"
+    echo -e "| ${yellow}Yet, your feedback and bug reports are very much${white}      |"
+    echo -e "| ${yellow}appreciated and will help finalize the release.${white}       |"
+    hr
+    echo -e "| Would you like to try out KIAUH v6?                   |"
+    echo -e "| 1) Yes                                                |"
+    echo -e "| 2) No                                                 |"
+    echo -e "| 3) Yes, remember my choice for next time              |"
+    echo -e "| 4) No, remember my choice for next time               |"
+    quit_footer
+    while true; do
+      read -p "${cyan}###### Select action:${white} " -e input
+      case "${input}" in
+        1)
+          launch_kiauh_v6
+          break;;
+        2)
+          launch_kiauh_v5
+          break;;
+        3)
+          save_startup_version 6
+          launch_kiauh_v6
+          break;;
+        4)
+          save_startup_version 5
+          launch_kiauh_v5
+          break;;
+        Q|q)
+          echo -e "${green}###### Happy printing! ######${white}"; echo
+          exit 0;;
+        *)
+          error_msg "Invalid Input!\n";;
+      esac
+    done && input=""
+  fi
 }
 
 check_if_ratos
 check_euid
+init_logfile
+set_globals
 kiauh_update_dialog
+read_kiauh_ini
+init_ini
 main

kiauh/components/crowsnest/__init__.py

@@ -9,6 +9,7 @@
 
 from pathlib import Path
 
+from core.backup_manager import BACKUP_ROOT_DIR
 from core.constants import SYSTEMD
 
 # repo
@@ -19,6 +20,7 @@ CROWSNEST_SERVICE_NAME = "crowsnest.service"
 
 # directories
 CROWSNEST_DIR = Path.home().joinpath("crowsnest")
+CROWSNEST_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("crowsnest-backups")
 
 # files
 CROWSNEST_MULTI_CONFIG = CROWSNEST_DIR.joinpath("tools/.config")

kiauh/components/crowsnest/crowsnest.py

@@ -15,6 +15,7 @@ from subprocess import CalledProcessError, run
 from typing import List
 
 from components.crowsnest import (
+    CROWSNEST_BACKUP_DIR,
     CROWSNEST_BIN_FILE,
     CROWSNEST_DIR,
     CROWSNEST_INSTALL_SCRIPT,
@@ -25,8 +26,8 @@ from components.crowsnest import (
     CROWSNEST_SERVICE_NAME,
 )
 from components.klipper.klipper import Klipper
+from core.backup_manager.backup_manager import BackupManager
 from core.logger import DialogType, Logger
-from core.services.backup_service import BackupService
 from core.settings.kiauh_settings import KiauhSettings
 from core.types.component_status import ComponentStatus
 from utils.common import (
@@ -126,11 +127,11 @@ def update_crowsnest() -> None:
 
             settings = KiauhSettings()
             if settings.kiauh.backup_before_update:
-                svc = BackupService()
-                svc.backup_directory(
-                    source_path=CROWSNEST_DIR,
-                    target_path="crowsnest",
-                    backup_name="crowsnest",
+                bm = BackupManager()
+                bm.backup_directory(
+                    CROWSNEST_DIR.name,
+                    source=CROWSNEST_DIR,
+                    target=CROWSNEST_BACKUP_DIR,
                 )
 
             git_pull_wrapper(CROWSNEST_DIR)

kiauh/components/klipper/__init__.py

@@ -9,6 +9,8 @@
 
 from pathlib import Path
 
+from core.backup_manager import BACKUP_ROOT_DIR
+
 MODULE_PATH = Path(__file__).resolve().parent
 
 KLIPPER_REPO_URL = "https://github.com/Klipper3d/klipper.git"
@@ -25,6 +27,7 @@ KLIPPER_SERVICE_NAME = "klipper.service"
 KLIPPER_DIR = Path.home().joinpath("klipper")
 KLIPPER_KCONFIGS_DIR = Path.home().joinpath("klipper-kconfigs")
 KLIPPER_ENV_DIR = Path.home().joinpath("klippy-env")
+KLIPPER_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("klipper-backups")
 
 # files
 KLIPPER_REQ_FILE = KLIPPER_DIR.joinpath("scripts/klippy-requirements.txt")

kiauh/components/klipper/klipper_utils.py

@@ -16,6 +16,7 @@ from subprocess import CalledProcessError, run
 from typing import Dict, List
 
 from components.klipper import (
+    KLIPPER_BACKUP_DIR,
     KLIPPER_DIR,
     KLIPPER_ENV_DIR,
     KLIPPER_INSTALL_SCRIPT,
@@ -30,10 +31,10 @@ from components.webui_client.base_data import BaseWebClient
 from components.webui_client.client_config.client_config_setup import (
     create_client_config_symlink,
 )
+from core.backup_manager.backup_manager import BackupManager
 from core.constants import CURRENT_USER
 from core.instance_manager.base_instance import SUFFIX_BLACKLIST
 from core.logger import DialogType, Logger
-from core.services.backup_service import BackupService
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
@@ -197,17 +198,9 @@ def create_example_printer_cfg(
 
 
 def backup_klipper_dir() -> None:
-    svc = BackupService()
-    svc.backup_directory(
-        source_path=KLIPPER_DIR,
-        backup_name="klipper",
-        target_path="klipper",
-    )
-    svc.backup_directory(
-        source_path=KLIPPER_ENV_DIR,
-        backup_name="klippy-env",
-        target_path="klipper",
-    )
+    bm = BackupManager()
+    bm.backup_directory("klipper", source=KLIPPER_DIR, target=KLIPPER_BACKUP_DIR)
+    bm.backup_directory("klippy-env", source=KLIPPER_ENV_DIR, target=KLIPPER_BACKUP_DIR)
 
 
 def install_klipper_packages() -> None:

kiauh/components/klipperscreen/__init__.py

@@ -8,6 +8,7 @@
 # ======================================================================= #
 from pathlib import Path
 
+from core.backup_manager import BACKUP_ROOT_DIR
 from core.constants import SYSTEMD
 
 # repo
@@ -21,6 +22,7 @@ KLIPPERSCREEN_LOG_NAME = "KlipperScreen.log"
 # directories
 KLIPPERSCREEN_DIR = Path.home().joinpath("KlipperScreen")
 KLIPPERSCREEN_ENV_DIR = Path.home().joinpath(".KlipperScreen-env")
+KLIPPERSCREEN_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("klipperscreen-backups")
 
 # files
 KLIPPERSCREEN_REQ_FILE = KLIPPERSCREEN_DIR.joinpath(

kiauh/components/klipperscreen/klipperscreen.py

@@ -13,6 +13,7 @@ from typing import List
 
 from components.klipper.klipper import Klipper
 from components.klipperscreen import (
+    KLIPPERSCREEN_BACKUP_DIR,
     KLIPPERSCREEN_DIR,
     KLIPPERSCREEN_ENV_DIR,
     KLIPPERSCREEN_INSTALL_SCRIPT,
@@ -24,10 +25,10 @@ from components.klipperscreen import (
     KLIPPERSCREEN_UPDATER_SECTION_NAME,
 )
 from components.moonraker.moonraker import Moonraker
+from core.backup_manager.backup_manager import BackupManager
 from core.constants import SYSTEMD
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import DialogType, Logger
-from core.services.backup_service import BackupService
 from core.settings.kiauh_settings import KiauhSettings
 from core.types.component_status import ComponentStatus
 from utils.common import (
@@ -96,7 +97,6 @@ def install_klipperscreen() -> None:
 
 
 def patch_klipperscreen_update_manager(instances: List[Moonraker]) -> None:
-    BackupService().backup_moonraker_conf()
     add_config_section(
         section=KLIPPERSCREEN_UPDATER_SECTION_NAME,
         instances=instances,
@@ -183,7 +183,6 @@ def remove_klipperscreen() -> None:
         mr_instances: List[Moonraker] = get_instances(Moonraker)
         if mr_instances:
             Logger.print_status("Removing KlipperScreen from update manager ...")
-            BackupService().backup_moonraker_conf()
             remove_config_section("update_manager KlipperScreen", mr_instances)
             Logger.print_ok("KlipperScreen successfully removed from update manager!")
 
@@ -194,14 +193,14 @@ def remove_klipperscreen() -> None:
 
 
 def backup_klipperscreen_dir() -> None:
-    svc = BackupService()
-    svc.backup_directory(
-        source_path=KLIPPERSCREEN_DIR,
-        backup_name="KlipperScreen",
-        target_path="KlipperScreen",
+    bm = BackupManager()
+    bm.backup_directory(
+        KLIPPERSCREEN_DIR.name,
+        source=KLIPPERSCREEN_DIR,
+        target=KLIPPERSCREEN_BACKUP_DIR,
     )
-    svc.backup_directory(
-        source_path=KLIPPERSCREEN_ENV_DIR,
-        backup_name="KlipperScreen-env",
-        target_path="KlipperScreen",
+    bm.backup_directory(
+        KLIPPERSCREEN_ENV_DIR.name,
+        source=KLIPPERSCREEN_ENV_DIR,
+        target=KLIPPERSCREEN_BACKUP_DIR,
     )

kiauh/components/moonraker/__init__.py

@@ -9,6 +9,8 @@
 
 from pathlib import Path
 
+from core.backup_manager import BACKUP_ROOT_DIR
+
 MODULE_PATH = Path(__file__).resolve().parent
 
 MOONRAKER_REPO_URL = "https://github.com/Arksine/moonraker.git"
@@ -23,6 +25,8 @@ MOONRAKER_ENV_FILE_NAME = "moonraker.env"
 # directories
 MOONRAKER_DIR = Path.home().joinpath("moonraker")
 MOONRAKER_ENV_DIR = Path.home().joinpath("moonraker-env")
+MOONRAKER_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("moonraker-backups")
+MOONRAKER_DB_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("moonraker-db-backups")
 
 # files
 MOONRAKER_INSTALL_SCRIPT = MOONRAKER_DIR.joinpath("scripts/install-moonraker.sh")

kiauh/components/moonraker/utils/sysdeps_parser.py

@@ -61,9 +61,6 @@ class SysDepsParser:
         version = distro_info.get("distro_version")
         if version:
             self.distro_version = _convert_version(version)
-        self.vendor: str = ""
-        if pathlib.Path("/etc/rpi-issue").is_file():
-            self.vendor = "raspberry-pi"
 
     def _parse_spec(self, full_spec: str) -> str | None:
         parts = full_spec.split(";", maxsplit=1)
@@ -112,9 +109,6 @@ class SysDepsParser:
             elif req_var == "distro_id":
                 left_op: str | Tuple[int | str, ...] = self.distro_id
                 right_op = dep_parts[2].strip().strip("\"'")
-            elif req_var == "vendor":
-                left_op = self.vendor
-                right_op = dep_parts[2].strip().strip("\"'")
             elif req_var == "distro_version":
                 if not self.distro_version:
                     logging.info(

kiauh/components/moonraker/utils/utils.py

@@ -14,6 +14,8 @@ from typing import Dict, List, Optional
 
 from components.moonraker import (
     MODULE_PATH,
+    MOONRAKER_BACKUP_DIR,
+    MOONRAKER_DB_BACKUP_DIR,
     MOONRAKER_DEFAULT_PORT,
     MOONRAKER_DEPS_JSON_FILE,
     MOONRAKER_DIR,
@@ -23,8 +25,8 @@ from components.moonraker import (
 from components.moonraker.moonraker import Moonraker
 from components.moonraker.utils.sysdeps_parser import SysDepsParser
 from components.webui_client.base_data import BaseWebClient
+from core.backup_manager.backup_manager import BackupManager
 from core.logger import Logger
-from core.services.backup_service import BackupService
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
@@ -166,55 +168,21 @@ def create_example_moonraker_conf(
 
 
 def backup_moonraker_dir() -> None:
-    svc = BackupService()
-    svc.backup_directory(
-        source_path=MOONRAKER_DIR, backup_name="moonraker", target_path="moonraker"
-    )
-    svc.backup_directory(
-        source_path=MOONRAKER_ENV_DIR,
-        backup_name="moonraker-env",
-        target_path="moonraker",
+    bm = BackupManager()
+    bm.backup_directory("moonraker", source=MOONRAKER_DIR, target=MOONRAKER_BACKUP_DIR)
+    bm.backup_directory(
+        "moonraker-env", source=MOONRAKER_ENV_DIR, target=MOONRAKER_BACKUP_DIR
     )
 
 
 def backup_moonraker_db_dir() -> None:
     instances: List[Moonraker] = get_instances(Moonraker)
-    svc = BackupService()
-
-    if not instances:
-        # fallback: search for printer data directories in the user's home directory
-        Logger.print_info("No Moonraker instances found via systemd services.")
-        Logger.print_info(
-            "Attempting to find printer data directories in home directory..."
-        )
-
-        home_dir = Path.home()
-        printer_data_dirs = []
-
-        for pattern in ["printer_data", "printer_*_data"]:
-            for data_dir in home_dir.glob(pattern):
-                if data_dir.is_dir():
-                    printer_data_dirs.append(data_dir)
-
-        if not printer_data_dirs:
-            Logger.print_info("Unable to find directory to backup!")
-            Logger.print_info("No printer data directories found in home directory.")
-            return
-
-        for data_dir in printer_data_dirs:
-            svc.backup_directory(
-                source_path=data_dir.joinpath("database"),
-                target_path=data_dir.name,
-                backup_name="database",
-            )
-
-        return
+    bm = BackupManager()
 
     for instance in instances:
-        svc.backup_directory(
-            source_path=instance.db_dir,
-            target_path=f"{instance.data_dir.name}",
-            backup_name="database",
+        name = f"database-{instance.data_dir.name}"
+        bm.backup_directory(
+            name, source=instance.db_dir, target=MOONRAKER_DB_BACKUP_DIR
         )
 
 

kiauh/components/webui_client/base_data.py

@@ -34,6 +34,7 @@ class BaseWebClient(ABC):
     display_name: str
     client_dir: Path
     config_file: Path
+    backup_dir: Path
     repo_path: str
     download_url: str
     nginx_config: Path
@@ -51,5 +52,6 @@ class BaseWebClientConfig(ABC):
     display_name: str
     config_filename: str
     config_dir: Path
+    backup_dir: Path
     repo_url: str
     config_section: str

kiauh/components/webui_client/client_config/client_config_remove.py

@@ -14,7 +14,6 @@ from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
 from components.webui_client.base_data import BaseWebClientConfig
 from core.logger import Logger
-from core.services.backup_service import BackupService
 from core.services.message_service import Message
 from core.types.color import Color
 from utils.config_utils import remove_config_section
@@ -36,8 +35,6 @@ def run_client_config_removal(
     if run_remove_routines(client_config.config_dir):
         completion_msg.text.append(f"● {client_config.display_name} removed")
 
-    BackupService().backup_printer_config_dir()
-
     completion_msg = remove_moonraker_config_section(
         completion_msg, client_config, mr_instances
     )

kiauh/components/webui_client/client_config/client_config_setup.py

@@ -25,8 +25,8 @@ from components.webui_client.client_utils import (
 )
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import Logger
-from core.services.backup_service import BackupService
 from core.settings.kiauh_settings import KiauhSettings
+from utils.common import backup_printer_config_dir
 from utils.config_utils import add_config_section, add_config_section_at_top
 from utils.fs_utils import create_symlink
 from utils.git_utils import git_clone_wrapper, git_pull_wrapper
@@ -57,7 +57,7 @@ def install_client_config(client_data: BaseWebClient, cfg_backup=True) -> None:
         create_client_config_symlink(client_config, kl_instances)
 
         if cfg_backup:
-            BackupService().backup_printer_config_dir()
+            backup_printer_config_dir()
 
         add_config_section(
             section=f"update_manager {client_config.name}",

kiauh/components/webui_client/client_remove.py

@@ -16,9 +16,9 @@ from components.webui_client.base_data import (
 from components.webui_client.client_config.client_config_remove import (
     run_client_config_removal,
 )
+from core.backup_manager.backup_manager import BackupManager
 from core.constants import NGINX_SITES_AVAILABLE, NGINX_SITES_ENABLED
 from core.logger import Logger
-from core.services.backup_service import BackupService
 from core.services.message_service import Message
 from core.types.color import Color
 from utils.config_utils import remove_config_section
@@ -43,19 +43,8 @@ def run_client_removal(
     kl_instances: List[Klipper] = get_instances(Klipper)
 
     if backup_config:
-        version = ""
-        src = client.client_dir
-        if src.joinpath(".version").exists():
-            with open(src.joinpath(".version"), "r") as v:
-                version = v.readlines()[0]
-
-        svc = BackupService()
-        target_path = svc.backup_root.joinpath(f"{client.client_dir.name}_{version}")
-        success = svc.backup_file(
-            source_path=client.config_file,
-            target_path=target_path,
-        )
-        if success:
+        bm = BackupManager()
+        if bm.backup_file(client.config_file):
             completion_msg.text.append(f"● {client.config_file.name} backup created")
 
     if remove_client:
@@ -67,7 +56,6 @@ def run_client_removal(
         if remove_client_nginx_logs(client, kl_instances):
             completion_msg.text.append("● NGINX logs removed")
 
-        BackupService().backup_moonraker_conf()
         section = f"update_manager {client_name}"
         handled_instances: List[Moonraker] = remove_config_section(
             section, mr_instances

kiauh/components/webui_client/client_setup.py

@@ -37,10 +37,9 @@ from components.webui_client.client_utils import (
 )
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import DialogType, Logger
-from core.services.backup_service import BackupService
 from core.settings.kiauh_settings import KiauhSettings
 from core.types.color import Color
-from utils.common import check_install_dependencies
+from utils.common import backup_printer_config_dir, check_install_dependencies
 from utils.config_utils import add_config_section
 from utils.fs_utils import unzip
 from utils.input_utils import get_confirm
@@ -98,7 +97,7 @@ def install_client(
         if enable_remotemode and client.client == WebClientType.MAINSAIL:
             enable_mainsail_remotemode()
 
-        BackupService().backup_printer_config_dir()
+        backup_printer_config_dir()
         add_config_section(
             section=f"update_manager {client.name}",
             instances=mr_instances,

kiauh/components/webui_client/client_utils.py

@@ -24,13 +24,13 @@ from components.webui_client.base_data import (
 from components.webui_client.client_dialogs import print_client_port_select_dialog
 from components.webui_client.fluidd_data import FluiddData
 from components.webui_client.mainsail_data import MainsailData
+from core.backup_manager.backup_manager import BackupManager
 from core.constants import (
     NGINX_CONFD,
     NGINX_SITES_AVAILABLE,
     NGINX_SITES_ENABLED,
 )
 from core.logger import Logger
-from core.services.backup_service import BackupService
 from core.settings.kiauh_settings import KiauhSettings, WebUiSettings
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
@@ -175,39 +175,26 @@ def get_remote_client_version(client: BaseWebClient) -> str | None:
 
 
 def backup_client_data(client: BaseWebClient) -> None:
-    version = ""
+    name = client.name
     src = client.client_dir
-    if src.joinpath(".version").exists():
+    dest = client.backup_dir
+
     with open(src.joinpath(".version"), "r") as v:
         version = v.readlines()[0]
 
-    svc = BackupService()
-    target_path = svc.backup_root.joinpath(f"{client.client_dir.name}_{version}")
-    svc.backup_directory(
-        source_path=client.client_dir,
-        target_path=target_path,
-        backup_name=client.name,
-    )
-    svc.backup_file(
-        source_path=client.config_file,
-        target_path=target_path,
-    )
+    bm = BackupManager()
+    bm.backup_directory(f"{name}-{version}", src, dest)
+    bm.backup_file(client.config_file, dest)
+    bm.backup_file(NGINX_SITES_AVAILABLE.joinpath(name), dest)
 
 
 def backup_client_config_data(client: BaseWebClient) -> None:
-    version = ""
-    src = client.client_dir
-    if src.joinpath(".version").exists():
-        with open(src.joinpath(".version"), "r") as v:
-            version = v.readlines()[0]
-
-    svc = BackupService()
-    target_path = svc.backup_root.joinpath(f"{client.client_dir.name}_{version}")
-    svc.backup_directory(
-        source_path=client.client_config.config_dir,
-        target_path=target_path,
-        backup_name=client.client_config.name,
-    )
+    client_config = client.client_config
+    name = client_config.name
+    source = client_config.config_dir
+    target = client_config.backup_dir
+    bm = BackupManager()
+    bm.backup_directory(name, source, target)
 
 
 def get_existing_clients() -> List[BaseWebClient]:

kiauh/components/webui_client/fluidd_data.py

@@ -18,6 +18,7 @@ from components.webui_client.base_data import (
     WebClientConfigType,
     WebClientType,
 )
+from core.backup_manager import BACKUP_ROOT_DIR
 from core.constants import NGINX_SITES_AVAILABLE
 
 
@@ -29,6 +30,7 @@ class FluiddConfigWeb(BaseWebClientConfig):
     config_dir: Path = Path.home().joinpath("fluidd-config")
     config_filename: str = "fluidd.cfg"
     config_section: str = f"include {config_filename}"
+    backup_dir: Path = BACKUP_ROOT_DIR.joinpath("fluidd-config-backups")
     repo_url: str = "https://github.com/fluidd-core/fluidd-config.git"
 
 
@@ -41,6 +43,7 @@ class FluiddData(BaseWebClient):
     display_name: str = name.capitalize()
     client_dir: Path = Path.home().joinpath("fluidd")
     config_file: Path = client_dir.joinpath("config.json")
+    backup_dir: Path = BACKUP_ROOT_DIR.joinpath("fluidd-backups")
     repo_path: str = "fluidd-core/fluidd"
     nginx_config: Path = NGINX_SITES_AVAILABLE.joinpath("fluidd")
     nginx_access_log: Path = Path("/var/log/nginx/fluidd-access.log")

kiauh/components/webui_client/mainsail_data.py

@@ -18,6 +18,7 @@ from components.webui_client.base_data import (
     WebClientConfigType,
     WebClientType,
 )
+from core.backup_manager import BACKUP_ROOT_DIR
 from core.constants import NGINX_SITES_AVAILABLE
 
 
@@ -29,6 +30,7 @@ class MainsailConfigWeb(BaseWebClientConfig):
     config_dir: Path = Path.home().joinpath("mainsail-config")
     config_filename: str = "mainsail.cfg"
     config_section: str = f"include {config_filename}"
+    backup_dir: Path = BACKUP_ROOT_DIR.joinpath("mainsail-config-backups")
     repo_url: str = "https://github.com/mainsail-crew/mainsail-config.git"
 
 
@@ -41,6 +43,7 @@ class MainsailData(BaseWebClient):
     display_name: str = name.capitalize()
     client_dir: Path = Path.home().joinpath("mainsail")
     config_file: Path = client_dir.joinpath("config.json")
+    backup_dir: Path = BACKUP_ROOT_DIR.joinpath("mainsail-backups")
     repo_path: str = "mainsail-crew/mainsail"
     nginx_config: Path = NGINX_SITES_AVAILABLE.joinpath("mainsail")
     nginx_access_log: Path = Path("/var/log/nginx/mainsail-access.log")

kiauh/core/backup_manager/__init__.py

@@ -0,0 +1,12 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from pathlib import Path
+
+BACKUP_ROOT_DIR = Path.home().joinpath("kiauh-backups")

kiauh/core/backup_manager/backup_manager.py

@@ -0,0 +1,108 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import shutil
+from pathlib import Path
+from typing import List
+
+from core.backup_manager import BACKUP_ROOT_DIR
+from core.logger import Logger
+from utils.common import get_current_date
+
+
+class BackupManagerException(Exception):
+    pass
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class BackupManager:
+    def __init__(self, backup_root_dir: Path = BACKUP_ROOT_DIR):
+        self._backup_root_dir: Path = backup_root_dir
+        self._ignore_folders: List[str] = []
+
+    @property
+    def backup_root_dir(self) -> Path:
+        return self._backup_root_dir
+
+    @backup_root_dir.setter
+    def backup_root_dir(self, value: Path):
+        self._backup_root_dir = value
+
+    @property
+    def ignore_folders(self) -> List[str]:
+        return self._ignore_folders
+
+    @ignore_folders.setter
+    def ignore_folders(self, value: List[str]):
+        self._ignore_folders = value
+
+    def backup_file(
+        self, file: Path, target: Path | None = None, custom_filename=None
+    ) -> bool:
+        Logger.print_status(f"Creating backup of {file} ...")
+
+        if not file.exists():
+            Logger.print_info("File does not exist! Skipping ...")
+            return False
+
+        target = self.backup_root_dir if target is None else target
+
+        if Path(file).is_file():
+            date = get_current_date().get("date")
+            time = get_current_date().get("time")
+            filename = f"{file.stem}-{date}-{time}{file.suffix}"
+            filename = custom_filename if custom_filename is not None else filename
+            try:
+                Path(target).mkdir(exist_ok=True)
+                shutil.copyfile(file, target.joinpath(filename))
+                Logger.print_ok("Backup successful!")
+                return True
+            except OSError as e:
+                Logger.print_error(f"Unable to backup '{file}':\n{e}")
+                return False
+        else:
+            Logger.print_info(f"File '{file}' not found ...")
+            return False
+
+    def backup_directory(
+        self, name: str, source: Path, target: Path | None = None
+    ) -> Path | None:
+        Logger.print_status(f"Creating backup of {name} in {target} ...")
+
+        if source is None or not Path(source).exists():
+            Logger.print_info("Source directory does not exist! Skipping ...")
+            return None
+
+        target = self.backup_root_dir if target is None else target
+        try:
+            date = get_current_date().get("date")
+            time = get_current_date().get("time")
+            backup_target = target.joinpath(f"{name.lower()}-{date}-{time}")
+            shutil.copytree(
+                source,
+                backup_target,
+                ignore=self.ignore_folders_func,
+                ignore_dangling_symlinks=True,
+            )
+            Logger.print_ok("Backup successful!")
+
+            return backup_target
+
+        except OSError as e:
+            Logger.print_error(f"Unable to backup directory '{source}':\n{e}")
+            raise BackupManagerException(f"Unable to backup directory '{source}':\n{e}")
+
+    def ignore_folders_func(self, dirpath, filenames) -> List[str]:
+        return (
+            [f for f in filenames if f in self._ignore_folders]
+            if self._ignore_folders
+            else []
+        )

kiauh/core/constants.py

@@ -11,6 +11,8 @@ import os
 import pwd
 from pathlib import Path
 
+from core.backup_manager import BACKUP_ROOT_DIR
+
 # global dependencies
 GLOBAL_DEPS = ["git", "wget", "curl", "unzip", "dfu-util", "python3-virtualenv"]
 
@@ -22,6 +24,7 @@ CURRENT_USER = pwd.getpwuid(os.getuid())[0]
 
 # dirs
 SYSTEMD = Path("/etc/systemd/system")
+PRINTER_DATA_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("printer-data-backups")
 NGINX_SITES_AVAILABLE = Path("/etc/nginx/sites-available")
 NGINX_SITES_ENABLED = Path("/etc/nginx/sites-enabled")
 NGINX_CONFD = Path("/etc/nginx/conf.d")

kiauh/core/instance_manager/base_instance.py

@@ -16,9 +16,8 @@ from typing import List
 
 from utils.fs_utils import get_data_dir
 
-# 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"]
+SUFFIX_BLACKLIST: List[str] = ["None", "mcu", "obico", "bambu", "companion"]
+
 
 @dataclass(repr=True)
 class BaseInstance:

kiauh/core/menus/backup_menu.py

@@ -25,8 +25,8 @@ from components.webui_client.fluidd_data import FluiddData
 from components.webui_client.mainsail_data import MainsailData
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
-from core.services.backup_service import BackupService
 from core.types.color import Color
+from utils.common import backup_printer_config_dir
 
 
 # noinspection PyUnusedLocal
@@ -86,7 +86,7 @@ class BackupMenu(BaseMenu):
         backup_moonraker_dir()
 
     def backup_printer_config(self, **kwargs) -> None:
-        BackupService().backup_printer_config_dir()
+        backup_printer_config_dir()
 
     def backup_moonraker_db(self, **kwargs) -> None:
         backup_moonraker_db_dir()

kiauh/core/services/backup_service.py

@@ -1,189 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-from __future__ import annotations
-
-import shutil
-from datetime import datetime
-from pathlib import Path
-from typing import List, Optional
-
-from components.klipper.klipper import Klipper
-from components.moonraker.moonraker import Moonraker
-from core.logger import Logger
-from utils.instance_utils import get_instances
-
-
-class BackupService:
-    def __init__(self):
-        self._backup_root = Path.home().joinpath("kiauh_backups")
-
-    @property
-    def backup_root(self) -> Path:
-        return self._backup_root
-
-    @property
-    def timestamp(self) -> str:
-        return datetime.now().strftime("%Y%m%d-%H%M%S")
-
-    ################################################
-    # GENERIC BACKUP METHODS
-    ################################################
-
-    def backup_file(
-        self,
-        source_path: Path,
-        target_path: Optional[Path | str] = None,
-        target_name: Optional[str] = None,
-    ) -> bool:
-        source_path = Path(source_path)
-
-        Logger.print_status(f"Creating backup of {source_path} ...")
-
-        if not source_path.exists():
-            Logger.print_info(
-                f"File '{source_path}' does not exist! Skipping backup..."
-            )
-            return False
-
-        if not source_path.is_file():
-            Logger.print_info(f"'{source_path}' is not a file! Skipping backup...")
-            return False
-
-        try:
-            self._backup_root.mkdir(parents=True, exist_ok=True)
-
-            filename = (
-                target_name
-                or f"{source_path.stem}_{self.timestamp}{source_path.suffix}"
-            )
-            if target_path is not None:
-                backup_path = self._backup_root.joinpath(target_path, filename)
-            else:
-                backup_path = self._backup_root.joinpath(filename)
-
-            backup_path.mkdir(parents=True, exist_ok=True)
-            shutil.copy2(source_path, backup_path)
-
-            Logger.print_ok(
-                f"Successfully backed up '{source_path}' to '{backup_path}'"
-            )
-            return True
-
-        except Exception as e:
-            Logger.print_error(f"Failed to backup '{source_path}': {e}")
-            return False
-
-    def backup_directory(
-        self,
-        source_path: Path,
-        backup_name: str,
-        target_path: Optional[Path | str] = None,
-    ) -> Optional[Path]:
-        source_path = Path(source_path)
-
-        Logger.print_status(f"Creating backup of {source_path} ...")
-
-        if not source_path.exists():
-            Logger.print_info(
-                f"Directory '{source_path}' does not exist! Skipping backup..."
-            )
-            return None
-
-        if not source_path.is_dir():
-            Logger.print_info(f"'{source_path}' is not a directory! Skipping backup...")
-            return None
-
-        try:
-            self._backup_root.mkdir(parents=True, exist_ok=True)
-
-            backup_dir_name = f"{backup_name}_{self.timestamp}"
-
-            if target_path is not None:
-                backup_path = self._backup_root.joinpath(target_path, backup_dir_name)
-            else:
-                backup_path = self._backup_root.joinpath(backup_dir_name)
-
-            shutil.copytree(source_path, backup_path)
-
-            Logger.print_ok(
-                f"Successfully backed up '{source_path}' to '{backup_path}'"
-            )
-            return backup_path
-
-        except Exception as e:
-            Logger.print_error(f"Failed to backup directory '{source_path}': {e}")
-            return None
-
-    ################################################
-    # SPECIFIC BACKUP METHODS
-    ################################################
-
-    def backup_printer_cfg(self):
-        klipper_instances: List[Klipper] = get_instances(Klipper)
-        for instance in klipper_instances:
-            target_path: Path = self._backup_root.joinpath(
-                instance.data_dir.name, f"config_{self.timestamp}"
-            )
-            self.backup_file(
-                source_path=instance.cfg_file,
-                target_path=target_path,
-                target_name=instance.cfg_file.name,
-            )
-
-    def backup_moonraker_conf(self):
-        moonraker_instances: List[Moonraker] = get_instances(Moonraker)
-        for instance in moonraker_instances:
-            target_path: Path = self._backup_root.joinpath(
-                instance.data_dir.name, f"config_{self.timestamp}"
-            )
-            self.backup_file(
-                source_path=instance.cfg_file,
-                target_path=target_path,
-                target_name=instance.cfg_file.name,
-            )
-
-    def backup_printer_config_dir(self) -> None:
-        instances: List[Klipper] = get_instances(Klipper)
-        if not instances:
-            # fallback: search for printer data directories in the user's home directory
-            Logger.print_info("No Klipper instances found via systemd services.")
-            Logger.print_info(
-                "Attempting to find printer data directories in home directory..."
-            )
-
-            home_dir = Path.home()
-            printer_data_dirs = []
-
-            for pattern in ["printer_data", "printer_*_data"]:
-                for data_dir in home_dir.glob(pattern):
-                    if data_dir.is_dir():
-                        printer_data_dirs.append(data_dir)
-
-            if not printer_data_dirs:
-                Logger.print_info("Unable to find directory to backup!")
-                Logger.print_info(
-                    "No printer data directories found in home directory."
-                )
-                return
-
-            for data_dir in printer_data_dirs:
-                self.backup_directory(
-                    source_path=data_dir.joinpath("config"),
-                    target_path=data_dir.name,
-                    backup_name="config",
-                )
-
-            return
-
-        for instance in instances:
-            self.backup_directory(
-                source_path=instance.base.cfg_dir,
-                target_path=f"{instance.data_dir.name}",
-                backup_name="config",
-            )

kiauh/core/settings/kiauh_settings.py

@@ -14,8 +14,8 @@ from typing import Any, Callable, List, TypeVar
 
 from components.klipper import KLIPPER_REPO_URL
 from components.moonraker import MOONRAKER_REPO_URL
+from core.backup_manager.backup_manager import BackupManager
 from core.logger import DialogType, Logger
-from core.services.backup_service import BackupService
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
@@ -374,8 +374,8 @@ class KiauhSettings:
             kill()
 
     def _migrate_repo_config(self) -> None:
-        svc = BackupService()
-        if not svc.backup_file(CUSTOM_CFG):
+        bm = BackupManager()
+        if not bm.backup_file(CUSTOM_CFG):
             Logger.print_dialog(
                 DialogType.ERROR,
                 [

kiauh/core/submodules/simple_config_parser/README.md

@@ -12,7 +12,6 @@ Specialized for handling Klipper style config files.
 - Option Block: A line starting with a word, followed by a `:` or `=` and a newline
 - Comment: A line starting with a `#` or `;`
 - Blank: A line containing only whitespace characters
-- SaveConfig: Klippers auto-generated SAVE_CONFIG section that can be found at the very end of the config file
 
 ---
 

kiauh/core/submodules/simple_config_parser/src/simple_config_parser/constants.py

@@ -49,9 +49,6 @@ LINE_COMMENT_RE = re.compile(r"^\s*[#;].*")
 #  - the line MUST contain only whitespace characters
 EMPTY_LINE_RE = re.compile(r"^\s*$")
 
-SAVE_CONFIG_START_RE = re.compile(r"^#\*# <-+ SAVE_CONFIG -+>$")
-SAVE_CONFIG_CONTENT_RE = re.compile(r"^#\*#.*$")
-
 BOOLEAN_STATES = {
     "1": True,
     "yes": True,

kiauh/core/submodules/simple_config_parser/src/simple_config_parser/simple_config_parser.py

@@ -18,7 +18,7 @@ from ..simple_config_parser.constants import (
     LINE_COMMENT_RE,
     OPTION_RE,
     OPTIONS_BLOCK_START_RE,
-    SECTION_RE, LineType, INDENT, SAVE_CONFIG_START_RE, SAVE_CONFIG_CONTENT_RE,
+    SECTION_RE, LineType, INDENT,
 )
 
 _UNSET = object()
@@ -61,34 +61,25 @@ class SimpleConfigParser:
 
     def __init__(self) -> None:
         self.header: List[str] = []
-        self.save_config_block: List[str] = []
         self.config: Dict = {}
         self.current_section: str | None = None
         self.current_opt_block: str | None = None
         self.in_option_block: bool = False
 
     def _match_section(self, line: str) -> bool:
-        """Whether the given line matches the definition of a section"""
+        """Wheter or not the given line matches the definition of a section"""
         return SECTION_RE.match(line) is not None
 
     def _match_option(self, line: str) -> bool:
-        """Whether the given line matches the definition of an option"""
+        """Wheter or not the given line matches the definition of an option"""
         return OPTION_RE.match(line) is not None
 
     def _match_options_block_start(self, line: str) -> bool:
-        """Whether the given line matches the definition of a multiline option"""
+        """Wheter or not the given line matches the definition of a multiline option"""
         return OPTIONS_BLOCK_START_RE.match(line) is not None
 
-    def _match_save_config_start(self, line: str) -> bool:
-        """Whether the given line matches the definition of a save config start"""
-        return SAVE_CONFIG_START_RE.match(line) is not None
-
-    def _match_save_config_content(self, line: str) -> bool:
-        """Whether the given line matches the definition of a save config content"""
-        return SAVE_CONFIG_CONTENT_RE.match(line) is not None
-
     def _match_line_comment(self, line: str) -> bool:
-        """Whether the given line matches the definition of a comment"""
+        """Wheter or not the given line matches the definition of a comment"""
         return LINE_COMMENT_RE.match(line) is not None
 
     def _match_empty_line(self, line: str) -> bool:
@@ -133,14 +124,6 @@ class SimpleConfigParser:
                     element["value"].append(line.strip()) # indentation is removed
                     break
 
-        elif self._match_save_config_start(line):
-            self.current_opt_block = None
-            self.save_config_block.append(line)
-
-        elif self._match_save_config_content(line):
-            self.current_opt_block = None
-            self.save_config_block.append(line)
-
         elif self._match_empty_line(line) or self._match_line_comment(line):
             self.current_opt_block = None
 
@@ -202,11 +185,6 @@ class SimpleConfigParser:
                     if not last_line.endswith("\n"):
                         f.write("\n")
 
-            if self.save_config_block:
-                for line in self.save_config_block:
-                    f.write(line)
-                f.write("\n")
-
     def get_sections(self) -> List[str]:
         """Return a list of all section names, but exclude any section starting with '#_'"""
         return list(

kiauh/core/submodules/simple_config_parser/tests/assets/test_config_4.cfg

@@ -1,116 +0,0 @@
-# a comment at the very top
-# should be treated as the file header
-
-# up to the first section, including all blank lines
-
-[section_1]
-option_1: value_1
-option_1_1: True # this is a boolean
-option_1_2: 5 ; this is an integer
-option_1_3: 1.123 #;this is a float
-
-[section_2] ; comment
-option_2: value_2
-
-; comment
-
-[section_3]
-option_3: value_3 # comment
-
-[section_4]
-# comment
-option_4: value_4
-
-[section number 5]
-#option_5: value_5
-option_5 = this.is.value-5
-multi_option:
-    # these are multi-line values
-    value_5_1
-    value_5_2 ; here is a comment
-    value_5_3
-option_5_1: value_5_1
-
-[gcode_macro M117]
-rename_existing: M117.1
-gcode:
-    {% if rawparams %}
-       {% set escaped_msg = rawparams.split(';', 1)[0].split('\x23', 1)[0]|replace('"', '\\"') %}
-       SET_DISPLAY_TEXT MSG="{escaped_msg}"
-       RESPOND TYPE=command MSG="{escaped_msg}"
-    {% else %}
-        SET_DISPLAY_TEXT
-    {% endif %}
-
-# SDCard 'looping' (aka Marlin M808 commands) support
-#
-# Support SDCard looping
-[sdcard_loop]
-[gcode_macro M486]
-gcode:
-    # Parameters known to M486 are as follows:
-    #   [C<flag>] Cancel the current object
-    #   [P<index>] Cancel the object with the given index
-    #   [S<index>] Set the index of the current object.
-    #       If the object with the given index has been canceled, this will cause
-    #       the firmware to skip to the next object. The value -1 is used to
-    #       indicate something that isn’t an object and shouldn’t be skipped.
-    #   [T<count>] Reset the state and set the number of objects
-    #   [U<index>] Un-cancel the object with the given index. This command will be
-    #       ignored if the object has already been skipped
-
-    {% if 'exclude_object' not in printer %}
-        {action_raise_error("[exclude_object] is not enabled")}
-    {% endif %}
-
-    {% if 'T' in params %}
-        EXCLUDE_OBJECT RESET=1
-
-      {% for i in range(params.T | int) %}
-        EXCLUDE_OBJECT_DEFINE NAME={i}
-      {% endfor %}
-    {% endif %}
-
-    {% if 'C' in params %}
-      EXCLUDE_OBJECT CURRENT=1
-    {% endif %}
-
-    {% if 'P' in params %}
-      EXCLUDE_OBJECT NAME={params.P}
-    {% endif %}
-
-    {% if 'S' in params %}
-        {% if params.S == '-1' %}
-            {% if printer.exclude_object.current_object %}
-                EXCLUDE_OBJECT_END NAME={printer.exclude_object.current_object}
-            {% endif %}
-        {% else %}
-            EXCLUDE_OBJECT_START NAME={params.S}
-        {% endif %}
-    {% endif %}
-
-    {% if 'U' in params %}
-        EXCLUDE_OBJECT RESET=1 NAME={params.U}
-    {% endif %}
-
-#*# <---------------------- SAVE_CONFIG ---------------------->
-#*# DO NOT EDIT THIS BLOCK OR BELOW. The contents are auto-generated.
-#*#
-#*# [bed_mesh default]
-#*# version = 1
-#*# points =
-#*# 	  -0.152500, -0.133125, -0.113125, -0.159375, -0.232500
-#*# 	  -0.095000, -0.078750, -0.068125, -0.133125, -0.235000
-#*# 	  -0.092500, -0.040625, 0.004375, -0.077500, -0.193125
-#*# 	  -0.073750, 0.023750, 0.085625, 0.026875, -0.085000
-#*# 	  -0.140625, 0.038125, 0.126250, 0.097500, 0.003750
-#*# tension = 0.2
-#*# min_x = 26.0
-#*# algo = bicubic
-#*# y_count = 5
-#*# mesh_y_pps = 2
-#*# min_y = 5.0
-#*# x_count = 5
-#*# max_y = 174.0
-#*# mesh_x_pps = 2
-#*# max_x = 194.0

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_save_config_content/test_data/matching_data.txt

@@ -1,22 +0,0 @@
-#*# any content
-#*#
-#*# DO NOT EDIT THIS BLOCK OR BELOW. The contents are auto-generated.
-#*#
-#*# [bed_mesh default]
-#*# version = 1
-#*# points =
-#*# 	  -0.152500, -0.133125, -0.113125, -0.159375, -0.232500
-#*# 	  -0.095000, -0.078750, -0.068125, -0.133125, -0.235000
-#*# 	  -0.092500, -0.040625, 0.004375, -0.077500, -0.193125
-#*# 	  -0.073750, 0.023750, 0.085625, 0.026875, -0.085000
-#*# 	  -0.140625, 0.038125, 0.126250, 0.097500, 0.003750
-#*# tension = 0.2
-#*# min_x = 26.0
-#*# algo = bicubic
-#*# y_count = 5
-#*# mesh_y_pps = 2
-#*# min_y = 5.0
-#*# x_count = 5
-#*# max_y = 174.0
-#*# mesh_x_pps = 2
-#*# max_x = 194.0

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_save_config_content/test_data/non_matching_data.txt

@@ -1,6 +0,0 @@
- #*# leading space prevents match
-random
-*# not starting with hash-star-hash
-#   *# spaced out
-<- SAVE_CONFIG ->
-;#*# semicolon first

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_save_config_content/test_match_save_config_content.py

@@ -1,37 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2024 Dominik Willner <th33xitus@gmail.com>               #
-#                                                                         #
-#  https://github.com/dw-0/simple-config-parser                           #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-from pathlib import Path
-
-import pytest
-
-from src.simple_config_parser.simple_config_parser import SimpleConfigParser
-from tests.utils import load_testdata_from_file
-
-BASE_DIR = Path(__file__).parent.joinpath("test_data")
-MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
-NON_MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("non_matching_data.txt")
-
-
-@pytest.fixture
-def parser():
-    return SimpleConfigParser()
-
-
-def test_matching_lines(parser):
-    """Alle Zeilen in matching_data.txt sollen als Save-Config-Content erkannt werden."""
-    matching_lines = load_testdata_from_file(MATCHING_TEST_DATA_PATH)
-    for line in matching_lines:
-        assert parser._match_save_config_content(line) is True, f"Line should be a save config content: {line!r}"
-
-
-def test_non_matching_lines(parser):
-    """Alle Zeilen in non_matching_data.txt sollen NICHT als Save-Config-Content erkannt werden."""
-    non_matching_lines = load_testdata_from_file(NON_MATCHING_TEST_DATA_PATH)
-    for line in non_matching_lines:
-        assert parser._match_save_config_content(line) is False, f"Line should not be a save config content: {line!r}"

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_save_config_start/test_data/matching_data.txt

@@ -1,6 +0,0 @@
-#*# <- SAVE_CONFIG ->
-#*# <---- SAVE_CONFIG ---->
-#*# <------------------- SAVE_CONFIG ------------------->
-#*# <---------------------- SAVE_CONFIG ---------------------->
-#*# <----- SAVE_CONFIG ->
-#*# <- SAVE_CONFIG ----------------->

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_save_config_start/test_data/non_matching_data.txt

@@ -1,13 +0,0 @@
-#*#<- SAVE_CONFIG ->
-#*# <-SAVE_CONFIG ->
-#*# <- SAVE_CONFIG->
-#*# <- SAVE_CONFIG -> extra
-#*# SAVE_CONFIG ---->
-#*# < SAVE_CONFIG >
-# *# <- SAVE_CONFIG ->
-<- SAVE_CONFIG ->
-random text
- #*# <---------------------- SAVE_CONFIG ---------------------->
-#*# <---------------------- SAVE_CONFIG ----------------------> #*#
-#*# <-------------------------------------------->
-#*# SAVE_CONFIG

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_save_config_start/test_match_save_config_start.py

@@ -1,37 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2024 Dominik Willner <th33xitus@gmail.com>               #
-#                                                                         #
-#  https://github.com/dw-0/simple-config-parser                           #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-from pathlib import Path
-
-import pytest
-
-from src.simple_config_parser.simple_config_parser import SimpleConfigParser
-from tests.utils import load_testdata_from_file
-
-BASE_DIR = Path(__file__).parent.joinpath("test_data")
-MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
-NON_MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("non_matching_data.txt")
-
-
-@pytest.fixture
-def parser():
-    return SimpleConfigParser()
-
-
-def test_matching_lines(parser):
-    """Test that all lines in the matching data file are correctly identified as save config start lines."""
-    matching_lines = load_testdata_from_file(MATCHING_TEST_DATA_PATH)
-    for line in matching_lines:
-        assert parser._match_save_config_start(line) is True, f"Line should be a save config start: {line!r}"
-
-
-def test_non_matching_lines(parser):
-    """Test that all lines in the non-matching data file are correctly identified as not save config start lines."""
-    non_matching_lines = load_testdata_from_file(NON_MATCHING_TEST_DATA_PATH)
-    for line in non_matching_lines:
-        assert parser._match_save_config_start(line) is False, f"Line should not be a save config start: {line!r}"

kiauh/core/submodules/simple_config_parser/tests/public_api/conftest.py

@@ -13,7 +13,7 @@ from src.simple_config_parser.simple_config_parser import SimpleConfigParser
 from tests.utils import load_testdata_from_file
 
 BASE_DIR = Path(__file__).parent.parent.joinpath("assets")
-CONFIG_FILES = ["test_config_1.cfg", "test_config_2.cfg", "test_config_3.cfg", "test_config_4.cfg"]
+CONFIG_FILES = ["test_config_1.cfg", "test_config_2.cfg", "test_config_3.cfg"]
 
 
 @pytest.fixture(params=CONFIG_FILES)

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}")
+                links_lines.append(f"- Website: {website}")
             if repo:
-                links_lines.append(f"● {repo}")
+                links_lines.append(f"- GitHub: {repo}")
 
             links_text = Logger.format_content(
                 links_lines,

kiauh/extensions/gcode_shell_cmd/gcode_shell_cmd_extension.py

@@ -9,13 +9,12 @@
 
 import os
 import shutil
-from datetime import datetime
 from typing import List
 
 from components.klipper.klipper import Klipper
+from core.backup_manager.backup_manager import BackupManager
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import Logger
-from core.services.backup_service import BackupService
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
@@ -110,13 +109,11 @@ class GcodeShellCmdExtension(BaseExtension):
                 Logger.warn(f"Unable to create example config: {e}")
 
         # backup each printer.cfg before modification
-        svc = BackupService()
-        timestamp = datetime.now().strftime("%Y%m%d-%H%M%S")
+        bm = BackupManager()
         for instance in instances:
-            svc.backup_file(
-                source_path=instance.cfg_file,
-                target_path=f"{instance.data_dir.name}/config_{timestamp}",
-                target_name=instance.cfg_file.name,
+            bm.backup_file(
+                instance.cfg_file,
+                custom_filename=f"{instance.suffix}.printer.cfg",
             )
 
         # add section to printer.cfg if not already defined

kiauh/extensions/gcode_shell_cmd/metadata.json

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

kiauh/extensions/klipper_backup/metadata.json

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

kiauh/extensions/mobileraker/__init__.py

@@ -9,6 +9,7 @@
 
 from pathlib import Path
 
+from core.backup_manager import BACKUP_ROOT_DIR
 from core.constants import SYSTEMD
 
 # repo
@@ -22,6 +23,7 @@ MOBILERAKER_LOG_NAME = "mobileraker.log"
 # directories
 MOBILERAKER_DIR = Path.home().joinpath("mobileraker_companion")
 MOBILERAKER_ENV_DIR = Path.home().joinpath("mobileraker-env")
+MOBILERAKER_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("mobileraker-backups")
 
 # files
 MOBILERAKER_INSTALL_SCRIPT = MOBILERAKER_DIR.joinpath("scripts/install.sh")

kiauh/extensions/mobileraker/metadata.json

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

kiauh/extensions/mobileraker/mobileraker_extension.py

@@ -13,12 +13,13 @@ from typing import List
 
 from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
+from core.backup_manager.backup_manager import BackupManager
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import DialogType, Logger
-from core.services.backup_service import BackupService
 from core.settings.kiauh_settings import KiauhSettings
 from extensions.base_extension import BaseExtension
 from extensions.mobileraker import (
+    MOBILERAKER_BACKUP_DIR,
     MOBILERAKER_DIR,
     MOBILERAKER_ENV_DIR,
     MOBILERAKER_INSTALL_SCRIPT,
@@ -151,7 +152,6 @@ class MobilerakerExtension(BaseExtension):
                 Logger.print_status(
                     "Removing Mobileraker's companion from update manager ..."
                 )
-                BackupService().backup_moonraker_conf()
                 remove_config_section(MOBILERAKER_UPDATER_SECTION_NAME, mr_instances)
                 Logger.print_ok(
                     "Mobileraker's companion successfully removed from update manager!"
@@ -163,7 +163,6 @@ class MobilerakerExtension(BaseExtension):
             Logger.print_error(f"Error removing Mobileraker's companion:\n{e}")
 
     def _patch_mobileraker_update_manager(self, instances: List[Moonraker]) -> None:
-        BackupService().backup_moonraker_conf()
         add_config_section(
             section=MOBILERAKER_UPDATER_SECTION_NAME,
             instances=instances,
@@ -180,14 +179,14 @@ class MobilerakerExtension(BaseExtension):
         )
 
     def _backup_mobileraker_dir(self) -> None:
-        svc = BackupService()
-        svc.backup_directory(
-            source_path=MOBILERAKER_DIR,
-            backup_name="mobileraker",
-            target_path="mobileraker",
+        bm = BackupManager()
+        bm.backup_directory(
+            MOBILERAKER_DIR.name,
+            source=MOBILERAKER_DIR,
+            target=MOBILERAKER_BACKUP_DIR,
         )
-        svc.backup_directory(
-            source_path=MOBILERAKER_ENV_DIR,
-            backup_name="mobileraker-env",
-            target_path="mobileraker",
+        bm.backup_directory(
+            MOBILERAKER_ENV_DIR.name,
+            source=MOBILERAKER_ENV_DIR,
+            target=MOBILERAKER_BACKUP_DIR,
         )

kiauh/extensions/obico/metadata.json

@@ -11,8 +11,6 @@
         "- 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/obico/moonraker_obico_extension.py

@@ -14,7 +14,6 @@ from components.moonraker.moonraker import Moonraker
 from core.instance_manager.base_instance import SUFFIX_BLACKLIST
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import DialogType, Logger
-from core.services.backup_service import BackupService
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
@@ -32,10 +31,7 @@ from extensions.obico import (
 from extensions.obico.moonraker_obico import (
     MoonrakerObico,
 )
-from utils.common import (
-    check_install_dependencies,
-    moonraker_exists,
-)
+from utils.common import check_install_dependencies, moonraker_exists
 from utils.config_utils import (
     add_config_section,
     remove_config_section,
@@ -123,8 +119,6 @@ class ObicoExtension(BaseExtension):
 
             cmd_sysctl_manage("daemon-reload")
 
-            BackupService().backup_printer_config_dir()
-
             # add to klippers config
             self._patch_printer_cfg(kl_instances)
             InstanceManager.restart_all(kl_instances)
@@ -171,7 +165,6 @@ class ObicoExtension(BaseExtension):
             self._remove_obico_instances(ob_instances)
             self._remove_obico_dir()
             self._remove_obico_env()
-            BackupService().backup_printer_config_dir()
             remove_config_section(f"include {OBICO_MACROS_CFG_NAME}", kl_instances)
             remove_config_section(f"include {OBICO_UPDATE_CFG_NAME}", mr_instances)
             Logger.print_dialog(

kiauh/extensions/octoapp/metadata.json

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

kiauh/extensions/octoapp/octoapp_extension.py

@@ -13,7 +13,6 @@ from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import DialogType, Logger
-from core.services.backup_service import BackupService
 from extensions.base_extension import BaseExtension
 from extensions.octoapp import (
     OA_DEPS_JSON_FILE,
@@ -134,7 +133,6 @@ class OctoappExtension(BaseExtension):
             self._remove_OA_store_dirs()
             self._remove_OA_dir()
             self._remove_OA_env()
-            BackupService().backup_moonraker_conf()
             remove_config_section(f"include {OA_SYS_CFG_NAME}", mr_instances)
             run_remove_routines(OA_INSTALLER_LOG_FILE)
             Logger.print_dialog(

kiauh/extensions/octoeverywhere/metadata.json

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

kiauh/extensions/octoeverywhere/octoeverywhere_extension.py

@@ -12,7 +12,6 @@ from typing import List
 from components.moonraker.moonraker import Moonraker
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import DialogType, Logger
-from core.services.backup_service import BackupService
 from extensions.base_extension import BaseExtension
 from extensions.octoeverywhere import (
     OE_DEPS_JSON_FILE,
@@ -134,7 +133,6 @@ class OctoeverywhereExtension(BaseExtension):
             self._remove_oe_instances(ob_instances)
             self._remove_oe_dir()
             self._remove_oe_env()
-            BackupService().backup_moonraker_conf()
             remove_config_section(f"include {OE_SYS_CFG_NAME}", mr_instances)
             run_remove_routines(OE_INSTALLER_LOG_FILE)
             Logger.print_dialog(

kiauh/extensions/pretty_gcode/metadata.json

@@ -5,7 +5,6 @@
     "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

@@ -8,9 +8,6 @@
             "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/simply_print/simply_print_extension.py

@@ -11,12 +11,11 @@ from typing import List
 from components.moonraker.moonraker import Moonraker
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import DialogType, Logger
-from core.services.backup_service import BackupService
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
 from extensions.base_extension import BaseExtension
-from utils.common import moonraker_exists
+from utils.common import backup_printer_config_dir, moonraker_exists
 from utils.input_utils import get_confirm
 
 
@@ -113,10 +112,10 @@ class SimplyPrintExtension(BaseExtension):
                 continue
 
             if is_install and not scp.has_section("simplyprint"):
-                BackupService().backup_printer_config_dir()
+                backup_printer_config_dir()
                 scp.add_section(section)
             elif not is_install and scp.has_section("simplyprint"):
-                BackupService().backup_printer_config_dir()
+                backup_printer_config_dir()
                 scp.remove_section(section)
             scp.write_file(moonraker.cfg_file)
             patched_files.append(moonraker.cfg_file)

kiauh/extensions/spoolman/metadata.json

@@ -13,7 +13,6 @@
       "\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/spoolman/spoolman_extension.py

@@ -15,9 +15,9 @@ from components.moonraker.moonraker import Moonraker
 from components.moonraker.services.moonraker_instance_service import (
     MoonrakerInstanceService,
 )
+from core.backup_manager.backup_manager import BackupManager
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import DialogType, Logger
-from core.services.backup_service import BackupService
 from extensions.base_extension import BaseExtension
 from extensions.spoolman import (
     SPOOLMAN_COMPOSE_FILE,
@@ -100,7 +100,6 @@ class SpoolmanExtension(BaseExtension):
         mr_instances: List[Moonraker] = mrsvc.get_all_instances()
 
         Logger.print_status("Removing Spoolman configuration from moonraker.conf...")
-        BackupService().backup_moonraker_conf()
         remove_config_section("spoolman", mr_instances)
 
         Logger.print_status("Removing Spoolman from moonraker.asvc...")
@@ -124,15 +123,16 @@ class SpoolmanExtension(BaseExtension):
                     "Failed to remove Spoolman image! Please remove it manually."
                 )
 
+        # backup Spoolman directory to ~/spoolman_data-<timestamp> before removing it
         try:
-            svc = BackupService()
-            success = svc.backup_directory(
-                source_path=SPOOLMAN_DIR,
-                backup_name="spoolman",
-                target_path="spoolman",
+            bm = BackupManager()
+            result = bm.backup_directory(
+                f"{SPOOLMAN_DIR.name}_data",
+                source=SPOOLMAN_DIR,
+                target=SPOOLMAN_DIR.parent,
             )
-            if success:
-                Logger.print_ok(f"Spoolman data backed up to {success}")
+            if result:
+                Logger.print_ok(f"Spoolman data backed up to {result}")
                 Logger.print_status("Removing Spoolman directory...")
                 if run_remove_routines(SPOOLMAN_DIR):
                     Logger.print_ok("Spoolman directory removed!")
@@ -290,7 +290,6 @@ class SpoolmanExtension(BaseExtension):
         mrsvc.load_instances()
         mr_instances = mrsvc.get_all_instances()
 
-        BackupService().backup_moonraker_conf()
         # noinspection HttpUrlsUsage
         add_config_section(
             section="spoolman",

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."],
-    "repo": "https://github.com/nlef/moonraker-telegram-bot",
+    "project_url": "https://github.com/nlef/moonraker-telegram-bot",
     "updates": true
   }
 }

kiauh/extensions/telegram_bot/moonraker_telegram_bot_extension.py

@@ -13,7 +13,6 @@ from typing import List
 from components.moonraker.moonraker import Moonraker
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import DialogType, Logger
-from core.services.backup_service import BackupService
 from extensions.base_extension import BaseExtension
 from extensions.telegram_bot import TG_BOT_REPO, TG_BOT_REQ_FILE
 from extensions.telegram_bot.moonraker_telegram_bot import (
@@ -106,7 +105,6 @@ class TelegramBotExtension(BaseExtension):
             cmd_sysctl_manage("daemon-reload")
 
             # add to moonraker update manager
-            BackupService().backup_moonraker_conf()
             self._patch_bot_update_manager(mr_instances)
 
             # restart moonraker
@@ -152,7 +150,6 @@ class TelegramBotExtension(BaseExtension):
             self._remove_bot_instances(tb_instances)
             self._remove_bot_dir()
             self._remove_bot_env()
-            BackupService().backup_moonraker_conf()
             remove_config_section("update_manager moonraker-telegram-bot", mr_instances)
             self._delete_bot_logs(tb_instances)
         except Exception as e:

kiauh/main.py

@@ -27,7 +27,3 @@ def main() -> None:
         MainMenu().run()
     except KeyboardInterrupt:
         Logger.print_ok("\nHappy printing!\n", prefix=False)
-
-
-if __name__ == "__main__":
-    main()

kiauh/procedures/switch_repo.py

@@ -13,6 +13,7 @@ from pathlib import Path
 from typing import Literal
 
 from components.klipper import (
+    KLIPPER_BACKUP_DIR,
     KLIPPER_DIR,
     KLIPPER_ENV_DIR,
     KLIPPER_REQ_FILE,
@@ -20,6 +21,7 @@ from components.klipper import (
 from components.klipper.klipper import Klipper
 from components.klipper.klipper_utils import install_klipper_packages
 from components.moonraker import (
+    MOONRAKER_BACKUP_DIR,
     MOONRAKER_DIR,
     MOONRAKER_ENV_DIR,
     MOONRAKER_REQ_FILE,
@@ -28,10 +30,10 @@ from components.moonraker.moonraker import Moonraker
 from components.moonraker.services.moonraker_setup_service import (
     install_moonraker_packages,
 )
+from core.backup_manager.backup_manager import BackupManager, BackupManagerException
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import Logger
-from core.services.backup_service import BackupService
-from utils.git_utils import GitException, git_clone_wrapper
+from utils.git_utils import GitException, get_repo_name, git_clone_wrapper
 from utils.instance_utils import get_instances
 from utils.sys_utils import (
     VenvCreationFailedException,
@@ -50,6 +52,7 @@ def run_switch_repo_routine(
     repo_dir: Path = KLIPPER_DIR if name == "klipper" else MOONRAKER_DIR
     env_dir: Path = KLIPPER_ENV_DIR if name == "klipper" else MOONRAKER_ENV_DIR
     req_file = KLIPPER_REQ_FILE if name == "klipper" else MOONRAKER_REQ_FILE
+    backup_dir: Path = KLIPPER_BACKUP_DIR if name == "klipper" else MOONRAKER_BACKUP_DIR
     _type = Klipper if name == "klipper" else Moonraker
 
     # step 1: stop all instances
@@ -61,17 +64,19 @@ def run_switch_repo_routine(
     env_dir_backup_path: Path | None = None
 
     try:
-        svc = BackupService()
-        svc.backup_directory(
-            source_path=repo_dir,
-            backup_name=name,
-            target_path=name,
+        # step 2: backup old repo and env
+        org, _ = get_repo_name(repo_dir)
+        backup_dir = backup_dir.joinpath(org)
+        bm = BackupManager()
+        repo_dir_backup_path = bm.backup_directory(
+            repo_dir.name,
+            repo_dir,
+            backup_dir,
         )
-        env_backup_name: str = f"{name if name == 'moonraker' else 'klippy'}-env"
-        svc.backup_directory(
-            source_path=env_dir,
-            backup_name=env_backup_name,
-            target_path=name,
+        env_dir_backup_path = bm.backup_directory(
+            env_dir.name,
+            env_dir,
+            backup_dir,
         )
 
         if not (repo_url or branch):
@@ -96,6 +101,10 @@ def run_switch_repo_routine(
 
         Logger.print_ok(f"Switched to {repo_url} at branch {branch}!")
 
+    except BackupManagerException as e:
+        Logger.print_error(f"Error during backup of repository: {e}")
+        raise RepoSwitchFailedException(e)
+
     except (GitException, VenvCreationFailedException) as e:
         # if something goes wrong during cloning or recreating the virtualenv,
         # we restore the backup of the repo and env
@@ -113,9 +122,6 @@ def run_switch_repo_routine(
         Logger.print_error(f"Something went wrong: {e}")
         return
 
-    except Exception as e:
-        raise RepoSwitchFailedException(e)
-
     Logger.print_status(f"Restarting all {_type.__name__} instances ...")
     InstanceManager.start_all(instances)
 

kiauh/utils/common.py

@@ -14,9 +14,11 @@ from datetime import datetime
 from pathlib import Path
 from typing import Dict, List, Literal, Set
 
+from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
 from core.constants import (
     GLOBAL_DEPS,
+    PRINTER_DATA_BACKUP_DIR,
 )
 from core.logger import DialogType, Logger
 from core.types.color import Color
@@ -149,6 +151,26 @@ def get_install_status(
     )
 
 
+def backup_printer_config_dir() -> None:
+    # local import to prevent circular import
+    from core.backup_manager.backup_manager import BackupManager
+
+    instances: List[Klipper] = get_instances(Klipper)
+    bm = BackupManager()
+
+    if not instances:
+        Logger.print_info("Unable to find directory to backup!")
+        Logger.print_info("Are there no Klipper instances installed?")
+        return
+
+    for instance in instances:
+        bm.backup_directory(
+            instance.data_dir.name,
+            source=instance.base.cfg_dir,
+            target=PRINTER_DATA_BACKUP_DIR,
+        )
+
+
 def moonraker_exists(name: str = "") -> List[Moonraker]:
     """
     Helper method to check if a Moonraker instance exists

kiauh/utils/config_utils.py

@@ -73,7 +73,7 @@ def add_config_section_at_top(section: str, instances: List[InstanceType]) -> No
             tmp.writelines(org_content)
 
         cfg_file.unlink()
-        shutil.move(tmp_cfg_path.as_posix(), cfg_file)
+        shutil.move(tmp_cfg_path, cfg_file)
 
         Logger.print_ok("OK!")
 
@@ -81,7 +81,7 @@ def add_config_section_at_top(section: str, instances: List[InstanceType]) -> No
 def remove_config_section(
     section: str, instances: List[InstanceType]
 ) -> List[InstanceType]:
-    removed_from: List[InstanceType] = []
+    removed_from: List[instances] = []
     for instance in instances:
         cfg_file = instance.cfg_file
         Logger.print_status(f"Remove section '[{section}]' from '{cfg_file}' ...")

mkdocs.yml

@@ -0,0 +1,84 @@
+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:
+      - setup/raspberry-pi-setup.md
+      - setup/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

pyproject.toml

@@ -2,7 +2,7 @@
 requires-python = ">=3.8"
 
 [project.optional-dependencies]
-dev=["ruff", "mypy"]
+dev=["ruff", "pyright"]
 
 [tool.ruff]
 required-version = ">=0.9.10"
@@ -20,14 +20,3 @@ quote-style = "double"
 
 [tool.ruff.lint]
 extend-select = ["I"]
-
-[tool.mypy]
-python_version = "3.8"
-platform = "linux"
-# strict = true # TODO: enable this once everything is else is handled
-check_untyped_defs = true
-ignore_missing_imports = true
-warn_redundant_casts = true
-warn_unused_ignores = true
-warn_return_any = true
-warn_unreachable = true

pyrightconfig.json

@@ -0,0 +1,6 @@
+{
+  "pythonVersion": "3.8",
+  "pythonPlatform": "Linux",
+  "typeCheckingMode": "standard",
+  "venvPath": "./.kiauh-env"
+}

requirements.txt

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

resources/autocommit.sh

@@ -0,0 +1,65 @@
+#!/usr/bin/env bash
+
+#####################################################################
+### Please set the paths accordingly. In case you don't have all  ###
+### the listed folders, just keep that line commented out.        ###
+#####################################################################
+### Path to your config folder you want to back up
+#config_folder=~/klipper_config
+
+### Path to your Klipper folder, by default that is '~/klipper'
+#klipper_folder=~/klipper
+
+### Path to your Moonraker folder, by default that is '~/moonraker'
+#moonraker_folder=~/moonraker
+
+### Path to your Mainsail folder, by default that is '~/mainsail'
+#mainsail_folder=~/mainsail
+
+### Path to your Fluidd folder, by default that is '~/fluidd'
+#fluidd_folder=~/fluidd
+
+#####################################################################
+#####################################################################
+
+
+#####################################################################
+################ !!! DO NOT EDIT BELOW THIS LINE !!! ################
+#####################################################################
+grab_version() {
+  local klipper_commit moonraker_commit
+  local mainsail_ver fluidd_ver
+
+  if [[ -n ${klipper_folder} ]]; then
+    cd "${klipper_folder}"
+    klipper_commit=$(git rev-parse --short=7 HEAD)
+    m1="Klipper on commit: ${klipper_commit}"
+  fi
+  if [[ -n ${moonraker_folder} ]]; then
+    cd "${moonraker_folder}"
+    moonraker_commit=$(git rev-parse --short=7 HEAD)
+    m2="Moonraker on commit: ${moonraker_commit}"
+  fi
+  if [[ -n ${mainsail_folder} ]]; then
+    mainsail_ver=$(head -n 1 "${mainsail_folder}/.version")
+    m3="Mainsail version: ${mainsail_ver}"
+  fi
+  if [[ -n ${fluidd_folder} ]]; then
+    fluidd_ver=$(head -n 1 "${fluidd_folder}/.version")
+    m4="Fluidd version: ${fluidd_ver}"
+  fi
+}
+
+push_config() {
+  local current_date
+  
+  cd "${config_folder}" || exit 1
+  git pull
+  git add .
+  current_date=$(date +"%Y-%m-%d %T")
+  git commit -m "Autocommit from ${current_date}" -m "${m1}" -m "${m2}" -m "${m3}" -m "${m4}"
+  git push
+}
+
+grab_version
+push_config

resources/common_vars.conf

@@ -0,0 +1,6 @@
+# /etc/nginx/conf.d/common_vars.conf
+
+map $http_upgrade $connection_upgrade {
+    default upgrade;
+    '' close;
+}

resources/example.printer.cfg

@@ -0,0 +1,11 @@
+[mcu]
+serial: /dev/serial/by-id/<your-mcu-id>
+
+[virtual_sdcard]
+path: %GCODES_DIR%
+on_error_gcode: CANCEL_PRINT
+
+[printer]
+kinematics: none
+max_velocity: 1000
+max_accel: 1000

resources/fluidd

@@ -0,0 +1,96 @@
+# /etc/nginx/sites-available/fluidd
+
+server {
+    listen 80;
+
+    access_log /var/log/nginx/fluidd-access.log;
+    error_log /var/log/nginx/fluidd-error.log;
+
+    # disable this section on smaller hardware like a pi zero
+    gzip on;
+    gzip_vary on;
+    gzip_proxied any;
+    gzip_proxied expired no-cache no-store private auth;
+    gzip_comp_level 4;
+    gzip_buffers 16 8k;
+    gzip_http_version 1.1;
+    gzip_types text/plain text/css text/xml text/javascript application/javascript application/x-javascript application/json application/xml;
+
+    # web_path from fluidd static files
+    root /home/pi/fluidd;
+
+    index index.html;
+    server_name _;
+
+    # disable max upload size checks
+    client_max_body_size 0;
+
+    # disable proxy request buffering
+    proxy_request_buffering off;
+
+    location / {
+        try_files $uri $uri/ /index.html;
+    }
+
+    location = /index.html {
+        add_header Cache-Control "no-store, no-cache, must-revalidate";
+    }
+
+    location /websocket {
+        proxy_pass http://apiserver/websocket;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection $connection_upgrade;
+        proxy_set_header Host $http_host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_read_timeout 86400;
+    }
+
+    location ~ ^/(printer|api|access|machine|server)/ {
+        proxy_pass http://apiserver$request_uri;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Host $http_host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Scheme $scheme;
+        proxy_read_timeout 600;
+    }
+
+    location /webcam/ {
+        postpone_output 0;
+        proxy_buffering off;
+        proxy_ignore_headers X-Accel-Buffering;
+        access_log off;
+        error_log off;
+        proxy_pass http://mjpgstreamer1/;
+    }
+
+    location /webcam2/ {
+        postpone_output 0;
+        proxy_buffering off;
+        proxy_ignore_headers X-Accel-Buffering;
+        access_log off;
+        error_log off;
+        proxy_pass http://mjpgstreamer2/;
+    }
+
+    location /webcam3/ {
+        postpone_output 0;
+        proxy_buffering off;
+        proxy_ignore_headers X-Accel-Buffering;
+        access_log off;
+        error_log off;
+        proxy_pass http://mjpgstreamer3/;
+    }
+
+    location /webcam4/ {
+        postpone_output 0;
+        proxy_buffering off;
+        proxy_ignore_headers X-Accel-Buffering;
+        access_log off;
+        error_log off;
+        proxy_pass http://mjpgstreamer4/;
+    }
+}

resources/gcode_shell_command.py

@@ -0,0 +1,94 @@
+# Run a shell command via gcode
+#
+# Copyright (C) 2019  Eric Callahan <arksine.code@gmail.com>
+#
+# This file may be distributed under the terms of the GNU GPLv3 license.
+import os
+import shlex
+import subprocess
+import logging
+
+
+class ShellCommand:
+    def __init__(self, config):
+        self.name = config.get_name().split()[-1]
+        self.printer = config.get_printer()
+        self.gcode = self.printer.lookup_object("gcode")
+        cmd = config.get("command")
+        cmd = os.path.expanduser(cmd)
+        self.command = shlex.split(cmd)
+        self.timeout = config.getfloat("timeout", 2.0, above=0.0)
+        self.verbose = config.getboolean("verbose", True)
+        self.proc_fd = None
+        self.partial_output = ""
+        self.gcode.register_mux_command(
+            "RUN_SHELL_COMMAND",
+            "CMD",
+            self.name,
+            self.cmd_RUN_SHELL_COMMAND,
+            desc=self.cmd_RUN_SHELL_COMMAND_help,
+        )
+
+    def _process_output(self, eventime):
+        if self.proc_fd is None:
+            return
+        try:
+            data = os.read(self.proc_fd, 4096)
+        except Exception:
+            pass
+        data = self.partial_output + data.decode()
+        if "\n" not in data:
+            self.partial_output = data
+            return
+        elif data[-1] != "\n":
+            split = data.rfind("\n") + 1
+            self.partial_output = data[split:]
+            data = data[:split]
+        else:
+            self.partial_output = ""
+        self.gcode.respond_info(data)
+
+    cmd_RUN_SHELL_COMMAND_help = "Run a linux shell command"
+
+    def cmd_RUN_SHELL_COMMAND(self, params):
+        gcode_params = params.get("PARAMS", "")
+        gcode_params = shlex.split(gcode_params)
+        reactor = self.printer.get_reactor()
+        try:
+            proc = subprocess.Popen(
+                self.command + gcode_params,
+                stdout=subprocess.PIPE,
+                stderr=subprocess.STDOUT,
+            )
+        except Exception:
+            logging.exception("shell_command: Command {%s} failed" % (self.name))
+            raise self.gcode.error("Error running command {%s}" % (self.name))
+        if self.verbose:
+            self.proc_fd = proc.stdout.fileno()
+            self.gcode.respond_info("Running Command {%s}...:" % (self.name))
+            hdl = reactor.register_fd(self.proc_fd, self._process_output)
+        eventtime = reactor.monotonic()
+        endtime = eventtime + self.timeout
+        complete = False
+        while eventtime < endtime:
+            eventtime = reactor.pause(eventtime + 0.05)
+            if proc.poll() is not None:
+                complete = True
+                break
+        if not complete:
+            proc.terminate()
+        if self.verbose:
+            if self.partial_output:
+                self.gcode.respond_info(self.partial_output)
+                self.partial_output = ""
+            if complete:
+                msg = "Command {%s} finished\n" % (self.name)
+            else:
+                msg = "Command {%s} timed out" % (self.name)
+            self.gcode.respond_info(msg)
+            reactor.unregister_fd(hdl)
+            self.proc_fd = None
+
+
+def load_config_prefix(config):
+    return ShellCommand(config)

resources/klipper.env

@@ -0,0 +1 @@
+KLIPPER_ARGS="%KLIPPER_DIR%/klippy/klippy.py %CFG% -I %PRINTER% -l %LOG% -a %UDS%"

resources/klipper.service

@@ -0,0 +1,18 @@
+[Unit]
+Description=Klipper 3D Printer Firmware SV1
+Documentation=https://www.klipper3d.org/
+After=network-online.target
+Wants=udev.target
+
+[Install]
+WantedBy=multi-user.target
+
+[Service]
+Type=simple
+User=%USER%
+RemainAfterExit=yes
+WorkingDirectory=%KLIPPER_DIR%
+EnvironmentFile=%ENV_FILE%
+ExecStart=%ENV%/bin/python $KLIPPER_ARGS
+Restart=always
+RestartSec=10

resources/mainsail

@@ -0,0 +1,96 @@
+# /etc/nginx/sites-available/mainsail
+
+server {
+    listen 80;
+
+    access_log /var/log/nginx/mainsail-access.log;
+    error_log /var/log/nginx/mainsail-error.log;
+
+    # disable this section on smaller hardware like a pi zero
+    gzip on;
+    gzip_vary on;
+    gzip_proxied any;
+    gzip_proxied expired no-cache no-store private auth;
+    gzip_comp_level 4;
+    gzip_buffers 16 8k;
+    gzip_http_version 1.1;
+    gzip_types text/plain text/css text/xml text/javascript application/javascript application/x-javascript application/json application/xml;
+
+    # web_path from mainsail static files
+    root /home/pi/mainsail;
+
+    index index.html;
+    server_name _;
+
+    # disable max upload size checks
+    client_max_body_size 0;
+
+    # disable proxy request buffering
+    proxy_request_buffering off;
+
+    location / {
+        try_files $uri $uri/ /index.html;
+    }
+
+    location = /index.html {
+        add_header Cache-Control "no-store, no-cache, must-revalidate";
+    }
+
+    location /websocket {
+        proxy_pass http://apiserver/websocket;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection $connection_upgrade;
+        proxy_set_header Host $http_host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_read_timeout 86400;
+    }
+
+    location ~ ^/(printer|api|access|machine|server)/ {
+        proxy_pass http://apiserver$request_uri;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Host $http_host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Scheme $scheme;
+        proxy_read_timeout 600;
+    }
+
+    location /webcam/ {
+        postpone_output 0;
+        proxy_buffering off;
+        proxy_ignore_headers X-Accel-Buffering;
+        access_log off;
+        error_log off;
+        proxy_pass http://mjpgstreamer1/;
+    }
+
+    location /webcam2/ {
+        postpone_output 0;
+        proxy_buffering off;
+        proxy_ignore_headers X-Accel-Buffering;
+        access_log off;
+        error_log off;
+        proxy_pass http://mjpgstreamer2/;
+    }
+
+    location /webcam3/ {
+        postpone_output 0;
+        proxy_buffering off;
+        proxy_ignore_headers X-Accel-Buffering;
+        access_log off;
+        error_log off;
+        proxy_pass http://mjpgstreamer3/;
+    }
+
+    location /webcam4/ {
+        postpone_output 0;
+        proxy_buffering off;
+        proxy_ignore_headers X-Accel-Buffering;
+        access_log off;
+        error_log off;
+        proxy_pass http://mjpgstreamer4/;
+    }
+}

resources/mjpg-streamer/webcam.txt

@@ -0,0 +1,79 @@
+### Windows users: To edit this file use Notepad++, VSCode, Atom or SublimeText.
+### Do not use Notepad or WordPad.
+
+### MacOSX users: If you use Textedit to edit this file make sure to use 
+### "plain text format" and "disable smart quotes" in "Textedit > Preferences"
+
+### Configure which camera to use
+#
+# Available options are:
+# - auto: tries first usb webcam, if that's not available tries raspi cam
+# - usb: only tries usb webcam
+# - raspi: only tries raspi cam
+#
+# Defaults to auto
+#
+#camera="auto"
+
+### Additional options to supply to MJPG Streamer for the USB camera
+#
+# See https://faq.octoprint.org/mjpg-streamer-config for available options
+#
+# Defaults to a resolution of 640x480 px and a framerate of 10 fps
+#
+#camera_usb_options="-r 640x480 -f 10"
+
+### Additional webcam devices known to cause problems with -f
+#
+# Apparently there a some devices out there that with the current 
+# mjpg_streamer release do not support the -f parameter (for specifying 
+# the capturing framerate) and will just refuse to output an image if it 
+# is supplied.
+#
+# The webcam daemon will detect those devices by their USB Vendor and Product
+# ID and remove the -f parameter from the options provided to mjpg_streamer.
+#
+# By default, this is done for the following devices:
+#   Logitech C170 (046d:082b)
+#   GEMBIRD (1908:2310)
+#   Genius F100 (0458:708c)
+#   Cubeternet GL-UPC822 UVC WebCam (1e4e:0102)
+#
+# Using the following option it is possible to add additional devices. If
+# your webcam happens to show above symptoms, try determining your cam's
+# vendor and product id via lsusb, activating the line below by removing # and 
+# adding it, e.g. for two broken cameras "aabb:ccdd" and "aabb:eeff"
+#
+#   additional_brokenfps_usb_devices=("aabb:ccdd" "aabb:eeff")
+#
+#
+#additional_brokenfps_usb_devices=()
+
+### Additional options to supply to MJPG Streamer for the RasPi Cam
+#
+# See https://faq.octoprint.org/mjpg-streamer-config for available options
+#
+# Defaults to 10fps
+#
+#camera_raspi_options="-fps 10"
+
+### Configuration of camera HTTP output
+#
+# Usually you should NOT need to change this at all! Only touch if you
+# know what you are doing and what the parameters mean.
+#
+# Below settings are used in the mjpg-streamer call like this:
+#
+#   -o "output_http.so -w $camera_http_webroot $camera_http_options"
+#
+# Current working directory is the mjpg-streamer base directory.
+#
+#camera_http_webroot="./www-mainsail"
+#camera_http_options="-n"
+
+### EXPERIMENTAL
+# Support for different streamer types.
+#
+# Available options:
+#   mjpeg [default] - stable MJPG-streamer
+#camera_streamer=mjpeg

resources/mjpg-streamer/webcamd

@@ -0,0 +1,303 @@
+#!/bin/bash
+
+########################################################################
+### DO NOT EDIT THIS FILE TO CHANGE THE CONFIG!!!                    ###
+### ---------------------------------------------------------------- ###
+### There is no need to edit this file for changing resolution,      ###
+### frame rates or any other mjpg-streamer parameters. Please edit   ###
+### /home/pi/klipper_config/webcam.txt instead - that's what it's    ###
+### there for! You can even do this with your Pi powered down by     ###
+### directly accessing the file when using the SD card as thumb      ###
+### drive in your regular computer.                                  ###
+########################################################################
+
+MJPGSTREAMER_HOME=/home/pi/mjpg-streamer
+MJPGSTREAMER_INPUT_USB="input_uvc.so"
+MJPGSTREAMER_INPUT_RASPICAM="input_raspicam.so"
+
+brokenfps_usb_devices=("046d:082b" "1908:2310" "0458:708c" "1e4e:0102" "0471:0311" "038f:6001" "046d:0804" "046d:0825" "046d:0994" "0ac8:3450")
+
+config_dir="/home/pi/klipper_config"
+
+echo "Starting up webcamDaemon..."
+echo ""
+
+cfg_files=()
+#cfg_files+=/boot/mainsail.txt
+if [[ -d ${config_dir} ]]; then
+  cfg_files+=( `ls ${config_dir}/webcam*.txt` )
+fi
+
+array_camera_config=()
+array_camera=()
+array_camera_usb_options=()
+array_camera_usb_device=()
+array_camera_raspi_options=()
+array_camera_http_webroot=()
+array_camera_http_options=()
+array_additional_brokenfps_usb_devices=()
+array_camera_device=()
+array_assigned_device=()
+
+echo "--- Configuration: ----------------------------"
+for cfg_file in ${cfg_files[@]}; do
+  # init configuration - DO NOT EDIT, USE /home/pi/klipper_config/webcam*.txt INSTEAD!
+  camera="auto"
+  camera_usb_options="-r 640x480 -f 10"
+  camera_raspi_options="-fps 10"
+  camera_http_webroot="./www-mjpgstreamer"
+  camera_http_options="-n"
+  additional_brokenfps_usb_devices=()
+
+  if [[ -e ${cfg_file} ]]; then
+      source "$cfg_file"
+  fi
+  usb_options="$camera_usb_options"
+
+  # if webcam device is explicitly given in /home/pi/klipper_config/webcam*.txt, save the path of the device
+  # to a variable and remove its parameter from usb_options
+  extracted_device=`echo $usb_options | sed 's@.*-d \(/dev/\(video[0-9]\+\|v4l/[^ ]*\)\).*@\1@'`
+  if [ "$extracted_device" != "$usb_options" ]
+  then
+    # the camera options refer to a device, save it in a variable
+    # replace video device parameter with empty string and strip extra whitespace
+    usb_options=`echo $usb_options | sed 's/\-d \/dev\/\(video[0-9]\+\|v4l\/[^ ]*\)//g' | awk '$1=$1'`
+  else
+    extracted_device=""
+  fi
+
+  # echo configuration
+  echo "cfg_file:      $cfg_file"
+  echo "camera:        $camera"
+  echo "usb options:   $camera_usb_options"
+  echo "raspi options: $camera_raspi_options"
+  echo "http options:  -w $camera_http_webroot $camera_http_options"
+  echo ""
+  echo "Explicitly USB device: $extracted_device"
+  echo "-----------------------------------------------"
+  echo ""
+
+  array_camera_config+=( $cfg_file )
+  array_camera+=( $camera )
+  array_camera_usb_options+=("$usb_options")
+  array_camera_usb_device+=("$extracted_device")
+  array_camera_raspi_options+=("$camera_raspi_options")
+  array_camera_http_webroot+=("$camera_http_webroot")
+  array_camera_http_options+=("$camera_http_options")
+  array_camera_brokenfps_usb_devices+=("${brokenfps_usb_devices[*]} ${additional_brokenfps_usb_devices[*]}")
+  array_camera_device+=("")
+done
+
+# check if array contains a string
+function containsString() {
+  local e match="$1"
+  shift
+  for e; do [[ "$e" == "$match" ]] && return 0; done
+  return 1
+}
+
+# cleans up when the script receives a SIGINT or SIGTERM
+function cleanup() {
+    # make sure that all child processed die when we die
+    local pids=$(jobs -pr)
+    [ -n "$pids" ] && kill $pids
+    exit 0
+}
+
+# says goodbye when the script shuts down
+function goodbye() {
+    # say goodbye
+    echo ""
+    echo "Goodbye..."
+    echo ""
+}
+
+# runs MJPG Streamer, using the provided input plugin + configuration
+function runMjpgStreamer {
+    input=$1
+
+    # There are problems with 0x000137ab firmware on VL805 (Raspberry Pi 4}).
+    # Try to autodetect offending firmware and temporarily fix the issue
+    # by changing power management mode
+    echo "Checking for VL805 (Raspberry Pi 4)..."
+    if [[ -f /usr/bin/vl805 ]]; then
+        VL805_VERSION=$(/usr/bin/vl805)
+        VL805_VERSION=${VL805_VERSION#*: }
+        echo " - version 0x${VL805_VERSION} detected"
+        case "$VL805_VERSION" in
+            00013701)
+                echo "    - nothing to be done. It shouldn't cause USB problems."
+                ;;
+            000137ab)
+                echo -e "    - \e[31mThis version is known to cause problems with USB cameras.\e[39m"
+                echo -e "      You may want to downgrade to 0x0013701."
+                echo -e "    - [FIXING] Trying the setpci -s 01:00.0 0xD4.B=0x41 hack to mitigate the"
+                echo -e "      issue. It disables ASPM L1 on the VL805. Your board may (or may not) get"
+                echo -e "      slightly hotter. For details see:"
+                echo -e "      https://www.raspberrypi.org/forums/viewtopic.php?f=28&t=244421"
+                setpci -s 01:00.0 0xD4.B=0x41
+                ;;
+            *)
+                echo "   - unknown firmware version. Doing nothing."
+                ;;
+        esac
+    else
+        echo "  - It seems that you don't have VL805 (Raspberry Pi 4)."
+        echo "    There should be no problems with USB (a.k.a. select() timeout)"
+    fi
+
+    pushd $MJPGSTREAMER_HOME > /dev/null 2>&1
+        echo Running ./mjpg_streamer -o "output_http.so -w $camera_http_webroot $camera_http_options" -i "$input"
+        LD_LIBRARY_PATH=. ./mjpg_streamer -o "output_http.so -w $camera_http_webroot $camera_http_options" -i "$input" &
+        sleep 1 &
+        sleep_pid=$!
+        wait ${sleep_pid}
+    popd > /dev/null 2>&1
+}
+
+# starts up the RasPiCam
+function startRaspi {
+    logger -s "Starting Raspberry Pi camera"
+    runMjpgStreamer "$MJPGSTREAMER_INPUT_RASPICAM $camera_raspi_options"
+}
+
+# starts up the USB webcam
+function startUsb {
+    options="$usb_options"
+    device="video0"
+
+    # check for parameter and set the device if it is given as a parameter
+    input=$1
+    if [[ -n $input ]]; then
+        device=`basename "$input"`
+    fi
+
+    # add video device into options
+    options="$options -d /dev/$device"
+
+    uevent_file="/sys/class/video4linux/$device/device/uevent"
+    if [ -e $uevent_file ]; then
+        # let's see what kind of webcam we have here, fetch vid and pid...
+        product=`cat $uevent_file | grep PRODUCT | cut -d"=" -f2`
+        vid=`echo $product | cut -d"/" -f1`
+        pid=`echo $product | cut -d"/" -f2`
+        vidpid=`printf "%04x:%04x" "0x$vid" "0x$pid"`
+
+        # ... then look if it is in our list of known broken-fps-devices and if so remove
+        # the -f parameter from the options (if it's in there, else that's just a no-op)
+        for identifier in ${brokenfps_usb_devices[@]};
+        do
+            if [ "$vidpid" = "$identifier" ]; then
+                echo
+                echo "Camera model $vidpid is known to not work with -f parameter, stripping it out"
+                echo
+                options=`echo $options | sed -e "s/\(\s\+\|^\)-f\s\+[0-9]\+//g"`
+            fi
+        done
+    fi
+
+    logger -s "Starting USB webcam"
+    runMjpgStreamer "$MJPGSTREAMER_INPUT_USB $options"
+}
+
+# make sure our cleanup function gets called when we receive SIGINT, SIGTERM
+trap "cleanup" SIGINT SIGTERM
+# say goodbye when we EXIT
+trap "goodbye" EXIT
+
+# we need this to prevent the later calls to vcgencmd from blocking
+# I have no idea why, but that's how it is...
+vcgencmd version > /dev/null 2>&1
+
+# keep mjpg streamer running if some camera is attached
+while true; do
+
+  # get list of usb video devices into an array
+  video_devices=($(find /dev -regextype sed -regex '\/dev/video[0-9]\+' | sort -nk1.11 2> /dev/null))
+
+  # add list of raspi camera into an array
+  if [ "`vcgencmd get_camera`" = "supported=1 detected=1" ]; then
+    video_devices+=( "raspi" )
+  fi
+
+  echo "Found video devices:"
+  printf '%s\n' "${video_devices[@]}"
+
+  for scan_mode in "usb" "usb-auto" "raspi" "auto"; do
+    camera=$scan_mode
+    if [[ "usb-auto" == "$scan_mode" ]]; then
+      camera="usb"
+    fi
+    for ((i=0;i<${#array_camera[@]};i++));  do
+      if [[ -z ${array_camera_device[${i}]} ]] && [[ $camera == ${array_camera[${i}]} ]]; then
+        camera_config="${array_camera_config[${i}]}"
+        usb_options="${array_camera_usb_options[${i}]}"
+        camera_usb_device="${array_camera_usb_device[${i}]}"
+        camera_raspi_options="${array_camera_raspi_options[${i}]}"
+        camera_http_webroot="${array_camera_http_webroot[${i}]}"
+        camera_http_options="${array_camera_http_options[${i}]}"
+        brokenfps_usb_devices="${array_camera_brokenfps_usb_devices[${i}]}"
+        if [[ ${camera_usb_device} ]] && { [[ "usb" == ${scan_mode} ]] || [[ "auto" == ${scan_mode} ]]; }; then
+           # usb device is explicitly set in options
+          usb_device_path=`readlink -f ${camera_usb_device}`
+          if containsString "$usb_device_path" "${array_camera_device[@]}"; then
+            if [[ "auto" != ${scan_mode} ]]; then
+              array_camera_device[${i}]="alredy_in_use"
+              echo "config file='$camera_config':Video device already in use."
+              continue
+            fi
+          elif containsString "$usb_device_path" "${video_devices[@]}"; then
+            array_camera_device[${i}]="$usb_device_path"
+            # explicitly set usb device was found in video_devices array, start usb with the found device
+            echo "config file='$camera_config':USB device was set in options and found in devices, start MJPG-streamer with the configured USB video device: $usb_device_path"
+            startUsb "$usb_device_path"
+            continue
+          fi
+        elif [[ -z ${camera_usb_device} ]] && { [[ "usb-auto" == ${scan_mode} ]] || [[ "auto" == ${scan_mode} ]]; }; then
+          for video_device in "${video_devices[@]}"; do
+            if [[ "raspi" != "$video_device" ]]; then
+              if containsString "$video_device" "${array_camera_device[@]}"; then
+                : #already in use
+              else
+                array_camera_device[${i}]="$video_device"
+                # device is not set explicitly in options, start usb with first found usb camera as the device
+                echo "config file='$camera_config':USB device was not set in options, start MJPG-streamer with the first found video device: ${video_device}"
+                startUsb "${video_device}"
+                break
+              fi
+            fi
+          done
+          if [[ -n ${array_camera_device[${i}]} ]]; then
+            continue
+          fi
+        fi
+        if [[ "raspi" == ${scan_mode} ]] || [[ "auto" == ${scan_mode} ]]; then
+          video_device="raspi"
+          if containsString "$video_device" "${array_camera_device[@]}"; then
+            if [[ "auto" != ${scan_mode} ]]; then
+              array_camera_device[${i}]="alredy_in_use"
+              echo "config file='$camera_config':RasPiCam device already in use."
+            fi
+          elif containsString "$video_device" "${video_devices[@]}"; then
+            array_camera_device[${i}]="$video_device"
+            echo "config file='$camera_config':Start MJPG-streamer with video device: ${video_device}"
+            startRaspi
+            sleep 30 &
+            sleep_pid=$!
+            wait ${sleep_pid}
+          fi
+        fi
+      fi
+    done
+  done
+  array_assigned_device=( ${array_camera_device[*]} )
+  if [[ ${#array_camera[@]} -eq ${#array_assigned_device[@]} ]]; then
+    echo "Done bring up all configured video device"
+    exit 0
+  else
+    echo "Scan again in two minutes"
+    sleep 120 &
+    sleep_pid=$!
+    wait ${sleep_pid}
+  fi
+done

resources/mjpg-streamer/webcamd.service

@@ -0,0 +1,15 @@
+[Unit]
+Description=Starts mjpg-streamer on startup
+After=network.target
+
+[Install]
+WantedBy=multi-user.target
+
+[Service]
+Type=forking
+User=%USER%
+WorkingDirectory=/usr/local/bin
+StandardOutput=append:/var/log/webcamd.log
+StandardError=append:/var/log/webcamd.log
+ExecStart=/usr/local/bin/webcamd
+Restart=always

resources/moonraker-telegram-bot.env

@@ -0,0 +1 @@
+TELEGRAM_BOT_ARGS="%TELEGRAM_BOT_DIR%/bot/main.py -c %CFG% -l %LOG%"

resources/moonraker-telegram-bot.service

@@ -0,0 +1,16 @@
+[Unit]
+Description=Moonraker Telegram Bot SV1 %INST%
+Documentation=https://github.com/nlef/moonraker-telegram-bot/wiki
+After=network-online.target
+
+[Install]
+WantedBy=multi-user.target
+
+[Service]
+Type=simple
+User=%USER%
+WorkingDirectory=%TELEGRAM_BOT_DIR%
+EnvironmentFile=%ENV_FILE%
+ExecStart=%ENV%/bin/python $TELEGRAM_BOT_ARGS
+Restart=always
+RestartSec=10

resources/moonraker.conf

@@ -0,0 +1,31 @@
+[server]
+host: 0.0.0.0
+port: %PORT%
+klippy_uds_address: %UDS%
+
+[authorization]
+trusted_clients:
+    %LAN%
+    10.0.0.0/8
+    127.0.0.0/8
+    169.254.0.0/16
+    172.16.0.0/12
+    192.168.0.0/16
+    FE80::/10
+    ::1/128
+cors_domains:
+    *.lan
+    *.local
+    *.internal
+    *://localhost
+    *://localhost:*
+    *://my.mainsail.xyz
+    *://app.fluidd.xyz
+
+[octoprint_compat]
+
+[history]
+
+[update_manager]
+channel: dev
+refresh_interval: 168