mirror of
https://github.com/dw-0/kiauh.git
synced 2026-06-28 19:35:27 +05:00
feat(extensions): add Moongate for Klipper (#809)
* feat(extensions): add Moongate for Klipper Adds Moongate for Klipper as extension #15 (next free index after KAMP). Moongate pairs a printer with the Moongate Android app for secure remote access and print monitoring over a Cloudflare quick-tunnel fronted by an EdDSA auth proxy. The extension is KIAUH-native for the parts KIAUH owns (Moonraker instance discovery, the install/remove confirmation dialogs, moonraker.conf backup, and the repo clone wired into the update manager) and delegates the heavy, security-sensitive install steps (cloudflared, the moongate-authproxy and moongate-tunnel systemd services, the Moonraker host rebind) to Moongate's own idempotent, non-interactive install/update/uninstall scripts so that logic stays maintained upstream in one place. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(metadata): update index for Moongate extension * refactor(moongate_extension): enhance error handling and update docstring for clarity --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com> Co-authored-by: dw-0 <th33xitus@gmail.com>
This commit is contained in:
Paul
GitHub
@@ -0,0 +1,34 @@
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2020 - 2026 Dominik Willner <th33xitus@gmail.com> #
|
||||
# Copyright (C) 2026 Paul Sharman <github.com/PEEKYPAUL> #
|
||||
# #
|
||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||
# https://github.com/dw-0/kiauh #
|
||||
# #
|
||||
# It integrates Moongate for Klipper: #
|
||||
# https://github.com/PEEKYPAUL/Moongate #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
from pathlib import Path
|
||||
|
||||
# repository
|
||||
MOONGATE_REPO = "https://github.com/PEEKYPAUL/moongate.git"
|
||||
MOONGATE_REPO_URL = "https://github.com/PEEKYPAUL/Moongate"
|
||||
|
||||
# directories
|
||||
MODULE_PATH = Path(__file__).resolve().parent
|
||||
MOONGATE_DIR = Path.home().joinpath("moongate")
|
||||
MOONGATE_PLUGIN_DIR = MOONGATE_DIR.joinpath("klipper-plugin")
|
||||
|
||||
# installer scripts shipped inside the cloned repo
|
||||
MOONGATE_INSTALL_SCRIPT = MOONGATE_PLUGIN_DIR.joinpath("install.sh")
|
||||
MOONGATE_UPDATE_SCRIPT = MOONGATE_PLUGIN_DIR.joinpath("update.sh")
|
||||
MOONGATE_UNINSTALL_SCRIPT = MOONGATE_PLUGIN_DIR.joinpath("uninstall.sh")
|
||||
|
||||
# moonraker.conf sections the installer manages
|
||||
MOONGATE_UPDATER_NAME = "update_manager moongate"
|
||||
MOONGATE_CONFIG_SECTION = "moongate"
|
||||
|
||||
# default HTTP port the Mainsail/Fluidd UI is served on
|
||||
MOONGATE_DEFAULT_PORT = 80
|
||||
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"metadata": {
|
||||
"index": 16,
|
||||
"module": "moongate_extension",
|
||||
"maintained_by": "PEEKYPAUL",
|
||||
"display_name": "Moongate for Klipper",
|
||||
"description": [
|
||||
"Pair this printer with the Moongate Android app for secure remote",
|
||||
"access and print monitoring. Installs cloudflared, a Cloudflare",
|
||||
"quick-tunnel and an EdDSA auth gate in front of Moonraker."
|
||||
],
|
||||
"repo": "https://github.com/PEEKYPAUL/Moongate",
|
||||
"updates": true
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,249 @@
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2020 - 2026 Dominik Willner <th33xitus@gmail.com> #
|
||||
# Copyright (C) 2026 Paul Sharman <github.com/PEEKYPAUL> #
|
||||
# #
|
||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||
# https://github.com/dw-0/kiauh #
|
||||
# #
|
||||
# It integrates Moongate for Klipper: #
|
||||
# https://github.com/PEEKYPAUL/Moongate #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
from pathlib import Path
|
||||
from subprocess import CalledProcessError, run
|
||||
from typing import Dict, List
|
||||
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from extensions.base_extension import BaseExtension
|
||||
from extensions.moongate import (
|
||||
MOONGATE_CONFIG_SECTION,
|
||||
MOONGATE_DEFAULT_PORT,
|
||||
MOONGATE_DIR,
|
||||
MOONGATE_INSTALL_SCRIPT,
|
||||
MOONGATE_REPO,
|
||||
MOONGATE_REPO_URL,
|
||||
MOONGATE_UNINSTALL_SCRIPT,
|
||||
MOONGATE_UPDATE_SCRIPT,
|
||||
MOONGATE_UPDATER_NAME,
|
||||
)
|
||||
from utils.config_utils import remove_config_section
|
||||
from utils.fs_utils import check_file_exist
|
||||
from utils.git_utils import GitException, git_clone_wrapper, git_pull_wrapper
|
||||
from utils.input_utils import get_confirm, get_number_input
|
||||
from utils.instance_utils import get_instances
|
||||
|
||||
|
||||
# noinspection PyMethodMayBeStatic
|
||||
class MoongateExtension(BaseExtension):
|
||||
"""
|
||||
Moongate ships a substantial, security-sensitive and idempotent installer
|
||||
(cloudflared, two systemd services, an EdDSA auth proxy, a Moonraker host
|
||||
rebind and a tightly-scoped Avahi sudoers entry). Rather than mirror all
|
||||
of that in Python — where it would drift out of sync with upstream — this
|
||||
extension does the KIAUH-idiomatic parts natively (instance discovery,
|
||||
confirmation, moonraker.conf backup, the repo clone wired to the update
|
||||
manager) and delegates the heavy lifting to Moongate's own scripts.
|
||||
"""
|
||||
|
||||
def install_extension(self, **kwargs) -> None:
|
||||
Logger.print_status("Installing Moongate for Klipper ...")
|
||||
|
||||
mr_instances: List[Moonraker] = get_instances(Moonraker)
|
||||
if not mr_instances:
|
||||
Logger.print_dialog(
|
||||
DialogType.WARNING,
|
||||
[
|
||||
"No Moonraker instances found!",
|
||||
"Moongate is a Moonraker component and needs Moonraker to be "
|
||||
"installed first. Please install Moonraker, then try again.",
|
||||
],
|
||||
)
|
||||
return
|
||||
|
||||
# Moongate is a single-printer integration. On a multi-instance host we
|
||||
# target the first Moonraker instance and say so.
|
||||
moonraker = mr_instances[0]
|
||||
if len(mr_instances) > 1:
|
||||
Logger.print_dialog(
|
||||
DialogType.WARNING,
|
||||
[
|
||||
"Multiple Moonraker instances detected.",
|
||||
"Moongate currently supports a single-printer setup. The "
|
||||
f"instance '{moonraker.data_dir.name}' will be used.",
|
||||
],
|
||||
)
|
||||
|
||||
if not self._confirm_install():
|
||||
Logger.print_info("Installation aborted.")
|
||||
return
|
||||
|
||||
port = get_number_input(
|
||||
"HTTP port your Mainsail/Fluidd UI is served on",
|
||||
min_value=1,
|
||||
max_value=65535,
|
||||
default=MOONGATE_DEFAULT_PORT,
|
||||
)
|
||||
if port is None:
|
||||
return
|
||||
|
||||
try:
|
||||
self._clone_or_update_repo()
|
||||
|
||||
BackupService().backup_moonraker_conf()
|
||||
|
||||
# Hand off to Moongate's own installer. It is idempotent,
|
||||
# non-interactive and env-driven: it installs cloudflared, adds the
|
||||
# two systemd services, patches moonraker.conf and restarts
|
||||
# Moonraker + Klipper itself.
|
||||
self._run_script(
|
||||
MOONGATE_INSTALL_SCRIPT,
|
||||
moonraker,
|
||||
extra_env={"MOONGATE_PORT": str(port)},
|
||||
)
|
||||
except (GitException, CalledProcessError, OSError) as e:
|
||||
Logger.print_error(f"Error during Moongate installation:\n{e}")
|
||||
return
|
||||
|
||||
Logger.print_dialog(
|
||||
DialogType.SUCCESS,
|
||||
[
|
||||
"Moongate installed successfully!",
|
||||
"\n\n",
|
||||
"Next steps:",
|
||||
"● Install the Moongate app on your Android device.",
|
||||
"● Run MOONGATE_PAIR in the Klipper console (or open the pair "
|
||||
"page printed above) and scan the QR code.",
|
||||
"● Updates from now on: Mainsail/Fluidd > Software Updates > Moongate.",
|
||||
],
|
||||
margin_bottom=1,
|
||||
)
|
||||
|
||||
def update_extension(self, **kwargs) -> None:
|
||||
Logger.print_status("Updating Moongate for Klipper ...")
|
||||
|
||||
if not check_file_exist(MOONGATE_DIR.joinpath(".git")):
|
||||
Logger.print_info("Moongate does not seem to be installed. Skipping ...")
|
||||
return
|
||||
|
||||
mr_instances: List[Moonraker] = get_instances(Moonraker)
|
||||
if not mr_instances:
|
||||
Logger.print_warn("No Moonraker instance found. Skipping ...")
|
||||
return
|
||||
|
||||
try:
|
||||
git_pull_wrapper(MOONGATE_DIR)
|
||||
self._run_script(MOONGATE_UPDATE_SCRIPT, mr_instances[0])
|
||||
InstanceManager.restart_all(mr_instances)
|
||||
except (GitException, CalledProcessError, OSError) as e:
|
||||
Logger.print_error(f"Error during Moongate update:\n{e}")
|
||||
return
|
||||
|
||||
Logger.print_ok("Moongate updated successfully.", end="\n\n")
|
||||
|
||||
def remove_extension(self, **kwargs) -> None:
|
||||
Logger.print_status("Removing Moongate for Klipper ...")
|
||||
|
||||
mr_instances: List[Moonraker] = get_instances(Moonraker)
|
||||
|
||||
if not get_confirm(
|
||||
"This removes Moongate, cloudflared, both systemd services and all "
|
||||
"Moongate config. Continue?",
|
||||
default_choice=True,
|
||||
allow_go_back=True,
|
||||
):
|
||||
Logger.print_info("Removal aborted.")
|
||||
return
|
||||
|
||||
# Preferred path: delegate to Moongate's own uninstaller, which stops
|
||||
# and removes the services, cleans moonraker.conf, restores its backup
|
||||
# and restarts Moonraker. MOONGATE_YES=1 makes it non-interactive
|
||||
# (KIAUH already collected the confirmation above).
|
||||
if check_file_exist(MOONGATE_UNINSTALL_SCRIPT):
|
||||
try:
|
||||
BackupService().backup_moonraker_conf()
|
||||
target = mr_instances[0] if mr_instances else None
|
||||
self._run_script(
|
||||
MOONGATE_UNINSTALL_SCRIPT,
|
||||
target,
|
||||
extra_env={"MOONGATE_YES": "1"},
|
||||
)
|
||||
Logger.print_ok("Moongate removed successfully.")
|
||||
return
|
||||
except (CalledProcessError, OSError) as e:
|
||||
Logger.print_error(f"Error during Moongate removal:\n{e}")
|
||||
# fall through to a best-effort native cleanup
|
||||
|
||||
# Fallback: the upstream uninstaller is gone (repo already deleted).
|
||||
# Do a best-effort native cleanup so moonraker.conf is left consistent.
|
||||
Logger.print_warn(
|
||||
"Moongate uninstaller not found — doing a best-effort cleanup. You "
|
||||
"may need to remove cloudflared and the moongate-* systemd services "
|
||||
"manually."
|
||||
)
|
||||
if mr_instances:
|
||||
BackupService().backup_moonraker_conf()
|
||||
remove_config_section(MOONGATE_UPDATER_NAME, mr_instances)
|
||||
remove_config_section(MOONGATE_CONFIG_SECTION, mr_instances)
|
||||
InstanceManager.restart_all(mr_instances)
|
||||
Logger.print_ok("Moongate configuration removed.")
|
||||
|
||||
# ------------------------------------------------------------------ #
|
||||
# helpers #
|
||||
# ------------------------------------------------------------------ #
|
||||
def _confirm_install(self) -> bool:
|
||||
Logger.print_dialog(
|
||||
DialogType.ATTENTION,
|
||||
[
|
||||
"Moongate pairs this printer with the Moongate Android app for "
|
||||
"secure remote access and print monitoring.",
|
||||
"\n\n",
|
||||
"This is a heavier install than most extensions. It will:",
|
||||
"● clone the Moongate repo to ~/moongate",
|
||||
"● add the Moongate component to Moonraker and register it with "
|
||||
"the update manager",
|
||||
"● install cloudflared and open a Cloudflare quick-tunnel",
|
||||
"● add two systemd services: moongate-authproxy + moongate-tunnel",
|
||||
"● bind Moonraker to 127.0.0.1 (the auth proxy fronts the tunnel)",
|
||||
"● add a tightly-scoped Avahi sudoers entry for LAN discovery",
|
||||
"\n\n",
|
||||
"Remote access relies on cloud infrastructure operated by the "
|
||||
"Moongate author. Moongate is licensed under PolyForm "
|
||||
"Noncommercial 1.0.0 (non-commercial use only).",
|
||||
MOONGATE_REPO_URL,
|
||||
],
|
||||
margin_bottom=1,
|
||||
)
|
||||
return bool(
|
||||
get_confirm(
|
||||
"Continue Moongate installation?",
|
||||
default_choice=True,
|
||||
allow_go_back=True,
|
||||
)
|
||||
)
|
||||
|
||||
def _clone_or_update_repo(self) -> None:
|
||||
if check_file_exist(MOONGATE_DIR.joinpath(".git")):
|
||||
git_pull_wrapper(MOONGATE_DIR)
|
||||
else:
|
||||
git_clone_wrapper(MOONGATE_REPO, MOONGATE_DIR)
|
||||
|
||||
def _run_script(
|
||||
self,
|
||||
script: Path,
|
||||
moonraker: Moonraker | None,
|
||||
extra_env: Dict[str, str] | None = None,
|
||||
) -> None:
|
||||
env = os.environ.copy()
|
||||
if moonraker is not None:
|
||||
env["MOONRAKER_DIR"] = moonraker.moonraker_dir.as_posix()
|
||||
env["PRINTER_DATA"] = moonraker.data_dir.as_posix()
|
||||
if extra_env:
|
||||
env.update(extra_env)
|
||||
run(["bash", script.as_posix()], env=env, check=True)
|
||||
Reference in New Issue
Block a user