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

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+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: 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: https://paypal.me/dwillner0

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,50 @@
+name: Bug report
+description: Create a report to help us improve
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        This issue form is for reporting bugs only!
+        If you have a feature request, please use [feature_request](/new?template=feature_request.yml)
+  - type: textarea
+    id: distro
+    attributes:
+      label: Linux Distribution
+      description: >-
+        The linux distribution the issue occured on
+    validations:
+      required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened
+      description: >-
+        A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: What did you expect to happen
+      description: >-
+        A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: repro-steps
+    attributes:
+      label: How to reproduce
+      description: >-
+        Minimal and precise steps to reproduce this bug.
+    validations:
+      required: true
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: Additional information
+      description: |
+        If you have any additional information for us, use the field below.
+
+        Please note, you can attach screenshots or screen recordings here, by
+        dragging and dropping files in the field below.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Klipper Discord
+    url: https://discord.klipper3d.org/
+    about: Quickest way to get in contact

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,40 @@
+name: Feature request
+description: Suggest an idea for this project
+labels: ["feature request"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        This issue form is for feature requests only!
+        If you've found a bug, please use [bug_report](/new?template=bug_report.yml)
+  - type: textarea
+    id: problem-description
+    attributes:
+      label: Is your feature request related to a problem? Please describe
+      description: >-
+        A clear and concise description of what the problem is.
+    validations:
+      required: true
+  - type: textarea
+    id: solution-description
+    attributes:
+      label: Describe the solution you'd like
+      description: >-
+        A clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: possible-alternatives
+    attributes:
+      label: Describe alternatives you've considered
+      description: >-
+        A clear and concise description of any alternative solutions or features you've considered.
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: Additional information
+      description: |
+        If you have any additional information for us, use the field below.
+
+        Please note, you can attach screenshots or screen recordings here, by
+        dragging and dropping files in the field below.

.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

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

.shellcheckrc

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

README.md

@@ -1,12 +1,214 @@
-# KIAUH
+<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>
 
-## Klipper Installation And Update Helper
+<p align="center">
+  A handy installation script that makes installing Klipper (and more) a breeze!
+</p>
 
-This script was actually created for my personal use only but i then decided to make the script accessible for everyone.
-It is meant to help guiding you through a complete fresh install of Klipper and optionally the DWC2 web UI + DWC2-for-Klipper.
-There are also functions for updating your current installations or removing them from your system.
+<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>
 
-## First things first: When you decide to use this script, you use it at your own risk!
+<hr>
 
-# THIS VERSION IS WORK IN PROGRESS!!! 
-# BUGS MAY BE STILL PRESENT!!!
+<h2 align="center">
+  📄️ Instructions 📄
+</h2>
+
+### 📋 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.
+
+* 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>
+
+* 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
+```
+
+* **Step 2:** \
+Once git is installed, use the following command to download KIAUH into your home-directory:
+
+```shell
+cd ~ && git clone https://github.com/dw-0/kiauh.git
+```
+
+* **Step 3:** \
+Finally, start KIAUH by running the next command:
+
+```shell
+./kiauh/kiauh.sh
+```
+
+* **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>
+</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>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><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>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><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>
+
+<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/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

@@ -0,0 +1,305 @@
+## Changelog
+
+This document covers possible important changes to KIAUH.
+
+### 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 (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 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)
+* refactor: The update manager sections for Mainsail, Fluidd and KlipperScreen were removed from the moonraker.conf template
+  * They will now be individually added during installation of the corresponding interface
+* refactor: The rollback function was reworked and now also allows rollbacks of Moonraker
+  * It now takes numerical inputs and reverts the corresponding repository by the given amount instead
+  * KIAUH does not save previous states to its config anymore like it did with the previous approach
+
+
+### 2022-01-29
+* Starting from the 28th of January, Moonraker can make use of PackageKit and PolicyKit.\
+More details on that can be found [here](
+https://github.com/Arksine/moonraker/issues/349) and [here](https://github.com/Arksine/moonraker/pull/346)
+* KIAUH will install Moonrakers PolicyKit rules by default when __installing__ Moonraker
+* KIAUH will also install Moonrakers PolicyKit rules when __updating__ Moonraker __via KIAUH__ as of now
+
+### 2021-12-30
+* Updated the doc for the usage of the [G-Code Shell Command Extension](docs/gcode_shell_command.md)
+* It became apparent, that some user groups are missing on some systems. A missing video group \
+membership for example caused issues when installing mjpg-streamer while not using the default pi user. \
+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
+ 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.
+
+### 2021-09-28
+* New Feature! Added an installer for the Telegram Bot for Moonraker by [nlef](https://github.com/nlef).
+Checkout his project! Remember to report all issues and/or bugs regarding that project in its corresponding repo and not here 😛.\
+You can find it here: https://github.com/nlef/moonraker-telegram-bot
+
+### 2021-09-24
+* The flashing function got adjusted a bit. It is now possible to also flash controllers which are connected over UART and thus accessible via `/dev/ttyAMA0`. You now have to select a connection methop prior flashing which is either USB or UART.
+* Due to several requests over time I have now created a Ko-fi account for those who want to support this project and my work with a small donation. Many thanks in advance to all future donors. You can support me on Ko-fi with this link: https://ko-fi.com/th33xitus
+* As usual, if you find any bugs or issues please report them. I tested the little rework i did with the hardware i have available and haven't encountered any malfunctions of flashing them yet.
+
+### 2021-08-10
+* KIAUH now supports the installation of the "PrettyGCode for Klipper" GCode-Viewer created by [Kragrathea](https://github.com/Kragrathea)! Installation, updating and removal are possible with KIAUH. For more details to this cool piece of software, please have a look here: https://github.com/Kragrathea/pgcode
+
+### 2021-07-10
+* The NGINX configuration files got updated to be in sync with MainsailOS and FluiddPi. Issues with the NGINX service not starting up due to wrong configuration should be resolved now. To get the updated configuration files, please remove Moonraker and Mainsail / Fluidd with KIAUH first and then re-install it. An automated file check for those configuration files might follow in the future which then automates updating those files if there were important changes.
+
+* The default `moonraker.conf` was updated to reflect the recent changes to the update manager section. The update channel is set to `dev`.
+
+### 2021-06-29
+* KIAUH will now patch the new `log_path` to existing moonraker.conf files when updating Moonraker and the entry is missing. Before that, it was necessary that the user provided that path manually to make Fluidd display the logfiles in its interface. This issue should be resolved now.
+
+### 2021-06-15
+
+* Moonraker introduced an optional `log_path` which clients can make use of to show log files located in that folder to their users. More info here: https://github.com/Arksine/moonraker/commit/829b3a4ee80579af35dd64a37ccc092a1f67682a \
+Client developers agreed upon using `~/klipper_logs` as the new default log path.\
+That means, from now on, Klipper and Moonraker services installed with KIAUH will place their logfiles in that mentioned folder.
+* Additionally, KIAUH will now detect Klipper and Moonraker systemd services that still use the old default location of `/tmp/<service>.log` and will update them next time the user updates Klipper and/or Moonraker with the KIAUH update function.
+* Additional symlinks for the following logfiles will get created along those update procedures to make them accessible through the webinterface once its supported:
+    - webcamd.log
+    - mainsail-access.log
+    - mainsail-error.log
+    - fluidd-access.log
+    - fluidd-error.log
+* For MainsailOS and FluiddPi users:\
+MainsailOS and FluiddPi will switch the shipped Klipper service from SysVinit to systemd probably with their next release. KIAUH can already help migrate older MainsailOS (0.4.0 and below) and FluiddPi (v1.13.0) releases to match their new service-, file- and folder-structure so you don't have to re-flash the SD-Card of your Raspberry Pi.\
+In detail here is what is going to happen when you use the new "CustomPiOS Migration Helper" from the Advanced Menu\
+`(Main Menu -> 4 -> Enter -> 10 -> Enter)` in a short summary:
+    * The Klipper SysVinit service will get replaced by a Klipper systemd service
+    * Klipper and Moonraker will use the new log-directory `~/klipper_logs`
+    * The webcamd service gets updated
+    * The webcamd script gets updated and moved from `/root/bin/webcamd` to `/usr/local/bin/webcamd`
+    * The NGINX `upstreams.conf` gets updated to be able to configure up to 4 webcams
+    * The `mainsail.txt` / `fluiddpi.txt` gets moved from `/boot` to `~/klipper_config` and renamed to `webcam.txt`
+    * Symlinks for the webcamd.log and various NGINX logs get created in `~/klipper_config`
+    * Configuration files for Klipper, Moonraker and webcamd get added to `/etc/logrotate.d`
+    * If they still exist, two lines will be removed from the mainsail.cfg or client_macros.cfg macro configurations:\
+    `SAVE_GCODE_STATE NAME=PAUSE_state` and `RESTORE_GCODE_STATE NAME=PAUSE_state`
+* **Please note:**\
+The "CustomPiOS Migration Helper" is intended to only work on "vanilla" MainsailOS and FluiddPi systems. Do not try to migrate a modified MainsailOS or FluiddPi system (for example if you already used KIAUH to re-install services or to set up a multi-instance installation for Klipper / Moonraker). This won't work.
+
+### 2021-01-31
+
+* **This is a big one... KIAUH v3.0 is out.**\
+With this update you can now install multiple instances of Klipper, Moonraker, Duet Web Control or Octoprint on the same Pi. This was quite a big rework of the whole script. So bugs can appear but with the help of some testers, i think there shouldn't be any critical ones anymore. In this regards thanks to @lixxbox and @zellneralex for testing.
+
+* Important changes to how installations are set up now: All components get installed as systemd services. Installation via init.d was dropped completely! This shouldn't affect you at all, since the common linux distributions like RaspberryPi OS or custom distributions like MainsailOS, FluiddPi or OctoPi support both ways of installing services. I just wanted to mention it here.
+
+* Now with KIAUH v3.0 and multi-instance installation capabilities, there are some things to point out. You will now need to tell KIAUH where your printers configurations are located when installing Klipper for the first time. Even though it is not recommended, you can change this location with the help of KIAUH and rewrite Klipper and Moonraker to use the new location.
+
+* When setting up a multi-instance system, the folder structure will only change slightly. The goal was to keep it as compatible as possible with the custom distributions like mainsailOS and FluiddPi. This should help converting a single-instance setup of mainsailOS/FluiddPi to a multi-instance setup in no time, but keeping single-instance backwards compatibility if needed at a later point in time.
+
+* The folder structure is as follows when setting up multi-instances:\
+Each printer instance will get its own folder within your configuration location. The decision to this specific structure was made to make it as painless and easy as possible to convert to a multi-instance setup.
+Here is an example:
+    ```shell
+    /home/<username>
+              └── klipper_config
+                  ├── printer_1
+                  │   ├── printer.cfg
+                  │   └── moonraker.conf
+                  ├── printer_2
+                  │   ├── printer.cfg
+                  │   └── moonraker.conf
+                  └── printer_n
+                      ├── printer.cfg
+                      └── moonraker.conf
+    ```
+* Also when setting up multi-instances of each service, the name of each service slightly changes.
+Each service gets its corresponding instance added to the service filename.
+
+    **This only applies to multi-instances! Single instance installations with KIAUH will keep their original names!**
+
+    Corresponding to the filetree example from above that would mean:
+    ```
+    Klipper services:
+            --> klipper-1.service
+            --> klipper-2.service
+            --> klipper-n.service
+
+    Moonraker services:
+            --> moonraker-1.service
+            --> moonraker-2.service
+            --> moonraker-n.service
+    ```
+* The same service file rules from above apply to OctoPrint even though only Klipper and Moonraker are shown in this example.
+
+* You can start, stop and restart all Klipper, Moonraker and OctoPrint instances from the KIAUH main menu. For doing this, just type "stop klipper", "start moonraker", "restart octoprint" and so on.
+
+* KIAUH v3.0 relocated its ini-file. It is now a hidden file in the users home-directory calles `.kiauh.ini`. This has the benefit of keeping all values in that file between possible re-installations of KIAUH. Otherwise that file would be lost.
+
+* The option of adding more trusted clients to the moonraker.conf file was dropped. Since you can edit this file right inside of Mainsail or Fluidd, only some basic entries are made which get you running.
+
+* I bet i have missed mentioning other stuff as well because it took me quite some time to re-write many functions. So i just hope you like the new version 😄
+
+### 2020-11-28
+
+* KIAUH now supports the installation, update and removal of [KlipperScreen](https://github.com/jordanruthe/KlipperScreen). This feature was was provided by [jordanruthe](https://github.com/jordanruthe)! Thank you!
+
+### 2020-11-18
+
+* Some changes to Fluidd caused a little rework on how KIAUH will install/update Fluidd from now on. Please see the [fluidd v1.0.0-rc0 release notes](https://github.com/cadriel/fluidd/releases/tag/v1.0.0-rc.0) for further information about what modifications to the moonraker.conf file exactly had to be done. In a nutshell, KIAUH will now always patch the required entries to the moonraker.conf if not already there.
+
+### 2020-10-30:
+
+* The user can now choose to install Klipper as a systemd service.
+
+* The Shell Command extension and `shell_command.py` got renamed to G-Code Shell Command extension and `gcode_shell_command.py`. In case the [pending PR](https://github.com/KevinOConnor/klipper/pull/2173) will be merged in the future, this was an early attempt to dodge possible incompatibilities. The [G-Code Shell Command docs](gcode_shell_command.md) has been updated accordingly.
+
+* The way how KIAUH interacts and writes to the users printer.cfg got changed. Usually KIAUH wrote everything directly into the printer.cfg. The way it will work from now on is, that a new file called `kiauh.cfg` will be created if there is something that needs to be written to the printer.cfg and everything gets written to `kiauh.cfg` instead. The only thing which then gets written to the users printer.cfg is `[include kiauh.cfg]`. This line will be located at the very top of the existing printer.cfg with a little comment as a note. The user can then decide to either keep the `kiauh.cfg` or take its content, places it into the printer.cfg directly and remove the `[include kiauh.cfg]`.
+
+* The `mainsail_macros.cfg` got renamed to `webui_macros.cfg`. Since Mainsail and Fluidd both use the same kind of pause, cancel and resume macros, a more generic name was chosen for the file containing the example macros one can choose to install when installing those webinterfaces.
+
+### 2020-10-10:
+
+* Support for changing the Klipper branch to the moonraker-dev branch from @Arksine has been dropped. Support for Moonraker has been merged into Klipper mainline a long time ago.
+
+* A new function is available from the main menu. You can now upload your log files to http://paste.c-net.org/ to share them for debugging purposes.
+
+### 2020-10-06:
+
+* Fluidd, a new Klipper interface got added to the list of available installers. At the same time some installation routines have changed or have seen some rework. Changes were made to the installation of NGINX configurations. A method was introduced to change the listen port of a webinterface configuration if there is already another webinterface listening on the default port (80).
+
+* At the moment, the Moonraker installer no longer asks you whether you want to install a web interface too. For now you therefore have to install them with their respective installers. Please report any bugs or issues you encounter.
+
+### 2020-09-17:
+
+* The dev-2.0 branch will be abandoned as of today. If you did a checkout to that branch in the past, you have to checkout back to master to receive updates.
+
+### 2020-09-12:
+
+* The old [dwc2-for-klipper](https://github.com/Stephan3/dwc2-for-klipper) won't be supported anymore!\
+The is a new, fully rewritten project available: [dwc2-for-klipper-socket](https://github.com/Stephan3/dwc2-for-klipper-socket).\
+The installer of this script also got rewritten to make use of that new project. You will not be able to install or remove the old [dwc2-for-klipper](https://github.com/Stephan3/dwc2-for-klipper) with KIAUH anymore if you updated KIAUH to the newest version.

docs/gcode_shell_command.md

@@ -0,0 +1,74 @@
+# G-Code Shell Command Extension
+
+### Creator of this extension is [Arksine](https://github.com/Arksine).
+
+This is a brief explanation of how to use the shell command extension for Klipper, which you can install with KIAUH.
+
+After installing the extension you can execute linux commands or even scripts from within Klipper with custom commands defined in your printer.cfg.
+
+#### How to configure a shell command:
+
+```shell
+# Runs a linux command or script from within klipper.  Note that sudo commands
+# that require password authentication are disallowed. All executable scripts
+# should include a shebang.
+# [gcode_shell_command my_shell_cmd]
+#command:
+#  The linux shell command/script to be executed.  This parameter must be
+#  provided
+#timeout: 2.
+#  The timeout in seconds until the command is forcably terminated.  Default
+#  is 2 seconds.
+#verbose: True
+#  If enabled, the command's output will be forwarded to the terminal.  Its
+#  recommended to set this to false for commands that my run in quick
+#  succession.  Default is True.
+```
+
+Once you have set up a shell command with the given parameters from above in your printer.cfg you can run the command as follows:
+`RUN_SHELL_COMMAND CMD=name`
+
+Example:
+
+```
+[gcode_shell_command hello_world]
+command: echo hello world
+timeout: 2.
+verbose: True
+```
+
+Execute with:
+`RUN_SHELL_COMMAND CMD=hello_world`
+
+### Passing parameters:
+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.
+
+Content of the `gcode_shell_command` and the `gcode_macro`:
+```
+[gcode_shell_command print_to_file]
+command: sh /home/pi/klipper_config/script.sh
+timeout: 30.
+verbose: True
+
+[gcode_macro GET_TEMP]
+gcode:
+    {% set temp = printer.extruder.temperature %}
+    { action_respond_info("%s" % (temp)) }
+    RUN_SHELL_COMMAND CMD=print_to_file PARAMS={temp}
+```
+
+Content of `script.sh`:
+```shell
+#!/bin/sh
+
+echo "temp is: $1"
+echo "$1" >> "${HOME}/test.txt"
+```
+
+## Warning
+
+This extension may have a high potential for abuse if not used carefully! Also, depending on the command you execute, high system loads may occur and can cause system instabilities.
+Use this extension at your own risk and only if you know what you are doing!

kiauh.ini

@@ -1 +0,0 @@
-backup_before_update=false

kiauh.sh

@@ -1,387 +1,71 @@
-#!/bin/bash
-clear
+#!/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
+clear -x
 
-### set some variables
-ERROR_MSG=""
-green="\e[92m"
-yellow="\e[93m"
-red="\e[91m"
-cyan="\e[96m"
-default="\e[39m"
-
-### set some messages
-warn_msg(){
-  echo -e "${red}<!!!!> $1${default}"
-}
-status_msg(){
-  echo; echo -e "${yellow}###### $1${default}"
-}
-ok_msg(){
-  echo -e "${green}>>>>>> $1${default}"
-}
-title_msg(){
-  echo -e "${cyan}$1${default}"
-}
-get_date(){
-  current_date=`date +"%Y-%m-%d_%H%M%S"`
-}
+# make sure we have the correct permissions while running the script
+umask 022
 
 ### sourcing all additional scripts
-for script in ${HOME}/kiauh/scripts/*; do . $script; done
+KIAUH_SRCDIR="$(dirname -- "$(readlink -f "${BASH_SOURCE[0]}")")"
+for script in "${KIAUH_SRCDIR}/scripts/"*.sh; do . "${script}"; done
+for script in "${KIAUH_SRCDIR}/scripts/ui/"*.sh; do . "${script}"; done
 
-### set important directories
-#klipper
-KLIPPER_DIR=${HOME}/klipper
-KLIPPY_ENV_DIR=${HOME}/klippy-env
-KLIPPER_SERVICE1=/etc/init.d/klipper
-KLIPPER_SERVICE2=/etc/default/klipper
-#dwc2
-DWC2FK_DIR=${HOME}/dwc2-for-klipper
-DWC2_DIR=${HOME}/sdcard/dwc2
-WEB_DWC2=${HOME}/klipper/klippy/extras/web_dwc2.py
-TORNADO_DIR1=${HOME}/klippy-env/lib/python2.7/site-packages/tornado
-TORNADO_DIR2=${HOME}/klippy-env/lib/python2.7/site-packages/tornado-5.1.1.dist-info
-#mainsail/moonraker
-MAINSAIL_DIR=${HOME}/mainsail
-MAINSAIL_SERVICE1=/etc/init.d/moonraker
-MAINSAIL_SERVICE2=/etc/default/moonraker
-#misc
-BACKUP_DIR=${HOME}/kiauh-backups
-PRINTER_CFG=${HOME}/printer.cfg
+#===================================================#
+#=================== UPDATE KIAUH ==================#
+#===================================================#
 
-### set github repos
-KLIPPER_REPO=https://github.com/KevinOConnor/klipper.git
-ARKSINE_REPO=https://github.com/Arksine/klipper.git
-DMBUTYUGIN_REPO=https://github.com/dmbutyugin/klipper.git
-DWC2FK_REPO=https://github.com/Stephan3/dwc2-for-klipper.git
-#branches
-BRANCH_MOONRAKER=Arksine/work-web_server-20200131
-BRANCH_DEV_MOONRAKER=Arksine/dev-moonraker-testing
-BRANCH_SCURVE_SMOOTHING=dmbutyugin/scurve-smoothing
-BRANCH_SCURVE_SHAPING=dmbutyugin/scurve-shaping
+function update_kiauh() {
+  status_msg "Updating KIAUH ..."
 
-print_error_msg(){
-  if [[ "$ERROR_MSG" != "" ]]; then
-    echo -e "${red}"
-    echo -e "#########################################################"
-    echo -e "$ERROR_MSG "
-    echo -e "#########################################################"
-    echo -e "${default}"
+  cd "${KIAUH_SRCDIR}"
+  git reset --hard && git pull
+
+  ok_msg "Update complete! Please restart KIAUH."
+  exit 0
+}
+
+#===================================================#
+#=================== KIAUH STATUS ==================#
+#===================================================#
+
+function kiauh_update_avail() {
+  [[ ! -d "${KIAUH_SRCDIR}/.git" ]] && return
+  local origin head
+
+  cd "${KIAUH_SRCDIR}"
+
+  ### abort if not on master branch
+  ! git branch -a | grep -q "\* master" && return
+
+  ### compare commit hash
+  git fetch -q
+  origin=$(git rev-parse --short=8 origin/master)
+  head=$(git rev-parse --short=8 HEAD)
+
+  if [[ ${origin} != "${head}" ]]; then
+    echo "true"
   fi
 }
 
-main_menu(){
-  print_header
-  print_error_msg && ERROR_MSG=""
-  #check install status
-    klipper_status
-    dwc2_status
-    mainsail_status
-    print_branch
-  main_ui
-  while true; do
-    read -p "Perform action: " action; echo
-    case "$action" in
-      0)
-        clear
-        print_header
-        ERROR_MSG=" Sorry this function is not implemented yet!"
-        print_error_msg && ERROR_MSG=""
-        main_ui;;
-      1)
-        clear
-        install_menu
-        break;;
-      2)
-        clear
-        update_menu
-        break;;
-      3)
-        clear
-        remove_menu
-        break;;
-      4)
-        clear
-        advanced_menu
-        break;;
-      5)
-        clear
-        backup_menu
-        break;;
-      Q|q)
-        exit -1;;
-      *)
-        clear
-        print_header
-        ERROR_MSG=" Unknown command '$action'"
-        print_error_msg && ERROR_MSG=""
-        main_ui;;
-    esac
-  done
-  clear; main_menu
-}
-
-install_menu(){
-  print_header
-  install_ui
-  while true; do
-    read -p "Perform action: " action; echo
-    case "$action" in
-      1)
-        clear
-        print_header
-        install_klipper
-        print_error_msg && ERROR_MSG=""
-        install_ui;;
-      2)
-        clear
-        print_header
-        dwc2_install_routine
-        print_error_msg && ERROR_MSG=""
-        install_ui;;
-      3)
-        clear
-        print_header
-        mainsail_install_routine
-        print_error_msg && ERROR_MSG=""
-        install_ui;;
-      Q|q)
-        clear; main_menu; break;;
-      *)
-        clear
-        print_header
-        ERROR_MSG=" Unknown command '$action'"
-        print_error_msg && ERROR_MSG=""
-        install_ui;;
-    esac
-  done
-  install_menu
-}
-
-update_menu(){
-  print_header
-  read_bb4u_stat
-  #compare versions
-    ui_print_versions
-  update_ui
-  while true; do
-    read -p "Perform action: " action; echo
-    case "$action" in
-      0)
-        clear
-        print_header
-        toggle_backups
-        print_error_msg && ERROR_MSG=""
-        update_ui;;
-      1)
-        clear
-        print_header
-        update_klipper && ui_print_versions
-        print_error_msg && ERROR_MSG=""
-        update_ui;;
-      2)
-        clear
-        print_header
-        update_dwc2fk && ui_print_versions
-        print_error_msg && ERROR_MSG=""
-        update_ui;;
-      3)
-        clear
-        print_header
-        update_dwc2 && ui_print_versions
-        print_error_msg && ERROR_MSG=""
-        update_ui;;
-      4)
-        clear
-        print_header
-        update_mainsail && ui_print_versions
-        print_error_msg && ERROR_MSG=""
-        update_ui;;
-      Q|q)
-        clear; main_menu; break;;
-      *)
-        clear
-        print_header
-        ERROR_MSG=" Unknown command '$action'"
-        print_error_msg && ERROR_MSG=""
-        ui_print_versions
-        update_ui;;
-    esac
-  done
-  update_menu
-}
-
-remove_menu(){
-  print_header
-  remove_ui
-  while true; do
-    read -p "Perform action: " action; echo
-    case "$action" in
-      1)
-        clear
-        print_header
-        remove_klipper
-        print_error_msg && ERROR_MSG=""
-        remove_ui;;
-      2)
-        clear
-        print_header
-        remove_dwc2
-        print_error_msg && ERROR_MSG=""
-        remove_ui;;
-      3)
-        clear
-        print_header
-        remove_mainsail
-        print_error_msg && ERROR_MSG=""
-        remove_ui;;
-      Q|q)
-        clear; main_menu; break;;
-      *)
-        clear
-        print_header
-        ERROR_MSG=" Unknown command '$action'"
-        print_error_msg && ERROR_MSG=""
-        remove_ui;;
-    esac
-  done
-  remove_menu
-}
-
-advanced_menu(){
-  print_header
-  print_error_msg && ERROR_MSG=""
-  advanced_ui
-  while true; do
-    read -p "Perform action: " action; echo
-    case "$action" in
-      1)
-        clear
-        switch_menu
-        print_error_msg && ERROR_MSG=""
-        advanced_ui;;
-      2)
-        clear
-        print_header
-        build_fw
-        print_error_msg && ERROR_MSG=""
-        advanced_ui;;
-      3)
-        clear
-        print_header
-        flash_routine
-        print_error_msg && ERROR_MSG=""
-        advanced_ui;;
-      4)
-        clear
-        print_header
-        get_usb_id
-        print_error_msg && ERROR_MSG=""
-        advanced_ui;;
-      5)
-        clear
-        print_header
-        get_usb_id && write_printer_id
-        print_error_msg && ERROR_MSG=""
-        advanced_ui;;
-      6)
-        clear
-        print_header
-        create_dwc2fk_cfg
-        print_error_msg && ERROR_MSG=""
-        advanced_ui;;
-      Q|q)
-        clear; main_menu; break;;
-      *)
-        clear
-        print_header
-        ERROR_MSG=" Unknown command '$action'"
-        print_error_msg && ERROR_MSG=""
-        advanced_ui;;
-    esac
-  done
-  advanced_menu
-}
-
-switch_menu(){
-  print_header
-  if [ -d $KLIPPER_DIR ]; then
-    read_branch
-    print_error_msg && ERROR_MSG=""
-    switch_ui
-    while true; do
-      read -p "Perform action: " action; echo
-      case "$action" in
-        1)
-          clear
-          print_header
-          switch_to_origin
-          read_branch
-          print_error_msg && ERROR_MSG=""
-          switch_ui;;
-        2)
-          clear
-          print_header
-          switch_to_scurve_shaping
-          read_branch
-          print_error_msg && ERROR_MSG=""
-          switch_ui;;
-        3)
-          clear
-          print_header
-          switch_to_scurve_smoothing
-          read_branch
-          print_error_msg && ERROR_MSG=""
-          switch_ui;;
-        4)
-          clear
-          print_header
-          switch_to_moonraker
-          read_branch
-          print_error_msg && ERROR_MSG=""
-          switch_ui;;
-        5)
-          clear
-          print_header
-          switch_to_dev_moonraker
-          read_branch
-          print_error_msg && ERROR_MSG=""
-          switch_ui;;
-        Q|q)
-          clear; advanced_menu; break;;
-      esac
-    done
-  else
-    ERROR_MSG=" No klipper directory found! Download klipper first!"
-  fi
-}
-
-backup_menu(){
-  print_header
-  print_error_msg && ERROR_MSG=""
-  backup_ui
-  while true; do
-    read -p "Perform action: " action; echo
-    case "$action" in
-      1)
-        clear
-        print_header
-        #function goes here
-        print_error_msg && ERROR_MSG=""
-        backup_ui;;
-      Q|q)
-        clear; main_menu; break;;
-      *)
-        clear
-        print_header
-        ERROR_MSG=" Unknown command '$action'"
-        print_error_msg && ERROR_MSG=""
-        backup_ui;;
-    esac
-  done
-  backup_menu
+function main() {
+  read_kiauh_ini "${FUNCNAME[0]}"
+  main_menu
 }
 
+check_if_ratos
 check_euid
-main_menu
+init_logfile
+set_globals
+read_kiauh_ini
+init_ini
+main

klipper_repos.txt.example

@@ -0,0 +1,18 @@
+# This file acts as an example file.
+#
+# 1) Make a copy of this file and rename it to 'klipper_repos.txt'
+# 2) Add your custom Klipper repository to the bottom of that copy
+# 3) Save the file
+#
+# Back in KIAUH you can now go into -> [Settings] and use action '2' to set a different Klipper repository
+#
+# Make sure to always separate the repository and the branch with a ','.
+# <repository>,<branch> -> https://github.com/Klipper3d/klipper,master
+# If you omit a branch, it will always default to 'master'
+#
+# You are allowed to omit the 'https://github.com/' part of the repository URL
+# Down below are now a few examples of what is considered as valid:
+https://github.com/Klipper3d/klipper,master
+https://github.com/Klipper3d/klipper
+Klipper3d/klipper,master
+Klipper3d/klipper

resources/autocommit.sh

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

resources/common_vars.conf

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

resources/example.printer.cfg

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

resources/fluidd

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

resources/gcode_shell_command.py

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

resources/klipper.env

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

resources/klipper.service

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

resources/mainsail

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

resources/mjpg-streamer/webcam.txt

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

resources/mjpg-streamer/webcamd

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

resources/mjpg-streamer/webcamd.service

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

resources/moonraker-telegram-bot.env

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

resources/moonraker-telegram-bot.service

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

resources/moonraker.conf

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

resources/moonraker.env

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

resources/moonraker.service

@@ -0,0 +1,19 @@
+[Unit]
+Description=API Server for Klipper SV1 %INST%
+Documentation=https://moonraker.readthedocs.io/
+Requires=network-online.target
+After=network-online.target
+
+[Install]
+WantedBy=multi-user.target
+
+[Service]
+Type=simple
+User=%USER%
+SupplementaryGroups=moonraker-admin
+RemainAfterExit=yes
+WorkingDirectory=%MOONRAKER_DIR%
+EnvironmentFile=%ENV_FILE%
+ExecStart=%ENV%/bin/python $MOONRAKER_ARGS
+Restart=always
+RestartSec=10

resources/shell_command.cfg

@@ -0,0 +1,7 @@
+[gcode_shell_command hello_world]
+command: echo hello world
+timeout: 2.
+verbose: True
+[gcode_macro HELLO_WORLD]
+gcode:
+    RUN_SHELL_COMMAND CMD=hello_world

resources/upstreams.conf

@@ -0,0 +1,25 @@
+# /etc/nginx/conf.d/upstreams.conf
+upstream apiserver {
+    ip_hash;
+    server 127.0.0.1:7125;
+}
+
+upstream mjpgstreamer1 {
+    ip_hash;
+    server 127.0.0.1:8080;
+}
+
+upstream mjpgstreamer2 {
+    ip_hash;
+    server 127.0.0.1:8081;
+}
+
+upstream mjpgstreamer3 {
+    ip_hash;
+    server 127.0.0.1:8082;
+}
+
+upstream mjpgstreamer4 {
+    ip_hash;
+    server 127.0.0.1:8083;
+}

scripts/backup.sh

@@ -1,74 +1,231 @@
-backup_printer_cfg(){
-  if [ ! -d $BACKUP_DIR ]; then
-    status_msg "Create backup directory ..."
-    mkdir -p $BACKUP_DIR && ok_msg "Directory created!"
-  fi
-  if [ -f $PRINTER_CFG ]; then
-    get_date
-    status_msg "Create backup of printer.cfg ..."
-    cp $PRINTER_CFG $BACKUP_DIR/printer.cfg."$current_date".backup && ok_msg "Backup created!"
+#!/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
+
+function get_date() {
+  local current_date
+  current_date=$(date +"%y%m%d-%H%M")
+  echo "${current_date}"
+}
+
+function check_for_backup_dir() {
+  [[ -d ${BACKUP_DIR} ]] && return
+
+  status_msg "Create KIAUH backup directory ..."
+  mkdir -p "${BACKUP_DIR}" && ok_msg "Directory created!"
+}
+
+function backup_before_update() {
+  read_kiauh_ini "${FUNCNAME[0]}"
+  local state="${backup_before_update}"
+  [[ ${state} = "false" ]] && return
+  backup_"${1}"
+}
+
+function backup_config_dir() {
+  check_for_backup_dir
+  local current_date config_pathes
+
+  config_pathes=$(get_config_folders)
+
+  if [[ -n "${config_pathes}" ]]; then
+    current_date=$(get_date)
+    status_msg "Timestamp: ${current_date}"
+
+    local i=0 folder folder_name target_dir
+    for folder in ${config_pathes}; do
+      if [[ -d ${folder} ]]; then
+        status_msg "Create backup of ${folder} ..."
+
+        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 printer.cfg found! Skipping backup ..."
+    ok_msg "No config directory found! Skipping backup ..."
   fi
 }
 
-read_bb4u_stat(){
-  source_ini
-  if [ ! "$backup_before_update" = "true" ]; then
-    BB4U_STATUS="${green}[Enable]${default} backups before updating                  "
+function backup_moonraker_database() {
+  check_for_backup_dir
+  local current_date db_pathes
+
+  db_pathes=$(get_instance_folder_path "database")
+
+  if [[ -n ${db_pathes} ]]; then
+    current_date=$(get_date)
+    status_msg "Timestamp: ${current_date}"
+
+    local i=0 database folder_name target_dir
+    for database in ${db_pathes}; do
+      status_msg "Create backup of ${database} ..."
+
+      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
-    BB4U_STATUS="${red}[Disable]${default} backups before updating                 "
+    print_error "No Moonraker database found! Skipping backup ..."
   fi
 }
 
-toggle_backups(){
-  source_ini
-  if [ "$backup_before_update" = "true" ]; then
-    sed -i '/backup_before_update=/s/true/false/' ${HOME}/kiauh2/kiauh.ini
-    BB4U_STATUS="${green}[Enable]${default} backups before updating                  "
-  fi
-  if [ "$backup_before_update" = "false" ]; then
-    sed -i '/backup_before_update=/s/false/true/' ${HOME}/kiauh2/kiauh.ini
-    BB4U_STATUS="${red}[Disable]${default} backups before updating                 "
-  fi
-}
+function backup_klipper() {
+  local current_date
 
-bb4u_klipper(){
-  source_ini
-  if [ -d $KLIPPER_DIR ] && [ "$backup_before_update" = "true" ]; then
-    get_date
+  if [[ -d ${KLIPPER_DIR} && -d ${KLIPPY_ENV} ]]; then
     status_msg "Creating Klipper backup ..."
-    mkdir -p $BACKUP_DIR/klipper-backups/"$current_date"
-    cp -r $KLIPPER_DIR $_ && cp -r $KLIPPY_ENV_DIR $_ && ok_msg "Backup complete!"
+    check_for_backup_dir
+    current_date=$(get_date)
+    status_msg "Timestamp: ${current_date}"
+    mkdir -p "${BACKUP_DIR}/klipper-backups/${current_date}"
+    cp -r "${KLIPPER_DIR}" "${_}" && cp -r "${KLIPPY_ENV}" "${_}"
+    print_confirm "Klipper backup complete!"
+  else
+    print_error "Can't back up 'klipper' and/or 'klipper-env' directory! Not found!"
   fi
 }
 
-bb4u_dwc2fk(){
-  source_ini
-  if [ -d $DWC2FK_DIR ] && [ "$backup_before_update" = "true" ]; then
-    get_date
-    status_msg "Creating DWC2-for-Klipper backup ..."
-    mkdir -p $BACKUP_DIR/dwc2-for-klipper-backups/"$current_date"
-    cp -r $DWC2FK_DIR $_ && ok_msg "Backup complete!"
-  fi
-}
+function backup_mainsail() {
+  local current_date
 
-bb4u_dwc2(){
-  source_ini
-  if [ -d $DWC2_DIR ] && [ "$backup_before_update" = "true" ]; then
-    get_date
-    status_msg "Creating DWC2 Web UI backup ..."
-    mkdir -p $BACKUP_DIR/dwc2-backups/"$current_date"
-    cp -r $DWC2_DIR $_ && ok_msg "Backup complete!"
-  fi
-}
-
-bb4u_mainsail(){
-  source_ini
-  if [ -d $MAINSAIL_DIR ] && [ "$backup_before_update" = "true" ]; then
-    get_date
+  if [[ -d ${MAINSAIL_DIR} ]]; then
     status_msg "Creating Mainsail backup ..."
-    mkdir -p $BACKUP_DIR/mainsail-backups/"$current_date"
-    cp -r $MAINSAIL_DIR $_ && ok_msg "Backup complete!"
+    check_for_backup_dir
+    current_date=$(get_date)
+    status_msg "Timestamp: ${current_date}"
+    mkdir -p "${BACKUP_DIR}/mainsail-backups/${current_date}"
+    cp -r "${MAINSAIL_DIR}" "${_}"
+    print_confirm "Mainsail backup complete!"
+  else
+    print_error "Can't back up 'mainsail' directory! Not found!"
+  fi
+}
+
+function backup_fluidd() {
+  local current_date
+
+  if [[ -d ${FLUIDD_DIR} ]]; then
+    status_msg "Creating Fluidd backup ..."
+    check_for_backup_dir
+    current_date=$(get_date)
+    status_msg "Timestamp: ${current_date}"
+    mkdir -p "${BACKUP_DIR}/fluidd-backups/${current_date}"
+    cp -r "${FLUIDD_DIR}" "${_}"
+    print_confirm "Fluidd backup complete!"
+  else
+    print_error "Can't back up 'fluidd' directory! Not found!"
+  fi
+}
+
+function backup_moonraker() {
+  local current_date
+
+  if [[ -d ${MOONRAKER_DIR} && -d ${MOONRAKER_ENV} ]]; then
+    status_msg "Creating Moonraker backup ..."
+    check_for_backup_dir
+    current_date=$(get_date)
+    status_msg "Timestamp: ${current_date}"
+    mkdir -p "${BACKUP_DIR}/moonraker-backups/${current_date}"
+    cp -r "${MOONRAKER_DIR}" "${_}" && cp -r "${MOONRAKER_ENV}" "${_}"
+    print_confirm "Moonraker backup complete!"
+  else
+    print_error "Can't back up moonraker and/or moonraker-env directory! Not found!"
+  fi
+}
+
+function backup_octoprint() {
+  local current_date
+
+  if [[ -d ${OCTOPRINT_DIR} && -d ${OCTOPRINT_CFG_DIR} ]]; then
+    status_msg "Creating OctoPrint backup ..."
+    check_for_backup_dir
+    current_date=$(get_date)
+    status_msg "Timestamp: ${current_date}"
+    mkdir -p "${BACKUP_DIR}/octoprint-backups/${current_date}"
+    cp -r "${OCTOPRINT_DIR}" "${_}" && cp -r "${OCTOPRINT_CFG_DIR}" "${_}"
+    print_confirm " OctoPrint backup complete!"
+  else
+    print_error "Can't back up OctoPrint and/or .octoprint directory!\n Not found!"
+  fi
+}
+
+function backup_klipperscreen() {
+  local current_date
+  if [[ -d ${KLIPPERSCREEN_DIR} ]] ; then
+    status_msg "Creating KlipperScreen backup ..."
+    check_for_backup_dir
+    current_date=$(get_date)
+    status_msg "Timestamp: ${current_date}"
+    mkdir -p "${BACKUP_DIR}/klipperscreen-backups/${current_date}"
+    cp -r "${KLIPPERSCREEN_DIR}" "${_}"
+    print_confirm "KlipperScreen backup complete!"
+  else
+    print_error "Can't back up KlipperScreen directory!\n Not found!"
+  fi
+}
+
+function backup_telegram_bot() {
+  local current_date
+
+  if [[ -d ${TELEGRAM_BOT_DIR} ]] ; then
+    status_msg "Creating MoonrakerTelegramBot backup ..."
+    check_for_backup_dir
+    current_date=$(get_date)
+    status_msg "Timestamp: ${current_date}"
+    mkdir -p "${BACKUP_DIR}/MoonrakerTelegramBot-backups/${current_date}"
+    cp -r "${TELEGRAM_BOT_DIR}" "${_}"
+    print_confirm "MoonrakerTelegramBot backup complete!"
+  else
+    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

@@ -0,0 +1,494 @@
+#!/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
+
+function init_flash_process() {
+  ### step 1: check for required userhgroups (tty & dialout)
+  check_usergroups
+
+  top_border
+  echo -e "|        ~~~~~~~~~~~~ [ Flash MCU ] ~~~~~~~~~~~~        |"
+  hr
+  echo -e "| Please select the flashing method to flash your MCU.  |"
+  echo -e "| Make sure to only select a method your MCU supports.  |"
+  echo -e "| Not all MCUs support both methods!                    |"
+  hr
+  blank_line
+  echo -e "| 1) Regular flashing method                            |"
+  echo -e "| 2) Updating via SD-Card Update                        |"
+  blank_line
+  back_help_footer
+
+  local choice method
+  while true; do
+    read -p "${cyan}###### Please select:${white} " choice
+    case "${choice}" in
+      1)
+        select_msg "Regular flashing method"
+        method="regular"
+        break;;
+      2)
+        select_msg "SD-Card Update"
+        method="sdcard"
+        break;;
+      B|b)
+        advanced_menu
+        break;;
+      H|h)
+        clear && print_header
+        show_flash_method_help
+        break;;
+      *)
+        error_msg "Invalid command!";;
+    esac
+  done
+
+  ### 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 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} |"
+  hr
+  blank_line
+  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
+
+  local choice
+  while true; do
+    read -p "${cyan}###### Connection method:${white} " choice
+    case "${choice}" in
+      1)
+        status_msg "Identifying MCU connected via USB ...\n"
+        get_usb_id || true # continue even after exit code 1
+        break;;
+      2)
+        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;;
+      H|h)
+        clear && print_header
+        show_mcu_connection_help
+        break;;
+      *)
+        error_msg "Invalid command!";;
+    esac
+  done
+}
+
+function print_detected_mcu_to_screen() {
+  local i=1
+
+  if (( ${#mcu_list[@]} < 1 )); then
+    print_error "No MCU found!\n MCU either not connected or not detected!"
+    return
+  fi
+
+  for mcu in "${mcu_list[@]}"; do
+    echo -e " ● MCU #${i}: ${cyan}${mcu}${white}"
+    i=$(( i + 1 ))
+  done
+  echo
+}
+
+#================================================#
+#=================== 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 either not connected or not detected!"
+    return
+  fi
+
+  top_border
+  echo -e "|                   ${red}!!! ATTENTION !!!${white}                   |"
+  hr
+  echo -e "| Make sure, to select the correct MCU!                 |"
+  echo -e "| ${red}ONLY flash a firmware created for the respective MCU!${white} |"
+  bottom_border
+  echo -e "${cyan}###### List of available MCU:${white}"
+
+  ### list all mcus
+  for mcu in "${mcu_list[@]}"; do
+    i=$(( i + 1 ))
+    mcu=$(echo "${mcu}" | rev | cut -d"/" -f1 | rev)
+    echo -e " ● MCU #${i}: ${cyan}${mcu}${white}"
+  done
+
+  ### verify user input
+  local regex="^[1-9]+$"
+  while [[ ! ${sel_index} =~ ${regex} ]] || [[ ${sel_index} -gt ${i} ]]; do
+    echo
+    read -p "${cyan}###### Select MCU to flash:${white} " sel_index
+
+    if [[ ! ${sel_index} =~ ${regex} ]]; then
+      error_msg "Invalid input!"
+    elif [[ ${sel_index} -lt 1 ]] || [[ ${sel_index} -gt ${i} ]]; then
+      error_msg "Please select a number between 1 and ${i}!"
+    fi
+
+    local mcu_index=$(( sel_index - 1 ))
+    local selected_mcu_id="${mcu_list[${mcu_index}]}"
+  done
+
+  ### confirm selection
+  local yn
+  while true; do
+    echo -e "\n###### You selected:\n ● MCU #${sel_index}: ${selected_mcu_id}\n"
+    read -p "${cyan}###### Continue? (Y/n):${white} " yn
+    case "${yn}" in
+      Y|y|Yes|yes|"")
+        select_msg "Yes"
+        status_msg "Flashing ${selected_mcu_id} ..."
+        if [[ ${method} == "regular" ]]; then
+          log_info "Flashing device '${selected_mcu_id}' with method '${method}'"
+          start_flash_mcu "${selected_mcu_id}"
+        elif [[ ${method} == "sdcard" ]]; then
+          log_info "Flashing device '${selected_mcu_id}' with method '${method}'"
+          start_flash_sd "${selected_mcu_id}"
+        else
+          print_error "No flash method set! Aborting..."
+          log_error "No flash method set!"
+          return
+        fi
+        break;;
+      N|n|No|no)
+        select_msg "No"
+        break;;
+      *)
+        error_msg "Invalid command!";;
+    esac
+  done
+}
+
+function start_flash_mcu() {
+  local device=${1}
+  do_action_service "stop" "klipper"
+
+  if make ${flash_command} FLASH_DEVICE="${device}"; then
+    ok_msg "Flashing successfull!"
+  else
+    warn_msg "Flashing failed!"
+    warn_msg "Please read the console output above!"
+  fi
+
+  do_action_service "start" "klipper"
+}
+
+function start_flash_sd() {
+  local i=0 board_list=() device=${1}
+  local flash_script="${KLIPPER_DIR}/scripts/flash-sdcard.sh"
+
+  ### write each supported board to the array to make it selectable
+  for board in $("${flash_script}" -l | tail -n +2); do
+    board_list+=("${board}")
+  done
+
+  top_border
+  echo -e "|  Please select the type of board that corresponds to  |"
+  echo -e "|  the currently selected MCU ID you chose before.      |"
+  blank_line
+  echo -e "|  The following boards are currently supported:        |"
+  hr
+  ### display all supported boards to the user
+  for board in "${board_list[@]}"; do
+    if [[ ${i} -lt 10 ]]; then
+      printf "|  ${i}) %-50s|\n" "${board_list[${i}]}"
+    else
+      printf "|  ${i}) %-49s|\n" "${board_list[${i}]}"
+    fi
+    i=$(( i + 1 ))
+  done
+  quit_footer
+
+  ### make the user select one of the boards
+  local choice
+  while true; do
+    read -p "${cyan}###### Please select board type:${white} " choice
+    if [[ ${choice} = "q" || ${choice} = "Q" ]]; then
+      clear && advanced_menu && break
+    elif [[ ${choice} -le ${#board_list[@]} ]]; then
+      local selected_board="${board_list[${choice}]}"
+      break
+    else
+      clear && print_header
+      error_msg "Invalid choice!"
+      flash_mcu_sd
+    fi
+  done
+
+  while true; do
+    echo
+    top_border
+    echo -e "| If your board is flashed with firmware that connects  |"
+    echo -e "| at a custom baud rate, please change it now.          |"
+    blank_line
+    echo -e "| If you are unsure, stick to the default 250000!       |"
+    bottom_border
+
+    local baud_rate regex="^[0-9]+$"
+    echo -e "${cyan}###### Please set the baud rate:${white} "
+    while [[ ! ${baud_rate} =~ ${regex} ]]; do
+      read -e -i "250000" -e baud_rate
+      local selected_baud_rate=${baud_rate}
+      break
+    done
+    break
+  done
+
+  ###flash process
+  do_action_service "stop" "klipper"
+  if "${flash_script}" -b "${selected_baud_rate}" "${device}" "${selected_board}"; then
+    print_confirm "Flashing successfull!"
+    log_info "Flash successfull!"
+  else
+    print_error "Flashing failed!\n Please read the console output above!"
+    log_error "Flash failed!"
+  fi
+  do_action_service "start" "klipper"
+}
+
+function build_fw() {
+  local python_version
+
+  if [[ ! -d ${KLIPPER_DIR} || ! -d ${KLIPPY_ENV} ]]; then
+    print_error "Klipper not found!\n Cannot build firmware without Klipper!"
+    return
+  fi
+
+  python_version=$(get_klipper_python_ver)
+
+  cd "${KLIPPER_DIR}"
+  status_msg "Initializing firmware build ..."
+  local dep=(build-essential dpkg-dev make)
+  dependency_check "${dep[@]}"
+
+  make clean
+
+  status_msg "Building firmware ..."
+  if (( python_version == 3 )); then
+    make PYTHON=python3 menuconfig
+    make PYTHON=python3
+  elif (( python_version == 2 )); then
+    make PYTHON=python2 menuconfig
+    make PYTHON=python2
+  else
+    warn_msg "Error reading Python version!"
+    return 1
+  fi
+
+  ok_msg "Firmware built!"
+}
+
+#================================================#
+#=================== HELPERS ====================#
+#================================================#
+
+function get_usb_id() {
+  unset mcu_list
+  sleep 1
+  mcus=$(find /dev/serial/by-id/* 2>/dev/null)
+
+  for mcu in ${mcus}; do
+    mcu_list+=("${mcu}")
+  done
+}
+
+function get_uart_id() {
+  unset mcu_list
+  sleep 1
+  mcus=$(find /dev -maxdepth 1 -regextype posix-extended -regex "^\/dev\/tty(AMA0|S0)$" 2>/dev/null)
+
+  for mcu in ${mcus}; do
+    mcu_list+=("${mcu}")
+  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 < ? > ~~~~~~~~     |"
+  hr
+  echo -e "| ${cyan}Regular flashing method:${white}                              |"
+  echo -e "| The default method to flash controller boards which   |"
+  echo -e "| are connected and updated over USB and not by placing |"
+  echo -e "| a compiled firmware file onto an internal SD-Card.    |"
+  blank_line
+  echo -e "| Common controllers that get flashed that way are:     |"
+  echo -e "| - Arduino Mega 2560                                   |"
+  echo -e "| - Fysetc F6 / S6 (used without a Display + SD-Slot)   |"
+  blank_line
+  echo -e "| ${cyan}Updating via SD-Card Update:${white}                          |"
+  echo -e "| Many popular controller boards ship with a bootloader |"
+  echo -e "| capable of updating the firmware via SD-Card.         |"
+  echo -e "| Choose this method if your controller board supports  |"
+  echo -e "| this way of updating. This method ONLY works for up-  |"
+  echo -e "| grading firmware. The initial flashing procedure must |"
+  echo -e "| be done manually per the instructions that apply to   |"
+  echo -e "| your controller board.                                |"
+  blank_line
+  echo -e "| Common controllers that can be flashed that way are:  |"
+  echo -e "| - BigTreeTech SKR 1.3 / 1.4 (Turbo) / E3 / Mini E3    |"
+  echo -e "| - Fysetc F6 / S6 (used with a Display + SD-Slot)      |"
+  echo -e "| - Fysetc Spider                                       |"
+  blank_line
+  back_footer
+
+  local choice
+  while true; do
+    read -p "${cyan}###### Please select:${white} " choice
+    case "${choice}" in
+      B|b)
+        clear && print_header
+        init_flash_process
+        break;;
+      *)
+        error_msg "Invalid command!";;
+    esac
+  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 < ? > ~~~~~~~~     |"
+  hr
+  echo -e "| ${cyan}USB:${white}                                                  |"
+  echo -e "| Selecting USB as the connection method will scan the  |"
+  echo -e "| USB ports for connected controller boards. This will  |"
+  echo -e "| be similar to the 'ls /dev/serial/by-id/*' command    |"
+  echo -e "| suggested by the official Klipper documentation for   |"
+  echo -e "| determining successfull USB connections!              |"
+  blank_line
+  echo -e "| ${cyan}UART:${white}                                                 |"
+  echo -e "| Selecting UART as the connection method will list all |"
+  echo -e "| possible UART serial ports. Note: This method ALWAYS  |"
+  echo -e "| returns something as it seems impossible to determine |"
+  echo -e "| if a valid Klipper controller board is connected or   |"
+  echo -e "| not. Because of that, you ${red}MUST${white} know which UART serial |"
+  echo -e "| port your controller board is connected to when using |"
+  echo -e "| this connection method.                               |"
+  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_mcu_connection
+        break;;
+      *)
+        error_msg "Invalid command!";;
+    esac
+  done
+}

scripts/fluidd.sh

@@ -0,0 +1,510 @@
+#!/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 FLUIDD =================#
+#===================================================#
+
+function install_fluidd() {
+  if [[ -z $(moonraker_systemd) ]]; then
+    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 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_config_dir
+
+  ### check for other enabled web interfaces
+  unset SET_LISTEN_PORT
+  detect_enabled_sites
+
+  ### check if another site already listens to port 80
+  fluidd_port_check
+
+  ### download fluidd
+  download_fluidd
+
+  ### ask user to install the recommended webinterface macros
+  install_fluidd_macros
+
+  ### create /etc/nginx/conf.d/upstreams.conf
+  set_upstream_nginx_cfg
+  ### create /etc/nginx/sites-available/<interface config>
+  set_nginx_cfg "fluidd"
+  ### nginx on ubuntu 21 and above needs special permissions to access the files
+  set_nginx_permissions
+
+  ### symlink nginx log
+  symlink_webui_nginx_log "fluidd"
+
+  ### add fluidd to the update manager in moonraker.conf
+  patch_fluidd_update_manager
+
+  fetch_webui_ports #WIP
+
+  ### confirm message
+  print_confirm "Fluidd has been set up!"
+}
+
+function install_fluidd_macros() {
+  local yn
+  while true; do
+    echo
+    top_border
+    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://github.com/fluidd-core/fluidd-config           |"
+    blank_line
+    echo -e "| If you already use these macros skip this step.       |"
+    echo -e "| Otherwise you should consider to answer with 'yes' to |"
+    echo -e "| download the recommended macros.                      |"
+    bottom_border
+    read -p "${cyan}###### Download the recommended macros? (Y/n):${white} " yn
+    case "${yn}" in
+      Y|y|Yes|yes|"")
+        select_msg "Yes"
+        download_fluidd_macros
+        break;;
+      N|n|No|no)
+        select_msg "No"
+        break;;
+      *)
+        print_error "Invalid command!";;
+    esac
+  done
+  return
+}
+
+function download_fluidd_macros() {
+  local ms_cfg_repo path configs regex line gcode_dir
+
+  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)
+
+  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() {
+  local url
+  url=$(get_fluidd_download_url)
+
+  status_msg "Downloading Fluidd from ${url} ..."
+
+  if [[ -d ${FLUIDD_DIR} ]]; then
+    rm -rf "${FLUIDD_DIR}"
+  fi
+
+  mkdir "${FLUIDD_DIR}" && cd "${FLUIDD_DIR}"
+
+  if wget "${url}"; then
+    ok_msg "Download complete!"
+    status_msg "Extracting archive ..."
+    unzip -q -o ./*.zip && ok_msg "Done!"
+    status_msg "Remove downloaded archive ..."
+    rm -rf ./*.zip && ok_msg "Done!"
+  else
+    print_error "Downloading Fluidd from\n ${url}\n failed!"
+    exit 1
+  fi
+}
+
+#===================================================#
+#================== REMOVE FLUIDD ==================#
+#===================================================#
+
+function remove_fluidd_dir() {
+  [[ ! -d ${FLUIDD_DIR} ]] && return
+
+  status_msg "Removing Fluidd directory ..."
+  rm -rf "${FLUIDD_DIR}" && ok_msg "Directory removed!"
+}
+
+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!"
+  fi
+  if [[ -L "/etc/nginx/sites-enabled/fluidd" ]]; then
+    status_msg "Removing Fluidd Symlink for Nginx ..."
+    sudo rm "/etc/nginx/sites-enabled/fluidd" && ok_msg "File removed!"
+  fi
+}
+
+function remove_fluidd_logs() {
+  local files
+  files=$(find /var/log/nginx -name "fluidd*" 2> /dev/null | sort)
+
+  if [[ -n ${files} ]]; then
+    for file in ${files}; do
+      status_msg "Removing ${file} ..."
+      sudo rm -f "${file}"
+      ok_msg "${file} removed!"
+    done
+  fi
+}
+
+function remove_fluidd_log_symlinks() {
+  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
+      status_msg "Removing ${file} ..."
+      rm -f "${file}"
+      ok_msg "${file} removed!"
+    done
+  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_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}"
+
+  print_confirm "Fluidd successfully removed!"
+}
+
+#===================================================#
+#================== UPDATE FLUIDD ==================#
+#===================================================#
+
+function update_fluidd() {
+  backup_before_update "fluidd"
+  status_msg "Updating Fluidd ..."
+  download_fluidd
+  match_nginx_configs
+  symlink_webui_nginx_log "fluidd"
+  print_confirm "Fluidd successfully updated!"
+}
+
+#===================================================#
+#================== FLUIDD STATUS ==================#
+#===================================================#
+
+function get_fluidd_status() {
+  local status
+  local data_arr=("${FLUIDD_DIR}" "${NGINX_SA}/fluidd" "${NGINX_SE}/fluidd")
+
+  ### 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_fluidd_version() {
+  local versionfile="${FLUIDD_DIR}/.version"
+  local relinfofile="${FLUIDD_DIR}/release_info.json"
+  local 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 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() {
+  local versions local_ver remote_ver
+  local_ver="$(get_local_fluidd_version)"
+  remote_ver="$(get_remote_fluidd_version)"
+
+  if [[ ${local_ver} != "${remote_ver}" && ${local_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 "fluidd"
+  else
+    versions="${green}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+  fi
+
+  echo "${versions}"
+}
+
+#================================================#
+#=================== HELPERS ====================#
+#================================================#
+
+function get_fluidd_download_url() {
+  local releases_by_tag tags tag unstable_url url
+
+  ### 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
+    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() {
+  if [[ ${FLUIDD_ENABLED} == "false" ]]; then
+
+    if [[ ${SITE_ENABLED} == "true" ]]; then
+      status_msg "Detected other enabled interfaces:"
+
+      [[ ${MAINSAIL_ENABLED} == "true" ]] && \
+      echo "   ${cyan}● Mainsail - Port: ${MAINSAIL_PORT}${white}"
+
+      if [[ ${MAINSAIL_PORT} == "80" ]]; then
+        PORT_80_BLOCKED="true"
+        select_fluidd_port
+      fi
+    else
+      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"
+
+  else
+    SET_NGINX_CFG="false"
+  fi
+}
+
+function select_fluidd_port() {
+  if [[ ${PORT_80_BLOCKED} == "true" ]]; then
+    echo
+    top_border
+    echo -e "|                    ${red}!!!WARNING!!!${white}                      |"
+    echo -e "| ${red}You need to choose a different port for Fluidd!${white}       |"
+    echo -e "| ${red}The following web interface is listening at port 80:${white}  |"
+    blank_line
+    [[ ${MAINSAIL_PORT} == "80" ]] && echo "|  ● Mainsail                                           |"
+    blank_line
+    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  |"
+    echo -e "| input. So make sure to choose a valid port!           |"
+    bottom_border
+
+    local new_port re="^[0-9]+$"
+    while true; do
+      read -p "${cyan}Please enter a new Port:${white} " new_port
+      if [[ ${new_port} =~ ${re} && ${new_port} != "${MAINSAIL_PORT}" ]]; then
+        select_msg "Setting port ${new_port} for Fluidd!"
+        SET_LISTEN_PORT=${new_port}
+        break
+      else
+        if [[ ! ${new_port} =~ ${re}  ]]; then
+          error_msg "Invalid input!"
+        else
+          error_msg "Port already taken! Select a different one!"
+        fi
+      fi
+    done
+  fi
+}
+
+function patch_fluidd_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\]\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 to update manager in file:\n       ${conf}"
+      /bin/sh -c "cat >> ${conf}" << MOONRAKER_CONF
+
+[update_manager fluidd]
+type: web
+channel: stable
+repo: fluidd-core/fluidd
+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/functions.sh

@@ -1,185 +0,0 @@
-# setting up some frequently used functions
-check_euid(){
-  if [ "$EUID" -eq 0 ]
-  then
-    echo -e "${red}"
-    echo -e "/=================================================\ "
-    echo -e "|    !!! THIS SCRIPT MUST NOT RAN AS ROOT !!!     |"
-    echo -e "\=================================================/ "
-    echo -e "${default}"
-    exit 1
-  fi
-}
-
-source_ini(){
-  source ${HOME}/kiauh2/kiauh.ini
-}
-
-start_klipper(){
-  if [ -e /etc/init.d/klipper ]; then
-    status_msg "Starting klipper service ..."
-    sudo /etc/init.d/klipper start && sleep 2 && ok_msg "Klipper service started!"
-  fi
-}
-stop_klipper(){
-  if [ -e /etc/init.d/klipper ]; then
-    status_msg "Stopping klipper service ..."
-    sudo /etc/init.d/klipper stop && sleep 2 && ok_msg "Klipper service stopped!"
-  fi
-}
-
-start_moonraker(){
-  if [ -e /etc/init.d/moonraker ]; then
-    status_msg "Starting moonraker service ..."
-    sudo /etc/init.d/moonraker start && sleep 2 && ok_msg "Moonraker service started!"
-  fi
-}
-
-stop_moonraker(){
-  if [ -e /etc/init.d/moonraker ]; then
-    status_msg "Stopping moonraker service ..."
-    sudo /etc/init.d/moonraker stop && sleep 2 && ok_msg "Moonraker service stopped!"
-  fi
-}
-
-dep_check(){
-  for package in "${dep[@]}"
-  do
-    ! command -v $package >&/dev/null 2>&1 && install+=($package)
-  done
-  if ! [ ${#install[@]} -eq 0 ]; then
-  warn_msg "The following packages are missing but necessary:"
-  echo ${install[@]}
-  while true; do
-    read -p "Do you want to install them now? (Y/n): " yn
-    case "$yn" in
-      Y|y|Yes|yes|"")
-      status_msg "Installing dependencies ..."
-      sudo apt-get install ${install[@]} -y && ok_msg "Dependencies installed!"
-      break;;
-      N|n|No|no) break;;
-         *) echo "Unknown parameter: $yn"; echo;;
-    esac
-  done
-  fi
-}
-
-print_error(){
-  for data in "${data_arr[@]}"
-  do
-    if [ ! -e $data ]; then
-      data_count+=(0)
-    else
-      data_count+=(1)
-    fi
-  done
-  sum=$(IFS=+; echo "$((${data_count[*]}))")
-  if [ $sum -eq 0 ]; then
-    ERROR_MSG=" Looks like $1 was already removed!\n Skipping..."
-  else
-    ERROR_MSG=""
-  fi
-}
-
-pkg_check(){
-  status_msg "Checking if nginx is installed"
-  if [[ $(dpkg-query -f'${Status}' --show nginx 2>/dev/null) = *\ installed ]]; then
-echo "nginx found!"
-else
-echo "nginx was not found, installing..." 2>&1
-sudo apt-get -y install nginx 2>/dev/null
-fi
-}
-
-build_fw(){
-    if [ -d $KLIPPER_DIR ]; then
-      cd $KLIPPER_DIR && make menuconfig
-      status_msg "Building firmware ..."
-      make clean && make && ok_msg "Firmware built!"
-    else
-      warn_msg "Can not build firmware without a Klipper directory!"
-    fi
-}
-
-### grab the printers id
-get_usb_id(){
-  warn_msg "Make sure your printer is the only USB device connected!"
-  while true; do
-    echo -e "${cyan}"
-    read -p "###### Press any key to continue ... " yn
-    echo -e "${default}"
-    case "$yn" in
-      *) break;;
-    esac
-  done
-  status_msg "Identifying the correct USB port ..."
-  USB_ID=$(ls /dev/serial/by-id/*)
-  if [ -e /dev/serial/by-id/* ]; then
-    status_msg "The ID of your printer is:"
-    title_msg "$USB_ID"
-  else
-    warn_msg "Could not retrieve ID!"
-    return 1
-  fi
-}
-
-write_printer_id(){
-  while true; do
-    echo -e "${cyan}"
-    read -p "###### Do you want to write the ID to your printer.cfg? (Y/n): " yn
-    echo -e "${default}"
-    case "$yn" in
-      Y|y|Yes|yes|"")
-        backup_printer_cfg
-cat <<PRINTERID >> $PRINTER_CFG
-
-##########################
-### CREATED WITH KIAUH ###
-##########################
-[mcu]
-serial: $USB_ID
-##########################
-##########################
-PRINTERID
-        ok_msg "Config written!"
-        break;;
-      N|n|No|no) break;;
-    esac
-  done
-}
-
-flash_routine(){
-  echo -e "/=================================================\ "
-  echo -e "|                   ATTENTION!                    |"
-  echo -e "| Flashing a Smoothie based board for the first   |"
-  echo -e "| time with this script will certainly fail.      |"
-  echo -e "| This applies to boards like the BTT SKR V1.3 or |"
-  echo -e "| the newer SKR V1.4 (Turbo). You have to copy    |"
-  echo -e "| the firmware file to the microSD card manually  |"
-  echo -e "| and rename it to 'firmware.bin'.                |"
-  echo -e "|                                                 |"
-  echo -e "| You find the file in: ~/klipper/out/klipper.bin |"
-  echo -e "\=================================================/ "
-  echo
-  while true; do
-    echo -e "${cyan}"
-    read -p "###### Do you want to continue? (Y/n): " yn
-    echo -e "${default}"
-    case "$yn" in
-      Y|y|Yes|yes|"")
-      get_usb_id && flash_mcu && write_printer_id; break;;
-      N|n|No|no) break;;
-    esac
-  done
-}
-
-flash_mcu(){
-  stop_klipper
-  if ! make flash FLASH_DEVICE="$USB_ID" ; then
-    warn_msg "Flashing failed!"
-    warn_msg "Please read the log above!"
-  else
-    ok_msg "Flashing successfull!"
-  fi
-  start_klipper
-}

scripts/gcode_shell_command.sh

@@ -0,0 +1,123 @@
+#!/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 GCODE_SHELL_COMMAND.PY =========#
+#=================================================#
+
+function setup_gcode_shell_command() {
+  top_border
+  echo -e "| You are about to install the 'G-Code Shell Command'   |"
+  echo -e "| extension. Please make sure to read the instructions  |"
+  echo -e "| before you continue and remember that potential risks |"
+  echo -e "| can be involved after installing this extension!      |"
+  blank_line
+  echo -e "| ${red}You accept that you are doing this on your own risk!${white}  |"
+  bottom_border
+
+  local yn
+  while true; do
+    read -p "${cyan}###### Do you want to continue? (Y/n):${white} " yn
+    case "${yn}" in
+      Y|y|Yes|yes|"")
+        select_msg "Yes"
+
+        if [[ ! -d "${KLIPPER_DIR}/klippy/extras" ]]; then
+          print_error "Folder ~/klipper/klippy/extras not found!\n      Klipper not installed yet?"
+          return
+        fi
+
+        status_msg "Installing gcode shell command extension ..."
+
+        if [[ ! -f "${KLIPPER_DIR}/klippy/extras/gcode_shell_command.py" ]]; then
+          install_gcode_shell_command
+        else
+          echo; warn_msg "File 'gcode_shell_command.py' already exists in the destination location!"
+
+          while true; do
+            read -p "${cyan}###### Do you want to overwrite it? (Y/n):${white} " yn
+            case "${yn}" in
+              Y|y|Yes|yes|"")
+                select_msg "Yes"
+                rm -f "${KLIPPER_DIR}/klippy/extras/gcode_shell_command.py"
+                install_gcode_shell_command
+                break;;
+              N|n|No|no)
+                select_msg "No"
+                break;;
+              *)
+                error_msg "Invalid Input!";;
+            esac
+          done
+        fi
+        return;;
+      N|n|No|no)
+        select_msg "No"
+        return;;
+      *)
+        error_msg "Invalid Input!";;
+    esac
+  done
+}
+
+function install_gcode_shell_command() {
+  do_action_service "stop" "klipper"
+  status_msg "Copy 'gcode_shell_command.py' to '${KLIPPER_DIR}/klippy/extras' ..."
+
+  if cp "${KIAUH_SRCDIR}/resources/gcode_shell_command.py" "${KLIPPER_DIR}/klippy/extras"; then
+    ok_msg "Done!"
+  else
+    error_msg "Cannot copy file to target destination...Exiting!"
+    return 1
+  fi
+
+  local yn
+  while true; do
+    echo
+    read -p "${cyan}###### Create an example shell command? (Y/n):${white} " yn
+    case "${yn}" in
+      Y|y|Yes|yes|"")
+        select_msg "Yes"
+        create_example_shell_command
+        break;;
+      N|n|No|no)
+        select_msg "No"
+        break;;
+    esac
+  done
+
+  do_action_service "restart" "klipper"
+  print_confirm "Shell command extension installed!"
+  return
+}
+
+function create_example_shell_command() {
+  ### create a backup of the config folder
+  backup_config_dir
+
+  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 ${configs}; do
+    path=$(echo "${cfg}" | rev | cut -d"/" -f2- | rev)
+
+    if [[ ! -f "${path}/shell_command.cfg" ]]; then
+      status_msg "Copy shell_command.cfg to ${path} ..."
+      cp "${KIAUH_SRCDIR}/resources/shell_command.cfg" "${path}"
+      ok_msg "${path}/shell_command.cfg created!"
+      ### write include to the very first line of the printer.cfg
+      sed -i "1 i [include shell_command.cfg]" "${cfg}"
+    fi
+  done
+}

scripts/globals.sh

@@ -0,0 +1,95 @@
+#!/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 #
+#=======================================================================#
+
+# shellcheck disable=SC2034
+set -e
+
+function set_globals() {
+  #=================== SYSTEM ===================#
+  SYSTEMD="/etc/systemd/system"
+  INITD="/etc/init.d"
+  ETCDEF="/etc/default"
+
+  #=================== KIAUH ====================#
+  green=$(echo -en "\e[92m")
+  yellow=$(echo -en "\e[93m")
+  magenta=$(echo -en "\e[35m")
+  red=$(echo -en "\e[91m")
+  cyan=$(echo -en "\e[96m")
+  white=$(echo -en "\e[39m")
+  INI_FILE="${HOME}/.kiauh.ini"
+  LOGFILE="/tmp/kiauh.log"
+  RESOURCES="${KIAUH_SRCDIR}/resources"
+  BACKUP_DIR="${HOME}/kiauh-backups"
+
+  #================== KLIPPER ===================#
+  KLIPPY_ENV="${HOME}/klippy-env"
+  KLIPPER_DIR="${HOME}/klipper"
+  KLIPPER_REPO="https://github.com/Klipper3d/klipper.git"
+
+  #================= MOONRAKER ==================#
+  MOONRAKER_ENV="${HOME}/moonraker-env"
+  MOONRAKER_DIR="${HOME}/moonraker"
+  MOONRAKER_REPO="https://github.com/Arksine/moonraker.git"
+
+  #================= MAINSAIL ===================#
+  MAINSAIL_DIR="${HOME}/mainsail"
+
+  #================== FLUIDD ====================#
+  FLUIDD_DIR="${HOME}/fluidd"
+
+  #=============== KLIPPERSCREEN ================#
+  KLIPPERSCREEN_ENV="${HOME}/.KlipperScreen-env"
+  KLIPPERSCREEN_DIR="${HOME}/KlipperScreen"
+  KLIPPERSCREEN_REPO="https://github.com/jordanruthe/KlipperScreen.git"
+
+  #========== MOONRAKER-TELEGRAM-BOT ============#
+  TELEGRAM_BOT_ENV="${HOME}/moonraker-telegram-bot-env"
+  TELEGRAM_BOT_DIR="${HOME}/moonraker-telegram-bot"
+  TELEGRAM_BOT_REPO="https://github.com/nlef/moonraker-telegram-bot.git"
+
+  #=============== PRETTY-GCODE =================#
+  PGC_DIR="${HOME}/pgcode"
+  PGC_REPO="https://github.com/Kragrathea/pgcode"
+
+  #================== NGINX =====================#
+  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/install_dwc2.sh

@@ -1,166 +0,0 @@
-#TODO:
-# - check for existing/running octoprint service
-# - ask for permission to disable octoprint service
-
-dwc2_install_routine(){
-  if [ -d $KLIPPER_DIR ]; then
-    # check for existing installation
-    if [ -d ${HOME}/klippy-env/lib/python2.7/site-packages/tornado ]; then
-      ERROR_MSG=" Looks like DWC2 is already installed!\n Skipping..."
-      return
-    fi
-    stop_klipper
-    install_tornado
-    install_dwc2fk && dwc2fk_cfg
-    install_dwc2
-    start_klipper
-  else
-    ERROR_MSG=" Please install Klipper first!\n Skipping..."
-  fi
-}
-
-install_tornado(){
-  #check for dependencies
-  dep=(virtualenv)
-  dep_check
-  #execute operation
-  status_msg "Installing Tornado 5.1.1 ..."
-  cd ${HOME}
-  PYTHONDIR="${HOME}/klippy-env"
-  virtualenv ${PYTHONDIR}
-  ${PYTHONDIR}/bin/pip install tornado==5.1.1 && ok_msg "Tornado 5.1.1 successfully installed!"
-}
-
-install_dwc2fk(){
-  cd ${HOME}
-  status_msg "Cloning dwc2-for-klipper repository ..."
-  git clone $DWC2FK_REPO && ok_msg "dwc2-for-klipper successfully cloned!"
-  #create a web_dwc2.py symlink if not already existing
-  if [ -d $KLIPPER_DIR/klippy/extras ] && [ ! -e $KLIPPER_DIR/klippy/extras/web_dwc2.py ]; then
-    status_msg "Creating web_dwc2.py symlink ..."
-    ln -s $DWC2FK_DIR/web_dwc2.py $KLIPPER_DIR/klippy/extras/web_dwc2.py && ok_msg "Symlink created!"
-  fi
-}
-
-dwc2fk_cfg(){
-  while true; do
-    echo -e "${cyan}"
-    read -p "###### Do you want to create the config now? (Y/n): " yn
-    echo -e "${default}"
-    case "$yn" in
-    Y|y|Yes|yes|"") create_dwc2fk_cfg; break;;
-    N|n|No|no) break;;
-    *) echo "Unknown parameter: $yn"; dwc2fk_cfg;;
-    esac
-  done
-}
-
-create_dwc2fk_cfg(){
-  echo -e "/=================================================\ "
-  echo -e "|  1) [Default configuration]                     | "
-  echo -e "|  2) [Custom configuration]                      | "
-  echo -e "|  3) [Skip]                                      | "
-  echo -e "\=================================================/ "
-  while true; do
-    read -p "Please select: " choice; echo
-    case "$choice" in
-    1) dwc2fk_default_cfg && ok_msg "Config written ..."; break;;
-    2) create_dwc2fk_custom_cfg && ok_msg "Config written ..."; break;;
-    3) echo "Skipping ..."; break;;
-    esac
-  done
-}
-
-dwc2fk_default_cfg(){
-  cat <<DWC2 >> $PRINTER_CFG
-
-##########################
-### CREATED WITH KIAUH ###
-##########################
-[virtual_sdcard]
-path: ~/sdcard
-
-[web_dwc2]
-printer_name: my_printer
-listen_adress: 0.0.0.0
-listen_port: 4750
-web_path: dwc2/web
-##########################
-##########################
-DWC2
-}
-
-create_dwc2fk_custom_cfg(){
-  echo -e "${cyan}"
-  read -e -p "Printer name: " -i "my_printer" PRINTER_NAME
-  read -e -p "Listen adress: " -i "0.0.0.0" LISTEN_ADRESS
-  read -e -p "Listen port: " -i "4750" LISTEN_PORT
-  read -e -p "Web path: " -i "dwc2/web" WEB_PATH
-  echo -e "${default}"
-  DWC2_CFG=$(cat <<DWC2
-
-##########################
-### CREATED WITH KIAUH ###
-##########################
-[virtual_sdcard]
-path: ~/sdcard
-
-[web_dwc2]
-printer_name: $PRINTER_NAME
-listen_adress: $LISTEN_ADRESS
-listen_port: $LISTEN_PORT
-web_path: $WEB_PATH
-##########################
-##########################
-DWC2
-)
-  echo "The following lines will be written:"
-  echo -e "$DWC2_CFG"
-  while true; do
-    echo -e "${cyan}"
-    read -p "###### Write now (Y) or start over (n)? (Y/n): " yn
-    echo -e "${default}"
-    case "$yn" in
-      Y|y|Yes|yes|"") echo -e "$DWC2_CFG" >> $PRINTER_CFG; break;;
-      N|n|No|no) create_dwc2fk_custom_cfg;;
-    esac
-  done
-}
-
-install_dwc2(){
-  #needed packages for webcam
-  while true; do
-    echo -e "${cyan}"
-    read -p "###### Do you want to use a webcam? (Y/n): " yn
-    echo -e "${default}"
-    case "$yn" in
-      Y|y|Yes|yes|"")
-      status_msg "Checking for dependencies ..."
-      webcam_dep_check && ok_msg "Dependencies installed!"
-      break;;
-      N|n|No|no) break;;
-         *) echo "Unknown parameter: $yn"; echo;;
-    esac
-  done
-  #the update_dwc2 function does the same as installing dwc2
-  update_dwc2 && ok_msg "DWC2 Web UI installed!"
-}
-
-webcam_dep_check(){
-  webcam_dep=(
-  build-essential
-  libjpeg8-dev
-  imagemagick
-  libv4l-dev
-  cmake
-  )
-  for pkg in "${webcam_dep[@]}"
-  do
-    if ! [[ $(dpkg-query -f'${Status}' --show $pkg 2>/dev/null) = *\ installed ]]; then
-      install+=($pkg)
-    fi
-  done
-  if ! [ ${#install[@]} -eq 0 ]; then
-    sudo apt-get install ${install[@]} -y
-  fi
-}

scripts/install_klipper.sh

@@ -1,30 +0,0 @@
-install_klipper(){
-  if [ -e /etc/init.d/klipper ] && [ -e /etc/default/klipper ]; then
-    ERROR_MSG=" Looks like klipper is already installed!\n Skipping ..."
-  else
-    #check for dependencies
-    dep=(git)
-    dep_check
-    #execute operation
-    cd ${HOME}
-    status_msg "Cloning klipper repository ..."
-    git clone $KLIPPER_REPO && ok_msg "Klipper successfully cloned!"
-    status_msg "Installing klipper service ..."
-    $KLIPPER_DIR/scripts/install-octopi.sh && sleep 2 && ok_msg "Klipper installation complete!"
-    #create a klippy.log symlink in home-dir just for convenience
-    if [ ! -e ${HOME}/klippy.log ]; then
-      status_msg "Creating klippy.log symlink ..."
-      ln -s /tmp/klippy.log ${HOME}/klippy.log && ok_msg "Symlink created!"
-    fi
-    while true; do
-      echo -e "${cyan}"
-      read -p "###### Do you want to flash your MCU now? (Y/n): " yn
-      echo -e "${default}"
-      case "$yn" in
-        Y|y|Yes|yes|"") build_fw && flash_routine; break;;
-        N|n|No|no) break;;
-      *) warn_msg "Unknown parameter: $yn"; echo;;
-    esac
-  done
-  fi
-}

scripts/install_mainsail.sh

@@ -1,349 +0,0 @@
-mainsail_install_routine(){
-  if [ -d $KLIPPER_DIR ]; then
-    #check for dependencies
-    dep=(wget curl unzip)
-    dep_check
-    #execute operation
-    install_moonraker
-    disable_wrong_webserver
-    remove_wrong_webserver
-    install_nginx
-    test_api
-    test_nginx
-    install_mainsail && ok_msg "Mainsail install complete!"; echo
-  else
-    ERROR_MSG=" Please install Klipper first!\n Skipping..."
-  fi
-}
-
-install_moonraker(){
-  cd $KLIPPER_DIR
-  if [[ $(git describe --all) = "remotes/Arksine/work-web_server-20200131" ]]; then
-    status_msg "Installing Moonraker ..."
-    $KLIPPER_DIR/scripts/install-moonraker.sh && ok_msg "Moonraker successfully installed!"
-    if [ ! -d ${HOME}/sdcard ]; then
-      mkdir ${HOME}/sdcard
-    fi
-    #create a moonraker.log symlink in home-dir just for convenience
-    if [ ! -e ${HOME}/moonraker.log ]; then
-      status_msg "Creating moonraker.log symlink ..."
-      ln -s /tmp/moonraker.log ${HOME}/moonraker.log && ok_msg "Symlink created!"
-    fi
-  else
-    warn_msg "You are not using Arksine/work-web_server-20200131."
-    warn_msg "Please switch to the moonraker fork first!"
-    while true; do
-      echo -e "${cyan}"
-      read -p "###### Do you want to switch to it now? (Y/n): " yn
-      echo -e "${default}"
-      case "$yn" in
-        Y|y|Yes|yes|"") switch_to_moonraker && install_moonraker; break;;
-        N|n|No|no) break;;
-           *) echo "Unknown parameter: $yn"; echo;;
-      esac
-    done
-  fi
-}
-
-check_printer_cfg(){
-  if [ ! -e $PRINTER_CFG ]; then
-    warn_msg "No printer.cfg found"
-    while true; do
-      echo -e "${cyan}"
-      read -p "###### Do you want to create a default config? (Y/n): " yn
-      echo -e "${default}"
-      case "$yn" in
-        Y|y|Yes|yes|"") create_default_cfg; break;;
-        N|n|No|no) break;;
-           *) echo "Unknown parameter: $yn"; echo;;
-      esac
-    done
-  else
-    check_vsdcard_section
-    check_api_section
-  fi
-}
-
-disable_wrong_webserver(){
-  if systemctl is-active haproxy ; then
-    status_msg "Stopping haproxy service ..."
-    sudo /etc/init.d/haproxy stop && ok_msg "Service stopped!"
-  fi
-  if systemctl is-active lighttpd ; then
-    status_msg "Stopping lighttpd service ..."
-    sudo /etc/init.d/lighttpd stop && ok_msg "Service stopped!"
-  fi
-}
-
-remove_wrong_webserver(){
-  rem=(haproxy lighttpd)
-  for remove in "${rem[@]}"
-  do
-    if [[ $(dpkg-query -f'${Status}' --show $remove 2>/dev/null) = *\ installed ]]; then
-      delete+=($remove)
-    fi
-  done
-  if ! [ ${#delete[@]} -eq 0 ]; then
-    sudo apt-get remove ${delete[@]} -y
-  fi
-}
-
-install_nginx(){
-  if ! [[ $(dpkg-query -f'${Status}' --show nginx 2>/dev/null) = *\ installed ]]; then
-    status_msg "Installing Nginx ..."
-    sudo apt-get install nginx -y && ok_msg "Nginx successfully installed!"
-  fi
-  if [ ! -d $MAINSAIL_DIR ]; then
-    mkdir $MAINSAIL_DIR
-  fi
-  status_msg "Configure Nginx ..."
-  create_mainsail_cfgfile && sudo mv $MAINSAIL_DIR/mainsail /etc/nginx/sites-available/
-  if [ -e /etc/nginx/sites-enabled/default ]; then
-    sudo rm /etc/nginx/sites-enabled/default
-  fi
-  if [ ! -e /etc/nginx/sites-enabled/mainsail ]; then
-    sudo ln -s /etc/nginx/sites-available/mainsail /etc/nginx/sites-enabled/
-  fi
-  ok_msg "Nginx configured!"
-}
-
-test_api(){
-  status_msg "Testing API ..."
-  sleep 5
-  status_msg "API response from http://localhost:7125/printer/info:"
-  API_RESPONSE="$(curl -sG4 http://localhost:7125/printer/info)"
-  echo -e "${cyan}$API_RESPONSE${default}"
-  if [ $(curl -sG4 "http://localhost:7125/printer/info" | grep '^{"result"' -c) -eq 1 ]; then
-    echo; ok_msg "Klipper API is working correctly!"; echo
-  else
-    echo; warn_msg "Klipper API not working correctly!"; echo
-  fi
-}
-
-test_nginx(){
-  sudo /etc/init.d/nginx restart
-  status_msg "Testing Nginx ..."
-  sleep 5
-  status_msg "API response from http://localhost/printer/info:"
-  API_RESPONSE="$(curl -sG4 http://localhost/printer/info)"
-  echo -e "${cyan}$API_RESPONSE${default}"
-  if [ $(curl -sG4 "http://localhost/printer/info" | grep '^{"result"' -c) -eq 1 ]; then
-    echo; ok_msg "Nginx is working correctly!"; echo
-  else
-    echo; warn_msg "Nginx is not working correctly!"; echo
-  fi
-}
-
-get_mainsail_ver(){
-  MAINSAIL_VERSION=`curl -s https://api.github.com/repositories/240875926/tags | grep name | cut -d'"' -f4 | cut -d"v" -f2 | head -1`
-}
-
-mainsail_dl_url(){
-  get_mainsail_ver
-  MAINSAIL_URL=https://github.com/meteyou/mainsail/releases/download/v"$MAINSAIL_VERSION"/mainsail-alpha-"$MAINSAIL_VERSION".zip
-}
-
-install_mainsail(){
-  mainsail_dl_url
-  if [ ! -d $MAINSAIL_DIR ]; then
-    mkdir $MAINSAIL_DIR
-  fi
-  cd $MAINSAIL_DIR
-  status_msg "Downloading Mainsail v$MAINSAIL_VERSION ..."
-  wget -q -O mainsail.zip $MAINSAIL_URL && status_msg "Extracting archive ..." && unzip -o mainsail.zip && rm mainsail.zip
-  ### write mainsail version to file for update check reasons
-  echo "$MAINSAIL_VERSION" > $MAINSAIL_DIR/version
-}
-
-create_mainsail_cfgfile(){
-  cat <<MAINSAIL_CFG > $MAINSAIL_DIR/mainsail
-map \$http_upgrade \$connection_upgrade {
-    default upgrade;
-    '' close;
-}
-
-upstream apiserver {
-    #edit your api port here
-    ip_hash;
-    server 127.0.0.1:7125;
-}
-
-server {
-    listen 80 default_server;
-    listen [::]:80 default_server;
-
-    access_log /var/log/nginx/mainsail-access.log;
-    error_log /var/log/nginx/mainsail-error.log;
-
-    #web_path from mainsail static files
-    root /home/pi/mainsail;
-
-    index index.html;
-    server_name _;
-
-    #max upload size for gcodes
-    client_max_body_size 200M;
-
-    location / {
-        try_files \$uri \$uri/ /index.html;
-    }
-
-    location /printer {
-        proxy_pass http://apiserver/printer;
-        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;
-    }
-
-    location /api {
-        proxy_pass http://apiserver/api;
-        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;
-    }
-
-    location /access {
-        proxy_pass http://apiserver/access;
-        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;
-    }
-
-    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 /machine {
-        proxy_pass http://apiserver/machine;
-        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;
-    }
-
-    location /server {
-        proxy_pass http://apiserver/server;
-        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;
-    }
-}
-MAINSAIL_CFG
-}
-
-check_vsdcard_section(){
-  # check if virtual sdcard is present in printer.cfg
-  if [ $(grep '^\[virtual_sdcard\]$' /home/pi/printer.cfg) ]; then
-    echo "Virtual sdcard already configured"
-  else
-    echo "No virtual sdcard entry found..."
-    echo "Configuring virtual sdcard..."
-# append the following lines to printer.cfg
-cat <<VSDCARD >> $PRINTER_CFG
-
-##########################
-### CREATED WITH KIAUH ###
-##########################
-[virtual_sdcard]
-path: ~/sdcard
-##########################
-##########################
-VSDCARD
-  fi
-}
-
-check_api_section(){
-  # check if api server is present in printer.cfg
-  if [ $(grep '^\[api_server\]$' /home/pi/printer.cfg) ]; then
-    echo "API server already configured"
-  else
-    echo "No API server entry found..."
-    echo "Configuring API server..."
-# append the following lines to printer.cfg
-cat <<API >> $PRINTER_CFG
-
-##########################
-### CREATED WITH KIAUH ###
-##########################
-[api_server]
-trusted_clients:
- 192.168.0.0/24
- 192.168.1.0/24
- 127.0.0.0/24
-##########################
-##########################
-API
-  fi
-}
-
-create_default_cfg(){
-cat <<MAINSAIL_CFG >> $PRINTER_CFG
-
-##########################
-### CREATED WITH KIAUH ###
-##########################
-[virtual_sdcard]
-path: ~/sdcard
-
-[api_server]
-trusted_clients:
- 192.168.0.0/24
- 192.168.1.0/24
- 127.0.0.0/24
-
-[pause_resume]
-
-[gcode_macro CANCEL]
-default_parameter_X: 230
-default_parameter_Y: 230
-default_parameter_Z: 10
-gcode:
-    M104 S0
-    M140 S0
-    M141 S0
-    M106 S0
-    CLEAR_PAUSE
-    RESET_SD
-
-[gcode_macro CANCEL_PRINT]
-gcode:
-    CANCEL
-
-[gcode_macro PAUSE]
-rename_existing: BASE_PAUSE
-default_parameter_X: 230
-default_parameter_Y: 230
-default_parameter_Z: 10
-gcode:
-    SAVE_GCODE_STATE NAME=PAUSE_state
-    BASE_PAUSE
-    G91
-    G1 E-1.7 F2100
-    G1 Z{Z}
-    G90
-    G1 X{X} Y{Y} F6000
-    G91
-
-[gcode_macro RESUME]
-rename_existing: BASE_RESUME
-gcode:
-    G91
-    G1 E1.7 F2100
-    G91
-    RESTORE_GCODE_STATE NAME=PAUSE_state MOVE=1
-    BASE_RESUME
-##########################
-##########################
-MAINSAIL_CFG
-}

