feat: KIAUH v4.0.0 (dw-0#191)

delorean-dev · May 29, 2022 · fcf059d · fcf059d
1 parent 4bf9e8f
commit fcf059d
Show file tree

Hide file tree

Showing 64 changed files with 6,485 additions and 5,885 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1 @@
-.idea
-.shellcheckrc
+klipper_repos.txt
diff --git a/.shellcheckrc b/.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
diff --git a/README.md b/README.md
@@ -1,11 +1,24 @@
-![main_menu](resources/screenshots/kiauh.png)
-# Klipper Installation And Update Helper
-![GitHub](https://img.shields.io/github/license/th33xitus/kiauh) ![GitHub Repo stars](https://img.shields.io/github/stars/th33xitus/kiauh) ![GitHub forks](https://img.shields.io/github/forks/th33xitus/kiauh) ![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/th33xitus/kiauh) ![GitHub last commit](https://img.shields.io/github/last-commit/th33xitus/kiauh) ![GitHub contributors](https://img.shields.io/github/contributors/th33xitus/kiauh)
-
-### **📋 Please see the [Changelog](docs/changelog.md) for possible important information !**
-
-**📢 Disclaimer: Usage of this script happens at your own risk!**
-
+<p align="center">
+  <a>
+    <img src="https://raw.githubusercontent.com/th33xitus/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">
+  A handy installation script that makes installing Klipper (and more) a breeze!
+</p>
+
+<p align="center">
+  <a><img src="https://img.shields.io/github/license/th33xitus/kiauh"></a>
+  <a><img src="https://img.shields.io/github/stars/th33xitus/kiauh"></a>
+  <a><img src="https://img.shields.io/github/forks/th33xitus/kiauh"></a>
+  <a><img src="https://img.shields.io/github/languages/top/th33xitus/kiauh?logo=gnubash&logoColor=white"></a>
+  <a><img src="https://img.shields.io/github/v/tag/th33xitus/kiauh"></a>
+  <br />  
+  <a><img src="https://img.shields.io/github/last-commit/th33xitus/kiauh"></a>
+  <a><img src="https://img.shields.io/github/contributors/th33xitus/kiauh"></a>
+</p>
 
 ## **🛠️ Instructions:**
 
@@ -20,50 +33,58 @@ git clone https://github.com/th33xitus/kiauh.git
 
 ./kiauh/kiauh.sh
 ```
+**📢 Disclaimer: Usage of this script happens at your own risk!**
 
 
-## **🧰 Functions and Features:**
-
-### **Core Functions:**
-
-- **Installing** Klipper to your Raspberry Pi or other Debian based Linux Distribution.
-- **Installing** of the Moonraker API (needed for Mainsail, Fluidd and KlipperScreen)
-- **Installing** several web interfaces such as Mainsail, Fluidd, Duet Web Control or OctoPrint including their dependencies.
-- **Installing** of KlipperScreen (OctoScreen but for Klipper!)
-- **Updating** of all the listed installations above excluding OctoPrint. For updating OctoPrint, please use the OctoPrint interface!
-- **Removing** of all the listed installations above.
-- **Backup** of all the listed installations above.
-
-### **Also possible:**
-
-- Build the Klipper Firmware
-- Flash the MCU
-- Read ID of the currently connected MCU
-- and more ...
-
-### **For a list of additional features please see: [Feature List](docs/features.md)**
-
 ## **❗ Notes:**
 
+**📋 Please see the [Changelog](docs/changelog.md) for possible important changes!**
+
 - Tested **only** on Raspberry Pi OS Lite (Debian 10 Buster)
     - Other Debian based distributions can work
     - Reported to work on Armbian too
 - During the use of this script you might be asked for your sudo password. There are several functions involved which need sudo privileges.
 
 ## **🌐 Sources & Further Information**
 
-For more information or instructions to the various components KIAUH can install, please check out the corresponding repositories listed below:
-
-* ⛵[Klipper](https://github.com/Klipper3d/klipper) by [KevinOConnor](https://github.com/KevinOConnor)
-* 🌙[Moonraker](https://github.com/Arksine/moonraker) by [Arksine](https://github.com/Arksine)
-* 💨[Mainsail](https://github.com/mainsail-crew/mainsail) by [mainsail-crew](https://github.com/mainsail-crew)
-* 🌊[Fluidd](https://github.com/fluidd-core/fluidd) by [fluidd-core](https://github.com/fluidd-core)
-* 🕸️[Duet Web Control](https://github.com/Duet3D/DuetWebControl) by [Duet3D](https://github.com/Duet3D)
-* 🕸️[DWC2-for-Klipper-Socket](https://github.com/Stephan3/dwc2-for-klipper-socket) by [Stephan3](https://github.com/Stephan3)
-* 🖥️[KlipperScreen](https://github.com/jordanruthe/KlipperScreen) by [jordanruthe](https://github.com/jordanruthe)
-* 🐙[OctoPrint](https://github.com/OctoPrint/OctoPrint) by [OctoPrint](https://github.com/OctoPrint)
-* 🔬[PrettyGCode](https://github.com/Kragrathea/pgcode) by [Kragrathea](https://github.com/Kragrathea)
-* 🤖[Moonraker-Telegram-Bot](https://github.com/nlef/moonraker-telegram-bot) by [nlef](https://github.com/nlef)
+<table>
+<tr>
+<th><h3><a href="https://github.com/Klipper3d/klipper">Klipper</a></h3></th>
+<th><h3><a href="https://github.com/Arksine/moonraker">Moonraker</a></h3></th>
+<th><h3><a href="https://github.com/mainsail-crew/mainsail">Mainsail</a></h3></th>
+<th><h3><a href="https://github.com/fluidd-core/fluidd">Fluidd</a></h3></th>
+</tr>
+<tr>
+<th><img src="https://raw.githubusercontent.com/Klipper3d/klipper/master/docs/img/klipper-logo.png" alt="Klipper Logo" height="64"></th>
+<th><img src="https://avatars.githubusercontent.com/u/9563098?v=4" alt="Arksine avatar" height="64"></th>
+<th><img src="https://raw.githubusercontent.com/mainsail-crew/docs/master/assets/img/logo.png" alt="Mainsail Logo" height="64"></th>
+<th><img src="https://raw.githubusercontent.com/fluidd-core/fluidd/master/docs/assets/images/logo.svg" alt="Fluidd Logo" height="64"></th>
+</tr>
+<tr>
+<th>by <a href="https://github.com/KevinOConnor">KevinOConnor</a></th>
+<th>by <a href="https://github.com/Arksine">Arksine</a></th>
+<th>by <a href="https://github.com/mainsail-crew">mainsail-crew</a></th>
+<th>by <a href="https://github.com/fluidd-core">fluidd-core</a></th>
+</tr>
+<tr>
+<th><h3><a href="https://github.com/jordanruthe/KlipperScreen">KlipperScreen</a></h3></th>
+<th><h3><a href="https://github.com/nlef/moonraker-telegram-bot">Moonraker-Telegram-Bot</a></h3></th>
+<th><h3><a href="https://github.com/Kragrathea/pgcode">PrettyGCode for Klipper</a></h3></th>
+<th><h3><a href="https://github.com/OctoPrint/OctoPrint">OctoPrint</a></h3></th>
+</tr>
+<tr>
+<th><img src="https://avatars.githubusercontent.com/u/31575189?v=4" alt="jordanruthe avatar" height="64"></th>
+<th><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></th>
+<th><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></th>
+<th><img src="https://camo.githubusercontent.com/627be7fc67195b626b298af9b9677d7c58e698c67305e54324cffbe06130d4a4/68747470733a2f2f6f63746f7072696e742e6f72672f6173736574732f696d672f6c6f676f2e706e67" alt="OctoPrint Logo" height="64"></th>
+</tr>
+<tr>
+<th>by <a href="https://github.com/jordanruthe">jordanruthe</a></th>
+<th>by <a href="https://github.com/nlef">nlef</a></th>
+<th>by <a href="https://github.com/Kragrathea">Kragrathea</a></th>
+<th>by <a href="https://github.com/OctoPrint">OctoPrint</a></th>
+</tr>
+</table>
 
 ## **Credits**
 

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -2,6 +2,30 @@
 
 This document covers possible important changes to KIAUH.
 
+### 2022-04-XX
+KIAUH has now reached major version 4 !
+* feat: Klipper can be installed under Python3 (considered as experimental)
+* feat: Klipper can be installed from custom repositories / inofficial forks
+* feat: Custom instance name for multi instance installations of Klipper
+  * Any other multi instance will share the same name given to the corresponding Klipper instance
+  * E.g. klipper-voron2 -> moonraker-voron2 -> moonraker-telegram-bot-voron2
+* feat: Option to only allow the installation of stable Mainsail and Fluidd versions
+* feat: 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.)
+* fix: During Klipper installation, checks for group membership of `tty` and `dialout` are made
+* 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](
@@ -114,9 +138,9 @@ Each service gets its corresponding instance added to the service filename.
             --> moonraker-2.service
             --> moonraker-n.service
     ```
-* The same service file rules from above apply to DWC and OctoPrint even though only Klipper and Moonraker are shown in this example.
+* 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, DWC and OctoPrint instances from the KIAUH main menu. For doing this, just type "stop klipper", "start moonraker", "restart octoprint" and so on.
+* 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.
 

diff --git a/docs/features.md b/docs/features.md