move docs to github wiki
Signed-off-by: meteyou <meteyou@gmail.com>
This commit is contained in:
meteyou
parent
f6687a944d
commit
39fdb75a96
@ -4,7 +4,7 @@ Mainsail is a lightweight & responsive web interface for the [Klipper](https://g
|
||||
|
||||
|
||||
|
||||
To begin using Mainsail start by [installing](docs/installation.md) it or read the [documentation](docs/README.md) for more informations.
|
||||
To begin using Mainsail start by [installing](wiki/Installertion) it or read the [Wikipedia Pages](wiki) for more informations.
|
||||
|
||||
## Credit, sources and inspiration
|
||||
* [Kevin O'Connor](https://github.com/KevinOConnor) for the awesome 3D printer firmware [Klipper](https://github.com/KevinOConnor/klipper)
|
||||
|
||||
@ -1,7 +0,0 @@
|
||||
# Overview
|
||||
|
||||
- [Installation](installation.md)
|
||||
- [Update](update.md)
|
||||
- [Macros](macros.md)
|
||||
- [Slicer upload](slicer-upload.md)
|
||||
- [Gcode thumbnails (PrusaSlicer & SuperSlicer only)](gcode-thumbnails.md)
|
||||
@ -1,11 +0,0 @@
|
||||
# Gcode-thumbnails with PrusaSlicer and SuperSlicer
|
||||
Mainsail can display these thumbnails in the gcode filemanager. To enable the thumbnails,
|
||||
open your slicer (PrusaSlicer or SuperSlicer) click on `Help > Show Configuration Folder`
|
||||
and then inside the `printers` sub-folder you’ll find your printer profiles.
|
||||
|
||||
Open your desired printer profile in your favorite text editor and find the `thumbnails =`
|
||||
section and add the resolutions `32x32,400x300`. Save the file and restart your slicer.
|
||||
|
||||
Now you should see a preview in the filemanager and if you will start a new job.
|
||||
|
||||
|
||||
@ -1,294 +0,0 @@
|
||||
# Installation
|
||||
This document provides a guide on how to install Moonraker & Mainsail on a Raspberry
|
||||
Pi running Raspian/Rasperry Pi OS. Other SBCs and/or linux distributions
|
||||
may work, however they may need a custom install script.
|
||||
|
||||
**Please don't use a octopi image!!!**
|
||||
|
||||
## Installing operation system image
|
||||
It's recommend to use a clean Raspberry Pi OS 32-bit Lite (previosly called Raspbian)
|
||||
image. You can download it [here](https://downloads.raspberrypi.org/raspios_lite_armhf_latest).
|
||||
|
||||
More information about the installtion of Raspberry Pi OS are
|
||||
[here](https://www.raspberrypi.org/documentation/installation/installing-images/).
|
||||
|
||||
**If you have finished the installation and connected via ssh, you can continue.**
|
||||
|
||||
## Install Requirements
|
||||
```
|
||||
sudo apt update && sudo apt upgrade
|
||||
sudo apt install git dfu-util unzip
|
||||
```
|
||||
|
||||
## Install Klipper
|
||||
In this step, we install klipper.
|
||||
```
|
||||
cd ~
|
||||
git clone https://github.com/KevinOConnor/klipper
|
||||
cd ~/klipper
|
||||
./scripts/install-octopi.sh
|
||||
```
|
||||
|
||||
After you install Klipper with its dependencies you have to change the location
|
||||
of the `printer.cfg` and add the UDS. This is definied in the `/etc/default/klipper` file.
|
||||
To edit this file type:
|
||||
```
|
||||
sudo nano /etc/default/klipper
|
||||
```
|
||||
and then change:
|
||||
```
|
||||
KLIPPY_ARGS="/home/pi/klipper/klippy/klippy.py /home/pi/printer.cfg -l /tmp/klippy.log"
|
||||
```
|
||||
to:
|
||||
```
|
||||
KLIPPY_ARGS="/home/pi/klipper/klippy/klippy.py /home/pi/klipper_config/printer.cfg -l /tmp/klippy.log -a /tmp/klippy_uds"
|
||||
```
|
||||
Save the file with `CTRL+O` and close the editor with `CTRL+X`.
|
||||
|
||||
At least you have to create the config and the virtual_sdcard directory with:
|
||||
```
|
||||
mkdir ~/klipper_config
|
||||
mkdir ~/sdcard
|
||||
```
|
||||
and copy your `printer.cfg` in the `~/klipper_config` directory and restart klipper with
|
||||
`sudo service klipper restart`. Please check the `klippy.log`, if Klipper starts
|
||||
correctly and then continue the guide.
|
||||
|
||||
and check if you have following lines in your `printer.cfg`:
|
||||
```
|
||||
[virtual_sdcard]
|
||||
path: ~/sdcard
|
||||
|
||||
[pause_resume]
|
||||
[display_status]
|
||||
```
|
||||
|
||||
## Install Moonraker (API)
|
||||
You can now install the Moonraker application:
|
||||
```
|
||||
cd ~
|
||||
git clone https://github.com/Arksine/moonraker.git
|
||||
```
|
||||
|
||||
Finally, run Moonraker's install script:
|
||||
```
|
||||
cd ~/moonraker/scripts
|
||||
./install-moonraker.sh
|
||||
```
|
||||
|
||||
When the script completes it should start both Moonraker and Klipper. In
|
||||
`klippy.log` you should find the following entry:\
|
||||
`Moonraker: server connection detected`
|
||||
|
||||
### Configure Moonraker
|
||||
A basic configuration that authorizes clients on a range
|
||||
from 192.168.1.1 - 192.168.1.254 is as follows.
|
||||
|
||||
Create the configfile with `nano ~/moonraker.conf` and add the following lines:
|
||||
```
|
||||
[server]
|
||||
host: 0.0.0.0
|
||||
config_path: ~/klipper_config
|
||||
|
||||
[authorization]
|
||||
enabled: true
|
||||
trusted_clients:
|
||||
192.168.1.0/24
|
||||
```
|
||||
Note that the above configuration can differ! Make sure you determine your local IP and replace the IP from the example configuration above with the one from your own network.
|
||||
|
||||
Restart Moonraker (`sudo service moonraker restart`) and open the url `http://<printer-ip>:7125/printer/info` in your browser.
|
||||
|
||||
If you see a content like this
|
||||
```
|
||||
{"result": {"hostname": "voron250", "error_detected": false, "version": "v0.8.0-643-g528f9f25", "is_ready": true, "message": "Printer is ready", "cpu": "4 core ARMv7 Processor rev 4 (v7l)"}}
|
||||
```
|
||||
|
||||
your API is working!
|
||||
|
||||
For more informations about the Moonraker installation or configuration
|
||||
look at the Repository from Arksine:
|
||||
[Moonraker Repository install Documentation](https://github.com/Arksine/moonraker/blob/master/docs/installation.md)
|
||||
|
||||
## Install Mainsail (webinterface)
|
||||
|
||||
### Install webserver & reverse proxy (nginx)
|
||||
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:
|
||||
|
||||
```
|
||||
sudo apt install nginx
|
||||
```
|
||||
|
||||
now we create the config files with:
|
||||
|
||||
```
|
||||
sudo touch /etc/nginx/sites-available/mainsail
|
||||
sudo touch /etc/nginx/conf.d/upstreams.conf
|
||||
sudo touch /etc/nginx/conf.d/common_vars.conf
|
||||
```
|
||||
|
||||
Each file can be filled with the following content:
|
||||
|
||||
`sudo nano /etc/nginx/conf.d/upstreams.conf`
|
||||
```
|
||||
# /etc/nginx/conf.d/upstreams.conf
|
||||
|
||||
upstream apiserver {
|
||||
#edit your api port here
|
||||
ip_hash;
|
||||
server 127.0.0.1:7125;
|
||||
}
|
||||
|
||||
upstream mjpgstreamer {
|
||||
#edit your webcam port here
|
||||
ip_hash;
|
||||
server 127.0.0.1:8081;
|
||||
}
|
||||
```
|
||||
|
||||
`sudo nano /etc/nginx/conf.d/common_vars.conf`
|
||||
|
||||
```
|
||||
# /etc/nginx/conf.d/common_vars.conf
|
||||
|
||||
map $http_upgrade $connection_upgrade {
|
||||
default upgrade;
|
||||
'' close;
|
||||
}
|
||||
```
|
||||
|
||||
`sudo nano /etc/nginx/sites-available/mainsail`
|
||||
|
||||
```
|
||||
# /etc/nginx/sites-available/mainsail
|
||||
|
||||
server {
|
||||
listen 80 default_server;
|
||||
listen [::]:80 default_server;
|
||||
|
||||
access_log /var/log/nginx/mainsail-access.log;
|
||||
error_log /var/log/nginx/mainsail-error.log;
|
||||
|
||||
#disable this section on smaller hardware like a pi zero
|
||||
gzip on;
|
||||
gzip_vary on;
|
||||
gzip_proxied any;
|
||||
gzip_proxied expired no-cache no-store private auth;
|
||||
gzip_comp_level 4;
|
||||
gzip_buffers 16 8k;
|
||||
gzip_http_version 1.1;
|
||||
gzip_types text/plain text/css text/xml text/javascript application/x-javascript application/json application/xml;
|
||||
|
||||
#web_path from mainsail static files
|
||||
root /home/pi/mainsail;
|
||||
|
||||
index index.html;
|
||||
server_name _;
|
||||
|
||||
#max upload size for gcodes
|
||||
client_max_body_size 200M;
|
||||
|
||||
location / {
|
||||
try_files $uri $uri/ /index.html;
|
||||
}
|
||||
|
||||
location /printer {
|
||||
proxy_pass http://apiserver/printer;
|
||||
proxy_set_header Host $http_host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Scheme $scheme;
|
||||
}
|
||||
|
||||
location /api {
|
||||
proxy_pass http://apiserver/api;
|
||||
proxy_set_header Host $http_host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Scheme $scheme;
|
||||
}
|
||||
|
||||
location /access {
|
||||
proxy_pass http://apiserver/access;
|
||||
proxy_set_header Host $http_host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Scheme $scheme;
|
||||
}
|
||||
|
||||
location /websocket {
|
||||
proxy_pass http://apiserver/websocket;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection $connection_upgrade;
|
||||
proxy_set_header Host $http_host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_read_timeout 86400;
|
||||
}
|
||||
|
||||
location /machine {
|
||||
proxy_pass http://apiserver/machine;
|
||||
proxy_set_header Host $http_host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Scheme $scheme;
|
||||
}
|
||||
|
||||
location /server {
|
||||
proxy_pass http://apiserver/server;
|
||||
proxy_set_header Host $http_host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Scheme $scheme;
|
||||
}
|
||||
|
||||
location /webcam/ {
|
||||
proxy_pass http://mjpgstreamer/;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Create directory for static files and active nginx config:
|
||||
```
|
||||
mkdir ~/mainsail
|
||||
sudo rm /etc/nginx/sites-enabled/default
|
||||
sudo ln -s /etc/nginx/sites-available/mainsail /etc/nginx/sites-enabled/
|
||||
sudo service nginx restart
|
||||
```
|
||||
|
||||
Now you can check again the API if it works with the reverse proxy.
|
||||
Open the url `http://<printer-ip>/printer/info` in your browser. if you see a content like this:
|
||||
```
|
||||
{"result": {"hostname": "voron250", "error_detected": false, "version": "v0.8.0-479-gd586fb06", "is_ready": true, "message": "Printer is ready", "cpu": "4 core ARMv7 Processor rev 4 (v7l)"}}
|
||||
```
|
||||
|
||||
Now we can install Mainsail (static httpdocs).
|
||||
|
||||
### Install httpdocs
|
||||
Now you can download the current mainsail static data
|
||||
```
|
||||
cd ~/mainsail
|
||||
wget -q -O mainsail.zip https://github.com/meteyou/mainsail/releases/download/v0.2.6/mainsail-beta-0.2.6.zip && unzip mainsail.zip && rm mainsail.zip
|
||||
```
|
||||
Now it should be possible to open the interface: `http://<printer-ip>/`.
|
||||
|
||||
### Important macros
|
||||
if you want to get the full experience with mainsail and klipper virtual_sdcard print,
|
||||
you should use these macros, or use them as templates for your own.
|
||||
|
||||
[Link to the macros doc](macros.md)
|
||||
|
||||
### Change the Hostname (optional)
|
||||
to use the hostname instate of the ip, you can install the avahi-daemon:
|
||||
```
|
||||
sudo apt install avahi-daemon
|
||||
```
|
||||
|
||||
and you can config your hostname:
|
||||
```
|
||||
sudo raspi-config
|
||||
```
|
||||
in 2 Network Options > N1 Hostname you can edit your hostname of your raspberry pi.
|
||||
After a reboot you can use `http://<hostname>.local/` to open the webinterface.
|
||||
@ -1,55 +0,0 @@
|
||||
# Useful macros for Moonraker/Mainsail
|
||||
|
||||
## pause / resume / cancel
|
||||
```
|
||||
#is required to load the pause_resume module in klipper
|
||||
[pause_resume]
|
||||
|
||||
[gcode_macro PAUSE]
|
||||
rename_existing: BASE_PAUSE
|
||||
default_parameter_X: 230 #edit to your park position
|
||||
default_parameter_Y: 230 #edit to your park position
|
||||
default_parameter_Z: 10 #edit to your park position
|
||||
default_parameter_E: 1 #edit to your retract length
|
||||
gcode:
|
||||
SAVE_GCODE_STATE NAME=PAUSE_state
|
||||
BASE_PAUSE
|
||||
G91
|
||||
G1 E-{E} F2100
|
||||
G1 Z{Z}
|
||||
G90
|
||||
G1 X{X} Y{Y} F6000
|
||||
|
||||
[gcode_macro RESUME]
|
||||
rename_existing: BASE_RESUME
|
||||
default_parameter_E: 1 #edit to your retract length
|
||||
gcode:
|
||||
G91
|
||||
G1 E{E} F2100
|
||||
G90
|
||||
RESTORE_GCODE_STATE NAME=PAUSE_state MOVE=1
|
||||
BASE_RESUME
|
||||
|
||||
[gcode_macro CANCEL_PRINT]
|
||||
rename_existing: BASE_CANCEL_PRINT
|
||||
gcode:
|
||||
TURN_OFF_HEATERS
|
||||
CLEAR_PAUSE
|
||||
SDCARD_RESET_FILE
|
||||
BASE_CANCEL_PRINT
|
||||
```
|
||||
|
||||
## customize klipper default commands
|
||||
for example, if you want to adjust the BED_MESH_CALIBRATE command, which will execute under "heightmap > calibrate".
|
||||
```
|
||||
[gcode_macro BED_MESH_CALIBRATE]
|
||||
rename_existing: BASE_BED_MESH_CALIBRATE
|
||||
gcode:
|
||||
#before the original gcode
|
||||
BED_MESH_CLEAR
|
||||
QUAD_GANTRY_LEVEL
|
||||
G1 X125 Y125 Z5 F6000
|
||||
#the original gcode
|
||||
BASE_BED_MESH_CALIBRATE
|
||||
#after the original gcode
|
||||
```
|
||||
@ -1,7 +0,0 @@
|
||||
# Upload Gcodes from your Slicer
|
||||
|
||||
You can upload your gcode-files from your slicer. Moonraker simulate the octoprint-upload.
|
||||
Just set the slicer to octoprint, enter the hostname or ip and fill in the API-Key field
|
||||
with something.
|
||||
|
||||
|
||||
@ -1,53 +0,0 @@
|
||||
# Update Mainsail
|
||||
|
||||
## Update Klipper
|
||||
```
|
||||
cd ~/klipper
|
||||
git fetch
|
||||
git checkout origin/master
|
||||
```
|
||||
|
||||
Please check the location of the `~/klipper_config/printer.cfg` and the UDS (`-a /tmp/klippy_uds`) in the `/etc/default/klipper` file. This
|
||||
should look like:
|
||||
```
|
||||
KLIPPY_ARGS="/home/pi/klipper/klippy/klippy.py /home/pi/klipper_config/printer.cfg -l /tmp/klippy.log -a /tmp/klippy_uds"
|
||||
```
|
||||
If you have to change the location of `printer.cfg` in `/etc/default/klipper`
|
||||
please create the directory `~/klipper_config` and move your config files in this directory.
|
||||
|
||||
Restart Klipper (`sudo service klipper restart`) and check the `klippy.log`, if Klipper starts
|
||||
correctly and then continue the guide.
|
||||
|
||||
## Update Moonraker (API)
|
||||
```
|
||||
cd ~/moonraker
|
||||
git fetch
|
||||
git checkout origin/master
|
||||
```
|
||||
|
||||
Restart Moonraker (`sudo service moonraker restart`) and open the url `http://<printer-ip>:7125/printer/info` in your browser.
|
||||
|
||||
If you see a content like this
|
||||
```
|
||||
{"result": {"hostname": "voron250", "error_detected": false, "version": "v0.8.0-643-g528f9f25", "is_ready": true, "message": "Printer is ready", "cpu": "4 core ARMv7 Processor rev 4 (v7l)"}}
|
||||
```
|
||||
|
||||
### Update moonraker dependence
|
||||
This is only nessasary, if your moonraker version is older than 31. october 2020.
|
||||
```
|
||||
~/moonraker/scripts/install-moonraker.sh
|
||||
```
|
||||
|
||||
## Update Mainsail (webinterface)
|
||||
```
|
||||
cd ~/mainsail
|
||||
rm -R ./*
|
||||
wget -q -O mainsail.zip https://github.com/meteyou/mainsail/releases/download/v0.2.6/mainsail-beta-0.2.6.zip && unzip mainsail.zip && rm mainsail.zip
|
||||
```
|
||||
### Move gui.json from gcodes to klipper_config
|
||||
This is only necessary if you update from 0.2.2 to 0.2.3 or higher. If you use MainsailOS, the virtual_sdcard directory is `gcode_files` instead of `sdcard`.
|
||||
```
|
||||
mv ~/sdcard/gui.json ~/klipper_config/
|
||||
```
|
||||
|
||||
Now it should be possible to open the interface: `http://<printer-ip>/`.
|
||||
Loading…
x
Reference in New Issue
Block a user