scripts/klipper.sh

@@ -0,0 +1,664 @@
+#!/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
+
+#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 ================#
+#=================================================#
+
+###
+# this function detects all installed klipper
+# systemd instances and returns their absolute path
+function klipper_systemd() {
+  local services
+  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 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
+
+  status_msg "Initializing Klipper installation ...\n"
+
+  ### return early if klipper already exists
+  klipper_systemd_services=$(klipper_systemd)
+
+  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
+
+  ### 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
+
+  ### 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    |"
+  echo -e "| the amount of printers you can run from this host.    |"
+  blank_line
+  echo -e "| ${yellow}WARNING:${white}                                              |"
+  echo -e "| ${yellow}Setting up too many instances may crash your system.${white}  |"
+  back_footer
+}
+
+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 run_klipper_setup() {
+  read_kiauh_ini "${FUNCNAME[0]}"
+
+  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
+  dependency_check "${dep[@]}"
+
+  ### step 1: clone klipper
+  clone_klipper "${custom_repo}" "${custom_branch}"
+
+  ### step 2: install klipper dependencies and create python virtualenv
+  install_klipper_packages "${python_version}"
+  create_klipper_virtualenv "${python_version}"
+
+  ### step 3: create klipper instances
+  for instance in "${instance_names[@]}"; do
+    create_klipper_service "${instance}"
+  done
+
+  ### step 4: enable and start all instances
+  do_action_service "enable" "klipper"
+  do_action_service "start" "klipper"
+
+  ### step 5: check for dialout group membership
+  check_usergroups
+
+  ### confirm message
+  (( ${#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
+}
+
+function clone_klipper() {
+  local repo=${1} branch=${2}
+
+  [[ -z ${repo} ]] && repo="${KLIPPER_REPO}"
+  repo=$(echo "${repo}" | sed -r "s/^(http|https):\/\/github\.com\///i; s/\.git$//")
+  repo="https://github.com/${repo}"
+
+  [[ -z ${branch} ]] && branch="master"
+
+  ### force remove existing klipper dir and clone into fresh klipper dir
+  [[ -d ${KLIPPER_DIR} ]] && rm -rf "${KLIPPER_DIR}"
+
+  status_msg "Cloning Klipper from ${repo} ..."
+
+  cd "${HOME}" || exit 1
+  if git clone "${repo}" "${KLIPPER_DIR}"; then
+    cd "${KLIPPER_DIR}" && git checkout "${branch}"
+  else
+    print_error "Cloning Klipper from\n ${repo}\n failed!"
+    exit 1
+  fi
+}
+
+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"
+
+  if [[ ! -f ${service} ]]; then
+    status_msg "Create Klipper service file ..."
+
+    sudo cp "${service_template}" "${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=${1}
+  local gcodes_dir=${2}
+  local cfg_template
+
+  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
+    error_msg "Couldn't create minimal example printer.cfg!"
+  fi
+}
+
+#================================================#
+#================ REMOVE KLIPPER ================#
+#================================================#
+
+function remove_klipper_service() {
+  [[ -z $(klipper_systemd) ]] && return
+
+  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}"
+    sudo systemctl daemon-reload
+    sudo systemctl reset-failed
+  done
+
+  ok_msg "All Klipper services removed!"
+}
+
+function find_instance_files() {
+  local target_folder=${1}
+  local target_name=${2}
+  local files
+
+  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() {
+  [[ ! -d ${KLIPPER_DIR} ]] && return
+
+  status_msg "Removing Klipper directory ..."
+  rm -rf "${KLIPPER_DIR}"
+  ok_msg "Directory removed!"
+}
+
+function remove_klipper_env() {
+  [[ ! -d ${KLIPPY_ENV} ]] && return
+
+  status_msg "Removing klippy-env directory ..."
+  rm -rf "${KLIPPY_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_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
+
+  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 "${py_ver}"
+    ### install possible new python dependencies
+    "${KLIPPY_ENV}"/bin/pip install -r "${KLIPPER_DIR}/scripts/klippy-requirements.txt"
+  fi
+
+  ok_msg "Update complete!"
+  do_action_service "restart" "klipper"
+}
+
+#================================================#
+#================ KLIPPER STATUS ================#
+#================================================#
+
+function get_klipper_status() {
+  local sf_count status py_ver
+  sf_count="$(klipper_systemd | wc -w)"
+
+  py_ver=$(get_klipper_python_ver)
+
+  ### remove the "SERVICE" entry from the data array if a klipper service is installed
+  local data_arr=(SERVICE "${KLIPPER_DIR}" "${KLIPPY_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
+    if (( py_ver == 3 )); then
+      status="Installed: ${sf_count}(py${py_ver})"
+    else
+      status="Installed: ${sf_count}"
+    fi
+  elif (( filecount == 0 )); then
+    status="Not installed!"
+  else
+    status="Incomplete!"
+  fi
+
+  echo "${status}"
+}
+
+function get_local_klipper_commit() {
+  [[ ! -d ${KLIPPER_DIR} || ! -d "${KLIPPER_DIR}/.git" ]] && return
+
+  local commit
+  cd "${KLIPPER_DIR}"
+  commit="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
+  echo "${commit}"
+}
+
+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/${branch}" --always --tags | cut -d "-" -f 1,2)
+  echo "${commit}"
+}
+
+function compare_klipper_versions() {
+  local versions local_ver remote_ver
+  local_ver="$(get_local_klipper_commit)"
+  remote_ver="$(get_remote_klipper_commit)"
+
+  if [[ ${local_ver} != "${remote_ver}" ]]; then
+    versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+    # 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}"
+  fi
+
+  echo "${versions}"
+}
+
+#================================================#
+#=================== HELPERS ====================#
+#================================================#
+
+###
+# 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

@@ -0,0 +1,237 @@
+#!/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 KLIPPERSCREEN ==============#
+#===================================================#
+
+function klipperscreen_systemd() {
+  local services
+  services=$(find "${SYSTEMD}" -maxdepth 1 -regextype posix-extended -regex "${SYSTEMD}/KlipperScreen.service")
+  echo "${services}"
+}
+
+function install_klipperscreen() {
+  ### 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 KlipperScreen
+  klipperscreen_setup
+
+  ### add klipperscreen to the update manager in moonraker.conf
+  patch_klipperscreen_update_manager
+
+  do_action_service "restart" "KlipperScreen"
+}
+
+function klipperscreen_setup() {
+  local dep=(wget curl unzip dfu-util)
+  dependency_check "${dep[@]}"
+  status_msg "Cloning KlipperScreen from ${KLIPPERSCREEN_REPO} ..."
+
+  # force remove existing KlipperScreen dir
+  [[ -d ${KLIPPERSCREEN_DIR} ]] && rm -rf "${KLIPPERSCREEN_DIR}"
+
+  # clone into fresh KlipperScreen dir
+  cd "${HOME}" || exit 1
+  if ! git clone "${KLIPPERSCREEN_REPO}" "${KLIPPERSCREEN_DIR}"; then
+    print_error "Cloning KlipperScreen from\n ${KLIPPERSCREEN_REPO}\n failed!"
+    exit 1
+  fi
+
+  status_msg "Installing KlipperScreen ..."
+  if "${KLIPPERSCREEN_DIR}"/scripts/KlipperScreen-install.sh; then
+    ok_msg "KlipperScreen successfully installed!"
+  else
+    print_error "KlipperScreen installation failed!"
+    exit 1
+  fi
+}
+
+#===================================================#
+#=============== REMOVE KLIPPERSCREEN ==============#
+#===================================================#
+
+function remove_klipperscreen() {
+  ### remove KlipperScreen dir
+  if [[ -d ${KLIPPERSCREEN_DIR} ]]; then
+    status_msg "Removing KlipperScreen directory ..."
+    rm -rf "${KLIPPERSCREEN_DIR}" && ok_msg "Directory removed!"
+  fi
+
+  ### remove KlipperScreen VENV dir
+  if [[ -d ${KLIPPERSCREEN_ENV} ]]; then
+    status_msg "Removing KlipperScreen VENV directory ..."
+    rm -rf "${KLIPPERSCREEN_ENV}" && ok_msg "Directory removed!"
+  fi
+
+  ### remove KlipperScreen service
+  if [[ -e "${SYSTEMD}/KlipperScreen.service" ]]; then
+    status_msg "Removing KlipperScreen service ..."
+    do_action_service "stop" "KlipperScreen"
+    do_action_service "disable" "KlipperScreen"
+    sudo rm -f "${SYSTEMD}/KlipperScreen.service"
+
+    ###reloading units
+    sudo systemctl daemon-reload
+    sudo systemctl reset-failed
+    ok_msg "KlipperScreen Service removed!"
+  fi
+
+  ### remove KlipperScreen log
+  if [[ -e "/tmp/KlipperScreen.log" ]]; then
+    status_msg "Removing KlipperScreen log file ..."
+    rm -f "/tmp/KlipperScreen.log" && ok_msg "File removed!"
+  fi
+
+  ### remove KlipperScreen log symlink in config dir
+  if [[ -e "${KLIPPER_CONFIG}/KlipperScreen.log" ]]; then
+    status_msg "Removing KlipperScreen log symlink ..."
+    rm -f "${KLIPPER_CONFIG}/KlipperScreen.log" && ok_msg "File removed!"
+  fi
+
+  print_confirm "KlipperScreen successfully removed!"
+}
+
+#===================================================#
+#=============== UPDATE KLIPPERSCREEN ==============#
+#===================================================#
+
+function update_klipperscreen() {
+  local old_md5
+  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 dependencies detected..."
+    "${KLIPPERSCREEN_ENV}"/bin/pip install -r "${KLIPPERSCREEN_DIR}/scripts/KlipperScreen-requirements.txt"
+    ok_msg "Dependencies have been installed!"
+  fi
+
+  ok_msg "Update complete!"
+  do_action_service "start" "KlipperScreen"
+}
+
+#===================================================#
+#=============== KLIPPERSCREEN STATUS ==============#
+#===================================================#
+
+function get_klipperscreen_status() {
+  local sf_count status
+  sf_count="$(klipperscreen_systemd | wc -w)"
+
+  ### remove the "SERVICE" entry from the data array if a moonraker service is installed
+  local data_arr=(SERVICE "${KLIPPERSCREEN_DIR}" "${KLIPPERSCREEN_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_klipperscreen_commit() {
+  [[ ! -d ${KLIPPERSCREEN_DIR} || ! -d "${KLIPPERSCREEN_DIR}/.git" ]] && return
+
+  local commit
+  cd "${KLIPPERSCREEN_DIR}"
+  commit="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
+  echo "${commit}"
+}
+
+function get_remote_klipperscreen_commit() {
+  [[ ! -d ${KLIPPERSCREEN_DIR} || ! -d "${KLIPPERSCREEN_DIR}/.git" ]] && return
+
+  local commit
+  cd "${KLIPPERSCREEN_DIR}" && git fetch origin -q
+  commit=$(git describe origin/master --always --tags | cut -d "-" -f 1,2)
+  echo "${commit}"
+}
+
+function compare_klipperscreen_versions() {
+  local versions local_ver remote_ver
+  local_ver="$(get_local_klipperscreen_commit)"
+  remote_ver="$(get_remote_klipperscreen_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 "klipperscreen"
+  else
+    versions="${green}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+  fi
+
+  echo "${versions}"
+}
+
+#================================================#
+#=================== HELPERS ====================#
+#================================================#
+
+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\]\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 KlipperScreens update manager section to moonraker.conf
+      status_msg "Adding KlipperScreen to update manager in file:\n       ${conf}"
+      /bin/sh -c "cat >> ${conf}" << MOONRAKER_CONF
+
+[update_manager KlipperScreen]
+type: git_repo
+path: ${HOME}/KlipperScreen
+origin: https://github.com/jordanruthe/KlipperScreen.git
+env: ${HOME}/.KlipperScreen-env/bin/python
+requirements: scripts/KlipperScreen-requirements.txt
+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

@@ -0,0 +1,690 @@
+#!/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 MAINSAIL ================#
+#===================================================#
+
+function install_mainsail() {
+  if [[ -z $(moonraker_systemd) ]]; then
+    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 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_config_dir
+
+  ### check for other enabled web interfaces
+  unset SET_LISTEN_PORT
+  detect_enabled_sites
+
+  ### check if another site already listens to port 80
+  mainsail_port_check
+
+  ### download mainsail
+  download_mainsail
+
+  ### ask user to install the recommended webinterface macros
+  install_mainsail_macros
+
+  ### create /etc/nginx/conf.d/upstreams.conf
+  set_upstream_nginx_cfg
+  ### create /etc/nginx/sites-available/<interface config>
+  set_nginx_cfg "mainsail"
+  ### nginx on ubuntu 21 and above needs special permissions to access the files
+  set_nginx_permissions
+
+  ### symlink nginx log
+  symlink_webui_nginx_log "mainsail"
+
+  ### add mainsail to the update manager in moonraker.conf
+  patch_mainsail_update_manager
+
+  fetch_webui_ports #WIP
+
+  ### confirm message
+  print_confirm "Mainsail has been set up!"
+}
+
+function install_mainsail_macros() {
+  local yn
+  while true; do
+    echo
+    top_border
+    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://github.com/mainsail-crew/mainsail-config      |"
+    blank_line
+    echo -e "| If you already use these macros skip this step.       |"
+    echo -e "| Otherwise you should consider to answer with 'yes' to |"
+    echo -e "| download the recommended macros.                      |"
+    bottom_border
+    read -p "${cyan}###### Download the recommended macros? (Y/n):${white} " yn
+    case "${yn}" in
+      Y|y|Yes|yes|"")
+        select_msg "Yes"
+        download_mainsail_macros
+        break;;
+      N|n|No|no)
+        select_msg "No"
+        break;;
+      *)
+        print_error "Invalid command!";;
+    esac
+  done
+  return
+}
+
+function download_mainsail_macros() {
+  local ms_cfg_repo path configs regex line gcode_dir
+
+  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)
+
+  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)
+
+  status_msg "Downloading Mainsail from ${url} ..."
+
+  if [[ -d ${MAINSAIL_DIR} ]]; then
+    rm -rf "${MAINSAIL_DIR}"
+  fi
+
+  mkdir "${MAINSAIL_DIR}" && cd "${MAINSAIL_DIR}"
+
+  if wget "${url}"; then
+    ok_msg "Download complete!"
+    status_msg "Extracting archive ..."
+    unzip -q -o ./*.zip && ok_msg "Done!"
+    status_msg "Remove downloaded archive ..."
+    rm -rf ./*.zip && ok_msg "Done!"
+  else
+    print_error "Downloading Mainsail from\n ${url}\n failed!"
+    exit 1
+  fi
+
+  ### 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
+}
+
+#===================================================#
+#================= REMOVE MAINSAIL =================#
+#===================================================#
+
+function remove_mainsail_dir() {
+  [[ ! -d ${MAINSAIL_DIR} ]] && return
+
+  status_msg "Removing Mainsail directory ..."
+  rm -rf "${MAINSAIL_DIR}" && ok_msg "Directory removed!"
+}
+
+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!"
+  fi
+  if [[ -L "/etc/nginx/sites-enabled/mainsail" ]]; then
+    status_msg "Removing Mainsail Symlink for Nginx ..."
+    sudo rm "/etc/nginx/sites-enabled/mainsail" && ok_msg "File removed!"
+  fi
+}
+
+function remove_mainsail_logs() {
+  local files
+  files=$(find /var/log/nginx -name "mainsail*" 2> /dev/null | sort)
+
+  if [[ -n ${files} ]]; then
+    for file in ${files}; do
+      status_msg "Removing ${file} ..."
+      sudo rm -f "${file}"
+      ok_msg "${file} removed!"
+    done
+  fi
+}
+
+function remove_mainsail_log_symlinks() {
+  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
+      status_msg "Removing ${file} ..."
+      rm -f "${file}"
+      ok_msg "${file} removed!"
+    done
+  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_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}"
+
+  print_confirm "Mainsail successfully removed!"
+}
+
+#===================================================#
+#================= UPDATE MAINSAIL =================#
+#===================================================#
+
+function update_mainsail() {
+  backup_before_update "mainsail"
+  status_msg "Updating Mainsail ..."
+  download_mainsail
+  match_nginx_configs
+  symlink_webui_nginx_log "mainsail"
+  print_confirm "Mainsail successfully updated!"
+}
+
+#===================================================#
+#================= MAINSAIL STATUS =================#
+#===================================================#
+
+function get_mainsail_status() {
+  local status
+  local data_arr=("${MAINSAIL_DIR}" "${NGINX_SA}/mainsail" "${NGINX_SE}/mainsail")
+
+  ### 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_mainsail_version() {
+  local versionfile="${MAINSAIL_DIR}/.version"
+  local relinfofile="${MAINSAIL_DIR}/release_info.json"
+  local 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 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() {
+  local versions local_ver remote_ver
+  local_ver="$(get_local_mainsail_version)"
+  remote_ver="$(get_remote_mainsail_version)"
+
+  if [[ ${local_ver} != "${remote_ver}" && ${local_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 "mainsail"
+  else
+    versions="${green}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+  fi
+
+  echo "${versions}"
+}
+
+#================================================#
+#=========== MAINSAIL THEME INSTALLER ===========#
+#================================================#
+
+function print_theme_list() {
+  local i=0 theme_list=${1}
+
+  while IFS="," read -r col1 col2 col3 col4; do
+    if [[ ${col1} != "name" ]]; then
+      printf "| ${i}) %-51s|\n" "[${col1}]"
+    fi
+    i=$(( i + 1 ))
+  done <<< "${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/gb-docs/main/_data/themes.csv"
+  theme_list=$(curl -s -L "${theme_csv_url}")
+
+  top_border
+  echo -e "|     ${red}~~~~~~~~ [ Mainsail Theme Installer ] ~~~~~~~${white}     |"
+  hr
+  echo -e "| ${cyan}A preview of each Mainsail theme can be found here:${white}   |"
+  echo -e "| https://docs.mainsail.xyz/theming/themes              |"
+  blank_line
+  echo -e "| ${yellow}Important note:${white}                                       |"
+  echo -e "| Installing a theme from this menu will overwrite an   |"
+  echo -e "| already installed theme or modified custom.css file!  |"
+  hr
+  print_theme_list "${theme_list}"
+  echo -e "|                                                       |"
+  echo -e "| R) [Remove Theme]                                     |"
+  back_footer
+
+  while IFS="," read -r col1 col2 col3 col4; do
+    theme_name+=("${col1}")
+    theme_note+=("${col2}")
+    theme_author+=("${col3}")
+    theme_repo+=("${col4}")
+  done <<< "${theme_list}"
+
+  local option
+  while true; do
+    read -p "${cyan}Install theme:${white} " option
+    if (( option > 0 &&  option < ${#theme_name[@]} )); then
+      theme_url="https://github.com/${theme_author[${option}]}/${theme_repo[${option}]}"
+      ms_theme_install "${theme_url}" "${theme_name[${option}]}" "${theme_note[${option}]}"
+      break
+    elif [[ ${option} == "R" || ${option} == "r" ]]; then
+      ms_theme_delete
+      break
+    elif [[ ${option} == "B" || ${option} == "b" ]]; then
+      advanced_menu
+      break
+    else
+      error_msg "Invalid command!"
+    fi
+  done
+  ms_theme_installer_menu
+}
+
+function ms_theme_install() {
+  read_kiauh_ini "${FUNCNAME[0]}"
+
+  local theme_url
+  local theme_name
+  local theme_note
+  theme_url=${1}
+  theme_name=${2}
+  theme_note=${3}
+
+  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 "/" -f2 | cut -d"_" -f2- | rev)
+      printf "|${cyan}%-55s${white}|\n" " ${i}) ${folder}"
+    done
+    bottom_border
+
+    local target re="^[0-9]*$"
+    while true; do
+      read -p "${cyan}###### Select printer:${white} " target
+      ### break while loop if input is valid, else display error
+      [[ ${target} =~ ${re} && ${target} -lt ${#target_folders[@]} ]] && break
+      error_msg "Invalid command!"
+    done
+  fi
+
+  [[ -d "${target_folders[${target}]}/.theme" ]] && rm -rf "${target_folders[${target}]}/.theme"
+
+  status_msg "Installing '${theme_name}' to ${target_folders[${target}]} ..."
+  cd "${target_folders[${target}]}"
+
+  if git clone "${theme_url}" ".theme"; then
+    ok_msg "Theme installation complete!"
+    [[ -n ${theme_note} ]] && echo "${yellow}###### Theme Info: ${theme_note}${white}"
+    ok_msg "Please remember to delete your browser cache!\n"
+  else
+    error_msg "Theme installation failed!\n"
+  fi
+}
+
+function ms_theme_delete() {
+  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
+    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.                              |"
+    for (( i=0; i < ${#target_folders[@]}; i++ )); do
+      folder=$(echo "${target_folders[${i}]}" | rev | cut -d "/" -f2 | rev)
+      printf "|${cyan}%-55s${white}|\n" " ${i}) ${folder}"
+    done
+    bottom_border
+
+    local target re="^[0-9]*$"
+    while true; do
+      read -p "${cyan}###### Select printer:${white} " target
+      ### break while loop if input is valid, else display error
+      [[ ${target} =~ ${re} && ${target} -lt ${#target_folders[@]} ]] && break
+      error_msg "Invalid command!"
+    done
+  fi
+
+  status_msg "Removing ${target_folders[${target}]} ..."
+  rm -rf "${target_folders[${target}]}" && ok_msg "Theme removed!\n"
+
+  return
+}
+
+#================================================#
+#=================== HELPERS ====================#
+#================================================#
+
+function get_mainsail_download_url() {
+  local releases_by_tag tags tag unstable_url url
+
+  ### 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
+    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() {
+  if [[ ${MAINSAIL_ENABLED} == "false" ]]; then
+
+    if [[ ${SITE_ENABLED} == "true" ]]; then
+      status_msg "Detected other enabled interfaces:"
+
+      [[ ${FLUIDD_ENABLED} == "true" ]] && \
+      echo -e "   ${cyan}● Fluidd - Port: ${FLUIDD_PORT}${white}"
+
+      if [[ ${FLUIDD_PORT} == "80" ]]; then
+        PORT_80_BLOCKED="true"
+        select_mainsail_port
+      fi
+    else
+      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"
+
+  else
+    SET_NGINX_CFG="false"
+  fi
+}
+
+function select_mainsail_port() {
+  if [[ ${PORT_80_BLOCKED} == "true" ]]; then
+    echo
+    top_border
+    echo -e "|                    ${red}!!!WARNING!!!${white}                      |"
+    echo -e "| ${red}You need to choose a different port for Mainsail!${white}     |"
+    echo -e "| ${red}The following web interface is listening at port 80:${white}  |"
+    blank_line
+    [[ ${FLUIDD_PORT} == "80" ]] && echo "|  ● Fluidd                                             |"
+    blank_line
+    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  |"
+    echo -e "| input. So make sure to choose a valid port!           |"
+    bottom_border
+
+    local new_port re="^[0-9]+$"
+    while true; do
+      read -p "${cyan}Please enter a new Port:${white} " new_port
+      if [[ ${new_port} =~ ${re} && ${new_port} != "${FLUIDD_PORT}" ]]; then
+        select_msg "Setting port ${new_port} for Mainsail!"
+        SET_LISTEN_PORT=${new_port}
+        break
+      else
+        if [[ ! ${new_port} =~ ${re}  ]]; then
+          error_msg "Invalid input!"
+        else
+          error_msg "Port already taken! Select a different one!"
+        fi
+      fi
+    done
+  fi
+}
+
+function enable_mainsail_remotemode() {
+  [[ ! -f "${MAINSAIL_DIR}/config.json" ]] && return
+
+  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 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\]\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 to update manager in file:\n       ${conf}"
+      /bin/sh -c "cat >> ${conf}" << MOONRAKER_CONF
+
+[update_manager mainsail]
+type: web
+channel: stable
+repo: mainsail-crew/mainsail
+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

@@ -0,0 +1,193 @@
+#!/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 MJPG-STREAMER =============#
+#=================================================#
+
+function install_mjpg-streamer() {
+  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"
+
+  ### return early if webcamd.service already exists
+  if [[ -f "${SYSTEMD}/webcamd.service" ]]; then
+    print_error "Looks like MJPG-streamer is already installed!\n Please remove it first before you try to re-install it!"
+    return
+  fi
+
+  status_msg "Initializing MJPG-Streamer installation ..."
+
+  ### check and install dependencies if missing
+  local dep=(git cmake build-essential imagemagick libv4l-dev ffmpeg)
+  if apt-cache search libjpeg62-turbo-dev | grep -Eq "^libjpeg62-turbo-dev "; then
+    dep+=(libjpeg62-turbo-dev)
+  elif apt-cache search libjpeg8-dev | grep -Eq "^libjpeg8-dev "; then
+    dep+=(libjpeg8-dev)
+  fi
+
+  dependency_check "${dep[@]}"
+
+  ### step 1: clone mjpg-streamer
+  status_msg "Cloning MJPG-Streamer from ${repo} ..."
+  [[ -d "${HOME}/mjpg-streamer" ]] && rm -rf "${HOME}/mjpg-streamer"
+
+  cd "${HOME}" || exit 1
+  if ! git clone "${repo}" "${HOME}/mjpg-streamer"; then
+    print_error "Cloning MJPG-Streamer from\n ${repo}\n failed!"
+    exit 1
+  fi
+  ok_msg "Cloning complete!"
+
+  ### step 2: compiling mjpg-streamer
+  status_msg "Compiling MJPG-Streamer ..."
+  cd "${HOME}/mjpg-streamer/mjpg-streamer-experimental"
+  if ! make; then
+    print_error "Compiling MJPG-Streamer failed!"
+    exit 1
+  fi
+  ok_msg "Compiling complete!"
+
+  #step 3: install mjpg-streamer
+  status_msg "Installing MJPG-Streamer ..."
+  cd "${HOME}/mjpg-streamer" && mv mjpg-streamer-experimental/* .
+  mkdir www-mjpgstreamer
+
+  cat <<EOT >> ./www-mjpgstreamer/index.html
+<html>
+<head><title>mjpg_streamer test page</title></head>
+<body>
+<h1>Snapshot</h1>
+<p>Refresh the page to refresh the snapshot</p>
+<img src="./?action=snapshot" alt="Snapshot">
+<h1>Stream</h1>
+<img src="./?action=stream" alt="Stream">
+</body>
+</html>
+EOT
+
+  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
+
+  ### step 4: create webcam.txt config file
+  [[ ! -d ${KLIPPER_CONFIG} ]] && mkdir -p "${KLIPPER_CONFIG}"
+  if [[ ! -f "${KLIPPER_CONFIG}/webcam.txt" ]]; then
+    status_msg "Creating webcam.txt config file ..."
+    cp "${webcam_txt}" "${KLIPPER_CONFIG}/webcam.txt"
+    ok_msg "Done!"
+  fi
+
+  ### step 5: create systemd service
+  status_msg "Creating MJPG-Streamer service ..."
+  sudo cp "${service}" "${SYSTEMD}/webcamd.service"
+  sudo sed -i "s|%USER%|${USER}|" "${SYSTEMD}/webcamd.service"
+  ok_msg "MJPG-Streamer service created!"
+
+  ### step 6: enabling and starting mjpg-streamer service
+  status_msg "Starting MJPG-Streamer service, please wait ..."
+  sudo systemctl enable webcamd.service
+  if sudo systemctl start webcamd.service; then
+    ok_msg "MJPG-Streamer service started!"
+  else
+    status_msg "MJPG-Streamer service couldn't be started! No webcam connected?\n###### You need to manually restart the service once your webcam is set up correctly."
+  fi
+
+  ### step 6.1: create webcamd.log symlink
+  [[ ! -d ${KLIPPER_LOGS} ]] && mkdir -p "${KLIPPER_LOGS}"
+  if [[ -f "/var/log/webcamd.log" && ! -L "${KLIPPER_LOGS}/webcamd.log" ]]; then
+    ln -s "/var/log/webcamd.log" "${KLIPPER_LOGS}/webcamd.log"
+  fi
+
+  ### step 6.2: add webcamd.log logrotate
+  if [[ ! -f "/etc/logrotate.d/webcamd"  ]]; then
+    status_msg "Create logrotate rule ..."
+    sudo /bin/sh -c "cat > /etc/logrotate.d/webcamd" << EOF
+/var/log/webcamd.log
+{
+    rotate 2
+    weekly
+    maxsize 32M
+    missingok
+    notifempty
+    compress
+    delaycompress
+    sharedscripts
+}
+EOF
+     ok_msg "Done!"
+  fi
+
+  ### step 7: check if user is in group "video"
+  local usergroup_changed="false"
+  if ! groups "${USER}" | grep -q "video"; then
+    status_msg "Adding user '${USER}' to group 'video' ..."
+    sudo usermod -a -G video "${USER}" && ok_msg "Done!"
+    usergroup_changed="true"
+  fi
+
+  ### confirm message
+  local confirm_msg="MJPG-Streamer has been set up!"
+  if [[ ${usergroup_changed} == "true" ]]; then
+    confirm_msg="${confirm_msg}\n ${yellow}INFO: Your User was added to a new group!${green}"
+    confirm_msg="${confirm_msg}\n ${yellow}You need to relog/restart for the group to be applied!${green}"
+  fi
+
+  print_confirm "${confirm_msg}"
+
+  ### print webcam ip adress/url
+  local ip
+  ip=$(hostname -I | cut -d" " -f1)
+  local cam_url="http://${ip}:8080/?action=stream"
+  local cam_url_alt="http://${ip}/webcam/?action=stream"
+  echo -e " ${cyan}● Webcam URL:${white} ${cam_url}"
+  echo -e " ${cyan}● Webcam URL:${white} ${cam_url_alt}"
+  echo
+}
+
+#=================================================#
+#============== REMOVE MJPG-STREAMER =============#
+#=================================================#
+
+function remove_mjpg-streamer() {
+  ### remove MJPG-Streamer service
+  if [[ -e "${SYSTEMD}/webcamd.service" ]]; then
+    status_msg "Removing MJPG-Streamer service ..."
+    sudo systemctl stop webcamd && sudo systemctl disable webcamd
+    sudo rm -f "${SYSTEMD}/webcamd.service"
+    ###reloading units
+    sudo systemctl daemon-reload
+    sudo systemctl reset-failed
+    ok_msg "MJPG-Streamer Service removed!"
+  fi
+
+  ### remove webcamd from /usr/local/bin
+  if [[ -e "/usr/local/bin/webcamd" ]]; then
+    sudo rm -f "/usr/local/bin/webcamd"
+  fi
+
+  ### remove MJPG-Streamer directory
+  if [[ -d "${HOME}/mjpg-streamer" ]]; then
+    status_msg "Removing MJPG-Streamer directory ..."
+    rm -rf "${HOME}/mjpg-streamer"
+    ok_msg "MJPG-Streamer directory removed!"
+  fi
+
+  ### remove webcamd log and symlink
+  [[ -f "/var/log/webcamd.log" ]] && sudo rm -f "/var/log/webcamd.log"
+  [[ -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

@@ -0,0 +1,542 @@
+#!/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 MOONRAKERTELEGRAMBOT ===========#
+#===================================================#
+
+function telegram_bot_systemd() {
+  local services
+  services=$(find "${SYSTEMD}" -maxdepth 1 -regextype posix-extended -regex "${SYSTEMD}/moonraker-telegram-bot(-[0-9a-zA-Z]+)?.service" | sort)
+  echo "${services}"
+}
+
+function telegram_bot_setup_dialog() {
+  ### return early if moonraker is not installed
+  local moonraker_services
+  moonraker_services=$(moonraker_systemd)
+
+  if [[ -z ${moonraker_services} ]]; then
+    local error="Moonraker not installed! Please install Moonraker first!"
+    print_error "${error}" && return
+  fi
+
+  status_msg "Initializing Telegram Bot installation ..."
+  ### first, we create a backup of the full klipper_config dir - safety first!
+  backup_config_dir
+
+  local moonraker_count user_input=() moonraker_names=()
+  moonraker_count=$(echo "${moonraker_services}" | wc -w )
+  for service in ${moonraker_services}; do
+    moonraker_names+=( "$(get_instance_name "${service}")" )
+  done
+
+  local telegram_bot_count
+  if (( moonraker_count == 1 )); then
+    ok_msg "Moonraker installation found!\n"
+    telegram_bot_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" " ● ${name}"
+    done
+    blank_line
+    echo -e "| The setup will apply the same names to Telegram Bot!  |"
+    blank_line
+    echo -e "| Please select the number of Telegram Bot instances to |"
+    echo -e "| install. Usually one Telegram Bot instance per        |"
+    echo -e "| Moonraker instance is required, but you may not       |"
+    echo -e "| install more Telegram Bot instances than available    |"
+    echo -e "| Moonraker instances.                                  |"
+    bottom_border
+
+    ### ask for amount of instances
+    local re="^[1-9][0-9]*$"
+    while [[ ! ${telegram_bot_count} =~ ${re} || ${telegram_bot_count} -gt ${moonraker_count} ]]; do
+      read -p "${cyan}###### Number of Telegram Bot instances to set up:${white} " -i "${moonraker_count}" -e telegram_bot_count
+      ### break if input is valid
+      [[ ${telegram_bot_count} =~ ${re} && ${telegram_bot_count} -le ${moonraker_count} ]] && break
+      ### conditional error messages
+      [[ ! ${telegram_bot_count} =~ ${re} ]] && error_msg "Input not a number"
+      (( telegram_bot_count > moonraker_count )) && error_msg "Number of Telegram Bot instances larger than existing Moonraker instances"
+    done && select_msg "${telegram_bot_count}"
+  else
+    log_error "Internal error. moonraker_count of '${moonraker_count}' not equal or grather than one!"
+    return 1
+  fi
+
+  user_input+=("${telegram_bot_count}")
+
+  ### confirm instance amount
+  local yn
+  while true; do
+    (( telegram_bot_count == 1 )) && local question="Install Telegram Bot?"
+    (( telegram_bot_count > 1 )) && local question="Install ${telegram_bot_count} Telegram Bot 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 Telegram Bot setup ...\n"
+        return;;
+      *)
+        error_msg "Invalid Input!";;
+    esac
+  done
+
+  ### write existing klipper names into user_input array to use them as names for moonraker
+  if (( moonraker_count > 1 )); then
+    for name in "${moonraker_names[@]}"; do
+      user_input+=("${name}")
+    done
+  fi
+
+  (( telegram_bot_count > 1 )) && status_msg "Installing ${telegram_bot_count} Telegram Bot instances ..."
+  (( telegram_bot_count == 1 )) && status_msg "Installing Telegram Bot ..."
+  telegram_bot_setup "${user_input[@]}"
+}
+
+function install_telegram_bot_dependencies() {
+  local packages log_name="Telegram Bot"
+  local install_script="${TELEGRAM_BOT_DIR}/scripts/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 create_telegram_bot_virtualenv() {
+  status_msg "Installing python virtual environment..."
+  ### always create a clean virtualenv
+  [[ -d ${TELEGRAM_BOT_ENV} ]] && rm -rf "${TELEGRAM_BOT_ENV}"
+  if virtualenv -p /usr/bin/python3 --system-site-packages "${TELEGRAM_BOT_ENV}"; then
+    "${TELEGRAM_BOT_ENV}"/bin/pip install -r "${TELEGRAM_BOT_DIR}/scripts/requirements.txt"
+  else
+    log_error "failure while creating python3 moonraker-telegram-bot-env"
+    error_msg "Creation of Moonraker Telegram Bot virtualenv failed!"
+    exit 1
+  fi
+}
+
+function telegram_bot_setup() {
+  local instance_arr=("${@}")
+  ### checking dependencies
+  local dep=(git virtualenv)
+  dependency_check "${dep[@]}"
+
+  ### step 1: clone telegram bot
+  clone_telegram_bot "${TELEGRAM_BOT_REPO}"
+
+  ### step 2: install telegram bot dependencies and create python virtualenv
+  status_msg "Installing dependencies ..."
+  install_telegram_bot_dependencies
+  create_telegram_bot_virtualenv
+
+  ### step 3: create telegram.conf
+  create_telegram_conf "${instance_arr[@]}"
+
+  ### step 4: create telegram bot instances
+  create_telegram_bot_service "${instance_arr[@]}"
+
+  ### step 5: add telegram-bot to the update manager in moonraker.conf
+  patch_telegram_bot_update_manager
+
+  ### step 6: enable and start all instances
+  do_action_service "enable" "moonraker-telegram-bot"
+  do_action_service "start" "moonraker-telegram-bot"
+
+  ### confirm message
+  local confirm=""
+  (( instance_arr[0] == 1 )) && confirm="Telegram Bot has been set up!"
+  (( instance_arr[0] > 1 )) && confirm="${instance_arr[0]} Telegram Bot instances have been set up!"
+  print_confirm "${confirm}" && return
+}
+
+function clone_telegram_bot() {
+  local repo=${1}
+
+  status_msg "Cloning Moonraker-Telegram-Bot from ${repo} ..."
+  ### force remove existing Moonraker-Telegram-Bot dir
+  [[ -d ${repo} ]] && rm -rf "${TELEGRAM_BOT_DIR}"
+
+  cd "${HOME}" || exit 1
+  if ! git clone "${repo}" "${TELEGRAM_BOT_DIR}"; then
+    print_error "Cloning Moonraker-Telegram-Bot from\n ${repo}\n failed!"
+    exit 1
+  fi
+}
+
+function create_telegram_conf() {
+  local input=("${@}")
+  local telegram_bot_count=${input[0]} && unset "input[0]"
+  local names=("${input[@]}") && unset "input[@]"
+  local printer_data log_dir cfg cfg_dir
+
+  if (( telegram_bot_count == 1 )); then
+    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}"
+
+  elif (( telegram_bot_count > 1 )); then
+    local j=0 re="^[1-9][0-9]*$"
+
+    for (( i=1; i <= telegram_bot_count; i++ )); do
+
+      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}"
+
+      j=$(( j + 1 ))
+    done && unset j
+
+  else
+    return 1
+  fi
+}
+
+function write_telegram_conf() {
+  local cfg_dir=${1} cfg=${2}
+  local conf_template="${TELEGRAM_BOT_DIR}/scripts/base_install_template"
+
+  if [[ ! -f ${cfg} ]]; then
+    status_msg "Creating telegram.conf in ${cfg_dir} ..."
+    cp "${conf_template}" "${cfg}"
+    ok_msg "telegram.conf created!"
+  else
+    ok_msg "File '${cfg}' already exists! Skipping..."
+  fi
+}
+
+function create_telegram_bot_service() {
+  local input=("${@}")
+  local instances=${input[0]} && unset "input[0]"
+  local names=("${input[@]}") && unset "input[@]"
+  local printer_data cfg_dir cfg log service env_file
+
+  if (( instances == 1 )); then
+    printer_data="${HOME}/printer_data"
+    cfg_dir="${printer_data}/config"
+    cfg="${cfg_dir}/telegram.conf"
+    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}" "${env_file}"
+    ok_msg "Telegram Bot instance created!"
+
+  elif (( instances > 1 )); then
+    local j=0 re="^[1-9][0-9]*$"
+
+    for (( i=1; i <= instances; i++ )); do
+      ### overwrite config folder if name is only a number
+      if [[ ${names[j]} =~ ${re} ]]; then
+        printer_data="${HOME}/printer_${names[${j}]}_data"
+      else
+        printer_data="${HOME}/${names[${j}]}_data"
+      fi
+
+      cfg_dir="${printer_data}/config"
+      cfg="${cfg_dir}/telegram.conf"
+      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
+      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
+
+  else
+    return 1
+  fi
+}
+
+function write_telegram_bot_service() {
+  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 service file for instance ${i} ..."
+    sudo cp "${service_template}" "${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
+}
+
+
+#===================================================#
+#=========== REMOVE MOONRAKERTELEGRAMBOT ===========#
+#===================================================#
+
+function remove_telegram_bot_systemd() {
+  [[ -z $(telegram_bot_systemd) ]] && return
+
+  status_msg "Removing Telegram Bot Systemd Services ..."
+  for service in $(telegram_bot_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 "Telegram Bot Services removed!"
+}
+
+function remove_telegram_bot_dir() {
+  [[ ! -d ${TELEGRAM_BOT_DIR} ]] && return
+
+  status_msg "Removing Moonraker-Telegram-Bot directory ..."
+  rm -rf "${TELEGRAM_BOT_DIR}"
+  ok_msg "Directory removed!"
+}
+
+function remove_telegram_bot_env() {
+  [[ ! -d ${TELEGRAM_BOT_ENV} ]] && return
+
+  status_msg "Removing moonraker-telegram-bot-env directory ..."
+  rm -rf "${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 "${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_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
+}
+
+#===================================================#
+#=========== UPDATE MOONRAKERTELEGRAMBOT ===========#
+#===================================================#
+
+function update_telegram_bot() {
+  do_action_service "stop" "moonraker-telegram-bot"
+
+  if [[ ! -d ${TELEGRAM_BOT_DIR} ]]; then
+    clone_telegram_bot "${TELEGRAM_BOT_REPO}"
+  else
+    backup_before_update "moonraker-telegram-bot"
+    status_msg "Updating Moonraker ..."
+    cd "${TELEGRAM_BOT_DIR}" && git pull
+    ### read PKGLIST and install possible new dependencies
+    install_telegram_bot_dependencies
+    ### install possible new python dependencies
+    "${TELEGRAM_BOT_ENV}"/bin/pip install -r "${TELEGRAM_BOT_DIR}/scripts/requirements.txt"
+  fi
+
+  ok_msg "Update complete!"
+  do_action_service "start" "moonraker-telegram-bot"
+}
+
+#===================================================#
+#=========== MOONRAKERTELEGRAMBOT STATUS ===========#
+#===================================================#
+
+function get_telegram_bot_status() {
+  local sf_count status
+  sf_count="$(telegram_bot_systemd | wc -w)"
+
+  ### remove the "SERVICE" entry from the data array if a moonraker service is installed
+  local data_arr=(SERVICE "${TELEGRAM_BOT_DIR}" "${TELEGRAM_BOT_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: ${sf_count}"
+  elif (( filecount == 0 )); then
+    status="Not installed!"
+  else
+    status="Incomplete!"
+  fi
+  echo "${status}"
+}
+
+function get_local_telegram_bot_commit() {
+  [[ ! -d ${TELEGRAM_BOT_DIR} || ! -d "${TELEGRAM_BOT_DIR}/.git" ]] && return
+
+  local commit
+  cd "${TELEGRAM_BOT_DIR}"
+  commit="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
+  echo "${commit}"
+}
+
+function get_remote_telegram_bot_commit() {
+  [[ ! -d ${TELEGRAM_BOT_DIR} || ! -d "${TELEGRAM_BOT_DIR}/.git" ]] && return
+
+  local commit
+  cd "${TELEGRAM_BOT_DIR}" && git fetch origin -q
+  commit=$(git describe origin/master --always --tags | cut -d "-" -f 1,2)
+  echo "${commit}"
+}
+
+function compare_telegram_bot_versions() {
+  local versions local_ver remote_ver
+  local_ver="$(get_local_telegram_bot_commit)"
+  remote_ver="$(get_remote_telegram_bot_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 "telegram_bot"
+  else
+    versions="${green}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+  fi
+
+  echo "${versions}"
+}
+
+#================================================#
+#=================== HELPERS ====================#
+#================================================#
+
+function patch_telegram_bot_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 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}"
+
+      ### add Moonraker-Telegram-Bot update manager section to moonraker.conf
+      status_msg "Adding Moonraker-Telegram-Bot to update manager in file:\n       ${conf}"
+      /bin/sh -c "cat >> ${conf}" << MOONRAKER_CONF
+
+[update_manager moonraker-telegram-bot]
+type: git_repo
+path: ~/moonraker-telegram-bot
+origin: https://github.com/nlef/moonraker-telegram-bot.git
+env: ~/moonraker-telegram-bot-env/bin/python
+requirements: scripts/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.sh

@@ -0,0 +1,824 @@
+#!/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 ================#
+#===================================================#
+
+###
+# this function detects all installed moonraker
+# systemd instances and returns their absolute path
+function moonraker_systemd() {
+  local services
+  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}"
+}
+
+function moonraker_setup_dialog() {
+  status_msg "Initializing Moonraker installation ..."
+
+  ### 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
+
+  ### return early if moonraker already exists
+  local moonraker_services
+  moonraker_services=$(moonraker_systemd)
+  if [[ -n ${moonraker_services} ]]; then
+    local error="At least one Moonraker service is already installed:"
+    for s in ${moonraker_services}; do
+      log_info "Found Moonraker service: ${s}"
+      error="${error}\n ➔ ${s}"
+    done
+    print_error "${error}" && return
+  fi
+
+  ### return early if klipper is not installed
+  local klipper_services
+  klipper_services=$(klipper_systemd)
+  if [[ -z ${klipper_services} ]]; then
+    local error="Klipper not installed! Please install Klipper first!"
+    log_error "Moonraker 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
+
+  local moonraker_count
+  if (( klipper_count == 1 )); then
+    ok_msg "Klipper installation found!\n"
+    moonraker_count=1
+  elif (( klipper_count > 1 )); then
+    top_border
+    printf "|${green}%-55s${white}|\n" " ${klipper_count} Klipper instances found!"
+    for name in "${klipper_names[@]}"; do
+      printf "|${cyan}%-57s${white}|\n" " ● klipper-${name}"
+    done
+    blank_line
+    echo -e "| The setup will apply the same names to Moonraker!     |"
+    blank_line
+    echo -e "| Please select the number of Moonraker instances to    |"
+    echo -e "| install. Usually one Moonraker instance per Klipper   |"
+    echo -e "| instance is required, but you may not install more    |"
+    echo -e "| Moonraker instances than available Klipper instances. |"
+    bottom_border
+
+    ### ask for amount of instances
+    local re="^[1-9][0-9]*$"
+    while [[ ! ${moonraker_count} =~ ${re} || ${moonraker_count} -gt ${klipper_count} ]]; do
+      read -p "${cyan}###### Number of Moonraker instances to set up:${white} " -i "${klipper_count}" -e moonraker_count
+      ### break if input is valid
+      [[ ${moonraker_count} =~ ${re} && ${moonraker_count} -le ${klipper_count} ]] && break
+      ### conditional error messages
+      [[ ! ${moonraker_count} =~ ${re} ]] && error_msg "Input not a number"
+      (( moonraker_count > klipper_count )) && error_msg "Number of Moonraker instances larger than installed Klipper instances"
+    done && select_msg "${moonraker_count}"
+  else
+    log_error "Internal error. klipper_count of '${klipper_count}' not equal or grather than one!"
+    return 1
+  fi
+
+  user_input+=("${moonraker_count}")
+
+  ### confirm instance amount
+  local yn
+  while true; do
+    (( moonraker_count == 1 )) && local question="Install Moonraker?"
+    (( moonraker_count > 1 )) && local question="Install ${moonraker_count} Moonraker 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 Moonraker setup ...\n"
+        return;;
+      *)
+        error_msg "Invalid Input!";;
+    esac
+  done
+
+  ### write existing klipper names into user_input array to use them as names for moonraker
+  if (( klipper_count > 1 )); then
+    for name in "${klipper_names[@]}"; do
+      user_input+=("${name}")
+    done
+  fi
+
+  (( moonraker_count > 1 )) && status_msg "Installing ${moonraker_count} Moonraker instances ..."
+  (( moonraker_count == 1 )) && status_msg "Installing Moonraker ..."
+  moonraker_setup "${user_input[@]}"
+}
+
+function install_moonraker_dependencies() {
+  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=$(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 lists if stale
+  update_system_package_lists
+
+  ### Install required packages
+  install_system_packages "${log_name}" "packages[@]"
+}
+
+function create_moonraker_virtualenv() {
+  status_msg "Installing python virtual environment..."
+
+  ### always create a clean virtualenv
+  [[ -d ${MOONRAKER_ENV} ]] && rm -rf "${MOONRAKER_ENV}"
+
+  if virtualenv -p /usr/bin/python3 "${MOONRAKER_ENV}"; then
+    "${MOONRAKER_ENV}"/bin/pip install -r "${MOONRAKER_DIR}/scripts/moonraker-requirements.txt"
+  else
+    log_error "failure while creating python3 moonraker-env"
+    error_msg "Creation of Moonraker virtualenv failed!"
+    exit 1
+  fi
+}
+
+function moonraker_setup() {
+  local instance_arr=("${@}")
+  ### checking dependencies
+  local dep=(git wget curl unzip dfu-util virtualenv)
+  ### additional required dependencies on armbian
+  dep+=(libjpeg-dev zlib1g-dev)
+  dependency_check "${dep[@]}"
+
+  ### step 1: clone moonraker
+  clone_moonraker "${MOONRAKER_REPO}"
+
+  ### step 2: install moonraker dependencies and create python virtualenv
+  status_msg "Installing dependencies ..."
+  install_moonraker_dependencies
+  create_moonraker_virtualenv
+
+  ### step 3: create moonraker.conf
+  create_moonraker_conf "${instance_arr[@]}"
+
+  ### step 4: create moonraker instances
+  configure_moonraker_service "${instance_arr[@]}"
+
+  ### step 5: create polkit rules for moonraker
+  install_moonraker_polkit || true
+
+  ### step 6: enable and start all instances
+  do_action_service "enable" "moonraker"
+  do_action_service "start" "moonraker"
+
+  ### confirm message
+  local confirm=""
+  (( instance_arr[0] == 1 )) && confirm="Moonraker has been set up!"
+  (( instance_arr[0] > 1 )) && confirm="${instance_arr[0]} Moonraker instances have been set up!"
+  print_confirm "${confirm}" && print_mr_ip_list "${instance_arr[0]}" && return
+}
+
+function clone_moonraker() {
+  local repo=${1}
+
+  status_msg "Cloning Moonraker from ${repo} ..."
+
+  ### force remove existing moonraker dir and clone into fresh moonraker dir
+  [[ -d ${MOONRAKER_DIR} ]] && rm -rf "${MOONRAKER_DIR}"
+
+  cd "${HOME}" || exit 1
+  if ! git clone "${MOONRAKER_REPO}" "${MOONRAKER_DIR}"; then
+    print_error "Cloning Moonraker from\n ${repo}\n failed!"
+    exit 1
+  fi
+}
+
+function create_moonraker_conf() {
+  local input=("${@}")
+  local moonraker_count=${input[0]} && unset "input[0]"
+  local names=("${input[@]}") && unset "input[@]"
+  local port lan printer_data cfg_dir cfg uds
+
+  port=7125
+  lan="$(hostname -I | cut -d" " -f1 | cut -d"." -f1-2).0.0/16"
+
+  if (( moonraker_count == 1 )); then
+    printer_data="${HOME}/printer_data"
+    cfg_dir="${printer_data}/config"
+    cfg="${cfg_dir}/moonraker.conf"
+    uds="${printer_data}/comms/klippy.sock"
+
+    ### write single instance config
+    write_moonraker_conf "${cfg_dir}" "${cfg}" "${port}" "${uds}" "${lan}"
+
+  elif (( moonraker_count > 1 )); then
+    local j=0 re="^[1-9][0-9]*$"
+
+    for (( i=1; i <= moonraker_count; i++ )); do
+      ### overwrite config folder if name is only a number
+      if [[ ${names[j]} =~ ${re} ]]; then
+        printer_data="${HOME}/printer_${names[${j}]}_data"
+      else
+        printer_data="${HOME}/${names[${j}]}_data"
+      fi
+
+      cfg_dir="${printer_data}/config"
+      cfg="${cfg_dir}/moonraker.conf"
+      uds="${printer_data}/comms/klippy.sock"
+
+      ### write multi instance config
+      write_moonraker_conf "${cfg_dir}" "${cfg}" "${port}" "${uds}" "${lan}"
+      port=$(( port + 1 ))
+      j=$(( j + 1 ))
+    done && unset j
+
+  else
+    return 1
+  fi
+}
+
+function write_moonraker_conf() {
+  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}"
+
+  if [[ ! -f ${cfg} ]]; then
+    status_msg "Creating moonraker.conf in ${cfg_dir} ..."
+    cp "${conf_template}" "${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
+      sed -i "s|%LAN%|${lan}|" "${cfg}"
+    else
+      sed -i "/%LAN%/d" "${cfg}"
+    fi
+    ok_msg "moonraker.conf created!"
+  else
+    status_msg "File '${cfg_dir}/moonraker.conf' already exists!\nSkipping..."
+  fi
+}
+
+function configure_moonraker_service() {
+  local input=("${@}")
+  local moonraker_count=${input[0]} && unset "input[0]"
+  local names=("${input[@]}") && unset "input[@]"
+  local printer_data cfg_dir service env_file
+
+  if (( moonraker_count == 1 )) && [[ ${#names[@]} -eq 0 ]]; then
+    i=""
+    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 "" "${printer_data}" "${service}" "${env_file}"
+    ok_msg "Moonraker instance created!"
+
+  elif (( moonraker_count > 1 )) && [[ ${#names[@]} -gt 0 ]]; then
+    local j=0 re="^[1-9][0-9]*$"
+
+    for (( i=1; i <= moonraker_count; i++ )); do
+      ### overwrite config folder if name is only a number
+      if [[ ${names[j]} =~ ${re} ]]; then
+        printer_data="${HOME}/printer_${names[${j}]}_data"
+      else
+        printer_data="${HOME}/${names[${j}]}_data"
+      fi
+
+      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}]}" "${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
+      enable_mainsail_remotemode
+    fi
+
+  else
+    return 1
+  fi
+}
+
+function write_moonraker_service() {
+  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| %INST%||" "${service}"
+    [[ -n ${i} ]] && sudo sed -i "s|%INST%|${i}|" "${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
+}
+
+function print_mr_ip_list() {
+  local ip count=${1} port=7125
+  ip=$(hostname -I | cut -d" " -f1)
+
+  for (( i=1; i <= count; i++ )); do
+    echo -e "   ${cyan}● Instance ${i}:${white} ${ip}:${port}"
+    port=$(( port + 1 ))
+  done && echo
+}
+
+### introduced due to
+### https://github.com/Arksine/moonraker/issues/349
+### https://github.com/Arksine/moonraker/pull/346
+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
+  for service in $(moonraker_systemd); do
+    has_sup="$(grep "SupplementaryGroups=moonraker-admin" "${service}")"
+    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
+
+  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 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
+}
+
+#==================================================#
+#================ REMOVE MOONRAKER ================#
+#==================================================#
+
+function remove_moonraker_sysvinit() {
+  [[ ! -e "${INITD}/moonraker" ]] && return
+
+  status_msg "Removing Moonraker SysVinit service ..."
+  sudo systemctl stop moonraker
+  sudo update-rc.d -f moonraker remove
+  sudo rm -f "${INITD}/moonraker" "${ETCDEF}/moonraker"
+  ok_msg "Moonraker SysVinit service removed!"
+}
+
+function remove_moonraker_systemd() {
+  [[ -z $(moonraker_systemd) ]] && return
+
+  status_msg "Removing Moonraker Systemd Services ..."
+
+  for service in $(moonraker_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 "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 "${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_api_key() {
+  ### remove legacy api key
+  if [[ -e "${HOME}/.klippy_api_key" ]]; then
+    status_msg "Removing legacy API Key ..."
+    rm "${HOME}/.klippy_api_key"
+    ok_msg "Done!"
+  fi
+
+  ### remove api key
+  if [[ -e "${HOME}/.moonraker_api_key" ]]; then
+    status_msg "Removing API Key ..."
+    rm "${HOME}/.moonraker_api_key"
+    ok_msg "Done!"
+  fi
+}
+
+function remove_moonraker_dir() {
+  [[ ! -d ${MOONRAKER_DIR} ]] && return
+
+  status_msg "Removing Moonraker directory ..."
+  rm -rf "${MOONRAKER_DIR}"
+  ok_msg "Directory removed!"
+}
+
+function remove_moonraker_env() {
+  [[ ! -d ${MOONRAKER_ENV} ]] && return
+
+  status_msg "Removing moonraker-env directory ..."
+  rm -rf "${MOONRAKER_ENV}"
+  ok_msg "Directory removed!"
+}
+
+function remove_moonraker_polkit() {
+  [[ ! -d ${MOONRAKER_DIR} ]] && return
+
+  status_msg "Removing all Moonraker PolicyKit rules ..."
+  "${MOONRAKER_DIR}"/scripts/set-policykit-rules.sh --clear
+  ok_msg "Done!"
+}
+
+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
+  remove_moonraker_env
+
+  print_confirm "Moonraker was successfully removed!"
+  return
+}
+
+#==================================================#
+#================ UPDATE MOONRAKER ================#
+#==================================================#
+
+function update_moonraker() {
+  do_action_service "stop" "moonraker"
+
+  if [[ ! -d ${MOONRAKER_DIR} ]]; then
+    clone_moonraker "${MOONRAKER_REPO}"
+  else
+    backup_before_update "moonraker"
+    status_msg "Updating Moonraker ..."
+    cd "${MOONRAKER_DIR}" && git pull
+    ### read PKGLIST and install possible new dependencies
+    install_moonraker_dependencies
+    ### install possible new python dependencies
+    "${MOONRAKER_ENV}"/bin/pip install -r "${MOONRAKER_DIR}/scripts/moonraker-requirements.txt"
+  fi
+
+  ### required due to https://github.com/Arksine/moonraker/issues/349
+  install_moonraker_polkit || true
+
+  ok_msg "Update complete!"
+  do_action_service "restart" "moonraker"
+}
+
+#==================================================#
+#================ MOONRAKER STATUS ================#
+#==================================================#
+
+function get_moonraker_status() {
+  local sf_count status
+  sf_count="$(moonraker_systemd | wc -w)"
+
+  ### remove the "SERVICE" entry from the data array if a moonraker service is installed
+  local data_arr=(SERVICE "${MOONRAKER_DIR}" "${MOONRAKER_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: ${sf_count}"
+  elif (( filecount == 0 )); then
+    status="Not installed!"
+  else
+    status="Incomplete!"
+  fi
+
+  echo "${status}"
+}
+
+function get_local_moonraker_commit() {
+  [[ ! -d ${MOONRAKER_DIR} || ! -d "${MOONRAKER_DIR}/.git" ]] && return
+
+  local commit
+  cd "${MOONRAKER_DIR}"
+  commit="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
+  echo "${commit}"
+}
+
+function get_remote_moonraker_commit() {
+  [[ ! -d ${MOONRAKER_DIR} || ! -d "${MOONRAKER_DIR}/.git" ]] && return
+
+  local commit
+  cd "${MOONRAKER_DIR}" && git fetch origin -q
+  commit=$(git describe origin/master --always --tags | cut -d "-" -f 1,2)
+  echo "${commit}"
+}
+
+function compare_moonraker_versions() {
+  local versions local_ver remote_ver
+  local_ver="$(get_local_moonraker_commit)"
+  remote_ver="$(get_remote_moonraker_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"
+  else
+    versions="${green}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+  fi
+
+  echo "${versions}"
+}

scripts/nginx.sh

@@ -0,0 +1,360 @@
+#!/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
+
+#===================================================#
+#=================== REMOVE NGINX ==================#
+#===================================================#
+
+function remove_nginx() {
+  if [[ $(dpkg -s nginx  2>/dev/null | grep "Status") = *\ installed ]]; then
+    status_msg "Stopping NGINX service ..."
+    if systemctl is-active nginx -q; then
+      sudo systemctl stop nginx && ok_msg "Service stopped!"
+    else
+      warn_msg "NGINX service not active!"
+    fi
+
+    status_msg "Removing NGINX from system ..."
+    if sudo apt-get remove nginx -y && sudo update-rc.d -f nginx remove; then
+      ok_msg "NGINX removed!"
+    else
+      error_msg "Removing NGINX from system failed!"
+    fi
+  else
+    print_error "Looks like Nginx was already removed!\n Skipping..."
+  fi
+}
+
+#===================================================#
+#===================== HELPERS =====================#
+#===================================================#
+
+function set_upstream_nginx_cfg() {
+  local current_date
+  local upstreams="${NGINX_CONFD}/upstreams.conf"
+  local common_vars="${NGINX_CONFD}/common_vars.conf"
+
+  current_date=$(get_date)
+
+  ### backup existing nginx configs
+  [[ ! -d "${BACKUP_DIR}/nginx_cfg" ]] && mkdir -p "${BACKUP_DIR}/nginx_cfg"
+
+  if [[ -f ${upstreams} ]]; then
+    sudo mv "${upstreams}" "${BACKUP_DIR}/nginx_cfg/${current_date}_upstreams.conf"
+  fi
+
+  if [[ -f ${common_vars} ]]; then
+    sudo mv "${common_vars}" "${BACKUP_DIR}/nginx_cfg/${current_date}_common_vars.conf"
+  fi
+
+  ### transfer ownership of backed up files from root to ${USER}
+  local files
+  files=$(find "${BACKUP_DIR}/nginx_cfg")
+
+  for file in ${files}; do
+    if [[ $(stat -c "%U" "${file}") != "${USER}" ]]; then
+      log_info "chown for user: ${USER} on file: ${file}"
+      sudo chown "${USER}" "${file}"
+    fi
+  done
+
+  ### copy nginx configs to target destination
+  [[ ! -f ${upstreams} ]] && sudo cp "${RESOURCES}/upstreams.conf" "${upstreams}"
+  [[ ! -f ${common_vars} ]] && sudo cp "${RESOURCES}/common_vars.conf" "${common_vars}"
+}
+
+function symlink_webui_nginx_log() {
+  local interface path access_log error_log regex logpaths
+
+  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)
+
+  for path in ${logpaths}; do
+    [[ ! -d ${path} ]] && mkdir -p "${path}"
+
+    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() {
+  read_kiauh_ini "${FUNCNAME[0]}"
+  local require_service_restart="false"
+  local upstreams="${NGINX_CONFD}/upstreams.conf"
+  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
+  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")
+  mainsail_webcams=$(grep -Ec "mjpgstreamer" "${mainsail_nginx_cfg}" 2>/dev/null || echo "0")
+  fluidd_webcams=$(grep -Ec "mjpgstreamer" "${fluidd_nginx_cfg}" 2>/dev/null || echo "0")
+
+  status_msg "Checking validity of NGINX configurations ..."
+
+  ### check for outdated upstreams.conf
+  if (( upstreams_webcams < mainsail_webcams || upstreams_webcams < fluidd_webcams )); then
+    status_msg "Outdated upstreams.conf found! Updating ..."
+
+    sudo rm -f "${upstreams}" "${common_vars}"
+    set_upstream_nginx_cfg
+
+    require_service_restart="true"
+  fi
+
+  ### check for outdated mainsail config
+  if [[ -e ${mainsail_nginx_cfg} ]] && (( upstreams_webcams > mainsail_webcams )); then
+    status_msg "Outdated Mainsail config found! Updating ..."
+
+    sudo rm -f "${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}"
+    sudo sed -i "s/listen\s\[\:*\]\:[0-9]*;/listen \[::\]\:${mainsail_port};/" "${mainsail_nginx_cfg}"
+
+    require_service_restart="true"
+  fi
+
+  ### check for outdated fluidd config
+  if [[ -e ${fluidd_nginx_cfg} ]] && (( upstreams_webcams > fluidd_webcams )); then
+    status_msg "Outdated Fluidd config found! Updating ..."
+
+    sudo rm -f "${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}"
+    sudo sed -i "s/listen\s\[\:*\]\:[0-9]*;/listen \[::\]\:${fluidd_port};/" "${fluidd_nginx_cfg}"
+
+    require_service_restart="true"
+  fi
+
+  ### only restart nginx if configs were updated
+  if [[ ${require_service_restart} == "true" ]]; then
+    sudo systemctl restart nginx.service
+  fi
+
+  ok_msg "Done!"
+}
+
+function remove_conflicting_packages() {
+  local apache=${1} haproxy=${2}
+
+  ### disable services before removing them
+  disable_conflicting_packages "${apache}" "${haproxy}"
+
+  if [[ ${apache} == "true" ]]; then
+    status_msg "Removing Apache2 from system ..."
+    if sudo apt-get remove apache2 -y && sudo update-rc.d -f apache2 remove; then
+      ok_msg "Apache2 removed!"
+    else
+      error_msg "Removing Apache2 from system failed!"
+    fi
+  fi
+
+  if [[ ${haproxy} == "true" ]]; then
+    status_msg "Removing haproxy from system ..."
+    if sudo apt-get remove haproxy -y && sudo update-rc.d -f haproxy remove; then
+      ok_msg "Haproxy removed!"
+    else
+      error_msg "Removing Haproxy from system failed!"
+    fi
+  fi
+}
+
+function disable_conflicting_packages() {
+  local apache=${1} haproxy=${2}
+
+  if [[ ${apache} == "true" ]]; then
+    status_msg "Stopping Apache2 service ..."
+    if systemctl is-active apache2 -q; then
+      sudo systemctl stop apache2 && ok_msg "Service stopped!"
+    else
+      warn_msg "Apache2 service not active!"
+    fi
+
+    status_msg "Disabling Apache2 service ..."
+    if sudo systemctl disable apache2; then
+      ok_msg "Apache2 service disabled!"
+    else
+      error_msg "Disabling Apache2 service failed!"
+    fi
+  fi
+
+  if [[ ${haproxy} == "true" ]]; then
+    status_msg "Stopping Haproxy service ..."
+    if systemctl is-active haproxy -q; then
+      sudo systemctl stop haproxy && ok_msg "Service stopped!"
+    else
+      warn_msg "Haproxy service not active!"
+    fi
+
+    status_msg "Disabling Haproxy service ..."
+    if sudo systemctl disable haproxy; then
+      ok_msg "Haproxy service disabled!"
+    else
+      error_msg "Disabling Haproxy service failed!"
+    fi
+  fi
+}
+
+function detect_conflicting_packages() {
+  local apache="false" haproxy="false"
+
+  ### check system for an installed apache2 service
+  [[ $(dpkg -s apache2  2>/dev/null | grep "Status") = *\ installed ]] && apache="true"
+  ### check system for an installed haproxy service
+  [[ $(dpkg -s haproxy  2>/dev/null | grep "Status") = *\ installed ]] && haproxy="true"
+
+  #notify user about haproxy or apache2 services found and possible issues
+  if [[ ${haproxy} == "false" && ${apache} == "false" ]]; then
+    return
+  else
+    while true; do
+      echo
+      top_border
+      echo -e "| ${red}Conflicting package installations found:${white}              |"
+      [[ ${apache} == "true" ]] && \
+      echo -e "| ${red}● apache2${white}                                             |"
+      [[ ${haproxy} == "true" ]] && \
+      echo -e "| ${red}● haproxy${white}                                             |"
+      blank_line
+      echo -e "| Having those packages installed can lead to unwanted  |"
+      echo -e "| behaviour. It's recommended to remove those packages. |"
+      echo -e "|                                                       |"
+      echo -e "| ${green}1) Remove packages (recommend)${white}                        |"
+      echo -e "| 2) Disable only (may still cause issues)              |"
+      echo -e "| ${red}3) Skip this step (not recommended)${white}                   |"
+      bottom_border
+
+      local action
+      read -p "${cyan}###### Please choose:${white} " action
+      case "${action}" in
+        1)
+          echo -e "###### > Remove packages"
+          remove_conflicting_packages "${apache}" "${haproxy}"
+          break;;
+        2)
+          echo -e "###### > Disable only"
+          disable_conflicting_packages "${apache}" "${haproxy}"
+          break;;
+        3)
+          echo -e "###### > Skip"
+          break;;
+        *)
+          error_msg "Invalid command!";;
+      esac
+    done
+  fi
+}
+
+function set_nginx_cfg() {
+  local interface=${1}
+
+  if [[ ${SET_NGINX_CFG} == "true" ]]; then
+    #check for dependencies
+    local dep=(nginx)
+    dependency_check "${dep[@]}"
+
+    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
+      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
+    if [[ -e "/etc/nginx/sites-enabled/default" ]]; then
+      sudo rm "/etc/nginx/sites-enabled/default"
+    fi
+
+    #create symlink for own sites
+    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 homedir_perm
+  local exec_perms_count
+
+  homedir_perm=$(ls -ld "${HOME}")
+  exec_perms_count=$(echo "${homedir_perm}" | cut -d" " -f1 | grep -c "x")
+
+  if (( exec_perms_count < 3 )); then
+    status_msg "Granting NGINX the required permissions ..."
+    chmod og+x "${HOME}" && ok_msg "Done!"
+  fi
+
+  return
+}
+
+function read_listen_port() {
+  local port interface=${1}
+  port=$(grep listen "/etc/nginx/sites-enabled/${interface}" | head -1 | sed 's/^\s*//' | cut -d" " -f2 | cut -d";" -f1)
+  echo "${port}"
+}
+
+function detect_enabled_sites() {
+  MAINSAIL_ENABLED="false" FLUIDD_ENABLED="false"
+  #check if there is another UI config already installed and reads the port they are listening on
+  if [[ -e "/etc/nginx/sites-enabled/mainsail" ]]; then
+    SITE_ENABLED="true" && MAINSAIL_ENABLED="true"
+    MAINSAIL_PORT=$(read_listen_port "mainsail")
+  fi
+  if [[ -e "/etc/nginx/sites-enabled/fluidd" ]]; then
+    SITE_ENABLED="true" && FLUIDD_ENABLED="true"
+    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

@@ -0,0 +1,416 @@
+#!/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 OCTOPRINT ===============#
+#=================================================#
+
+function octoprint_systemd() {
+  local services
+  services=$(find "${SYSTEMD}" -maxdepth 1 -regextype posix-extended -regex "${SYSTEMD}/octoprint(-[0-9a-zA-Z]+)?.service" | sort)
+  echo "${services}"
+}
+
+function octoprint_setup_dialog() {
+  status_msg "Initializing OctoPrint installation ..."
+
+  local klipper_services
+  klipper_services=$(klipper_systemd)
+  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
+
+  local octoprint_count
+  if (( klipper_count == 1 )); then
+    ok_msg "Klipper installation found!\n"
+    octoprint_count=1
+
+  elif (( klipper_count > 1 )); then
+    top_border
+    printf "|${green}%-55s${white}|\n" " ${klipper_count} Klipper instances found!"
+    for name in "${klipper_names[@]}"; do
+      printf "|${cyan}%-57s${white}|\n" " ● ${name}"
+    done
+    blank_line
+    echo -e "| The setup will apply the same names to OctoPrint!     |"
+    blank_line
+    echo -e "| Please select the number of OctoPrint instances to    |"
+    echo -e "| install. Usually one OctoPrint instance per Klipper   |"
+    echo -e "| instance is required, but you may not install more    |"
+    echo -e "| OctoPrint instances than available Klipper instances. |"
+    bottom_border
+
+    local re="^[1-9][0-9]*$"
+    while [[ ! ${octoprint_count} =~ ${re} || ${octoprint_count} -gt ${klipper_count} ]]; do
+      read -p "${cyan}###### Number of OctoPrint instances to set up:${white} " -i "${klipper_count}" -e octoprint_count
+      ### break if input is valid
+      [[ ${octoprint_count} =~ ${re} ]] && break
+      ### conditional error messages
+      [[ ! ${octoprint_count} =~ ${re} ]] && error_msg "Input not a number"
+      (( octoprint_count > klipper_count )) && error_msg "Number of OctoPrint instances larger than existing Klipper instances"
+    done && select_msg "${octoprint_count}"
+
+  else
+    log_error "Internal error. klipper_count of '${klipper_count}' not equal or grather than one!"
+    return 1
+  fi
+
+  user_input+=("${octoprint_count}")
+
+  ### confirm instance amount
+  local yn
+  while true; do
+    (( octoprint_count == 1 )) && local question="Install OctoPrint?"
+    (( octoprint_count > 1 )) && local question="Install ${octoprint_count} OctoPrint 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 OctoPrint setup ...\n"
+        return;;
+      *)
+        error_msg "Invalid Input!";;
+    esac
+  done
+
+  ### write existing klipper names into user_input array to use them as names for octoprint
+  if (( klipper_count > 1 )); then
+    for name in "${klipper_names[@]}"; do
+      user_input+=("${name}")
+    done
+  fi
+
+  (( octoprint_count > 1 )) && status_msg "Installing ${octoprint_count} OctoPrint instances ..."
+  (( octoprint_count == 1 )) && status_msg "Installing OctoPrint ..."
+  octoprint_setup "${user_input[@]}"
+}
+
+function octoprint_setup() {
+  local instance_arr=("${@}")
+  ### check and install all dependencies
+  local dep=(
+    git
+    wget
+    python3-pip
+    python3-dev
+    libyaml-dev
+    build-essential
+    python3-setuptools
+    python3-virtualenv
+  )
+  dependency_check "${dep[@]}"
+
+  ### step 1: check for tty and dialout usergroups and add reboot permissions
+  check_usergroups
+  add_reboot_permission
+
+  ### step 2: install octoprint
+  install_octoprint "${instance_arr[@]}"
+
+  ### step 3: set up service
+  create_octoprint_service "${instance_arr[@]}"
+
+  ### step 4: enable and start all instances
+  do_action_service "enable" "octoprint"
+  do_action_service "start" "octoprint"
+
+  ### confirm message
+  local confirm=""
+  (( instance_arr[0] == 1 )) && confirm="OctoPrint has been set up!"
+  (( instance_arr[0] > 1 )) && confirm="${instance_arr[0]} OctoPrint instances have been set up!"
+  print_confirm "${confirm}" && print_op_ip_list "${instance_arr[0]}" && return
+}
+
+function install_octoprint() {
+
+  function install_octoprint_python_env() {
+    local tmp="${1}"
+    ### create and activate the virtualenv
+    status_msg "Installing python virtual environment..."
+
+    if [[ ! -d ${tmp} ]]; then
+      mkdir -p "${tmp}"
+    else
+      error_msg "Cannot create temporary directory in ${HOME}!"
+      error_msg "Folder 'TMP_OCTO_ENV' exists and may not be empty!"
+      error_msg "Please remove/rename that folder and start again."
+      return 1
+    fi
+
+    cd "${tmp}"
+
+    if virtualenv --python=python3 venv; then
+      ### activate virtualenv
+      source venv/bin/activate
+      pip install pip --upgrade
+      pip install --no-cache-dir octoprint
+      ### leave virtualenv
+      deactivate
+    else
+      log_error "failure while creating python3 OctoPrint env"
+      error_msg "Creation of OctoPrint virtualenv failed!"
+      exit 1
+    fi
+
+    cd "${HOME}"
+  }
+
+  local input=("${@}")
+  local octoprint_count=${input[0]} && unset "input[0]"
+  local names=("${input[@]}") && unset "input[@]"
+  local j=0 octo_env
+  local tmp="${HOME}/TMP_OCTO_ENV"
+
+  ### handle single instance installs
+  if (( octoprint_count == 1 )); then
+    if install_octoprint_python_env "${tmp}"; then
+      status_msg "Installing OctoPrint ..."
+      octo_env="${HOME}/OctoPrint"
+
+      ### rename the temporary directory to the correct name
+      [[ -d ${octo_env} ]] && rm -rf "${octo_env}"
+      mv "${tmp}" "${octo_env}"
+
+      ### replace the temporary directory name with the actual one in ${octo_env}/venv/bin/python/octoprint
+      sed -i "s|${tmp}|${octo_env}|" "${octo_env}/venv/bin/octoprint"
+    else
+      error_msg "OctoPrint installation failed!"
+      return 1
+    fi
+  fi
+
+  ### handle multi instance installs
+  if (( octoprint_count > 1 )); then
+    if install_octoprint_python_env "${tmp}"; then
+      for (( i=1; i <= octoprint_count; i++ )); do
+        status_msg "Installing OctoPrint instance ${i}(${names[${j}]}) ..."
+        octo_env="${HOME}/OctoPrint_${names[${j}]}"
+
+        ### rename the temporary directory to the correct name
+        [[ -d ${octo_env} ]] && rm -rf "${octo_env}"
+        cp -r "${tmp}" "${octo_env}"
+
+        ### replace the temporary directory name with the actual one in ${octo_env}/venv/bin/python/octoprint
+        sed -i "s|${tmp}|${octo_env}|" "${octo_env}/venv/bin/octoprint"
+        j=$(( j + 1 ))
+      done && rm -rf "${tmp}"
+    else
+      error_msg "OctoPrint installation failed!"
+      return 1
+    fi
+  fi
+}
+
+function create_octoprint_service() {
+  local input=("${@}")
+  local octoprint_count=${input[0]} && unset "input[0]"
+  local names=("${input[@]}") && unset "input[@]"
+  local j=0 port=5000
+  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"
+      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}]}"
+      printer="${printer_data}/comms/klippy.serial"
+      config_yaml="${basedir}/config.yaml"
+      restart_cmd="sudo service octoprint-${names[${j}]} restart"
+    fi
+
+    (( octoprint_count == 1 )) && status_msg "Creating OctoPrint Service ..."
+    (( octoprint_count > 1 )) && status_msg "Creating OctoPrint Service ${i}(${names[${j}]}) ..."
+
+    sudo /bin/sh -c "cat > ${service}" << OCTOPRINT
+[Unit]
+Description=Starts OctoPrint on startup
+After=network-online.target
+Wants=network-online.target
+
+[Service]
+Environment="LC_ALL=C.UTF-8"
+Environment="LANG=C.UTF-8"
+Type=simple
+User=${USER}
+ExecStart=${octo_env}/venv/bin/octoprint --basedir ${basedir} --config ${config_yaml} --port=${port} serve
+
+[Install]
+WantedBy=multi-user.target
+OCTOPRINT
+
+    port=$(( port + 1 ))
+    j=$(( j + 1 ))
+    ok_msg "Ok!"
+
+    ### create config.yaml
+    if [[ ! -f ${basedir}/config.yaml ]]; then
+      [[ ! -d ${basedir} ]] && mkdir "${basedir}"
+
+      (( octoprint_count == 1 )) && status_msg "Creating config.yaml ..."
+      (( octoprint_count > 1 )) && status_msg "Creating config.yaml for instance ${i}(${names[${j}]}) ..."
+
+      /bin/sh -c "cat > ${basedir}/config.yaml" << CONFIGYAML
+serial:
+    additionalPorts:
+    - ${printer}
+    disconnectOnErrors: false
+    port: ${printer}
+server:
+    commands:
+        serverRestartCommand: ${restart_cmd}
+        systemRestartCommand: sudo shutdown -r now
+        systemShutdownCommand: sudo shutdown -h now
+CONFIGYAML
+      ok_msg "Ok!"
+    fi
+  done
+}
+
+function add_reboot_permission() {
+  #create a backup if file already exists
+  if [[ -f /etc/sudoers.d/octoprint-shutdown ]]; then
+    sudo mv /etc/sudoers.d/octoprint-shutdown /etc/sudoers.d/octoprint-shutdown.old
+  fi
+
+  #create new permission file
+  status_msg "Add reboot permission to user '${USER}' ..."
+  cd "${HOME}" && echo "${USER} ALL=NOPASSWD: /sbin/shutdown" > octoprint-shutdown
+  sudo chown 0 octoprint-shutdown
+  sudo mv octoprint-shutdown /etc/sudoers.d/octoprint-shutdown
+  ok_msg "Permission set!"
+}
+
+function print_op_ip_list() {
+  local ip octoprint_count="${1}" port=5000
+  ip=$(hostname -I | cut -d" " -f1)
+
+  for (( i=1; i <= octoprint_count; i++ )); do
+    echo -e "   ${cyan}● Instance ${i}:${white} ${ip}:${port}"
+    port=$(( port + 1 ))
+  done && echo
+}
+
+#=================================================#
+#=============== REMOVE OCTOPRINT ================#
+#=================================================#
+
+function remove_octoprint_service() {
+  [[ -z $(octoprint_systemd) ]] && return
+
+  ###remove all octoprint services
+  status_msg "Removing OctoPrint Systemd Services ..."
+
+  for service in $(octoprint_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
+}
+
+function remove_octoprint_sudoers() {
+  [[ ! -f /etc/sudoers.d/octoprint-shutdown ]] && return
+
+  ### remove sudoers file
+  sudo rm -f /etc/sudoers.d/octoprint-shutdown
+}
+
+function remove_octoprint_env() {
+  local files
+  files=$(find "${HOME}" -maxdepth 1 -regextype posix-extended -regex "${HOME}/OctoPrint(_[0-9a-zA-Z]+)?" | 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_octoprint_dir() {
+  local files
+  files=$(find "${HOME}" -maxdepth 1 -regextype posix-extended -regex "${HOME}/.octoprint(_[0-9a-zA-Z]+)?" | 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_octoprint() {
+  remove_octoprint_service
+  remove_octoprint_sudoers
+  remove_octoprint_env
+  remove_octoprint_dir
+
+  local confirm="OctoPrint was successfully removed!"
+
+  print_confirm "${confirm}" && return
+}
+
+#=================================================#
+#=============== OCTOPRINT STATUS ================#
+#=================================================#
+
+function get_octoprint_status() {
+  local sf_count env_count dir_count status
+  sf_count="$(octoprint_systemd | wc -w)"
+  env_count=$(find "${HOME}" -maxdepth 1 -regextype posix-extended -regex "${HOME}/OctoPrint(_[0-9a-zA-Z]+)?" | wc -w)
+  dir_count=$(find "${HOME}" -maxdepth 1 -regextype posix-extended -regex "${HOME}/.octoprint(_[0-9a-zA-Z]+)?" | wc -w)
+
+  if (( sf_count == 0 )) && (( env_count == 0 )) && (( dir_count == 0 )); then
+    status="Not installed!"
+  elif (( sf_count == env_count )) && (( sf_count == dir_count )); then
+    status="Installed: ${sf_count}"
+  else
+    status="Incomplete!"
+  fi
+
+  echo "${status}"
+}

scripts/pretty_gcode.sh

@@ -0,0 +1,127 @@
+#!/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 PGC ==================#
+#=================================================#
+
+function install_pgc_for_klipper() {
+  local pgconfsrc="${PGC_DIR}/pgcode.local.conf"
+  local pgconf="/etc/nginx/sites-available/pgcode.local.conf"
+  local pgconfsl="/etc/nginx/sites-enabled/pgcode.local.conf"
+  local pgc_uri pgc_custom_port pgc_default_port="7136"
+
+  status_msg "Installing PrettyGCode for Klipper ..."
+  echo -e "${cyan}\n###### On which port should PrettyGCode run? (Default: ${pgc_default_port})${white} "
+  read -e -p "${cyan}###### Port:${white} " -i "${pgc_default_port}" pgc_custom_port
+
+  ### check nginx dependency
+  local dep=(nginx)
+  dependency_check "${dep[@]}"
+
+  [[ -d ${PGC_DIR} ]] && rm -rf "${PGC_DIR}"
+
+  cd "${HOME}" || exit 1
+  if ! git clone "${PGC_REPO}" "${PGC_DIR}"; then
+    print_error "Cloning PrettyGCode for Klipper from\n ${PGC_REPO}\n failed!"
+    exit 1
+  fi
+
+  sudo cp "${pgconfsrc}" "${pgconf}"
+  sudo sed -i "s|/home/pi/pgcode;|${HOME}/pgcode;|" "${pgconf}"
+
+  ### replace default port
+  if (( pgc_custom_port != pgc_default_port )); then
+    sudo sed -i "s|listen ${pgc_default_port};|listen ${pgc_custom_port};|" "${pgconf}"
+    sudo sed -i "s|listen \[::\]:${pgc_default_port};|listen \[::\]:${pgc_custom_port};|" "${pgconf}"
+  fi
+
+  [[ ! -L ${pgconfsl} ]] && sudo ln -s "${pgconf}" "${pgconfsl}"
+  sudo systemctl restart nginx
+
+  pgc_uri="http://$(hostname -I | cut -d" " -f1):${pgc_custom_port}"
+  echo -e "${cyan}\n● Accessible via:${white} ${pgc_uri}"
+  ok_msg "PrettyGCode for Klipper installed!\n"
+}
+
+#=================================================#
+#=================== REMOVE PGC ==================#
+#=================================================#
+
+function remove_prettygcode() {
+  local pgconf="/etc/nginx/sites-available/pgcode.local.conf"
+  local pgconfsl="/etc/nginx/sites-enabled/pgcode.local.conf"
+
+  if [[ -d ${PGC_DIR} || -f ${pgconf} || -L ${pgconfsl} ]]; then
+    status_msg "Removing PrettyGCode for Klipper ..."
+    rm -rf "${PGC_DIR}"
+    sudo rm -f "${pgconf}"
+    sudo rm -f "${pgconfsl}"
+    sudo systemctl restart nginx
+    print_confirm "PrettyGCode for Klipper successfully removed!"
+  else
+    print_error "PrettyGCode for Klipper not found!\n Skipping..."
+  fi
+}
+
+#=================================================#
+#=================== UPDATE PGC ==================#
+#=================================================#
+
+function update_pgc_for_klipper() {
+  [[ ! -d ${PGC_DIR} ]] && return
+
+  status_msg "Updating PrettyGCode for Klipper ..."
+  cd "${PGC_DIR}" && git pull
+  ok_msg "Update complete!"
+}
+
+#=================================================#
+#=================== PGC STATUS ==================#
+#=================================================#
+
+function get_local_prettygcode_commit() {
+  local commit
+
+  [[ ! -d ${PGC_DIR} || ! -d "${PGC_DIR}/.git" ]] && return
+  cd "${PGC_DIR}"
+  commit="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
+  echo "${commit}"
+}
+
+function get_remote_prettygcode_commit() {
+  local commit
+
+  [[ ! -d ${PGC_DIR} || ! -d "${PGC_DIR}/.git" ]] && return
+  cd "${PGC_DIR}" && git fetch origin -q
+  commit=$(git describe origin/main --always --tags | cut -d "-" -f 1,2)
+  echo "${commit}"
+}
+
+function compare_prettygcode_versions() {
+  local versions local_ver remote_ver
+  local_ver="$(get_local_prettygcode_commit)"
+  remote_ver="$(get_remote_prettygcode_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 "pgc_for_klipper"
+  else
+    versions="${green}$(printf " %-14s" "${local_ver}")${white}"
+    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
+  fi
+
+  echo "${versions}"
+}

scripts/remove.sh

@@ -1,145 +0,0 @@
-remove_klipper(){
-  data_arr=(
-  /etc/init.d/klipper
-  /etc/default/klipper
-  $KLIPPER_DIR
-  $KLIPPY_ENV_DIR
-  ${HOME}/klippy.log
-  )
-  print_error "Klipper" && data_count=()
-  if [ "$ERROR_MSG" = "" ]; then
-    stop_klipper
-    if [[ -e /etc/init.d/klipper || -e /etc/default/klipper ]]; then
-      status_msg "Removing klipper service ..."
-      sudo update-rc.d -f klipper remove
-      sudo rm -rf /etc/init.d/klipper /etc/default/klipper && ok_msg "Klipper service removed!"
-    fi
-    if [[ -d $KLIPPER_DIR || -d $KLIPPY_ENV_DIR ]]; then
-      status_msg "Removing klipper and klippy-env diretory ..."
-      rm -rf $KLIPPER_DIR $KLIPPY_ENV_DIR && ok_msg "Directories removed!"
-    fi
-    if [[ -L ${HOME}/klippy.log || -e /tmp/klippy.log ]]; then
-      status_msg "Removing klippy.log symlink ..."
-      rm -rf ${HOME}/klippy.log /tmp/klippy.log && ok_msg "Symlink removed!"
-    fi
-    ok_msg "Klipper successfully removed!"
-  fi
-}
-
-remove_dwc2(){
-  data_arr=(
-  $DWC2FK_DIR
-  $TORNADO_DIR1
-  $TORNADO_DIR2
-  $WEB_DWC2
-  $DWC2_DIR
-  )
-  print_error "DWC2-for-Klipper &\n DWC2 Web UI" && data_count=()
-  if [ "$ERROR_MSG" = "" ]; then
-    if [ -d $DWC2FK_DIR ]; then
-      status_msg "Removing dwc2-for-klipper directory ..."
-      rm -rf $DWC2FK_DIR && ok_msg "Directory removed!"
-    fi
-    if [ -d $TORNADO_DIR1 ]; then
-      status_msg "Removing tornado from klippy-env ..."
-      rm -rf $TORNADO_DIR1 $TORNADO_DIR2 && ok_msg "Tornado removed!"
-    fi
-    if [ -e $WEB_DWC2 ]; then
-      status_msg "Removing web_dwc2.py symlink from klippy ..."
-      rm -rf $WEB_DWC2 && ok_msg "File removed!"
-    fi
-    if [ -d $DWC2_DIR ]; then
-      status_msg "Removing dwc2 directory ..."
-      rm -rf $DWC2_DIR && ok_msg "Directory removed!"
-    fi
-    ok_msg "DWC2-for-Klipper & DWC2 Web UI successfully removed!"
-  fi
-}
-
-remove_mainsail(){
-  data_arr=(
-  $MAINSAIL_SERVICE1
-  $MAINSAIL_SERVICE2
-  $MAINSAIL_DIR
-  ${HOME}/moonraker.log
-  ${HOME}/.klippy_api_key
-  ${HOME}/.moonraker_api_key
-  ${HOME}/moonraker-env
-  /etc/nginx/sites-available/mainsail
-  /etc/nginx/sites-enabled/mainsail
-  /etc/init.d/nginx
-  /etc/default/nginx
-  )
-  print_error "Mainsail" && data_count=()
-  if [ "$ERROR_MSG" = "" ]; then
-    stop_moonraker
-    #remove moonraker services
-    if [[ -e /etc/init.d/moonraker || -e /etc/default/moonraker ]]; then
-      status_msg "Removing moonraker service ..."
-      sudo update-rc.d -f moonraker remove
-      sudo rm -rf /etc/init.d/moonraker /etc/default/moonraker && ok_msg "Moonraker service removed!"
-    fi
-    #remove mainsail dir
-    if [ -d $MAINSAIL_DIR ]; then
-      status_msg "Removing mainsail directory ..."
-      rm -rf $MAINSAIL_DIR && ok_msg "Directory removed!"
-    fi
-    #remove moonraker-env
-    if [ -d ${HOME}/moonraker-env ]; then
-      status_msg "Removing moonraker virtualenv ..."
-      rm -rf ${HOME}/moonraker-env && ok_msg "Directory removed!"
-    fi
-    #remove moonraker.log symlink
-    if [[ -L ${HOME}/moonraker.log || -e /tmp/moonraker.log ]]; then
-      status_msg "Removing moonraker.log symlink ..."
-      rm -rf ${HOME}/moonraker.log /tmp/moonraker.log && ok_msg "Symlink removed!"
-    fi
-    #remove mainsail cfg
-    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!"
-    fi
-    #remove mainsail symlink
-    if [ -L /etc/nginx/sites-enabled/mainsail ]; then
-      status_msg "Removing mainsail symlink for nginx ..."
-      sudo rm /etc/nginx/sites-enabled/mainsail && ok_msg "File removed!"
-    fi
-    #remove legacy api key
-    if [ -e ${HOME}/.klippy_api_key ]; then
-      status_msg "Removing legacy API Key ..."
-      rm ${HOME}/.klippy_api_key && ok_msg "Done!"
-    fi
-    #remove api key
-    if [ -e ${HOME}/.moonraker_api_key ]; then
-      status_msg "Removing API Key ..."
-      rm ${HOME}/.moonraker_api_key && ok_msg "Done!"
-    fi
-    remove_nginx
-    ok_msg "Mainsail successfully removed!"
-  fi
-}
-
-remove_nginx(){
-  #ask for complete removal of nginx if installed
-  if [[ $(dpkg-query -f'${Status}' --show nginx 2>/dev/null) = *\ installed ]]  ; then
-    while true; do
-      echo
-      read -p "Do you want to completely remove (purge) nginx? (Y/n): " yn
-      case "$yn" in
-        Y|y|Yes|yes|"")
-        status_msg "Stopping and removing nginx service ..."
-        if [ -e /etc/init.d/nginx ]; then
-          sudo /etc/init.d/nginx stop && ok_msg "Nginx service stopped!"
-          sudo rm /etc/init.d/nginx && ok_msg "Nginx service removed!"
-        fi
-        if [ -e /etc/default/nginx ]; then
-          sudo rm /etc/default/nginx
-        fi
-        status_msg "Purging nginx from system ..."
-        sudo apt-get purge nginx nginx-common -y && ok_msg "Nginx removed!"
-        break;;
-        N|n|No|no) break;;
-      esac
-    done
-  fi
-}

scripts/rollback.sh

@@ -0,0 +1,85 @@
+#!/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
+
+function rollback_menu() {
+  top_border
+  echo -e "|     $(title_msg "~~~~~~~~~~~~~ [ Rollback Menu ] ~~~~~~~~~~~~~")     |"
+  hr
+  echo -e "| If serious errors occured after updating Klipper or   |"
+  echo -e "| Moonraker, you can use this menu to try and reset the |"
+  echo -e "| repository to an earlier state.                       |"
+  hr
+  echo -e "| 1) Rollback Klipper                                   |"
+  echo -e "| 2) Rollback Moonraker                                 |"
+  back_footer
+
+  local action
+  while true; do
+    read -p "${cyan}###### Perform action:${white} " action
+    case "${action}" in
+      1)
+        select_msg "Klipper"
+        rollback_component "klipper"
+        break;;
+      2)
+        select_msg "Moonraker"
+        rollback_component "moonraker"
+        break;;
+      B|b)
+        clear; advanced_menu; break;;
+      *)
+        error_msg "Invalid command!";;
+    esac
+  done
+}
+
+function rollback_component() {
+  local component=${1}
+
+  if [[ ! -d "${HOME}/${component}" ]]; then
+    print_error "Rollback not possible! Missing installation?"
+    return
+  fi
+
+  echo
+  top_border
+  echo -e "| Please select how many commits you want to revert.    |"
+  echo -e "| Consider using the information provided by the GitHub |"
+  echo -e "| commit history to decide how many commits to revert.  |"
+  blank_line
+  echo -e "| ${red}Warning:${white}                                              |"
+  echo -e "| ${red}Do not proceed if you are currently in the progress${white}   |"
+  echo -e "| ${red}of printing! Proceeding WILL terminate that print!${white}    |"
+  back_footer
+
+  local count
+  while true; do
+    read -p "${cyan}###### Revert this amount of commits:${white} " count
+    if [[ -n ${count} ]] && (( count > 0 )); then
+      status_msg "Revert ${component^} by ${count} commits ..."
+      cd "${HOME}/${component}"
+      if git reset --hard HEAD~"${count}"; then
+        do_action_service "restart" "${component}"
+        print_confirm "${component^} was successfully reset!"
+      else
+        print_error "Reverting ${component^} failed! Please see the console output above."
+      fi
+      break
+    elif [[ ${count} == "B" || ${count} == "b" ]]; then
+      clear && print_header && break
+    else
+      error_msg "Invalid command!"
+    fi
+  done
+  rollback_menu
+}

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/status.sh

