jeka/kiauh
1
0
Fork 0
mirror of https://github.com/dw-0/kiauh.git synced 2025-12-11 17:44:28 +05:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
th33xitus
2020-07-24 23:05:24 +02:00
committed by GitHub
parent 5651ce2d63
commit 37b23129c0
1 changed files with 40 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
README.md
View File

@@ -4,22 +4,23 @@
## Klipper Installation And Update Helper
[![kiauh](https://abload.de/img/mobaxterm_personal_207mk20.png)](https://abload.de/image.php?img=mobaxterm_personal_207mk20.png)
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.~~
![main_menu](https://raw.githubusercontent.com/th33xitus/kiauh/dev-2.0/resources/screenshots/main.png)
![remove_menu](https://raw.githubusercontent.com/th33xitus/kiauh/dev-2.0/resources/screenshots/remove.png)
![update_menu](https://raw.githubusercontent.com/th33xitus/kiauh/dev-2.0/resources/screenshots/update.png)
![advanced_menu](https://raw.githubusercontent.com/th33xitus/kiauh/dev-2.0/resources/screenshots/advanced.png)
## First things first: When you decide to use this script, you use it at your own risk!
Give it a try if you want and if you have suggestions or encounter any problems, please report them. But i can't guarantee that i will fix them immediately (or at all).
Give it a try if you want and if you have suggestions or encounter any problems, please report them to me.
## Instructions:
In order to run this script you have to make it executable. Use the following commands in the given order to download and execute the script.
Make sure you don't skip checking out the development branch if you want to use this new version of the script.
If you don't have git already installed on your machine run `sudo apt-get install git -y` to install git first. You will need it anyways!
```
After you have successfully installed git, use the following commands in the given order to download and execute the script.
Make sure you **don't skip checking out the development branch** if you want to use this new version of the script.
```shell
cd ~
git clone https://github.com/th33xitus/kiauh.git
cd kiauh && git checkout dev-2.0
@@ -31,39 +32,43 @@ chmod +x ~/kiauh/scripts/*
## Restrictions:
- Tested only on Raspbian Buster Lite
- Prevent simultaneous use of DWC2 and OctoPrint. There have been reports that DWC2 does strange things while the OctoPrint service is running while using the DWC2 web interface. The script disables an existing OctoPrint service when installing DWC2. However, the service can also be reactivated with the script!
- Prevent simultaneous use of DWC2 and OctoPrint if possible. There have been reports that DWC2 does strange things while the OctoPrint service is running while using the DWC2 webinterface. The script disables an existing OctoPrint service when installing DWC2. However, the service can also be reactivated with the script!
## Notes:
During the use of this script you will be asked for your sudo password. There are several functions involved which need sudo privileges.
## Functions and Features:
- Installing:
- Klipper
- dwc2-for-klipper + Duet Web Control
- Moonraker + Mainsail
- OctoPrint
- Updating:
- Klipper
- dwc2-for-klipper + Duet Web Control
- Moonraker + Mainsail
- Removing:
- Klipper
- dwc2-for-klipper + Duet Web Control
- Moonraker + Mainsail
- OctoPrint
### Core Functions:
- **Install:** Klipper Firmware, dwc2-for-klipper + Duet Web Control, Moonraker + Mainsail, OctoPrint
- **Update:** Klipper Firmware, dwc2-for-klipper + Duet Web Control, Moonraker + Mainsail
- **Backup:** Klipper Firmware, dwc2-for-klipper + Duet Web Control, Moonraker + Mainsail, OctoPrint
- **Remove:** Klipper Firmware, dwc2-for-klipper + Duet Web Control, Moonraker + Mainsail, OctoPrint
- Build Klipper Firmware
- Flash MCU
- Read ID of currently connected printer
- Read ID of the currently connected printer (only one at the time)
- Write several entries to your printer.cfg, some of them customizable right in the console
- Switch between Klipper Forks:
- scurve-shaping
- scurve-smoothing
- moonraker
- dev-moonraker
- Toggle auto-create backups before updating
- Toggle OctoPrint Service (usefull when using DWC2/Mainsail and Octoprint at the same time)
- Before writing to an existing printer.cfg the script will create a backup! (better safe than sorry!)
- Set up reverse proxy for Mainsail/OctoPrint
### Features:
- Automatic dependency check:
- If packages are missing on your machine but needed for the asked task, the script will automatically install them
- Switch between Klipper Forks:
- origin/master, scurve-shaping, scurve-smoothing, moonraker, dev-moonraker
- The update function of the script will always update the currently selected/active fork!
- Toggle auto-create backups before updating:
- When enabled, a backup of the installation you want to update is made prior updating
- Preconfigure OctoPrint:
- When installing OctoPrint, a config is created which preconfigures your installation to be used with Klipper
- adding the restart/shutdown commands for OctoPrint
- adding the serial port `/tmp/printer`
- set the behavior to "Cancel any ongoing prints but stay connected to the printer"
- Enable/Disable OctoPrint Service:
- Usefull when using DWC2/Mainsail and Octoprint at the same time to prevent them interfering with each other
- Set up reverse proxy for DWC2, Mainsail and OctoPrint and changing the hostname:
- The script can install and configure Nginx for the selected webinterface. This will allow you to make your webinterface reachable over an URL like `<hostname>.local`
- Example: If you name the host "mainsail" and set up a reverse proxy, type `mainsail.local` in your webbrowser to open the Mainsail webinterface
tbc ...