CreatBot/GeneralKlipperScreen
7
0
Fork 0
forked from CreatBot/CreatBotKlipperScreen
Code Pull Requests Activity

docs/Installation: Updates to installation instructions

Browse Source
This commit is contained in:
Jordan Ruthe 2021-01-25 20:48:14 -05:00
parent f1ced2ac46
commit d25f642716
1 changed files with 27 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/Installation.md
View File

@ -19,12 +19,15 @@ After changing _/boot/config.txt_ you must reboot your raspberry pi. Please also
### Installation ### Installation
#### Setup Raspberry Pi
This install process is meant for Raspbian non-desktop version. If you have installed it on the GUI version, use This install process is meant for Raspbian non-desktop version. If you have installed it on the GUI version, use
`sudo raspi-config` to set boot to console by choosing the following options in order: `sudo raspi-config` to set boot to console by choosing the following options in order:
* 1 System Options * 1 System Options
* S5 Boot / Auto Login * S5 Boot / Auto Login
* B1 Console * B1 Console
#### Klipper and Moonraker Installation
Follow the instructions to install klipper and moonraker. Follow the instructions to install klipper and moonraker.
klipper: https://github.com/KevinOConnor/klipper/ klipper: https://github.com/KevinOConnor/klipper/
moonraker: https://github.com/Arksine/moonraker moonraker: https://github.com/Arksine/moonraker
@ -36,12 +39,31 @@ trusted_clients:
127.0.0.1 127.0.0.1
``` ```
For moonraker, ensure that 127.0.0.1 is a trusted client: If you wish to use the update manager feature of moonraker for KlipperScreen, add the following block into the moonraker
configuration:
```
[update_manager client KlipperScreen]
type: git_repo
path: /home/pi/KlipperScreen
origin: https://github.com/jordanruthe/KlipperScreen.git
env: /home/pi/.KlipperScreen-env/bin/python
requirements: scripts/KlipperScreen-requirements.txt
install_script: scripts/KlipperScreen-install.sh
```
Run _scripts/KlipperScreen-install.sh_ #### KlipperScreen Installation
This script will install packages that are listed under manual install, create a After you clone KlipperScreen, run the following commands:
python virtual environment at ${HOME}/.KlipperScreen-env and install a systemd ```
service file. cd KlipperScreen
./scripts/KlipperScreen-install.sh
```
This script will install packages that are listed under manual install, create a python virtual environment at
${HOME}/.KlipperScreen-env and install a systemd service file.
KlipperScreen will create a log file output at `/tmp/KlipperScreen.log`. If you are having issues and KlipperScreen has
not gotten to the point where the log file has been created. Run `journalctl -xe -u KlipperScreen` to view the ouput and
see any issues that may be happening.
As an option to do development or interact with KlipperScreen from your computer, you may install tigervnc-scraping-server and VNC to your pi instance. Follow tigervnc server setup procedures for details on how to do that. As an option to do development or interact with KlipperScreen from your computer, you may install tigervnc-scraping-server and VNC to your pi instance. Follow tigervnc server setup procedures for details on how to do that.