@@ -1,226 +0,0 @@
-klipper_status(){
-  kcount=0
-  klipper_data=(
-    $KLIPPER_DIR
-    $KLIPPY_ENV_DIR
-    $KLIPPER_SERVICE1
-    $KLIPPER_SERVICE2
-  )
-  #count+1 for each found data-item from array
-  for kd in "${klipper_data[@]}"
-  do
-    if [ -e $kd ]; then
-      kcount=$(expr $kcount + 1)
-    fi
-  done
-  if [ "$kcount" == "${#klipper_data[*]}" ]; then
-    KLIPPER_STATUS="${green}Installed!${default}         "
-  elif [ "$kcount" == 0 ]; then
-    KLIPPER_STATUS="${red}Not installed!${default}     "
-  else
-    KLIPPER_STATUS="${yellow}Incomplete!${default}        "
-  fi
-}
-
-dwc2_status(){
-  dcount=0
-  dwc2_data=(
-    $DWC2FK_DIR
-    $WEB_DWC2
-    $DWC2_DIR
-    $TORNADO_DIR1
-    $TORNADO_DIR2
-  )
-  #count+1 for each found data-item from array
-  for dd in "${dwc2_data[@]}"
-  do
-    if [ -e $dd ]; then
-      dcount=$(expr $dcount + 1)
-    fi
-  done
-  if [ "$dcount" == "${#dwc2_data[*]}" ]; then
-    DWC2_STATUS="${green}Installed!${default}         "
-  elif [ "$dcount" == 0 ]; then
-    DWC2_STATUS="${red}Not installed!${default}     "
-  else
-    DWC2_STATUS="${yellow}Incomplete!${default}        "
-  fi
-}
-
-mainsail_status(){
-  mcount=0
-  mainsail_data=(
-    $MAINSAIL_SERVICE1
-    $MAINSAIL_SERVICE2
-    $MAINSAIL_DIR
-    #${HOME}/.klippy_api_key
-    #${HOME}/.moonraker_api_key
-    #${HOME}/moonraker-env
-    /etc/nginx/sites-available/mainsail
-    /etc/nginx/sites-enabled/mainsail
-    /etc/init.d/nginx
-    /etc/default/nginx
-  )
-  #count+1 for each found data-item from array
-  for md in "${mainsail_data[@]}"
-  do
-    if [ -e $md ]; then
-      mcount=$(expr $mcount + 1)
-    fi
-  done
-  if [ "$mcount" == "${#mainsail_data[*]}" ]; then
-    MAINSAIL_STATUS="${green}Installed!${default}         "
-  elif [ "$mcount" == 0 ]; then
-    MAINSAIL_STATUS="${red}Not installed!${default}     "
-  else
-    MAINSAIL_STATUS="${yellow}Incomplete!${default}        "
-  fi
-}
-
-read_branch(){
-  if [ -d $KLIPPER_DIR ] && [ -d $KLIPPER_DIR/.git ]; then
-    cd $KLIPPER_DIR
-    GET_BRANCH=$(git branch -a | head -1 | cut -d " " -f5 | cut -d ")" -f1)
-    #if reading the branch gives an empty string
-    #we are on non-detached HEAD state on origin/master
-    #and need to set GET_BRANCH to make a non-empty string
-    if [ -z $GET_BRANCH ]; then
-      GET_BRANCH="origin/master"
-    fi
-  else
-    GET_BRANCH=""
-  fi
-}
-
-print_branch(){
-  read_branch
-  if [ "$GET_BRANCH" == "origin/master" ]; then
-    PRINT_BRANCH="${cyan}$GET_BRANCH${default}      "
-  elif [ "$GET_BRANCH" == "dmbutyugin/scurve-shaping" ]; then
-    PRINT_BRANCH="${cyan}scurve-shaping${default}     "
-  elif [ "$GET_BRANCH" == "dmbutyugin/scurve-smoothing" ]; then
-    PRINT_BRANCH="${cyan}scurve-smoothing${default}   "
-  elif [ "$GET_BRANCH" == "Arksine/work-web_server-20200131" ]; then
-    PRINT_BRANCH="${cyan}moonraker${default}          "
-  elif [ "$GET_BRANCH" == "Arksine/dev-moonraker-testing" ]; then
-    PRINT_BRANCH="${cyan}dev-moonraker${default}      "
-  else
-    PRINT_BRANCH="${red}----${default}               "
-  fi
-}
-
-read_local_klipper_commit(){
-  if [ -d $KLIPPER_DIR ] && [ -d $KLIPPER_DIR/.git ]; then
-    cd $KLIPPER_DIR
-    LOCAL_COMMIT=$(git rev-parse --short=8 HEAD)
-  else
-    LOCAL_COMMIT=""
-  fi
-}
-
-read_remote_klipper_commit(){
-  read_branch
-  if [ ! -z $GET_BRANCH ];then
-    REMOTE_COMMIT=$(git rev-parse --short=8 $GET_BRANCH)
-  else
-    REMOTE_COMMIT=""
-  fi
-}
-
-compare_klipper_versions(){
-  read_local_klipper_commit
-  read_remote_klipper_commit
-  #echo "Local: $LOCAL_COMMIT"
-  #echo "Remote: $REMOTE_COMMIT"
-  if [ "$LOCAL_COMMIT" != "$REMOTE_COMMIT" ]; then
-    LOCAL_COMMIT="${yellow}$LOCAL_COMMIT${default}"
-    REMOTE_COMMIT="${green}$REMOTE_COMMIT${default}"
-  else
-    LOCAL_COMMIT="${green}$LOCAL_COMMIT${default}"
-    REMOTE_COMMIT="${green}$REMOTE_COMMIT${default}"
-  fi
-}
-
-read_dwc2fk_versions(){
-  if [ -d $DWC2FK_DIR ] && [ -d $DWC2FK_DIR/.git ]; then
-    cd $DWC2FK_DIR
-    LOCAL_DWC2FK_COMMIT=$(git rev-parse --short=8 HEAD)
-    REMOTE_DWC2FK_COMMIT=$(git rev-parse --short=8 origin/master)
-  else
-    LOCAL_DWC2FK_COMMIT=""
-    REMOTE_DWC2FK_COMMIT=""
-  fi
-}
-
-compare_dwc2fk_versions(){
-  read_dwc2fk_versions
-  #echo "Local: $LOCAL_DWC2FK_COMMIT"
-  #echo "Remote: $REMOTE_DWC2FK_COMMIT"
-  if [ "$LOCAL_DWC2FK_COMMIT" != "$REMOTE_DWC2FK_COMMIT" ]; then
-    LOCAL_DWC2FK_COMMIT="${yellow}$LOCAL_DWC2FK_COMMIT${default}"
-    REMOTE_DWC2FK_COMMIT="${green}$REMOTE_DWC2FK_COMMIT${default}"
-  else
-    LOCAL_DWC2FK_COMMIT="${green}$LOCAL_DWC2FK_COMMIT${default}"
-    REMOTE_DWC2FK_COMMIT="${green}$REMOTE_DWC2FK_COMMIT${default}"
-  fi
-}
-
-read_local_dwc2_version(){
-  if [ -e $DWC2_DIR/web/version ]; then
-    DWC2_LOCAL_VER=$(head -n 1 $DWC2_DIR/web/version)
-  else
-    DWC2_LOCAL_VER=""
-  fi
-}
-
-read_remote_dwc2_version(){
-  DWC2_REMOTE_VER=$(curl -s https://api.github.com/repositories/28820678/releases/latest | grep tag_name | cut -d'"' -f4)
-}
-
-compare_dwc2_versions(){
-  read_local_dwc2_version
-  read_remote_dwc2_version
-  #echo "Local: $DWC2_LOCAL_VER"
-  #echo "Remote: $DWC2_REMOTE_VER"
-  if [ "$DWC2_LOCAL_VER" != "$DWC2_REMOTE_VER" ]; then
-    DWC2_LOCAL_VER="${yellow}$DWC2_LOCAL_VER${default}"
-    DWC2_REMOTE_VER="${green}$DWC2_REMOTE_VER${default}"
-  else
-    DWC2_LOCAL_VER="${green}$DWC2_LOCAL_VER${default}"
-    DWC2_REMOTE_VER="${green}$DWC2_REMOTE_VER${default}"
-  fi
-}
-
-read_local_mainsail_version(){
-  if [ -e $MAINSAIL_DIR/version ]; then
-    MAINSAIL_LOCAL_VER=$(head -n 1 $MAINSAIL_DIR/version)
-  else
-    MAINSAIL_LOCAL_VER=""
-  fi
-}
-
-read_remote_mainsail_version(){
-  get_mainsail_ver
-  MAINSAIL_REMOTE_VER=$MAINSAIL_VERSION
-}
-
-compare_mainsail_versions(){
-  read_local_mainsail_version
-  read_remote_mainsail_version
-  #echo "Local: $MAINSAIL_LOCAL_VER"
-  #echo "Remote: $MAINSAIL_REMOTE_VER"
-  if [ "$MAINSAIL_LOCAL_VER" != "$MAINSAIL_REMOTE_VER" ]; then
-    MAINSAIL_LOCAL_VER="${yellow}$MAINSAIL_LOCAL_VER${default}"
-    MAINSAIL_REMOTE_VER="${green}$MAINSAIL_REMOTE_VER${default}"
-  else
-    MAINSAIL_LOCAL_VER="${green}$MAINSAIL_LOCAL_VER${default}"
-    MAINSAIL_REMOTE_VER="${green}$MAINSAIL_REMOTE_VER${default}"
-  fi
-}
-
-ui_print_versions(){
-  compare_klipper_versions
-  compare_dwc2fk_versions
-  compare_dwc2_versions
-  compare_mainsail_versions
-}

scripts/switch_branch.sh

@@ -1,41 +0,0 @@
-switch_to_origin(){
-  cd $KLIPPER_DIR
-  status_msg "Switching...Please wait ..."; echo
-  git fetch origin -q && git checkout origin/master -q
-}
-
-switch_to_scurve_shaping(){
-  cd $KLIPPER_DIR
-  status_msg "Switching...Please wait ..."; echo
-  if ! git remote | grep dmbutyugin -q; then
-    git remote add dmbutyugin $DMBUTYUGIN_REPO
-  fi
-  git fetch dmbutyugin -q && git checkout $BRANCH_SCURVE_SHAPING -q
-}
-
-switch_to_scurve_smoothing(){
-  cd $KLIPPER_DIR
-  status_msg "Switching...Please wait ..."; echo
-  if ! git remote | grep dmbutyugin -q; then
-    git remote add dmbutyugin $DMBUTYUGIN_REPO
-  fi
-  git fetch dmbutyugin -q && git checkout $BRANCH_SCURVE_SMOOTHING -q
-}
-
-switch_to_moonraker(){
-  cd $KLIPPER_DIR
-  status_msg "Switching...Please wait ..."; echo
-  if ! git remote | grep Arksine -q; then
-    git remote add Arksine $ARKSINE_REPO
-  fi
-  git fetch Arksine -q && git checkout $BRANCH_MOONRAKER -q
-}
-
-switch_to_dev_moonraker(){
-  cd $KLIPPER_DIR
-  status_msg "Switching...Please wait ..."; echo
-  if ! git remote | grep Arksine -q; then
-    git remote add Arksine $ARKSINE_REPO
-  fi
-  git fetch Arksine -q && git checkout $BRANCH_DEV_MOONRAKER -q
-}

scripts/switch_klipper_repo.sh

@@ -0,0 +1,144 @@
+#!/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
+
+function change_klipper_repo_menu() {
+  local repo_file="${KIAUH_SRCDIR}/klipper_repos.txt"
+  local repo branch repos=() branches=()
+
+  if [[ ! -f ${repo_file} ]]; then
+    print_error "File not found:\n '${KIAUH_SRCDIR}/klipper_repos.txt'"
+    return
+  fi
+
+  ### generate the repolist from the klipper_repos.txt textfile
+  while IFS="," read -r repo branch; do
+    repo=$(echo "${repo}" | sed -r "s/^http(s)?:\/\/github.com\///" | sed "s/\.git$//" )
+    repos+=("${repo}")
+    ### if branch is not given, default to 'master'
+    [[ -z ${branch} ]] && branch="master"
+    branches+=("${branch}")
+  done < <(grep -E "^[^#]" "${repo_file}")
+
+  top_border
+  echo -e "|     ~~~~~~~~ [ Set custom Klipper repo ] ~~~~~~~~     | "
+  hr
+  blank_line
+  ### print repolist
+  local i=0
+  for _ in "${repos[@]}"; do
+    printf "| %s) %-63s|\n" "${i}" "${yellow}${repos[${i}]}${white} → ${branches[${i}]}"
+    i=$(( i + 1 ))
+  done
+  blank_line
+  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
+
+    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
+}
+
+#================================================#
+#=================== HELPERS ====================#
+#================================================#
+
+function switch_klipper_repo() {
+  local repo=${1} branch=${2}
+
+  status_msg "Switching Klipper repository..."
+  do_action_service "stop" "klipper"
+
+  [[ -d ${KLIPPER_DIR} ]] && rm -rf "${KLIPPER_DIR}"
+  clone_klipper "${repo}" "${branch}"
+
+  do_action_service "start" "klipper"
+}
+
+function show_custom_klipper_repo_help() {
+  top_border
+  echo -e "|   ~~~~ < ? > Help: Custom Klipper repo < ? > ~~~~     |"
+  hr
+  echo -e "| With this setting, it is possible to install Klipper  |"
+  echo -e "| from a custom repository. It will also switch an      |"
+  echo -e "| existing Klipper installation to the newly selected   |"
+  echo -e "| source repository.                                    |"
+  echo -e "| A list of repositories is automatically generated by  |"
+  echo -e "| a 'klipper_repos.txt' textfile in KIAUHs root folder. |"
+  echo -e "| An example file is provided at the same location.     |"
+  blank_line
+  back_footer
+
+  local choice
+  while true; do
+    read -p "${cyan}###### Please select:${white} " choice
+    case "${choice}" in
+      B|b)
+        clear && print_header
+        change_klipper_repo_menu
+        break;;
+      *)
+        deny_action "show_settings_help";;
+    esac
+  done
+}

