diff --git a/docs/assets/img/GuppyFLO/01.png b/docs/assets/img/GuppyFLO/01.png new file mode 100644 index 00000000..9297ecce Binary files /dev/null and b/docs/assets/img/GuppyFLO/01.png differ diff --git a/docs/assets/img/GuppyFLO/02.png b/docs/assets/img/GuppyFLO/02.png new file mode 100644 index 00000000..e173342a Binary files /dev/null and b/docs/assets/img/GuppyFLO/02.png differ diff --git a/docs/assets/img/GuppyFLO/03.png b/docs/assets/img/GuppyFLO/03.png new file mode 100644 index 00000000..22e901a7 Binary files /dev/null and b/docs/assets/img/GuppyFLO/03.png differ diff --git a/docs/assets/img/GuppyFLO/04.png b/docs/assets/img/GuppyFLO/04.png new file mode 100644 index 00000000..0a31e365 Binary files /dev/null and b/docs/assets/img/GuppyFLO/04.png differ diff --git a/docs/assets/img/GuppyFLO/05.png b/docs/assets/img/GuppyFLO/05.png new file mode 100644 index 00000000..27c1fc21 Binary files /dev/null and b/docs/assets/img/GuppyFLO/05.png differ diff --git a/docs/assets/img/GuppyFLO/06.png b/docs/assets/img/GuppyFLO/06.png new file mode 100644 index 00000000..7394e7ed Binary files /dev/null and b/docs/assets/img/GuppyFLO/06.png differ diff --git a/docs/assets/img/GuppyFLO/07.png b/docs/assets/img/GuppyFLO/07.png new file mode 100644 index 00000000..f3ec39ba Binary files /dev/null and b/docs/assets/img/GuppyFLO/07.png differ diff --git a/docs/helper-script/guppyflo.md b/docs/helper-script/guppyflo.md new file mode 100644 index 00000000..6bc2ffba --- /dev/null +++ b/docs/helper-script/guppyflo.md @@ -0,0 +1,77 @@ +GuppyFLO is a self-hosted service that enables local/remote management of multiple Klipper printers using Moonraker. + +More info about GuppyFLO: :material-github: [Here](https://github.com/ballaswag/guppyflo) + +More info about Tailscale: :material-web: [Here](https://tailscale.com/) + +!!! Note + **This procedure must be repeated after restoring the printer to factory settings.** + + +## Installation +
+ +- Make sure you have followed this Helper Script Installation section before. + +- In the script, enter in `[Install] Menu` by typing ++"1"++ , validate with ++"Enter"++ and install `GuppyFLO`: + + + + +## Prerequisites +
+ +- Create a free Tailscale account here: :material-web: [Create Tailscale Account](https://login.tailscale.com/start) + +- Install the Tailscale application depending device(s) you want to use for remote access: :material-web: [Download Tailscale App](https://tailscale.com/download) + + +## Configurations +
+ +- Open your web browser and go to the address `http://xxx.xxx.xxx.xxx:9873` (by replacing **xxx.xxx.xxx.xxx** by your printer's local IP address) to access the GuppyFLO Web interface : + + + +- Then, click on authenticate link to register GuppyFLO instance to Tailscale: + + + +- You will be redirected to the Tailscale website to connect device by clicking on `Connect` button: + + + +- Go back to GuppyFLO Web interface and click on `Add Printer` button: + + + +- Configure settings and click on `Add Printer` button: + + + +- Go to to your Tailscale Admin console here: [Tailscale Admin Console](https://login.tailscale.com/admin/machines) + +- There you will see the connected devices and their respective IP addresses : + + + + 1. guppyflo :fontawesome-solid-arrow-right-long: Your printer + 2. IP address assigned to your printer (to connect to it remotely) + 3. The devices you have connected to Tailscale (here my mobile phone) + 4. The IP addresses assigned to the devices you have connected + + What interests us here is the IP address assigned to guppyflo (your printer). It's this IP address that you will need to use to connect to the GuppyFlo Web interface remotely from the device(s) you have connected to Tailscale. + +- You can now connect to GuppyFlo Web interface remotely by using IP address assigned to guppyflo: + + + +!!! Note + **For now camera not working remotely and it will be fixed in future release of GuppyFLO.** + + +
+ +**If you like my work, don't hesitate to support me by paying me a 🍺 or a ☕. Thank you 🙂** + + diff --git a/docs/special-thanks.md b/docs/special-thanks.md index 105459f3..0c2a7648 100644 --- a/docs/special-thanks.md +++ b/docs/special-thanks.md @@ -17,7 +17,7 @@ hide: - [Kenneth Jiang](https://github.com/kennethjiang) for Obico. - [mulder999](https://github.com/mulder999) for M191 macro. - [caffeineflo](https://github.com/caffeineflo) for fix for Reboot function. -- [ballaswag](https://github.com/ballaswag) for Guppy Screen, Shapers Calibrations macros and fix with curl. +- [ballaswag](https://github.com/ballaswag) for Guppy Screen, GuppyFLO, Shapers Calibrations macros and fix with curl. - [Frix-x](https://github.com/Frix-x) for EXCITATE_AXIS_AT_FREQ macro and some pics. - [d3dorsett](https://github.com/d3dorsett) for fix for 504 Gateway Timeout error. - [avoylenko](https://github.com/avoylenko) for mirroring Entware repo. diff --git a/mkdocs.yml b/mkdocs.yml index 2cd3efb7..abf91e7a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -131,6 +131,7 @@ nav: - OctoEverywhere: helper-script/octoeverywhere.md - Moonraker Obico: helper-script/moonraker-obico.md - Mobileraker Companion: helper-script/mobileraker-companion.md + - GuppyFLO: helper-script/guppyflo.md - Customize Menu: - Custom Boot Display: helper-script/custom-boot-display.md - Remove & Restore Creality Web Interface: helper-script/remove-and-restore-creality-web-interface.md