295 lines
13 KiB
Markdown
295 lines
13 KiB
Markdown
<p align="center">
|
|
<img src="docs/assets/logo-large.png" alt="KIAUH Logo" height="181">
|
|
<h1 align="center">Klipper Installation And Update Helper</h1>
|
|
</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/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>
|
|
|
|
<hr>
|
|
|
|
<h2 align="center">⚠️ Official Website Disclaimer ⚠️</h2>
|
|
|
|
**The only official source and website for KIAUH is this GitHub repository:
|
|
[https://github.com/dw-0/kiauh/](https://github.com/dw-0/kiauh/).**
|
|
|
|
The website **kiauh[.]com** is **not** an official website of this project and
|
|
is **not** affiliated with, endorsed by, or connected to KIAUH or its maintainer
|
|
[dw-0](https://github.com/dw-0) in any way. Its operator neither asked for
|
|
permission nor informed the maintainer. The maintainer has no control over, and
|
|
takes no responsibility for, its content, downloads, instructions, or any other
|
|
material offered there.
|
|
|
|
Please be aware of the following:
|
|
|
|
* **Do not download, open, or run anything from kiauh[.]com.** Its start page
|
|
offers a ZIP file for download. Under no circumstances should you download it,
|
|
open it, or execute any code from it. Its contents are unverified and may be
|
|
malicious.
|
|
* **Do not use the contact form on kiauh[.]com.** It does not send your message to
|
|
any official party of this project. Never submit the form or disclose personal
|
|
data there. This repository is the only official source and communication channel.
|
|
* **Do not let its appearance, name, or content mislead you.** It is not the project's website, regardless
|
|
of how it presents itself.
|
|
* **Do not trust any of the information.** Any statement on that site about KIAUH, its usage, its support, or its
|
|
licensing has no connection to the maintainer and may be inaccurate or
|
|
outdated.
|
|
|
|
Please download and install KIAUH from this repository only. Do not run scripts
|
|
or commands obtained from any other source without verifying them against this
|
|
repository first.
|
|
|
|
The KIAUH name and logo must not be used in a way that suggests an official
|
|
affiliation with or endorsement by this project.
|
|
|
|
If you come across websites or sources that present or suggest themselves as official KIAUH
|
|
channels, please report them in the
|
|
[GitHub Discussions](https://github.com/dw-0/kiauh/discussions).
|
|
|
|
This statement remains valid until explicitly revoked by the maintainer.
|
|
|
|
<hr>
|
|
|
|
<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="docs/assets/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="docs/assets/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">⚙️ Core Components ⚙️</h2>
|
|
|
|
<table align="center" style="text-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/KlipperScreen/KlipperScreen">KlipperScreen</a></h3></th>
|
|
<th></th>
|
|
</tr>
|
|
<tr>
|
|
<th><img src="https://raw.githubusercontent.com/fluidd-core/fluidd/master/docs/docs/assets/images/logo.svg" alt="Fluidd Logo" height="64"></th>
|
|
<th><img src="https://avatars.githubusercontent.com/KlipperScreen?v=4" alt="KlipperScreen Logo" height="64"></th>
|
|
<th></th>
|
|
</tr>
|
|
<tr>
|
|
<th>by <a href="https://github.com/fluidd-core">fluidd-core</a></th>
|
|
<th>by <a href="https://github.com/alfrix">alfrix</a></th>
|
|
<th></th>
|
|
</tr>
|
|
</table>
|
|
|
|
<hr>
|
|
|
|
<h2 align="center">🧩 Community Extensions 🧩</h2>
|
|
|
|
<table align="center" style="text-align: center;">
|
|
<tr>
|
|
<th><h3><a href="https://github.com/OctoPrint/OctoPrint">OctoPrint</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>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="https://github.com/OctoPrint/OctoPrint"><img src="https://raw.githubusercontent.com/OctoPrint/OctoPrint/master/docs/images/octoprint-logo.png" alt="OctoPrint Logo" height="64"></a></th>
|
|
<th><a href="https://github.com/nlef/moonraker-telegram-bot"><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></a></th>
|
|
<th><a href="https://github.com/Kragrathea/pgcode"><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></a></th>
|
|
</tr>
|
|
<tr>
|
|
<th>by <a href="https://github.com/OctoPrint">OctoPrint</a></th>
|
|
<th>by <a href="https://github.com/nlef">nlef</a></th>
|
|
<th>by <a href="https://github.com/Kragrathea">Kragrathea</a></th>
|
|
</tr>
|
|
<tr>
|
|
<th><h3><a href="https://github.com/TheSpaghettiDetective/moonraker-obico">Obico for Klipper</a></h3></th>
|
|
<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>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="https://github.com/TheSpaghettiDetective/moonraker-obico"><img src="https://avatars.githubusercontent.com/u/46323662?s=200&v=4" alt="Obico logo" height="64"></a></th>
|
|
<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>
|
|
</tr>
|
|
<tr>
|
|
<th>by <a href="https://github.com/TheSpaghettiDetective">Obico</a></th>
|
|
<th>by <a href="https://github.com/Clon1998">Patrick Schmidt</a></th>
|
|
<th>by <a href="https://github.com/QuinnDamerell">Quinn Damerell</a></th>
|
|
</tr>
|
|
<tr>
|
|
<th><h3><a href="https://github.com/crysxd/OctoApp-Plugin">OctoApp For Klipper</a></h3></th>
|
|
<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://octoapp.eu/?source=kiauh_readme"><img src="https://octoapp.eu/octoapp.webp" alt="OctoApp Logo" height="64"></a></th>
|
|
<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="SimplyPrint Logo" height="64"></a></th>
|
|
</tr>
|
|
<tr>
|
|
<th>by <a href="https://github.com/crysxd">Christian Würthner</a></th>
|
|
<th>by <a href="https://github.com/Staubgeborener">Staubgeborener</a></th>
|
|
<th>by <a href="https://github.com/SimplyPrint">SimplyPrint</a></th>
|
|
</tr>
|
|
<tr>
|
|
<th><h3><a href="https://github.com/CodeMasterCody3D/DroidKlipp">DroidKlipp</a></h3></th>
|
|
<th><h3><a href="https://github.com/PEEKYPAUL/Moongate">Moongate</a></h3></th>
|
|
<th></th>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="https://github.com/CodeMasterCody3D/DroidKlipp"><img src="https://raw.githubusercontent.com/CodeMasterCody3D/DroidKlipp/main/logo.png" alt="DroidKlipp Logo" height="64"></a></th>
|
|
<th><a href="https://github.com/PEEKYPAUL/Moongate"><img src="https://raw.githubusercontent.com/PEEKYPAUL/Moongate/master/docs/moongate-icon.png" alt="Moongate Logo" height="64"></a></th>
|
|
<th></th>
|
|
</tr>
|
|
<tr>
|
|
<th>by <a href="https://github.com/CodeMasterCody3D">CodeMasterCody3D</a></th>
|
|
<th>by <a href="https://github.com/PEEKYPAUL">PEEKYPAUL</a></th>
|
|
<th></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!
|