scripts/ui.sh

@@ -1,154 +0,0 @@
-### set up some UI stuff
-
-#ui total width = 57 chars
-top_border(){
-  echo -e "/=======================================================\ "
-}
-
-bottom_border(){
-  echo -e "\=======================================================/"
-}
-
-hr(){
-  echo -e "|-------------------------------------------------------|"
-}
-
-quit_footer(){
-  hr
-  echo -e "|                        ${red}Q) Quit${default}                        | "
-  bottom_border
-}
-
-print_header(){
-  top_border
-  echo -e "|     $(title_msg "~~~~~~~~~~~~~~~~~ [ KIAUH ] ~~~~~~~~~~~~~~~~~")     |"
-  echo -e "|     $(title_msg "   Klipper Installation And Update Helper    ")     |"
-  echo -e "|     $(title_msg "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~")     |"
-  bottom_border
-}
-
-main_ui(){
-  top_border
-  echo -e "|     $(title_msg "~~~~~~~~~~~~~~~ [ Main Menu ] ~~~~~~~~~~~~~~~")     |"
-  hr
-  echo -e "|  0) [System status]  |                                |"
-  echo -e "|                      |    Klipper: $KLIPPER_STATUS|"
-  echo -e "|  1) [Install]        |     Branch: $PRINT_BRANCH|"
-  echo -e "|  2) [Update]         |                                |"
-  echo -e "|  3) [Remove]         |       DWC2: $DWC2_STATUS|"
-  echo -e "|                      |   Mainsail: $MAINSAIL_STATUS|"
-  echo -e "|  4) [Advanced]       |  Octoprint: #### WIP ####      |"
-  echo -e "|  5) [Backup]         |                                |"
-  quit_footer
-}
-
-install_ui(){
-  top_border
-  echo -e "|     $(title_msg "~~~~~~~~~~~ [ Installation Menu ] ~~~~~~~~~~~")     | "
-  hr
-  echo -e "|  You need this menu usually only for installing       | "
-  echo -e "|  all necessary dependencies for the various           | "
-  echo -e "|  functions on a completely fresh system.              | "
-  hr
-  echo -e "|  Firmware:             |                              | "
-  echo -e "|  1) [Klipper]          |                              | "
-  echo -e "|                        |                              | "
-  echo -e "|  Webinterface:         |                              | "
-  echo -e "|  2) [DWC2]             |                              | "
-  echo -e "|  3) [Mainsail]         |                              | "
-  echo -e "|                        |                              | "
-  quit_footer
-}
-
-update_ui(){
-  top_border
-  echo -e "|     $(title_msg "~~~~~~~~~~~~~~ [ Update Menu ] ~~~~~~~~~~~~~~")     | "
-  hr
-  echo -e "|  It's a good idea to check the following website      | "
-  echo -e "|  for important software changes to the config file    | "
-  echo -e "|  BEFORE updating your klipper installation:           | "
-  echo -e "|                                                       | "
-  echo -e "|  ${yellow}https://www.klipper3d.org/Config_Changes.html${default}        | "
-  bottom_border
-  top_border
-  echo -e "|  0) $BB4U_STATUS| "
-  hr
-  echo -e "|                        |  Local Vers:  | Remote Vers: | "
-  echo -e "|  Firmware:             |               |              | "
-  echo -e "|  1) [Klipper]          |  $(echo "$LOCAL_COMMIT")     | $(echo "$REMOTE_COMMIT")     | "
-  echo -e "|                        |               |              | "
-  echo -e "|  Webinterface:         |               |              | "
-  echo -e "|  2) [DWC2-for-Klipper] |  $(echo "$LOCAL_DWC2FK_COMMIT")     | $(echo "$REMOTE_DWC2FK_COMMIT")     | "
-  echo -e "|  3) [DWC2 Web UI]      |  $(echo "$DWC2_LOCAL_VER")        | $(echo "$DWC2_REMOTE_VER")        | "
-  echo -e "|  4) [Mainsail]         |  $(echo "$MAINSAIL_LOCAL_VER")       | $(echo "$MAINSAIL_REMOTE_VER")       | "
-  echo -e "|                        |               |              | "
-  quit_footer
-}
-
-remove_ui(){
-  top_border
-  echo -e "|     $(title_msg "~~~~~~~~~~~~~~ [ Remove Menu ] ~~~~~~~~~~~~~~")     | "
-  hr
-  echo -e "|  Files and directories which remain untouched:        | "
-  echo -e "|  --> ~/printer.cfg                                    | "
-  echo -e "|  --> ~/backup                                         | "
-  echo -e "|  You need remove them manually if you wish so.        | "
-  hr
-  echo -e "|  1) [Klipper]          |                              | "
-  echo -e "|  2) [DWC2-for-Klipper] |                              | "
-  echo -e "|  3) [Mainsail]         |                              | "
-  echo -e "|                        |                              | "
-  quit_footer
-}
-
-advanced_ui(){
-  top_border
-  echo -e "|     $(title_msg "~~~~~~~~~~~~~ [ Advanced Menu ] ~~~~~~~~~~~~~")     | "
-  hr
-  echo -e "|  1) [Switch Klipper version]                          | "
-  echo -e "|                                                       | "
-  echo -e "|  2) [Build Firmware]                                  | "
-  echo -e "|  3) [Flash MCU]                                       | "
-  echo -e "|  4) [Get Printer-ID]                                  | "
-  echo -e "|  5) [Write Printer-ID to printer.cfg]                 | "
-  echo -e "|  6) [Write DWC2-for-klipper config]                   | "
-  echo -e "|                                                       | "
-  echo -e "|  x) [Enable/Disable Octoprint service]                | "
-  echo -e "|                                                       | "
-quit_footer
-}
-
-backup_ui(){
-  top_border
-  echo -e "|     $(title_msg "~~~~~~~~~~~~~~ [ Backup Menu ] ~~~~~~~~~~~~~~")     | "
-  hr
-  echo -e "|                                                       | "
-  hr
-  echo -e "|  1) [        ]                                        | "
-  echo -e "|  2) [        ]                                        | "
-  echo -e "|  3) [        ]                                        | "
-  echo -e "|  4) [        ]                                        | "
-  echo -e "|  5) [        ]                                        | "
-  echo -e "|  6) [        ]                                        | "
-  echo -e "|  7) [        ]                                        | "
-  echo -e "|                                                       | "
-  quit_footer
-}
-
-switch_ui(){
-  top_border
-  echo -e "|     $(title_msg "~~~~~~~~~ [ Switch Klipper Branch ] ~~~~~~~~~")     |"
-  bottom_border
-  echo
-  echo -e " $(title_msg "Active branch: ")${green}$GET_BRANCH${default}"
-  echo
-  top_border
-  echo -e "|  1) [--> origin/master]                               | "
-  echo -e "|                                                       | "
-  echo -e "|  2) [--> scurve-shaping]                              | "
-  echo -e "|  3) [--> scurve-smoothing]                            | "
-  echo -e "|                                                       | "
-  echo -e "|  4) [--> moonraker]                                   | "
-  echo -e "|  5) [--> dev-moonraker]                               | "
-  quit_footer
-}

