chore: this is the last commit for KIAUH v5

206fd4828d

72b89d905e

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+end_of_line = lf
+
+[*.py]
+max_line_length = 88
+
+[*.{sh,yml,yaml,json}]
+indent_size = 2

.github/FUNDING.yml

@@ -3,10 +3,10 @@
 github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
 patreon: # Replace with a single Patreon username
 open_collective: # Replace with a single Open Collective username
-ko_fi: th33xitus
+ko_fi: dw__0
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
 community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
 liberapay: # Replace with a single Liberapay username
 issuehunt: # Replace with a single IssueHunt username
 otechie: # Replace with a single Otechie username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
+custom: https://paypal.me/dwillner0

.github/workflows/release-ff-and-tag.yml

@@ -0,0 +1,33 @@
+name: Release - Fast-Forward and Tag
+on:
+  workflow_dispatch:
+    inputs:
+      tag_name:
+        description: 'Provide a tag name (e.g. v1.0.0)'
+        required: true
+        type: string
+
+jobs:
+  ff-and-tag:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: 'master'
+      - name: Merge Fast Forward
+        uses: MaximeHeckel/github-action-merge-fast-forward@v1.1.0
+        with:
+          branchtomerge: origin/develop
+          branch: master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Create and Push Tag
+        run: |
+          git tag ${{ inputs.tag_name }}
+          git push origin ${{ inputs.tag_name }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1 +1,13 @@
-klipper_repos.txt
+.idea
+.vscode
+.pytest_cache
+.jupyter
+*.ipynb
+*.ipynb_checkpoints
+*.tmp
+__pycache__
+.kiauh-env
+*.code-workspace
+*.iml
+kiauh.cfg
+klipper_repos.txt

README.md

@@ -1,6 +1,6 @@
 <p align="center">
   <a>
-    <img src="https://raw.githubusercontent.com/th33xitus/kiauh/master/resources/screenshots/kiauh.png" alt="KIAUH logo" height="181">
+    <img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/kiauh.png" alt="KIAUH logo" height="181">
     <h1 align="center">Klipper Installation And Update Helper</h1>
   </a>
 </p>
@@ -10,84 +10,205 @@
 </p>
 
 <p align="center">
-  <a><img src="https://img.shields.io/github/license/th33xitus/kiauh"></a>
-  <a><img src="https://img.shields.io/github/stars/th33xitus/kiauh"></a>
-  <a><img src="https://img.shields.io/github/forks/th33xitus/kiauh"></a>
-  <a><img src="https://img.shields.io/github/languages/top/th33xitus/kiauh?logo=gnubash&logoColor=white"></a>
-  <a><img src="https://img.shields.io/github/v/tag/th33xitus/kiauh"></a>
-  <br />  
-  <a><img src="https://img.shields.io/github/last-commit/th33xitus/kiauh"></a>
-  <a><img src="https://img.shields.io/github/contributors/th33xitus/kiauh"></a>
+  <a><img src="https://img.shields.io/github/license/dw-0/kiauh"></a>
+  <a><img src="https://img.shields.io/github/stars/dw-0/kiauh"></a>
+  <a><img src="https://img.shields.io/github/forks/dw-0/kiauh"></a>
+  <a><img src="https://img.shields.io/github/languages/top/dw-0/kiauh?logo=gnubash&logoColor=white"></a>
+  <a><img src="https://img.shields.io/github/v/tag/dw-0/kiauh"></a>
+  <br />
+  <a><img src="https://img.shields.io/github/last-commit/dw-0/kiauh"></a>
+  <a><img src="https://img.shields.io/github/contributors/dw-0/kiauh"></a>
 </p>
 
-## **🛠️ Instructions:**
+<hr>
 
-For downloading this script it is necessary to have git installed.\
-If you haven't, please run `sudo apt-get install git -y` to install git first.\
-After git is installed, use the following commands in the given order to download and execute the script:
+<h2 align="center">
+  📄️ Instructions 📄
+</h2>
 
-```shell
-cd ~
+### 📋 Prerequisites
+KIAUH is a script that assists you in installing Klipper on a Linux operating system that has
+already been flashed to your Raspberry Pi's (or other SBC's) SD card. As a result, you must ensure
+that you have a functional Linux system on hand. `Raspberry Pi OS Lite (either 32bit or 64bit)` is a recommended Linux image
+if you are using a Raspberry Pi. The [official Raspberry Pi Imager](https://www.raspberrypi.com/software/)
+is the simplest way to flash an image like this to an SD card.
 
-git clone https://github.com/th33xitus/kiauh.git
+* Once you have downloaded, installed and launched the Raspberry Pi Imager,
+select `Choose OS -> Raspberry Pi OS (other)`: \
+<p align="center">
+  <img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager1.png" alt="KIAUH logo" height="350">
+</p>
 
-./kiauh/kiauh.sh
-```
+* Then select `Raspberry Pi OS Lite (32bit)` (or 64bit if you want to use that instead):
+<p align="center">
+  <img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager2.png" alt="KIAUH logo" height="350">
+</p>
+
+* Back in the Raspberry Pi Imager's main menu, select the corresponding SD card to which
+you want to flash the image.
+
+* Make sure to go into the Advanced Option (the cog icon in the lower left corner of the main menu)
+and enable SSH and configure Wi-Fi.
+
+* If you need more help for using the Raspberry Pi Imager, please visit the [official documentation](https://www.raspberrypi.com/documentation/computers/getting-started.html).
+
+These steps **only** apply if you are actually using a Raspberry Pi. In case you want
+to use a different SBC (like an Orange Pi or any other Pi derivates), please look up on how to get an appropriate Linux image flashed
+to the SD card before proceeding further (usually done with Balena Etcher in those cases). Also make sure that KIAUH will be able to run
+and operate on the Linux Distribution you are going to flash. You likely will have the most success with
+distributions based on Debian 11 Bullseye. Read the notes further down below in this document.
+
+### 💾 Download and use KIAUH
 **📢 Disclaimer: Usage of this script happens at your own risk!**
 
+* **Step 1:** \
+To download this script, it is necessary to have git installed. If you don't have git already installed, or if you are unsure, run the following command:
+```shell
+sudo apt-get update && sudo apt-get install git -y
+```
 
-## **❗ Notes:**
+* **Step 2:** \
+Once git is installed, use the following command to download KIAUH into your home-directory:
 
-**📋 Please see the [Changelog](docs/changelog.md) for possible important changes!**
+```shell
+cd ~ && git clone https://github.com/dw-0/kiauh.git
+```
 
-- Tested **only** on Raspberry Pi OS Lite (Debian 10 Buster)
-    - Other Debian based distributions can work
-    - Reported to work on Armbian too
-- During the use of this script you might be asked for your sudo password. There are several functions involved which need sudo privileges.
+* **Step 3:** \
+Finally, start KIAUH by running the next command:
 
-## **🌐 Sources & Further Information**
+```shell
+./kiauh/kiauh.sh
+```
 
-<table>
+* **Step 4:** \
+You should now find yourself in the main menu of KIAUH. You will see several actions to choose from depending
+on what you want to do. To choose an action, simply type the corresponding number into the "Perform action"
+prompt and confirm by hitting ENTER.
+
+<hr>
+
+<h2 align="center">❗ Notes ❗</h2>
+
+### **📋 Please see the [Changelog](docs/changelog.md) for possible important changes!**
+
+- Mainly tested on Raspberry Pi OS Lite (Debian 10 Buster / Debian 11 Bullseye)
+    - Other Debian based distributions (like Ubuntu 20 to 22) likely work too
+    - Reported to work on Armbian as well but not tested in detail
+- During the use of this script you will be asked for your sudo password. There are several functions involved which need sudo privileges.
+
+<hr>
+
+<h2 align="center">🌐 Sources & Further Information</h2>
+
+<table align="center">
 <tr>
-<th><h3><a href="https://github.com/Klipper3d/klipper">Klipper</a></h3></th>
-<th><h3><a href="https://github.com/Arksine/moonraker">Moonraker</a></h3></th>
-<th><h3><a href="https://github.com/mainsail-crew/mainsail">Mainsail</a></h3></th>
-<th><h3><a href="https://github.com/fluidd-core/fluidd">Fluidd</a></h3></th>
+    <th><h3><a href="https://github.com/Klipper3d/klipper">Klipper</a></h3></th>
+    <th><h3><a href="https://github.com/Arksine/moonraker">Moonraker</a></h3></th>
+    <th><h3><a href="https://github.com/mainsail-crew/mainsail">Mainsail</a></h3></th>
 </tr>
 <tr>
-<th><img src="https://raw.githubusercontent.com/Klipper3d/klipper/master/docs/img/klipper-logo.png" alt="Klipper Logo" height="64"></th>
-<th><img src="https://avatars.githubusercontent.com/u/9563098?v=4" alt="Arksine avatar" height="64"></th>
-<th><img src="https://raw.githubusercontent.com/mainsail-crew/docs/master/assets/img/logo.png" alt="Mainsail Logo" height="64"></th>
-<th><img src="https://raw.githubusercontent.com/fluidd-core/fluidd/master/docs/assets/images/logo.svg" alt="Fluidd Logo" height="64"></th>
+    <th><img src="https://raw.githubusercontent.com/Klipper3d/klipper/master/docs/img/klipper-logo.png" alt="Klipper Logo" height="64"></th>
+    <th><img src="https://avatars.githubusercontent.com/u/9563098?v=4" alt="Arksine avatar" height="64"></th>
+    <th><img src="https://raw.githubusercontent.com/mainsail-crew/docs/master/assets/img/logo.png" alt="Mainsail Logo" height="64"></th>
 </tr>
 <tr>
-<th>by <a href="https://github.com/KevinOConnor">KevinOConnor</a></th>
-<th>by <a href="https://github.com/Arksine">Arksine</a></th>
-<th>by <a href="https://github.com/mainsail-crew">mainsail-crew</a></th>
-<th>by <a href="https://github.com/fluidd-core">fluidd-core</a></th>
+    <th>by <a href="https://github.com/KevinOConnor">KevinOConnor</a></th>
+    <th>by <a href="https://github.com/Arksine">Arksine</a></th>
+    <th>by <a href="https://github.com/mainsail-crew">mainsail-crew</a></th>
+</tr>
+
+<tr>
+    <th><h3><a href="https://github.com/fluidd-core/fluidd">Fluidd</a></h3></th>
+    <th><h3><a href="https://github.com/jordanruthe/KlipperScreen">KlipperScreen</a></h3></th>
+    <th><h3><a href="https://github.com/OctoPrint/OctoPrint">OctoPrint</a></h3></th>
 </tr>
 <tr>
-<th><h3><a href="https://github.com/jordanruthe/KlipperScreen">KlipperScreen</a></h3></th>
-<th><h3><a href="https://github.com/nlef/moonraker-telegram-bot">Moonraker-Telegram-Bot</a></h3></th>
-<th><h3><a href="https://github.com/Kragrathea/pgcode">PrettyGCode for Klipper</a></h3></th>
-<th><h3><a href="https://github.com/OctoPrint/OctoPrint">OctoPrint</a></h3></th>
+    <th><img src="https://raw.githubusercontent.com/fluidd-core/fluidd/master/docs/assets/images/logo.svg" alt="Fluidd Logo" height="64"></th>
+    <th><img src="https://avatars.githubusercontent.com/u/31575189?v=4" alt="jordanruthe avatar" height="64"></th>
+    <th><img src="https://raw.githubusercontent.com/OctoPrint/OctoPrint/master/docs/images/octoprint-logo.png" alt="OctoPrint Logo" height="64"></th>
 </tr>
 <tr>
-<th><img src="https://avatars.githubusercontent.com/u/31575189?v=4" alt="jordanruthe avatar" height="64"></th>
-<th><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></th>
-<th><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></th>
-<th><img src="https://camo.githubusercontent.com/627be7fc67195b626b298af9b9677d7c58e698c67305e54324cffbe06130d4a4/68747470733a2f2f6f63746f7072696e742e6f72672f6173736574732f696d672f6c6f676f2e706e67" alt="OctoPrint Logo" height="64"></th>
+    <th>by <a href="https://github.com/fluidd-core">fluidd-core</a></th>
+    <th>by <a href="https://github.com/jordanruthe">jordanruthe</a></th>
+    <th>by <a href="https://github.com/OctoPrint">OctoPrint</a></th>
+</tr>
+
+<tr>
+    <th><h3><a href="https://github.com/nlef/moonraker-telegram-bot">Moonraker-Telegram-Bot</a></h3></th>
+    <th><h3><a href="https://github.com/Kragrathea/pgcode">PrettyGCode for Klipper</a></h3></th>
+    <th><h3><a href="https://github.com/TheSpaghettiDetective/moonraker-obico">Obico for Klipper</a></h3></th>
 </tr>
 <tr>
-<th>by <a href="https://github.com/jordanruthe">jordanruthe</a></th>
-<th>by <a href="https://github.com/nlef">nlef</a></th>
-<th>by <a href="https://github.com/Kragrathea">Kragrathea</a></th>
-<th>by <a href="https://github.com/OctoPrint">OctoPrint</a></th>
+    <th><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></th>
+    <th><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></th>
+    <th><img src="https://avatars.githubusercontent.com/u/46323662?s=200&v=4" alt="Obico logo" height="64"></th>
+</tr>
+<tr>
+    <th>by <a href="https://github.com/nlef">nlef</a></th>
+    <th>by <a href="https://github.com/Kragrathea">Kragrathea</a></th>
+    <th>by <a href="https://github.com/TheSpaghettiDetective">Obico</a></th>
+</tr>
+
+<tr>
+    <th><h3><a href="https://github.com/Clon1998/mobileraker_companion">Mobileraker's Companion</a></h3></th>
+    <th><h3><a href="https://octoeverywhere.com/?source=kiauh_readme">OctoEverywhere For Klipper</a></h3></th>
+    <th><h3><a href="https://github.com/crysxd/OctoApp-Plugin">OctoApp For Klipper</a></h3></th>
+</tr>
+<tr>
+    <th><a href="https://github.com/Clon1998/mobileraker_companion"><img src="https://raw.githubusercontent.com/Clon1998/mobileraker/master/assets/icon/mr_appicon.png" alt="Mobileraker Logo" height="64"></a></th>
+    <th><a href="https://octoeverywhere.com/?source=kiauh_readme"><img src="https://octoeverywhere.com/img/logo.svg" alt="OctoEverywhere Logo" height="64"></a></th>
+    <th><a href="https://octoapp.eu/?source=kiauh_readme"><img src="https://octoapp.eu/octoapp.webp" alt="OctoApp Logo" height="64"></a></th>
+</tr>
+<tr>
+    <th>by <a href="https://github.com/Clon1998">Patrick Schmidt</a></th>
+    <th>by <a href="https://github.com/QuinnDamerell">Quinn Damerell</a></th>
+    <th>by <a href="https://github.com/crysxd">Christian Würthner</a></th>
+</tr>
+
+<tr>
+    <th><h3><a href="https://github.com/staubgeborener/klipper-backup">Klipper-Backup</a></h3></th>
+    <th><h3><a href="https://simplyprint.io/">SimplyPrint for Klipper</a></h3></th>
+</tr>
+<tr>
+    <th><a href="https://github.com/staubgeborener/klipper-backup"><img src="https://avatars.githubusercontent.com/u/28908603?v=4" alt="Staubgeroner Avatar" height="64"></a></th>
+    <th><a href="https://github.com/SimplyPrint"><img src="https://avatars.githubusercontent.com/u/64896552?s=200&v=4" alt="" height="64"></a></th>
+</tr>
+<tr>
+    <th>by <a href="https://github.com/Staubgeborener">Staubgeborener</a></th>
+    <th>by <a href="https://github.com/SimplyPrint">SimplyPrint</a></th>
 </tr>
 </table>
 
-## **Credits**
+<hr>
+
+<h2 align="center">🎖️ Contributors 🎖️</h2>
+
+<div align="center">
+  <a href="https://github.com/dw-0/kiauh/graphs/contributors">
+    <img src="https://contrib.rocks/image?repo=dw-0/kiauh" alt=""/>
+  </a>
+</div>
+
+<hr>
+
+<div align="center">
+    <img src="https://repobeats.axiom.co/api/embed/a1afbda9190c04a90cf4bd3061e5573bc836cb05.svg" alt="Repobeats analytics image"/>
+</div>
+
+<hr>
+
+<h2 align="center">✨ Credits ✨</h2>
 
 * A big thank you to [lixxbox](https://github.com/lixxbox) for that awesome KIAUH-Logo!
-* Also a big thank you to everyone who supported my work with a [Ko-fi](https://ko-fi.com/th33xitus) !
+* Also, a big thank you to everyone who supported my work with a [Ko-fi](https://ko-fi.com/dw__0) !
 * Last but not least: Thank you to all contributors and members of the Klipper Community who like and share this project!
+
+<hr>
+
+<h4 align="center">A special thank you to JetBrains for sponsoring this project with their incredible software!</h4>
+<p align="center">
+  <a href="https://www.jetbrains.com/community/opensource/#support" target="_blank">
+    <img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo (Main) logo." height="128">
+  </a>
+</p>

README_zh.md

@@ -0,0 +1,206 @@
+# KIAUH - Klipper 安装与更新助手
+
+<p align="center">
+  <a>
+    <img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/kiauh.png" alt="KIAUH logo" height="181">
+    <h1 align="center">Klipper Installation And Update Helper</h1>
+  </a>
+</p>
+
+<p align="center">
+  一个方便的安装脚本，让安装Klipper（以及更多组件）变得轻松！
+</p>
+
+<p align="center">
+  <a><img src="https://img.shields.io/github/license/dw-0/kiauh"></a>
+  <a><img src="https://img.shields.io/github/stars/dw-0/kiauh"></a>
+  <a><img src="https://img.shields.io/github/forks/dw-0/kiauh"></a>
+  <a><img src="https://img.shields.io/github/languages/top/dw-0/kiauh?logo=gnubash&logoColor=white"></a>
+  <a><img src="https://img.shields.io/github/v/tag/dw-0/kiauh"></a>
+  <br />
+  <a><img src="https://img.shields.io/github/last-commit/dw-0/kiauh"></a>
+  <a><img src="https://img.shields.io/github/contributors/dw-0/kiauh"></a>
+</p>
+
+## 📄 使用说明
+
+### 📋 系统要求
+KIAUH 是一个帮助您在 Linux 系统上安装 Klipper 的脚本工具，
+它需要一个已经写入树莓派（或其他单板计算机）SD 卡的 Linux 系统。
+如果您使用树莓派，推荐使用 `Raspberry Pi OS Lite (32位或64位)` 系统镜像。
+[官方 Raspberry Pi Imager](https://www.raspberrypi.com/software/) 是将此类镜像写入 SD 卡的最简单方式。
+
+* 下载、安装并启动 Raspberry Pi Imager 后，
+选择 `Choose OS -> Raspberry Pi OS (other)`:
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager1.png" alt="KIAUH logo" height="350">
+</p>
+
+* 然后选择 `Raspberry Pi OS Lite (32位)` (或如果您想使用64位版本):
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager2.png" alt="KIAUH logo" height="350">
+</p>
+
+* 返回 Raspberry Pi Imager 主界面，选择对应的 SD 卡作为写入目标。
+
+* 确保点击左下角的齿轮图标（在主菜单中）
+启用 SSH 并配置 Wi-Fi。
+
+* 如果您需要更多关于使用 Raspberry Pi Imager 的帮助，请访问 [官方文档](https://www.raspberrypi.com/documentation/computers/getting-started.html)。
+
+这些步骤**仅适用于**您实际使用树莓派的情况。如果您想使用其他单板计算机（如香橙派或其他 Pi 衍生产品），
+请查找如何将合适的 Linux 镜像写入 SD 卡（通常使用 Balena Etcher）。
+同时确保 KIAUH 能够在您要安装的 Linux 发行版上运行。
+您在使用基于 Debian 11 Bullseye 的系统时可能会获得最佳体验。
+请阅读本文档下方的注意事项。
+
+### 💾 下载并使用 KIAUH
+
+**📢 免责声明：使用此脚本的风险由您自行承担！**
+
+* **第一步：**
+要下载此脚本，需要先安装 git。
+如果您不确定是否已安装 git，请运行以下命令：
+```shell
+sudo apt-get update && sudo apt-get install git -y
+```
+
+* **第二步：**
+安装完 git 后，
+使用以下命令将 KIAUH 下载到您的主目录：
+
+```shell
+cd ~ && git clone https://github.com/dw-0/kiauh.git
+```
+
+* **第三步：**
+最后，通过运行以下命令启动 KIAUH：
+
+```shell
+./kiauh/kiauh.sh
+```
+
+* **第四步：**
+您现在应该会看到 KIAUH 的主菜单。
+根据您的选择，
+您会看到几个可选操作。
+要选择某个操作，只需在 "Perform action" 提示后输入对应的数字并按回车键确认。
+
+## ❗ 注意事项
+
+### **📋 请查看 [更新日志](docs/changelog.md) 以了解可能的重要更新！**
+
+- 主要在 Raspberry Pi OS Lite (Debian 10 Buster / Debian 11 Bullseye) 上测试
+    - 其他基于 Debian 的发行版（如 Ubuntu 20 到 22）也可能正常工作
+    - 据报告在 Armbian 上也可用，但未进行详细测试
+- 在使用此脚本的过程中，
+您会被要求输入 sudo 密码。
+因为有几个功能需要 sudo 权限。
+
+## 🌐 相关资源与更多信息
+
+<table align="center">
+<tr>
+    <th><h3><a href="https://github.com/Klipper3d/klipper">Klipper</a></h3></th>
+    <th><h3><a href="https://github.com/Arksine/moonraker">Moonraker</a></h3></th>
+    <th><h3><a href="https://github.com/mainsail-crew/mainsail">Mainsail</a></h3></th>
+</tr>
+<tr>
+    <th><img src="https://raw.githubusercontent.com/Klipper3d/klipper/master/docs/img/klipper-logo.png" alt="Klipper Logo" height="64"></th>
+    <th><img src="https://avatars.githubusercontent.com/u/9563098?v=4" alt="Arksine avatar" height="64"></th>
+    <th><img src="https://raw.githubusercontent.com/mainsail-crew/docs/master/assets/img/logo.png" alt="Mainsail Logo" height="64"></th>
+</tr>
+<tr>
+    <th>由 <a href="https://github.com/KevinOConnor">KevinOConnor</a></th>
+    <th>由 <a href="https://github.com/Arksine">Arksine</a></th>
+    <th>由 <a href="https://github.com/mainsail-crew">mainsail-crew</a></th>
+</tr>
+
+<tr>
+    <th><h3><a href="https://github.com/fluidd-core/fluidd">Fluidd</a></h3></th>
+    <th><h3><a href="https://github.com/jordanruthe/KlipperScreen">KlipperScreen</a></h3></th>
+    <th><h3><a href="https://github.com/OctoPrint/OctoPrint">OctoPrint</a></h3></th>
+</tr>
+<tr>
+    <th><img src="https://raw.githubusercontent.com/fluidd-core/fluidd/master/docs/assets/images/logo.svg" alt="Fluidd Logo" height="64"></th>
+    <th><img src="https://avatars.githubusercontent.com/u/31575189?v=4" alt="jordanruthe avatar" height="64"></th>
+    <th><img src="https://raw.githubusercontent.com/OctoPrint/OctoPrint/master/docs/images/octoprint-logo.png" alt="OctoPrint Logo" height="64"></th>
+</tr>
+<tr>
+    <th>由 <a href="https://github.com/fluidd-core">fluidd-core</a></th>
+    <th>由 <a href="https://github.com/jordanruthe">jordanruthe</a></th>
+    <th>由 <a href="https://github.com/OctoPrint">OctoPrint</a></th>
+</tr>
+
+<tr>
+    <th><h3><a href="https://github.com/nlef/moonraker-telegram-bot">Moonraker-Telegram-Bot</a></h3></th>
+    <th><h3><a href="https://github.com/Kragrathea/pgcode">PrettyGCode for Klipper</a></h3></th>
+    <th><h3><a href="https://github.com/TheSpaghettiDetective/moonraker-obico">Obico for Klipper</a></h3></th>
+</tr>
+<tr>
+    <th><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></th>
+    <th><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></th>
+    <th><img src="https://avatars.githubusercontent.com/u/46323662?s=200&v=4" alt="Obico logo" height="64"></th>
+</tr>
+<tr>
+    <th>由 <a href="https://github.com/nlef">nlef</a></th>
+    <th>由 <a href="https://github.com/Kragrathea">Kragrathea</a></th>
+    <th>由 <a href="https://github.com/TheSpaghettiDetective">Obico</a></th>
+</tr>
+
+<tr>
+    <th><h3><a href="https://github.com/Clon1998/mobileraker_companion">Mobileraker's Companion</a></h3></th>
+    <th><h3><a href="https://octoeverywhere.com/?source=kiauh_readme">OctoEverywhere For Klipper</a></h3></th>
+    <th><h3><a href="https://github.com/crysxd/OctoApp-Plugin">OctoApp For Klipper</a></h3></th>
+</tr>
+<tr>
+    <th><a href="https://github.com/Clon1998/mobileraker_companion"><img src="https://raw.githubusercontent.com/Clon1998/mobileraker/master/assets/icon/mr_appicon.png" alt="Mobileraker Logo" height="64"></a></th>
+    <th><a href="https://octoeverywhere.com/?source=kiauh_readme"><img src="https://octoeverywhere.com/img/logo.svg" alt="OctoEverywhere Logo" height="64"></a></th>
+    <th><a href="https://octoapp.eu/?source=kiauh_readme"><img src="https://octoapp.eu/octoapp.webp" alt="OctoApp Logo" height="64"></a></th>
+</tr>
+<tr>
+    <th>由 <a href="https://github.com/Clon1998">Patrick Schmidt</a></th>
+    <th>由 <a href="https://github.com/QuinnDamerell">Quinn Damerell</a></th>
+    <th>由 <a href="https://github.com/crysxd">Christian Würthner</a></th>
+</tr>
+
+<tr>
+    <th><h3><a href="https://github.com/staubgeborener/klipper-backup">Klipper-Backup</a></h3></th>
+    <th><h3><a href="https://simplyprint.io/">SimplyPrint for Klipper</a></h3></th>
+</tr>
+<tr>
+    <th><a href="https://github.com/staubgeborener/klipper-backup"><img src="https://avatars.githubusercontent.com/u/28908603?v=4" alt="Staubgeroner Avatar" height="64"></a></th>
+    <th><a href="https://github.com/SimplyPrint"><img src="https://avatars.githubusercontent.com/u/64896552?s=200&v=4" alt="" height="64"></a></th>
+</tr>
+<tr>
+    <th>由 <a href="https://github.com/Staubgeborener">Staubgeborener</a></th>
+    <th>由 <a href="https://github.com/SimplyPrint">SimplyPrint</a></th>
+</tr>
+</table>
+
+## 🎖️ 贡献者
+
+<div align="center">
+  <a href="https://github.com/dw-0/kiauh/graphs/contributors">
+    <img src="https://contrib.rocks/image?repo=dw-0/kiauh" alt=""/>
+  </a>
+</div>
+
+<div align="center">
+    <img src="https://repobeats.axiom.co/api/embed/a1afbda9190c04a90cf4bd3061e5573bc836cb05.svg" alt="Repobeats analytics image"/>
+</div>
+
+## ✨ 特别感谢
+
+* 非常感谢 [lixxbox](https://github.com/lixxbox) 设计了如此出色的 KIAUH 标志！
+* 同时，非常感谢所有通过 [Ko-fi](https://ko-fi.com/dw__0) 支持我的工作的人！
+* 最后但同样重要的是：感谢所有为 Klipper 社区做出贡献的成员，以及喜欢和分享这个项目的朋友们！
+
+<h4 align="center">特别感谢 JetBrains 为本项目提供其出色的软件赞助！</h4>
+<p align="center">
+  <a href="https://www.jetbrains.com/community/opensource/#support" target="_blank">
+    <img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo (Main) logo." height="128">
+  </a>
+</p>

docs/changelog.md

@@ -2,20 +2,136 @@
 
 This document covers possible important changes to KIAUH.
 
-### 2022-04-XX
+### 2024-08-31 (v6.0.0-alpha.1)
+Long time no see, but here we are again!
+A lot has happened in the background, but now it is time to take it out into the wild.
+
+#### KIAUH has now reached version 6! Well, at least in an alpha state...
+
+The project has seen a complete rewrite of the script from scratch in Python.
+It requires Python 3.8 or newer to run. Because this update is still in an alpha state, bugs may or will occur.
+During startup, you will be asked if you want to start the new version 6 or the old version 5.
+As long as version 6 is in a pre-release state, version 5 will still be available. If there are any critical issues
+with the new version that were overlooked, you can always switch back to the old version.
+
+In case you selected not to get asked about which version to start (option 3 or 4 in the startup dialog) and you want to
+revert that decision, you will find a line called `version_to_launch=` within the `.kiauh.ini` file in your home directory.
+Just delete that line, save the file and restart KIAUH. KIAUH will then ask you again which version you want to start.
+
+Here is a list of the most important changes to KIAUH in regard to version 6:
+- The majority of features available in KIAUH v5 are still available; they just got migrated from Bash to Python.
+- It is now possible to add new/remove instances to/from existing multi-instance installations of Klipper and Moonraker
+- KIAUH now has an Extension-System. This allows contributors to add new installers to KIAUH without having to modify the main script.
+    - You will now find some of the features that were previously available in the Installer-Menu in the Extensions-Menu.
+    - The current extensions are:
+        - G-Code Shell Command (previously found in the Advanced-Menu)
+        - Mainsail Theme Installer (previously found in the Advanced-Menu)
+        - Klipper-Backup (new in v6!)
+        - Moonraker Telegram Bot (previously found in the Installer-Menu)
+        - PrettyGCode for Klipper (previously found in the Installer-Menu)
+        - Obico for Klipper (previously found in the Installer-Menu)
+    - The following additional extensions are planned, but not yet available:
+        - Spoolman (available in v5 in the Installer-Menu)
+        - OctoApp (available in v5 in the Installer-Menu)
+- KIAUH has its own config file now
+    - The file has some default values for the currently supported options
+    - There might be more options in the future
+    - It is located in KIAUH's root directory and is called `default.kiauh.cfg`
+        - DO NOT EDIT the default file directly, instead make a copy of it and call it `kiauh.cfg`
+        - Settings changed via the Advanced-Menu will be written to the `kiauh.cfg`
+- Support for OctoPrint was removed
+
+Feel free to give version 6 a try and report any bugs or issues you encounter! Every feedback is appreciated.
+
+### 2023-06-17
+KIAUH has now added support for installing Mobileraker's companion!
+Mobileraker is a free and Open Source Android and iOS App for Klipper, utilizing the Moonraker API, allowing you
+to control your printer. Thank you to [Clon1998](https://github.com/Clon1998) for adding this feature!
+
+### 2023-02-03
+The installer for MJPG-Streamer got replaced by crowsnest. It is an improved webcam service, utilizing ustreamer.
+Please have a look here for additional info about crowsnest and how to configure it: https://github.com/mainsail-crew/crowsnest \
+It's unsure if the previous MJPG-Streamer installer will be updated and make its way back into KIAUH.
+A big thanks to [KwadFan](https://github.com/KwadFan) for writing the crowsnest implementation.
+
+### 2022-10-31
+Some functions got updated, though not all of them.
+
+The following functions are still currently unavailable:
+- Installation of: MJPG-Streamer
+- All backup functions and the Log-Upload
+
+### 2022-10-20
+KIAUH has now reached major version 5 !
+
+Recently Moonraker introduced some changes which makes it necessary to change the folder structure of printer setups.
+If you are interested in the details, check out this PR: https://github.com/Arksine/moonraker/pull/491 \
+Although Moonraker has some mechanics available to migrate existing setups to the new file structure with the use of symlinks, fresh and clean installs
+should be considered.
+
+The version jump of KIAUH to v5 is a breaking change due to those major changes! That means v4 and v5 are not compatible with each other!
+This is also the reason why you will currently be greeted by a yellow notification in the main menu of KIAUH leading to this changelog.
+I decided to disable a few functions of the script and focus on releasing the required changes to the core components of this script.
+I will work on updating the other parts of the script piece by piece during the next days/weeks.
+So I am already sorry in advance if one of your desired components you wanted to install or use temporarily cannot be installed or used right now.
+
+The following functions are currently unavailable:
+- Installation of: KlipperScreen, Obico, Octoprint, MJPG-Streamer, Telegram Bot and PrettyGCode
+- All backup functions and the Log-Upload
+
+**So what is working?**\
+Installation of Klipper, Moonraker, Mainsail and Fluidd. Both, single and multi-instance setups work!\
+As already said, the rest will follow in the near future. Updating and removal of already installed components should continue to work.
+
+**What was removed?**\
+The option to change Klippers configuration directory got removed. From now on it will not be possible anymore to change
+the configuration directory from within KIAUH and the new filestructure is enforced.
+
+**What if I don't have an existing Klipper/Moonraker install right now?**\
+Nothing important to think about, install Klipper and Moonraker. KIAUH will install both of them with the new filestructure.
+
+**What if I have an existing Klipper/Moonraker install?**\
+First of all: Backups! Please copy all of your config files and the Moonraker database (it is a hidden folder, usually `~/.moonraker_database`) to a safe location.
+After that, uninstall Klipper and Moonraker with KIAUH. You can then proceed and re-install both of them with KIAUH again. It is important that you are on KIAUH v5 for that!
+Once everything is installed again, you need to manually copy your configuration files from the old `~/klipper_config` folder to the new `~/printer_data/config` folder.
+Previous, by Moonraker created symlinks to folder of the old filestructure will not work anymore, you need to move the files to their new location now!
+Do the same with the two files inside of `~/.moonraker_database`. Move/copy them into `~/printer_data/database`. If `~/printer_data/database` is already populated with a `data.mdb` and `lock.mdb`
+delete them or simply overwrite them. Nothing should be lost as those should be empty database files. Anyway, you made backups, right?
+You can now proceed and restart Moonraker. Either from within Mainsail or Fluidd, or use SSH and execute `sudo systemctl restart moonraker`.
+If everything went smooth, you should be good to go again. If you see some Moonraker warnings about deprecated options in the `moonraker.conf`, go ahead and resolve them.
+I will not cover them in detail here. A good source is the Moonraker documentation: https://moonraker.readthedocs.io/en/latest/configuration/
+
+**What if I have an existing Klipper/Moonraker multi-instance install?**\
+Pretty much the same steps that are required for single instance installs apply to multi-instance setups. So please go ahead and read the previous paragraph if you didn't already.
+Make backups of everything first. Then remove and install the desired amount of Klipper and Moonraker instances again.
+Now you need to move all config and database files to their new locations.\
+Example with an instance called `printer_1`:\
+The config files go from `~/klipper_config/printer_1` to `~/printer_1_data/config`.
+The database files go from `~/.moonraker_database_1` to `~/printer_1_data/database`.
+Now restart all Moonraker services. You can restart all of them at once if you launch KIAUH, and in the main menu type `restart moonraker` and hit Enter.
+
+I hope I have covered the most important things. In case you need further support, the official Klipper Discord is a good place to ask for help.
+
+### 2022-08-15
+Support for "Obico for Klipper" was added! Huge thanks to [kennethjiang](https://github.com/kennethjiang) for helping me with the implementation!
+
+### 2022-05-29
 KIAUH has now reached major version 4 !
-* feat: Klipper can be installed under Python3 (considered as experimental)
+* feat: Klipper can be installed under Python3 (still considered as experimental)
 * feat: Klipper can be installed from custom repositories / inofficial forks
 * feat: Custom instance name for multi instance installations of Klipper
   * Any other multi instance will share the same name given to the corresponding Klipper instance
   * E.g. klipper-voron2 -> moonraker-voron2 -> moonraker-telegram-bot-voron2
-* feat: Option to only allow the installation of stable Mainsail and Fluidd versions
+* feat: Option to allow installation of / updating to unstable Mainsail and Fluidd versions
+  * by default only stable versions get installed/updated
 * feat: Multi-Instance OctoPrint installations now each have their own virtual python environment
   * allows independent installation of plugins for each instance
 * feat: Implementing the use of shellcheck during development
 * feat: Implementing a simple logging mechanic
 * feat: Log-upload function now also allows uploading other logfiles (kiauh.log, webcamd.log etc.)
+* feat: added several new help dialogs which try to explain various functions
 * fix: During Klipper installation, checks for group membership of `tty` and `dialout` are made
+* refactor: rework of the settings menu for better control the new KIAUH features
 * refactor: Support for DWC and DWC-for-Klipper has been removed
 * refactor: The backup before update settings were moved to the KIAUH settings menu
 * refactor: Switch branch function has been removed (was replaced by the custom Klipper repo feature)
@@ -40,7 +156,7 @@ membership for example caused issues when installing mjpg-streamer while not usi
 Other issues could occur when trying to flash an MCU on Debian or Ubuntu distributions where a user might not be part
 of the dialout group by default. A check for the tty group is also done. The tty group is needed for setting
 up a linux MCU (currently not yet supported by KIAUH).
-* There is an issue when trying to install Mainsail or Fluidd on Ubuntu 21.10. Permissions on that distro seem to have seen a rework 
+* There is an issue when trying to install Mainsail or Fluidd on Ubuntu 21.10. Permissions on that distro seem to have seen a rework
  in comparison to 20.04 and users will be greeted with an "Error 403 - Permission denied" message after installing one of Klippers webinterfaces.
 I still have to figure out a viable solution for that.
 

docs/gcode_shell_command.md

@@ -41,7 +41,7 @@ Execute with:
 `RUN_SHELL_COMMAND CMD=hello_world`
 
 ### Passing parameters:
-As of commit [f231fa9](https://github.com/th33xitus/kiauh/commit/f231fa9c69191f23277b4e3319f6b675bfa0ee42) it is also possible to pass optional parameters to a `gcode_shell_command`.
+As of commit [f231fa9](https://github.com/dw-0/kiauh/commit/f231fa9c69191f23277b4e3319f6b675bfa0ee42) it is also possible to pass optional parameters to a `gcode_shell_command`.
 The following short example shows storing the extruder temperature into a variable, passing that value with a parameter to a `gcode_shell_command`, which then, 
 once the gcode_macro runs and the gcode_shell_command gets called, executes the `script.sh`. The script then echoes a message to the console (if `verbose: True`) 
 and writes the value of the parameter into a textfile called `test.txt` located in the home directory.

kiauh.sh

@@ -1,16 +1,19 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
 
 set -e
-clear
+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]}")")"
@@ -54,36 +57,15 @@ function kiauh_update_avail() {
   fi
 }
 
-function kiauh_update_dialog() {
-  [[ ! $(kiauh_update_avail) == "true" ]] && return
-  top_border
-  echo -e "|${green}              New KIAUH update available!              ${white}|"
-  hr
-  echo -e "|${green}  View Changelog: https://git.io/JnmlX                 ${white}|"
-  blank_line
-  echo -e "|${yellow}  It is recommended to keep KIAUH up to date. Updates  ${white}|"
-  echo -e "|${yellow}  usually contain bugfixes, important changes or new   ${white}|"
-  echo -e "|${yellow}  features. Please consider updating!                  ${white}|"
-  bottom_border
-
-  local yn
-  read -p "${cyan}###### Do you want to update now? (Y/n):${white} " yn
-  while true; do
-    case "${yn}" in
-      Y|y|Yes|yes|"")
-        do_action "update_kiauh"
-        break;;
-      N|n|No|no)
-        break;;
-      *)
-        deny_action "kiauh_update_dialog";;
-    esac
-  done
+function main() {
+  read_kiauh_ini "${FUNCNAME[0]}"
+  main_menu
 }
 
+check_if_ratos
 check_euid
 init_logfile
 set_globals
+read_kiauh_ini
 init_ini
-kiauh_update_dialog
-main_menu
+main

resources/example.printer.cfg

@@ -1,7 +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
+max_accel: 1000

resources/fluidd

@@ -1,10 +1,10 @@
-# /etc/nginx/sites-available/<<UI>>
+# /etc/nginx/sites-available/fluidd
 
 server {
     listen 80;
 
-    access_log /var/log/nginx/<<UI>>-access.log;
-    error_log /var/log/nginx/<<UI>>-error.log;
+    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;
@@ -16,8 +16,8 @@ server {
     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 <<UI>> static files
-    root /home/pi/<<UI>>;
+    # web_path from fluidd static files
+    root /home/pi/fluidd;
 
     index index.html;
     server_name _;
@@ -55,6 +55,7 @@ server {
         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/ {

resources/gcode_shell_command.py

@@ -8,22 +8,26 @@ 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')
+        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., above=0.)
-        self.verbose = config.getboolean('verbose', True)
+        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,
+            "RUN_SHELL_COMMAND",
+            "CMD",
+            self.name,
             self.cmd_RUN_SHELL_COMMAND,
-            desc=self.cmd_RUN_SHELL_COMMAND_help)
+            desc=self.cmd_RUN_SHELL_COMMAND_help,
+        )
 
     def _process_output(self, eventime):
         if self.proc_fd is None:
@@ -33,11 +37,11 @@ class ShellCommand:
         except Exception:
             pass
         data = self.partial_output + data.decode()
-        if '\n' not in data:
+        if "\n" not in data:
             self.partial_output = data
             return
-        elif data[-1] != '\n':
-            split = data.rfind('\n') + 1
+        elif data[-1] != "\n":
+            split = data.rfind("\n") + 1
             self.partial_output = data[split:]
             data = data[:split]
         else:
@@ -45,16 +49,19 @@ class ShellCommand:
         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 = 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)
+                self.command + gcode_params,
+                stdout=subprocess.PIPE,
+                stderr=subprocess.STDOUT,
+            )
         except Exception:
-            logging.exception(
-                "shell_command: Command {%s} failed" % (self.name))
+            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()
@@ -64,7 +71,7 @@ class ShellCommand:
         endtime = eventtime + self.timeout
         complete = False
         while eventtime < endtime:
-            eventtime = reactor.pause(eventtime + .05)
+            eventtime = reactor.pause(eventtime + 0.05)
             if proc.poll() is not None:
                 complete = True
                 break

resources/kiauh_macros.cfg

@@ -1,59 +0,0 @@
-################################################################################
-# ~~~~~~~~~~~~~~~~~~~~~~~~  AUTOCREATED WITH KIAUH  ~~~~~~~~~~~~~~~~~~~~~~~~~~ #
-################################################################################
-# Recommended macros and config entries if you use Mainsail or Fluidd!         #
-# You can edit or delete those macros if you already defined them elsewhere!   #
-################################################################################
-
-[pause_resume]
-
-[display_status]
-
-[gcode_macro CANCEL_PRINT]
-rename_existing: BASE_CANCEL_PRINT
-gcode:
-    TURN_OFF_HEATERS
-    CLEAR_PAUSE
-    SDCARD_RESET_FILE
-    BASE_CANCEL_PRINT
-
-[gcode_macro PAUSE]
-rename_existing: BASE_PAUSE
-gcode:
-    ##### set defaults #####
-    {% set x = params.X|default(230) %}      #edit to your park position
-    {% set y = params.Y|default(230) %}      #edit to your park position
-    {% set z = params.Z|default(10)|float %} #edit to your park position
-    {% set e = params.E|default(1) %}        #edit to your retract length
-    ##### calculate save lift position #####
-    {% set max_z = printer.toolhead.axis_maximum.z|float %}
-    {% set act_z = printer.toolhead.position.z|float %}
-    {% set lift_z = z|abs %}
-    {% if act_z < (max_z - lift_z) %}
-        {% set z_safe = lift_z %}
-    {% else %}
-        {% set z_safe = max_z - act_z %}
-    {% endif %}
-    ##### end of definitions #####
-    SAVE_GCODE_STATE NAME=PAUSE_state
-    BASE_PAUSE
-    G91
-    G1 E-{e} F2100
-    G1 Z{z_safe}
-    G90
-    G1 X{x} Y{y} F6000
-
-
-[gcode_macro RESUME]
-rename_existing: BASE_RESUME
-gcode:
-    ##### set defaults #####
-    {% set e = params.E|default(1) %} #edit to your retract length
-    G91
-    G1 E{e} F2100
-    G90
-    RESTORE_GCODE_STATE NAME=PAUSE_state MOVE=1
-    BASE_RESUME
-
-################################################################################
-################################################################################

resources/klipper.env

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

resources/klipper.service

@@ -1,22 +1,18 @@
-#Systemd Klipper Service
-
 [Unit]
-Description=Systemd Klipper Service for instance klipper-%INST%
+Description=Klipper 3D Printer Firmware SV1
 Documentation=https://www.klipper3d.org/
-After=network.target
+After=network-online.target
 Wants=udev.target
 
 [Install]
 WantedBy=multi-user.target
 
 [Service]
-Environment=KLIPPER_CONFIG=%CFG%
-Environment=KLIPPER_LOG=%LOG%
-Environment=KLIPPER_SOCKET=%UDS%
-Environment=KLIPPER_PRINTER=%PRINTER%
 Type=simple
 User=%USER%
 RemainAfterExit=yes
-ExecStart=%ENV%/bin/python %DIR%/klippy/klippy.py ${KLIPPER_CONFIG} -I ${KLIPPER_PRINTER} -l ${KLIPPER_LOG} -a ${KLIPPER_SOCKET}
+WorkingDirectory=%KLIPPER_DIR%
+EnvironmentFile=%ENV_FILE%
+ExecStart=%ENV%/bin/python $KLIPPER_ARGS
 Restart=always
-RestartSec=10
+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/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

@@ -1,19 +1,16 @@
-#Systemd service file for Moonraker Telegram Bot
-
 [Unit]
-Description=Starts Moonraker Telegram Bot instance %INST% on startup
+Description=Moonraker Telegram Bot SV1 %INST%
 Documentation=https://github.com/nlef/moonraker-telegram-bot/wiki
-After=network.target
+After=network-online.target
 
 [Install]
 WantedBy=multi-user.target
 
 [Service]
-Environment=TELEGRAM_CONF=%CFG%
-Environment=TELEGRAM_LOG=%LOG%
 Type=simple
 User=%USER%
-RemainAfterExit=yes
-ExecStart=%ENV%/bin/python %DIR%/bot/main.py -c ${TELEGRAM_CONF} -l ${TELEGRAM_LOG}
+WorkingDirectory=%TELEGRAM_BOT_DIR%
+EnvironmentFile=%ENV_FILE%
+ExecStart=%ENV%/bin/python $TELEGRAM_BOT_ARGS
 Restart=always
-RestartSec=10
+RestartSec=10

resources/moonraker.conf

@@ -1,7 +1,6 @@
 [server]
 host: 0.0.0.0
 port: %PORT%
-enable_debug_logging: False
 klippy_uds_address: %UDS%
 
 [authorization]
@@ -15,19 +14,13 @@ trusted_clients:
     FE80::/10
     ::1/128
 cors_domains:
-    http://*.lan
-    http://*.local
-    https://my.mainsail.xyz
-    http://my.mainsail.xyz
-    https://app.fluidd.xyz
-    http://app.fluidd.xyz
-
-[database]
-database_path: %DB%
-
-[file_manager]
-config_path: %CFG%
-log_path: %LOG%
+    *.lan
+    *.local
+    *.internal
+    *://localhost
+    *://localhost:*
+    *://my.mainsail.xyz
+    *://app.fluidd.xyz
 
 [octoprint_compat]
 

resources/moonraker.env

@@ -0,0 +1 @@
+MOONRAKER_ARGS="%MOONRAKER_DIR%/moonraker/moonraker.py -d %PRINTER_DATA%"

resources/moonraker.service

@@ -1,20 +1,19 @@
-#Systemd Moonraker Service
-
 [Unit]
-Description=Systemd Moonraker Service for instance moonraker-%INST%
+Description=API Server for Klipper SV1 %INST%
 Documentation=https://moonraker.readthedocs.io/
-After=network.target
+Requires=network-online.target
+After=network-online.target
 
 [Install]
 WantedBy=multi-user.target
 
 [Service]
-Environment=MOONRAKER_CONF=%CFG%
-Environment=MOONRAKER_LOG=%LOG%
 Type=simple
-SupplementaryGroups=moonraker-admin
 User=%USER%
+SupplementaryGroups=moonraker-admin
 RemainAfterExit=yes
-ExecStart=%ENV%/bin/python %DIR%/moonraker/moonraker.py -c ${MOONRAKER_CONF} -l ${MOONRAKER_LOG}
+WorkingDirectory=%MOONRAKER_DIR%
+EnvironmentFile=%ENV_FILE%
+ExecStart=%ENV%/bin/python $MOONRAKER_ARGS
 Restart=always
 RestartSec=10

scripts/backup.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -31,21 +31,30 @@ function backup_before_update() {
   backup_"${1}"
 }
 
-function backup_klipper_config_dir() {
+function backup_config_dir() {
   check_for_backup_dir
-  local current_date config_folder_name
+  local current_date config_pathes
 
-  if [[ -d "${KLIPPER_CONFIG}" ]]; then
+  config_pathes=$(get_config_folders)
+
+  if [[ -n "${config_pathes}" ]]; then
     current_date=$(get_date)
-    config_folder_name="$(echo "${KLIPPER_CONFIG}" | rev | cut -d"/" -f1 | rev)"
-
     status_msg "Timestamp: ${current_date}"
-    status_msg "Create backup of the Klipper config directory ..."
 
-    mkdir -p "${BACKUP_DIR}/${config_folder_name}/${current_date}"
-    cp -r "${KLIPPER_CONFIG}" "${_}"
+    local i=0 folder folder_name target_dir
+    for folder in ${config_pathes}; do
+      if [[ -d ${folder} ]]; then
+        status_msg "Create backup of ${folder} ..."
 
-    print_confirm "Configuration directory backup complete!"
+        folder_name=$(echo "${folder}" | rev | cut -d"/" -f2 | rev)
+        target_dir="${BACKUP_DIR}/configs/${current_date}/${folder_name}"
+        mkdir -p "${target_dir}"
+        cp -r "${folder}" "${target_dir}"
+        i=$(( i + 1 ))
+
+        ok_msg "Backup created in:\n${target_dir}"
+      fi
+    done
   else
     ok_msg "No config directory found! Skipping backup ..."
   fi
@@ -53,27 +62,29 @@ function backup_klipper_config_dir() {
 
 function backup_moonraker_database() {
   check_for_backup_dir
-  local current_date databases target_dir regex=".moonraker_database(_[0-9a-zA-Z]+)?"
-  databases=$(find "${HOME}" -maxdepth 1 -type d -regextype posix-extended -regex "${HOME}/${regex}" | sort)
+  local current_date db_pathes
 
-  if [[ -n ${databases} ]]; then
+  db_pathes=$(get_instance_folder_path "database")
+
+  if [[ -n ${db_pathes} ]]; then
     current_date=$(get_date)
-    target_dir="${BACKUP_DIR}/moonraker_database_backup/${current_date}"
-
     status_msg "Timestamp: ${current_date}"
-    mkdir -p "${target_dir}"
 
-    for database in ${databases}; do
+    local i=0 database folder_name target_dir
+    for database in ${db_pathes}; do
       status_msg "Create backup of ${database} ..."
-      cp -r "${database}" "${target_dir}"
-      ok_msg "Done!"
-    done
 
-    print_confirm "Moonraker database backup complete!"
+      folder_name=$(echo "${database}" | rev | cut -d"/" -f2 | rev)
+      target_dir="${BACKUP_DIR}/moonraker_databases/${current_date}/${folder_name}"
+      mkdir -p "${target_dir}"
+      cp -r "${database}" "${target_dir}"
+      i=$(( i + 1 ))
+
+      ok_msg "Backup created in:\n${target_dir}"
+    done
   else
     print_error "No Moonraker database found! Skipping backup ..."
   fi
-  return
 }
 
 function backup_klipper() {
@@ -186,3 +197,35 @@ function backup_telegram_bot() {
     print_error "Can't back up MoonrakerTelegramBot directory!\n Not found!"
   fi
 }
+
+function backup_octoeverywhere() {
+  local current_date
+
+  if [[ -d ${OCTOEVERYWHERE_DIR} ]] ; then
+    status_msg "Creating OctoEverywhere backup ..."
+    check_for_backup_dir
+    current_date=$(get_date)
+    status_msg "Timestamp: ${current_date}"
+    mkdir -p "${BACKUP_DIR}/OctoEverywhere-backups/${current_date}"
+    cp -r "${OCTOEVERYWHERE_DIR}" "${_}" && cp -r "${OCTOEVERYWHERE_ENV}" "${_}"
+    print_confirm "OctoEverywhere backup complete!"
+  else
+    print_error "Can't back up OctoEverywhere directory!\n Not found!"
+  fi
+}
+
+function backup_spoolman() {
+  local current_date
+
+  if [[ -d ${SPOOLMAN_DIR} ]] ; then
+    status_msg "Creating Spoolman backup ..."
+    check_for_backup_dir
+    current_date=$(get_date)
+    status_msg "Timestamp: ${current_date}"
+    mkdir -p "${BACKUP_DIR}/Spoolman-backups/${current_date}"
+    cp -r "${SPOOLMAN_DIR}" "${_}" && cp -r "${SPOOLMAN_DB_DIR}/spoolman.db" "${_}"
+    print_confirm "Spoolman backup complete!"
+  else
+    print_error "Can't back up Spoolman directory!\n Not found!"
+  fi
+}

scripts/crowsnest.sh

@@ -0,0 +1,235 @@
+#!/usr/bin/env bash
+
+#=======================================================================#
+# 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                                         #
+#                                                                       #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+#=======================================================================#
+
+#=======================================================================#
+# Crowsnest Installer brought to you by KwadFan <me@stephanwe.de>       #
+# Copyright (C) 2022 KwadFan <me@stephanwe.de>                          #
+# https://github.com/KwadFan/crowsnest                                  #
+#=======================================================================#
+
+# Error Handling
+set -e
+
+# Helper messages
+
+function multi_instance_message(){
+  echo -e "Crowsnest is NOT designed to support multi instances."
+  echo -e "A workaround for this is to choose the most used instance as a 'master'"
+  echo -e "Use this instance to set up your 'crowsnest.conf' and steering it's service.\n"
+  echo -e "Found the following instances:\n"
+  for i in ${1}; do
+    select_msg "${i}"
+  done
+  echo -e "\nLaunching crowsnest's configuration tool ..."
+  continue_config
+}
+
+# Helper funcs
+function clone_crowsnest(){
+  $(command -v git) clone "${CROWSNEST_REPO}" -b master "${CROWSNEST_DIR}"
+}
+
+function check_multi_instance(){
+  local -a instances
+  readarray -t instances < <(find "${HOME}" -regex "${HOME}/[a-zA-Z0-9_]+_data/*" -printf "%P\n" 2> /dev/null | sort)
+  if [[ "${#instances[@]}" -gt 1 ]]; then
+    status_msg "Multi instance install detected ..."
+    multi_instance_message "${instances[*]}"
+    if [[ -d "${HOME}/crowsnest" ]]; then
+      pushd "${HOME}/crowsnest" &> /dev/null || exit 1
+      if ! make config ;then
+        error_msg "Something went wrong! Please try again..."
+        if [[ -f "tools/.config" ]]; then
+          rm -f tools/.config
+        fi
+        exit 1
+      fi
+      if [[ ! -f "tools/.config" ]]; then
+        log_error "failure while generating .config"
+        error_msg "Generating .config failed, installation aborted"
+        exit 1
+      fi
+      popd &> /dev/null || exit 1
+    fi
+  fi
+}
+
+function continue_config() {
+  local reply
+  while true; do
+    read -erp "${cyan}###### Continue with configuration? (y/N):${white} " reply
+    case "${reply}" in
+      Y|y|Yes|yes)
+        select_msg "Yes"
+        break;;
+      N|n|No|no|"")
+        select_msg "No"
+        warn_msg "Installation aborted by user ... Exiting!"
+        exit 1;;
+      *)
+        error_msg "Invalid Input!\n";;
+    esac
+  done
+  return 0
+}
+
+# Install func
+function install_crowsnest(){
+
+  # Step 1: jump to home directory
+  pushd "${HOME}" &> /dev/null || exit 1
+
+  # Step 2: Clone crowsnest repo
+  status_msg "Cloning 'crowsnest' repository ..."
+  if [[ ! -d "${HOME}/crowsnest" && -z "$(ls -A "${HOME}/crowsnest" 2> /dev/null)" ]]; then
+    clone_crowsnest
+  else
+    ok_msg "crowsnest repository already exists ..."
+  fi
+
+  # Step 3: Install dependencies
+  dependency_check git make
+
+  # Step 4: Check for Multi Instance
+  check_multi_instance
+
+  # Step 5: Launch crowsnest installer
+  pushd "${HOME}/crowsnest" &> /dev/null || exit 1
+  title_msg "Installer will prompt you for sudo password!"
+  status_msg "Launching crowsnest installer ..."
+  if ! sudo make install; then
+    error_msg "Something went wrong! Please try again..."
+    exit 1
+  fi
+
+  # Step 5: Leave directory (twice due two pushd)
+  popd &> /dev/null || exit 1
+  popd &> /dev/null || exit 1
+}
+
+# Remove func
+function remove_crowsnest(){
+  if [[ -d "${CROWSNEST_DIR}" ]]; then
+    pushd "${HOME}/crowsnest" &> /dev/null || exit 1
+    title_msg "Uninstaller will prompt you for sudo password!"
+    status_msg "Launching crowsnest uninstaller ..."
+
+    if ! make uninstall; then
+      error_msg "Something went wrong! Please try again..."
+      exit 1
+    fi
+
+    status_msg "Removing crowsnest directory ..."
+    rm -rf "${CROWSNEST_DIR}"
+    ok_msg "Directory removed!"
+  fi
+
+  print_confirm "Crowsnest successfully removed!"
+}
+
+# Status funcs
+get_crowsnest_status(){
+  local -a files
+  local env_file
+  env_file="$(grep "EnvironmentFile" /etc/systemd/system/crowsnest.service 2>/dev/null | cut -d "=" -f2)"
+  files=(
+    "${CROWSNEST_DIR}"
+    "/usr/local/bin/crowsnest"
+    "/etc/logrotate.d/crowsnest"
+    "/etc/systemd/system/crowsnest.service"
+    "${env_file}"
+    )
+  local count
+  count=0
+
+  for file in "${files[@]}"; do
+    [[ -e "${file}" ]] && count=$(( count +1 ))
+  done
+  if [[ "${count}" -eq "${#files[*]}" ]]; then
+    echo "Installed"
+  elif [[ "${count}" -gt 0 ]]; then
+    echo "Incomplete!"
+  else
+    echo "Not installed!"
+  fi
+}
+
+# Update funcs
+# Shameless stolen from KlipperScreen.sh
+function get_local_crowsnest_commit() {
+  [[ ! -d ${CROWSNEST_DIR} || ! -d "${CROWSNEST_DIR}/.git" ]] && return
+
+  local commit
+  cd "${CROWSNEST_DIR}"
+  commit="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
+  echo "${commit}"
+}
+
+function get_remote_crowsnest_commit() {
+  [[ ! -d ${CROWSNEST_DIR} || ! -d "${CROWSNEST_DIR}/.git" ]] && return
+
+  local commit
+  cd "${CROWSNEST_DIR}" && git fetch origin -q
+  commit=$(git describe origin/master --always --tags | cut -d "-" -f 1,2)
+  echo "${commit}"
+}
+
+function compare_crowsnest_versions() {
+  local versions local_ver remote_ver
+  local_ver="$(get_local_crowsnest_commit)"
+  remote_ver="$(get_remote_crowsnest_commit)"
+
+  if [[ ${local_ver} != "${remote_ver}" ]]; then
+    versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+    # add moonraker to application_updates_available in kiauh.ini
+    add_to_application_updates "crowsnest"
+  else
+    versions="${green}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+  fi
+
+  echo "${versions}"
+}
+
+function install_crowsnest_dependencies() {
+  local packages log_name="Crowsnest"
+  local install_script="${CROWSNEST_DIR}/tools/install.sh"
+
+  ### read PKGLIST from official install-script
+  status_msg "Reading dependencies..."
+  # shellcheck disable=SC2016
+  packages="$(grep "PKGLIST=" "${install_script}" | cut -d'"' -f2 | sed 's/\${PKGLIST}//g' | tr -d '\n')"
+
+  echo "${cyan}${packages}${white}" | tr '[:space:]' '\n'
+    read -r -a packages <<< "${packages}"
+
+  ### Update system package lists if stale
+  update_system_package_lists
+
+  ### Install required packages
+  install_system_packages "${log_name}" "packages[@]"
+}
+
+function update_crowsnest() {
+  do_action_service "stop" "crowsnest"
+
+  if [[ ! -d ${CROWSNEST_DIR} ]]; then
+    clone_crowsnest
+  else
+    status_msg "Updating Crowsnest ..."
+    cd "${CROWSNEST_DIR}" && git pull
+    ### read PKGLIST and install possible new dependencies
+    install_crowsnest_dependencies
+  fi
+  ok_msg "Update complete!"
+  do_action_service "restart" "crowsnest"
+}

scripts/flash_klipper.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -52,16 +52,57 @@ function init_flash_process() {
     esac
   done
 
-  ### step 2: select how the mcu is connected to the host
+  ### step 2: select how the mcu is flashed (flash/serialflash)
+  select_flash_command
+
+  ### step 3: select how the mcu is connected to the host
   select_mcu_connection
 
-  ### step 3: select which detected mcu should be flashed
+  ### step 4: select which detected mcu should be flashed
   select_mcu_id "${method}"
 }
 
 #================================================#
 #=================== STEP 2 =====================#
 #================================================#
+function select_flash_command() {
+  unset flash_command
+
+  top_border
+  echo -e "| How to flash MCU?                                     |"
+  echo -e "| 1) make flash (default)                               |"
+  echo -e "| 2) make serialflash (stm32flash)                      |"
+  blank_line
+  back_help_footer
+
+  local choice
+  while true; do
+    read -p "${cyan}###### Flashing command:${white} " -i "1" -e choice
+    case "${choice}" in
+      1)
+        select_msg "Selected 'make flash' command"
+        flash_command="flash"
+        break;;
+      2)
+        select_msg "Selected 'make serialflash' command"
+        flash_command="serialflash"
+        break;;
+      B|b)
+        advanced_menu
+        break;;
+      H|h)
+        clear && print_header
+        show_mcu_flash_command_help
+        break;;
+      *)
+        error_msg "Invalid command!";;
+    esac
+  done
+}
+
+#================================================#
+#=================== STEP 3 =====================#
+#================================================#
 function select_mcu_connection() {
   top_border
   echo -e "| ${yellow}Make sure that the controller board is connected now!${white} |"
@@ -70,6 +111,7 @@ function select_mcu_connection() {
   echo -e "| How is the controller board connected to the host?    |"
   echo -e "| 1) USB                                                |"
   echo -e "| 2) UART                                               |"
+  echo -e "| 3) USB (DFU mode)                                     |"
   blank_line
   back_help_footer
 
@@ -85,6 +127,10 @@ function select_mcu_connection() {
         status_msg "Identifying MCU possibly connected via UART ...\n"
         get_uart_id || true # continue even after exit code 1
         break;;
+      3)
+        status_msg "Identifying MCU connected via USB in DFU mode ...\n"
+        get_dfu_id || true # continue even after exit code 1
+        break;;
       B|b)
         advanced_menu
         break;;
@@ -102,12 +148,11 @@ function print_detected_mcu_to_screen() {
   local i=1
 
   if (( ${#mcu_list[@]} < 1 )); then
-    print_error "No MCU found!\n MCU eihter not connected or not detected!"
+    print_error "No MCU found!\n MCU either not connected or not detected!"
     return
   fi
 
   for mcu in "${mcu_list[@]}"; do
-    mcu=$(echo "${mcu}" | rev | cut -d"/" -f1 | rev)
     echo -e " ● MCU #${i}: ${cyan}${mcu}${white}"
     i=$(( i + 1 ))
   done
@@ -115,13 +160,13 @@ function print_detected_mcu_to_screen() {
 }
 
 #================================================#
-#=================== STEP 3 =====================#
+#=================== STEP 4 =====================#
 #================================================#
 function select_mcu_id() {
   local i=0 sel_index=0 method=${1}
 
   if (( ${#mcu_list[@]} < 1 )); then
-    print_error "No MCU found!\n MCU eihter not connected or not detected!"
+    print_error "No MCU found!\n MCU either not connected or not detected!"
     return
   fi
 
@@ -190,7 +235,7 @@ function start_flash_mcu() {
   local device=${1}
   do_action_service "stop" "klipper"
 
-  if make flash FLASH_DEVICE="${device}"; then
+  if make ${flash_command} FLASH_DEVICE="${device}"; then
     ok_msg "Flashing successfull!"
   else
     warn_msg "Flashing failed!"
@@ -329,6 +374,16 @@ function get_uart_id() {
   done
 }
 
+function get_dfu_id() {
+  unset mcu_list
+  sleep 1
+  mcus=$(lsusb | grep "DFU" | cut -d " " -f 6 2>/dev/null)
+
+  for mcu in ${mcus}; do
+    mcu_list+=("${mcu}")
+  done
+}
+
 function show_flash_method_help() {
   top_border
   echo -e "|     ~~~~~~~~ < ? > Help: Flash MCU < ? > ~~~~~~~~     |"
@@ -372,6 +427,36 @@ function show_flash_method_help() {
   done
 }
 
+function show_mcu_flash_command_help() {
+  top_border
+  echo -e "|     ~~~~~~~~ < ? > Help: Flash MCU < ? > ~~~~~~~~     |"
+  hr
+  echo -e "| ${cyan}make flash:${white}                                           |"
+  echo -e "| The default command to flash controller board, it     |"
+  echo -e "| will detect selected microcontroller and use suitable |"
+  echo -e "| tool for flashing it.                                 |"
+  blank_line
+  echo -e "| ${cyan}make serialflash:${white}                                     |"
+  echo -e "| Special command to flash STM32 microcontrollers in    |"
+  echo -e "| DFU mode but connected via serial. stm32flash command |"
+  echo -e "| will be used internally.                              |"
+  blank_line
+  back_footer
+
+  local choice
+  while true; do
+    read -p "${cyan}###### Please select:${white} " choice
+    case "${choice}" in
+      B|b)
+        clear && print_header
+        select_flash_command
+        break;;
+      *)
+        error_msg "Invalid command!";;
+    esac
+  done
+}
+
 function show_mcu_connection_help() {
   top_border
   echo -e "|     ~~~~~~~~ < ? > Help: Flash MCU < ? > ~~~~~~~~     |"
@@ -406,4 +491,4 @@ function show_mcu_connection_help() {
         error_msg "Invalid command!";;
     esac
   done
-}
+}

scripts/fluidd.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -16,21 +16,35 @@ set -e
 #===================================================#
 
 function install_fluidd() {
-  ### exit early if moonraker not found
   if [[ -z $(moonraker_systemd) ]]; then
-    local error="Moonraker not installed! Please install Moonraker first!"
-    print_error "${error}" && return
+    local error="Moonraker not installed! It's recommended to install Moonraker first!"
+    print_error "${error}"
+    while true; do
+      local yn
+      read -p "${cyan}###### Proceed to install Fluidd without installing Moonraker? (y/N):${white} " yn
+      case "${yn}" in
+        Y|y|Yes|yes)
+          select_msg "Yes"
+          break;;
+        N|n|No|no|"")
+          select_msg "No"
+          abort_msg "Exiting Fluidd setup ...\n"
+          return;;
+        *)
+          error_msg "Invalid Input!";;
+      esac
+    done
   fi
 
   ### checking dependencies
-  local dep=(wget nginx)
+  local dep=(wget nginx unzip)
   dependency_check "${dep[@]}"
   ### detect conflicting Haproxy and Apache2 installations
   detect_conflicting_packages
 
   status_msg "Initializing Fluidd installation ..."
   ### first, we create a backup of the full klipper_config dir - safety first!
-  backup_klipper_config_dir
+  backup_config_dir
 
   ### check for other enabled web interfaces
   unset SET_LISTEN_PORT
@@ -39,30 +53,6 @@ function install_fluidd() {
   ### check if another site already listens to port 80
   fluidd_port_check
 
-  ### ask user to install mjpg-streamer
-  local install_mjpg_streamer
-  if [[ ! -f "${SYSTEMD}/webcamd.service" ]]; then
-    while true; do
-      echo
-      top_border
-      echo -e "| Install MJGP-Streamer for webcam support?             |"
-      bottom_border
-      read -p "${cyan}###### Please select (y/N):${white} " yn
-      case "${yn}" in
-        Y|y|Yes|yes)
-          select_msg "Yes"
-          install_mjpg_streamer="true"
-          break;;
-        N|n|No|no|"")
-          select_msg "No"
-          install_mjpg_streamer="false"
-          break;;
-        *)
-          error_msg "Invalid command!";;
-      esac
-    done
-  fi
-
   ### download fluidd
   download_fluidd
 
@@ -82,9 +72,6 @@ function install_fluidd() {
   ### add fluidd to the update manager in moonraker.conf
   patch_fluidd_update_manager
 
-  ### install mjpg-streamer
-  [[ ${install_mjpg_streamer} == "true" ]] && install_mjpg-streamer
-
   fetch_webui_ports #WIP
 
   ### confirm message
@@ -92,22 +79,21 @@ function install_fluidd() {
 }
 
 function install_fluidd_macros() {
+  local yn
   while true; do
     echo
     top_border
-    echo -e "| It is recommended to have some important macros in    |"
-    echo -e "| your printer configuration to have Fluidd fully       |"
-    echo -e "| functional and working.                               |"
+    echo -e "| It is recommended to use special macros in order to   |"
+    echo -e "| have Fluidd fully functional and working.             |"
     blank_line
     echo -e "| The recommended macros for Fluidd can be found here:  |"
-    echo -e "| https://docs.fluidd.xyz/configuration/initial_setup   |"
+    echo -e "| https://github.com/fluidd-core/fluidd-config           |"
     blank_line
-    echo -e "| If you already have these macros in your config file, |"
-    echo -e "| skip this step and answer with 'no'.                  |"
+    echo -e "| If you already use these macros skip this step.       |"
     echo -e "| Otherwise you should consider to answer with 'yes' to |"
-    echo -e "| add the recommended example macros to your config.    |"
+    echo -e "| download the recommended macros.                      |"
     bottom_border
-    read -p "${cyan}###### Add the recommended macros? (Y/n):${white} " yn
+    read -p "${cyan}###### Download the recommended macros? (Y/n):${white} " yn
     case "${yn}" in
       Y|y|Yes|yes|"")
         select_msg "Yes"
@@ -124,34 +110,64 @@ function install_fluidd_macros() {
 }
 
 function download_fluidd_macros() {
-  local fluidd_cfg="https://raw.githubusercontent.com/fluidd-core/FluiddPI/master/src/modules/fluidd/filesystem/home/pi/klipper_config/fluidd.cfg"
-  local configs path
-  configs=$(find "${KLIPPER_CONFIG}" -type f -name "printer.cfg" | sort)
+  local ms_cfg_repo path configs regex line gcode_dir
 
-  if [[ -n ${configs} ]]; then
-    for config in ${configs}; do
-      path=$(echo "${config}" | rev | cut -d"/" -f2- | rev)
-      if [[ ! -f "${path}/fluidd.cfg" ]]; then
-        status_msg "Downloading fluidd.cfg to ${path} ..."
-        log_info "downloading fluidd.cfg to: ${path}"
-        wget "${fluidd_cfg}" -O "${path}/fluidd.cfg"
+  ms_cfg_repo="https://github.com/fluidd-core/fluidd-config.git"
+  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/printer\.cfg"
+  configs=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)
 
-        ### replace user 'pi' with current username to prevent issues in cases where the user is not called 'pi'
-        log_info "modify fluidd.cfg"
-        sed -i "/^path: \/home\/pi\/gcode_files/ s/\/home\/pi/\/home\/${USER}/" "${path}/fluidd.cfg"
-
-        ### write include to the very first line of the printer.cfg
-        if ! grep -Eq "^[include fluidd.cfg]$" "${path}/printer.cfg"; then
-          log_info "modify printer.cfg"
-          sed -i "1 i [include fluidd.cfg]" "${path}/printer.cfg"
-        fi
-        ok_msg "Done!"
-      fi
-    done
-  else
+  if [[ -z ${configs} ]]; then
+    print_error "No printer.cfg found! Installation of Macros will be skipped ..."
     log_error "execution stopped! reason: no printer.cfg found"
     return
   fi
+
+  status_msg "Cloning fluidd-config ..."
+  [[ -d "${HOME}/fluidd-config" ]] && rm -rf "${HOME}/fluidd-config"
+  if git clone --recurse-submodules "${ms_cfg_repo}" "${HOME}/fluidd-config"; then
+    for config in ${configs}; do
+      path=$(echo "${config}" | rev | cut -d"/" -f2- | rev)
+
+      if [[ -e "${path}/fluidd.cfg" && ! -h "${path}/fluidd.cfg" ]]; then
+        warn_msg "Attention! Existing fluidd.cfg detected!"
+        warn_msg "The file will be renamed to 'fluidd.bak.cfg' to be able to continue with the installation."
+        if ! mv "${path}/fluidd.cfg" "${path}/fluidd.bak.cfg"; then
+          error_msg "Renaming fluidd.cfg failed! Aborting installation ..."
+          return
+        fi
+      fi
+
+      if [[ -h "${path}/fluidd.cfg" ]]; then
+        warn_msg "Recreating symlink in ${path} ..."
+        rm -rf "${path}/fluidd.cfg"
+      fi
+
+      if ! ln -sf "${HOME}/fluidd-config/client.cfg" "${path}/fluidd.cfg"; then
+        error_msg "Creating symlink failed! Aborting installation ..."
+        return
+      fi
+
+      if ! grep -Eq "^\[include fluidd.cfg\]$" "${path}/printer.cfg"; then
+        log_info "${path}/printer.cfg"
+        sed -i "1 i [include fluidd.cfg]" "${path}/printer.cfg"
+      fi
+
+      line=$(($(grep -n "\[include fluidd.cfg\]" "${path}/printer.cfg" | tail -1 | cut -d: -f1) + 1))
+      gcode_dir=${path/config/gcodes}
+      if ! grep -Eq "^\[virtual_sdcard\]$" "${path}/printer.cfg"; then
+        log_info "${path}/printer.cfg"
+        sed -i "${line} i \[virtual_sdcard]\npath: ${gcode_dir}\non_error_gcode: CANCEL_PRINT\n" "${path}/printer.cfg"
+      fi
+    done
+  else
+    print_error "Cloning failed! Aborting installation ..."
+    log_error "execution stopped! reason: cloning failed"
+    return
+  fi
+
+  patch_fluidd_config_update_manager
+
+  ok_msg "Done!"
 }
 
 function download_fluidd() {
@@ -189,7 +205,7 @@ function remove_fluidd_dir() {
   rm -rf "${FLUIDD_DIR}" && ok_msg "Directory removed!"
 }
 
-function remove_fluidd_config() {
+function remove_fluidd_nginx_config() {
   if [[ -e "/etc/nginx/sites-available/fluidd" ]]; then
     status_msg "Removing Fluidd configuration for Nginx ..."
     sudo rm "/etc/nginx/sites-available/fluidd" && ok_msg "File removed!"
@@ -214,8 +230,10 @@ function remove_fluidd_logs() {
 }
 
 function remove_fluidd_log_symlinks() {
-  local files
-  files=$(find "${KLIPPER_LOGS}" -name "fluidd*" 2> /dev/null | sort)
+  local files regex
+
+  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/logs\/fluidd-.*"
+  files=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" 2> /dev/null | sort)
 
   if [[ -n ${files} ]]; then
     for file in ${files}; do
@@ -226,11 +244,34 @@ function remove_fluidd_log_symlinks() {
   fi
 }
 
+function remove_legacy_fluidd_log_symlinks() {
+  local files
+  files=$(find "${HOME}/klipper_logs" -name "fluidd*" 2> /dev/null | sort)
+
+  if [[ -n ${files} ]]; then
+    for file in ${files}; do
+      status_msg "Removing ${file} ..."
+      rm -f "${file}"
+      ok_msg "${file} removed!"
+    done
+  fi
+}
+
+function remove_fluidd_config() {
+  if [[ -d "${HOME}/fluidd-config"  ]]; then
+    status_msg "Removing ${HOME}/fluidd-config ..."
+    rm -rf "${HOME}/fluidd-config"
+    ok_msg "${HOME}/fluidd-config removed!"
+    print_confirm "Fluidd-Config successfully removed!"
+  fi
+}
+
 function remove_fluidd() {
   remove_fluidd_dir
-  remove_fluidd_config
+  remove_fluidd_nginx_config
   remove_fluidd_logs
   remove_fluidd_log_symlinks
+  remove_legacy_fluidd_log_symlinks
 
   ### remove fluidd_port from ~/.kiauh.ini
   sed -i "/^fluidd_port=/d" "${INI_FILE}"
@@ -276,36 +317,40 @@ function get_fluidd_status() {
 }
 
 function get_local_fluidd_version() {
-  [[ ! -f "${FLUIDD_DIR}/.version" ]] && return
-
+  local versionfile="${FLUIDD_DIR}/.version"
+  local relinfofile="${FLUIDD_DIR}/release_info.json"
   local version
-  version=$(head -n 1 "${FLUIDD_DIR}/.version")
+
+  if [[ -f ${relinfofile} ]]; then
+    version=$(grep -o '"version":"[^"]*' "${relinfofile}" | grep -o '[^"]*$')
+  elif [[ -f ${versionfile} ]]; then
+    version=$(head -n 1 "${versionfile}")
+  fi
+
   echo "${version}"
 }
 
 function get_remote_fluidd_version() {
   [[ ! $(dpkg-query -f'${Status}' --show curl 2>/dev/null) = *\ installed ]] && return
 
-  local version
-  version=$(get_fluidd_download_url | rev | cut -d"/" -f2 | rev)
-  echo "${version}"
+  local tags
+  tags=$(curl -s "https://api.github.com/repos/fluidd-core/fluidd/tags" | grep "name" | cut -d'"' -f4)
+  echo "${tags}" | head -1
 }
 
 function compare_fluidd_versions() {
-  unset FLUIDD_UPDATE_AVAIL
   local versions local_ver remote_ver
   local_ver="$(get_local_fluidd_version)"
   remote_ver="$(get_remote_fluidd_version)"
 
-  if [[ ${local_ver} != "${remote_ver}" ]]; then
+  if [[ ${local_ver} != "${remote_ver}" && ${local_ver} != "" ]]; then
     versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
     versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-    # add fluidd to the update all array for the update all function in the updater
-    FLUIDD_UPDATE_AVAIL="true" && update_arr+=(update_fluidd)
+    # add moonraker to application_updates_available in kiauh.ini
+    add_to_application_updates "fluidd"
   else
     versions="${green}$(printf " %-14s" "${local_ver}")${white}"
     versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-    FLUIDD_UPDATE_AVAIL="false"
   fi
 
   echo "${versions}"
@@ -316,25 +361,28 @@ function compare_fluidd_versions() {
 #================================================#
 
 function get_fluidd_download_url() {
-  local tags latest_tag latest_url stable_tag stable_url url
-  tags=$(curl -s "${FLUIDD_TAGS}" | grep "name" | cut -d'"' -f4)
+  local releases_by_tag tags tag unstable_url url
 
-  ### latest download url including pre-releases (alpha, beta, rc)
-  latest_tag=$(echo "${tags}" | head -1)
-  latest_url="https://github.com/fluidd-core/fluidd/releases/download/${latest_tag}/fluidd.zip"
-
-  ### get stable fluidd download url
-  stable_tag=$(echo "${tags}" | grep -E "^v([0-9]+\.?){3}$" | head -1)
-  stable_url="https://github.com/fluidd-core/fluidd/releases/download/${stable_tag}/fluidd.zip"
+  ### latest stable download url
+  url="https://github.com/fluidd-core/fluidd/releases/latest/download/fluidd.zip"
 
   read_kiauh_ini "${FUNCNAME[0]}"
   if [[ ${fluidd_install_unstable} == "true" ]]; then
-    url="${latest_url}"
-    echo "${url}"
-  else
-    url="${stable_url}"
-    echo "${url}"
+    releases_by_tag="https://api.github.com/repos/fluidd-core/fluidd/tags"
+    tags=$(curl -s "${releases_by_tag}" | grep "name" | cut -d'"' -f4)
+    tag=$(echo "${tags}" | head -1)
+
+    ### latest unstable download url including pre-releases (alpha, beta, rc)
+    unstable_url="https://github.com/fluidd-core/fluidd/releases/download/${tag}/fluidd.zip"
+
+    if [[ ${unstable_url} == *"download//"* ]]; then
+      warn_msg "Download URL broken! Falling back to URL of latest stable release!"
+    else
+      url=${unstable_url}
+    fi
   fi
+
+  echo "${url}"
 }
 
 function fluidd_port_check() {
@@ -351,7 +399,7 @@ function fluidd_port_check() {
         select_fluidd_port
       fi
     else
-      DEFAULT_PORT=$(grep listen "${KIAUH_SRCDIR}/resources/klipper_webui_nginx.cfg" | head -1 | sed 's/^\s*//' | cut -d" " -f2 | cut -d";" -f1)
+      DEFAULT_PORT=$(grep listen "${KIAUH_SRCDIR}/resources/fluidd" | head -1 | sed 's/^\s*//' | cut -d" " -f2 | cut -d";" -f1)
       SET_LISTEN_PORT=${DEFAULT_PORT}
     fi
     SET_NGINX_CFG="true"
@@ -371,7 +419,7 @@ function select_fluidd_port() {
     blank_line
     [[ ${MAINSAIL_PORT} == "80" ]] && echo "|  ● Mainsail                                           |"
     blank_line
-    echo -e "| Make sure you don't choose a port which is already    |"
+    echo -e "| Make sure you don't choose a port which was already   |"
     echo -e "| assigned to another webinterface!                     |"
     blank_line
     echo -e "| Be aware: there is ${red}NO${white} sanity check for the following  |"
@@ -397,11 +445,13 @@ function select_fluidd_port() {
 }
 
 function patch_fluidd_update_manager() {
-  local moonraker_configs
-  moonraker_configs=$(find "${KLIPPER_CONFIG}" -type f -name "moonraker.conf" | sort)
+  local patched moonraker_configs regex
+  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/moonraker\.conf"
+  moonraker_configs=$(find "${HOME}" -maxdepth 3 -type f -regextype posix-extended -regex "${regex}" | sort)
 
+  patched="false"
   for conf in ${moonraker_configs}; do
-    if ! grep -Eq "^\[update_manager fluidd\]$" "${conf}"; then
+    if ! grep -Eq "^\[update_manager fluidd\]\s*$" "${conf}"; then
       ### add new line to conf if it doesn't end with one
       [[ $(tail -c1 "${conf}" | wc -l) -eq 0 ]] && echo "" >> "${conf}"
 
@@ -417,5 +467,44 @@ path: ~/fluidd
 MOONRAKER_CONF
 
     fi
+
+    patched="true"
   done
-}
+
+  if [[ ${patched} == "true" ]]; then
+    do_action_service "restart" "moonraker"
+  fi
+}
+
+function patch_fluidd_config_update_manager() {
+  local patched moonraker_configs regex
+  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/moonraker\.conf"
+  moonraker_configs=$(find "${HOME}" -maxdepth 3 -type f -regextype posix-extended -regex "${regex}" | sort)
+
+  patched="false"
+  for conf in ${moonraker_configs}; do
+    if ! grep -Eq "^\[update_manager fluidd-config\]\s*$" "${conf}"; then
+      ### add new line to conf if it doesn't end with one
+      [[ $(tail -c1 "${conf}" | wc -l) -eq 0 ]] && echo "" >> "${conf}"
+
+      ### add Fluidds update manager section to moonraker.conf
+      status_msg "Adding Fluidd-Config to update manager in file:\n       ${conf}"
+      /bin/sh -c "cat >> ${conf}" << MOONRAKER_CONF
+
+[update_manager fluidd-config]
+type: git_repo
+primary_branch: master
+path: ~/fluidd-config
+origin: https://github.com/fluidd-core/fluidd-config.git
+managed_services: klipper
+MOONRAKER_CONF
+
+    fi
+
+    patched="true"
+  done
+
+  if [[ ${patched} == "true" ]]; then
+    do_action_service "restart" "moonraker"
+  fi
+}

scripts/gcode_shell_command.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -103,12 +103,13 @@ function install_gcode_shell_command() {
 
 function create_example_shell_command() {
   ### create a backup of the config folder
-  backup_klipper_config_dir
+  backup_config_dir
 
-  local printer_cfgs path
-  printer_cfgs=$(find "$(get_klipper_cfg_dir)" -type f -name "printer.cfg" | sort)
+  local configs regex path
+  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/printer\.cfg"
+  configs=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)
 
-  for cfg in ${printer_cfgs}; do
+  for cfg in ${configs}; do
     path=$(echo "${cfg}" | rev | cut -d"/" -f2- | rev)
 
     if [[ ! -f "${path}/shell_command.cfg" ]]; then
@@ -119,4 +120,4 @@ function create_example_shell_command() {
       sed -i "1 i [include shell_command.cfg]" "${cfg}"
     fi
   done
-}
+}

scripts/globals.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -34,8 +34,6 @@ function set_globals() {
   KLIPPY_ENV="${HOME}/klippy-env"
   KLIPPER_DIR="${HOME}/klipper"
   KLIPPER_REPO="https://github.com/Klipper3d/klipper.git"
-  KLIPPER_LOGS="${HOME}/klipper_logs"
-  KLIPPER_CONFIG="$(get_klipper_cfg_dir)" # default: ${HOME}/klipper_config
 
   #================= MOONRAKER ==================#
   MOONRAKER_ENV="${HOME}/moonraker-env"
@@ -44,13 +42,9 @@ function set_globals() {
 
   #================= MAINSAIL ===================#
   MAINSAIL_DIR="${HOME}/mainsail"
-  MAINSAIL_REPO_API="https://api.github.com/repos/mainsail-crew/mainsail/releases"
-  MAINSAIL_TAGS="https://api.github.com/repos/mainsail-crew/mainsail/tags"
 
   #================== FLUIDD ====================#
   FLUIDD_DIR="${HOME}/fluidd"
-  FLUIDD_REPO_API="https://api.github.com/repos/fluidd-core/fluidd/releases"
-  FLUIDD_TAGS="https://api.github.com/repos/fluidd-core/fluidd/tags"
 
   #=============== KLIPPERSCREEN ================#
   KLIPPERSCREEN_ENV="${HOME}/.KlipperScreen-env"
@@ -70,4 +64,32 @@ function set_globals() {
   NGINX_SA="/etc/nginx/sites-available"
   NGINX_SE="/etc/nginx/sites-enabled"
   NGINX_CONFD="/etc/nginx/conf.d"
-}
+
+  #=============== MOONRAKER-OBICO ================#
+  MOONRAKER_OBICO_DIR="${HOME}/moonraker-obico"
+  MOONRAKER_OBICO_REPO="https://github.com/TheSpaghettiDetective/moonraker-obico.git"
+
+  #=============== OCTOEVERYWHERE ================#
+  OCTOEVERYWHERE_ENV="${HOME}/octoeverywhere-env"
+  OCTOEVERYWHERE_DIR="${HOME}/octoeverywhere"
+  OCTOEVERYWHERE_REPO="https://github.com/QuinnDamerell/OctoPrint-OctoEverywhere.git"
+
+  #=============== Crowsnest ================#
+  CROWSNEST_DIR="${HOME}/crowsnest"
+  CROWSNEST_REPO="https://github.com/mainsail-crew/crowsnest.git"
+
+  #=============== Mobileraker ================#
+  MOBILERAKER_ENV="${HOME}/mobileraker-env"
+  MOBILERAKER_DIR="${HOME}/mobileraker_companion"
+  MOBILERAKER_REPO="https://github.com/Clon1998/mobileraker_companion.git"
+
+  #=============== OCTOAPP ================#
+  OCTOAPP_ENV="${HOME}/octoapp-env"
+  OCTOAPP_DIR="${HOME}/octoapp"
+  OCTOAPP_REPO="https://github.com/crysxd/OctoApp-Plugin.git"
+
+  #=============== Spoolman ================#
+  SPOOLMAN_DIR="${HOME}/Spoolman"
+  SPOOLMAN_DB_DIR="${HOME}/.local/share/spoolman"
+  SPOOLMAN_REPO="https://api.github.com/repos/Donkie/Spoolman/releases/latest"
+}

scripts/klipper.sh

@@ -1,61 +1,183 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
 
 set -e
 
+#TODO (multi instance):
+# if the klipper installer is started another time while other klipper
+# instances are detected, ask if new instances should be added
+
 #=================================================#
 #================ INSTALL KLIPPER ================#
 #=================================================#
 
-### check for existing klipper service installations
-function klipper_initd() {
-  local services
-  services=$(find "${INITD}" -maxdepth 1 -regextype posix-extended -regex "${INITD}/klipper(-[^0])?[0-9]*" | sort)
-  echo "${services}"
-}
-
+###
+# this function detects all installed klipper
+# systemd instances and returns their absolute path
 function klipper_systemd() {
   local services
-  services=$(find "${SYSTEMD}" -maxdepth 1 -regextype posix-extended -regex "${SYSTEMD}/klipper(-[0-9a-zA-Z]+)?.service" | sort)
+  local blacklist
+  local ignore
+  local match
+
+  ###
+  # any service that uses "klipper" in its own name but isn't a full klipper service must be blacklisted using
+  # this variable, otherwise they will be falsely recognized as klipper instances. E.g. "klipper-mcu.service"
+  # is not a klipper service, but related to klippers linux mcu, which also requires its own service file, hence
+  # it must be blacklisted.
+  blacklist="mcu"
+
+  ignore="${SYSTEMD}/klipper-(${blacklist}).service"
+  match="${SYSTEMD}/klipper(-[0-9a-zA-Z]+)?.service"
+
+  services=$(find "${SYSTEMD}" -maxdepth 1 -regextype awk ! -regex "${ignore}" -regex "${match}" | sort)
   echo "${services}"
 }
 
-function klipper_exists() {
-  local services
-  [[ -n $(klipper_initd) ]] && services+="$(klipper_initd) "
-  [[ -n $(klipper_systemd) ]] && services+="$(klipper_systemd)"
-  echo "${services}"
-}
+function start_klipper_setup() {
+  local klipper_systemd_services
+  local python_version
+  local instance_count
+  local instance_names
+  local use_custom_names
+  local input
+  local regex
+  local blacklist
+  local error
 
-function klipper_setup_dialog() {
-  status_msg "Initializing Klipper installation ..."
-
-  local klipper_services
-  local python_version="${1}" user_input=()
-  klipper_services=$(klipper_exists)
-  user_input+=("${python_version}")
+  status_msg "Initializing Klipper installation ...\n"
 
   ### return early if klipper already exists
-  if [[ -n ${klipper_services} ]]; then
-    local error="At least one Klipper service is already installed:"
+  klipper_systemd_services=$(klipper_systemd)
 
-    for s in ${klipper_services}; do
+  if [[ -n ${klipper_systemd_services} ]]; then
+    error="At least one Klipper service is already installed:"
+
+    for s in ${klipper_systemd_services}; do
       log_info "Found Klipper service: ${s}"
       error="${error}\n ➔ ${s}"
     done
+  fi
+  [[ -n ${error} ]] && print_error "${error}" && return
 
-    print_error "${error}" && return
+  ### user selection for python version
+  print_dialog_user_select_python_version
+  while true; do
+    read -p "${cyan}###### Select Python version:${white} " -i "1" -e input
+    case "${input}" in
+      1)
+        select_msg "Python 3.x\n"
+        python_version=3
+        break;;
+      2)
+        select_msg "Python 2.7\n"
+        python_version=2
+        break;;
+      B|b)
+        clear; install_menu; break;;
+      *)
+        error_msg "Invalid Input!\n";;
+    esac
+  done && input=""
+
+  ### user selection for instance count
+  print_dialog_user_select_instance_count
+  regex="^[1-9][0-9]*$"
+  while [[ ! ${input} =~ ${regex} ]]; do
+    read -p "${cyan}###### Number of Klipper instances to set up:${white} " -i "1" -e input
+
+    if [[ ${input} =~ ${regex} ]]; then
+      instance_count="${input}"
+      select_msg "Instance count: ${instance_count}\n"
+      break
+    elif [[ ${input} == "B" || ${input} == "b" ]]; then
+      install_menu
+    else
+      error_msg "Invalid Input!\n"
+    fi
+  done && input=""
+
+  ### user selection for custom names
+  use_custom_names="false"
+  if (( instance_count > 1 )); then
+    print_dialog_user_select_custom_name_bool
+    while true; do
+      read -p "${cyan}###### Assign custom names? (y/N):${white} " input
+      case "${input}" in
+        Y|y|Yes|yes)
+          select_msg "Yes\n"
+          use_custom_names="true"
+          break;;
+        N|n|No|no|"")
+          select_msg "No\n"
+          break;;
+        B|b)
+          clear; install_menu; break;;
+        *)
+          error_msg "Invalid Input!\n";;
+      esac
+    done && input=""
+  else
+    instance_names+=("printer")
   fi
 
-  ### ask for amount of instances to create
+  ### user selection for setting the actual custom names
+  shopt -s nocasematch
+  if (( instance_count > 1 )) && [[ ${use_custom_names} == "true" ]]; then
+    local i
+
+    i=1
+    regex="^[0-9a-zA-Z]+$"
+    blacklist="mcu"
+    while [[ ! ${input} =~ ${regex} || ${input} =~ ${blacklist} || ${i} -le ${instance_count} ]]; do
+      read -p "${cyan}###### Name for instance #${i}:${white} " input
+
+      if [[ ${input} =~ ${blacklist} ]]; then
+        error_msg "Name not allowed! You are trying to use a reserved name."
+      elif [[ ${input} =~ ${regex} && ! ${input} =~ ${blacklist} ]]; then
+        select_msg "Name: ${input}\n"
+        if [[ ${input} =~ ^[0-9]+$ ]]; then
+          instance_names+=("printer_${input}")
+        else
+          instance_names+=("${input}")
+        fi
+        i=$(( i + 1 ))
+      else
+        error_msg "Invalid Input!\n"
+      fi
+    done && input=""
+  elif (( instance_count > 1 )) && [[ ${use_custom_names} == "false" ]]; then
+    for (( i=1; i <= instance_count; i++ )); do
+      instance_names+=("printer_${i}")
+    done
+  fi
+  shopt -u nocasematch
+
+  (( instance_count > 1 )) && status_msg "Installing ${instance_count} Klipper instances ..."
+  (( instance_count == 1 )) && status_msg "Installing single Klipper instance ..."
+
+  run_klipper_setup "${python_version}" "${instance_names[@]}"
+}
+
+function print_dialog_user_select_python_version() {
+  top_border
+  echo -e "| Please select your preferred Python version.          | "
+  echo -e "| The recommended version is Python 3.x.                | "
+  hr
+  echo -e "|  1) [Python 3.x]  (recommended)                       | "
+  echo -e "|  2) [Python 2.7]  ${yellow}(legacy)${white}                            | "
+  back_footer
+}
+
+function print_dialog_user_select_instance_count() {
   top_border
   echo -e "| Please select the number of Klipper instances to set  |"
   echo -e "| up. The number of Klipper instances will determine    |"
@@ -63,177 +185,38 @@ function klipper_setup_dialog() {
   blank_line
   echo -e "| ${yellow}WARNING:${white}                                              |"
   echo -e "| ${yellow}Setting up too many instances may crash your system.${white}  |"
-  bottom_border
-
-  ### ask for amount of instances
-  local klipper_count re="^[1-9][0-9]*$"
-  while [[ ! ${klipper_count} =~ ${re} ]]; do
-    read -p "${cyan}###### Number of Klipper instances to set up:${white} " -i "1" -e klipper_count
-    ### break if input is valid
-    [[ ${klipper_count} =~ ${re} ]] && break
-    ### error messages on invalid input
-    error_msg "Input not a number"
-  done && select_msg "${klipper_count}"
-
-  user_input+=("${klipper_count}")
-
-  ### confirm instance amount
-  local yn
-  while true; do
-    read -p "${cyan}###### Install ${klipper_count} instance(s)? (Y/n):${white} " yn
-    case "${yn}" in
-      Y|y|Yes|yes|"")
-        select_msg "Yes"
-        break;;
-      N|n|No|no)
-        select_msg "No"
-        abort_msg "Exiting Klipper setup ...\n"
-        return;;
-      *)
-        error_msg "Invalid Input!";;
-    esac
-  done
-
-  ### ask for custom names
-  if (( klipper_count > 1 )); then
-    local custom_names="false"
-    top_border
-    echo -e "| You can give each instance a custom name or skip.     |"
-    echo -e "| If skipped, KIAUH will automatically assign an index  |"
-    echo -e "| to each instance in ascending order, starting at '1'. |"
-    blank_line
-    echo -e "| Info:                                                 |"
-    echo -e "| Only alphanumeric characters will be allowed.         |"
-    bottom_border
-    while true; do
-      read -p "${cyan}###### Use custom names? (y/N):${white} " yn
-      case "${yn}" in
-        Y|y|Yes|yes)
-          select_msg "Yes"
-          custom_names="true"
-          break;;
-        N|n|No|no|"")
-          select_msg "No"
-          break;;
-        *)
-          error_msg "Invalid Input!";;
-      esac
-    done
-
-    ### get user input for custom names
-    if [[ ${custom_names} == "true" ]]; then
-      local i=1 name re="^[0-9a-zA-Z]+$"
-      while [[ ! ${name} =~ ${re} || ${i} -le ${klipper_count} ]]; do
-        read -p "${cyan}###### Name for instance #${i}:${white} " name
-        if [[ ${name} =~ ${re} ]]; then
-          select_msg "Name: ${name}"
-          user_input+=("${name}")
-          i=$(( i + 1 ))
-        else
-          error_msg "Invalid Input!"
-        fi
-      done
-    else
-      ### if no custom names are used, add the respective amount of indices to the user_input array
-      for (( i=1; i <= klipper_count; i++ )); do
-        user_input+=("${i}")
-      done
-    fi
-  fi
-
-
-  (( klipper_count > 1 )) && status_msg "Installing ${klipper_count} Klipper instances ..."
-  (( klipper_count == 1 )) && status_msg "Installing single Klipper instance ..."
-
-  klipper_setup "${user_input[@]}"
+  back_footer
 }
 
-function install_klipper_packages() {
-  local packages python_version="${1}"
-  local install_script="${KLIPPER_DIR}/scripts/install-debian.sh"
-
-  status_msg "Reading dependencies..."
-  # shellcheck disable=SC2016
-  packages=$(grep "PKGLIST=" "${install_script}" | cut -d'"' -f2 | sed 's/\${PKGLIST}//g' | tr -d '\n')
-  ### add dfu-util for octopi-images
-  packages+=" dfu-util"
-  ### add dbus requirement for DietPi distro
-  [[ -e "/boot/dietpi/.version" ]] && packages+=" dbus"
-
-  if [[ ${python_version} == "python3" ]]; then
-    ### replace python-dev with python3-dev if python3 was selected
-    packages="${packages//python-dev/python3-dev}"
-  else
-    ### package name 'python-dev' is deprecated (-> no installation candidate) on more modern linux distros
-    packages="${packages//python-dev/python2-dev}"
-  fi
-
-  echo "${cyan}${packages}${white}" | tr '[:space:]' '\n'
-  read -r -a packages <<< "${packages}"
-
-  ### Update system package info
-  status_msg "Updating package lists..."
-  if ! sudo apt-get update --allow-releaseinfo-change; then
-    log_error "failure while updating package lists"
-    error_msg "Updating package lists failed!"
-    exit 1
-  fi
-
-  ### Install required packages
-  status_msg "Installing required packages..."
-  if ! sudo apt-get install --yes "${packages[@]}"; then
-    log_error "failure while installing required klipper packages"
-    error_msg "Installing required packages failed!"
-    exit 1
-  fi
+function print_dialog_user_select_custom_name_bool() {
+  top_border
+  echo -e "| You can now assign a custom name to each instance.    |"
+  echo -e "| If skipped, each instance will get an index assigned  |"
+  echo -e "| in ascending order, starting at index '1'.            |"
+  blank_line
+  echo -e "| Info:                                                 |"
+  echo -e "| Only alphanumeric characters for names are allowed!   |"
+  back_footer
 }
 
-function create_klipper_virtualenv() {
-  local python_version="${1}"
-
-  [[ ${python_version} == "python2" ]] && \
-  status_msg "Installing $(python2 -V) virtual environment..."
-
-  [[ ${python_version} == "python3" ]] && \
-  status_msg "Installing $(python3 -V) virtual environment..."
-
-  ### remove klippy-env if it already exists
-  [[ -d ${KLIPPY_ENV} ]] && rm -rf "${KLIPPY_ENV}"
-
-  if [[ ${python_version} == "python2" ]]; then
-    if virtualenv -p python2 "${KLIPPY_ENV}"; then
-      "${KLIPPY_ENV}"/bin/pip install -r "${KLIPPER_DIR}"/scripts/klippy-requirements.txt
-    else
-      log_error "failure while creating python2 klippy-env"
-      error_msg "Creation of Klipper virtualenv failed!"
-      exit 1
-    fi
-  fi
-
-  if [[ ${python_version} == "python3" ]]; then
-    if virtualenv -p python3 "${KLIPPY_ENV}"; then
-      "${KLIPPY_ENV}"/bin/pip install -U pip
-      "${KLIPPY_ENV}"/bin/pip install -r "${KLIPPER_DIR}"/scripts/klippy-requirements.txt
-    else
-      log_error "failure while creating python3 klippy-env"
-      error_msg "Creation of Klipper virtualenv failed!"
-      exit 1
-    fi
-  fi
-
-  return
-}
-
-function klipper_setup() {
+function run_klipper_setup() {
   read_kiauh_ini "${FUNCNAME[0]}"
-  ### index 0: python version, index 1: instance count, index 2-n: instance names (optional)
-  local user_input=("${@}")
-  local python_version="${user_input[0]}" && unset "user_input[0]"
-  local instance_arr=("${user_input[@]}") && unset "user_input[@]"
-  local custom_repo="${custom_klipper_repo}"
-  local custom_branch="${custom_klipper_repo_branch}"
+
+  local python_version=${1}
+  local instance_names
+  local confirm
+  local custom_repo
+  local custom_branch
+  local dep
+
+  shift 1
+  read -r -a instance_names <<< "${@}"
+
+  custom_repo="${custom_klipper_repo}"
+  custom_branch="${custom_klipper_repo_branch}"
+  dep=(git)
+
   ### checking dependencies
-  local dep=(git)
   dependency_check "${dep[@]}"
 
   ### step 1: clone klipper
@@ -243,24 +226,25 @@ function klipper_setup() {
   install_klipper_packages "${python_version}"
   create_klipper_virtualenv "${python_version}"
 
-  ### step 3: create gcode_files and logs folder
-  [[ ! -d "${HOME}/gcode_files" ]] && mkdir -p "${HOME}/gcode_files"
-  [[ ! -d ${KLIPPER_LOGS} ]] && mkdir -p "${KLIPPER_LOGS}"
+  ### step 3: create klipper instances
+  for instance in "${instance_names[@]}"; do
+    create_klipper_service "${instance}"
+  done
 
-  ### step 4: create klipper instances
-  create_klipper_service "${instance_arr[@]}"
-
-  ### step 5: enable and start all instances
+  ### step 4: enable and start all instances
   do_action_service "enable" "klipper"
   do_action_service "start" "klipper"
 
-  ### step 6: check for dialout group membership
+  ### step 5: check for dialout group membership
   check_usergroups
 
   ### confirm message
-  local confirm=""
-  (( instance_arr[0] == 1 )) && confirm="Klipper has been set up!"
-  (( instance_arr[0] > 1 )) && confirm="${instance_arr[0]} Klipper instances have been set up!"
+  (( ${#instance_names[@]} == 1 )) && confirm="Klipper has been set up!"
+  (( ${#instance_names[@]} > 1 )) && confirm="${#instance_names[@]} Klipper instances have been set up!"
+
+  ### finalizing the setup with writing instance names to the kiauh.ini
+  set_multi_instance_names
+  mask_disrupting_services
 
   print_confirm "${confirm}" && return
 }
@@ -288,81 +272,130 @@ function clone_klipper() {
   fi
 }
 
-function write_klipper_service() {
-  local i=${1} cfg=${2} log=${3} printer=${4} uds=${5} service=${6}
-  local service_template="${KIAUH_SRCDIR}/resources/klipper.service"
+function create_klipper_virtualenv() {
+  local python_version="${1}"
+
+  [[ -d ${KLIPPY_ENV} ]] && rm -rf "${KLIPPY_ENV}"
+
+  status_msg "Installing $("python${python_version}" -V) virtual environment..."
+
+  if virtualenv -p "python${python_version}" "${KLIPPY_ENV}"; then
+    "${KLIPPY_ENV}"/bin/pip install -r "${KLIPPER_DIR}"/scripts/klippy-requirements.txt
+  else
+    log_error "failure while creating python3 klippy-env"
+    error_msg "Creation of Klipper virtualenv failed!"
+    exit 1
+  fi
+}
+
+###
+# extracts the required packages from the
+# install-debian.sh script and installs them
+#
+# @param {string}: python_version - klipper-env python version
+#
+function install_klipper_packages() {
+  local packages log_name="Klipper" python_version="${1}"
+  local install_script="${KLIPPER_DIR}/scripts/install-debian.sh"
+
+  status_msg "Reading dependencies..."
+  # shellcheck disable=SC2016
+  packages=$(grep "PKGLIST=" "${install_script}" | cut -d'"' -f2 | sed 's/\${PKGLIST}//g' | tr -d '\n')
+  ### add dfu-util for octopi-images
+  packages+=" dfu-util"
+  ### add pkg-config for rp2040 build
+  packages+=" pkg-config"
+  ### add dbus requirement for DietPi distro
+  [[ -e "/boot/dietpi/.version" ]] && packages+=" dbus"
+
+  if (( python_version == 3 )); then
+    ### replace python-dev with python3-dev if python3 was selected
+    packages="${packages//python-dev/python3-dev}"
+  elif (( python_version == 2 )); then
+    ### package name 'python-dev' is deprecated (-> no installation candidate) on more modern linux distros
+    packages="${packages//python-dev/python2-dev}"
+  else
+    log_error "Internal Error: missing parameter 'python_version' during function call of ${FUNCNAME[0]}"
+    error_msg "Internal Error: missing parameter 'python_version' during function call of ${FUNCNAME[0]}"
+    exit 1
+  fi
+
+  echo "${cyan}${packages}${white}" | tr '[:space:]' '\n'
+  read -r -a packages <<< "${packages}"
+
+  ### Update system package lists if stale
+  update_system_package_lists
+
+  ### Install required packages
+  install_system_packages "${log_name}" "packages[@]"
+}
+
+function create_klipper_service() {
+  local instance_name=${1}
+
+  local printer_data
+  local cfg_dir
+  local gcodes_dir
+  local cfg
+  local log
+  local klippy_serial
+  local klippy_socket
+  local env_file
+  local service
+  local service_template
+  local env_template
+  local suffix
+
+  printer_data="${HOME}/${instance_name}_data"
+  cfg_dir="${printer_data}/config"
+  gcodes_dir="${printer_data}/gcodes"
+  cfg="${cfg_dir}/printer.cfg"
+  log="${printer_data}/logs/klippy.log"
+  klippy_serial="${printer_data}/comms/klippy.serial"
+  klippy_socket="${printer_data}/comms/klippy.sock"
+  env_file="${printer_data}/systemd/klipper.env"
+
+  if [[ ${instance_name} == "printer" ]]; then
+    suffix="${instance_name//printer/}"
+  else
+    suffix="-${instance_name//printer_/}"
+  fi
+
+  create_required_folders "${printer_data}"
+
+  service_template="${KIAUH_SRCDIR}/resources/klipper.service"
+  env_template="${KIAUH_SRCDIR}/resources/klipper.env"
+  service="${SYSTEMD}/klipper${suffix}.service"
 
-  ### replace all placeholders
   if [[ ! -f ${service} ]]; then
-    status_msg "Creating Klipper Service ${i} ..."
+    status_msg "Create Klipper service file ..."
+
     sudo cp "${service_template}" "${service}"
-    [[ -z ${i} ]] && sudo sed -i "s| for instance klipper-%INST%||" "${service}"
-    [[ -n ${i} ]] && sudo sed -i "s|%INST%|${i}|" "${service}"
-    sudo sed -i "s|%USER%|${USER}|; s|%ENV%|${KLIPPY_ENV}|; s|%DIR%|${KLIPPER_DIR}|" "${service}"
-    sudo sed -i "s|%LOG%|${log}|; s|%CFG%|${cfg}|; s|%PRINTER%|${printer}|; s|%UDS%|${uds}|" "${service}"
+    sudo cp "${env_template}" "${env_file}"
+    sudo sed -i "s|%USER%|${USER}|g; s|%KLIPPER_DIR%|${KLIPPER_DIR}|; s|%ENV%|${KLIPPY_ENV}|; s|%ENV_FILE%|${env_file}|" "${service}"
+    sudo sed -i "s|%USER%|${USER}|; s|%KLIPPER_DIR%|${KLIPPER_DIR}|; s|%LOG%|${log}|; s|%CFG%|${cfg}|; s|%PRINTER%|${klippy_serial}|; s|%UDS%|${klippy_socket}|" "${env_file}"
+
+    ok_msg "Klipper service file created!"
+  fi
+
+  if [[ ! -f ${cfg} ]]; then
+    write_example_printer_cfg "${cfg}" "${gcodes_dir}"
   fi
 }
 
 function write_example_printer_cfg() {
-  local cfg_dir=${1} cfg=${2}
-  local cfg_template="${KIAUH_SRCDIR}/resources/printer.cfg"
+  local cfg=${1}
+  local gcodes_dir=${2}
+  local cfg_template
 
-  ### create a config directory if it doesn't exist
-  if [[ ! -d ${cfg_dir} ]]; then
-    status_msg "Creating '${cfg_dir}' ..."
-    mkdir -p "${cfg_dir}"
-  fi
-
-  ### create a minimal config if there is no printer.cfg
-  if [[ ! -f ${cfg} ]]; then
-    status_msg "Creating minimal example printer.cfg ..."
-    cp "${cfg_template}" "${cfg}"
-  fi
-}
-
-function create_klipper_service() {
-  local input=("${@}")
-  local klipper_count=${input[0]} && unset "input[0]"
-  local names=("${input[@]}") && unset "input[@]"
-  local cfg_dir cfg log printer uds service
-
-  if (( klipper_count == 1 )) && [[ ${#names[@]} -eq 0 ]]; then
-    cfg_dir="${KLIPPER_CONFIG}"
-    cfg="${cfg_dir}/printer.cfg"
-    log="${KLIPPER_LOGS}/klippy.log"
-    printer="/tmp/printer"
-    uds="/tmp/klippy_uds"
-    service="${SYSTEMD}/klipper.service"
-    ### write single instance service
-    write_klipper_service "" "${cfg}" "${log}" "${printer}" "${uds}" "${service}"
-    write_example_printer_cfg "${cfg_dir}" "${cfg}"
-    ok_msg "Klipper instance created!"
-
-  elif (( klipper_count >= 1 )) && [[ ${#names[@]} -gt 0 ]]; then
-    local j=0 re="^[1-9][0-9]*$"
-
-    for (( i=1; i <= klipper_count; i++ )); do
-      ### overwrite config folder if name is only a number
-      if [[ ${names[j]} =~ ${re} ]]; then
-        cfg_dir="${KLIPPER_CONFIG}/printer_${names[${j}]}"
-      else
-        cfg_dir="${KLIPPER_CONFIG}/${names[${j}]}"
-      fi
-
-      cfg="${cfg_dir}/printer.cfg"
-      log="${KLIPPER_LOGS}/klippy-${names[${j}]}.log"
-      printer="/tmp/printer-${names[${j}]}"
-      uds="/tmp/klippy_uds-${names[${j}]}"
-      service="${SYSTEMD}/klipper-${names[${j}]}.service"
-      ### write multi instance service
-      write_klipper_service "${names[${j}]}" "${cfg}" "${log}" "${printer}" "${uds}" "${service}"
-      write_example_printer_cfg "${cfg_dir}" "${cfg}"
-      ok_msg "Klipper instance 'klipper-${names[${j}]}' created!"
-      j=$(( j + 1 ))
-    done && unset j
+  cfg_template="${KIAUH_SRCDIR}/resources/example.printer.cfg"
 
+  status_msg "Creating minimal example printer.cfg ..."
+  if cp "${cfg_template}" "${cfg}"; then
+    sed -i "s|%GCODES_DIR%|${gcodes_dir}|" "${cfg}"
+    ok_msg "Minimal example printer.cfg created!"
   else
-    return 1
+    error_msg "Couldn't create minimal example printer.cfg!"
   fi
 }
 
@@ -370,71 +403,53 @@ function create_klipper_service() {
 #================ REMOVE KLIPPER ================#
 #================================================#
 
-function remove_klipper_sysvinit() {
-  [[ ! -e "${INITD}/klipper" ]] && return
-
-  status_msg "Removing Klipper SysVinit service ..."
-  sudo systemctl stop klipper
-  sudo update-rc.d -f klipper remove
-  sudo rm -f "${INITD}/klipper" "${ETCDEF}/klipper"
-  ok_msg "Klipper SysVinit service removed!"
-}
-
-function remove_klipper_systemd() {
+function remove_klipper_service() {
   [[ -z $(klipper_systemd) ]] && return
 
-  status_msg "Removing Klipper Systemd Services ..."
+  status_msg "Removing Klipper services ..."
+
   for service in $(klipper_systemd | cut -d"/" -f5); do
     status_msg "Removing ${service} ..."
     sudo systemctl stop "${service}"
     sudo systemctl disable "${service}"
     sudo rm -f "${SYSTEMD}/${service}"
-    ok_msg "Done!"
+    sudo systemctl daemon-reload
+    sudo systemctl reset-failed
   done
 
-  ### reloading units
-  sudo systemctl daemon-reload
-  sudo systemctl reset-failed
-  ok_msg "Klipper Service removed!"
+  ok_msg "All Klipper services removed!"
 }
 
-function remove_klipper_logs() {
-  local files regex="klippy(-[0-9a-zA-Z]+)?\.log(.*)?"
-  files=$(find "${KLIPPER_LOGS}" -maxdepth 1 -regextype posix-extended -regex "${KLIPPER_LOGS}/${regex}" 2> /dev/null | sort)
-
-  if [[ -n ${files} ]]; then
-    for file in ${files}; do
-      status_msg "Removing ${file} ..."
-      rm -f "${file}"
-      ok_msg "${file} removed!"
-    done
-  fi
-}
-
-function remove_klipper_uds() {
-  local files
-  files=$(find /tmp -maxdepth 1 -regextype posix-extended -regex "/tmp/klippy_uds(-[0-9a-zA-Z]+)?" | sort)
-
-  if [[ -n ${files} ]]; then
-    for file in ${files}; do
-      status_msg "Removing ${file} ..."
-      rm -f "${file}"
-      ok_msg "${file} removed!"
-    done
-  fi
-}
-
-function remove_klipper_printer() {
+function find_instance_files() {
+  local target_folder=${1}
+  local target_name=${2}
   local files
 
-  files=$(find /tmp -maxdepth 1 -regextype posix-extended -regex "/tmp/printer(-[0-9a-zA-Z]+)?" | sort)
-  if [[ -n ${files} ]]; then
-    for file in ${files}; do
-      status_msg "Removing ${file} ..."
-      rm -f "${file}"
-      ok_msg "${file} removed!"
-    done
-  fi
+  readarray -t files < <(find "${HOME}" -regex "${HOME}/[A-Za-z0-9_]+_data/${target_folder}/${target_name}" | sort)
+
+  echo -e "${files[@]}"
+}
+
+function find_legacy_klipper_logs() {
+  local files
+  local regex="klippy(-[0-9a-zA-Z]+)?\.log(.*)?"
+
+  readarray -t files < <(find "${HOME}/klipper_logs" -maxdepth 1 -regextype posix-extended -regex "${HOME}/klipper_logs/${regex}" 2> /dev/null | sort)
+  echo -e "${files[@]}"
+}
+
+function find_legacy_klipper_uds() {
+  local files
+
+  readarray -t files < <(find /tmp -maxdepth 1 -regextype posix-extended -regex "/tmp/klippy_uds(-[0-9a-zA-Z]+)?" | sort)
+  echo -e "${files[@]}"
+}
+
+function find_legacy_klipper_printer() {
+  local files
+
+  readarray -t files < <(find /tmp -maxdepth 1 -regextype posix-extended -regex "/tmp/printer(-[0-9a-zA-Z]+)?" | sort)
+  echo -e "${files[@]}"
 }
 
 function remove_klipper_dir() {
@@ -453,38 +468,68 @@ function remove_klipper_env() {
   ok_msg "Directory removed!"
 }
 
+###
+# takes in a string of space separated absolute
+# filepaths and removes those files one after another
+#
+function remove_files() {
+  local files
+  read -r -a files <<< "${@}"
+
+  if (( ${#files[@]} > 0 )); then
+    for file in "${files[@]}"; do
+      status_msg "Removing ${file} ..."
+      rm -f "${file}"
+      ok_msg "${file} removed!"
+    done
+  fi
+}
+
 function remove_klipper() {
-  remove_klipper_sysvinit
-  remove_klipper_systemd
-  remove_klipper_logs
-  remove_klipper_uds
-  remove_klipper_printer
+  remove_klipper_service
+  remove_files "$(find_instance_files "systemd" "klipper.env")"
+  remove_files "$(find_instance_files "logs" "klippy.log.*")"
+  remove_files "$(find_instance_files "comms" "klippy.sock")"
+  remove_files "$(find_instance_files "comms" "klippy.serial")"
+
+  remove_files "$(find_legacy_klipper_logs)"
+  remove_files "$(find_legacy_klipper_uds)"
+  remove_files "$(find_legacy_klipper_printer)"
+
   remove_klipper_dir
   remove_klipper_env
 
-  local confirm="Klipper was successfully removed!"
-  print_confirm "${confirm}" && return
+  print_confirm "Klipper was successfully removed!" && return
 }
 
 #================================================#
 #================ UPDATE KLIPPER ================#
 #================================================#
 
+###
+# stops klipper, performs a git pull, installs
+# possible new dependencies, then restarts klipper
+#
 function update_klipper() {
   read_kiauh_ini "${FUNCNAME[0]}"
+
+  local py_ver
   local custom_repo="${custom_klipper_repo}"
   local custom_branch="${custom_klipper_repo_branch}"
 
+  py_ver=$(get_klipper_python_ver)
+
   do_action_service "stop" "klipper"
 
   if [[ ! -d ${KLIPPER_DIR} ]]; then
     clone_klipper "${custom_repo}" "${custom_branch}"
   else
     backup_before_update "klipper"
+
     status_msg "Updating Klipper ..."
     cd "${KLIPPER_DIR}" && git pull
     ### read PKGLIST and install possible new dependencies
-    install_klipper_packages
+    install_klipper_packages "${py_ver}"
     ### install possible new python dependencies
     "${KLIPPY_ENV}"/bin/pip install -r "${KLIPPER_DIR}/scripts/klippy-requirements.txt"
   fi
@@ -501,12 +546,6 @@ function get_klipper_status() {
   local sf_count status py_ver
   sf_count="$(klipper_systemd | wc -w)"
 
-  ### detect an existing "legacy" klipper init.d installation
-  if [[ $(klipper_systemd | wc -w) -eq 0 ]] \
-  && [[ $(klipper_initd | wc -w) -ge 1 ]]; then
-    sf_count=1
-  fi
-
   py_ver=$(get_klipper_python_ver)
 
   ### remove the "SERVICE" entry from the data array if a klipper service is installed
@@ -547,13 +586,18 @@ function get_remote_klipper_commit() {
   [[ ! -d ${KLIPPER_DIR} || ! -d "${KLIPPER_DIR}/.git" ]] && return
 
   local commit
+  local branch
+
+  read_kiauh_ini "${FUNCNAME[0]}"
+  branch="${custom_klipper_repo_branch}"
+  [[ -z ${branch} ]] && branch="master"
+
   cd "${KLIPPER_DIR}" && git fetch origin -q
-  commit=$(git describe origin/master --always --tags | cut -d "-" -f 1,2)
+  commit=$(git describe "origin/${branch}" --always --tags | cut -d "-" -f 1,2)
   echo "${commit}"
 }
 
 function compare_klipper_versions() {
-  unset KLIPPER_UPDATE_AVAIL
   local versions local_ver remote_ver
   local_ver="$(get_local_klipper_commit)"
   remote_ver="$(get_remote_klipper_commit)"
@@ -561,12 +605,11 @@ function compare_klipper_versions() {
   if [[ ${local_ver} != "${remote_ver}" ]]; then
     versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
     versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-    # add klipper to the update all array for the update all function in the updater
-    KLIPPER_UPDATE_AVAIL="true" && update_arr+=(update_klipper)
+    # add klipper to application_updates_available in kiauh.ini
+    add_to_application_updates "klipper"
   else
     versions="${green}$(printf " %-14s" "${local_ver}")${white}"
     versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-    KLIPPER_UPDATE_AVAIL="false"
   fi
 
   echo "${versions}"
@@ -576,24 +619,46 @@ function compare_klipper_versions() {
 #=================== HELPERS ====================#
 #================================================#
 
-function get_klipper_cfg_dir() {
-  local cfg_dir
-  read_kiauh_ini "${FUNCNAME[0]}"
-
-  if [[ -z ${custom_klipper_cfg_loc} ]]; then
-    cfg_dir="${HOME}/klipper_config"
-  else
-    cfg_dir="${custom_klipper_cfg_loc}"
-  fi
-
-  echo "${cfg_dir}"
-}
-
-### returns the major python version the klippy-env was created with
+###
+# reads the python version from the klipper virtual environment
+#
+# @output: writes the python major version to STDOUT
+#
 function get_klipper_python_ver() {
   [[ ! -d ${KLIPPY_ENV} ]] && return
 
   local version
   version=$("${KLIPPY_ENV}"/bin/python --version 2>&1 | cut -d" " -f2 | cut -d"." -f1)
   echo "${version}"
-}
+}
+
+function mask_disrupting_services() {
+  local brltty="false"
+  local brltty_udev="false"
+  local modem_manager="false"
+
+  [[ $(dpkg -s brltty  2>/dev/null | grep "Status") = *\ installed ]] && brltty="true"
+  [[ $(dpkg -s brltty-udev  2>/dev/null | grep "Status") = *\ installed ]] && brltty_udev="true"
+  [[ $(dpkg -s ModemManager  2>/dev/null | grep "Status") = *\ installed ]] && modem_manager="true"
+
+  status_msg "Installed brltty package detected, masking brltty service ..."
+  if [[ ${brltty} == "true" ]]; then
+    sudo systemctl stop brltty
+    sudo systemctl mask brltty
+  fi
+  ok_msg "brltty service masked!"
+
+  status_msg "Installed brltty-udev package detected, masking brltty-udev service ..."
+  if [[ ${brltty_udev} == "true" ]]; then
+    sudo systemctl stop brltty-udev
+    sudo systemctl mask brltty-udev
+  fi
+  ok_msg "brltty-udev service masked!"
+
+  status_msg "Installed ModemManager package detected, masking ModemManager service ..."
+  if [[ ${modem_manager} == "true" ]]; then
+    sudo systemctl stop ModemManager
+    sudo systemctl mask ModemManager
+  fi
+  ok_msg "ModemManager service masked!"
+}

scripts/klipperscreen.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -30,7 +30,7 @@ function install_klipperscreen() {
   fi
 
   ### first, we create a backup of the full klipper_config dir - safety first!
-  backup_klipper_config_dir
+  backup_config_dir
 
   ### install KlipperScreen
   klipperscreen_setup
@@ -119,12 +119,14 @@ function update_klipperscreen() {
   old_md5=$(md5sum "${KLIPPERSCREEN_DIR}/scripts/KlipperScreen-requirements.txt" | cut -d " " -f1)
 
   do_action_service "stop" "KlipperScreen"
+  backup_before_update "klipperscreen"
+
   cd "${KLIPPERSCREEN_DIR}"
   git pull origin master -q && ok_msg "Fetch successfull!"
   git checkout -f master && ok_msg "Checkout successfull"
 
   if [[ $(md5sum "${KLIPPERSCREEN_DIR}/scripts/KlipperScreen-requirements.txt" | cut -d " " -f1) != "${old_md5}" ]]; then
-    status_msg "New dependecies detected..."
+    status_msg "New dependencies detected..."
     "${KLIPPERSCREEN_ENV}"/bin/pip install -r "${KLIPPERSCREEN_DIR}/scripts/KlipperScreen-requirements.txt"
     ok_msg "Dependencies have been installed!"
   fi
@@ -180,7 +182,6 @@ function get_remote_klipperscreen_commit() {
 }
 
 function compare_klipperscreen_versions() {
-  unset KLIPPERSCREEN_UPDATE_AVAIL
   local versions local_ver remote_ver
   local_ver="$(get_local_klipperscreen_commit)"
   remote_ver="$(get_remote_klipperscreen_commit)"
@@ -188,12 +189,11 @@ function compare_klipperscreen_versions() {
   if [[ ${local_ver} != "${remote_ver}" ]]; then
     versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
     versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-    # add klipperscreen to the update all array for the update all function in the updater
-    KLIPPERSCREEN_UPDATE_AVAIL="true" && update_arr+=(update_klipperscreen)
+    # add moonraker to application_updates_available in kiauh.ini
+    add_to_application_updates "klipperscreen"
   else
     versions="${green}$(printf " %-14s" "${local_ver}")${white}"
     versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-    KLIPPERSCREEN_UPDATE_AVAIL="false"
   fi
 
   echo "${versions}"
@@ -204,11 +204,12 @@ function compare_klipperscreen_versions() {
 #================================================#
 
 function patch_klipperscreen_update_manager() {
+  local patched="false"
   local moonraker_configs
   moonraker_configs=$(find "${KLIPPER_CONFIG}" -type f -name "moonraker.conf" | sort)
 
   for conf in ${moonraker_configs}; do
-    if ! grep -Eq "^\[update_manager KlipperScreen\]$" "${conf}"; then
+    if ! grep -Eq "^\[update_manager KlipperScreen\]\s*$" "${conf}"; then
       ### add new line to conf if it doesn't end with one
       [[ $(tail -c1 "${conf}" | wc -l) -eq 0 ]] && echo "" >> "${conf}"
 
@@ -226,5 +227,11 @@ install_script: scripts/KlipperScreen-install.sh
 MOONRAKER_CONF
 
     fi
+
+    patched="true"
   done
+
+  if [[ ${patched} == "true" ]]; then
+    do_action_service "restart" "moonraker"
+  fi
 }

scripts/mainsail.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -16,21 +16,35 @@ set -e
 #===================================================#
 
 function install_mainsail() {
-  ### exit early if moonraker not found
   if [[ -z $(moonraker_systemd) ]]; then
-    local error="Moonraker not installed! Please install Moonraker first!"
-    print_error "${error}" && return
+    local error="Moonraker not installed! It's recommended to install Moonraker first!"
+    print_error "${error}"
+    while true; do
+      local yn
+      read -p "${cyan}###### Proceed to install Mainsail without installing Moonraker? (y/N):${white} " yn
+      case "${yn}" in
+        Y|y|Yes|yes)
+          select_msg "Yes"
+          break;;
+        N|n|No|no|"")
+          select_msg "No"
+          abort_msg "Exiting Mainsail setup ...\n"
+          return;;
+        *)
+          error_msg "Invalid Input!";;
+      esac
+    done
   fi
 
   ### checking dependencies
-  local dep=(wget nginx)
+  local dep=(wget nginx unzip)
   dependency_check "${dep[@]}"
   ### detect conflicting Haproxy and Apache2 installations
   detect_conflicting_packages
 
   status_msg "Initializing Mainsail installation ..."
   ### first, we create a backup of the full klipper_config dir - safety first!
-  backup_klipper_config_dir
+  backup_config_dir
 
   ### check for other enabled web interfaces
   unset SET_LISTEN_PORT
@@ -39,30 +53,6 @@ function install_mainsail() {
   ### check if another site already listens to port 80
   mainsail_port_check
 
-  ### ask user to install mjpg-streamer
-  local install_mjpg_streamer
-  if [[ ! -f "${SYSTEMD}/webcamd.service" ]]; then
-    while true; do
-      echo
-      top_border
-      echo -e "| Install MJGP-Streamer for webcam support?             |"
-      bottom_border
-      read -p "${cyan}###### Please select (y/N):${white} " yn
-      case "${yn}" in
-        Y|y|Yes|yes)
-          select_msg "Yes"
-          install_mjpg_streamer="true"
-          break;;
-        N|n|No|no|"")
-          select_msg "No"
-          install_mjpg_streamer="false"
-          break;;
-        *)
-          error_msg "Invalid command!";;
-      esac
-    done
-  fi
-
   ### download mainsail
   download_mainsail
 
@@ -82,9 +72,6 @@ function install_mainsail() {
   ### add mainsail to the update manager in moonraker.conf
   patch_mainsail_update_manager
 
-  ### install mjpg-streamer
-  [[ ${install_mjpg_streamer} == "true" ]] && install_mjpg-streamer
-
   fetch_webui_ports #WIP
 
   ### confirm message
@@ -92,22 +79,21 @@ function install_mainsail() {
 }
 
 function install_mainsail_macros() {
+  local yn
   while true; do
     echo
     top_border
-    echo -e "| It is recommended to have some important macros in    |"
-    echo -e "| your printer configuration to have Mainsail fully     |"
-    echo -e "| functional and working.                               |"
+    echo -e "| It is recommended to use special macros in order to   |"
+    echo -e "| have Mainsail fully functional and working.           |"
     blank_line
     echo -e "| The recommended macros for Mainsail can be seen here: |"
-    echo -e "| https://docs.mainsail.xyz/configuration#macros        |"
+    echo -e "| https://github.com/mainsail-crew/mainsail-config      |"
     blank_line
-    echo -e "| If you already have these macros in your config file, |"
-    echo -e "| skip this step and answer with 'no'.                  |"
+    echo -e "| If you already use these macros skip this step.       |"
     echo -e "| Otherwise you should consider to answer with 'yes' to |"
-    echo -e "| add the recommended example macros to your config.    |"
+    echo -e "| download the recommended macros.                      |"
     bottom_border
-    read -p "${cyan}###### Add the recommended macros? (Y/n):${white} " yn
+    read -p "${cyan}###### Download the recommended macros? (Y/n):${white} " yn
     case "${yn}" in
       Y|y|Yes|yes|"")
         select_msg "Yes"
@@ -124,37 +110,68 @@ function install_mainsail_macros() {
 }
 
 function download_mainsail_macros() {
-  local ms_cfg="https://raw.githubusercontent.com/mainsail-crew/MainsailOS/master/src/modules/mainsail/filesystem/home/pi/klipper_config/mainsail.cfg"
-  local configs path
-  configs=$(find "${KLIPPER_CONFIG}" -type f -name "printer.cfg" | sort)
+  local ms_cfg_repo path configs regex line gcode_dir
 
-  if [[ -n ${configs} ]]; then
-    for config in ${configs}; do
-      path=$(echo "${config}" | rev | cut -d"/" -f2- | rev)
-      if [[ ! -f "${path}/mainsail.cfg" ]]; then
-        status_msg "Downloading mainsail.cfg to ${path} ..."
-        log_info "downloading mainsail.cfg to: ${path}"
-        wget "${ms_cfg}" -O "${path}/mainsail.cfg"
+  ms_cfg_repo="https://github.com/mainsail-crew/mainsail-config.git"
+  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/printer\.cfg"
+  configs=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)
 
-        ### replace user 'pi' with current username to prevent issues in cases where the user is not called 'pi'
-        log_info "modify mainsail.cfg"
-        sed -i "/^path: \/home\/pi\/gcode_files/ s/\/home\/pi/\/home\/${USER}/" "${path}/mainsail.cfg"
-
-        ### write include to the very first line of the printer.cfg
-        if ! grep -Eq "^[include mainsail.cfg]$" "${path}/printer.cfg"; then
-          log_info "modify printer.cfg"
-          sed -i "1 i [include mainsail.cfg]" "${path}/printer.cfg"
-        fi
-        ok_msg "Done!"
-      fi
-    done
-  else
+  if [[ -z ${configs} ]]; then
+    print_error "No printer.cfg found! Installation of Macros will be skipped ..."
     log_error "execution stopped! reason: no printer.cfg found"
     return
   fi
+
+  status_msg "Cloning mainsail-config ..."
+  [[ -d "${HOME}/mainsail-config" ]] && rm -rf "${HOME}/mainsail-config"
+  if git clone "${ms_cfg_repo}" "${HOME}/mainsail-config"; then
+    for config in ${configs}; do
+      path=$(echo "${config}" | rev | cut -d"/" -f2- | rev)
+
+      if [[ -e "${path}/mainsail.cfg" && ! -h "${path}/mainsail.cfg" ]]; then
+        warn_msg "Attention! Existing mainsail.cfg detected!"
+        warn_msg "The file will be renamed to 'mainsail.bak.cfg' to be able to continue with the installation."
+        if ! mv "${path}/mainsail.cfg" "${path}/mainsail.bak.cfg"; then
+          error_msg "Renaming mainsail.cfg failed! Aborting installation ..."
+          return
+        fi
+      fi
+
+      if [[ -h "${path}/mainsail.cfg" ]]; then
+        warn_msg "Recreating symlink in ${path} ..."
+        rm -rf "${path}/mainsail.cfg"
+      fi
+
+      if ! ln -sf "${HOME}/mainsail-config/client.cfg" "${path}/mainsail.cfg"; then
+        error_msg "Creating symlink failed! Aborting installation ..."
+        return
+      fi
+
+      if ! grep -Eq "^\[include mainsail.cfg\]$" "${path}/printer.cfg"; then
+        log_info "${path}/printer.cfg"
+        sed -i "1 i [include mainsail.cfg]" "${path}/printer.cfg"
+      fi
+
+      line=$(($(grep -n "\[include mainsail.cfg\]" "${path}/printer.cfg" | tail -1 | cut -d: -f1) + 1))
+      gcode_dir=${path/config/gcodes}
+      if ! grep -Eq "^\[virtual_sdcard\]$" "${path}/printer.cfg"; then
+        log_info "${path}/printer.cfg"
+        sed -i "${line} i \[virtual_sdcard]\npath: ${gcode_dir}\non_error_gcode: CANCEL_PRINT\n" "${path}/printer.cfg"
+      fi
+    done
+  else
+    print_error "Cloning failed! Aborting installation ..."
+    log_error "execution stopped! reason: cloning failed"
+    return
+  fi
+
+  patch_mainsail_config_update_manager
+
+  ok_msg "Done!"
 }
 
 function download_mainsail() {
+  local services
   local url
   url=$(get_mainsail_download_url)
 
@@ -177,8 +194,9 @@ function download_mainsail() {
     exit 1
   fi
 
-  ### check for moonraker multi-instance and if multi-instance was found, enable mainsails remoteMode
-  if [[ $(moonraker_systemd | wc -w) -gt 1 ]]; then
+  ### check for moonraker multi-instance and if no-instance or multi-instance was found, enable mainsails remoteMode
+  services=$(moonraker_systemd)
+  if [[ ( -z "${services}" ) || ( $(echo "${services}" | wc -w) -gt 1 ) ]]; then
     enable_mainsail_remotemode
   fi
 }
@@ -194,7 +212,7 @@ function remove_mainsail_dir() {
   rm -rf "${MAINSAIL_DIR}" && ok_msg "Directory removed!"
 }
 
-function remove_mainsail_config() {
+function remove_mainsail_nginx_config() {
   if [[ -e "/etc/nginx/sites-available/mainsail" ]]; then
     status_msg "Removing Mainsail configuration for Nginx ..."
     sudo rm "/etc/nginx/sites-available/mainsail" && ok_msg "File removed!"
@@ -219,8 +237,10 @@ function remove_mainsail_logs() {
 }
 
 function remove_mainsail_log_symlinks() {
-  local files
-  files=$(find "${KLIPPER_LOGS}" -name "mainsail*" 2> /dev/null | sort)
+  local files regex
+
+  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/logs\/mainsail-.*"
+  files=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" 2> /dev/null | sort)
 
   if [[ -n ${files} ]]; then
     for file in ${files}; do
@@ -231,11 +251,34 @@ function remove_mainsail_log_symlinks() {
   fi
 }
 
+function remove_legacy_mainsail_log_symlinks() {
+  local files
+  files=$(find "${HOME}/klipper_logs" -name "mainsail*" 2> /dev/null | sort)
+
+  if [[ -n ${files} ]]; then
+    for file in ${files}; do
+      status_msg "Removing ${file} ..."
+      rm -f "${file}"
+      ok_msg "${file} removed!"
+    done
+  fi
+}
+
+function remove_mainsail_config() {
+  if [[ -d "${HOME}/mainsail-config"  ]]; then
+    status_msg "Removing ${HOME}/mainsail-config ..."
+    rm -rf "${HOME}/mainsail-config"
+    ok_msg "${HOME}/mainsail-config removed!"
+    print_confirm "Mainsail-Config successfully removed!"
+  fi
+}
+
 function remove_mainsail() {
   remove_mainsail_dir
-  remove_mainsail_config
+  remove_mainsail_nginx_config
   remove_mainsail_logs
   remove_mainsail_log_symlinks
+  remove_legacy_mainsail_log_symlinks
 
   ### remove mainsail_port from ~/.kiauh.ini
   sed -i "/^mainsail_port=/d" "${INI_FILE}"
@@ -281,36 +324,40 @@ function get_mainsail_status() {
 }
 
 function get_local_mainsail_version() {
-  [[ ! -f "${MAINSAIL_DIR}/.version" ]] && return
-
+  local versionfile="${MAINSAIL_DIR}/.version"
+  local relinfofile="${MAINSAIL_DIR}/release_info.json"
   local version
-  version=$(head -n 1 "${MAINSAIL_DIR}/.version")
+
+  if [[ -f ${relinfofile} ]]; then
+    version=$(grep -o '"version":"[^"]*' "${relinfofile}" | grep -o '[^"]*$')
+  elif [[ -f ${versionfile} ]]; then
+    version=$(head -n 1 "${versionfile}")
+  fi
+
   echo "${version}"
 }
 
 function get_remote_mainsail_version() {
   [[ ! $(dpkg-query -f'${Status}' --show curl 2>/dev/null) = *\ installed ]] && return
 
-  local version
-  version=$(get_mainsail_download_url | rev | cut -d"/" -f2 | rev)
-  echo "${version}"
+  local tags
+  tags=$(curl -s "https://api.github.com/repos/mainsail-crew/mainsail/tags" | grep "name" | cut -d'"' -f4)
+  echo "${tags}" | head -1
 }
 
 function compare_mainsail_versions() {
-  unset MAINSAIL_UPDATE_AVAIL
   local versions local_ver remote_ver
   local_ver="$(get_local_mainsail_version)"
   remote_ver="$(get_remote_mainsail_version)"
 
-  if [[ ${local_ver} != "${remote_ver}" ]]; then
+  if [[ ${local_ver} != "${remote_ver}" && ${local_ver} != "" ]]; then
     versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
     versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-    # add mainsail to the update all array for the update all function in the updater
-    MAINSAIL_UPDATE_AVAIL="true" && update_arr+=(update_mainsail)
+    # add moonraker to application_updates_available in kiauh.ini
+    add_to_application_updates "mainsail"
   else
     versions="${green}$(printf " %-14s" "${local_ver}")${white}"
     versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-    MAINSAIL_UPDATE_AVAIL="false"
   fi
 
   echo "${versions}"
@@ -333,7 +380,7 @@ function print_theme_list() {
 
 function ms_theme_installer_menu() {
   local theme_list theme_author theme_repo theme_name theme_note theme_url
-  local theme_csv_url="https://raw.githubusercontent.com/mainsail-crew/docs/master/_data/themes.csv"
+  local theme_csv_url="https://raw.githubusercontent.com/mainsail-crew/gb-docs/main/_data/themes.csv"
   theme_list=$(curl -s -L "${theme_csv_url}")
 
   top_border
@@ -379,23 +426,41 @@ function ms_theme_installer_menu() {
 }
 
 function ms_theme_install() {
-  local theme_url=${1} theme_name theme_note
-  theme_name=${2} theme_note=${3}
+  read_kiauh_ini "${FUNCNAME[0]}"
 
-  local config_folders target_folders=()
-  config_folders=$(find "${KLIPPER_CONFIG}" -mindepth 1 -maxdepth 1 -type d | sort)
+  local theme_url
+  local theme_name
+  local theme_note
+  theme_url=${1}
+  theme_name=${2}
+  theme_note=${3}
 
-  ### build target folder array
-  for folder in ${config_folders}; do
-    target_folders+=("${folder}")
-  done
+  local folder_arr
+  local folder_names="${multi_instance_names}"
+  local target_folders=()
+
+  IFS=',' read -r -a folder_arr <<< "${folder_names}"
+
+  ### build theme target folder array
+  if (( ${#folder_arr[@]} > 1 )); then
+    for folder in "${folder_arr[@]}"; do
+      ### instance names/identifier of only numbers need to be prefixed with 'printer_'
+      if [[ ${folder} =~ ^[0-9]+$ ]]; then
+        target_folders+=("${HOME}/printer_${folder}_data/config")
+      else
+        target_folders+=("${HOME}/${folder}_data/config")
+      fi
+    done
+  else
+    target_folders+=("${HOME}/printer_data/config")
+  fi
 
   if (( ${#target_folders[@]} > 1 )); then
     top_border
     echo -e "| Please select the printer you want to apply the theme |"
     echo -e "| installation to:                                      |"
     for (( i=0; i < ${#target_folders[@]}; i++ )); do
-      folder=$(echo "${target_folders[${i}]}" | rev | cut -d "/" -f1 | rev)
+      folder=$(echo "${target_folders[${i}]}" | rev | cut -d "/" -f2 | cut -d"_" -f2- | rev)
       printf "|${cyan}%-55s${white}|\n" " ${i}) ${folder}"
     done
     bottom_border
@@ -424,15 +489,21 @@ function ms_theme_install() {
 }
 
 function ms_theme_delete() {
-  local theme_folders target_folders=()
-  theme_folders=$(find "${KLIPPER_CONFIG}" -mindepth 1 -type d -name ".theme" | sort)
+  local regex theme_folders target_folders=()
+
+  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/\.theme"
+  theme_folders=$(find "${HOME}" -maxdepth 3 -type d -regextype posix-extended -regex "${regex}" | sort)
+#  theme_folders=$(find "${KLIPPER_CONFIG}" -mindepth 1 -type d -name ".theme" | sort)
 
   ### build target folder array
   for folder in ${theme_folders}; do
     target_folders+=("${folder}")
   done
 
-  if (( ${#target_folders[@]} > 0 )); then
+  if (( ${#target_folders[@]} == 0 )); then
+    status_msg "No Themes installed!\n"
+    return
+  elif (( ${#target_folders[@]} > 1 )); then
     top_border
     echo -e "| Please select the printer you want to remove the      |"
     echo -e "| theme installation from.                              |"
@@ -449,9 +520,6 @@ function ms_theme_delete() {
       [[ ${target} =~ ${re} && ${target} -lt ${#target_folders[@]} ]] && break
       error_msg "Invalid command!"
     done
-  else
-    status_msg "No Themes installed!\n"
-    return
   fi
 
   status_msg "Removing ${target_folders[${target}]} ..."
@@ -465,25 +533,28 @@ function ms_theme_delete() {
 #================================================#
 
 function get_mainsail_download_url() {
-  local tags latest_tag latest_url stable_tag stable_url url
-  tags=$(curl -s "${MAINSAIL_TAGS}" | grep "name" | cut -d'"' -f4)
+  local releases_by_tag tags tag unstable_url url
 
-  ### latest download url including pre-releases (alpha, beta, rc)
-  latest_tag=$(echo "${tags}" | head -1)
-  latest_url="https://github.com/mainsail-crew/mainsail/releases/download/${latest_tag}/mainsail.zip"
-
-  ### get stable mainsail download url
-  stable_tag=$(echo "${tags}" | grep -E "^v([0-9]+\.?){3}$" | head -1)
-  stable_url="https://github.com/mainsail-crew/mainsail/releases/download/${stable_tag}/mainsail.zip"
+  ### latest stable download url
+  url="https://github.com/mainsail-crew/mainsail/releases/latest/download/mainsail.zip"
 
   read_kiauh_ini "${FUNCNAME[0]}"
   if [[ ${mainsail_install_unstable} == "true" ]]; then
-    url="${latest_url}"
-    echo "${url}"
-  else
-    url="${stable_url}"
-    echo "${url}"
+    releases_by_tag="https://api.github.com/repos/mainsail-crew/mainsail/tags"
+    tags=$(curl -s "${releases_by_tag}" | grep "name" | cut -d'"' -f4)
+    tag=$(echo "${tags}" | head -1)
+
+    ### latest unstable download url including pre-releases (alpha, beta, rc)
+    unstable_url="https://github.com/mainsail-crew/mainsail/releases/download/${tag}/mainsail.zip"
+
+    if [[ ${unstable_url} == *"download//"* ]]; then
+      warn_msg "Download URL broken! Falling back to URL of latest stable release!"
+    else
+      url=${unstable_url}
+    fi
   fi
+
+  echo "${url}"
 }
 
 function mainsail_port_check() {
@@ -500,7 +571,7 @@ function mainsail_port_check() {
         select_mainsail_port
       fi
     else
-      DEFAULT_PORT=$(grep listen "${KIAUH_SRCDIR}/resources/klipper_webui_nginx.cfg" | head -1 | sed 's/^\s*//' | cut -d" " -f2 | cut -d";" -f1)
+      DEFAULT_PORT=$(grep listen "${KIAUH_SRCDIR}/resources/mainsail" | head -1 | sed 's/^\s*//' | cut -d" " -f2 | cut -d";" -f1)
       SET_LISTEN_PORT=${DEFAULT_PORT}
     fi
     SET_NGINX_CFG="true"
@@ -548,16 +619,19 @@ function select_mainsail_port() {
 function enable_mainsail_remotemode() {
   [[ ! -f "${MAINSAIL_DIR}/config.json" ]] && return
 
-  rm -f "${MAINSAIL_DIR}/config.json"
-  echo -e "{\n    \"remoteMode\":true\n}" >> "${MAINSAIL_DIR}/config.json"
+  status_msg "Setting instance storage location to 'browser' ..."
+  sed -i 's|"instancesDB": "moonraker"|"instancesDB": "browser"|' "${MAINSAIL_DIR}/config.json"
+  ok_msg "Done!"
 }
 
 function patch_mainsail_update_manager() {
-  local moonraker_configs
-  moonraker_configs=$(find "${KLIPPER_CONFIG}" -type f -name "moonraker.conf" | sort)
+  local patched moonraker_configs regex
+  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/moonraker\.conf"
+  moonraker_configs=$(find "${HOME}" -maxdepth 3 -type f -regextype posix-extended -regex "${regex}" | sort)
 
+  patched="false"
   for conf in ${moonraker_configs}; do
-    if ! grep -Eq "^\[update_manager mainsail\]$" "${conf}"; then
+    if ! grep -Eq "^\[update_manager mainsail\]\s*$" "${conf}"; then
       ### add new line to conf if it doesn't end with one
       [[ $(tail -c1 "${conf}" | wc -l) -eq 0 ]] && echo "" >> "${conf}"
 
@@ -573,5 +647,44 @@ path: ~/mainsail
 MOONRAKER_CONF
 
     fi
+
+    patched="true"
   done
-}
+
+  if [[ ${patched} == "true" ]]; then
+    do_action_service "restart" "moonraker"
+  fi
+}
+
+function patch_mainsail_config_update_manager() {
+  local patched moonraker_configs regex
+  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/moonraker\.conf"
+  moonraker_configs=$(find "${HOME}" -maxdepth 3 -type f -regextype posix-extended -regex "${regex}" | sort)
+
+  patched="false"
+  for conf in ${moonraker_configs}; do
+    if ! grep -Eq "^\[update_manager mainsail-config\]\s*$" "${conf}"; then
+      ### add new line to conf if it doesn't end with one
+      [[ $(tail -c1 "${conf}" | wc -l) -eq 0 ]] && echo "" >> "${conf}"
+
+      ### add Mainsails update manager section to moonraker.conf
+      status_msg "Adding Mainsail-Config to update manager in file:\n       ${conf}"
+      /bin/sh -c "cat >> ${conf}" << MOONRAKER_CONF
+
+[update_manager mainsail-config]
+type: git_repo
+primary_branch: master
+path: ~/mainsail-config
+origin: https://github.com/mainsail-crew/mainsail-config.git
+managed_services: klipper
+MOONRAKER_CONF
+
+    fi
+
+    patched="true"
+  done
+
+  if [[ ${patched} == "true" ]]; then
+    do_action_service "restart" "moonraker"
+  fi
+}

scripts/mjpg-streamer.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -16,10 +16,10 @@ set -e
 #=================================================#
 
 function install_mjpg-streamer() {
-  local webcamd="https://raw.githubusercontent.com/mainsail-crew/MainsailOS/master/src/modules/mjpgstreamer/filesystem/root/usr/local/bin/webcamd"
-  local webcam_txt="https://raw.githubusercontent.com/mainsail-crew/MainsailOS/master/src/modules/mjpgstreamer/filesystem/home/pi/klipper_config/webcam.txt"
+  local webcamd="${KIAUH_SRCDIR}/resources/mjpg-streamer/webcamd"
+  local webcam_txt="${KIAUH_SRCDIR}/resources/mjpg-streamer/webcam.txt"
+  local service="${KIAUH_SRCDIR}/resources/mjpg-streamer/webcamd.service"
   local repo="https://github.com/jacksonliam/mjpg-streamer.git"
-  local service="${KIAUH_SRCDIR}/resources/webcamd.service"
 
   ### return early if webcamd.service already exists
   if [[ -f "${SYSTEMD}/webcamd.service" ]]; then
@@ -77,7 +77,7 @@ function install_mjpg-streamer() {
 </html>
 EOT
 
-  sudo wget "${webcamd}" -O "/usr/local/bin/webcamd"
+  sudo cp "${webcamd}" "/usr/local/bin/webcamd"
   sudo sed -i "/^config_dir=/ s|=.*|=${KLIPPER_CONFIG}|" /usr/local/bin/webcamd
   sudo sed -i "/MJPGSTREAMER_HOME/ s/pi/${USER}/" /usr/local/bin/webcamd
   sudo chmod +x /usr/local/bin/webcamd
@@ -86,7 +86,7 @@ EOT
   [[ ! -d ${KLIPPER_CONFIG} ]] && mkdir -p "${KLIPPER_CONFIG}"
   if [[ ! -f "${KLIPPER_CONFIG}/webcam.txt" ]]; then
     status_msg "Creating webcam.txt config file ..."
-    wget "${webcam_txt}" -O "${KLIPPER_CONFIG}/webcam.txt"
+    cp "${webcam_txt}" "${KLIPPER_CONFIG}/webcam.txt"
     ok_msg "Done!"
   fi
 
@@ -190,4 +190,4 @@ function remove_mjpg-streamer() {
   [[ -L "${KLIPPER_LOGS}/webcamd.log" ]] && rm -f "${KLIPPER_LOGS}/webcamd.log"
 
   print_confirm "MJPG-Streamer successfully removed!"
-}
+}

scripts/mobileraker.sh

@@ -0,0 +1,247 @@
+#!/usr/bin/env bash
+
+#=======================================================================#
+# 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                                         #
+#                                                                       #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+#=======================================================================#
+
+#
+# This file is written and maintained by Patrick Schmidt author of Mobileraker
+# It is based of the kliperscreen.sh install script!
+
+
+set -e
+
+#===================================================#
+#========== INSTALL MOBILERAKER COMPANION ==========#
+#===================================================#
+
+function mobileraker_systemd() {
+  local services
+  services=$(find "${SYSTEMD}" -maxdepth 1 -regextype posix-extended -regex "${SYSTEMD}/mobileraker.service")
+  echo "${services}"
+}
+
+function install_mobileraker() {
+  ### return early if python version check fails
+  if [[ $(python3_check) == "false" ]]; then
+    local error="Versioncheck failed! Python 3.7 or newer required!\n"
+    error="${error} Please upgrade Python."
+    print_error "${error}" && return
+  fi
+
+  ### first, we create a backup of the full klipper_config dir - safety first!
+  backup_config_dir
+
+  ### install Mobileraker's Companion
+  mobileraker_setup
+
+  ### add Mobileraker's Companion to the update manager in moonraker.conf
+  patch_mobileraker_update_manager
+
+  do_action_service "restart" "mobileraker"
+}
+
+function mobileraker_setup() {
+  local dep=(wget curl unzip dfu-util)
+  dependency_check "${dep[@]}"
+  status_msg "Cloning Mobileraker's companion from ${MOBILERAKER_REPO} ..."
+
+  # force remove existing Mobileraker's companion dir
+  [[ -d ${MOBILERAKER_DIR} ]] && rm -rf "${MOBILERAKER_DIR}"
+
+  # clone into fresh Mobileraker's companion dir
+  cd "${HOME}" || exit 1
+  if ! git clone "${MOBILERAKER_REPO}" "${MOBILERAKER_DIR}"; then
+    print_error "Cloning mobileraker's companion from\n ${MOBILERAKER_REPO}\n failed!"
+    exit 1
+  fi
+
+  status_msg "Starting installer of Mobileraker's companion ..."
+  if "${MOBILERAKER_DIR}"/scripts/install.sh; then
+    ok_msg "Mobileraker's companion successfully installed!"
+  else
+    print_error "Mobileraker's companion installation failed!"
+    exit 1
+  fi
+}
+
+#===================================================#
+#=========== REMOVE MOBILERAKER COMPANION ==========#
+#===================================================#
+
+function remove_mobileraker() {
+  ### remove Mobileraker's companion dir
+  if [[ -d ${MOBILERAKER_DIR} ]]; then
+    status_msg "Removing Mobileraker's companion directory ..."
+    rm -rf "${MOBILERAKER_DIR}" && ok_msg "Directory removed!"
+  fi
+
+  ### remove Mobileraker's companion VENV dir
+  if [[ -d ${MOBILERAKER_ENV} ]]; then
+    status_msg "Removing Mobileraker's companion VENV directory ..."
+    rm -rf "${MOBILERAKER_ENV}" && ok_msg "Directory removed!"
+  fi
+
+  ### remove Mobileraker's companion service
+  if [[ -e "${SYSTEMD}/mobileraker.service" ]]; then
+    status_msg "Removing mobileraker service ..."
+    do_action_service "stop" "mobileraker"
+    do_action_service "disable" "mobileraker"
+    sudo rm -f "${SYSTEMD}/mobileraker.service"
+
+    ###reloading units
+    sudo systemctl daemon-reload
+    sudo systemctl reset-failed
+    ok_msg "Mobileraker's companion Service removed!"
+  fi
+
+
+  remove_mobileraker_logs
+
+  print_confirm "Mobileraker's companion successfully removed!"
+}
+
+function remove_mobileraker_logs() {
+  local files regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/logs\/mobileraker\.log.*"
+  files=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)
+
+  if [[ -n ${files} ]]; then
+    for file in ${files}; do
+      status_msg "Removing ${file} ..."
+      rm -f "${file}"
+      ok_msg "${file} removed!"
+    done
+  fi
+}
+
+#===================================================#
+#=========== UPDATE MOBILERAKER COMPANION ==========#
+#===================================================#
+
+function update_mobileraker() {
+  local old_md5
+  old_md5=$(md5sum "${MOBILERAKER_DIR}/scripts/mobileraker-requirements.txt" | cut -d " " -f1)
+
+  do_action_service "stop" "mobileraker"
+  cd "${MOBILERAKER_DIR}"
+  git pull origin main -q && ok_msg "Fetch successfull!"
+  git checkout -f main && ok_msg "Checkout successfull"
+
+  if [[ $(md5sum "${MOBILERAKER_DIR}/scripts/mobileraker-requirements.txt" | cut -d " " -f1) != "${old_md5}" ]]; then
+    status_msg "New dependencies detected..."
+    "${MOBILERAKER_ENV}"/bin/pip install -r "${MOBILERAKER_DIR}/scripts/mobileraker-requirements.txt"
+    ok_msg "Dependencies have been installed!"
+  fi
+
+  ok_msg "Update complete!"
+  do_action_service "start" "mobileraker"
+}
+
+#===================================================#
+#=========== MOBILERAKER COMPANION STATUS ==========#
+#===================================================#
+
+function get_mobileraker_status() {
+  local sf_count status
+  sf_count="$(mobileraker_systemd | wc -w)"
+
+  ### remove the "SERVICE" entry from the data array if a moonraker service is installed
+  local data_arr=(SERVICE "${MOBILERAKER_DIR}" "${MOBILERAKER_ENV}")
+  (( sf_count > 0 )) && unset "data_arr[0]"
+
+  ### count+1 for each found data-item from array
+  local filecount=0
+  for data in "${data_arr[@]}"; do
+    [[ -e ${data} ]] && filecount=$(( filecount + 1 ))
+  done
+
+  if (( filecount == ${#data_arr[*]} )); then
+    status="Installed!"
+  elif (( filecount == 0 )); then
+    status="Not installed!"
+  else
+    status="Incomplete!"
+  fi
+  echo "${status}"
+}
+
+function get_local_mobileraker_commit() {
+  [[ ! -d ${MOBILERAKER_DIR} || ! -d "${MOBILERAKER_DIR}/.git" ]] && return
+
+  local commit
+  cd "${MOBILERAKER_DIR}"
+  commit="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
+  echo "${commit}"
+}
+
+function get_remote_mobileraker_commit() {
+  [[ ! -d ${MOBILERAKER_DIR} || ! -d "${MOBILERAKER_DIR}/.git" ]] && return
+
+  local commit
+  cd "${MOBILERAKER_DIR}" && git fetch origin -q
+  commit=$(git describe origin/main --always --tags | cut -d "-" -f 1,2)
+  echo "${commit}"
+}
+
+function compare_mobileraker_versions() {
+  local versions local_ver remote_ver
+  local_ver="$(get_local_mobileraker_commit)"
+  remote_ver="$(get_remote_mobileraker_commit)"
+
+  if [[ ${local_ver} != "${remote_ver}" ]]; then
+    versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+    # add moonraker to application_updates_available in kiauh.ini
+    add_to_application_updates "mobileraker"
+  else
+    versions="${green}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+  fi
+
+  echo "${versions}"
+}
+
+#================================================#
+#=================== HELPERS ====================#
+#================================================#
+
+function patch_mobileraker_update_manager() {
+  local patched moonraker_configs regex
+  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/moonraker\.conf"
+  moonraker_configs=$(find "${HOME}" -maxdepth 3 -type f -regextype posix-extended -regex "${regex}" | sort)
+
+  patched="false"
+  for conf in ${moonraker_configs}; do
+    if ! grep -Eq "^\[update_manager mobileraker\]\s*$" "${conf}"; then
+      ### add new line to conf if it doesn't end with one
+      [[ $(tail -c1 "${conf}" | wc -l) -eq 0 ]] && echo "" >> "${conf}"
+
+      ### add Mobileraker's Companion update manager section to moonraker.conf
+      status_msg "Adding Mobileraker's Companion to update manager in file:\n       ${conf}"
+      /bin/sh -c "cat >> ${conf}" << MOONRAKER_CONF
+
+[update_manager mobileraker]
+type: git_repo
+path: ${HOME}/mobileraker_companion
+origin: https://github.com/Clon1998/mobileraker_companion.git
+primary_branch:main
+managed_services: mobileraker
+env: ${HOME}/mobileraker-env/bin/python
+requirements: scripts/mobileraker-requirements.txt
+install_script: scripts/install.sh
+MOONRAKER_CONF
+
+    fi
+
+    patched="true"
+  done
+
+  if [[ ${patched} == "true" ]]; then
+    do_action_service "restart" "moonraker"
+  fi
+}

scripts/moonraker-telegram-bot.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -33,7 +33,7 @@ function telegram_bot_setup_dialog() {
 
   status_msg "Initializing Telegram Bot installation ..."
   ### first, we create a backup of the full klipper_config dir - safety first!
-  backup_klipper_config_dir
+  backup_config_dir
 
   local moonraker_count user_input=() moonraker_names=()
   moonraker_count=$(echo "${moonraker_services}" | wc -w )
@@ -110,7 +110,7 @@ function telegram_bot_setup_dialog() {
 }
 
 function install_telegram_bot_dependencies() {
-  local packages
+  local packages log_name="Telegram Bot"
   local install_script="${TELEGRAM_BOT_DIR}/scripts/install.sh"
 
   ### read PKGLIST from official install-script
@@ -121,21 +121,11 @@ function install_telegram_bot_dependencies() {
   echo "${cyan}${packages}${white}" | tr '[:space:]' '\n'
   read -r -a packages <<< "${packages}"
 
-  ### Update system package info
-  status_msg "Updating package lists..."
-  if ! sudo apt-get update --allow-releaseinfo-change; then
-    log_error "failure while updating package lists"
-    error_msg "Updating package lists failed!"
-    exit 1
-  fi
+  ### Update system package lists if stale
+  update_system_package_lists
 
   ### Install required packages
-  status_msg "Installing required packages..."
-  if ! sudo apt-get install --yes "${packages[@]}"; then
-    log_error "failure while installing required moonraker-telegram-bot packages"
-    error_msg "Installing required packages failed!"
-    exit 1
-  fi
+  install_system_packages "${log_name}" "packages[@]"
 }
 
 function create_telegram_bot_virtualenv() {
@@ -203,29 +193,40 @@ function create_telegram_conf() {
   local input=("${@}")
   local telegram_bot_count=${input[0]} && unset "input[0]"
   local names=("${input[@]}") && unset "input[@]"
-  local log="${KLIPPER_LOGS}"
-  local cfg cfg_dir
+  local printer_data log_dir cfg cfg_dir
 
   if (( telegram_bot_count == 1 )); then
-    cfg_dir="${KLIPPER_CONFIG}"
+    printer_data="${HOME}/printer_data"
+    log_dir="${printer_data}/logs"
+    cfg_dir="${printer_data}/config"
     cfg="${cfg_dir}/telegram.conf"
+
+    ### create required folder structure
+    create_required_folders "${printer_data}"
+
     ### write single instance config
-    write_telegram_conf "${cfg_dir}" "${cfg}" "${log}"
+    write_telegram_conf "${cfg_dir}" "${cfg}"
 
   elif (( telegram_bot_count > 1 )); then
     local j=0 re="^[1-9][0-9]*$"
 
     for (( i=1; i <= telegram_bot_count; i++ )); do
-      ### overwrite config folder if name is only a number
-      if [[ ${names[j]} =~ ${re} ]]; then
-        cfg_dir="${KLIPPER_CONFIG}/printer_${names[${j}]}"
-      else
-        cfg_dir="${KLIPPER_CONFIG}/${names[${j}]}"
-      fi
+
+      printer_data="${HOME}/${names[${j}]}_data"
+      ### prefix instance name with "printer_" if it is only a number
+      [[ ${names[j]} =~ ${re} ]] && printer_data="${HOME}/printer_${names[${j}]}_data"
+
+
+      cfg_dir="${printer_data}/config"
       cfg="${cfg_dir}/telegram.conf"
+      log_dir="${printer_data}/logs"
+
+      ### create required folder structure
+      create_required_folders "${printer_data}"
 
       ### write multi instance config
-      write_telegram_conf "${cfg_dir}" "${cfg}" "${log}"
+      write_telegram_conf "${cfg_dir}" "${cfg}"
+
       j=$(( j + 1 ))
     done && unset j
 
@@ -235,17 +236,15 @@ function create_telegram_conf() {
 }
 
 function write_telegram_conf() {
-  local cfg_dir=${1} cfg=${2} log=${3}
+  local cfg_dir=${1} cfg=${2}
   local conf_template="${TELEGRAM_BOT_DIR}/scripts/base_install_template"
-  [[ ! -d ${cfg_dir} ]] && mkdir -p "${cfg_dir}"
 
   if [[ ! -f ${cfg} ]]; then
     status_msg "Creating telegram.conf in ${cfg_dir} ..."
     cp "${conf_template}" "${cfg}"
-    sed -i "s|some_log_path|${log}|g" "${cfg}"
     ok_msg "telegram.conf created!"
   else
-    status_msg "File '${cfg}' already exists!\nSkipping..."
+    ok_msg "File '${cfg}' already exists! Skipping..."
   fi
 }
 
@@ -253,16 +252,22 @@ function create_telegram_bot_service() {
   local input=("${@}")
   local instances=${input[0]} && unset "input[0]"
   local names=("${input[@]}") && unset "input[@]"
-  local cfg_dir cfg log service
+  local printer_data cfg_dir cfg log service env_file
 
   if (( instances == 1 )); then
-    cfg_dir="${KLIPPER_CONFIG}"
+    printer_data="${HOME}/printer_data"
+    cfg_dir="${printer_data}/config"
     cfg="${cfg_dir}/telegram.conf"
-    log="${KLIPPER_LOGS}/telegram.log"
+    log="${printer_data}/logs/telegram.log"
     service="${SYSTEMD}/moonraker-telegram-bot.service"
+    env_file="${printer_data}/systemd/moonraker-telegram-bot.env"
+
+    ### create required folder structure
+    create_required_folders "${printer_data}"
+
     ### write single instance service
-    write_telegram_bot_service "" "${cfg}" "${log}" "${service}"
-    ok_msg "Single Telegram Bot instance created!"
+    write_telegram_bot_service "" "${cfg}" "${log}" "${service}" "${env_file}"
+    ok_msg "Telegram Bot instance created!"
 
   elif (( instances > 1 )); then
     local j=0 re="^[1-9][0-9]*$"
@@ -270,17 +275,27 @@ function create_telegram_bot_service() {
     for (( i=1; i <= instances; i++ )); do
       ### overwrite config folder if name is only a number
       if [[ ${names[j]} =~ ${re} ]]; then
-        cfg_dir="${KLIPPER_CONFIG}/printer_${names[${j}]}"
+        printer_data="${HOME}/printer_${names[${j}]}_data"
       else
-        cfg_dir="${KLIPPER_CONFIG}/${names[${j}]}"
+        printer_data="${HOME}/${names[${j}]}_data"
       fi
 
+      cfg_dir="${printer_data}/config"
       cfg="${cfg_dir}/telegram.conf"
-      log="${KLIPPER_LOGS}/telegram-${names[${j}]}.log"
+      log="${printer_data}/logs/telegram.log"
       service="${SYSTEMD}/moonraker-telegram-bot-${names[${j}]}.service"
+      env_file="${printer_data}/systemd/moonraker-telegram-bot.env"
+
+      ### create required folder structure
+      create_required_folders "${printer_data}"
+
       ### write multi instance service
-      write_telegram_bot_service "${names[${j}]}" "${cfg}" "${log}" "${service}"
-      ok_msg "Telegram Bot instance moonraker-telegram-bot-${names[${j}]} created!"
+      if write_telegram_bot_service "${names[${j}]}" "${cfg}" "${log}" "${service}" "${env_file}"; then
+        ok_msg "Telegram Bot instance moonraker-telegram-bot-${names[${j}]} created!"
+      else
+        error_msg "An error occured during creation of instance moonraker-telegram-bot-${names[${j}]}!"
+      fi
+
       j=$(( j + 1 ))
     done && unset j
 
@@ -290,17 +305,24 @@ function create_telegram_bot_service() {
 }
 
 function write_telegram_bot_service() {
-  local i=${1} cfg=${2} log=${3} service=${4}
+  local i=${1} cfg=${2} log=${3} service=${4} env_file=${5}
   local service_template="${KIAUH_SRCDIR}/resources/moonraker-telegram-bot.service"
+  local env_template="${KIAUH_SRCDIR}/resources/moonraker-telegram-bot.env"
 
   ### replace all placeholders
   if [[ ! -f ${service} ]]; then
-    status_msg "Creating Telegram Bot Service ${i} ..."
+    status_msg "Creating service file for instance ${i} ..."
     sudo cp "${service_template}" "${service}"
-    [[ -z ${i} ]] && sudo sed -i "s|instance %INST% ||" "${service}"
-    [[ -n ${i} ]] && sudo sed -i "s|%INST%|${i}|" "${service}"
-    sudo sed -i "s|%USER%|${USER}|; s|%ENV%|${TELEGRAM_BOT_ENV}|; s|%DIR%|${TELEGRAM_BOT_DIR}|" "${service}"
-    sudo sed -i "s|%CFG%|${cfg}|; s|%LOG%|${log}|" "${service}"
+    if [[ -z ${i} ]]; then
+      sudo sed -i "s| %INST%||" "${service}"
+    else
+      sudo sed -i "s|%INST%|${i}|" "${service}"
+    fi
+    sudo sed -i "s|%USER%|${USER}|g; s|%TELEGRAM_BOT_DIR%|${TELEGRAM_BOT_DIR}|; s|%ENV%|${TELEGRAM_BOT_ENV}|; s|%ENV_FILE%|${env_file}|" "${service}"
+
+    status_msg "Creating environment file for instance ${i} ..."
+    cp "${env_template}" "${env_file}"
+    sed -i "s|%USER%|${USER}|; s|%TELEGRAM_BOT_DIR%|${TELEGRAM_BOT_DIR}|; s|%CFG%|${cfg}|; s|%LOG%|${log}|" "${env_file}"
   fi
 }
 
@@ -343,9 +365,35 @@ function remove_telegram_bot_env() {
   ok_msg "Directory removed!"
 }
 
+function remove_telegram_bot_env_file() {
+  local files regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/systemd\/moonraker-telegram-bot\.env"
+  files=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)
+
+  if [[ -n ${files} ]]; then
+    for file in ${files}; do
+      status_msg "Removing ${file} ..."
+      rm -f "${file}"
+      ok_msg "${file} removed!"
+    done
+  fi
+}
+
 function remove_telegram_bot_logs() {
+  local files regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/logs\/telegram\.log.*"
+  files=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)
+
+  if [[ -n ${files} ]]; then
+    for file in ${files}; do
+      status_msg "Removing ${file} ..."
+      rm -f "${file}"
+      ok_msg "${file} removed!"
+    done
+  fi
+}
+
+function remove_legacy_telegram_bot_logs() {
   local files regex="telegram(-[0-9a-zA-Z]+)?\.log(.*)?"
-  files=$(find "${KLIPPER_LOGS}" -maxdepth 1 -regextype posix-extended -regex "${KLIPPER_LOGS}/${regex}" | sort)
+  files=$(find "${HOME}/klipper_logs" -maxdepth 1 -regextype posix-extended -regex "${HOME}/klipper_logs/${regex}" 2> /dev/null | sort)
 
   if [[ -n ${files} ]]; then
     for file in ${files}; do
@@ -360,7 +408,9 @@ function remove_telegram_bot() {
   remove_telegram_bot_systemd
   remove_telegram_bot_dir
   remove_telegram_bot_env
+  remove_telegram_bot_env_file
   remove_telegram_bot_logs
+  remove_legacy_telegram_bot_logs
 
   local confirm="Moonraker-Telegram-Bot was successfully removed!"
   print_confirm "${confirm}" && return
@@ -436,7 +486,6 @@ function get_remote_telegram_bot_commit() {
 }
 
 function compare_telegram_bot_versions() {
-  unset MOONRAKER_TELEGRAM_BOT_UPDATE_AVAIL
   local versions local_ver remote_ver
   local_ver="$(get_local_telegram_bot_commit)"
   remote_ver="$(get_remote_telegram_bot_commit)"
@@ -444,12 +493,11 @@ function compare_telegram_bot_versions() {
   if [[ ${local_ver} != "${remote_ver}" ]]; then
     versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
     versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-    # add moonraker-telegram-bot to the update all array for the update all function in the updater
-    MOONRAKER_TELEGRAM_BOT_UPDATE_AVAIL="true" && update_arr+=(update_telegram_bot)
+    # add moonraker to application_updates_available in kiauh.ini
+    add_to_application_updates "telegram_bot"
   else
     versions="${green}$(printf " %-14s" "${local_ver}")${white}"
     versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-    MOONRAKER_TELEGRAM_BOT_UPDATE_AVAIL="false"
   fi
 
   echo "${versions}"
@@ -460,11 +508,13 @@ function compare_telegram_bot_versions() {
 #================================================#
 
 function patch_telegram_bot_update_manager() {
-  local moonraker_configs
-  moonraker_configs=$(find "${KLIPPER_CONFIG}" -type f -name "moonraker.conf" | sort)
+  local patched moonraker_configs regex
+  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/moonraker\.conf"
+  moonraker_configs=$(find "${HOME}" -maxdepth 3 -type f -regextype posix-extended -regex "${regex}" | sort)
 
+  patched="false"
   for conf in ${moonraker_configs}; do
-    if ! grep -Eq "^\[update_manager moonraker-telegram-bot\]$" "${conf}"; then
+    if ! grep -Eq "^\[update_manager moonraker-telegram-bot\]\s*$" "${conf}"; then
       ### add new line to conf if it doesn't end with one
       [[ $(tail -c1 "${conf}" | wc -l) -eq 0 ]] && echo "" >> "${conf}"
 
@@ -482,5 +532,11 @@ install_script: scripts/install.sh
 MOONRAKER_CONF
 
     fi
+
+    patched="true"
   done
+
+  if [[ ${patched} == "true" ]]; then
+    do_action_service "restart" "moonraker"
+  fi
 }

scripts/moonraker.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -15,9 +15,24 @@ set -e
 #================ INSTALL MOONRAKER ================#
 #===================================================#
 
+###
+# this function detects all installed moonraker
+# systemd instances and returns their absolute path
 function moonraker_systemd() {
   local services
-  services=$(find "${SYSTEMD}" -maxdepth 1 -regextype posix-extended -regex "${SYSTEMD}/moonraker(-[0-9a-zA-Z]+)?.service" | sort)
+  local blacklist
+  local ignore
+  local match
+
+  ###
+  # any moonraker client that uses "moonraker" in its own name must be blacklisted using
+  # this variable, otherwise they will be falsely recognized as moonraker instances
+  blacklist="obico|hmi|telegram-bot"
+
+  ignore="${SYSTEMD}/moonraker-(${blacklist}).service"
+  match="${SYSTEMD}/moonraker(-[0-9a-zA-Z]+)?.service"
+
+  services=$(find "${SYSTEMD}" -maxdepth 1 -regextype awk ! -regex "${ignore}" -regex "${match}" | sort)
   echo "${services}"
 }
 
@@ -126,32 +141,207 @@ function moonraker_setup_dialog() {
 }
 
 function install_moonraker_dependencies() {
-  local packages
-  local install_script="${MOONRAKER_DIR}/scripts/install-moonraker.sh"
+  local packages log_name="Moonraker"
+  local package_json="${MOONRAKER_DIR}/scripts/system-dependencies.json"
 
   ### read PKGLIST from official install-script
   status_msg "Reading dependencies..."
   # shellcheck disable=SC2016
-  packages="$(grep "PKGLIST=" "${install_script}" | cut -d'"' -f2 | sed 's/\${PKGLIST}//g' | tr -d '\n')"
+  packages=$(python3 - << EOF
+from __future__ import annotations
+import shlex
+import re
+import pathlib
+import logging
+
+from typing import Tuple, Dict, List, Any
+
+def _get_distro_info() -> Dict[str, Any]:
+    try:
+        import distro
+    except ModuleNotFoundError:
+        pass
+    else:
+        return dict(
+            distro_id=distro.id(),
+            distro_version=distro.version(),
+            aliases=distro.like().split()
+        )
+    release_file = pathlib.Path("/etc/os-release")
+    release_info: Dict[str, str] = {}
+    with release_file.open("r") as f:
+        lexer = shlex.shlex(f, posix=True)
+        lexer.whitespace_split = True
+        for item in list(lexer):
+            if "=" in item:
+                key, val = item.split("=", maxsplit=1)
+                release_info[key] = val
+    return dict(
+        distro_id=release_info.get("ID", ""),
+        distro_version=release_info.get("VERSION_ID", ""),
+        aliases=release_info.get("ID_LIKE", "").split()
+    )
+
+def _convert_version(version: str) -> Tuple[str | int, ...]:
+    version = version.strip()
+    ver_match = re.match(r"\d+(\.\d+)*((?:-|\.).+)?", version)
+    if ver_match is not None:
+        return tuple([
+            int(part) if part.isdigit() else part
+            for part in re.split(r"\.|-", version)
+        ])
+    return (version,)
+
+class SysDepsParser:
+    def __init__(self, distro_info: Dict[str, Any] | None = None) -> None:
+        if distro_info is None:
+            distro_info = _get_distro_info()
+        self.distro_id: str = distro_info.get("distro_id", "")
+        self.aliases: List[str] = distro_info.get("aliases", [])
+        self.distro_version: Tuple[int | str, ...] = tuple()
+        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)
+        if len(parts) == 1:
+            return full_spec
+        pkg_name = parts[0].strip()
+        expressions = re.split(r"( and | or )", parts[1].strip())
+        if not len(expressions) & 1:
+            logging.info(
+                f"Requirement specifier is missing an expression "
+                f"between logical operators : {full_spec}"
+            )
+            return None
+        last_result: bool = True
+        last_logical_op: str | None = "and"
+        for idx, exp in enumerate(expressions):
+            if idx & 1:
+                if last_logical_op is not None:
+                    logging.info(
+                        "Requirement specifier contains sequential logical "
+                        f"operators: {full_spec}"
+                    )
+                    return None
+                logical_op = exp.strip()
+                if logical_op not in ("and", "or"):
+                    logging.info(
+                        f"Invalid logical operator {logical_op} in requirement "
+                        f"specifier: {full_spec}")
+                    return None
+                last_logical_op = logical_op
+                continue
+            elif last_logical_op is None:
+                logging.info(
+                    f"Requirement specifier contains two seqential expressions "
+                    f"without a logical operator: {full_spec}")
+                return None
+            dep_parts = re.split(r"(==|!=|<=|>=|<|>)", exp.strip())
+            req_var = dep_parts[0].strip().lower()
+            if len(dep_parts) != 3:
+                logging.info(f"Invalid comparison, must be 3 parts: {full_spec}")
+                return None
+            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(
+                        "Distro Version not detected, cannot satisfy requirement: "
+                        f"{full_spec}"
+                    )
+                    return None
+                left_op = self.distro_version
+                right_op = _convert_version(dep_parts[2].strip().strip("\"'"))
+            else:
+                logging.info(f"Invalid requirement specifier: {full_spec}")
+                return None
+            operator = dep_parts[1].strip()
+            try:
+                compfunc = {
+                    "<": lambda x, y: x < y,
+                    ">": lambda x, y: x > y,
+                    "==": lambda x, y: x == y,
+                    "!=": lambda x, y: x != y,
+                    ">=": lambda x, y: x >= y,
+                    "<=": lambda x, y: x <= y
+                }.get(operator, lambda x, y: False)
+                result = compfunc(left_op, right_op)
+                if last_logical_op == "and":
+                    last_result &= result
+                else:
+                    last_result |= result
+                last_logical_op = None
+            except Exception:
+                logging.exception(f"Error comparing requirements: {full_spec}")
+                return None
+        if last_result:
+            return pkg_name
+        return None
+
+    def parse_dependencies(self, sys_deps: Dict[str, List[str]]) -> List[str]:
+        if not self.distro_id:
+            logging.info(
+                "Failed to detect current distro ID, cannot parse dependencies"
+            )
+            return []
+        all_ids = [self.distro_id] + self.aliases
+        for distro_id in all_ids:
+            if distro_id in sys_deps:
+                if not sys_deps[distro_id]:
+                    logging.info(
+                        f"Dependency data contains an empty package definition "
+                        f"for linux distro '{distro_id}'"
+                    )
+                    continue
+                processed_deps: List[str] = []
+                for dep in sys_deps[distro_id]:
+                    parsed_dep = self._parse_spec(dep)
+                    if parsed_dep is not None:
+                        processed_deps.append(parsed_dep)
+                return processed_deps
+        else:
+            logging.info(
+                f"Dependency data has no package definition for linux "
+                f"distro '{self.distro_id}'"
+            )
+        return []
+# *** SYSTEM DEPENDENCIES START ***
+system_deps = {
+    "debian": [
+        "python3-virtualenv", "python3-dev", "libopenjp2-7", "libsodium-dev",
+        "zlib1g-dev", "libjpeg-dev", "packagekit",
+        "wireless-tools; distro_id != 'ubuntu' or distro_version <= '24.04'",
+        "iw; distro_id == 'ubuntu' and distro_version >= '24.10'",
+        "python3-libcamera; vendor == 'raspberry-pi' and distro_version >= '11'",
+        "curl", "build-essential"
+    ],
+}
+# *** SYSTEM DEPENDENCIES END ***
+parser = SysDepsParser()
+pkgs = parser.parse_dependencies(system_deps)
+if pkgs:
+    print(' '.join(pkgs), end="")
+exit(0)
+EOF
+)
 
   echo "${cyan}${packages}${white}" | tr '[:space:]' '\n'
   read -r -a packages <<< "${packages}"
 
-  ### Update system package info
-  status_msg "Updating package lists..."
-  if ! sudo apt-get update --allow-releaseinfo-change; then
-    log_error "failure while updating package lists"
-    error_msg "Updating package lists failed!"
-    exit 1
-  fi
+  ### Update system package lists if stale
+  update_system_package_lists
 
   ### Install required packages
-  status_msg "Installing required packages..."
-  if ! sudo apt-get install --yes "${packages[@]}"; then
-    log_error "failure while installing required moonraker packages"
-    error_msg "Installing required packages failed!"
-    exit 1
-  fi
+  install_system_packages "${log_name}" "packages[@]"
 }
 
 function create_moonraker_virtualenv() {
@@ -161,7 +351,6 @@ function create_moonraker_virtualenv() {
   [[ -d ${MOONRAKER_ENV} ]] && rm -rf "${MOONRAKER_ENV}"
 
   if virtualenv -p /usr/bin/python3 "${MOONRAKER_ENV}"; then
-    "${MOONRAKER_ENV}"/bin/pip install -U pip
     "${MOONRAKER_ENV}"/bin/pip install -r "${MOONRAKER_DIR}/scripts/moonraker-requirements.txt"
   else
     log_error "failure while creating python3 moonraker-env"
@@ -190,10 +379,10 @@ function moonraker_setup() {
   create_moonraker_conf "${instance_arr[@]}"
 
   ### step 4: create moonraker instances
-  create_moonraker_service "${instance_arr[@]}"
+  configure_moonraker_service "${instance_arr[@]}"
 
   ### step 5: create polkit rules for moonraker
-  moonraker_polkit || true
+  install_moonraker_polkit || true
 
   ### step 6: enable and start all instances
   do_action_service "enable" "moonraker"
@@ -225,18 +414,19 @@ function create_moonraker_conf() {
   local input=("${@}")
   local moonraker_count=${input[0]} && unset "input[0]"
   local names=("${input[@]}") && unset "input[@]"
-  local log="${KLIPPER_LOGS}"
-  local lan
+  local port lan printer_data cfg_dir cfg uds
+
+  port=7125
   lan="$(hostname -I | cut -d" " -f1 | cut -d"." -f1-2).0.0/16"
-  local port=7125 cfg_dir cfg db uds
 
   if (( moonraker_count == 1 )); then
-    cfg_dir="${KLIPPER_CONFIG}"
+    printer_data="${HOME}/printer_data"
+    cfg_dir="${printer_data}/config"
     cfg="${cfg_dir}/moonraker.conf"
-    db="${HOME}/.moonraker_database"
-    uds="/tmp/klippy_uds"
+    uds="${printer_data}/comms/klippy.sock"
+
     ### write single instance config
-    write_moonraker_conf "${cfg_dir}" "${cfg}" "${port}" "${log}" "${db}" "${uds}" "${lan}"
+    write_moonraker_conf "${cfg_dir}" "${cfg}" "${port}" "${uds}" "${lan}"
 
   elif (( moonraker_count > 1 )); then
     local j=0 re="^[1-9][0-9]*$"
@@ -244,16 +434,17 @@ function create_moonraker_conf() {
     for (( i=1; i <= moonraker_count; i++ )); do
       ### overwrite config folder if name is only a number
       if [[ ${names[j]} =~ ${re} ]]; then
-        cfg_dir="${KLIPPER_CONFIG}/printer_${names[${j}]}"
+        printer_data="${HOME}/printer_${names[${j}]}_data"
       else
-        cfg_dir="${KLIPPER_CONFIG}/${names[${j}]}"
+        printer_data="${HOME}/${names[${j}]}_data"
       fi
 
+      cfg_dir="${printer_data}/config"
       cfg="${cfg_dir}/moonraker.conf"
-      uds="/tmp/klippy_uds-${names[${j}]}"
-      db="${HOME}/.moonraker_database_${names[${j}]}"
+      uds="${printer_data}/comms/klippy.sock"
+
       ### write multi instance config
-      write_moonraker_conf "${cfg_dir}" "${cfg}" "${port}" "${log}" "${db}" "${uds}" "${lan}"
+      write_moonraker_conf "${cfg_dir}" "${cfg}" "${port}" "${uds}" "${lan}"
       port=$(( port + 1 ))
       j=$(( j + 1 ))
     done && unset j
@@ -264,7 +455,7 @@ function create_moonraker_conf() {
 }
 
 function write_moonraker_conf() {
-  local cfg_dir=${1} cfg=${2} port=${3} log=${4} db=${5} uds=${6} lan=${7}
+  local cfg_dir=${1} cfg=${2} port=${3} uds=${4} lan=${5}
   local conf_template="${KIAUH_SRCDIR}/resources/moonraker.conf"
 
   [[ ! -d ${cfg_dir} ]] && mkdir -p "${cfg_dir}"
@@ -272,8 +463,7 @@ function write_moonraker_conf() {
   if [[ ! -f ${cfg} ]]; then
     status_msg "Creating moonraker.conf in ${cfg_dir} ..."
     cp "${conf_template}" "${cfg}"
-    sed -i "s|%USER%|${USER}|g" "${cfg}"
-    sed -i "s|%CFG%|${cfg_dir}|; s|%PORT%|${port}|; s|%LOG%|${log}|; s|%DB%|${db}|; s|%UDS%|${uds}|" "${cfg}"
+    sed -i "s|%USER%|${USER}|g; s|%PORT%|${port}|; s|%UDS%|${uds}|" "${cfg}"
     # if host ip is not in the default ip ranges replace placeholder,
     # otherwise remove placeholder from config
     if ! grep -q "${lan}" "${cfg}"; then
@@ -287,20 +477,24 @@ function write_moonraker_conf() {
   fi
 }
 
-function create_moonraker_service() {
+function configure_moonraker_service() {
   local input=("${@}")
   local moonraker_count=${input[0]} && unset "input[0]"
   local names=("${input[@]}") && unset "input[@]"
-  local cfg_dir cfg log service
+  local printer_data cfg_dir service env_file
 
   if (( moonraker_count == 1 )) && [[ ${#names[@]} -eq 0 ]]; then
     i=""
-    cfg_dir="${KLIPPER_CONFIG}"
-    cfg="${cfg_dir}/moonraker.conf"
-    log="${KLIPPER_LOGS}/moonraker.log"
+    printer_data="${HOME}/printer_data"
+    cfg_dir="${printer_data}/config"
     service="${SYSTEMD}/moonraker.service"
+    env_file="${printer_data}/systemd/moonraker.env"
+
+    ### create required folder structure
+    create_required_folders "${printer_data}"
+
     ### write single instance service
-    write_moonraker_service "" "${cfg}" "${log}" "${service}"
+    write_moonraker_service "" "${printer_data}" "${service}" "${env_file}"
     ok_msg "Moonraker instance created!"
 
   elif (( moonraker_count > 1 )) && [[ ${#names[@]} -gt 0 ]]; then
@@ -309,25 +503,27 @@ function create_moonraker_service() {
     for (( i=1; i <= moonraker_count; i++ )); do
       ### overwrite config folder if name is only a number
       if [[ ${names[j]} =~ ${re} ]]; then
-        cfg_dir="${KLIPPER_CONFIG}/printer_${names[${j}]}"
+        printer_data="${HOME}/printer_${names[${j}]}_data"
       else
-        cfg_dir="${KLIPPER_CONFIG}/${names[${j}]}"
+        printer_data="${HOME}/${names[${j}]}_data"
       fi
 
-      cfg="${cfg_dir}/moonraker.conf"
-      log="${KLIPPER_LOGS}/moonraker-${names[${j}]}.log"
+      cfg_dir="${printer_data}/config"
       service="${SYSTEMD}/moonraker-${names[${j}]}.service"
+      env_file="${printer_data}/systemd/moonraker.env"
+
+      ### create required folder structure
+      create_required_folders "${printer_data}"
+
       ### write multi instance service
-      write_moonraker_service "${names[${j}]}" "${cfg}" "${log}" "${service}"
+      write_moonraker_service "${names[${j}]}" "${printer_data}" "${service}" "${env_file}"
       ok_msg "Moonraker instance 'moonraker-${names[${j}]}' created!"
       j=$(( j + 1 ))
     done && unset i
 
     ### enable mainsails remoteMode if mainsail is found
     if [[ -d ${MAINSAIL_DIR} ]]; then
-      status_msg "Mainsail installation found! Enabling Mainsail remote mode ..."
       enable_mainsail_remotemode
-      ok_msg "Mainsails remote mode enabled!"
     fi
 
   else
@@ -336,18 +532,20 @@ function create_moonraker_service() {
 }
 
 function write_moonraker_service() {
-  local i=${1} cfg=${2} log=${3} service=${4}
+  local i=${1} printer_data=${2} service=${3} env_file=${4}
   local service_template="${KIAUH_SRCDIR}/resources/moonraker.service"
+  local env_template="${KIAUH_SRCDIR}/resources/moonraker.env"
 
   ### replace all placeholders
   if [[ ! -f ${service} ]]; then
     status_msg "Creating Moonraker Service ${i} ..."
     sudo cp "${service_template}" "${service}"
+    sudo cp "${env_template}" "${env_file}"
 
-    [[ -z ${i} ]] && sudo sed -i "s| for instance moonraker-%INST%||" "${service}"
+    [[ -z ${i} ]] && sudo sed -i "s| %INST%||" "${service}"
     [[ -n ${i} ]] && sudo sed -i "s|%INST%|${i}|" "${service}"
-    sudo sed -i "s|%USER%|${USER}|; s|%ENV%|${MOONRAKER_ENV}|; s|%DIR%|${MOONRAKER_DIR}|" "${service}"
-    sudo sed -i "s|%CFG%|${cfg}|; s|%LOG%|${log}|" "${service}"
+    sudo sed -i "s|%USER%|${USER}|g; s|%MOONRAKER_DIR%|${MOONRAKER_DIR}|; s|%ENV%|${MOONRAKER_ENV}|; s|%ENV_FILE%|${env_file}|" "${service}"
+    sudo sed -i "s|%USER%|${USER}|; s|%MOONRAKER_DIR%|${MOONRAKER_DIR}|; s|%PRINTER_DATA%|${printer_data}|" "${env_file}"
   fi
 }
 
@@ -364,8 +562,20 @@ function print_mr_ip_list() {
 ### introduced due to
 ### https://github.com/Arksine/moonraker/issues/349
 ### https://github.com/Arksine/moonraker/pull/346
-function moonraker_polkit() {
+function install_moonraker_polkit() {
+  local POLKIT_LEGACY_FILE="/etc/polkit-1/localauthority/50-local.d/10-moonraker.pkla"
+  local POLKIT_FILE="/etc/polkit-1/rules.d/moonraker.rules"
+  local POLKIT_USR_FILE="/usr/share/polkit-1/rules.d/moonraker.rules"
+  local legacy_file_exists
+  local file_exists
+  local usr_file_exists
+
   local has_sup
+  local require_daemon_reload="false"
+
+  legacy_file_exists=$(sudo find "${POLKIT_LEGACY_FILE}" 2> /dev/null)
+  file_exists=$(sudo find "${POLKIT_FILE}" 2> /dev/null)
+  usr_file_exists=$(sudo find "${POLKIT_USR_FILE}" 2> /dev/null)
 
   ### check for required SupplementaryGroups entry in service files
   ### write it to the service if it doesn't exist
@@ -374,14 +584,25 @@ function moonraker_polkit() {
     if [[ -z ${has_sup} ]]; then
       status_msg "Adding moonraker-admin supplementary group to ${service} ..."
       sudo sed -i "/^Type=simple$/a SupplementaryGroups=moonraker-admin" "${service}"
+      require_daemon_reload="true"
       ok_msg "Adding moonraker-admin supplementary group successfull!"
     fi
   done
 
-  [[ -z ${has_sup} ]] && echo "reloading services!!!" && sudo systemctl daemon-reload
+  if [[ ${require_daemon_reload} == "true" ]]; then
+    status_msg "Reloading unit files ..."
+    sudo systemctl daemon-reload
+    ok_msg "Unit files reloaded!"
+  fi
 
-  ### execute moonrakers policykit-rules script
-  "${HOME}"/moonraker/scripts/set-policykit-rules.sh
+  ### execute moonrakers policykit-rules script only if rule files do not already exist
+  if [[ -z ${legacy_file_exists} && ( -z ${file_exists} || -z ${usr_file_exists} ) ]]; then
+    status_msg "Installing Moonraker policykit rules ..."
+    "${HOME}"/moonraker/scripts/set-policykit-rules.sh
+    ok_msg "Moonraker policykit rules installed!"
+  fi
+
+  return
 }
 
 #==================================================#
@@ -417,9 +638,35 @@ function remove_moonraker_systemd() {
   ok_msg "Moonraker Services removed!"
 }
 
+function remove_moonraker_env_file() {
+  local files regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/systemd\/moonraker\.env"
+  files=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)
+
+  if [[ -n ${files} ]]; then
+    for file in ${files}; do
+      status_msg "Removing ${file} ..."
+      rm -f "${file}"
+      ok_msg "${file} removed!"
+    done
+  fi
+}
+
 function remove_moonraker_logs() {
+  local files regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/logs\/moonraker\.log.*"
+  files=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)
+
+  if [[ -n ${files} ]]; then
+    for file in ${files}; do
+      status_msg "Removing ${file} ..."
+      rm -f "${file}"
+      ok_msg "${file} removed!"
+    done
+  fi
+}
+
+function remove_legacy_moonraker_logs() {
   local files regex="moonraker(-[0-9a-zA-Z]+)?\.log(.*)?"
-  files=$(find "${KLIPPER_LOGS}" -maxdepth 1 -regextype posix-extended -regex "${KLIPPER_LOGS}/${regex}" 2> /dev/null | sort)
+  files=$(find "${HOME}/klipper_logs" -maxdepth 1 -regextype posix-extended -regex "${HOME}/klipper_logs/${regex}" 2> /dev/null | sort)
 
   if [[ -n ${files} ]]; then
     for file in ${files}; do
@@ -473,7 +720,9 @@ function remove_moonraker_polkit() {
 function remove_moonraker() {
   remove_moonraker_sysvinit
   remove_moonraker_systemd
+  remove_moonraker_env_file
   remove_moonraker_logs
+  remove_legacy_moonraker_logs
   remove_moonraker_api_key
   remove_moonraker_polkit
   remove_moonraker_dir
@@ -503,7 +752,7 @@ function update_moonraker() {
   fi
 
   ### required due to https://github.com/Arksine/moonraker/issues/349
-  moonraker_polkit
+  install_moonraker_polkit || true
 
   ok_msg "Update complete!"
   do_action_service "restart" "moonraker"
@@ -557,7 +806,6 @@ function get_remote_moonraker_commit() {
 }
 
 function compare_moonraker_versions() {
-  unset MOONRAKER_UPDATE_AVAIL
   local versions local_ver remote_ver
   local_ver="$(get_local_moonraker_commit)"
   remote_ver="$(get_remote_moonraker_commit)"
@@ -565,13 +813,12 @@ function compare_moonraker_versions() {
   if [[ ${local_ver} != "${remote_ver}" ]]; then
     versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
     versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-    # add moonraker to the update all array for the update all function in the updater
-    MOONRAKER_UPDATE_AVAIL="true" && update_arr+=(update_moonraker)
+    # add moonraker to application_updates_available in kiauh.ini
+    add_to_application_updates "moonraker"
   else
     versions="${green}$(printf " %-14s" "${local_ver}")${white}"
     versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-    MOONRAKER_UPDATE_AVAIL="false"
   fi
 
   echo "${versions}"
-}
+}

scripts/nginx.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -74,23 +74,29 @@ function set_upstream_nginx_cfg() {
 }
 
 function symlink_webui_nginx_log() {
-  local interface=${1} path="${KLIPPER_LOGS}"
-  local access_log="/var/log/nginx/${interface}-access.log"
-  local error_log="/var/log/nginx/${interface}-error.log"
+  local interface path access_log error_log regex logpaths
 
-  [[ ! -d ${path} ]] && mkdir -p "${path}"
+  interface=${1}
+  access_log="/var/log/nginx/${interface}-access.log"
+  error_log="/var/log/nginx/${interface}-error.log"
+  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/logs"
+  logpaths=$(find "${HOME}" -maxdepth 2 -type d -regextype posix-extended -regex "${regex}" | sort)
 
-  if [[ -f ${access_log} && ! -L "${path}/${interface}-access.log" ]]; then
-    status_msg "Creating symlink for ${access_log} ..."
-    ln -s "${access_log}" "${path}"
-    ok_msg "Done!"
-  fi
+  for path in ${logpaths}; do
+    [[ ! -d ${path} ]] && mkdir -p "${path}"
 
-  if [[ -f ${error_log} && ! -L "${path}/${interface}-error.log" ]]; then
-    status_msg "Creating symlink for ${error_log} ..."
-    ln -s "${error_log}" "${path}"
-    ok_msg "Done!"
-  fi
+    if [[ -f ${access_log} && ! -L "${path}/${interface}-access.log" ]]; then
+      status_msg "Creating symlink for ${access_log} ..."
+      ln -s "${access_log}" "${path}"
+      ok_msg "Symlink created: ${path}/${interface}-access.log"
+    fi
+
+    if [[ -f ${error_log} && ! -L "${path}/${interface}-error.log" ]]; then
+      status_msg "Creating symlink for ${error_log} ..."
+      ln -s "${error_log}" "${path}"
+      ok_msg "Symlink created: ${path}/${interface}-error.log"
+    fi
+  done
 }
 
 function match_nginx_configs() {
@@ -100,7 +106,9 @@ function match_nginx_configs() {
   local common_vars="${NGINX_CONFD}/common_vars.conf"
   local mainsail_nginx_cfg="/etc/nginx/sites-available/mainsail"
   local fluidd_nginx_cfg="/etc/nginx/sites-available/fluidd"
-  local upstreams_webcams mainsail_webcams fluidd_webcams
+  local upstreams_webcams
+  local mainsail_webcams
+  local fluidd_webcams
 
   ### reinstall nginx configs if the amount of upstreams don't match anymore
   upstreams_webcams=$(grep -Ec "mjpgstreamer" "/etc/nginx/conf.d/upstreams.conf")
@@ -124,7 +132,7 @@ function match_nginx_configs() {
     status_msg "Outdated Mainsail config found! Updating ..."
 
     sudo rm -f "${mainsail_nginx_cfg}"
-    sudo cp "${RESOURCES}/klipper_webui_nginx.cfg" "${mainsail_nginx_cfg}"
+    sudo cp "${RESOURCES}/mainsail" "${mainsail_nginx_cfg}"
     sudo sed -i "s/<<UI>>/mainsail/g" "${mainsail_nginx_cfg}"
     sudo sed -i "/root/s/pi/${USER}/" "${mainsail_nginx_cfg}"
     sudo sed -i "s/listen\s[0-9]*;/listen ${mainsail_port};/" "${mainsail_nginx_cfg}"
@@ -138,7 +146,7 @@ function match_nginx_configs() {
     status_msg "Outdated Fluidd config found! Updating ..."
 
     sudo rm -f "${fluidd_nginx_cfg}"
-    sudo cp "${RESOURCES}/klipper_webui_nginx.cfg" "${fluidd_nginx_cfg}"
+    sudo cp "${RESOURCES}/fluidd" "${fluidd_nginx_cfg}"
     sudo sed -i "s/<<UI>>/fluidd/g" "${fluidd_nginx_cfg}"
     sudo sed -i "/root/s/pi/${USER}/" "${fluidd_nginx_cfg}"
     sudo sed -i "s/listen\s[0-9]*;/listen ${fluidd_port};/" "${fluidd_nginx_cfg}"
@@ -260,8 +268,7 @@ function detect_conflicting_packages() {
           echo -e "###### > Skip"
           break;;
         *)
-          print_unkown_cmd
-          print_msg && clear_msg;;
+          error_msg "Invalid command!";;
       esac
     done
   fi
@@ -269,34 +276,25 @@ function detect_conflicting_packages() {
 
 function set_nginx_cfg() {
   local interface=${1}
+
   if [[ ${SET_NGINX_CFG} == "true" ]]; then
-    local cfg="${RESOURCES}/${interface}"
     #check for dependencies
     local dep=(nginx)
     dependency_check "${dep[@]}"
 
-    status_msg "Creating Nginx configuration for ${interface^} ..."
-    cat "${RESOURCES}/klipper_webui_nginx.cfg" > "${cfg}"
-    sed -i "s/<<UI>>/${interface}/g" "${cfg}"
+    local cfg_src="${RESOURCES}/${interface}"
+    local cfg_dest="/etc/nginx/sites-available/${interface}"
+
+    status_msg "Creating NGINX configuration for ${interface^} ..."
+
+    # copy config to destination and set correct username
+    [[ -f ${cfg_dest} ]] && sudo rm -f "${cfg_dest}"
+    sudo cp "${cfg_src}" "${cfg_dest}"
+    sudo sed -i "/root/s/pi/${USER}/" "${cfg_dest}"
 
     if [[ ${SET_LISTEN_PORT} != "${DEFAULT_PORT}" ]]; then
-      status_msg "Configuring port for ${interface^} ..."
-      sed -i "s/listen\s[0-9]*;/listen ${SET_LISTEN_PORT};/" "${cfg}"
-      sed -i "s/listen\s\[\:*\]\:[0-9]*;/listen \[::\]\:${SET_LISTEN_PORT};/" "${cfg}"
-    fi
-
-    #set correct user
-    if [[ ${interface} == "mainsail" || ${interface} == "fluidd" ]]; then
-      sudo sed -i "/root/s/pi/${USER}/" "${cfg}"
-    fi
-
-    #moving the config file into correct directory
-    sudo mv "${cfg}" "/etc/nginx/sites-available/${interface}"
-    ok_msg "Nginx configuration for ${interface^} was set!"
-    if [[ -n ${SET_LISTEN_PORT} ]]; then
-      ok_msg "${interface^} configured for port ${SET_LISTEN_PORT}!"
-    else
-      ok_msg "${interface^} configured for default port ${DEFAULT_PORT}!"
+      sudo sed -i "s/listen\s[0-9]*;/listen ${SET_LISTEN_PORT};/" "${cfg_dest}"
+      sudo sed -i "s/listen\s\[\:*\]\:[0-9]*;/listen \[::\]\:${SET_LISTEN_PORT};/" "${cfg_dest}"
     fi
 
     #remove nginx default config
@@ -308,17 +306,32 @@ function set_nginx_cfg() {
     if [[ ! -e "/etc/nginx/sites-enabled/${interface}" ]]; then
       sudo ln -s "/etc/nginx/sites-available/${interface}" "/etc/nginx/sites-enabled/"
     fi
+
+    if [[ -n ${SET_LISTEN_PORT} ]]; then
+      ok_msg "${interface^} configured for port ${SET_LISTEN_PORT}!"
+    else
+      ok_msg "${interface^} configured for default port ${DEFAULT_PORT}!"
+    fi
+
     sudo systemctl restart nginx.service
+
+    ok_msg "NGINX configuration for ${interface^} was set!"
   fi
 }
 
+###
+# check if permissions of the users home directory
+# grant execution rights to group and other which is
+# required for NGINX to be able to serve Mainsail/Fluidd
+#
 function set_nginx_permissions() {
-  local distro_name version_id
+  local homedir_perm
+  local exec_perms_count
 
-  distro_name=$(grep -E "^NAME=" /etc/os-release | cut -d'"' -f2)
-  version_id=$(grep -E "^VERSION_ID=" /etc/os-release | cut -d'"' -f2)
+  homedir_perm=$(ls -ld "${HOME}")
+  exec_perms_count=$(echo "${homedir_perm}" | cut -d" " -f1 | grep -c "x")
 
-  if [[ ${distro_name} == "Ubuntu" && ( ${version_id} == "21.10" || ${version_id} == "22.04") ]]; then
+  if (( exec_perms_count < 3 )); then
     status_msg "Granting NGINX the required permissions ..."
     chmod og+x "${HOME}" && ok_msg "Done!"
   fi
@@ -344,4 +357,4 @@ function detect_enabled_sites() {
     FLUIDD_PORT=$(read_listen_port "fluidd")
 
   fi
-}
+}

scripts/obico.sh

@@ -0,0 +1,489 @@
+#!/usr/bin/env bash
+
+#=======================================================================#
+# 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                                         #
+#                                                                       #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+#=======================================================================#
+
+set -e
+
+#===================================================#
+#============== INSTALL MOONRAKER-OBICO ============#
+#===================================================#
+
+function moonraker_obico_systemd() {
+  local services
+  services=$(find "${SYSTEMD}" -maxdepth 1 -regextype posix-extended -regex "${SYSTEMD}/moonraker-obico(-[0-9a-zA-Z]+)?.service")
+  echo "${services}"
+}
+
+function moonraker_obico_config() {
+  local moonraker_cfg_dirs
+
+  read -r -a moonraker_cfg_dirs <<< "$(get_instance_folder_path "config")"
+
+  if (( ${#moonraker_cfg_dirs[@]} > 0 )); then
+    echo "${moonraker_cfg_dirs[${1}]}/moonraker-obico.cfg"
+  else
+    echo ""
+  fi
+}
+
+function moonraker_obico_needs_linking() {
+  local moonraker_obico_cfg=${1}
+  if [[ ! -f "${moonraker_obico_cfg}" ]]; then
+    return 1
+  fi
+  if grep -s -E "^[^#]" "${moonraker_obico_cfg}" | grep -q 'auth_token'; then
+    return 1
+  else
+    return 0
+  fi
+}
+
+function obico_server_url_prompt() {
+  top_border
+  printf "|${green}%-55s${white}|\n" " Obico Server URL"
+  blank_line
+  echo -e "| You can use a self-hosted Obico Server or the Obico   |"
+  echo -e "| Cloud. For more information, please visit:            |"
+  echo -e "| https://obico.io.                                     |"
+  blank_line
+  echo -e "| For the Obico Cloud, leave it as the default:         |"
+  printf "|${cyan}%-55s${white}|\n" " https://app.obico.io"
+  blank_line
+  echo -e "| For self-hosted server, specify:                      |"
+  printf "|${cyan}%-55s${white}|\n" " http://server_ip:port"
+  echo -e "| For instance, 'http://192.168.0.5:3334'.              |"
+  bottom_border
+}
+
+function moonraker_obico_setup_dialog() {
+  status_msg "Initializing Obico installation ..."
+
+  local moonraker_count
+  local moonraker_names
+
+  moonraker_count=$(moonraker_systemd | wc -w)
+
+  if (( moonraker_count == 0 )); then
+    ### return early if moonraker is not installed
+    local error="Moonraker not installed! Please install Moonraker first!"
+    log_error "Obico setup started without Moonraker being installed. Aborting setup."
+    print_error "${error}" && return
+  elif (( moonraker_count > 1 )); then
+    # moonraker_names is valid only in case of multi-instance
+    read -r -a moonraker_names <<< "$(get_multi_instance_names)"
+  fi
+
+  local moonraker_obico_services
+  local existing_moonraker_obico_count
+  moonraker_obico_services=$(moonraker_obico_systemd)
+  existing_moonraker_obico_count=$(echo "${moonraker_obico_services}" | wc -w )
+  local allowed_moonraker_obico_count=$(( moonraker_count - existing_moonraker_obico_count ))
+
+  # Allow user to reinstall an incomplete installation.
+  if (( allowed_moonraker_obico_count == 0 && moonraker_count > 0 )) && [[ $(get_moonraker_obico_status) != "Not linked!" ]]; then
+    local yn
+    while true; do
+      echo "${yellow}Obico is already installed.${white}"
+      echo "It is safe to run the install again to repair any issues."
+      echo ""
+      local question="Do you want to reinstall Obico?"
+      read -p "${cyan}###### ${question} (Y/n):${white} " yn
+      case "${yn}" in
+        Y|y|Yes|yes|"")
+          select_msg "Yes"
+          break;;
+        N|n|No|no)
+          select_msg "No"
+          abort_msg "Exiting Obico installation...\n"
+          return;;
+        *)
+          error_msg "Invalid Input!";;
+      esac
+    done
+    # The user responded yes, allow the install to run again.
+    allowed_moonraker_obico_count=1
+  fi
+
+  if (( allowed_moonraker_obico_count > 0 )); then
+    local new_moonraker_obico_count
+
+    ### Step 1: Ask for the number of moonraker-obico instances to install
+    if (( moonraker_count == 1 )); then
+      ok_msg "Moonraker installation found!\n"
+      new_moonraker_obico_count=1
+    elif (( moonraker_count > 1 )); then
+      top_border
+      printf "|${green}%-55s${white}|\n" " ${moonraker_count} Moonraker instances found!"
+      for name in "${moonraker_names[@]}"; do
+        printf "|${cyan}%-57s${white}|\n" " ● moonraker-${name}"
+      done
+      blank_line
+      if (( existing_moonraker_obico_count > 0 )); then
+        printf "|${green}%-55s${white}|\n" " ${existing_moonraker_obico_count} Obico instances already installed!"
+        for svc in ${moonraker_obico_services}; do
+          printf "|${cyan}%-57s${white}|\n" " ● moonraker-obco-$(get_instance_name "${svc}")"
+        done
+      fi
+      blank_line
+      echo -e "| The setup will apply the same names to Obico!         |"
+      blank_line
+      echo -e "| Please select the number of Obico instances           |"
+      echo -e "| to install. Usually one Obico instance per            |"
+      echo -e "| Moonraker instance is required, but you may not       |"
+      echo -e "| install more Obico instances than available           |"
+      echo -e "| Moonraker instances.                                  |"
+      bottom_border
+
+      ### ask for amount of instances
+      local re="^[1-9][0-9]*$"
+      while [[ ! ${new_moonraker_obico_count} =~ ${re} || ${new_moonraker_obico_count} -gt ${allowed_moonraker_obico_count} ]]; do
+        read -p "${cyan}###### Number of new Obico instances to set up:${white} " -i "${allowed_moonraker_obico_count}" -e new_moonraker_obico_count
+        ### break if input is valid
+        [[ ${new_moonraker_obico_count} =~ ${re} && ${new_moonraker_obico_count} -le ${allowed_moonraker_obico_count} ]] && break
+        ### conditional error messages
+        [[ ! ${new_moonraker_obico_count} =~ ${re} ]] && error_msg "Input not a number"
+        (( new_moonraker_obico_count > allowed_moonraker_obico_count )) && error_msg "Number of Obico instances larger than installed Moonraker instances"
+      done && select_msg "${new_moonraker_obico_count}"
+    else
+      log_error "Internal error. moonraker_count of '${moonraker_count}' not equal or grather than one!"
+      return 1
+    fi  # (( moonraker_count == 1 ))
+
+    ### Step 2: Confirm instance amount
+    local yn
+    while true; do
+      (( new_moonraker_obico_count == 1 )) && local question="Install Obico?"
+      (( new_moonraker_obico_count > 1 )) && local question="Install ${new_moonraker_obico_count} Obico instances?"
+      read -p "${cyan}###### ${question} (Y/n):${white} " yn
+      case "${yn}" in
+        Y|y|Yes|yes|"")
+          select_msg "Yes"
+          break;;
+        N|n|No|no)
+          select_msg "No"
+          abort_msg "Exiting Obico setup ...\n"
+          return;;
+        *)
+          error_msg "Invalid Input!";;
+      esac
+    done
+  fi  # (( allowed_moonraker_obico_count > 0 ))
+
+  if (( new_moonraker_obico_count > 0 )); then
+
+    ### Step 3: Ask for the Obico server URL
+    obico_server_url_prompt
+    local obico_server_url
+    while true; do
+      read -p "${cyan}###### Obico Server URL:${white} " -i "https://app.obico.io" -e obico_server_url
+      if echo "${obico_server_url}" | grep -qE "^(http|https)://[a-zA-Z0-9./?=_%:-]*"; then
+        break
+      else
+        error_msg "Invalid server URL!"
+      fi
+    done
+
+    (( new_moonraker_obico_count > 1 )) && status_msg "Installing ${new_moonraker_obico_count} Obico instances ..."
+    (( new_moonraker_obico_count == 1 )) && status_msg "Installing Obico ..."
+
+    ### Step 5: Clone the moonraker-obico repo
+    clone_moonraker_obico "${MOONRAKER_OBICO_REPO}"
+
+    ### step 6: call moonrake-obico/install.sh with the correct params
+    local port=7125
+    local instance_cfg_dirs
+    local instance_log_dirs
+
+    read -r -a instance_cfg_dirs <<< "$(get_instance_folder_path "config")"
+    read -r -a instance_log_dirs <<< "$(get_instance_folder_path "logs")"
+
+    if (( moonraker_count == 1 )); then
+      "${MOONRAKER_OBICO_DIR}/install.sh"\
+      -C "${instance_cfg_dirs[0]}/moonraker.conf"\
+      -p "${port}" -H 127.0.0.1 -l\
+      "${instance_log_dirs[0]}"\
+      -L -S "${obico_server_url}"
+    elif (( moonraker_count > 1 )); then
+      local j=${existing_moonraker_obico_count}
+
+      for (( i=1; i <= new_moonraker_obico_count; i++ )); do
+        "${MOONRAKER_OBICO_DIR}/install.sh"\
+        -n "${moonraker_names[${j}]}"\
+        -C "${instance_cfg_dirs[${j}]}/moonraker.conf"\
+        -p $((port+j))\
+        -H 127.0.0.1\
+        -l "${instance_log_dirs[${j}]}"\
+        -L -S "${obico_server_url}"
+        j=$(( j + 1 ))
+      done && unset j
+    fi # (( moonraker_count == 1 ))
+  fi  # (( new_moonraker_obico_count > 0 ))
+
+  ### Step 7: Link to the Obico server if necessary
+  local not_linked_instances=()
+  if (( moonraker_count == 1 )); then
+    if moonraker_obico_needs_linking "$(moonraker_obico_config 0)"; then
+      not_linked_instances+=("0")
+    fi
+  elif (( moonraker_count > 1 )); then
+    for (( i=0; i <= moonraker_count; i++ )); do
+      if moonraker_obico_needs_linking "$(moonraker_obico_config "${i}")"; then
+        not_linked_instances+=("${i}")
+      fi
+    done
+  fi  # (( moonraker_count == 1 ))
+
+  if (( ${#not_linked_instances[@]} > 0 )); then
+    top_border
+    if (( moonraker_count == 1 )); then
+      printf "|${green}%-55s${white}|\n" " Obico not linked to the server!"
+    else
+      printf "|${green}%-55s${white}|\n" " ${#not_linked_instances[@]} Obico instances not linked to the server!"
+      for i in "${not_linked_instances[@]}"; do
+        printf "|${cyan}%-57s${white}|\n" " ● moonraker-obico-${moonraker_names[${i}]}"
+      done
+    fi
+    blank_line
+    echo -e "| It will take only 10 seconds to link printer to Obico.|"
+    echo -e "| For more information, visit:                          |"
+    echo -e "| https://www.obico.io/docs/user-guides/klipper-setup/  |"
+    blank_line
+    echo -e "| If you don't want to link the printer now, you can    |"
+    echo -e "| restart the linking process later by:                 |"
+    echo -e "| 1. 'cd ~/kiauh && ./kiauh.sh' to launch KIAUH.        |"
+    echo -e "| 2. Select ${green}[Install]${white}                                   |"
+    echo -e "| 3. Select ${green}[Link to Obico Server]${white}                      |"
+    bottom_border
+
+    while true; do
+      read -p "${cyan}###### Link to your Obico Server account now? (Y/n):${white} " yn
+      case "${yn}" in
+        Y|y|Yes|yes|"")
+          select_msg "Yes"
+          break;;
+        N|n|No|no)
+          select_msg "No"
+          abort_msg "Exiting Obico setup ...\n"
+          return;;
+        *)
+          error_msg "Invalid Input!";;
+      esac
+    done
+
+    if (( moonraker_count == 1 )); then
+      status_msg "Link moonraker-obico to the Obico Server..."
+      "${MOONRAKER_OBICO_DIR}/scripts/link.sh" -q -c "$(moonraker_obico_config 0)"
+    elif (( moonraker_count > 1 )); then
+      for i in "${not_linked_instances[@]}"; do
+        local name="${moonraker_names[i]}"
+        status_msg "Link moonraker-obico-${name} to the Obico Server..."
+        "${MOONRAKER_OBICO_DIR}/scripts/link.sh" -q -n "${name}" -c "$(moonraker_obico_config "${i}")"
+      done
+    fi  # (( moonraker_count == 1 ))
+  fi  # (( ${#not_linked_instances[@]} > 0 ))
+}
+
+function clone_moonraker_obico() {
+  local repo=${1}
+
+  status_msg "Cloning Obico from ${repo} ..."
+  ### force remove existing Obico dir
+  [[ -d "${MOONRAKER_OBICO_DIR}" ]] && rm -rf "${MOONRAKER_OBICO_DIR}"
+
+  cd "${HOME}" || exit 1
+  if ! git clone "${repo}" "${MOONRAKER_OBICO_DIR}"; then
+    print_error "Cloning Obico from\n ${repo}\n failed!"
+    exit 1
+  fi
+}
+
+function moonraker_obico_install() {
+  "${MOONRAKER_OBICO_DIR}/install.sh" "$@"
+}
+
+#===================================================#
+#============= REMOVE MOONRAKER-OBICO ==============#
+#===================================================#
+
+function remove_moonraker_obico_systemd() {
+  [[ -z $(moonraker_obico_systemd) ]] && return
+  status_msg "Removing Obico Systemd Services ..."
+
+  for service in $(moonraker_obico_systemd | cut -d"/" -f5); do
+    status_msg "Removing ${service} ..."
+    sudo systemctl stop "${service}"
+    sudo systemctl disable "${service}"
+    sudo rm -f "${SYSTEMD}/${service}"
+    ok_msg "Done!"
+  done
+
+  ### reloading units
+  sudo systemctl daemon-reload
+  sudo systemctl reset-failed
+  ok_msg "Obico Services removed!"
+}
+
+function remove_moonraker_obico_logs() {
+  local files regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/logs\/moonraker-obico(-[0-9a-zA-Z]+)?\.log(.*)?"
+  files=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)
+
+  if [[ -n ${files} ]]; then
+    for file in ${files}; do
+      status_msg "Removing ${file} ..."
+      rm -f "${file}"
+      ok_msg "${file} removed!"
+    done
+  fi
+}
+
+function remove_legacy_moonraker_obico_logs() {
+  local files regex="moonraker-obico(-[0-9a-zA-Z]+)?\.log(.*)?"
+  files=$(find "${HOME}/klipper_logs" -maxdepth 1 -regextype posix-extended -regex "${HOME}/klipper_logs/${regex}" 2> /dev/null | sort)
+
+  if [[ -n ${files} ]]; then
+    for file in ${files}; do
+      status_msg "Removing ${file} ..."
+      rm -f "${file}"
+      ok_msg "${file} removed!"
+    done
+  fi
+}
+
+function remove_moonraker_obico_dir() {
+  [[ ! -d ${MOONRAKER_OBICO_DIR} ]] && return
+
+  status_msg "Removing Obico directory ..."
+  rm -rf "${MOONRAKER_OBICO_DIR}"
+  ok_msg "Directory removed!"
+}
+
+function remove_moonraker_obico_env() {
+  [[ ! -d "${HOME}/moonraker-obico-env" ]] && return
+
+  status_msg "Removing moonraker-obico-env directory ..."
+  rm -rf "${HOME}/moonraker-obico-env"
+  ok_msg "Directory removed!"
+}
+
+function remove_moonraker_obico() {
+  remove_moonraker_obico_systemd
+  remove_moonraker_obico_logs
+  remove_moonraker_obico_dir
+  remove_moonraker_obico_env
+
+  print_confirm "Obico was successfully removed!"
+  return
+}
+
+#===================================================#
+#============= UPDATE MOONRAKER-OBICO ==============#
+#===================================================#
+
+function update_moonraker_obico() {
+  do_action_service "stop" "moonraker-obico"
+
+  if [[ ! -d ${MOONRAKER_OBICO_DIR} ]]; then
+    clone_moonraker_obico "${MOONRAKER_OBICO_REPO}"
+  else
+    status_msg "Updating Obico ..."
+    cd "${MOONRAKER_OBICO_DIR}" && git pull
+  fi
+
+  "${MOONRAKER_OBICO_DIR}/install.sh" -U
+
+  ok_msg "Update complete!"
+  do_action_service "restart" "moonraker-obico"
+}
+
+#===================================================#
+#============= MOONRAKER-OBICO STATUS ==============#
+#===================================================#
+
+function get_moonraker_obico_status() {
+  local status
+  local service_count
+  local is_linked
+  local moonraker_obico_services
+
+  moonraker_obico_services=$(moonraker_obico_systemd)
+  service_count=$(echo "${moonraker_obico_services}" | wc -w )
+
+  is_linked="true"
+  if [[ -n ${moonraker_obico_services} ]]; then
+    for cfg_dir in $(get_instance_folder_path "config"); do
+      if moonraker_obico_needs_linking "${cfg_dir}/moonraker-obico.cfg"; then
+        is_linked="false"
+      fi
+    done
+  fi
+
+  if (( service_count == 0 )); then
+    status="Not installed!"
+  elif [[ ! -d "${MOONRAKER_OBICO_DIR}" ]]; then
+    status="Incomplete!"
+  elif [[ ${is_linked} == "false" ]]; then
+    status="Not linked!"
+  else
+    status="Installed!"
+  fi
+
+  echo "${status}"
+}
+
+function get_local_moonraker_obico_commit() {
+  [[ ! -d ${MOONRAKER_OBICO_DIR} || ! -d "${MOONRAKER_OBICO_DIR}/.git" ]] && return
+
+  local commit
+  cd "${MOONRAKER_OBICO_DIR}"
+  commit="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
+  echo "${commit}"
+}
+
+function get_remote_moonraker_obico_commit() {
+  [[ ! -d ${MOONRAKER_OBICO_DIR} || ! -d "${MOONRAKER_OBICO_DIR}/.git" ]] && return
+
+  local commit
+  cd "${MOONRAKER_OBICO_DIR}" && git fetch origin -q
+  commit=$(git describe origin/master --always --tags | cut -d "-" -f 1,2)
+  echo "${commit}"
+}
+
+function compare_moonraker_obico_versions() {
+  local versions local_ver remote_ver
+  local_ver="$(get_local_moonraker_obico_commit)"
+  remote_ver="$(get_remote_moonraker_obico_commit)"
+
+  if [[ ${local_ver} != "${remote_ver}" ]]; then
+    versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+    # add moonraker to application_updates_available in kiauh.ini
+    add_to_application_updates "moonraker_obico"
+  else
+    versions="${green}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+  fi
+
+  echo "${versions}"
+}
+
+###
+# it is possible, that moonraker_obico is installed in a so called
+# "non-linked" state. the linking can be achieved by running the
+# installation script again. this function will check the obico
+# installation status and returns the correctly formulated menu title
+#
+function obico_install_title() {
+  if [[ $(get_moonraker_obico_status) == "Not linked!" ]]; then
+    echo "[Link to Obico Server]"
+  else
+    echo "[Obico for Klipper]   "
+  fi
+}
+

scripts/octoapp.sh

@@ -0,0 +1,369 @@
+#!/usr/bin/env bash
+
+#=======================================================================#
+# 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                                         #
+#                                                                       #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+#=======================================================================#
+
+#
+# This file is written and maintained by Christian Würthner from OctoApp
+# Please contact me if you need any help!
+# hello@octoapp.eu
+#
+
+set -e
+
+#===================================================#
+#==============         Install         ============#
+#===================================================#
+
+function octoapp_systemd() {
+  local services
+  services=$(find "${SYSTEMD}" -maxdepth 1 -regextype posix-extended -regex "${SYSTEMD}/octoapp(-[0-9a-zA-Z]+)?.service")
+  echo "${services}"
+}
+
+function octoapp_setup_dialog() {
+  status_msg "Initializing OctoApp for Klipper installation ..."
+
+  # First, check for moonraker service instances.
+  local moonraker_count
+  local moonraker_names
+  moonraker_count=$(moonraker_systemd | wc -w)
+  if (( moonraker_count == 0 )); then
+    ### return early if moonraker is not installed
+    local error="Moonraker not installed! Please install Moonraker first!"
+    log_error   "OctoApp setup started without Moonraker being installed. Aborting setup."
+    print_error "${error}" && return
+  elif (( moonraker_count > 1 )); then
+    # moonraker_names is valid only in case of multi-instance
+    read -r -a moonraker_names <<< "$(get_multi_instance_names)"
+  fi
+
+  # Next, check for any existing OctoApp services.
+  local octoapp_services
+  local existing_octoapp_count
+  octoapp_services=$(octoapp_systemd)
+  existing_octoapp_count=$(echo "${octoapp_services}" | wc -w )
+
+  # We need to make the moonraker instance count to the OctoApp service count.
+  local allowed_octoapp_count=$(( moonraker_count - existing_octoapp_count ))
+  if (( allowed_octoapp_count > 0 )); then
+    local new_octoapp_count
+
+    ### Step 1: Ask for the number of OctoApp instances to install
+    if (( moonraker_count == 1 )); then
+      ok_msg "Moonraker installation found!\n"
+      new_octoapp_count=1
+    elif (( moonraker_count > 1 )); then
+      top_border
+      printf "|${green}%-55s${white}|\n" " ${moonraker_count} Moonraker instances found!"
+      for name in "${moonraker_names[@]}"; do
+        printf "|${cyan}%-57s${white}|\n" " ● moonraker-${name}"
+      done
+      blank_line
+      if (( existing_octoapp_count > 0 )); then
+        printf "|${green}%-55s${white}|\n" " ${existing_octoapp_count} OctoApp instances already installed!"
+        for svc in ${octoapp_services}; do
+          printf "|${cyan}%-57s${white}|\n" " ● octoapp-$(get_instance_name "${svc}")"
+        done
+      fi
+      blank_line
+      echo -e "| The setup will apply the same names to OctoApp        |"
+      blank_line
+      echo -e "| Please select the number of OctoApp instances to      |"
+      echo -e "| install. Usually one OctoApp instance per Moonraker   |"
+      echo -e "| instance is required, but you may not install more    |"
+      echo -e "| OctoApp instances than available Moonraker instances. |"
+      bottom_border
+
+      ### ask for amount of instances
+      local re="^[1-9][0-9]*$"
+      while [[ ! ${new_octoapp_count} =~ ${re} || ${new_octoapp_count} -gt ${allowed_octoapp_count} ]]; do
+        read -p "${cyan}###### Number of new OctoApp instances to set up:${white} " -i "${allowed_octoapp_count}" -e new_octoapp_count
+        ### break if input is valid
+        [[ ${new_octoapp_count} =~ ${re} && ${new_octoapp_count} -le ${allowed_octoapp_count} ]] && break
+        ### conditional error messages
+        [[ ! ${new_octoapp_count} =~ ${re} ]] && error_msg "Input not a number"
+        (( new_octoapp_count > allowed_octoapp_count )) && error_msg "Number of OctoApp instances larger than installed Moonraker instances"
+      done && select_msg "${new_octoapp_count}"
+    else
+      log_error "Internal error. moonraker_count of '${moonraker_count}' not equal or grater than one!"
+      return 1
+    fi  # (( moonraker_count == 1 ))
+  fi  # (( allowed_octoapp_count > 0 ))
+
+  # Special case for one moonraker instance with OctoApp already installed.
+  # If the user selects the install option again, they might be trying to recover the install
+  # or complete a printer link they didn't finish in the past.
+  # So in this case, we will allow them to run the install script again, since it's safe to run
+  # if the service is already installed, it will repair any missing issues.
+  if (( allowed_octoapp_count == 0 && moonraker_count == 1 )); then
+    local yn
+    while true; do
+      echo "${yellow}OctoApp is already installed.${white}"
+      echo "It is safe to run the install again to repair any issues or if the printer isn't linked, run the printer linking logic again."
+      echo ""
+      local question="Do you want to run the OctoApp recovery or linking logic again?"
+      read -p "${cyan}###### ${question} (Y/n):${white} " yn
+      case "${yn}" in
+        Y|y|Yes|yes|"")
+          select_msg "Yes"
+          break;;
+        N|n|No|no)
+          select_msg "No"
+          abort_msg "Exiting OctoApp setup ...\n"
+          return;;
+        *)
+          error_msg "Invalid Input!";;
+      esac
+    done
+    # The user responded yes, allow the install to run again.
+    allowed_octoapp_count=1
+  fi
+
+  # If there's something to install, do it!
+  if (( allowed_octoapp_count > 0 )); then
+
+    (( new_octoapp_count > 1 )) && status_msg "Installing ${new_octoapp_count} OctoApp instances ..."
+    (( new_octoapp_count == 1 )) && status_msg "Installing OctoApp ..."
+
+    # Ensure the basic system dependencies are installed.
+    local dep=(git dfu-util virtualenv python3 python3-pip python3-venv)
+    dependency_check "${dep[@]}"
+
+    # Close the repo
+    clone_octoapp "${OCTOAPP_REPO}"
+
+    # Call install with the correct args.
+    local instance_cfg_dirs
+    read -r -a instance_cfg_dirs <<< "$(get_instance_folder_path "config")"
+    echo instance_cfg_dirs[0]
+
+    if (( moonraker_count == 1 )); then
+      "${OCTOAPP_DIR}/install.sh" "${instance_cfg_dirs[0]}/moonraker.conf"
+    elif (( moonraker_count > 1 )); then
+      local j=${existing_octoapp_count}
+
+      for (( i=1; i <= new_octoapp_count; i++ )); do
+        "${OCTOAPP_DIR}/install.sh" "${instance_cfg_dirs[${j}]}/moonraker.conf"
+        j=$(( j + 1 ))
+      done && unset j
+    fi # (( moonraker_count == 1 ))
+  fi  # (( allowed_octoapp_count > 0 ))
+}
+
+function octoapp_install() {
+  "${OCTOAPP_DIR}/install.sh" "$@"
+}
+
+#===================================================#
+#=============        Remove          ==============#
+#===================================================#
+
+function remove_octoapp_systemd() {
+  [[ -z $(octoapp_systemd) ]] && return
+  status_msg "Removing OctoApp Systemd Services ..."
+
+  for service in $(octoapp_systemd | cut -d"/" -f5); do
+    status_msg "Removing ${service} ..."
+    sudo systemctl stop "${service}"
+    sudo systemctl disable "${service}"
+    sudo rm -f "${SYSTEMD}/${service}"
+    ok_msg "Done!"
+  done
+
+  ### reloading units
+  sudo systemctl daemon-reload
+  sudo systemctl reset-failed
+  ok_msg "OctoApp Services removed!"
+}
+
+function remove_octoapp_logs() {
+  local files regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/logs\/octoapp(-[0-9a-zA-Z]+)?\.log(.*)?"
+  files=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)
+
+  if [[ -n ${files} ]]; then
+    for file in ${files}; do
+      status_msg "Removing ${file} ..."
+      rm -f "${file}"
+      ok_msg "${file} removed!"
+    done
+  fi
+}
+
+function remove_octoapp_dir() {
+  [[ ! -d ${OCTOAPP_DIR} ]] && return
+
+  status_msg "Removing OctoApp directory ..."
+  rm -rf "${OCTOAPP_DIR}"
+  ok_msg "Directory removed!"
+}
+
+function remove_octoapp_config() {
+  # Remove the system config but not the main config, so the printer id doesn't get lost.
+  local files regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/octoapp-system(-[0-9a-zA-Z]+)?\.cfg(.*)?"
+  files=$(find "${HOME}" -maxdepth 4 -regextype posix-extended -regex "${regex}" | sort)
+
+  if [[ -n ${files} ]]; then
+    for file in ${files}; do
+      status_msg "Removing ${file} ..."
+      rm -f "${file}"
+      ok_msg "${file} removed!"
+    done
+  fi
+}
+
+function remove_octoapp_store_dir() {
+  local files regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/octoapp-store"
+  files=$(find "${HOME}" -maxdepth 2 -type d -regextype posix-extended -regex "${regex}" | sort)
+
+  if [[ -n ${files} ]]; then
+    for file in ${files}; do
+      status_msg "Removing ${file} ..."
+      rm -rf "${file}"
+      ok_msg "${file} removed!"
+    done
+  fi
+}
+
+function remove_octoapp_env() {
+  [[ ! -d "${HOME}/octoapp-env" ]] && return
+
+  status_msg "Removing octoapp-env directory ..."
+  rm -rf "${HOME}/octoapp-env"
+  ok_msg "Directory removed!"
+}
+
+function remove_octoapp()
+{
+  remove_octoapp_systemd
+  remove_octoapp_logs
+  remove_octoapp_dir
+  remove_octoapp_env
+  remove_octoapp_config
+  remove_octoapp_store_dir
+
+  print_confirm "OctoApp was successfully removed!"
+  return
+}
+
+#===================================================#
+#=============        UPDATE          ==============#
+#===================================================#
+
+function update_octoapp() {
+  do_action_service "stop" "octoapp"
+
+  if [[ ! -d ${OCTOAPP_DIR} ]]; then
+    clone_octoapp "${OCTOAPP_REPO}"
+  else
+    backup_before_update "octoapp"
+    status_msg "Updating OctoApp for Klipper ..."
+    cd "${OCTOAPP_DIR}" && git pull
+    ### read PKGLIST and install possible new dependencies
+    install_octoapp_dependencies
+    ### install possible new python dependencies
+    "${OCTOAPP_ENV}"/bin/pip install -r "${OCTOAPP_DIR}/requirements.txt"
+  fi
+
+  ok_msg "Update complete!"
+  do_action_service "restart" "octoapp"
+}
+
+function clone_octoapp() {
+  local repo=${1}
+
+  status_msg "Cloning OctoApp from ${repo} ..."
+
+  ### force remove existing octoapp dir and clone into fresh octoapp dir
+  [[ -d ${OCTOAPP_DIR} ]] && rm -rf "${OCTOAPP_DIR}"
+
+  cd "${HOME}" || exit 1
+  if ! git clone "${OCTOAPP_REPO}" "${OCTOAPP_DIR}"; then
+    print_error "Cloning OctoApp from\n ${repo}\n failed!"
+    exit 1
+  fi
+}
+
+function install_octoapp_dependencies() {
+  local packages log_name="OctoApp"
+  local install_script="${OCTOAPP_DIR}/install.sh"
+
+  ### read PKGLIST from official install-script
+  status_msg "Reading dependencies..."
+  # shellcheck disable=SC2016
+  packages="$(grep "PKGLIST=" "${install_script}" | cut -d'"' -f2 | sed 's/\${PKGLIST}//g' | tr -d '\n')"
+
+  echo "${cyan}${packages}${white}" | tr '[:space:]' '\n'
+  read -r -a packages <<< "${packages}"
+
+  ### Update system package lists if stale
+  update_system_package_lists
+
+  ### Install required packages
+  install_system_packages "${log_name}" "packages[@]"
+}
+
+#===================================================#
+#=============        STATUS          ==============#
+#===================================================#
+
+function get_octoapp_status() {
+  local status
+  local service_count
+  local octoapp_services
+
+  octoapp_services=$(octoapp_systemd)
+  service_count=$(echo "${octoapp_services}" | wc -w )
+
+  if (( service_count == 0 )); then
+    status="Not installed!"
+  elif [[ ! -d "${OCTOAPP_DIR}" ]]; then
+    status="Incomplete!"
+  else
+    status="Installed!"
+  fi
+
+  echo "${status}"
+}
+
+function get_local_octoapp_commit() {
+  [[ ! -d ${OCTOAPP_DIR} || ! -d "${OCTOAPP_DIR}/.git" ]] && return
+
+  local commit
+  cd "${OCTOAPP_DIR}"
+  commit="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
+  echo "${commit}"
+}
+
+function get_remote_octoapp_commit() {
+  [[ ! -d ${OCTOAPP_DIR} || ! -d "${OCTOAPP_DIR}/.git" ]] && return
+
+  local commit
+  cd "${OCTOAPP_DIR}" && git fetch origin -q
+  commit=$(git describe origin/release --always --tags | cut -d "-" -f 1,2)
+  echo "${commit}"
+}
+
+function compare_octoapp_versions() {
+  local versions local_ver remote_ver
+  local_ver="$(get_local_octoapp_commit)"
+  remote_ver="$(get_remote_octoapp_commit)"
+
+  if [[ ${local_ver} != "${remote_ver}" ]]; then
+    versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+    # Add us to the update file, so if the user selects "update all" it includes us.
+    add_to_application_updates "octoapp"
+  else
+    versions="${green}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+  fi
+
+  echo "${versions}"
+}

scripts/octoeverywhere.sh

@@ -0,0 +1,385 @@
+#!/usr/bin/env bash
+
+#=======================================================================#
+# 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                                         #
+#                                                                       #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+#=======================================================================#
+
+#
+# This file is written and maintained by Quinn Damerell from OctoEverywhere
+# Please contact our support team if you need any help!
+# https://octoeverywhere.com/support
+#
+
+set -e
+
+#===================================================#
+#==============         Install         ============#
+#===================================================#
+
+function octoeverywhere_systemd() {
+  local services
+  services=$(find "${SYSTEMD}" -maxdepth 1 -regextype posix-extended -regex "${SYSTEMD}/octoeverywhere(-[0-9a-zA-Z]+)?.service")
+  echo "${services}"
+}
+
+function octoeverywhere_setup_dialog() {
+  status_msg "Initializing OctoEverywhere for Klipper installation ..."
+
+  # First, check for moonraker service instances.
+  local moonraker_count
+  local moonraker_names
+  moonraker_count=$(moonraker_systemd | wc -w)
+  if (( moonraker_count == 0 )); then
+    ### return early if moonraker is not installed
+    local error="Moonraker not installed! Please install Moonraker first!"
+    log_error   "OctoEverywhere setup started without Moonraker being installed. Aborting setup."
+    print_error "${error}" && return
+  elif (( moonraker_count > 1 )); then
+    # moonraker_names is valid only in case of multi-instance
+    read -r -a moonraker_names <<< "$(get_multi_instance_names)"
+  fi
+
+  # Next, check for any existing OctoEverywhere services.
+  local octoeverywhere_services
+  local existing_octoeverywhere_count
+  octoeverywhere_services=$(octoeverywhere_systemd)
+  existing_octoeverywhere_count=$(echo "${octoeverywhere_services}" | wc -w )
+
+  # We need to make the moonraker instance count to the OctoEverywhere service count.
+  local allowed_octoeverywhere_count=$(( moonraker_count - existing_octoeverywhere_count ))
+  if (( allowed_octoeverywhere_count > 0 )); then
+    local new_octoeverywhere_count
+
+    ### Step 1: Ask for the number of OctoEverywhere instances to install
+    if (( moonraker_count == 1 )); then
+      ok_msg "Moonraker installation found!\n"
+      new_octoeverywhere_count=1
+    elif (( moonraker_count > 1 )); then
+      top_border
+      printf "|${green}%-55s${white}|\n" " ${moonraker_count} Moonraker instances found!"
+      for name in "${moonraker_names[@]}"; do
+        printf "|${cyan}%-57s${white}|\n" " ● moonraker-${name}"
+      done
+      blank_line
+      if (( existing_octoeverywhere_count > 0 )); then
+        printf "|${green}%-55s${white}|\n" " ${existing_octoeverywhere_count} OctoEverywhere instances already installed!"
+        for svc in ${octoeverywhere_services}; do
+          printf "|${cyan}%-57s${white}|\n" " ● octoeverywhere-$(get_instance_name "${svc}")"
+        done
+      fi
+      blank_line
+      echo -e "| The setup will apply the same names to                |"
+      echo -e "| OctoEverywhere                                        |"
+      blank_line
+      echo -e "| Please select the number of OctoEverywhere instances  |"
+      echo -e "| to install. Usually one OctoEverywhere instance per   |"
+      echo -e "| Moonraker instance is required, but you may not       |"
+      echo -e "| install more OctoEverywhere instances than available  |"
+      echo -e "| Moonraker instances.                                  |"
+      bottom_border
+
+      ### ask for amount of instances
+      local re="^[1-9][0-9]*$"
+      while [[ ! ${new_octoeverywhere_count} =~ ${re} || ${new_octoeverywhere_count} -gt ${allowed_octoeverywhere_count} ]]; do
+        read -p "${cyan}###### Number of new OctoEverywhere instances to set up:${white} " -i "${allowed_octoeverywhere_count}" -e new_octoeverywhere_count
+        ### break if input is valid
+        [[ ${new_octoeverywhere_count} =~ ${re} && ${new_octoeverywhere_count} -le ${allowed_octoeverywhere_count} ]] && break
+        ### conditional error messages
+        [[ ! ${new_octoeverywhere_count} =~ ${re} ]] && error_msg "Input not a number"
+        (( new_octoeverywhere_count > allowed_octoeverywhere_count )) && error_msg "Number of OctoEverywhere instances larger than installed Moonraker instances"
+      done && select_msg "${new_octoeverywhere_count}"
+    else
+      log_error "Internal error. moonraker_count of '${moonraker_count}' not equal or grater than one!"
+      return 1
+    fi  # (( moonraker_count == 1 ))
+  fi  # (( allowed_octoeverywhere_count > 0 ))
+
+  # Special case for one moonraker instance with OctoEverywhere already installed.
+  # If the user selects the install option again, they might be trying to recover the install
+  # or complete a printer link they didn't finish in the past.
+  # So in this case, we will allow them to run the install script again, since it's safe to run
+  # if the service is already installed, it will repair any missing issues.
+  if (( allowed_octoeverywhere_count == 0 && moonraker_count == 1 )); then
+    local yn
+    while true; do
+      echo "${yellow}OctoEverywhere is already installed.${white}"
+      echo "It is safe to run the install again to repair any issues or if the printer isn't linked, run the printer linking logic again."
+      echo ""
+      local question="Do you want to run the OctoEverywhere recovery or linking logic again?"
+      read -p "${cyan}###### ${question} (Y/n):${white} " yn
+      case "${yn}" in
+        Y|y|Yes|yes|"")
+          select_msg "Yes"
+          break;;
+        N|n|No|no)
+          select_msg "No"
+          abort_msg "Exiting OctoEverywhere setup ...\n"
+          return;;
+        *)
+          error_msg "Invalid Input!";;
+      esac
+    done
+    # The user responded yes, allow the install to run again.
+    allowed_octoeverywhere_count=1
+  fi
+
+  # If there's something to install, do it!
+  if (( allowed_octoeverywhere_count > 0 )); then
+
+    (( new_octoeverywhere_count > 1 )) && status_msg "Installing ${new_octoeverywhere_count} OctoEverywhere instances ..."
+    (( new_octoeverywhere_count == 1 )) && status_msg "Installing OctoEverywhere ..."
+
+    # Ensure the basic system dependencies are installed.
+    local dep=(git dfu-util virtualenv python3 python3-pip python3-venv)
+    dependency_check "${dep[@]}"
+
+    # Close the repo
+    clone_octoeverywhere "${OCTOEVERYWHERE_REPO}"
+
+    # Call install with the correct args.
+    local instance_cfg_dirs
+    read -r -a instance_cfg_dirs <<< "$(get_instance_folder_path "config")"
+    echo instance_cfg_dirs[0]
+
+    if (( moonraker_count == 1 )); then
+      "${OCTOEVERYWHERE_DIR}/install.sh" "${instance_cfg_dirs[0]}/moonraker.conf"
+    elif (( moonraker_count > 1 )); then
+      local j=${existing_octoeverywhere_count}
+
+      for (( i=1; i <= new_octoeverywhere_count; i++ )); do
+        "${OCTOEVERYWHERE_DIR}/install.sh" "${instance_cfg_dirs[${j}]}/moonraker.conf"
+        j=$(( j + 1 ))
+      done && unset j
+    fi # (( moonraker_count == 1 ))
+  fi  # (( allowed_octoeverywhere_count > 0 ))
+}
+
+function clone_octoeverywhere() {
+  local repo=${1}
+
+  status_msg "Cloning OctoEverywhere..."
+  ### force remove existing repos
+  [[ -d "${OCTOEVERYWHERE_DIR}" ]] && rm -rf "${OCTOEVERYWHERE_DIR}"
+
+  cd "${HOME}" || exit 1
+  if ! git clone "${repo}" "${OCTOEVERYWHERE_DIR}"; then
+    print_error "Cloning OctoEverywhere from\n ${repo}\n failed!"
+    exit 1
+  fi
+}
+
+function octoeverywhere_install() {
+  "${OCTOEVERYWHERE_DIR}/install.sh" "$@"
+}
+
+#===================================================#
+#=============        Remove          ==============#
+#===================================================#
+
+function remove_octoeverywhere_systemd() {
+  [[ -z $(octoeverywhere_systemd) ]] && return
+  status_msg "Removing OctoEverywhere Systemd Services ..."
+
+  for service in $(octoeverywhere_systemd | cut -d"/" -f5); do
+    status_msg "Removing ${service} ..."
+    sudo systemctl stop "${service}"
+    sudo systemctl disable "${service}"
+    sudo rm -f "${SYSTEMD}/${service}"
+    ok_msg "Done!"
+  done
+
+  ### reloading units
+  sudo systemctl daemon-reload
+  sudo systemctl reset-failed
+  ok_msg "OctoEverywhere Services removed!"
+}
+
+function remove_octoeverywhere_logs() {
+  local files regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/logs\/octoeverywhere(-[0-9a-zA-Z]+)?\.log(.*)?"
+  files=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)
+
+  if [[ -n ${files} ]]; then
+    for file in ${files}; do
+      status_msg "Removing ${file} ..."
+      rm -f "${file}"
+      ok_msg "${file} removed!"
+    done
+  fi
+}
+
+function remove_octoeverywhere_dir() {
+  [[ ! -d ${OCTOEVERYWHERE_DIR} ]] && return
+
+  status_msg "Removing OctoEverywhere directory ..."
+  rm -rf "${OCTOEVERYWHERE_DIR}"
+  ok_msg "Directory removed!"
+}
+
+function remove_octoeverywhere_config() {
+  # Remove the system config but not the main config, so the printer id doesn't get lost.
+  local files regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/octoeverywhere-system(-[0-9a-zA-Z]+)?\.cfg(.*)?"
+  files=$(find "${HOME}" -maxdepth 4 -regextype posix-extended -regex "${regex}" | sort)
+
+  if [[ -n ${files} ]]; then
+    for file in ${files}; do
+      status_msg "Removing ${file} ..."
+      rm -f "${file}"
+      ok_msg "${file} removed!"
+    done
+  fi
+}
+
+function remove_octoeverywhere_store_dir() {
+  local files regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/octoeverywhere-store"
+  files=$(find "${HOME}" -maxdepth 2 -type d -regextype posix-extended -regex "${regex}" | sort)
+
+  if [[ -n ${files} ]]; then
+    for file in ${files}; do
+      status_msg "Removing ${file} ..."
+      rm -rf "${file}"
+      ok_msg "${file} removed!"
+    done
+  fi
+}
+
+function remove_octoeverywhere_env() {
+  [[ ! -d "${HOME}/octoeverywhere-env" ]] && return
+
+  status_msg "Removing octoeverywhere-env directory ..."
+  rm -rf "${HOME}/octoeverywhere-env"
+  ok_msg "Directory removed!"
+}
+
+function remove_octoeverywhere()
+{
+  remove_octoeverywhere_systemd
+  remove_octoeverywhere_logs
+  remove_octoeverywhere_dir
+  remove_octoeverywhere_env
+  remove_octoeverywhere_config
+  remove_octoeverywhere_store_dir
+
+  print_confirm "OctoEverywhere was successfully removed!"
+  return
+}
+
+#===================================================#
+#=============        UPDATE          ==============#
+#===================================================#
+
+function update_octoeverywhere() {
+  do_action_service "stop" "octoeverywhere"
+
+  if [[ ! -d ${OCTOEVERYWHERE_DIR} ]]; then
+    clone_octoeverywhere "${OCTOEVERYWHERE_REPO}"
+  else
+    backup_before_update "octoeverywhere"
+    status_msg "Updating OctoEverywhere for Klipper ..."
+    cd "${OCTOEVERYWHERE_DIR}" && git pull
+    ### read PKGLIST and install possible new dependencies
+    install_octoeverywhere_dependencies
+    ### install possible new python dependencies
+    "${OCTOEVERYWHERE_ENV}"/bin/pip install -r "${OCTOEVERYWHERE_DIR}/requirements.txt"
+  fi
+
+  ok_msg "Update complete!"
+  do_action_service "restart" "octoeverywhere"
+}
+
+function clone_octoeverywhere() {
+  local repo=${1}
+
+  status_msg "Cloning OctoEverywhere from ${repo} ..."
+
+  ### force remove existing octoeverywhere dir and clone into fresh octoeverywhere dir
+  [[ -d ${OCTOEVERYWHERE_DIR} ]] && rm -rf "${OCTOEVERYWHERE_DIR}"
+
+  cd "${HOME}" || exit 1
+  if ! git clone "${OCTOEVERYWHERE_REPO}" "${OCTOEVERYWHERE_DIR}"; then
+    print_error "Cloning OctoEverywhere from\n ${repo}\n failed!"
+    exit 1
+  fi
+}
+
+function install_octoeverywhere_dependencies() {
+  local packages log_name="OctoEverywhere"
+  local install_script="${OCTOEVERYWHERE_DIR}/install.sh"
+
+  ### read PKGLIST from official install-script
+  status_msg "Reading dependencies..."
+  # shellcheck disable=SC2016
+  packages="$(grep "PKGLIST=" "${install_script}" | cut -d'"' -f2 | sed 's/\${PKGLIST}//g' | tr -d '\n')"
+
+  echo "${cyan}${packages}${white}" | tr '[:space:]' '\n'
+  read -r -a packages <<< "${packages}"
+
+  ### Update system package lists if stale
+  update_system_package_lists
+
+  ### Install required packages
+  install_system_packages "${log_name}" "packages[@]"
+}
+
+#===================================================#
+#=============        STATUS          ==============#
+#===================================================#
+
+function get_octoeverywhere_status() {
+  local status
+  local service_count
+  local octoeverywhere_services
+
+  octoeverywhere_services=$(octoeverywhere_systemd)
+  service_count=$(echo "${octoeverywhere_services}" | wc -w )
+
+  if (( service_count == 0 )); then
+    status="Not installed!"
+  elif [[ ! -d "${OCTOEVERYWHERE_DIR}" ]]; then
+    status="Incomplete!"
+  else
+    status="Installed!"
+  fi
+
+  echo "${status}"
+}
+
+function get_local_octoeverywhere_commit() {
+  [[ ! -d ${OCTOEVERYWHERE_DIR} || ! -d "${OCTOEVERYWHERE_DIR}/.git" ]] && return
+
+  local commit
+  cd "${OCTOEVERYWHERE_DIR}"
+  commit="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
+  echo "${commit}"
+}
+
+function get_remote_octoeverywhere_commit() {
+  [[ ! -d ${OCTOEVERYWHERE_DIR} || ! -d "${OCTOEVERYWHERE_DIR}/.git" ]] && return
+
+  local commit
+  cd "${OCTOEVERYWHERE_DIR}" && git fetch origin -q
+  commit=$(git describe origin/master --always --tags | cut -d "-" -f 1,2)
+  echo "${commit}"
+}
+
+function compare_octoeverywhere_versions() {
+  local versions local_ver remote_ver
+  local_ver="$(get_local_octoeverywhere_commit)"
+  remote_ver="$(get_remote_octoeverywhere_commit)"
+
+  if [[ ${local_ver} != "${remote_ver}" ]]; then
+    versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+    # Add us to the update file, so if the user selects "update all" it includes us.
+    add_to_application_updates "octoeverywhere"
+  else
+    versions="${green}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+  fi
+
+  echo "${versions}"
+}

scripts/octoprint.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -24,10 +24,16 @@ function octoprint_systemd() {
 function octoprint_setup_dialog() {
   status_msg "Initializing OctoPrint installation ..."
 
-  local klipper_services klipper_count user_input=() klipper_names=()
+  local klipper_services
   klipper_services=$(klipper_systemd)
-  klipper_count=$(echo "${klipper_services}" | wc -w )
+  if [[ -z ${klipper_services} ]]; then
+    local error="Klipper not installed! Please install Klipper first!"
+    log_error "OctoPrint setup started without Klipper being installed. Aborting setup."
+    print_error "${error}" && return
+  fi
 
+  local klipper_count user_input=() klipper_names=()
+  klipper_count=$(echo "${klipper_services}" | wc -w )
   for service in ${klipper_services}; do
     klipper_names+=( "$(get_instance_name "${service}")" )
   done
@@ -63,7 +69,7 @@ function octoprint_setup_dialog() {
     done && select_msg "${octoprint_count}"
 
   else
-    log_error "Internal error. octoprint_count of '${octoprint_count}' not equal or grather than one!"
+    log_error "Internal error. klipper_count of '${klipper_count}' not equal or grather than one!"
     return 1
   fi
 
@@ -221,21 +227,30 @@ function create_octoprint_service() {
   local octoprint_count=${input[0]} && unset "input[0]"
   local names=("${input[@]}") && unset "input[@]"
   local j=0 port=5000
-  local octo_env service basedir tmp_printer config_yaml restart_cmd
+  local printer_data octo_env service basedir printer config_yaml restart_cmd
 
   for (( i=1; i <= octoprint_count; i++ )); do
     if (( octoprint_count == 1 )); then
+      printer_data="${HOME}/printer_data"
       octo_env="${HOME}/OctoPrint"
       service="${SYSTEMD}/octoprint.service"
       basedir="${HOME}/.octoprint"
-      tmp_printer="/tmp/printer"
+      printer="${printer_data}/comms/klippy.serial"
       config_yaml="${basedir}/config.yaml"
       restart_cmd="sudo service octoprint restart"
     elif (( octoprint_count > 1 )); then
+
+      local re="^[1-9][0-9]*$"
+      if [[ ${names[j]} =~ ${re} ]]; then
+        printer_data="${HOME}/printer_${names[${j}]}_data"
+      else
+        printer_data="${HOME}/${names[${j}]}_data"
+      fi
+
       octo_env="${HOME}/OctoPrint_${names[${j}]}"
       service="${SYSTEMD}/octoprint-${names[${j}]}.service"
       basedir="${HOME}/.octoprint_${names[${j}]}"
-      tmp_printer="/tmp/printer-${names[${j}]}"
+      printer="${printer_data}/comms/klippy.serial"
       config_yaml="${basedir}/config.yaml"
       restart_cmd="sudo service octoprint-${names[${j}]} restart"
     fi
@@ -274,9 +289,9 @@ OCTOPRINT
       /bin/sh -c "cat > ${basedir}/config.yaml" << CONFIGYAML
 serial:
     additionalPorts:
-    - ${tmp_printer}
+    - ${printer}
     disconnectOnErrors: false
-    port: ${tmp_printer}
+    port: ${printer}
 server:
     commands:
         serverRestartCommand: ${restart_cmd}
@@ -398,4 +413,4 @@ function get_octoprint_status() {
   fi
 
   echo "${status}"
-}
+}

scripts/pretty_gcode.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -38,7 +38,7 @@ function install_pgc_for_klipper() {
   fi
 
   sudo cp "${pgconfsrc}" "${pgconf}"
-  sudo sed -i "s|/home/pi/pgcode;|/home/${USER}/pgcode;|" "${pgconf}"
+  sudo sed -i "s|/home/pi/pgcode;|${HOME}/pgcode;|" "${pgconf}"
 
   ### replace default port
   if (( pgc_custom_port != pgc_default_port )); then
@@ -104,12 +104,11 @@ function get_remote_prettygcode_commit() {
 
   [[ ! -d ${PGC_DIR} || ! -d "${PGC_DIR}/.git" ]] && return
   cd "${PGC_DIR}" && git fetch origin -q
-  commit=$(git describe origin/master --always --tags | cut -d "-" -f 1,2)
+  commit=$(git describe origin/main --always --tags | cut -d "-" -f 1,2)
   echo "${commit}"
 }
 
 function compare_prettygcode_versions() {
-  unset PGC_UPDATE_AVAIL
   local versions local_ver remote_ver
   local_ver="$(get_local_prettygcode_commit)"
   remote_ver="$(get_remote_prettygcode_commit)"
@@ -117,13 +116,12 @@ function compare_prettygcode_versions() {
   if [[ ${local_ver} != "${remote_ver}" ]]; then
     versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
     versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-    # add prettygcode to the update all array for the update all function in the updater
-    PGC_UPDATE_AVAIL="true" && update_arr+=(update_pgc_for_klipper)
+    # add moonraker to application_updates_available in kiauh.ini
+    add_to_application_updates "pgc_for_klipper"
   else
     versions="${green}$(printf " %-14s" "${local_ver}")${white}"
     versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-    PGC_UPDATE_AVAIL="false"
   fi
 
   echo "${versions}"
-}
+}

scripts/rollback.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#

scripts/spoolman.sh

@@ -0,0 +1,281 @@
+#!/usr/bin/env bash
+
+#=======================================================================#
+# 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                                         #
+#                                                                       #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+#=======================================================================#
+
+# Error Handling
+set -e
+
+function install_spoolman() {
+
+  pushd "${HOME}" &> /dev/null || exit 1
+
+  dependency_check curl jq
+
+  if [[ ! -d "${SPOOLMAN_DIR}" && -z "$(ls -A "${SPOOLMAN_DIR}" 2> /dev/null)" ]]; then
+    status_msg "Downloading spoolman..."
+    setup_spoolman_folder
+    status_msg "Downloading complete"
+    start_install_script
+    advanced_config_prompt
+  else
+    ### In case spoolman is "incomplete" rerun install script
+    if get_spoolman_status | grep -q "Incomplete!"; then
+      start_install_script
+      exit 1
+    fi
+
+    ok_msg "Spoolman already installed"
+    exit 1
+  fi
+
+  enable_moonraker_integration_prompt
+  patch_spoolman_update_manager
+
+  do_action_service "restart" "moonraker"
+}
+
+function update_spoolman() {
+  ### stop and disable old spoolman service
+  do_action_service "stop" "Spoolman"
+  do_action_service "disable" "Spoolman"
+
+  mv "${SPOOLMAN_DIR}" "${SPOOLMAN_DIR}_old"
+
+  setup_spoolman_folder
+  cp "${SPOOLMAN_DIR}_old/.env" "${SPOOLMAN_DIR}/.env"
+
+  start_install_script
+
+  rm -rf "${SPOOLMAN_DIR}_old"
+}
+
+function remove_spoolman(){
+  if [[ -d "${SPOOLMAN_DIR}" ]]; then
+    status_msg "Removing spoolman service..."
+    do_action_service "stop" "Spoolman"
+    do_action_service "disable" "Spoolman"
+    sudo rm -f "${SYSTEMD}/Spoolman.service"
+    sudo systemctl daemon-reload
+    sudo systemctl reset-failed
+    ok_msg "Spoolman service removed!"
+
+    status_msg "Removing spoolman directory..."
+    rm -rf "${SPOOLMAN_DIR}"
+    ok_msg "Spoolman directory removed!"
+  fi
+
+  print_confirm "Spoolman successfully removed!"
+}
+
+function update_moonraker_configs() {
+  local moonraker_configs regex
+  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/moonraker\.conf"
+  moonraker_configs=$(find "${HOME}" -maxdepth 3 -type f -regextype posix-extended -regex "${regex}" | sort)
+
+  for conf in ${moonraker_configs}; do
+    if ! grep -Eq "^\[update_manager Spoolman\]\s*$" "${conf}"; then
+      ### add new line to conf if it doesn't end with one
+      [[ $(tail -c1 "${conf}" | wc -l) -eq 0 ]] && echo "" >> "${conf}"
+      /bin/sh -c "cat >> ${conf}" << MOONRAKER_CONF
+${1}
+MOONRAKER_CONF
+    fi
+  done
+}
+
+function enable_moonraker_integration() {
+  local integration_str env_port
+  # get spoolman port from .env
+  env_port=$(grep "^SPOOLMAN_PORT=" "${SPOOLMAN_DIR}/.env" | cut -d"=" -f2)
+
+  integration_str="
+[spoolman]
+server: http://$(hostname -I | cut -d" " -f1):${env_port}
+"
+
+  status_msg "Adding Spoolman integration..."
+  update_moonraker_configs "${integration_str}"
+}
+
+function patch_spoolman_update_manager() {
+  local updater_str
+  updater_str="
+[update_manager Spoolman]
+type: zip
+channel: stable
+repo: Donkie/Spoolman
+path: ${SPOOLMAN_DIR}
+virtualenv: .venv
+requirements: requirements.txt
+persistent_files:
+  .venv
+  .env
+managed_services: Spoolman
+"
+
+  update_moonraker_configs "${updater_str}"
+
+  # add spoolman service to moonraker.asvc
+  local moonraker_asvc regex
+  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/moonraker\.asvc"
+  moonraker_asvc=$(find "${HOME}" -maxdepth 2 -type f -regextype posix-extended -regex "${regex}" | sort)
+
+  if ! grep -q "^Spoolman$" "${moonraker_asvc}"; then
+    status_msg "Adding Spoolman service to moonraker.asvc..."
+    sed -i '$a''Spoolman' "${moonraker_asvc}"
+  fi
+}
+
+function advanced_config_prompt() {
+  local reply
+  while true; do
+    read -erp "${cyan}###### Continue with default configuration? (Y/n):${white} " reply
+    case "${reply}" in
+      Y|y|Yes|yes|"")
+        select_msg "Yes"
+        break;;
+      N|n|No|no)
+        select_msg "No"
+        advanced_config
+        break;;
+      *)
+        error_msg "Invalid Input!\n";;
+    esac
+  done
+  return 0
+}
+
+function enable_moonraker_integration_prompt() {
+  local reply
+  while true; do
+    read -erp "${cyan}###### Enable Moonraker integration? (Y/n):${white} " reply
+    case "${reply}" in
+      Y|y|Yes|yes|"")
+        select_msg "Yes"
+        enable_moonraker_integration
+        break;;
+      N|n|No|no)
+        select_msg "No"
+        break;;
+      *)
+        error_msg "Invalid Input!\n";;
+    esac
+  done
+  return 0
+}
+
+function advanced_config() {
+  status_msg "###### Advanced configuration"
+
+  local reply
+  while true; do
+    read -erp "${cyan}###### Select spoolman port (7912):${white} " reply
+    ### set default
+    if [[ -z "${reply}" ]]; then
+      reply="7912"
+    fi
+
+    select_msg "${reply}"
+    ### check if port is valid
+    if ! [[ "${reply}" =~ ^[0-9]+$ && "${reply}" -ge 1024 && "${reply}" -le 65535 ]]; then
+      error_msg "Invalid port number!\n"
+      continue
+    fi
+
+    ### update .env
+    sed -i "s/^SPOOLMAN_PORT=.*$/SPOOLMAN_PORT=${reply}/" "${SPOOLMAN_DIR}/.env"
+    do_action_service "restart" "Spoolman"
+    break
+  done
+  return 0
+}
+
+function setup_spoolman_folder() {
+  local source_url
+  ### get latest spoolman release url
+  source_url="$(curl -s "${SPOOLMAN_REPO}" | jq -r '.assets[] | select(.name == "spoolman.zip").browser_download_url')"
+
+  mkdir -p "${SPOOLMAN_DIR}"
+  curl -sSL "${source_url}" -o /tmp/temp.zip
+  unzip /tmp/temp.zip -d "${SPOOLMAN_DIR}" &> /dev/null
+  rm /tmp/temp.zip
+
+  chmod +x "${SPOOLMAN_DIR}"/scripts/install.sh
+}
+
+function start_install_script() {
+
+  pushd "${SPOOLMAN_DIR}" &> /dev/null || exit 1
+
+  if bash ./scripts/install.sh; then
+    ok_msg "Spoolman successfully installed!"
+  else
+    print_error "Spoolman installation failed!"
+    exit 1
+  fi
+}
+
+function get_spoolman_status() {
+  local -a files
+  files=(
+      "${SPOOLMAN_DIR}"
+      "${SYSTEMD}/Spoolman.service"
+      "${SPOOLMAN_DB_DIR}"
+    )
+
+  local count
+  count=0
+
+  for file in "${files[@]}"; do
+    [[ -e "${file}" ]] && count=$(( count +1 ))
+  done
+
+  if [[ "${count}" -eq "${#files[*]}" ]]; then
+    echo "Installed"
+  elif [[ "${count}" -gt 0 ]]; then
+    echo "Incomplete!"
+  else
+    echo "Not installed!"
+  fi
+}
+
+function get_local_spoolman_version() {
+  [[ ! -d "${SPOOLMAN_DIR}" ]] && return
+
+  local version
+  version=$(grep -o '"version":\s*"[^"]*' "${SPOOLMAN_DIR}"/release_info.json | cut -d'"' -f4)
+  echo "${version}"
+}
+
+function get_remote_spoolman_version() {
+  [[ ! -d "${SPOOLMAN_DIR}" ]] && return
+
+  local version
+  version=$(curl -s "${SPOOLMAN_REPO}" | grep -o '"tag_name":\s*"v[^"]*"' | cut -d'"' -f4)
+  echo "${version}"
+}
+
+function compare_spoolman_versions() {
+  local local_ver remote_ver
+  local_ver="$(get_local_spoolman_version)"
+  remote_ver="$(get_remote_spoolman_version)"
+
+  if [[ ${local_ver} != "${remote_ver}" ]]; then
+    versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+    # add spoolman to application_updates_available in kiauh.ini
+    add_to_application_updates "spoolman"
+  else
+    versions="${green}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+  fi
+
+  echo "${versions}"
+}

scripts/switch_klipper_repo.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -43,53 +43,59 @@ function change_klipper_repo_menu() {
   back_help_footer
 
   local option
+  local num="^[0-9]+$"
+  local back="^(B|b)$"
+  local help="^(H|h)$"
+
   while true; do
     read -p "${cyan}###### Perform action:${white} " option
-    case "${option}" in
-      0 | "$(( option < ${#repos[@]} ))")
-        select_msg "Repo: ${repos[option]} Branch: ${branches[option]}"
-        if [[ -d ${KLIPPER_DIR} ]]; then
-          top_border
-          echo -e "|                   ${red}!!! ATTENTION !!!${white}                   |"
-          echo -e "| Existing Klipper folder found! Proceeding will remove | "
-          echo -e "| the existing Klipper folder and replace it with a     | "
-          echo -e "| clean copy of the previously selected source repo!    | "
-          bottom_border
 
-          local yn
-          while true; do
-          read -p "${cyan}###### Proceed? (Y/n):${white} " yn
-            case "${yn}" in
-              Y|y|Yes|yes|"")
-                select_msg "Yes"
-                switch_klipper_repo "${repos[${option}]}" "${branches[${option}]}"
-                set_custom_klipper_repo "${repos[${option}]}" "${branches[${option}]}"
-                break;;
-              N|n|No|no)
-                select_msg "No"
-                break;;
-              *)
-                error_msg "Invalid command!";;
-            esac
-          done
-        else
-          status_msg "Set custom Klipper repository to:\n       ● Repository: ${repos[${option}]}\n       ● Branch: ${branches[${option}]}"
-          set_custom_klipper_repo "${repos[${option}]}" "${branches[${option}]}"
-          ok_msg "This repo will now be used for new Klipper installations!\n"
-        fi
-        break;;
-      B|b)
-        clear && print_header
-        settings_menu
-        break;;
-      H|h)
-        clear && print_header
-        show_custom_klipper_repo_help
-        break;;
-      *)
-        error_msg "Invalid command!";;
-    esac
+    if [[ ${option} =~ ${num} && ${option} -lt ${#repos[@]} ]]; then
+      select_msg "Repo: ${repos[option]} Branch: ${branches[option]}"
+
+      if [[ -d ${KLIPPER_DIR} ]]; then
+        top_border
+        echo -e "|                   ${red}!!! ATTENTION !!!${white}                   |"
+        echo -e "| Existing Klipper folder found! Proceeding will remove | "
+        echo -e "| the existing Klipper folder and replace it with a     | "
+        echo -e "| clean copy of the previously selected source repo!    | "
+        bottom_border
+
+        local yn
+        while true; do
+        read -p "${cyan}###### Proceed? (Y/n):${white} " yn
+          case "${yn}" in
+            Y|y|Yes|yes|"")
+              select_msg "Yes"
+              switch_klipper_repo "${repos[${option}]}" "${branches[${option}]}"
+              set_custom_klipper_repo "${repos[${option}]}" "${branches[${option}]}"
+              break;;
+            N|n|No|no)
+              select_msg "No"
+              break;;
+            *)
+              error_msg "Invalid command!";;
+          esac
+        done
+        break
+      else
+        status_msg "Set custom Klipper repository to:\n       ● Repository: ${repos[${option}]}\n       ● Branch: ${branches[${option}]}"
+        set_custom_klipper_repo "${repos[${option}]}" "${branches[${option}]}"
+        ok_msg "This repo will now be used for new Klipper installations!\n"
+        break
+      fi
+
+    elif [[ ${option} =~ ${back} ]]; then
+      clear && print_header
+      settings_menu
+    elif [[ ${option} =~ ${help} ]]; then
+      clear && print_header
+      show_custom_klipper_repo_help
+    else
+      error_msg "Invalid command!"
+    fi
   done
+
   change_klipper_repo_menu
 }
 
@@ -135,4 +141,4 @@ function show_custom_klipper_repo_help() {
         deny_action "show_settings_help";;
     esac
   done
-}
+}

scripts/ui/advanced_menu.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -66,4 +66,4 @@ function advanced_menu() {
     esac
   done
   advanced_menu
-}
+}

scripts/ui/backup_menu.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -20,12 +20,13 @@ function backup_ui() {
   echo -e "| Klipper & API:             | Touchscreen GUI:         |"
   echo -e "|  1) [Klipper]              |  7) [KlipperScreen]      |"
   echo -e "|  2) [Moonraker]            |                          |"
-  echo -e "|  3) [Configuration Folder] | 3rd Party Webinterface:  |"
+  echo -e "|  3) [Config Folder]        | 3rd Party Webinterface:  |"
   echo -e "|  4) [Moonraker Database]   |  8) [OctoPrint]          |"
   echo -e "|                            |                          |"
   echo -e "| Klipper Webinterface:      | Other:                   |"
   echo -e "|  5) [Mainsail]             |  9) [Telegram Bot]       |"
-  echo -e "|  6) [Fluidd]               |                          |"
+  echo -e "|  6) [Fluidd]               | 10) [OctoEverywhere]     |"
+  echo -e "|                            | 11) [Spoolman]           |"
   back_footer
 }
 
@@ -41,7 +42,7 @@ function backup_menu() {
       2)
         do_action "backup_moonraker" "backup_ui";;
       3)
-        do_action "backup_klipper_config_dir" "backup_ui";;
+        do_action "backup_config_dir" "backup_ui";;
       4)
         do_action "backup_moonraker_database" "backup_ui";;
       5)
@@ -54,6 +55,10 @@ function backup_menu() {
         do_action "backup_octoprint" "backup_ui";;
       9)
         do_action "backup_telegram_bot" "backup_ui";;
+      10)
+        do_action "backup_octoeverywhere" "backup_ui";;
+      11)
+        do_action "backup_spoolman" "backup_ui";;
       B|b)
         clear; main_menu; break;;
       *)

scripts/ui/general_ui.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#

scripts/ui/install_menu.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -19,29 +19,39 @@ function install_ui() {
   echo -e "|  all necessary dependencies for the various           |"
   echo -e "|  functions on a completely fresh system.              |"
   hr
-  echo -e "| Firmware & API:           | 3rd Party Webinterface:   |"
-  echo -e "|  1) [Klipper]             |  6) [OctoPrint]           |"
-  echo -e "|  2) [Moonraker]           |                           |"
-  echo -e "|                           | Other:                    |"
-  echo -e "| Klipper Webinterface:     |  7) [PrettyGCode]         |"
-  echo -e "|  3) [Mainsail]            |  8) [Telegram Bot]        |"
-  echo -e "|  4) [Fluidd]              |                           |"
-  echo -e "|                           | Webcam Streamer:          |"
-  echo -e "| Touchscreen GUI:          |  9) [MJPG-Streamer]       |"
-  echo -e "|  5) [KlipperScreen]       |                           |"
+  echo -e "| Firmware & API:          | Other:                     |"
+  echo -e "|  1) [Klipper]            |  7) [PrettyGCode]          |"
+  echo -e "|  2) [Moonraker]          |  8) [Telegram Bot]         |"
+  echo -e "|                          |  9) $(obico_install_title) |"
+  echo -e "| Klipper Webinterface:    | 10) [OctoEverywhere]       |"
+  echo -e "|  3) [Mainsail]           | 11) [Mobileraker]          |"
+  echo -e "|  4) [Fluidd]             | 12) [OctoApp for Klipper]  |"
+  echo -e "|                          | 13) [Spoolman]             |"
+  echo -e "| Touchscreen GUI:         |                            |"
+  echo -e "|  5) [KlipperScreen]      | Webcam Streamer:           |"
+  echo -e "|                          | 14) [Crowsnest]            |"
+  echo -e "| 3rd Party Webinterface:  |                            |"
+  echo -e "|  6) [OctoPrint]          |                            |"
   back_footer
 }
 
 function install_menu() {
-  clear && print_header
+  clear -x && sudo true && clear -x # (re)cache sudo credentials so password prompt doesn't bork ui
+  print_header
   install_ui
 
+  ### save all installed webinterface ports to the ini file
+  fetch_webui_ports
+
+  ### save all klipper multi-instance names to the ini file
+  set_multi_instance_names
+
   local action
   while true; do
     read -p "${cyan}####### Perform action:${white} " action
     case "${action}" in
       1)
-        do_action "select_klipper_python_version" "install_ui";;
+        do_action "start_klipper_setup" "install_ui";;
       2)
         do_action "moonraker_setup_dialog" "install_ui";;
       3)
@@ -57,7 +67,17 @@ function install_menu() {
       8)
         do_action "telegram_bot_setup_dialog" "install_ui";;
       9)
-        do_action "install_mjpg-streamer" "install_ui";;
+        do_action "moonraker_obico_setup_dialog" "install_ui";;
+      10)
+        do_action "octoeverywhere_setup_dialog" "install_ui";;
+      11)
+        do_action "install_mobileraker" "install_ui";;
+      12)
+        do_action "octoapp_setup_dialog" "install_ui";;
+      13)
+        do_action "install_spoolman" "install_ui";;
+      14)
+        do_action "install_crowsnest" "install_ui";;
       B|b)
         clear; main_menu; break;;
       *)
@@ -66,33 +86,3 @@ function install_menu() {
   done
   install_menu
 }
-
-function select_klipper_python_version() {
-  top_border
-  echo -e "| Please select the preferred Python version.           | "
-  echo -e "| The recommended version is Python 2.7.                | "
-  blank_line
-  echo -e "| Installing Klipper with Python 3 is officially not    | "
-  echo -e "| recommended and should be considered as experimental. | "
-  hr
-  echo -e "|  1) [Python 2.7]  (recommended)                       | "
-  echo -e "|  2) [Python 3.x]  ${yellow}(experimental)${white}                      | "
-  back_footer
-  while true; do
-    read -p "${cyan}###### Select Python version:${white} " action
-    case "${action}" in
-      1)
-        select_msg "Python 2.7"
-        klipper_setup_dialog "python2"
-        break;;
-      2)
-        select_msg "Python 3.x"
-        klipper_setup_dialog "python3"
-        break;;
-      B|b)
-        clear; install_menu; break;;
-      *)
-        error_msg "Invalid Input!\n";;
-    esac
-  done
-}

scripts/ui/main_menu.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -15,30 +15,38 @@ function main_ui() {
   top_border
   echo -e "|     $(title_msg "~~~~~~~~~~~~~~~ [ Main Menu ] ~~~~~~~~~~~~~~~")     |"
   hr
-  echo -e "|  0) [Log-Upload]   |       Klipper: $(print_status "klipper")|"
-  echo -e "|                    |          Repo: $(print_klipper_repo)|"
-  echo -e "|  1) [Install]      |                                  |"
-  echo -e "|  2) [Update]       |     Moonraker: $(print_status "moonraker")|"
-  echo -e "|  3) [Remove]       |                                  |"
-  echo -e "|  4) [Advanced]     |      Mainsail: $(print_status "mainsail")|"
-  echo -e "|  5) [Backup]       |        Fluidd: $(print_status "fluidd")|"
-  echo -e "|                    | KlipperScreen: $(print_status "klipperscreen")|"
-  echo -e "|  6) [Settings]     |  Telegram Bot: $(print_status "telegram_bot")|"
-  echo -e "|                    |                                  |"
-  echo -e "|  $(print_kiauh_version)|     Octoprint: $(print_status "octoprint")|"
+  echo -e "|  0) [Log-Upload] |         Klipper: $(print_status "klipper")|"
+  echo -e "|                  |            Repo: $(print_klipper_repo)|"
+  echo -e "|  1) [Install]    |                                    |"
+  echo -e "|  2) [Update]     |       Moonraker: $(print_status "moonraker")|"
+  echo -e "|  3) [Remove]     |                                    |"
+  echo -e "|  4) [Advanced]   |        Mainsail: $(print_status "mainsail")|"
+  echo -e "|  5) [Backup]     |          Fluidd: $(print_status "fluidd")|"
+  echo -e "|                  |   KlipperScreen: $(print_status "klipperscreen")|"
+  echo -e "|  6) [Settings]   |    Telegram Bot: $(print_status "telegram_bot")|"
+  echo -e "|                  |       Crowsnest: $(print_status "crowsnest")|"
+  echo -e "|                  |           Obico: $(print_status "moonraker_obico")|"
+  echo -e "|                  |  OctoEverywhere: $(print_status "octoeverywhere")|"
+  echo -e "|                  |     Mobileraker: $(print_status "mobileraker")|"
+  echo -e "|                  |         OctoApp: $(print_status "octoapp")|"
+  echo -e "|                  |        Spoolman: $(print_status "spoolman")|"
+  echo -e "|                  |                                    |"
+  echo -e "|                  |       Octoprint: $(print_status "octoprint")|"
+  hr
+  echo -e "|  $(print_kiauh_version)|    Changelog: ${magenta}https://git.io/JnmlX${white} |"
   quit_footer
 }
 
 function get_kiauh_version() {
   local version
   cd "${KIAUH_SRCDIR}"
-  version="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
+  version="$(git tag -l 'v5*' | tail -1)"
   echo "${version}"
 }
 
 function print_kiauh_version() {
   local version
-  version="$(printf "%-18s" "$(get_kiauh_version)")"
+  version="$(printf "%-16s" "$(get_kiauh_version)")"
   echo "${cyan}${version}${white}"
 }
 
@@ -50,6 +58,9 @@ function print_status() {
     status="${red}${status}${white}"
   elif [[ ${status} == "Incomplete!" ]]; then
     status="${yellow}${status}${white}"
+  elif [[ ${status} == "Not linked!" ]]; then
+    ### "Not linked!" is only required for Obico for Klipper
+    status="${yellow}${status}${white}"
   else
     status="${green}${status}${white}"
   fi
@@ -79,7 +90,8 @@ function print_klipper_repo() {
 
 
 function main_menu() {
-  print_header && main_ui
+  clear && print_header
+  main_ui
 
   local action
   while true; do
@@ -94,10 +106,13 @@ function main_menu() {
       "start octoprint") do_action_service "start" "octoprint"; main_ui;;
       "stop octoprint") do_action_service "stop" "octoprint"; main_ui;;
       "restart octoprint") do_action_service "restart" "octoprint"; main_ui;;
+      "start crowsnest") do_action_service "start" "crowsnest"; main_ui;;
+      "stop crowsnest") do_action_service "stop" "crowsnest"; main_ui;;
+      "restart crowsnest") do_action_service "restart" "crowsnest"; main_ui;;
       update) do_action "update_kiauh" "main_ui";;
       0)clear && print_header
         upload_selection
-        break;;
+        main_ui;;
       1)clear && print_header
         install_menu
         break;;
@@ -112,7 +127,7 @@ function main_menu() {
         break;;
       5)clear && print_header
         backup_menu
-        break;;
+        main_ui;;
       6)clear && print_header
         settings_menu
         break;;
@@ -123,5 +138,5 @@ function main_menu() {
         deny_action "main_ui";;
     esac
   done
-  clear; main_menu
+  main_menu
 }

scripts/ui/remove_menu.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -17,16 +17,21 @@ function remove_ui() {
   hr
   echo -e "| ${yellow}INFO: Configurations and/or any backups will be kept!${white} |"
   hr
-  echo -e "| Firmware & API:           | 3rd Party Webinterface:   |"
-  echo -e "|  1) [Klipper]             |  6) [OctoPrint]           |"
-  echo -e "|  2) [Moonraker]           |                           |"
-  echo -e "|                           | Webcam Streamer:          |"
-  echo -e "| Klipper Webinterface:     |  7) [MJPG-Streamer]       |"
-  echo -e "|  3) [Mainsail]            |                           |"
-  echo -e "|  4) [Fluidd]              | Other:                    |"
-  echo -e "|                           |  8) [PrettyGCode]         |"
-  echo -e "| Touchscreen GUI:          |  9) [Telegram Bot]        |"
-  echo -e "|  5) [KlipperScreen]       | 10) [NGINX]               |"
+  echo -e "| Firmware & API:           | Webcam Streamer:          |"
+  echo -e "|  1) [Klipper]             |  9) [Crowsnest]           |"
+  echo -e "|  2) [Moonraker]           | 10) [MJPG-Streamer]       |"
+  echo -e "|                           |                           |"
+  echo -e "| Klipper Webinterface:     | Other:                    |"
+  echo -e "|  3) [Mainsail]            | 11) [PrettyGCode]         |"
+  echo -e "|  4) [Mainsail-Config]     | 12) [Telegram Bot]        |"
+  echo -e "|  5) [Fluidd]              | 13) [Obico for Klipper]   |"
+  echo -e "|  6) [Fluidd-Config]       | 14) [OctoEverywhere]      |"
+  echo -e "|                           | 15) [Mobileraker]         |"
+  echo -e "| Touchscreen GUI:          | 16) [NGINX]               |"
+  echo -e "|  7) [KlipperScreen]       | 17) [OctoApp]             |"
+  echo -e "|                           | 18) [Spoolman]            |"
+  echo -e "| 3rd Party Webinterface:   |                           |"
+  echo -e "|  8) [OctoPrint]           |                           |"
   back_footer
 }
 
@@ -44,19 +49,35 @@ function remove_menu() {
       3)
         do_action "remove_mainsail" "remove_ui";;
       4)
-        do_action "remove_fluidd" "remove_ui";;
+        do_action "remove_mainsail_config" "remove_ui";;
       5)
-        do_action "remove_klipperscreen" "remove_ui";;
+        do_action "remove_fluidd" "remove_ui";;
       6)
-        do_action "remove_octoprint" "remove_ui";;
+        do_action "remove_fluidd_config" "remove_ui";;
       7)
-        do_action "remove_mjpg-streamer" "remove_ui";;
+        do_action "remove_klipperscreen" "remove_ui";;
       8)
-        do_action "remove_prettygcode" "remove_ui";;
+        do_action "remove_octoprint" "remove_ui";;
       9)
-        do_action "remove_telegram_bot" "remove_ui";;
+        do_action "remove_crowsnest" "remove_ui";;
       10)
+        do_action "remove_mjpg-streamer" "remove_ui";;
+      11)
+        do_action "remove_prettygcode" "remove_ui";;
+      12)
+        do_action "remove_telegram_bot" "remove_ui";;
+      13)
+        do_action "remove_moonraker_obico" "remove_ui";;
+      14)
+        do_action "remove_octoeverywhere" "remove_ui";;
+      15)
+        do_action "remove_mobileraker" "remove_ui";;
+      16)
         do_action "remove_nginx" "remove_ui";;
+      17)
+        do_action "remove_octoapp" "remove_ui";;
+      18)
+        do_action "remove_spoolman" "remove_ui";;
       B|b)
         clear; main_menu; break;;
       *)

scripts/ui/settings_menu.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -14,20 +14,12 @@ set -e
 function settings_ui() {
   read_kiauh_ini "${FUNCNAME[0]}"
 
-  local custom_cfg_loc="${custom_klipper_cfg_loc}"
   local custom_repo="${custom_klipper_repo}"
   local custom_branch="${custom_klipper_repo_branch}"
   local ms_pre_rls="${mainsail_install_unstable}"
   local fl_pre_rls="${fluidd_install_unstable}"
   local bbu="${backup_before_update}"
 
-  ### config location
-  if [[ -z ${custom_cfg_loc} ]]; then
-    custom_cfg_loc="${cyan}${KLIPPER_CONFIG}${white}"
-  else
-    custom_cfg_loc="${cyan}${custom_cfg_loc}${white}"
-  fi
-
   ### custom repository
   custom_repo=$(echo "${custom_repo}" | sed "s/https:\/\/github\.com\///" | sed "s/\.git$//" )
   if [[ -z ${custom_repo} ]]; then
@@ -67,8 +59,6 @@ function settings_ui() {
   echo -e "|     $(title_msg "~~~~~~~~~~~~ [ KIAUH Settings ] ~~~~~~~~~~~~~")     |"
   hr
   echo -e "| Klipper:                                              |"
-  echo -e "|   ● Config folder:                                    |"
-  printf  "|     %-60s|\n" "${custom_cfg_loc}"
   echo -e "|   ● Repository:                                       |"
   printf  "|     %-70s|\n" "${custom_repo} (${custom_branch})"
   hr
@@ -77,24 +67,23 @@ function settings_ui() {
   hr
   printf  "| Backup before updating: %-42s|\n" "${bbu}"
   hr
-  echo -e "| 1) Change Klipper config folder location              |"
-  echo -e "| 2) Set custom Klipper repository                      |"
+  echo -e "| 1) Set custom Klipper repository                      |"
   blank_line
   if [[ ${mainsail_install_unstable} == "false" ]]; then
-  echo -e "| 3) ${green}Allow${white} unstable Mainsail releases                   |"
+  echo -e "| 2) ${green}Allow${white} unstable Mainsail releases                   |"
   else
-  echo -e "| 3) ${red}Disallow${white} unstable Mainsail releases                |"
+  echo -e "| 2) ${red}Disallow${white} unstable Mainsail releases                |"
   fi
   if [[ ${fluidd_install_unstable} == "false" ]]; then
-  echo -e "| 4) ${green}Allow${white} unstable Fluidd releases                     |"
+  echo -e "| 3) ${green}Allow${white} unstable Fluidd releases                     |"
   else
-  echo -e "| 4) ${red}Disallow${white} unstable Fluidd releases                  |"
+  echo -e "| 3) ${red}Disallow${white} unstable Fluidd releases                  |"
   fi
   blank_line
   if [[ ${backup_before_update} == "false" ]]; then
-  echo -e "| 5) ${green}Enable${white} automatic backups before updates            |"
+  echo -e "| 4) ${green}Enable${white} automatic backups before updates            |"
   else
-  echo -e "| 5) ${red}Disable${white} automatic backups before updates           |"
+  echo -e "| 4) ${red}Disable${white} automatic backups before updates           |"
   fi
   back_help_footer
 }
@@ -105,16 +94,6 @@ function show_settings_help() {
   top_border
   echo -e "|    ~~~~~~ < ? > Help: KIAUH Settings < ? > ~~~~~~     |"
   hr
-  echo -e "| ${cyan}Klipper config folder:${white}                                |"
-  echo -e "| The location of your printer.cfg and all other config |"
-  echo -e "| files that gets used during installation of Klipper   |"
-  echo -e "| and all other components which need that location.    |"
-  echo -e "| It is not recommended to change this location.        |"
-  echo -e "| Be advised, that negative side effects could occur.   |"
-  blank_line
-  printf  "| Default: %-55s|\n" "${default_cfg}"
-  blank_line
-  hr
   echo -e "| ${cyan}Install unstable releases:${white}                            |"
   echo -e "| If set to ${green}true${white}, KIAUH installs/updates the software   |"
   echo -e "| with the latest, currently available release.         |"
@@ -160,20 +139,16 @@ function settings_menu() {
     read -p "${cyan}####### Perform action:${white} " action
     case "${action}" in
       1)
-        clear && print_header
-        change_klipper_cfg_folder
-        settings_ui;;
-      2)
         clear && print_header
         change_klipper_repo_menu
         settings_ui;;
-      3)
+      2)
         switch_mainsail_releasetype
         settings_menu;;
-      4)
+      3)
         switch_fluidd_releasetype
         settings_menu;;
-      5)
+      4)
         toggle_backup_before_update
         settings_menu;;
       B|b)

scripts/ui/update_menu.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -31,15 +31,21 @@ function update_ui() {
   echo -e "| Other:                 |---------------|--------------|"
   echo -e "|  6) [PrettyGCode]      |$(compare_prettygcode_versions)|"
   echo -e "|  7) [Telegram Bot]     |$(compare_telegram_bot_versions)|"
+  echo -e "|  8) [Obico for Klipper]|$(compare_moonraker_obico_versions)|"
+  echo -e "|  9) [OctoEverywhere]   |$(compare_octoeverywhere_versions)|"
+  echo -e "| 10) [Mobileraker]      |$(compare_mobileraker_versions)|"
+  echo -e "| 11) [Crowsnest]        |$(compare_crowsnest_versions)|"
+  echo -e "| 12) [OctoApp]          |$(compare_octoapp_versions)|"
+  echo -e "| 13) [Spoolman]         |$(compare_spoolman_versions)|"
   echo -e "|                        |------------------------------|"
-  echo -e "|  8) [System]           |  $(check_system_updates)   |"
+  echo -e "| 14) [System]           |  $(check_system_updates)   |"
   back_footer
 }
 
 function update_menu() {
-  unset update_arr
+  clear -x && sudo true && clear -x # (re)cache sudo credentials so password prompt doesn't bork ui
   do_action "" "update_ui"
-  
+
   local action
   while true; do
     read -p "${cyan}####### Perform action:${white} " action
@@ -61,7 +67,19 @@ function update_menu() {
       7)
         do_action "update_telegram_bot" "update_ui";;
       8)
-        do_action "update_system" "update_ui";;
+        do_action "update_moonraker_obico" "update_ui";;
+      9)
+        do_action "update_octoeverywhere" "update_ui";;
+      10)
+        do_action "update_mobileraker" "update_ui";;
+      11)
+        do_action "update_crowsnest" "update_ui";;
+      12)
+        do_action "update_octoapp" "update_ui";;
+      13)
+        do_action "update_spoolman" "update_ui";;
+      14)
+        do_action "upgrade_system_packages" "update_ui";;
       a)
         do_action "update_all" "update_ui";;
       B|b)
@@ -74,58 +92,81 @@ function update_menu() {
 }
 
 function update_all() {
+  read_kiauh_ini "${FUNCNAME[0]}"
+
+  local update_arr
+  local app_update_state="${application_updates_available}"
+
+  IFS=', ' read -r -a update_arr <<< "${app_update_state}"
+
   while true; do
     if (( ${#update_arr[@]} == 0 )); then
       print_confirm "Everything is already up-to-date!"
       echo; break
     fi
-    
+
     echo
     top_border
     echo -e "|  The following installations will be updated:         |"
-    if [[ "${KLIPPER_UPDATE_AVAIL}" = "true" ]]; then
-      echo -e "|  ${cyan}● Klipper${white}                                            |"
-    fi
-    if [[ "${MOONRAKER_UPDATE_AVAIL}" = "true" ]]; then
-      echo -e "|  ${cyan}● Moonraker${white}                                          |"
-    fi
-    if [[ "${MAINSAIL_UPDATE_AVAIL}" = "true" ]]; then
-      echo -e "|  ${cyan}● Mainsail${white}                                           |"
-    fi
-    if [[ "${FLUIDD_UPDATE_AVAIL}" = "true" ]]; then
-      echo -e "|  ${cyan}● Fluidd${white}                                             |"
-    fi
-    if [[ "${KLIPPERSCREEN_UPDATE_AVAIL}" = "true" ]]; then
-      echo -e "|  ${cyan}● KlipperScreen${white}                                      |"
-    fi
-    if [[ "${PGC_UPDATE_AVAIL}" = "true" ]]; then
-      echo -e "|  ${cyan}● PrettyGCode for Klipper${white}                            |"
-    fi
-    if [[ "${MOONRAKER_TELEGRAM_BOT_UPDATE_AVAIL}" = "true" ]]; then
-      echo -e "|  ${cyan}● MoonrakerTelegramBot${white}                               |"
-    fi
-    if [[ "${SYS_UPDATE_AVAIL}" = "true" ]]; then
-      echo -e "|  ${cyan}● System${white}                                             |"
-    fi
+
+    [[ "${update_arr[*]}" =~ "klipper" ]] && \
+    echo -e "|  ${cyan}● Klipper${white}                                            |"
+
+    [[ "${update_arr[*]}" =~ "moonraker" ]] && \
+    echo -e "|  ${cyan}● Moonraker${white}                                          |"
+
+    [[ "${update_arr[*]}" =~ "mainsail" ]] && \
+    echo -e "|  ${cyan}● Mainsail${white}                                           |"
+
+    [[ "${update_arr[*]}" =~ "fluidd" ]] && \
+    echo -e "|  ${cyan}● Fluidd${white}                                             |"
+
+    [[ "${update_arr[*]}" =~ "klipperscreen" ]] && \
+    echo -e "|  ${cyan}● KlipperScreen${white}                                      |"
+
+    [[ "${update_arr[*]}" =~ "spoolman" ]] && \
+    echo -e "|  ${cyan}● SpoolMan${white}                                      |"
+
+    [[ "${update_arr[*]}" =~ "pgc_for_klipper" ]] && \
+    echo -e "|  ${cyan}● PrettyGCode for Klipper${white}                            |"
+
+    [[ "${update_arr[*]}" =~ "telegram_bot" ]] && \
+    echo -e "|  ${cyan}● MoonrakerTelegramBot${white}                               |"
+
+    [[ "${update_arr[*]}" =~ "octoeverywhere" ]] && \
+    echo -e "|  ${cyan}● OctoEverywhere${white}                                     |"
+
+    [[ "${update_arr[*]}" =~ "mobileraker" ]] && \
+    echo -e "|  ${cyan}● Mobileraker${white}                                        |"
+
+    [[ "${update_arr[*]}" =~ "octoapp" ]] && \
+    echo -e "|  ${cyan}● OctoApp${white}                                            |"
+
+    [[ "${update_arr[*]}" =~ "system" ]] && \
+    echo -e "|  ${cyan}● System${white}                                             |"
+
     bottom_border
-    
+
     local yn
-    if (( ${#update_arr[@]} != 0 )); then
-      read -p "${cyan}###### Do you want to proceed? (Y/n):${white} " yn
-      case "${yn}" in
-        Y|y|Yes|yes|"")
-          for update in "${update_arr[@]}"
-          do
-            #shellcheck disable=SC2250
-            $update
-          done
-          break;;
-        N|n|No|no)
-          break;;
-        *)
-          print_unkown_cmd
-          print_msg && clear_msg;;
-      esac
-    fi
+    read -p "${cyan}###### Do you want to proceed? (Y/n):${white} " yn
+    case "${yn}" in
+      Y|y|Yes|yes|"")
+        local component
+        local update
+        for component in "${update_arr[@]}"; do
+          if [[ ${component} == "system" ]]; then
+            update="upgrade_system_packages"
+          else
+            update="update_${component}"
+          fi
+          #shellcheck disable=SC2250
+          $update
+        done
+        break;;
+      N|n|No|no)
+        break;;
+      *)
+        error_msg "Invalid command!";;
+    esac
   done
 }

scripts/upload_log.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -54,7 +54,6 @@ function upload_selection() {
   [[ ${upload_agreed} == "false" ]] && accept_upload_conditions
 
   local logfiles
-  local logs_dir="${KLIPPER_LOGS}"
   local webif_logs="/var/log/nginx"
 
   function find_logfile() {
@@ -64,14 +63,18 @@ function upload_selection() {
     done
   }
 
-  find_logfile "kiauh\.log" "/tmp"
-  find_logfile "klippy(-[0-9a-zA-Z]+)?\.log" "${logs_dir}"
-  find_logfile "moonraker(-[0-9a-zA-Z]+)?\.log" "${logs_dir}"
-  find_logfile "telegram(-[0-9a-zA-Z]+)?\.log" "${logs_dir}"
+  local logdir log_dirs
+  log_dirs=$(get_instance_folder_path "logs")
+  for logdir in ${log_dirs}; do
+    find_logfile "klippy(-[0-9a-zA-Z]+)?\.log" "${logdir}"
+    find_logfile "moonraker(-[0-9a-zA-Z]+)?\.log" "${logdir}"
+    find_logfile "telegram(-[0-9a-zA-Z]+)?\.log" "${logdir}"
+  done
   find_logfile "mainsail.*" "${webif_logs}"
   find_logfile "fluidd.*" "${webif_logs}"
   find_logfile "KlipperScreen.log" "/tmp"
   find_logfile "webcamd\.log(\.[0-9]+)?$" "/var/log"
+  find_logfile "kiauh\.log" "/tmp"
 
   ### draw interface
   local i=0

scripts/utilities.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2022 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/th33xitus/kiauh                                    #
+# https://github.com/dw-0/kiauh                                         #
 #                                                                       #
 # This file may be distributed under the terms of the GNU GPLv3 license #
 #=======================================================================#
@@ -20,6 +20,23 @@ function check_euid() {
     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 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
@@ -134,13 +151,20 @@ function init_ini() {
       echo -e "# File creation date: $(date)"
       echo -e "#=================================================#"
       echo -e "# KIAUH - Klipper Installation And Update Helper  #"
-      echo -e "#       https://github.com/th33xitus/kiauh        #"
+      echo -e "#       https://github.com/dw-0/kiauh             #"
       echo -e "#             DO NOT edit this file!              #"
       echo -e "#=================================================#"
       echo -e "# KIAUH v4.0.0"
+      echo -e "#"
     } >> "${INI_FILE}"
   fi
 
+  if ! grep -Eq "^application_updates_available=" "${INI_FILE}"; then
+    echo -e "\napplication_updates_available=\c" >> "${INI_FILE}"
+  else
+    sed -i "/application_updates_available=/s/=.*/=/" "${INI_FILE}"
+  fi
+
   if ! grep -Eq "^backup_before_update=." "${INI_FILE}"; then
     echo -e "\nbackup_before_update=false\c" >> "${INI_FILE}"
   fi
@@ -149,10 +173,6 @@ function init_ini() {
     echo -e "\nlogupload_accepted=false\c" >> "${INI_FILE}"
   fi
 
-  if ! grep -Eq "^custom_klipper_cfg_loc=" "${INI_FILE}"; then
-    echo -e "\ncustom_klipper_cfg_loc=\c" >> "${INI_FILE}"
-  fi
-
   if ! grep -Eq "^custom_klipper_repo=" "${INI_FILE}"; then
     echo -e "\ncustom_klipper_repo=\c" >> "${INI_FILE}"
   fi
@@ -169,158 +189,16 @@ function init_ini() {
     echo -e "\nfluidd_install_unstable=false\c" >> "${INI_FILE}"
   fi
 
-  fetch_webui_ports
-}
-
-function change_klipper_cfg_folder() {
-  local current_cfg_loc example_loc recommended_loc new_cfg_loc
-  current_cfg_loc="$(get_klipper_cfg_dir)"
-  example_loc=$(printf "%s/<your_config_folder>" "${HOME}")
-  recommended_loc=$(printf "%s/klipper_config" "${HOME}")
-
-  local yn
-  while true; do
-    top_border
-    echo -e "|  ${yellow}IMPORTANT:${white}                                           |"
-    echo -e "|  Please enter the new path in the following format:   |"
-    printf  "|  ${cyan}%-51s${white}  |\n" "${example_loc}"
-    blank_line
-    echo -e "|  ${red}WARNING: ${white}                                            |"
-    echo -e "|  ${red}There will be no validation checks! Make sure to set${white} |"
-    echo -e "|  ${red}a valid directory to prevent possible problems!${white}      |"
-    blank_line
-    printf  "|  Recommended: ${cyan}%-38s${white}  |\n" "${recommended_loc}"
-    bottom_border
-    echo
-    echo -e "${cyan}###### Please set the new Klipper config directory:${white} "
-    read -e -i "${current_cfg_loc}" -e new_cfg_loc
-    echo
-    read -p "${cyan}###### Set config directory to '${yellow}${new_cfg_loc}${cyan}' ? (Y/n):${white} " yn
-    case "${yn}" in
-      Y|y|Yes|yes|"")
-        select_msg "Yes"
-        set_klipper_cfg_path "${current_cfg_loc}" "${new_cfg_loc}"
-        print_confirm "New config directory set!"
-        break;;
-      N|n|No|no)
-        select_msg "No"
-        break;;
-      *)
-        print_error "Invalid command!";;
-    esac
-  done
-}
-
-function set_klipper_cfg_path() {
-  local current_cfg_loc="${1}" new_cfg_loc="${2}"
-  local instance klipper_services moonraker_services moonraker_configs
-
-  log_info "Function set_klipper_cfg_path invoked\nCurrent location: ${1}\nNew location: ${2}"
-  ### backup the old config dir
-  backup_klipper_config_dir
-  ### write new location to .kiauh.ini
-  sed -i "/^custom_klipper_cfg_loc=/d" "${INI_FILE}"
-  sed -i '$a'"custom_klipper_cfg_loc=${new_cfg_loc}" "${INI_FILE}"
-  status_msg "New directory was set to '${new_cfg_loc}'!"
-
-  ### stop services
-  do_action_service "stop" "klipper"
-  do_action_service "stop" "moonraker"
-
-  ### copy config files to new klipper config folder
-  if [[ -n ${current_cfg_loc} && -d ${current_cfg_loc} ]]; then
-    status_msg "Copy config files to '${new_cfg_loc}' ..."
-
-    if [[ ! -d ${new_cfg_loc} ]]; then
-      log_info "Copy process started"
-      mkdir -p "${new_cfg_loc}"
-      cd "${current_cfg_loc}"
-      cp -r -v ./* "${new_cfg_loc}"
-      ok_msg "Done!"
-    else
-      log_warning "Copy process skipped, new config directory already exists and may not be empty!"
-      warn_msg "New config directory already exists! Copy process skipped!"
-    fi
+  if ! grep -Eq "^multi_instance_names=" "${INI_FILE}"; then
+    echo -e "\nmulti_instance_names=\c" >> "${INI_FILE}"
   fi
 
-  klipper_services=$(klipper_systemd)
-
-  if [[ -n ${klipper_services} ]]; then
-    status_msg "Re-writing Klipper services to use new config file location ..."
-
-    for service in ${klipper_services}; do
-      if [[ ${service} = "/etc/systemd/system/klipper.service" ]]; then
-
-        if grep -q "Environment=KLIPPER_CONFIG=" "${service}"; then
-          ### single instance klipper service installed by kiauh v4 / MainsailOS > 0.5.0
-          sudo sed -i -r "/KLIPPER_CONFIG=/ s|CONFIG=(.+)\/printer\.cfg|CONFIG=${new_cfg_loc}/printer\.cfg|" "${service}"
-        else
-          ### single instance klipper service installed by kiauh v3
-          sudo sed -i -r "/ExecStart=/ s|klippy\.py (.+)\/printer\.cfg|klippy\.py ${new_cfg_loc}\/printer\.cfg|" "${service}"
-        fi
-
-      else
-        instance=$(echo "${service}" | cut -d"-" -f2 | cut -d"." -f1)
-
-        if grep -q "Environment=KLIPPER_CONFIG=" "${service}"; then
-          ### multi instance klipper service installed by kiauh v4 / MainsailOS > 0.5.0
-          sudo sed -i -r "/KLIPPER_CONFIG=/ s|CONFIG=(.+)\/printer_${instance}\/printer\.cfg|CONFIG=${new_cfg_loc}\/printer_${instance}\/printer\.cfg|" "${service}"
-        else
-          ### multi instance klipper service installed by kiauh v3
-          sudo sed -i -r "/ExecStart=/ s|klippy\.py (.+)\/printer_${instance}\/printer\.cfg|klippy\.py ${new_cfg_loc}\/printer_${instance}\/printer\.cfg|" "${service}"
-        fi
-      fi
-    done
-    ok_msg "OK!"
+  if ! grep -Eq "^version_to_launch=" "${INI_FILE}"; then
+    echo -e "\nversion_to_launch=\n\c" >> "${INI_FILE}"
   fi
 
-  moonraker_services=$(moonraker_systemd)
-
-  if [[ -n ${moonraker_services} ]]; then
-    ### handle multi moonraker instance service file
-    status_msg "Re-writing Moonraker services to use new config file location ..."
-
-    for service in ${moonraker_services}; do
-      if [[ ${service} = "/etc/systemd/system/moonraker.service" ]]; then
-
-        if grep -q "Environment=MOONRAKER_CONF=" "${service}"; then
-          ### single instance moonraker service installed by kiauh v4 / MainsailOS > 0.5.0
-          sudo sed -i -r "/MOONRAKER_CONF=/ s|_CONF=(.+)\/moonraker\.conf|_CONF=${new_cfg_loc}\/moonraker\.conf|" "${service}"
-        else
-          ### single instance moonraker service installed by kiauh v3
-          sudo sed -i -r "/ExecStart=/ s| -c (.+)\/moonraker\.conf| -c ${new_cfg_loc}\/moonraker\.conf|" "${service}"
-        fi
-
-      else
-        instance=$(echo "${service}" | cut -d"-" -f2 | cut -d"." -f1)
-
-        if grep -q "Environment=MOONRAKER_CONF=" "${service}"; then
-          ### multi instance moonraker service installed by kiauh v4 / MainsailOS > 0.5.0
-          sudo sed -i -r "/MOONRAKER_CONF=/ s|_CONF=(.+)\/printer_${instance}\/moonraker\.conf|_CONF=${new_cfg_loc}\/printer_${instance}\/moonraker\.conf|" "${service}"
-        else
-          ### multi instance moonraker service installed by kiauh v3
-          sudo sed -i -r "/ExecStart=/ s| -c (.+)\/printer_${instance}\/moonraker\.conf| -c ${new_cfg_loc}\/printer_${instance}\/moonraker\.conf|" "${service}"
-        fi
-      fi
-    done
-
-    moonraker_configs=$(find "${new_cfg_loc}" -type f -name "moonraker.conf" | sort)
-
-    ### replace old file path with new one in moonraker.conf
-    local loc
-    for conf in ${moonraker_configs}; do
-      loc=$(echo "${conf}" | rev | cut -d"/" -f2- | rev)
-      sed -i -r "/config_path:/ s|config_path:.*|config_path: ${loc}|" "${conf}"
-    done
-    ok_msg "OK!"
-  fi
-
-  ### reloading units
-  sudo systemctl daemon-reload
-
-  ### restart services
-  do_action_service "restart" "klipper"
-  do_action_service "restart" "moonraker"
+  ### strip all empty lines out of the file
+  sed -i "/^[[:blank:]]*$/ d" "${INI_FILE}"
 }
 
 function switch_mainsail_releasetype() {
@@ -370,6 +248,18 @@ function set_custom_klipper_repo() {
   sed -i '$a'"custom_klipper_repo_branch=${branch}" "${INI_FILE}"
 }
 
+function add_to_application_updates() {
+  read_kiauh_ini "${FUNCNAME[0]}"
+
+  local application="${1}"
+  local app_update_state="${application_updates_available}"
+
+  if ! grep -Eq "${application}" <<< "${app_update_state}"; then
+    app_update_state="${app_update_state}${application},"
+    sed -i "/application_updates_available=/s/=.*/=${app_update_state}/" "${INI_FILE}"
+  fi
+}
+
 #================================================#
 #=============== HANDLE SERVICES ================#
 #================================================#
@@ -416,7 +306,7 @@ function python3_check() {
 
 function dependency_check() {
   local dep=( "${@}" )
-  local packages
+  local packages log_name="dependencies"
   status_msg "Checking for the following dependencies:"
 
   #check if package is installed, if not write its name into array
@@ -434,12 +324,12 @@ function dependency_check() {
     done
     echo
 
-    if sudo apt-get update --allow-releaseinfo-change && sudo apt-get install "${packages[@]}" -y; then
-      ok_msg "Dependencies installed!"
-    else
-      error_msg "Installing dependencies failed!"
-      return 1 # exit kiauh
-    fi
+    # update system package lists if stale
+    update_system_package_lists
+
+    # install required packages
+    install_system_packages "${log_name}" "packages[@]"
+
   else
     ok_msg "Dependencies already met!"
     return
@@ -469,28 +359,98 @@ function fetch_webui_ports() {
 #=================== SYSTEM =====================#
 #================================================#
 
-function check_system_updates() {
-  local updates_avail info_msg
-  updates_avail=$(apt list --upgradeable 2>/dev/null | sed "1d")
+function create_required_folders() {
+  local printer_data=${1} folders
+  folders=("backup" "certs" "config" "database" "gcodes" "comms" "logs" "systemd")
 
-  if [[ -n ${updates_avail} ]]; then
-    # add system updates to the update all array for the update all function in the updater
-    SYS_UPDATE_AVAIL="true" && update_arr+=(update_system)
-    info_msg="${yellow}System upgrade available!${white}"
-  else
-    SYS_UPDATE_AVAIL="false"
-    info_msg="${green}System up to date!       ${white}"
-  fi
+  for folder in "${folders[@]}"; do
+    local dir="${printer_data}/${folder}"
 
-  echo "${info_msg}"
+    ### remove possible symlink created by moonraker
+    if [[ -L "${dir}" && -d "${dir}" ]]; then
+      rm "${dir}"
+    fi
+
+    if [[ ! -d "${dir}" ]]; then
+      status_msg "Creating folder '${dir}' ..."
+      mkdir -p "${dir}"
+      ok_msg "Folder '${dir}' created!"
+    fi
+  done
 }
 
-function update_system() {
-  status_msg "Updating System ..."
-  if sudo apt-get update --allow-releaseinfo-change && sudo apt-get upgrade -y; then
-    print_confirm "Update complete! Check the log above!\n ${yellow}KIAUH will not install any dist-upgrades or\n any packages which have been kept back!${green}"
+function update_system_package_lists() {
+  local cache_mtime update_age update_interval silent
+
+  if [[ $1 == '--silent' ]]; then silent="true"; fi
+
+  if [[ -e /var/lib/apt/periodic/update-success-stamp ]]; then
+    cache_mtime="$(stat -c %Y /var/lib/apt/periodic/update-success-stamp)"
+  elif [[ -e /var/lib/apt/lists ]]; then
+    cache_mtime="$(stat -c %Y /var/lib/apt/lists)"
   else
-    print_error "System update failed! Please watch for any errors printed above!"
+    log_warning "Failure determining package cache age, forcing update"
+    cache_mtime=0
+  fi
+
+  update_age="$(($(date +'%s') - cache_mtime))"
+  update_interval=$((48*60*60)) # 48hrs
+
+  # update if cache is greater than update_interval
+  if (( update_age > update_interval )); then
+    if [[ ! ${silent} == "true" ]]; then status_msg "Updating package lists..."; fi
+    if ! sudo apt-get update --allow-releaseinfo-change &>/dev/null; then
+      log_error "Failure while updating package lists!"
+      if [[ ! ${silent} == "true" ]]; then error_msg "Updating package lists failed!"; fi
+      return 1
+    else
+      log_info "Package lists updated successfully"
+      if [[ ! ${silent} == "true" ]]; then status_msg "Updated package lists."; fi
+    fi
+  else
+    log_info "Package lists updated recently, skipping update..."
+  fi
+}
+
+function check_system_updates() {
+  local updates_avail status
+  if ! update_system_package_lists --silent; then
+    status="${red}Update check failed!     ${white}"
+  else
+    updates_avail="$(apt list --upgradeable 2>/dev/null | sed "1d")"
+
+    if [[ -n ${updates_avail} ]]; then
+      status="${yellow}System upgrade available!${white}"
+      # add system to application_updates_available in kiauh.ini
+      add_to_application_updates "system"
+    else
+      status="${green}System up to date!       ${white}"
+    fi
+  fi
+
+  echo "${status}"
+}
+
+function upgrade_system_packages() {
+  status_msg "Upgrading System ..."
+  update_system_package_lists
+  if sudo apt-get upgrade -y; then
+    print_confirm "Upgrade complete! Check the log above!\n ${yellow}KIAUH will not install any dist-upgrades or\n any packages which have been held back!${green}"
+  else
+    print_error "System upgrade failed! Please look for any errors printed above!"
+  fi
+}
+
+function install_system_packages() {
+  local log_name="$1"
+  local packages=("${!2}")
+  status_msg "Installing packages..."
+  if sudo apt-get install -y "${packages[@]}"; then
+    ok_msg "${log_name^} packages installed!"
+  else
+    log_error "Failure while installing ${log_name,,} packages"
+    error_msg "Installing ${log_name} packages failed!"
+    exit 1 # exit kiauh
   fi
 }
 
@@ -643,12 +603,176 @@ function set_hostname() {
   ok_msg "Remember to reboot for the changes to take effect!"
 }
 
-### this function takes in the full path of a systemd service file and returns
-### either the instance index or the custom name
-### input: /etc/systemd/system/klipper-name.service
-### returns: name
+#================================================#
+#============ INSTANCE MANAGEMENT ===============#
+#================================================#
+
+###
+# takes in a systemd service files full path and
+# returns the sub-string with the instance name
+#
+# @param {string}: service file absolute path
+#                  (e.g. '/etc/systemd/system/klipper-<name>.service')
+#
+# => return sub-string containing only the <name> part of the full string
+#
 function get_instance_name() {
-  local instance=${1} name
-  name=$(echo "${instance}" | rev | cut -d"/" -f1 | rev | cut -d"-" -f2 | cut -d"." -f1)
+  local instance=${1}
+  local name
+
+  name=$(echo "${instance}" | rev | cut -d"/" -f1 | cut -d"." -f2 | cut -d"-" -f1 | rev)
+
   echo "${name}"
-}
+}
+
+###
+# returns the instance name/identifier of the klipper service
+# if the klipper service is part of a multi instance setup
+# otherwise returns an emtpy string
+#
+# @param {string}: name - klipper service name (e.g. klipper-name.service)
+#
+function get_klipper_instance_name() {
+  local instance=${1}
+  local name
+
+  name=$(echo "${instance}" | rev | cut -d"/" -f1 | cut -d"." -f2 | rev)
+
+  local regex="^klipper-[0-9a-zA-Z]+$"
+  if [[ ${name} =~ ${regex} ]]; then
+    name=$(echo "${name}" | cut -d"-" -f2)
+  else
+    name=""
+  fi
+
+  echo "${name}"
+}
+
+###
+# loops through all installed klipper services and saves
+# each instances name in a comma separated format to the kiauh.ini
+#
+function set_multi_instance_names() {
+  read_kiauh_ini "${FUNCNAME[0]}"
+
+  local name
+  local names=""
+  local services
+
+  services=$(klipper_systemd)
+
+  ###
+  # if value of 'multi_instance_names' is not an empty
+  # string, delete its value, so it can be re-written
+  if [[ -n ${multi_instance_names} ]]; then
+    sed -i "/multi_instance_names=/s/=.*/=/" "${INI_FILE}"
+  fi
+
+  for svc in ${services}; do
+    name=$(get_klipper_instance_name "${svc}")
+
+    if ! grep -Eq "${name}" <<<"${names}"; then
+      names="${names}${name},"
+    fi
+
+  done
+
+  # write up-to-date instance name string to kiauh.ini
+  sed -i "/multi_instance_names=/s/=.*/=${names}/" "${INI_FILE}"
+}
+
+###
+# Helper function that returns all configured instance names
+#
+# => return an empty string if 0 or 1 klipper instance is installed
+# => return space-separated string for names of the configured instances
+#           if 2 or more klipper instances are installed
+#
+function get_multi_instance_names() {
+  read_kiauh_ini "${FUNCNAME[0]}"
+  local instance_names=()
+
+  ###
+  # convert the comma separates string from the .kiauh.ini into
+  # an array of instance names. a single instance installation
+  # results in an empty instance_names array
+  IFS=',' read -r -a instance_names <<< "${multi_instance_names}"
+
+  echo "${instance_names[@]}"
+}
+
+###
+# helper function that returns all possibly available absolute
+# klipper config directory paths based on their instance name.
+#
+# => return an empty string if klipper is not installed
+# => return space-separated string of absolute config directory paths
+#
+function get_config_folders() {
+  local cfg_dirs=()
+  local instance_names
+  instance_names=$(get_multi_instance_names)
+
+  if [[ -n ${instance_names} ]]; then
+    for name in ${instance_names}; do
+      ###
+      # by KIAUH convention, all instance names of only numbers
+      # need to be prefixed with 'printer_'
+      if [[ ${name} =~ ^[0-9]+$ ]]; then
+        cfg_dirs+=("${HOME}/printer_${name}_data/config")
+      else
+        cfg_dirs+=("${HOME}/${name}_data/config")
+      fi
+    done
+  elif [[ -z ${instance_names} && $(klipper_systemd | wc -w) -gt 0 ]]; then
+    cfg_dirs+=("${HOME}/printer_data/config")
+  else
+    cfg_dirs=()
+  fi
+
+  echo "${cfg_dirs[@]}"
+}
+
+###
+# helper function that returns all available absolute directory paths
+# based on their instance name and specified target folder
+#
+# @param {string}: folder name - target instance folder name (e.g. config)
+#
+# => return an empty string if klipper is not installed
+# => return space-separated string of absolute directory paths
+#
+function get_instance_folder_path() {
+  local folder_name=${1}
+  local folder_paths=()
+  local instance_names
+  local path
+
+  instance_names=$(get_multi_instance_names)
+
+  if [[ -n ${instance_names} ]]; then
+    for name in ${instance_names}; do
+      ###
+      # by KIAUH convention, all instance names of only numbers
+      # need to be prefixed with 'printer_'
+      if [[ ${name} =~ ^[0-9]+$ ]]; then
+        path="${HOME}/printer_${name}_data/${folder_name}"
+        if [[ -d ${path} ]]; then
+          folder_paths+=("${path}")
+        fi
+      else
+        path="${HOME}/${name}_data/${folder_name}"
+        if [[ -d ${path} ]]; then
+          folder_paths+=("${path}")
+        fi
+      fi
+    done
+  elif [[ -z ${instance_names} && $(klipper_systemd | wc -w) -gt 0 ]]; then
+    path="${HOME}/printer_data/${folder_name}"
+    if [[ -d ${path} ]]; then
+      folder_paths+=("${path}")
+    fi
+  fi
+
+  echo "${folder_paths[@]}"
+}