Update root README.md
This commit is contained in:
Stefan Dej
parent
be7abdf254
commit
e98d6c0ba9
249
README.md
249
README.md
@ -1,248 +1,7 @@
|
||||
# Mainsail
|
||||
Mainsail is a responsive web interface for the [Klipper](https://github.com/KevinOConnor/klipper) 3D printer firmware. It communicates with the Moonraker (Klipper-API) from [Arksine](https://github.com/arksine).
|
||||
Mainsail is a lightweight & responsive web interface for the [Klipper](https://github.com/KevinOConnor/klipper)
|
||||
3D printer firmware. It communicates with the [Moonraker (Klipper-API)](https://github.com/arksine/moonraker) from [Arksine](https://github.com/arksine).
|
||||
|
||||
## Automatic Install Scripts
|
||||
* [Installer from ArmyAg08](https://github.com/ArmyAg08/mainsail-installer) (recommended)
|
||||
* [Installer from BlackStump](https://github.com/BlackStump/mainsail-install) (untested)
|
||||
|
||||
|
||||
## Manual installation of Mainsail
|
||||
Mainsail requires a working Klipper instance. Please head over to the official Klipper [installation documentation](https://www.klipper3d.org/Installation.html).
|
||||
|
||||
The installation is split into several sections:
|
||||
|
||||
- [Change branch for Klipper-API](#change-branch-for-moonraker)
|
||||
- [Configure Klipper-API](#configure-moonraker)
|
||||
- [Install the Webserver & Reverse Proxy (NGINX)](#install-webserver--reverse-proxy-nginx)
|
||||
- [Install & Configure Mainsail](#install--configure-mainsail)
|
||||
- [Change the Hostname](#change-the-hostname-optional)
|
||||
|
||||
### Change branch for Moonraker
|
||||
The Klipper-API isn't merged in Klipper at the moment, so you have to change the Repository to [Arksine's Fork](https://github.com/Arksine/klipper/tree/work-web_server-20200131/klippy/extras/remote_api) with the Klipper-API.
|
||||
|
||||
```bash
|
||||
cd ~/klipper
|
||||
git remote add arksine https://github.com/Arksine/klipper.git
|
||||
git fetch arksine
|
||||
git checkout arksine/work-web_server-20200131
|
||||
~/klipper/scripts/install-moonraker.sh
|
||||
```
|
||||
|
||||
### Configure Moonraker
|
||||
Edit your `printer.cfg` with `nano ~/printer.cfg` and add the following lines:
|
||||
```
|
||||
[virtual_sdcard]
|
||||
path: /home/pi/sdcard
|
||||
|
||||
[api_server]
|
||||
trusted_clients:
|
||||
192.168.0.0/24
|
||||
127.0.0.1
|
||||
```
|
||||
Edit the first line of `trusted_clients` (192.168.0.0/24) to your network. The second line (127.0.0.0/24) is for reverse proxy later.
|
||||
If you need other options in your API you can find all options with descriptions on [Arksine's Fork](https://github.com/Arksine/klipper/tree/work-web_server-20200131/moonraker).
|
||||
|
||||
Finally, we create the `virtual_sdcard` directory:
|
||||
```
|
||||
mkdir ~/sdcard
|
||||
```
|
||||
Restart klipper (`sudo service klipper restart`) and check your klippy.log if klipper is starting correct again.
|
||||
|
||||
When klipper is running, 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-479-gd586fb06", "is_ready": true, "message": "Printer is ready", "cpu": "4 core ARMv7 Processor rev 4 (v7l)"}}
|
||||
```
|
||||
your API is working!
|
||||
|
||||
### install webserver & reverse proxy (nginx)
|
||||
nginx is important to mount all components on port 80 and host the static files from Mainsail.
|
||||
|
||||
If you have installed lighttpd & haproxy before you have to stop & disable it:
|
||||
```bash
|
||||
sudo service haproxy stop
|
||||
sudo service lighttpd stop
|
||||
sudo apt remove haproxy lighttpd
|
||||
```
|
||||
|
||||
After disable all other webserver you can install nginx now:
|
||||
```bash
|
||||
sudo apt install nginx
|
||||
```
|
||||
now we create the config file with
|
||||
```bash
|
||||
sudo nano /etc/nginx/sites-available/mainsail
|
||||
```
|
||||
and fill it with the following content:
|
||||
```
|
||||
map $http_upgrade $connection_upgrade {
|
||||
default upgrade;
|
||||
'' close;
|
||||
}
|
||||
|
||||
upstream apiserver {
|
||||
#edit your api port here
|
||||
ip_hash;
|
||||
server 127.0.0.1:7125;
|
||||
}
|
||||
|
||||
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;
|
||||
|
||||
#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;
|
||||
}
|
||||
}
|
||||
```
|
||||
Create directory for static files and active nginx config:
|
||||
```bash
|
||||
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.
|
||||
|
||||
### Install & Configure Mainsail
|
||||
Now you can download the current mainsail static data
|
||||
```bash
|
||||
cd ~/mainsail
|
||||
wget -q -O mainsail.zip https://github.com/meteyou/mainsail/releases/download/v0.0.12/mainsail-alpha-0.0.12.zip && unzip mainsail.zip && rm mainsail.zip
|
||||
```
|
||||
Now it should be possible to open the interface: `http://<printer-ip>/`.
|
||||
|
||||
### Change the Hostname (Optional)
|
||||
to use the hostname instate of the ip, you can install the avahi-daemon:
|
||||
```bash
|
||||
sudo apt install avahi-daemon
|
||||
```
|
||||
and you can config your hostname (if you use a raspberry pi):
|
||||
```bash
|
||||
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.
|
||||
|
||||
## Klipper example macros for Mainsail
|
||||
These macros are important to start/pause/cancel prints.
|
||||
```
|
||||
[pause_resume]
|
||||
|
||||
[gcode_macro CANCEL]
|
||||
default_parameter_X: 230
|
||||
default_parameter_Y: 230
|
||||
default_parameter_Z: 10
|
||||
gcode:
|
||||
M104 S0
|
||||
M140 S0
|
||||
M141 S0
|
||||
M106 S0
|
||||
CLEAR_PAUSE
|
||||
RESET_SD
|
||||
|
||||
[gcode_macro CANCEL_PRINT]
|
||||
gcode:
|
||||
CANCEL
|
||||
|
||||
[gcode_macro PAUSE]
|
||||
rename_existing: BASE_PAUSE
|
||||
default_parameter_X: 230
|
||||
default_parameter_Y: 230
|
||||
default_parameter_Z: 10
|
||||
gcode:
|
||||
SAVE_GCODE_STATE NAME=PAUSE_state
|
||||
BASE_PAUSE
|
||||
G91
|
||||
G1 E-1.7 F2100
|
||||
G1 Z{Z}
|
||||
G90
|
||||
G1 X{X} Y{Y} F6000
|
||||
G91
|
||||
|
||||
[gcode_macro RESUME]
|
||||
rename_existing: BASE_RESUME
|
||||
gcode:
|
||||
G91
|
||||
G1 E1.7 F2100
|
||||
G91
|
||||
RESTORE_GCODE_STATE NAME=PAUSE_state MOVE=1
|
||||
BASE_RESUME
|
||||
```
|
||||
|
||||
## Update Mainsail to V0.0.12
|
||||
```
|
||||
sudo service klipper stop
|
||||
cd ~/klipper
|
||||
git clean -x -d -i
|
||||
git fetch arksine && git checkout arksine/work-web_server-20200131
|
||||
~/klipper/scripts/install-moonraker.sh #optional: only for the first installation of moonraker
|
||||
rm -R ~/mainsail/*
|
||||
cd ~/mainsail
|
||||
wget -q -O mainsail.zip https://github.com/meteyou/mainsail/releases/download/v0.0.12/mainsail-alpha-0.0.12.zip && unzip mainsail.zip && rm mainsail.zip
|
||||
```
|
||||
and update your macros & nginx config.
|
||||
To begin using Mainsail start by [installing](docs/installation.md) it or read the [documentation](docs/README.md) for more informations.
|
||||
BIN
docs/images/screenshot-dashboard.png
Normal file
BIN
docs/images/screenshot-dashboard.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 618 KiB |
Loading…
x
Reference in New Issue
Block a user