scripts/ui/advanced_menu.sh

@@ -0,0 +1,69 @@
+#!/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
+
+function advanced_ui() {
+  top_border
+  echo -e "|     ${yellow}~~~~~~~~~~~~~ [ Advanced Menu ] ~~~~~~~~~~~~~${white}     |"
+  hr
+  echo -e "| Klipper & API:          | Mainsail:                   |"
+  echo -e "|  1) [Rollback]          |  6) [Theme installer]       |"
+  echo -e "|                         |                             |"
+  echo -e "| Firmware:               | System:                     |"
+  echo -e "|  2) [Build only]        |  7) [Change hostname]       |"
+  echo -e "|  3) [Flash only]        |                             |"
+  echo -e "|  4) [Build + Flash]     | Extras:                     |"
+  echo -e "|  5) [Get MCU ID]        |  8) [G-Code Shell Command]  |"
+  back_footer
+}
+
+function advanced_menu() {
+  do_action "" "advanced_ui"
+
+  local action
+  while true; do
+    read -p "${cyan}####### Perform action:${white} " action
+    case "${action}" in
+      1)
+        do_action "rollback_menu" "advanced_menu";;
+      2)
+        do_action "build_fw" "advanced_ui";;
+      3)
+        clear && print_header
+        do_action "init_flash_process" "advanced_ui";;
+      4)
+        clear && print_header
+        status_msg "Please wait..."
+        build_fw && init_flash_process
+        advanced_ui;;
+      5)
+        clear && print_header
+        select_mcu_connection
+        print_detected_mcu_to_screen
+        advanced_ui;;
+      6)
+        do_action "ms_theme_installer_menu";;
+      7)
+        clear
+        print_header
+        set_custom_hostname
+        advanced_ui;;
+      8)
+        do_action "setup_gcode_shell_command" "advanced_ui";;
+      B|b)
+        clear; main_menu; break;;
+      *)
+        deny_action "advanced_ui";;
+    esac
+  done
+  advanced_menu
+}

