Skip to content

Commit a163eaf

Browse files
meteyougitbook-bot
authored andcommitted
GITBOOK-205: No subject
1 parent 4ae22f6 commit a163eaf

File tree

1 file changed

+49
-13
lines changed

1 file changed

+49
-13
lines changed

setup/getting-started/manual-setup.md

Lines changed: 49 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,24 @@ _Please check and modify the username, if you do not use the user pi, you have t
1414
Don’t forget to enable SSH and configure a network if using Wi-Fi.
1515
{% endhint %}
1616

17-
It is recommended to use a clean [Raspberry Pi OS 32-bit Lite](https://downloads.raspberrypi.org/raspios\_lite\_armhf\_latest) image. If you don't use a Raspberry Pi as SBC, every default Debian Buster / Bullseye (recommended) should also fit with this guide.
17+
It is recommended to use a clean [Raspberry Pi OS 64-bit Lite](https://downloads.raspberrypi.org/raspios_lite_arm64_latest) image. If you don't use a Raspberry Pi as SBC, every default Debian Bullseye / Bookworm (recommended) should also fit with this guide.
1818

1919
We recommend you follow the Raspberry Pi OS official [documentation](https://www.raspberrypi.org/documentation/installation/installing-images/) to flash and install the operating system to your SD card.
2020

2121
Once you have finished the installation and are connected via SSH, you can continue.
2222

23-
### &#x20;Requirements <a href="#requirements" id="requirements"></a>
23+
### Requirements <a href="#requirements" id="requirements"></a>
2424

2525
Install the required packages and update the system:
2626

2727
{% tabs %}
28+
{% tab title="Debian 12 (Bookworm)" %}
29+
```bash
30+
sudo apt update && sudo apt upgrade -y
31+
sudo apt install git unzip
32+
```
33+
{% endtab %}
34+
2835
{% tab title="Debian 11 (Bullseye)" %}
2936
```bash
3037
sudo apt update && sudo apt upgrade -y
@@ -42,11 +49,19 @@ sudo apt install git unzip
4249

4350
## Klipper <a href="#klipper" id="klipper"></a>
4451

45-
### &#x20;Installation <a href="#installation" id="installation"></a>
52+
### Installation <a href="#installation" id="installation"></a>
4653

4754
At first we have to install some OS dependencies:
4855

4956
{% tabs %}
57+
{% tab title="Debian 12 (Bookworm)" %}
58+
{% code overflow="wrap" %}
59+
```bash
60+
sudo apt install python3-virtualenv python3-dev python3-dev libffi-dev build-essential libncurses-dev avrdude gcc-avr binutils-avr avr-libc stm32flash dfu-util libnewlib-arm-none-eabi gcc-arm-none-eabi binutils-arm-none-eabi libusb-1.0-0 libusb-1.0-0-dev
61+
```
62+
{% endcode %}
63+
{% endtab %}
64+
5065
{% tab title="Debian 11 (Bullseye)" %}
5166
{% code overflow="wrap" %}
5267
```bash
@@ -68,7 +83,7 @@ The following commands will clone Klipper to an appropriate directory in HOME.
6883

6984
```bash
7085
cd ~
71-
git clone https://github.com/KevinOConnor/klipper
86+
git clone https://github.com/Klipper3d/klipper
7287
```
7388

7489
Then we can initialize the python virtual environment and install the python dependencies:
@@ -78,7 +93,7 @@ Then we can initialize the python virtual environment and install the python dep
7893
</strong>./klippy-env/bin/pip install -r ./klipper/scripts/klippy-requirements.txt
7994
</code></pre>
8095

81-
### &#x20;Configuration & startup service <a href="#configuration--startup-service" id="configuration--startup-service"></a>
96+
### Configuration & startup service <a href="#configuration--startup-service" id="configuration--startup-service"></a>
8297

8398
After Klipper is installed, you will need to create the file structure for Klipper & Moonraker.
8499

@@ -156,11 +171,19 @@ After your config is in place, restart Klipper with `sudo systemctl start klippe
156171

157172
Moonraker is a web server that exposes APIs which lets Mainsail interact with Klipper.
158173

159-
### &#x20;Installation <a href="#installation" id="installation"></a>
174+
### Installation <a href="#installation" id="installation"></a>
160175

161176
At first we have to install some OS dependencies:
162177

163178
{% tabs %}
179+
{% tab title="Debian 12 (Bookworm)" %}
180+
{% code overflow="wrap" %}
181+
```bash
182+
sudo apt install python3-virtualenv python3-dev libopenjp2-7 python3-libgpiod curl libcurl4-openssl-dev libssl-dev liblmdb-dev libsodium-dev zlib1g-dev libjpeg-dev packagekit wireless-tools
183+
```
184+
{% endcode %}
185+
{% endtab %}
186+
164187
{% tab title="Debian 11 (Bullseye)" %}
165188
{% code overflow="wrap" %}
166189
```bash
@@ -193,7 +216,7 @@ virtualenv -p python3 ./moonraker-env
193216
./moonraker-env/bin/pip install -r ./moonraker/scripts/moonraker-requirements.txt
194217
```
195218

196-
### &#x20;Configuration <a href="#configuration" id="configuration"></a>
219+
### Configuration <a href="#configuration" id="configuration"></a>
197220

198221
{% hint style="warning" %}
199222
**Please pay attention to the following steps!**\
@@ -202,7 +225,9 @@ A very common source of errors are improperly configured `trusted_clients`.
202225

203226
For Moonraker you’ll need to create a separate config file.
204227

205-
`nano ~/printer_data/config/moonraker.conf`
228+
```bash
229+
nano ~/printer_data/config/moonraker.conf
230+
```
206231

207232
Insert the following part:
208233

@@ -269,7 +294,7 @@ For example, an entry of 192.168.1.0/24 will authorize IP addresses in the range
269294

270295
Save the file with `CTRL+O` and close the editor with `CTRL+X`.
271296

272-
### &#x20;Startup service <a href="#startup-service" id="startup-service"></a>
297+
### Startup service <a href="#startup-service" id="startup-service"></a>
273298

274299
To edit this file type:
275300

@@ -353,7 +378,7 @@ If everything has been set up successfully, a message like this should appear:
353378

354379
## Mainsail <a href="#mainsail" id="mainsail"></a>
355380

356-
### &#x20;Install web server & reverse proxy (NGINX) <a href="#install-web-server--reverse-proxy-nginx" id="install-web-server--reverse-proxy-nginx"></a>
381+
### Install web server & reverse proxy (NGINX) <a href="#install-web-server--reverse-proxy-nginx" id="install-web-server--reverse-proxy-nginx"></a>
357382

358383
NGINX is important to mount all components on port 80 and host the static files from Mainsail. To install NGINX you only need to execute:
359384

@@ -546,7 +571,7 @@ Now you can recheck the API to see if it works with the reverse proxy. Open the
546571

547572
Now we can install Mainsail.
548573

549-
### &#x20;Install `httpdocs` <a href="#install-httpdocs" id="install-httpdocs"></a>
574+
### Install `httpdocs` <a href="#install-httpdocs" id="install-httpdocs"></a>
550575

551576
Now you can download the current Mainsail static data.
552577

@@ -557,13 +582,24 @@ wget -q -O mainsail.zip https://github.com/mainsail-crew/mainsail/releases/lates
557582

558583
Now it should be possible to open the interface: `http://<printer-ip>/`.
559584

560-
### &#x20;Important macros <a href="#important-macros" id="important-macros"></a>
585+
{% hint style="warning" %}
586+
With **Debian 12 (Bookworm)** you have to add the correct user rights. Execute these lines to add the www-data user to the pi group and set executeable rights to the home directory:
587+
588+
```bash
589+
sudo gpasswd -a www-data pi
590+
sudo chmod g+x /home/pi
591+
```
592+
593+
Change the username `pi`, if you changed it or use a different default username.
594+
{% endhint %}
595+
596+
## Important macros
561597

562598
If you want the whole experience with Mainsail and Klipper `virtual_sdcard` print, you should use these macros or use them as templates for your own.
563599

564600
[Macro Link](https://docs.mainsail.xyz/setup/configuration)
565601

566-
### &#x20;Use hostname instead of IP to open Mainsail (optional) <a href="#change-the-hostname-optional" id="change-the-hostname-optional"></a>
602+
## Use hostname instead of IP to open Mainsail (optional) <a href="#change-the-hostname-optional" id="change-the-hostname-optional"></a>
567603

568604
To use the hostname instate of the IP, you can install the avahi-daemon:
569605

0 commit comments

Comments
 (0)