scripts/ui/backup_menu.sh

@@ -0,0 +1,69 @@
+#!/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
+
+function backup_ui() {
+  top_border
+  echo -e "|     $(title_msg "~~~~~~~~~~~~~~ [ Backup Menu ] ~~~~~~~~~~~~~~")     |"
+  hr
+  echo -e "| ${yellow}INFO: Backups are located in '~/kiauh-backups'${white}        |"
+  hr
+  echo -e "| Klipper & API:             | Touchscreen GUI:         |"
+  echo -e "|  1) [Klipper]              |  7) [KlipperScreen]      |"
+  echo -e "|  2) [Moonraker]            |                          |"
+  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]               | 10) [OctoEverywhere]     |"
+  echo -e "|                            | 11) [Spoolman]           |"
+  back_footer
+}
+
+function backup_menu() {
+  do_action "" "backup_ui"
+
+  local action
+  while true; do
+    read -p "${cyan}####### Perform action:${white} " action
+    case "${action}" in
+      1)
+        do_action "backup_klipper" "backup_ui";;
+      2)
+        do_action "backup_moonraker" "backup_ui";;
+      3)
+        do_action "backup_config_dir" "backup_ui";;
+      4)
+        do_action "backup_moonraker_database" "backup_ui";;
+      5)
+        do_action "backup_mainsail" "backup_ui";;
+      6)
+        do_action "backup_fluidd" "backup_ui";;
+      7)
+        do_action "backup_klipperscreen" "backup_ui";;
+      8)
+        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;;
+      *)
+        deny_action "backup_ui";;
+    esac
+  done
+  backup_menu
+}

scripts/ui/general_ui.sh

@@ -0,0 +1,70 @@
+#!/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
+
+#ui total width = 57 chars
+function top_border() {
+  echo -e "/=======================================================\\"
+}
+
+function bottom_border() {
+  echo -e "\=======================================================/"
+}
+
+function blank_line() {
+  echo -e "|                                                       |"
+}
+
+function hr() {
+  echo -e "|-------------------------------------------------------|"
+}
+
+function quit_footer() {
+  hr
+  echo -e "|                        ${red}Q) Quit${white}                        |"
+  bottom_border
+}
+
+function back_footer() {
+  hr
+  echo -e "|                       ${green}B) « Back${white}                       |"
+  bottom_border
+}
+
+function back_help_footer() {
+  hr
+  echo -e "|         ${green}B) « Back${white}         |        ${yellow}H) Help [?]${white}        |"
+  bottom_border
+}
+
+function print_header() {
+  top_border
+  echo -e "|     $(title_msg "~~~~~~~~~~~~~~~~~ [ KIAUH ] ~~~~~~~~~~~~~~~~~")     |"
+  echo -e "|     $(title_msg "   Klipper Installation And Update Helper    ")     |"
+  echo -e "|     $(title_msg "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~")     |"
+  bottom_border
+}
+
+function do_action() {
+  clear && print_header
+  ### $1 is the action the user wants to fire
+  $1
+#  print_msg && clear_msg
+  ### $2 is the menu the user usually gets directed back to after an action is completed
+  $2
+}
+
+function deny_action() {
+  clear && print_header
+  print_error "Invalid command!"
+  $1
+}

scripts/ui/install_menu.sh

@@ -0,0 +1,88 @@
+#!/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
+
+function install_ui() {
+  top_border
+  echo -e "|     ${green}~~~~~~~~~~~ [ Installation Menu ] ~~~~~~~~~~~${white}     |"
+  hr
+  echo -e "|  You need this menu usually only for installing       |"
+  echo -e "|  all necessary dependencies for the various           |"
+  echo -e "|  functions on a completely fresh system.              |"
+  hr
+  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 -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 "start_klipper_setup" "install_ui";;
+      2)
+        do_action "moonraker_setup_dialog" "install_ui";;
+      3)
+        do_action "install_mainsail" "install_ui";;
+      4)
+        do_action "install_fluidd" "install_ui";;
+      5)
+        do_action "install_klipperscreen" "install_ui";;
+      6)
+        do_action "octoprint_setup_dialog" "install_ui";;
+      7)
+        do_action "install_pgc_for_klipper" "install_ui";;
+      8)
+        do_action "telegram_bot_setup_dialog" "install_ui";;
+      9)
+        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;;
+      *)
+        deny_action "install_ui";;
+    esac
+  done
+  install_menu
+}

scripts/ui/main_menu.sh

@@ -0,0 +1,142 @@
+#!/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
+
+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 "|                  |       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 tag -l 'v5*' | tail -1)"
+  echo "${version}"
+}
+
+function print_kiauh_version() {
+  local version
+  version="$(printf "%-16s" "$(get_kiauh_version)")"
+  echo "${cyan}${version}${white}"
+}
+
+function print_status() {
+  local status component="${1}"
+  status=$(get_"${component}"_status)
+
+  if [[ ${status} == "Not installed!" ]]; then
+    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
+
+  printf "%-28s" "${status}"
+}
+
+function print_klipper_repo() {
+  read_kiauh_ini
+
+  local repo klipper_status
+  klipper_status=$(get_klipper_status)
+  repo=$(echo "${custom_klipper_repo}" | sed "s/https:\/\/github\.com\///" | sed "s/\.git$//")
+  repo="${repo^^}"
+
+  if [[ ${klipper_status} == "Not installed!" ]]; then
+    repo="${red}-${white}"
+  elif [[ -n ${repo} && ${repo} != "KLIPPER3D/KLIPPER"  ]]; then
+    repo="${cyan}custom${white}"
+  else
+    repo="${cyan}Klipper3d/klipper${white}"
+  fi
+
+  printf "%-28s" "${repo}"
+}
+
+
+
+function main_menu() {
+  clear && print_header
+  main_ui
+
+  local action
+  while true; do
+    read -p "${cyan}####### Perform action:${white} " action
+    case "${action}" in
+      "start klipper") do_action_service "start" "klipper"; main_ui;;
+      "stop klipper") do_action_service "stop" "klipper"; main_ui;;
+      "restart klipper") do_action_service "restart" "klipper"; main_ui;;
+      "start moonraker") do_action_service "start" "moonraker"; main_ui;;
+      "stop moonraker") do_action_service "stop" "moonraker"; main_ui;;
+      "restart moonraker")do_action_service "restart" "moonraker"; main_ui;;
+      "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
+        main_ui;;
+      1)clear && print_header
+        install_menu
+        break;;
+      2) clear && print_header
+        update_menu
+        break;;
+      3) clear && print_header
+        remove_menu
+        break;;
+      4)clear && print_header
+        advanced_menu
+        break;;
+      5)clear && print_header
+        backup_menu
+        main_ui;;
+      6)clear && print_header
+        settings_menu
+        break;;
+      Q|q)
+        echo -e "${green}###### Happy printing! ######${white}"; echo
+        exit 0;;
+      *)
+        deny_action "main_ui";;
+    esac
+  done
+  main_menu
+}

scripts/ui/remove_menu.sh

@@ -0,0 +1,88 @@
+#!/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
+
+function remove_ui() {
+  top_border
+  echo -e "|     ${red}~~~~~~~~~~~~~~ [ Remove Menu ] ~~~~~~~~~~~~~~${white}     |"
+  hr
+  echo -e "| ${yellow}INFO: Configurations and/or any backups will be kept!${white} |"
+  hr
+  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
+}
+
+function remove_menu() {
+  do_action "" "remove_ui"
+
+  local action
+  while true; do
+    read -p "${cyan}####### Perform action:${white} " action
+    case "${action}" in
+      1)
+        do_action "remove_klipper" "remove_ui";;
+      2)
+        do_action "remove_moonraker" "remove_ui";;
+      3)
+        do_action "remove_mainsail" "remove_ui";;
+      4)
+        do_action "remove_mainsail_config" "remove_ui";;
+      5)
+        do_action "remove_fluidd" "remove_ui";;
+      6)
+        do_action "remove_fluidd_config" "remove_ui";;
+      7)
+        do_action "remove_klipperscreen" "remove_ui";;
+      8)
+        do_action "remove_octoprint" "remove_ui";;
+      9)
+        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;;
+      *)
+        deny_action "remove_ui";;
+    esac
+  done
+  remove_menu
+}

scripts/ui/settings_menu.sh

@@ -0,0 +1,166 @@
+#!/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
+
+function settings_ui() {
+  read_kiauh_ini "${FUNCNAME[0]}"
+
+  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}"
+
+  ### custom repository
+  custom_repo=$(echo "${custom_repo}" | sed "s/https:\/\/github\.com\///" | sed "s/\.git$//" )
+  if [[ -z ${custom_repo} ]]; then
+    custom_repo="${cyan}Klipper3D/klipper${white}"
+  else
+    custom_repo="${cyan}${custom_repo}${white}"
+  fi
+
+  ### custom repository branch
+  if [[ -z ${custom_branch} ]]; then
+    custom_branch="${cyan}master${white}"
+  else
+    custom_branch="${cyan}${custom_branch}${white}"
+  fi
+
+  ### webinterface stable toggle
+  if [[ ${ms_pre_rls} == "false" ]]; then
+    ms_pre_rls="${red}● ${ms_pre_rls}${white}"
+  else
+    ms_pre_rls="${green}● ${ms_pre_rls}${white}"
+  fi
+
+  if [[ ${fl_pre_rls} == "false" ]]; then
+    fl_pre_rls="${red}● ${fl_pre_rls}${white}"
+  else
+    fl_pre_rls="${green}● ${fl_pre_rls}${white}"
+  fi
+
+  ### backup before update toggle
+  if [[ "${bbu}" == "false" ]]; then
+    bbu="${red}● ${bbu}${white}"
+  else
+    bbu="${green}● ${bbu}${white}"
+  fi
+
+  top_border
+  echo -e "|     $(title_msg "~~~~~~~~~~~~ [ KIAUH Settings ] ~~~~~~~~~~~~~")     |"
+  hr
+  echo -e "| Klipper:                                              |"
+  echo -e "|   ● Repository:                                       |"
+  printf  "|     %-70s|\n" "${custom_repo} (${custom_branch})"
+  hr
+  echo -e "| Install unstable releases:                            |"
+  printf  "|     Mainsail: %-29sFluidd: %-27s|\n" "${ms_pre_rls}" "${fl_pre_rls}"
+  hr
+  printf  "| Backup before updating: %-42s|\n" "${bbu}"
+  hr
+  echo -e "| 1) Set custom Klipper repository                      |"
+  blank_line
+  if [[ ${mainsail_install_unstable} == "false" ]]; then
+  echo -e "| 2) ${green}Allow${white} unstable Mainsail releases                   |"
+  else
+  echo -e "| 2) ${red}Disallow${white} unstable Mainsail releases                |"
+  fi
+  if [[ ${fluidd_install_unstable} == "false" ]]; then
+  echo -e "| 3) ${green}Allow${white} unstable Fluidd releases                     |"
+  else
+  echo -e "| 3) ${red}Disallow${white} unstable Fluidd releases                  |"
+  fi
+  blank_line
+  if [[ ${backup_before_update} == "false" ]]; then
+  echo -e "| 4) ${green}Enable${white} automatic backups before updates            |"
+  else
+  echo -e "| 4) ${red}Disable${white} automatic backups before updates           |"
+  fi
+  back_help_footer
+}
+
+function show_settings_help() {
+  local default_cfg="${cyan}${HOME}/klipper_config${white}"
+
+  top_border
+  echo -e "|    ~~~~~~ < ? > Help: KIAUH Settings < ? > ~~~~~~     |"
+  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.         |"
+  echo -e "| ${yellow}This will include alpha, beta and rc releases!${white}        |"
+  blank_line
+  echo -e "| If set to ${red}false${white}, KIAUH installs/updates the software  |"
+  echo -e "| with the most recent stable release.                  |"
+  blank_line
+  echo -e "| Default: ${red}false${white}                                        |"
+  blank_line
+  hr
+  echo -e "| ${cyan}Backup before updating:${white}                               |"
+  echo -e "| If set to true, KIAUH will automatically create a     |"
+  echo -e "| backup from the corresponding component you are about |"
+  echo -e "| to update before actually updating it, preserving the |"
+  echo -e "| current state of the component in a safe location.    |"
+  echo -e "| All backups are stored in '~/kiauh_backups'.          |"
+  blank_line
+  echo -e "| Default: ${red}false${white}                                        |"
+  blank_line
+  back_footer
+
+  local choice
+  while true; do
+    read -p "${cyan}###### Please select:${white} " choice
+    case "${choice}" in
+      B|b)
+        clear && print_header
+        settings_menu
+        break;;
+      *)
+        deny_action "show_settings_help";;
+    esac
+  done
+}
+
+function settings_menu() {
+  clear && print_header
+  settings_ui
+
+  local action
+  while true; do
+    read -p "${cyan}####### Perform action:${white} " action
+    case "${action}" in
+      1)
+        clear && print_header
+        change_klipper_repo_menu
+        settings_ui;;
+      2)
+        switch_mainsail_releasetype
+        settings_menu;;
+      3)
+        switch_fluidd_releasetype
+        settings_menu;;
+      4)
+        toggle_backup_before_update
+        settings_menu;;
+      B|b)
+        clear
+        main_menu
+        break;;
+      H|h)
+        clear && print_header
+        show_settings_help
+        break;;
+      *)
+        deny_action "settings_ui";;
+    esac
+  done
+}

scripts/ui/update_menu.sh

@@ -0,0 +1,172 @@
+#!/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
+
+function update_ui() {
+  top_border
+  echo -e "|     ${green}~~~~~~~~~~~~~~ [ Update Menu ] ~~~~~~~~~~~~~~${white}     |"
+  hr
+  echo -e "| a) [Update all]        |               |              |"
+  echo -e "|                        | Installed:    | Latest:      |"
+  echo -e "| Klipper & API:         |---------------|--------------|"
+  echo -e "|  1) [Klipper]          |$(compare_klipper_versions)|"
+  echo -e "|  2) [Moonraker]        |$(compare_moonraker_versions)|"
+  echo -e "|                        |               |              |"
+  echo -e "| Klipper Webinterface:  |---------------|--------------|"
+  echo -e "|  3) [Mainsail]         |$(compare_mainsail_versions)|"
+  echo -e "|  4) [Fluidd]           |$(compare_fluidd_versions)|"
+  echo -e "|                        |               |              |"
+  echo -e "| Touchscreen GUI:       |---------------|--------------|"
+  echo -e "|  5) [KlipperScreen]    |$(compare_klipperscreen_versions)|"
+  echo -e "|                        |               |              |"
+  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 "| 14) [System]           |  $(check_system_updates)   |"
+  back_footer
+}
+
+function update_menu() {
+  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
+    case "${action}" in
+      0)
+        do_action "toggle_backups" "update_ui";;
+      1)
+        do_action "update_klipper" "update_ui";;
+      2)
+        do_action "update_moonraker" "update_ui";;
+      3)
+        do_action "update_mainsail" "update_ui";;
+      4)
+        do_action "update_fluidd" "update_ui";;
+      5)
+        do_action "update_klipperscreen" "update_ui";;
+      6)
+        do_action "update_pgc_for_klipper" "update_ui";;
+      7)
+        do_action "update_telegram_bot" "update_ui";;
+      8)
+        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)
+        clear; main_menu; break;;
+      *)
+        deny_action "update_ui";;
+    esac
+  done
+  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:         |"
+
+    [[ "${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
+    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/update.sh

@@ -1,77 +0,0 @@
-#TODO
-# - update the correct branch
-# - version checks before updating
-
-#WIP
-update_check(){
-  read_local_commit
-  read_remote_commit
-}
-
-update_klipper(){
-  stop_klipper
-  bb4u_klipper
-  if [ ! -d $KLIPPER_DIR ]; then
-    cd ${HOME} && git clone $KLIPPER_REPO
-  else
-    read_branch
-    status_msg "Updating $GET_BRANCH"
-    #fetching origin/master -> error
-    #rewriting origin/master to origin
-    if [ "$GET_BRANCH" == "origin/master" ]; then
-      FETCH_BRANCH="origin"
-    else
-      FETCH_BRANCH=$(echo "$GET_BRANCH" | cut -d "/" -f1)
-    fi
-    status_msg "Fetching from $FETCH_BRANCH"
-    git fetch $FETCH_BRANCH -q && ok_msg "Fetch successfull!"
-    status_msg "Checking out $GET_BRANCH"
-    git checkout $GET_BRANCH -q && ok_msg "Checkout successfull!" && echo; ok_msg "Update complete!"
-  fi
-  start_klipper; echo
-}
-
-update_dwc2fk(){
-  stop_klipper
-  bb4u_dwc2fk
-  if [ ! -d $DWC2FK_DIR ]; then
-    cd ${HOME} && git clone $DWC2FK_REPO
-  else
-    cd $DWC2FK_DIR && git pull
-    #create a web_dwc2.py symlink if not already existing
-    if [ -d $KLIPPER_DIR/klippy/extras ] && [ ! -e $WEB_DWC2 ]; then
-      status_msg "Creating web_dwc2.py symlink ..."
-      ln -s $DWC2FK_DIR/web_dwc2.py $WEB_DWC2 && ok_msg "Symlink created!"
-    fi
-  fi
-  start_klipper
-}
-
-update_dwc2(){
-  bb4u_dwc2
-  #check dependencies
-  dep=(wget gzip tar curl)
-  dep_check
-  #execute operation
-  GET_DWC2_URL=`curl -s https://api.github.com/repositories/28820678/releases/latest | grep browser_download_url | cut -d'"' -f4`
-  if [ ! -d $DWC2_DIR/web ]; then
-    mkdir -p $DWC2_DIR/web
-  fi
-  cd $DWC2_DIR/web
-  status_msg "Downloading DWC2 Web UI ..."
-  wget -q $GET_DWC2_URL && ok_msg "Download complete!"
-  status_msg "Unzipping archive ..."
-  unzip -q -o *.zip && for f_ in $(find . | grep '.gz');do gunzip -f ${f_};done && ok_msg "Done!"
-  status_msg "Writing version to file ..."
-  echo $GET_DWC2_URL | cut -d/ -f8 > $DWC2_DIR/web/version && ok_msg "Done!"
-  status_msg "Do a little cleanup ..."
-  rm -rf DuetWebControl-SD.zip && ok_msg "Done!"
-}
-
-update_mainsail(){
-  stop_klipper
-  bb4u_mainsail
-  status_msg "Updating Mainsail ..."
-  install_mainsail
-  start_klipper
-}

scripts/upload_log.sh

@@ -0,0 +1,125 @@
+#!/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
+
+function accept_upload_conditions() {
+  top_border
+  echo -e "|     ${red}~~~~~~~~~~~ [ Upload Agreement ] ~~~~~~~~~~~~${white}     |"
+  hr
+  echo -e "| The following function will help to quickly upload    |"
+  echo -e "| logs for debugging purposes. With confirming this     |"
+  echo -e "| dialog, you agree that during that process your logs  |"
+  echo -e "| will be uploaded to: ${yellow}http://paste.c-net.org/${white}          |"
+  hr
+  echo -e "| ${red}PLEASE NOTE:${white}                                          |"
+  echo -e "| Be aware that logs can contain network information,   |"
+  echo -e "| private data like usernames, filenames, or other      |"
+  echo -e "| information you may not want to make public.          |"
+  blank_line
+  echo -e "| Do ${red}NOT${white} use this function if you don't agree!          |"
+  bottom_border
+
+  local yn
+  while true; do
+    read -p "${cyan}Do you accept? (Y/n):${white} " yn
+    case "${yn}" in
+      Y|y|Yes|yes|"")
+        sed -i "/logupload_accepted=/s/false/true/" "${INI_FILE}"
+        clear && print_header && upload_selection
+        ;;
+      N|n|No|no)
+        clear
+        main_menu
+        break
+        ;;
+      *)
+        error_msg "Invalid command!";;
+    esac
+  done
+}
+
+function upload_selection() {
+  read_kiauh_ini "${FUNCNAME[0]}"
+
+  local upload_agreed="${logupload_accepted}"
+  [[ ${upload_agreed} == "false" ]] && accept_upload_conditions
+
+  local logfiles
+  local webif_logs="/var/log/nginx"
+
+  function find_logfile() {
+    local name=${1} location=${2}
+    for log in $(find "${location}" -maxdepth 1 -regextype posix-extended -regex "${location}/${name}" | sort -g); do
+      logfiles+=("${log}")
+    done
+  }
+
+  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
+  top_border
+  echo -e "|     ${yellow}~~~~~~~~~~~~~~~ [ Log Upload ] ~~~~~~~~~~~~~~${white}     |"
+  hr
+  echo -e "| You can choose the following logfiles for uploading:  |"
+  blank_line
+
+  for log in "${logfiles[@]}"; do
+    log=${log//${HOME}/"~"}
+    (( i < 10 )) && printf "|  ${i}) %-50s|\n" "${log}"
+    (( i >= 10 )) && printf "| ${i}) %-50s|\n" "${log}"
+    i=$(( i + 1 ))
+  done
+
+  blank_line
+  back_footer
+
+  local option re="^[0-9]+$"
+  while true; do
+    read -p "${cyan}###### Please select:${white} " option
+
+    if [[ ${option} =~ ${re} && ${option} -lt ${#logfiles[@]} ]]; then
+      upload_log "${logfiles[${option}]}"
+      upload_selection
+    elif [[ ${option} == "B" || ${option} == "b" ]]; then
+      return
+    else
+      error_msg "Invalid command!"
+    fi
+  done
+}
+
+function upload_log() {
+  local link
+  clear && print_header
+  status_msg "Uploading ${1} ..."
+  link=$(curl -s -H "x-random;" --upload-file "${1}" 'http://paste.c-net.org/')
+
+  if [[ -n ${link} ]]; then
+    ok_msg "${1} upload successfull!"
+    echo -e "\n${cyan}###### Here is your link:${white}"
+    echo -e ">>>>>> ${link}\n"
+  else
+    error_msg "Uploading failed!"
+  fi
+}

scripts/utilities.sh

@@ -0,0 +1,778 @@
+#!/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
+
+#================================================#
+#=================== STARTUP ====================#
+#================================================#
+
+function check_euid() {
+  if [[ ${EUID} -eq 0 ]]; then
+    echo -e "${red}"
+    top_border
+    echo -e "|       !!! THIS SCRIPT MUST NOT RUN AS ROOT !!!        |"
+    echo -e "|                                                       |"
+    echo -e "|        It will ask for credentials as needed.         |"
+    bottom_border
+    echo -e "${white}"
+    exit 1
+  fi
+}
+
+function check_if_ratos() {
+  if [[ -n $(which ratos) ]]; then
+    echo -e "${red}"
+    top_border
+    echo -e "|        !!! RatOS 2.1 or greater detected !!!          |"
+    echo -e "|                                                       |"
+    echo -e "|        KIAUH does currently not support RatOS.        |"
+    echo -e "| If you have any questions, please ask for help on the |"
+    echo -e "| RatRig Community Discord: https://discord.gg/ratrig   |"
+    bottom_border
+    echo -e "${white}"
+    exit 1
+  fi
+}
+
+#================================================#
+#============= MESSAGE FORMATTING ===============#
+#================================================#
+
+function select_msg() {
+  echo -e "${white}   [➔] ${1}"
+}
+function status_msg() {
+  echo -e "\n${magenta}###### ${1}${white}"
+}
+function ok_msg() {
+  echo -e "${green}[✓ OK] ${1}${white}"
+}
+function warn_msg() {
+  echo -e "${yellow}>>>>>> ${1}${white}"
+}
+function error_msg() {
+  echo -e "${red}>>>>>> ${1}${white}"
+}
+function abort_msg() {
+  echo -e "${red}<<<<<< ${1}${white}"
+}
+function title_msg() {
+  echo -e "${cyan}${1}${white}"
+}
+
+function print_error() {
+  [[ -z ${1} ]] && return
+
+  echo -e "${red}"
+  echo -e "#=======================================================#"
+  echo -e " ${1} "
+  echo -e "#=======================================================#"
+  echo -e "${white}"
+}
+
+function print_confirm() {
+  [[ -z ${1} ]] && return
+
+  echo -e "${green}"
+  echo -e "#=======================================================#"
+  echo -e " ${1} "
+  echo -e "#=======================================================#"
+  echo -e "${white}"
+}
+
+#================================================#
+#=================== LOGGING ====================#
+#================================================#
+
+function timestamp() {
+  date +"[%F %T]"
+}
+
+function init_logfile() {
+  local log="/tmp/kiauh.log"
+  {
+    echo -e "#================================================================#"
+    echo -e "# New KIAUH session started on: $(date) #"
+    echo -e "#================================================================#"
+    echo -e "KIAUH $(get_kiauh_version)"
+    echo -e "#================================================================#"
+  } >> "${log}"
+}
+
+function log_info() {
+  local message="${1}" log="${LOGFILE}"
+  echo -e "$(timestamp) [INFO]: ${message}" | tr -s " " >> "${log}"
+}
+
+function log_warning() {
+  local message="${1}" log="${LOGFILE}"
+  echo -e "$(timestamp) [WARN]: ${message}" | tr -s " " >> "${log}"
+}
+
+function log_error() {
+  local message="${1}" log="${LOGFILE}"
+  echo -e "$(timestamp) [ERR]: ${message}" | tr -s " " >> "${log}"
+}
+
+#================================================#
+#=============== KIAUH SETTINGS =================#
+#================================================#
+
+function read_kiauh_ini() {
+  local func=${1}
+
+  if [[ ! -f ${INI_FILE} ]]; then
+    log_warning "Reading from .kiauh.ini failed! File not found! Creating default ini file."
+    init_ini
+  fi
+
+  log_info "Reading from .kiauh.ini ... (${func})"
+  source "${INI_FILE}"
+}
+
+function init_ini() {
+  ### remove pre-version 4 ini files
+  if [[ -f ${INI_FILE} ]] && ! grep -Eq "^# KIAUH v4\.0\.0$" "${INI_FILE}"; then
+    rm "${INI_FILE}"
+  fi
+
+  ### initialize v4.0.0 ini file
+  if [[ ! -f ${INI_FILE} ]]; then
+    {
+      echo -e "# File creation date: $(date)"
+      echo -e "#=================================================#"
+      echo -e "# KIAUH - Klipper Installation And Update Helper  #"
+      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
+
+  if ! grep -Eq "^logupload_accepted=." "${INI_FILE}"; then
+    echo -e "\nlogupload_accepted=false\c" >> "${INI_FILE}"
+  fi
+
+  if ! grep -Eq "^custom_klipper_repo=" "${INI_FILE}"; then
+    echo -e "\ncustom_klipper_repo=\c" >> "${INI_FILE}"
+  fi
+
+  if ! grep -Eq "^custom_klipper_repo_branch=" "${INI_FILE}"; then
+    echo -e "\ncustom_klipper_repo_branch=\c" >> "${INI_FILE}"
+  fi
+
+  if ! grep -Eq "^mainsail_install_unstable=" "${INI_FILE}"; then
+    echo -e "\nmainsail_install_unstable=false\c" >> "${INI_FILE}"
+  fi
+
+  if ! grep -Eq "^fluidd_install_unstable=" "${INI_FILE}"; then
+    echo -e "\nfluidd_install_unstable=false\c" >> "${INI_FILE}"
+  fi
+
+  if ! grep -Eq "^multi_instance_names=" "${INI_FILE}"; then
+    echo -e "\nmulti_instance_names=\c" >> "${INI_FILE}"
+  fi
+
+  if ! grep -Eq "^version_to_launch=" "${INI_FILE}"; then
+    echo -e "\nversion_to_launch=\n\c" >> "${INI_FILE}"
+  fi
+
+  ### strip all empty lines out of the file
+  sed -i "/^[[:blank:]]*$/ d" "${INI_FILE}"
+}
+
+function switch_mainsail_releasetype() {
+  read_kiauh_ini "${FUNCNAME[0]}"
+  local state="${mainsail_install_unstable}"
+
+  if [[ ${state} == "false" ]]; then
+    sed -i '/mainsail_install_unstable=/s/false/true/' "${INI_FILE}"
+    log_info "mainsail_install_unstable changed (false -> true) "
+  else
+    sed -i '/mainsail_install_unstable=/s/true/false/' "${INI_FILE}"
+    log_info "mainsail_install_unstable changed (true -> false) "
+  fi
+}
+
+function switch_fluidd_releasetype() {
+  read_kiauh_ini "${FUNCNAME[0]}"
+  local state="${fluidd_install_unstable}"
+
+  if [[ ${state} == "false" ]]; then
+    sed -i '/fluidd_install_unstable=/s/false/true/' "${INI_FILE}"
+    log_info "fluidd_install_unstable changed (false -> true) "
+  else
+    sed -i '/fluidd_install_unstable=/s/true/false/' "${INI_FILE}"
+    log_info "fluidd_install_unstable changed (true -> false) "
+  fi
+}
+
+function toggle_backup_before_update() {
+  read_kiauh_ini "${FUNCNAME[0]}"
+  local state="${backup_before_update}"
+
+  if [[ ${state} = "false" ]]; then
+    sed -i '/backup_before_update=/s/false/true/' "${INI_FILE}"
+  else
+    sed -i '/backup_before_update=/s/true/false/' "${INI_FILE}"
+  fi
+}
+
+function set_custom_klipper_repo() {
+  read_kiauh_ini "${FUNCNAME[0]}"
+  local repo=${1} branch=${2}
+
+  sed -i "/^custom_klipper_repo=/d" "${INI_FILE}"
+  sed -i '$a'"custom_klipper_repo=${repo}" "${INI_FILE}"
+  sed -i "/^custom_klipper_repo_branch=/d" "${INI_FILE}"
+  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 ================#
+#================================================#
+
+function do_action_service() {
+  local services action=${1} service=${2}
+  services=$(find "${SYSTEMD}" -maxdepth 1 -regextype posix-extended -regex "${SYSTEMD}/${service}(-[0-9a-zA-Z]+)?.service" | sort)
+
+  if [[ -n ${services} ]]; then
+    for service in ${services}; do
+      service=$(echo "${service}" | rev | cut -d"/" -f1 | rev)
+      status_msg "${action^} ${service} ..."
+
+      if sudo systemctl "${action}" "${service}"; then
+        log_info "${service}: ${action} > success"
+        ok_msg "${action^} ${service} successfull!"
+      else
+        log_warning "${service}: ${action} > failed"
+        warn_msg "${action^} ${service} failed!"
+      fi
+    done
+  fi
+}
+
+#================================================#
+#================ DEPENDENCIES ==================#
+#================================================#
+
+### returns 'true' if python version >= 3.7
+function python3_check() {
+  local major minor passed
+
+  major=$(python3 --version | cut -d" " -f2 | cut -d"." -f1)
+  minor=$(python3 --version | cut -d"." -f2)
+
+  if (( major >= 3 && minor >= 7 )); then
+    passed="true"
+  else
+    passed="false"
+  fi
+
+  echo "${passed}"
+}
+
+function dependency_check() {
+  local dep=( "${@}" )
+  local packages log_name="dependencies"
+  status_msg "Checking for the following dependencies:"
+
+  #check if package is installed, if not write its name into array
+  for pkg in "${dep[@]}"; do
+    echo -e "${cyan}● ${pkg} ${white}"
+    [[ ! $(dpkg-query -f'${Status}' --show "${pkg}" 2>/dev/null) = *\ installed ]] && \
+    packages+=("${pkg}")
+  done
+
+  #if array is not empty, install packages from array
+  if (( ${#packages[@]} > 0 )); then
+    status_msg "Installing the following dependencies:"
+    for package in "${packages[@]}"; do
+      echo -e "${cyan}● ${package} ${white}"
+    done
+    echo
+
+    # 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
+  fi
+}
+
+function fetch_webui_ports() {
+  local port interfaces=("mainsail" "fluidd" "octoprint")
+
+  ### read ports from possible installed interfaces and write them to ~/.kiauh.ini
+  for interface in "${interfaces[@]}"; do
+    if [[ -f "/etc/nginx/sites-available/${interface}" ]]; then
+      port=$(grep -E "listen" "/etc/nginx/sites-available/${interface}" | head -1 | sed 's/^\s*//' | sed 's/;$//' | cut -d" " -f2)
+      if ! grep -Eq "${interface}_port" "${INI_FILE}"; then
+        sed -i '$a'"${interface}_port=${port}" "${INI_FILE}"
+      else
+        sed -i "/^${interface}_port/d" "${INI_FILE}"
+        sed -i '$a'"${interface}_port=${port}" "${INI_FILE}"
+      fi
+    else
+        sed -i "/^${interface}_port/d" "${INI_FILE}"
+    fi
+  done
+}
+
+#================================================#
+#=================== SYSTEM =====================#
+#================================================#
+
+function create_required_folders() {
+  local printer_data=${1} folders
+  folders=("backup" "certs" "config" "database" "gcodes" "comms" "logs" "systemd")
+
+  for folder in "${folders[@]}"; do
+    local dir="${printer_data}/${folder}"
+
+    ### 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_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
+    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
+}
+
+function check_usergroups() {
+  local group_dialout group_tty
+
+  if grep -q "dialout" </etc/group && ! grep -q "dialout" <(groups "${USER}"); then
+    group_dialout="false"
+  fi
+
+  if grep -q "tty" </etc/group && ! grep -q "tty" <(groups "${USER}"); then
+    group_tty="false"
+  fi
+
+  if [[ ${group_dialout} == "false" || ${group_tty} == "false" ]] ; then
+    top_border
+    echo -e "| ${yellow}WARNING: Your current user is not in group:${white}           |"
+    [[ ${group_tty} == "false" ]] && \
+    echo -e "| ${yellow}● tty${white}                                                 |"
+    [[ ${group_dialout} == "false" ]] && \
+    echo -e "| ${yellow}● dialout${white}                                             |"
+    blank_line
+    echo -e "| It is possible that you won't be able to successfully |"
+    echo -e "| connect and/or flash the controller board without     |"
+    echo -e "| your user being a member of that group.               |"
+    echo -e "| If you want to add the current user to the group(s)   |"
+    echo -e "| listed above, answer with 'Y'. Else skip with 'n'.    |"
+    blank_line
+    echo -e "| ${yellow}INFO:${white}                                                 |"
+    echo -e "| ${yellow}Relog required for group assignments to take effect!${white}  |"
+    bottom_border
+
+    local yn
+    while true; do
+      read -p "${cyan}###### Add user '${USER}' to group(s) now? (Y/n):${white} " yn
+      case "${yn}" in
+        Y|y|Yes|yes|"")
+          select_msg "Yes"
+          status_msg "Adding user '${USER}' to group(s) ..."
+          if [[ ${group_tty} == "false" ]]; then
+            sudo usermod -a -G tty "${USER}" && ok_msg "Group 'tty' assigned!"
+          fi
+          if [[ ${group_dialout} == "false" ]]; then
+            sudo usermod -a -G dialout "${USER}" && ok_msg "Group 'dialout' assigned!"
+          fi
+          ok_msg "Remember to relog/restart this machine for the group(s) to be applied!"
+          break;;
+        N|n|No|no)
+          select_msg "No"
+          break;;
+        *)
+          print_error "Invalid command!";;
+      esac
+    done
+  fi
+}
+
+function set_custom_hostname() {
+  echo
+  top_border
+  echo -e "|  Changing the hostname of this machine allows you to  |"
+  echo -e "|  access a webinterface that is configured for port 80 |"
+  echo -e "|  by simply typing '<hostname>.local' in the browser.  |"
+  echo -e "|                                                       |"
+  echo -e "|  E.g.: If you set the hostname to 'my-printer' you    |"
+  echo -e "|        can open Mainsail / Fluidd / Octoprint by      |"
+  echo -e "|        browsing to: http://my-printer.local           |"
+  bottom_border
+
+  local yn
+  while true; do
+    read -p "${cyan}###### Do you want to change the hostname? (y/N):${white} " yn
+    case "${yn}" in
+      Y|y|Yes|yes)
+        select_msg "Yes"
+        change_hostname
+        break;;
+      N|n|No|no|"")
+        select_msg "No"
+        break;;
+      *)
+        error_msg "Invalid command!";;
+    esac
+  done
+}
+
+function change_hostname() {
+    local new_hostname regex="^[^\-\_]+([0-9a-z]\-{0,1})+[^\-\_]+$"
+    echo
+    top_border
+    echo -e "|  ${green}Allowed characters: a-z, 0-9 and single '-'${white}          |"
+    echo -e "|  ${red}No special characters allowed!${white}                       |"
+    echo -e "|  ${red}No leading or trailing '-' allowed!${white}                  |"
+    bottom_border
+
+    while true; do
+      read -p "${cyan}###### Please set the new hostname:${white} " new_hostname
+
+      if [[ ${new_hostname} =~ ${regex} ]]; then
+        local yn
+        while true; do
+          echo
+          read -p "${cyan}###### Do you want '${new_hostname}' to be the new hostname? (Y/n):${white} " yn
+          case "${yn}" in
+            Y|y|Yes|yes|"")
+              select_msg "Yes"
+              set_hostname "${new_hostname}"
+              break;;
+            N|n|No|no)
+              select_msg "No"
+              abort_msg "Skip hostname change ..."
+              break;;
+            *)
+              print_error "Invalid command!";;
+          esac
+        done
+      else
+        warn_msg "'${new_hostname}' is not a valid hostname!"
+      fi
+      break
+    done
+}
+
+function set_hostname() {
+  local new_hostname=${1} current_date
+  #check for dependencies
+  local dep=(avahi-daemon)
+  dependency_check "${dep[@]}"
+
+  #create host file if missing or create backup of existing one with current date&time
+  if [[ -f /etc/hosts ]]; then
+    current_date=$(get_date)
+    status_msg "Creating backup of hosts file ..."
+    sudo cp "/etc/hosts" "/etc/hosts.${current_date}.bak"
+    ok_msg "Backup done!"
+    ok_msg "File:'/etc/hosts.${current_date}.bak'"
+  else
+    sudo touch /etc/hosts
+  fi
+
+  #set new hostname in /etc/hostname
+  status_msg "Setting hostname to '${new_hostname}' ..."
+  status_msg "Please wait ..."
+  sudo hostnamectl set-hostname "${new_hostname}"
+
+  #write new hostname to /etc/hosts
+  status_msg "Writing new hostname to /etc/hosts ..."
+  echo "127.0.0.1       ${new_hostname}" | sudo tee -a /etc/hosts &>/dev/null
+  ok_msg "New hostname successfully configured!"
+  ok_msg "Remember to reboot for the changes to take effect!"
+}
+
+#================================================#
+#============ 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}
+  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[@]}"
+}