install.sh 58 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564
  1. #!/usr/bin/env bash
  2. #
  3. # SpoolBuddy Installation Script for Raspberry Pi
  4. #
  5. # Supports two scenarios:
  6. # 1) SpoolBuddy only — NFC/scale companion connecting to a remote Bambuddy instance
  7. # 2) SpoolBuddy + Bambuddy — both running natively on this Raspberry Pi
  8. #
  9. # Usage:
  10. # Interactive: curl -fsSL https://raw.githubusercontent.com/maziggy/bambuddy/main/spoolbuddy/install.sh -o install.sh && chmod +x install.sh && sudo ./install.sh
  11. # Unattended: sudo ./install.sh --mode spoolbuddy --bambuddy-url http://192.168.1.100:8000 --api-key bb_xxx --yes
  12. #
  13. # Options:
  14. # --mode MODE Installation mode: "spoolbuddy" (companion only) or "full" (both)
  15. # --repo URL Git repository URL to install from (default: upstream repo)
  16. # --ref REF Git ref to install (branch/tag/commit, default: main)
  17. # --bambuddy-url URL Bambuddy server URL (required for spoolbuddy mode)
  18. # --api-key KEY Bambuddy API key (required for spoolbuddy mode)
  19. # --path PATH Installation directory (default: /opt/spoolbuddy or /opt/bambuddy)
  20. # --port PORT Bambuddy port (full mode only, default: 8000)
  21. # --ssh-pubkey KEY Bambuddy SSH public key for remote updates
  22. # --yes, -y Non-interactive mode, accept defaults
  23. # --help, -h Show this help message
  24. #
  25. set -e
  26. # ─────────────────────────────────────────────────────────────────────────────
  27. # Constants
  28. # ─────────────────────────────────────────────────────────────────────────────
  29. RED='\033[0;31m'
  30. GREEN='\033[0;32m'
  31. YELLOW='\033[1;33m'
  32. CYAN='\033[0;36m'
  33. BOLD='\033[1m'
  34. NC='\033[0m'
  35. GITHUB_REPO="https://github.com/maziggy/bambuddy.git"
  36. SPOOLBUDDY_SERVICE_USER="spoolbuddy"
  37. BAMBUDDY_SERVICE_USER="bambuddy"
  38. # Packages needed for SpoolBuddy hardware (NFC reader + scale)
  39. SYSTEM_PACKAGES="python3 python3-pip python3-venv python3-dev python3-spidev python3-libgpiod gpiod libgpiod-dev i2c-tools git"
  40. # Python packages for SpoolBuddy daemon
  41. SPOOLBUDDY_PIP_PACKAGES="spidev gpiod smbus2 httpx"
  42. # ─────────────────────────────────────────────────────────────────────────────
  43. # Variables (set by args or prompts)
  44. # ─────────────────────────────────────────────────────────────────────────────
  45. INSTALL_MODE="" # "spoolbuddy" or "full"
  46. INSTALL_PATH=""
  47. INSTALL_REPO=""
  48. INSTALL_REF=""
  49. DETECTED_INSTALLER_REPO=""
  50. DETECTED_INSTALLER_REF=""
  51. BAMBUDDY_URL=""
  52. API_KEY=""
  53. BAMBUDDY_PORT="8000"
  54. NON_INTERACTIVE="false"
  55. REBOOT_NEEDED="false"
  56. KIOSK_USER="" # auto-detected from $SUDO_USER
  57. KIOSK_URL="" # derived from $BAMBUDDY_URL/spoolbuddy?token=$API_KEY
  58. SSH_PUBKEY="" # Bambuddy's SSH public key for remote updates
  59. # ─────────────────────────────────────────────────────────────────────────────
  60. # Helpers
  61. # ─────────────────────────────────────────────────────────────────────────────
  62. info() { echo -e "${CYAN}[INFO]${NC} $1"; }
  63. success() { echo -e "${GREEN}[OK]${NC} $1"; }
  64. warn() { echo -e "${YELLOW}[WARN]${NC} $1"; }
  65. error() { echo -e "${RED}[ERROR]${NC} $1"; exit 1; }
  66. # Run a long-running command with a spinner + live progress output.
  67. # Usage: run_with_progress "description" command [args...]
  68. run_with_progress() {
  69. local desc="$1"
  70. shift
  71. local log_file
  72. log_file=$(mktemp /tmp/spoolbuddy-install.XXXXXX)
  73. local start_time=$SECONDS
  74. # Run command in background, capture stdout+stderr
  75. "$@" > "$log_file" 2>&1 &
  76. local pid=$!
  77. # Spinner frames (braille pattern)
  78. local -a spin=("⠋" "⠙" "⠹" "⠸" "⠼" "⠴" "⠦" "⠧" "⠇" "⠏")
  79. local i=0
  80. while kill -0 "$pid" 2>/dev/null; do
  81. local elapsed=$(( SECONDS - start_time ))
  82. local time_str
  83. if (( elapsed >= 60 )); then
  84. time_str="$(( elapsed / 60 ))m$(printf '%02d' $(( elapsed % 60 )))s"
  85. else
  86. time_str="${elapsed}s"
  87. fi
  88. # Last chunk of output (handles \r progress lines and regular \n lines)
  89. local last_line=""
  90. last_line=$(tail -c 4096 "$log_file" 2>/dev/null | tr '\r' '\n' | sed 's/\x1b\[[0-9;]*[mGKHJ]//g' | sed '/^[[:space:]]*$/d' | tail -1 | sed 's/^[[:space:]]*//' | cut -c1-50) || true
  91. printf "\r ${spin[$((i % 10))]} %-36s ${CYAN}%6s${NC} %s\033[K" "$desc" "$time_str" "$last_line"
  92. i=$(( i + 1 ))
  93. sleep 0.15
  94. done
  95. local exit_code=0
  96. wait "$pid" || exit_code=$?
  97. # Clear spinner line
  98. printf "\r\033[K"
  99. # Format elapsed time for summary
  100. local elapsed=$(( SECONDS - start_time ))
  101. local time_suffix=""
  102. if (( elapsed >= 60 )); then
  103. time_suffix=" ($(( elapsed / 60 ))m $(( elapsed % 60 ))s)"
  104. elif (( elapsed >= 5 )); then
  105. time_suffix=" (${elapsed}s)"
  106. fi
  107. if [[ $exit_code -eq 0 ]]; then
  108. success "${desc}${time_suffix}"
  109. rm -f "$log_file"
  110. else
  111. echo -e "${RED}[FAIL]${NC} ${desc}${time_suffix}"
  112. echo ""
  113. echo -e " ${YELLOW}Last 20 lines:${NC}"
  114. tail -20 "$log_file" 2>/dev/null | sed 's/^/ /'
  115. echo ""
  116. echo -e " Full log: ${CYAN}$log_file${NC}"
  117. exit 1
  118. fi
  119. }
  120. prompt() {
  121. local prompt_text="$1"
  122. local default_value="$2"
  123. local var_name="$3"
  124. if [[ "$NON_INTERACTIVE" == "true" ]]; then
  125. eval "$var_name=\"$default_value\""
  126. return
  127. fi
  128. if [[ -n "$default_value" ]]; then
  129. echo -en "${BOLD}$prompt_text${NC} [${CYAN}$default_value${NC}]: "
  130. else
  131. echo -en "${BOLD}$prompt_text${NC}: "
  132. fi
  133. read -r input
  134. if [[ -z "$input" ]]; then
  135. eval "$var_name=\"$default_value\""
  136. else
  137. eval "$var_name=\"$input\""
  138. fi
  139. }
  140. prompt_yes_no() {
  141. local prompt_text="$1"
  142. local default="$2"
  143. if [[ "$NON_INTERACTIVE" == "true" ]]; then
  144. [[ "$default" == "y" ]] && return 0 || return 1
  145. fi
  146. local yn_hint="[y/n]"
  147. [[ "$default" == "y" ]] && yn_hint="[Y/n]"
  148. [[ "$default" == "n" ]] && yn_hint="[y/N]"
  149. while true; do
  150. echo -en "${BOLD}$prompt_text${NC} $yn_hint: "
  151. read -r yn
  152. [[ -z "$yn" ]] && yn="$default"
  153. case "$yn" in
  154. [Yy]* ) return 0;;
  155. [Nn]* ) return 1;;
  156. * ) echo "Please answer yes or no.";;
  157. esac
  158. done
  159. }
  160. show_help() {
  161. echo "SpoolBuddy Installation Script for Raspberry Pi"
  162. echo ""
  163. echo "Usage: sudo $0 [OPTIONS]"
  164. echo ""
  165. echo "Options:"
  166. echo " --mode MODE \"spoolbuddy\" (companion only) or \"full\" (Bambuddy + SpoolBuddy)"
  167. echo " --repo URL Git repository URL to install from"
  168. echo " --ref REF Git ref to install (branch/tag/commit)"
  169. echo " --bambuddy-url URL Bambuddy server URL (required for spoolbuddy mode)"
  170. echo " --api-key KEY Bambuddy API key (required for spoolbuddy mode)"
  171. echo " --path PATH Installation directory (default: /opt/spoolbuddy or /opt/bambuddy)"
  172. echo " --port PORT Bambuddy port (full mode only, default: 8000)"
  173. echo " --ssh-pubkey KEY Bambuddy SSH public key for remote updates"
  174. echo " --yes, -y Non-interactive mode, accept defaults"
  175. echo " --help, -h Show this help message"
  176. echo ""
  177. echo "Examples:"
  178. echo " Interactive:"
  179. echo " sudo ./install.sh"
  180. echo ""
  181. echo " SpoolBuddy companion (unattended):"
  182. echo " sudo ./install.sh --mode spoolbuddy --bambuddy-url http://192.168.1.100:8000 --api-key bb_xxx -y"
  183. echo ""
  184. echo " Full install (unattended):"
  185. echo " sudo ./install.sh --mode full --port 8000 -y"
  186. exit 0
  187. }
  188. normalize_github_repo_url() {
  189. local url="$1"
  190. if [[ -z "$url" ]]; then
  191. echo ""
  192. return
  193. fi
  194. # Convert git@github.com:owner/repo(.git) to https://github.com/owner/repo.git
  195. if [[ "$url" =~ ^git@github.com:(.+)$ ]]; then
  196. url="https://github.com/${BASH_REMATCH[1]}"
  197. fi
  198. # Keep remote URL style consistent.
  199. url="${url%.git}"
  200. echo "${url}.git"
  201. }
  202. detect_installer_source_context() {
  203. local script_dir
  204. script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
  205. if git -C "$script_dir" rev-parse --is-inside-work-tree >/dev/null 2>&1; then
  206. DETECTED_INSTALLER_REF="$(git -C "$script_dir" rev-parse --abbrev-ref HEAD 2>/dev/null || true)"
  207. local origin_url
  208. origin_url="$(git -C "$script_dir" remote get-url origin 2>/dev/null || true)"
  209. DETECTED_INSTALLER_REPO="$(normalize_github_repo_url "$origin_url")"
  210. fi
  211. # Optional environment overrides for raw-download installs.
  212. if [[ -n "${SPOOLBUDDY_INSTALL_REPO:-}" ]]; then
  213. DETECTED_INSTALLER_REPO="$(normalize_github_repo_url "$SPOOLBUDDY_INSTALL_REPO")"
  214. fi
  215. if [[ -n "${SPOOLBUDDY_INSTALL_REF:-}" ]]; then
  216. DETECTED_INSTALLER_REF="$SPOOLBUDDY_INSTALL_REF"
  217. fi
  218. if [[ -z "$INSTALL_REPO" ]]; then
  219. if [[ -n "$DETECTED_INSTALLER_REPO" ]]; then
  220. INSTALL_REPO="$DETECTED_INSTALLER_REPO"
  221. else
  222. INSTALL_REPO="$GITHUB_REPO"
  223. fi
  224. fi
  225. if [[ -z "$INSTALL_REF" ]]; then
  226. if [[ -n "$DETECTED_INSTALLER_REF" && "$DETECTED_INSTALLER_REF" != "HEAD" ]]; then
  227. INSTALL_REF="$DETECTED_INSTALLER_REF"
  228. else
  229. INSTALL_REF="main"
  230. fi
  231. fi
  232. }
  233. resolve_install_ref() {
  234. local ref="$1"
  235. # If ref exists on origin as a branch, track/reset it. Otherwise treat it as tag/commit.
  236. if git ls-remote --exit-code --heads origin "$ref" >/dev/null 2>&1; then
  237. git checkout -B "$ref" "origin/$ref" > /dev/null 2>&1
  238. git reset --hard "origin/$ref" > /dev/null 2>&1
  239. else
  240. git checkout "$ref" > /dev/null 2>&1
  241. fi
  242. }
  243. # ─────────────────────────────────────────────────────────────────────────────
  244. # Pre-flight Checks
  245. # ─────────────────────────────────────────────────────────────────────────────
  246. check_root() {
  247. if [[ $EUID -ne 0 ]]; then
  248. error "This script must be run as root (use sudo)"
  249. fi
  250. }
  251. check_raspberry_pi() {
  252. if ! grep -q "Raspberry Pi\|BCM2" /proc/cpuinfo 2>/dev/null; then
  253. error "This script is designed for Raspberry Pi only"
  254. fi
  255. # Detect Pi model for hardware recommendations
  256. local model
  257. model=$(tr -d '\0' < /proc/device-tree/model 2>/dev/null) || model="Unknown"
  258. success "Detected: $model"
  259. }
  260. check_raspberry_pi_os() {
  261. if [[ ! -f /etc/os-release ]]; then
  262. error "Cannot detect operating system"
  263. fi
  264. . /etc/os-release
  265. if [[ "$ID" != "raspbian" && "$ID" != "debian" ]]; then
  266. warn "Expected Raspberry Pi OS (Debian-based), found: $ID"
  267. if ! prompt_yes_no "Continue anyway?" "n"; then
  268. exit 0
  269. fi
  270. fi
  271. success "OS: $PRETTY_NAME"
  272. }
  273. detect_python() {
  274. local cmd=""
  275. if command -v python3 &>/dev/null; then
  276. cmd="python3"
  277. elif command -v python &>/dev/null; then
  278. local ver
  279. ver=$(python --version 2>&1 | cut -d' ' -f2 | cut -d'.' -f1)
  280. if [[ "$ver" -ge 3 ]]; then
  281. cmd="python"
  282. fi
  283. fi
  284. if [[ -z "$cmd" ]]; then
  285. return 1
  286. fi
  287. local version
  288. version=$($cmd -c 'import sys; print(f"{sys.version_info.major}.{sys.version_info.minor}")')
  289. local major minor
  290. major=$(echo "$version" | cut -d'.' -f1)
  291. minor=$(echo "$version" | cut -d'.' -f2)
  292. if [[ "$major" -lt 3 ]] || { [[ "$major" -eq 3 ]] && [[ "$minor" -lt 10 ]]; }; then
  293. warn "Python $version found, but 3.10+ is required"
  294. return 1
  295. fi
  296. PYTHON_CMD="$cmd"
  297. success "Found Python $version"
  298. return 0
  299. }
  300. # ─────────────────────────────────────────────────────────────────────────────
  301. # Raspberry Pi Hardware Configuration
  302. # ─────────────────────────────────────────────────────────────────────────────
  303. enable_spi() {
  304. if raspi-config nonint get_spi 2>/dev/null | grep -q "1"; then
  305. info "Enabling SPI..."
  306. raspi-config nonint do_spi 0
  307. REBOOT_NEEDED="true"
  308. success "SPI enabled"
  309. else
  310. success "SPI already enabled"
  311. fi
  312. }
  313. enable_i2c() {
  314. if raspi-config nonint get_i2c 2>/dev/null | grep -q "1"; then
  315. info "Enabling I2C..."
  316. raspi-config nonint do_i2c 0
  317. REBOOT_NEEDED="true"
  318. success "I2C enabled"
  319. else
  320. success "I2C already enabled"
  321. fi
  322. }
  323. configure_boot_config() {
  324. # Find the boot config file (Bookworm+ uses /boot/firmware/config.txt)
  325. local boot_config="/boot/firmware/config.txt"
  326. if [[ ! -f "$boot_config" ]]; then
  327. boot_config="/boot/config.txt"
  328. fi
  329. if [[ ! -f "$boot_config" ]]; then
  330. warn "Boot config not found at /boot/firmware/config.txt or /boot/config.txt"
  331. warn "You may need to manually add: dtparam=i2c_arm=on and dtoverlay=spi0-0cs"
  332. return
  333. fi
  334. info "Configuring $boot_config..."
  335. # Migrate legacy SpoolBuddy setting (bus 0 / i2c_vc) to bus 1 / i2c_arm.
  336. if grep -q "^dtparam=i2c_vc=on" "$boot_config"; then
  337. sed -i "s/^dtparam=i2c_vc=on$/# dtparam=i2c_vc=on (disabled by SpoolBuddy installer; use i2c_arm bus 1)/" "$boot_config"
  338. REBOOT_NEEDED="true"
  339. success "Disabled legacy dtparam=i2c_vc=on"
  340. fi
  341. if grep -q "^# SpoolBuddy: I2C bus 0 for NAU7802 scale (GPIO0/GPIO1)" "$boot_config"; then
  342. sed -i "s/^# SpoolBuddy: I2C bus 0 for NAU7802 scale (GPIO0\/GPIO1)$/# SpoolBuddy: I2C bus 1 for NAU7802 scale (GPIO2\/GPIO3)/" "$boot_config"
  343. fi
  344. # Ensure I2C bus 1 (GPIO2/GPIO3) is enabled for NAU7802 scale
  345. if ! grep -q "^dtparam=i2c_arm=on" "$boot_config"; then
  346. echo "" >> "$boot_config"
  347. echo "# SpoolBuddy: I2C bus 1 for NAU7802 scale (GPIO2/GPIO3)" >> "$boot_config"
  348. echo "dtparam=i2c_arm=on" >> "$boot_config"
  349. REBOOT_NEEDED="true"
  350. success "Added dtparam=i2c_arm=on"
  351. else
  352. success "dtparam=i2c_arm=on already set"
  353. fi
  354. # Disable SPI auto chip-select (manual CS on GPIO23 for PN5180)
  355. if ! grep -q "^dtoverlay=spi0-0cs" "$boot_config"; then
  356. echo "" >> "$boot_config"
  357. echo "# SpoolBuddy: Disable SPI auto CS (manual CS on GPIO23 for PN5180)" >> "$boot_config"
  358. echo "dtoverlay=spi0-0cs" >> "$boot_config"
  359. REBOOT_NEEDED="true"
  360. success "Added dtoverlay=spi0-0cs"
  361. else
  362. success "dtoverlay=spi0-0cs already set"
  363. fi
  364. }
  365. # ─────────────────────────────────────────────────────────────────────────────
  366. # Package Installation
  367. # ─────────────────────────────────────────────────────────────────────────────
  368. install_system_packages() {
  369. run_with_progress "Updating package lists" apt-get update
  370. run_with_progress "Installing system packages" apt-get install -y $SYSTEM_PACKAGES
  371. }
  372. install_wifi_safeguard() {
  373. # Protect WiFi credentials from being wiped by apt upgrades.
  374. # Raspberry Pi OS Bookworm migrated from wpa_supplicant/dhcpcd to
  375. # NetworkManager, but certain package upgrades (raspberrypi-sys-mods,
  376. # raspi-config, NetworkManager itself) can delete saved connections
  377. # from /etc/NetworkManager/system-connections/. This hook backs them
  378. # up before dpkg runs and restores them if they vanish.
  379. local hook_file="/etc/apt/apt.conf.d/80-preserve-wifi"
  380. if [[ -f "$hook_file" ]]; then
  381. success "WiFi safeguard already installed"
  382. return
  383. fi
  384. # Only install if NetworkManager is the active network manager
  385. if ! systemctl is-active --quiet NetworkManager 2>/dev/null; then
  386. return
  387. fi
  388. # Write a helper script (avoids quote escaping issues in APT config)
  389. local helper="/usr/local/sbin/preserve-wifi"
  390. cat > "$helper" << 'HELPEREOF'
  391. #!/bin/sh
  392. # Called by APT hooks to preserve NetworkManager WiFi connections.
  393. NM_DIR="/etc/NetworkManager/system-connections"
  394. BAK_DIR="/etc/NetworkManager/system-connections.bak"
  395. case "$1" in
  396. backup)
  397. if [ -d "$NM_DIR" ] && [ -n "$(ls -A "$NM_DIR" 2>/dev/null)" ]; then
  398. cp -a "$NM_DIR/" "$BAK_DIR/"
  399. fi
  400. ;;
  401. restore)
  402. if [ -d "$BAK_DIR" ] && [ -z "$(ls -A "$NM_DIR" 2>/dev/null)" ]; then
  403. cp -a "$BAK_DIR"/* "$NM_DIR"/
  404. nmcli general reload 2>/dev/null
  405. fi
  406. rm -rf "$BAK_DIR" 2>/dev/null
  407. ;;
  408. esac
  409. HELPEREOF
  410. chmod +x "$helper"
  411. cat > "$hook_file" << 'APTEOF'
  412. // Preserve NetworkManager WiFi connections across apt upgrades.
  413. // Installed by SpoolBuddy.
  414. DPkg::Pre-Invoke {"/usr/local/sbin/preserve-wifi backup";};
  415. DPkg::Post-Invoke {"/usr/local/sbin/preserve-wifi restore";};
  416. APTEOF
  417. success "WiFi safeguard installed (${hook_file})"
  418. }
  419. upgrade_system_packages() {
  420. run_with_progress "Upgrading system packages" apt-get upgrade -y
  421. }
  422. # ─────────────────────────────────────────────────────────────────────────────
  423. # SpoolBuddy Installation
  424. # ─────────────────────────────────────────────────────────────────────────────
  425. create_spoolbuddy_user() {
  426. if id "$SPOOLBUDDY_SERVICE_USER" &>/dev/null; then
  427. info "User '$SPOOLBUDDY_SERVICE_USER' already exists"
  428. # Ensure existing installs get a real shell for SSH access
  429. usermod --shell /bin/bash "$SPOOLBUDDY_SERVICE_USER" 2>/dev/null || true
  430. else
  431. info "Creating service user '$SPOOLBUDDY_SERVICE_USER'..."
  432. useradd --system --shell /bin/bash --home-dir "$INSTALL_PATH" "$SPOOLBUDDY_SERVICE_USER"
  433. success "Service user created"
  434. fi
  435. # Add to hardware access groups (gpio, spi, i2c, video for backlight)
  436. for group in gpio spi i2c video; do
  437. if getent group "$group" &>/dev/null; then
  438. usermod -aG "$group" "$SPOOLBUDDY_SERVICE_USER" 2>/dev/null || true
  439. fi
  440. done
  441. success "User added to gpio, spi, i2c, video groups"
  442. # Allow passwordless restart of daemon + kiosk (needed for SSH-based updates from Bambuddy)
  443. cat > /etc/sudoers.d/spoolbuddy << 'SUDOERS'
  444. spoolbuddy ALL=(root) NOPASSWD: /usr/bin/systemctl restart spoolbuddy.service
  445. spoolbuddy ALL=(root) NOPASSWD: /usr/bin/systemctl restart getty@tty1.service
  446. spoolbuddy ALL=(root) NOPASSWD: /usr/bin/find /home -maxdepth 5 *
  447. spoolbuddy ALL=(root) NOPASSWD: /sbin/reboot
  448. spoolbuddy ALL=(root) NOPASSWD: /sbin/shutdown -h now
  449. SUDOERS
  450. chmod 440 /etc/sudoers.d/spoolbuddy
  451. success "Sudoers entries created for service, kiosk restart, reboot and shutdown"
  452. }
  453. download_spoolbuddy() {
  454. if [[ -d "$INSTALL_PATH/.git" ]]; then
  455. info "Existing installation found, updating..."
  456. git config --global --add safe.directory "$INSTALL_PATH" 2>/dev/null || true
  457. cd "$INSTALL_PATH"
  458. git remote set-url origin "$INSTALL_REPO" 2>/dev/null || true
  459. run_with_progress "Fetching updates" git fetch origin
  460. resolve_install_ref "$INSTALL_REF"
  461. else
  462. mkdir -p "$INSTALL_PATH"
  463. run_with_progress "Cloning repository" git clone "$INSTALL_REPO" "$INSTALL_PATH"
  464. cd "$INSTALL_PATH"
  465. resolve_install_ref "$INSTALL_REF"
  466. fi
  467. chown -R "$SPOOLBUDDY_SERVICE_USER:$SPOOLBUDDY_SERVICE_USER" "$INSTALL_PATH"
  468. }
  469. setup_spoolbuddy_venv() {
  470. cd "$INSTALL_PATH/spoolbuddy"
  471. run_with_progress "Creating SpoolBuddy venv" $PYTHON_CMD -m venv --system-site-packages venv
  472. run_with_progress "Upgrading pip" "$INSTALL_PATH/spoolbuddy/venv/bin/pip" install --upgrade pip
  473. run_with_progress "Installing SpoolBuddy packages" "$INSTALL_PATH/spoolbuddy/venv/bin/pip" install $SPOOLBUDDY_PIP_PACKAGES
  474. chown -R "$SPOOLBUDDY_SERVICE_USER:$SPOOLBUDDY_SERVICE_USER" "$INSTALL_PATH/spoolbuddy/venv"
  475. }
  476. create_spoolbuddy_env() {
  477. info "Creating SpoolBuddy configuration..."
  478. local env_file="$INSTALL_PATH/spoolbuddy/.env"
  479. cat > "$env_file" << EOF
  480. # SpoolBuddy Configuration
  481. # Generated by install.sh on $(date)
  482. # Bambuddy backend URL
  483. SPOOLBUDDY_BACKEND_URL=$BAMBUDDY_URL
  484. # API key (create one in Bambuddy Settings -> API Keys)
  485. SPOOLBUDDY_API_KEY=$API_KEY
  486. # NAU7802 scale bus (RPi GPIO2/GPIO3)
  487. SPOOLBUDDY_I2C_BUS=1
  488. EOF
  489. chown "$SPOOLBUDDY_SERVICE_USER:$SPOOLBUDDY_SERVICE_USER" "$env_file"
  490. # Keep secrets owner-writable while allowing kiosk user (in spoolbuddy group)
  491. # to read backend URL/API key for dynamic launcher URL resolution.
  492. chgrp "$SPOOLBUDDY_SERVICE_USER" "$env_file"
  493. chmod 640 "$env_file"
  494. success "Configuration saved to $env_file"
  495. }
  496. ensure_kiosk_env_access() {
  497. local env_file="$INSTALL_PATH/spoolbuddy/.env"
  498. if [[ ! -f "$env_file" ]]; then
  499. warn "SpoolBuddy env file not found at $env_file"
  500. return
  501. fi
  502. # Ensure kiosk user is known even when this function is called outside setup_kiosk.
  503. if [[ -z "$KIOSK_USER" ]]; then
  504. KIOSK_USER="${SUDO_USER:-$(logname 2>/dev/null || echo pi)}"
  505. fi
  506. if id "$KIOSK_USER" &>/dev/null; then
  507. usermod -aG "$SPOOLBUDDY_SERVICE_USER" "$KIOSK_USER" 2>/dev/null || true
  508. fi
  509. chgrp "$SPOOLBUDDY_SERVICE_USER" "$env_file"
  510. chmod 640 "$env_file"
  511. if ! su -s /bin/sh -c "test -r '$env_file'" "$KIOSK_USER"; then
  512. error "Kiosk user '$KIOSK_USER' cannot read $env_file (required for dynamic kiosk URL). Check groups/permissions."
  513. fi
  514. success "Verified kiosk user '$KIOSK_USER' can read SpoolBuddy env"
  515. }
  516. setup_ssh_key() {
  517. info "Setting up SSH access for Bambuddy remote updates..."
  518. local ssh_dir="$INSTALL_PATH/.ssh"
  519. local auth_keys="$ssh_dir/authorized_keys"
  520. mkdir -p "$ssh_dir"
  521. chmod 700 "$ssh_dir"
  522. if [[ -n "$SSH_PUBKEY" ]]; then
  523. # Manual key provided via --ssh-pubkey flag
  524. if [[ -f "$auth_keys" ]] && grep -qF "$SSH_PUBKEY" "$auth_keys" 2>/dev/null; then
  525. info "SSH key already present in authorized_keys"
  526. else
  527. echo "$SSH_PUBKEY" >> "$auth_keys"
  528. success "SSH public key added"
  529. fi
  530. else
  531. # No manual key — the daemon will auto-deploy it on first registration
  532. info "SSH key will be deployed automatically when the daemon connects to Bambuddy"
  533. touch "$auth_keys"
  534. fi
  535. chmod 600 "$auth_keys"
  536. chown -R "$SPOOLBUDDY_SERVICE_USER:$SPOOLBUDDY_SERVICE_USER" "$ssh_dir"
  537. }
  538. create_spoolbuddy_service() {
  539. info "Creating SpoolBuddy systemd service..."
  540. local after_line="After=network-online.target"
  541. if [[ "$INSTALL_MODE" == "full" ]]; then
  542. after_line="After=network-online.target bambuddy.service"
  543. fi
  544. cat > /etc/systemd/system/spoolbuddy.service << EOF
  545. [Unit]
  546. Description=SpoolBuddy - NFC Spool Management Daemon
  547. Documentation=https://github.com/maziggy/bambuddy
  548. $after_line
  549. Wants=network-online.target
  550. [Service]
  551. Type=simple
  552. User=$SPOOLBUDDY_SERVICE_USER
  553. WorkingDirectory=$INSTALL_PATH/spoolbuddy
  554. EnvironmentFile=$INSTALL_PATH/spoolbuddy/.env
  555. ExecStart=$INSTALL_PATH/spoolbuddy/venv/bin/python -m daemon.main
  556. Restart=always
  557. RestartSec=5
  558. StandardOutput=journal
  559. StandardError=journal
  560. [Install]
  561. WantedBy=multi-user.target
  562. EOF
  563. systemctl daemon-reload
  564. systemctl enable spoolbuddy.service
  565. success "SpoolBuddy service created and enabled"
  566. }
  567. # ─────────────────────────────────────────────────────────────────────────────
  568. # Bambuddy Installation (full mode only)
  569. # ─────────────────────────────────────────────────────────────────────────────
  570. create_bambuddy_user() {
  571. if id "$BAMBUDDY_SERVICE_USER" &>/dev/null; then
  572. info "User '$BAMBUDDY_SERVICE_USER' already exists"
  573. return
  574. fi
  575. info "Creating service user '$BAMBUDDY_SERVICE_USER'..."
  576. useradd --system --shell /usr/sbin/nologin --home-dir "$INSTALL_PATH" "$BAMBUDDY_SERVICE_USER"
  577. success "Service user created"
  578. }
  579. setup_bambuddy_venv() {
  580. cd "$INSTALL_PATH"
  581. run_with_progress "Creating Bambuddy venv" $PYTHON_CMD -m venv venv
  582. run_with_progress "Upgrading pip" "$INSTALL_PATH/venv/bin/pip" install --upgrade pip
  583. run_with_progress "Installing Bambuddy dependencies" "$INSTALL_PATH/venv/bin/pip" install -r requirements.txt
  584. chown -R "$BAMBUDDY_SERVICE_USER:$BAMBUDDY_SERVICE_USER" "$INSTALL_PATH/venv"
  585. }
  586. install_nodejs() {
  587. if command -v node &>/dev/null; then
  588. local version
  589. version=$(node --version 2>/dev/null | sed 's/^v//')
  590. local major
  591. major=$(echo "$version" | cut -d'.' -f1)
  592. if [[ "$major" -ge 20 ]]; then
  593. success "Found Node.js v$version"
  594. return
  595. fi
  596. fi
  597. apt-get remove -y nodejs npm > /dev/null 2>&1 || true
  598. run_with_progress "Setting up Node.js repository" bash -c "curl -fsSL https://deb.nodesource.com/setup_22.x | bash -"
  599. run_with_progress "Installing Node.js" apt-get install -y nodejs
  600. hash -r 2>/dev/null || true
  601. success "Node.js installed: $(node --version)"
  602. }
  603. build_frontend() {
  604. cd "$INSTALL_PATH/frontend"
  605. run_with_progress "Installing frontend dependencies" npm ci
  606. run_with_progress "Building frontend" npm run build
  607. }
  608. create_bambuddy_env() {
  609. info "Creating Bambuddy configuration..."
  610. local env_file="$INSTALL_PATH/.env"
  611. cat > "$env_file" << EOF
  612. # Bambuddy Configuration
  613. # Generated by install.sh on $(date)
  614. DEBUG=false
  615. LOG_LEVEL=INFO
  616. LOG_TO_FILE=true
  617. EOF
  618. chown "$BAMBUDDY_SERVICE_USER:$BAMBUDDY_SERVICE_USER" "$env_file"
  619. chmod 600 "$env_file"
  620. success "Configuration saved to $env_file"
  621. }
  622. create_bambuddy_directories() {
  623. mkdir -p "$INSTALL_PATH/data" "$INSTALL_PATH/logs"
  624. chown -R "$BAMBUDDY_SERVICE_USER:$BAMBUDDY_SERVICE_USER" "$INSTALL_PATH/data" "$INSTALL_PATH/logs"
  625. success "Data directories created"
  626. }
  627. create_bambuddy_service() {
  628. info "Creating Bambuddy systemd service..."
  629. cat > /etc/systemd/system/bambuddy.service << EOF
  630. [Unit]
  631. Description=Bambuddy - Bambu Lab Print Management
  632. Documentation=https://github.com/maziggy/bambuddy
  633. After=network.target
  634. [Service]
  635. Type=simple
  636. User=$BAMBUDDY_SERVICE_USER
  637. Group=$BAMBUDDY_SERVICE_USER
  638. WorkingDirectory=$INSTALL_PATH
  639. EnvironmentFile=$INSTALL_PATH/.env
  640. Environment="DATA_DIR=$INSTALL_PATH/data"
  641. Environment="LOG_DIR=$INSTALL_PATH/logs"
  642. ExecStart=$INSTALL_PATH/venv/bin/uvicorn backend.app.main:app --host 0.0.0.0 --port $BAMBUDDY_PORT
  643. Restart=on-failure
  644. RestartSec=5
  645. StandardOutput=journal
  646. StandardError=journal
  647. NoNewPrivileges=true
  648. PrivateTmp=true
  649. ProtectSystem=strict
  650. ProtectHome=true
  651. ReadWritePaths=$INSTALL_PATH/data $INSTALL_PATH/logs $INSTALL_PATH
  652. [Install]
  653. WantedBy=multi-user.target
  654. EOF
  655. systemctl daemon-reload
  656. systemctl enable bambuddy.service
  657. success "Bambuddy service created and enabled"
  658. }
  659. # ─────────────────────────────────────────────────────────────────────────────
  660. # System Strip-Down (dedicated appliance — remove unnecessary services/packages)
  661. # ─────────────────────────────────────────────────────────────────────────────
  662. strip_services() {
  663. info "Disabling unnecessary services..."
  664. local services=(
  665. bluetooth.service
  666. lightdm.service
  667. cloud-init-local.service
  668. cloud-init.service
  669. cloud-init-network.service
  670. cloud-config.service
  671. cloud-final.service
  672. cloud-init-hotplugd.socket
  673. avahi-daemon.service
  674. avahi-daemon.socket
  675. ModemManager.service
  676. udisks2.service
  677. apparmor.service
  678. man-db.timer
  679. e2scrub_all.timer
  680. e2scrub_reap.service
  681. # Audio stack (no speakers on a spool reader)
  682. pipewire.service
  683. pipewire.socket
  684. pipewire-pulse.service
  685. pipewire-pulse.socket
  686. wireplumber.service
  687. # Printing
  688. cups.service
  689. cups.socket
  690. cups-browsed.service
  691. # Desktop services
  692. accounts-daemon.service
  693. upower.service
  694. polkit.service
  695. # Flatpak portals (not using Flatpak)
  696. xdg-desktop-portal.service
  697. xdg-desktop-portal-gtk.service
  698. xdg-document-portal.service
  699. xdg-permission-store.service
  700. # NFS/RPC (unnecessary + security surface)
  701. rpcbind.service
  702. rpcbind.socket
  703. # Bluetooth media proxy
  704. mpris-proxy.service
  705. )
  706. local disabled=0
  707. for svc in "${services[@]}"; do
  708. if systemctl is-enabled "$svc" &>/dev/null; then
  709. systemctl disable "$svc" 2>/dev/null || true
  710. systemctl mask "$svc" 2>/dev/null || true
  711. (( ++disabled ))
  712. fi
  713. done
  714. if (( disabled > 0 )); then
  715. success "Disabled $disabled unnecessary services"
  716. else
  717. success "No unnecessary services to disable"
  718. fi
  719. # Mask user-level services globally via /etc/systemd/user/ overrides.
  720. # The su-based approach doesn't reliably reach the user's systemd instance
  721. # when run from sudo, so we create global masks that apply before login.
  722. local user_services=(
  723. pipewire.service
  724. pipewire.socket
  725. pipewire-pulse.service
  726. pipewire-pulse.socket
  727. wireplumber.service
  728. xdg-desktop-portal.service
  729. xdg-desktop-portal-gtk.service
  730. xdg-document-portal.service
  731. xdg-permission-store.service
  732. mpris-proxy.service
  733. )
  734. mkdir -p /etc/systemd/user
  735. local user_masked=0
  736. for svc in "${user_services[@]}"; do
  737. if [[ ! -L "/etc/systemd/user/$svc" ]] || [[ "$(readlink /etc/systemd/user/$svc)" != "/dev/null" ]]; then
  738. ln -sf /dev/null "/etc/systemd/user/$svc"
  739. (( ++user_masked ))
  740. fi
  741. done
  742. if (( user_masked > 0 )); then
  743. success "Masked $user_masked unnecessary user services globally"
  744. fi
  745. }
  746. strip_packages() {
  747. info "Removing unnecessary packages..."
  748. local packages=(
  749. mkvtoolnix
  750. firmware-atheros
  751. firmware-mediatek
  752. cloud-init
  753. rpi-cloud-init-mods
  754. rpi-connect-lite
  755. avahi-daemon
  756. modemmanager
  757. udisks2
  758. pipewire
  759. pipewire-pulse
  760. wireplumber
  761. cups
  762. cups-browsed
  763. cups-common
  764. cups-client
  765. rpcbind
  766. )
  767. local to_remove=()
  768. for pkg in "${packages[@]}"; do
  769. if dpkg -l "$pkg" &>/dev/null 2>&1; then
  770. to_remove+=("$pkg")
  771. fi
  772. done
  773. if (( ${#to_remove[@]} > 0 )); then
  774. run_with_progress "Removing ${#to_remove[@]} packages" apt-get remove --purge -y "${to_remove[@]}"
  775. run_with_progress "Cleaning up dependencies" apt-get autoremove --purge -y
  776. else
  777. success "No unnecessary packages to remove"
  778. fi
  779. }
  780. # ─────────────────────────────────────────────────────────────────────────────
  781. # Kiosk Setup (labwc + Chromium + Plymouth splash)
  782. # ─────────────────────────────────────────────────────────────────────────────
  783. setup_kiosk() {
  784. info "Setting up touchscreen kiosk..."
  785. # Detect kiosk user (the human user who ran sudo)
  786. KIOSK_USER="${SUDO_USER:-$(logname 2>/dev/null || echo pi)}"
  787. KIOSK_URL="${BAMBUDDY_URL}/spoolbuddy?token=${API_KEY}"
  788. local KIOSK_HOME
  789. KIOSK_HOME=$(eval echo "~$KIOSK_USER")
  790. info "Kiosk user: $KIOSK_USER (home: $KIOSK_HOME)"
  791. info "Kiosk URL: $KIOSK_URL"
  792. # Allow kiosk user to read SpoolBuddy env so launcher can resolve backend URL
  793. # and API key dynamically instead of using stale install-time fallback values.
  794. local spoolbuddy_env="$INSTALL_PATH/spoolbuddy/.env"
  795. if [[ -f "$spoolbuddy_env" ]]; then
  796. usermod -aG "$SPOOLBUDDY_SERVICE_USER" "$KIOSK_USER" 2>/dev/null || true
  797. chgrp "$SPOOLBUDDY_SERVICE_USER" "$spoolbuddy_env" 2>/dev/null || true
  798. chmod 640 "$spoolbuddy_env" 2>/dev/null || true
  799. fi
  800. # ── Install kiosk packages ────────────────────────────────────────────
  801. # Temporarily block initramfs rebuilds during package install — we rebuild
  802. # once at the end after the Plymouth theme is configured, saving ~4 runs
  803. # (one per installed kernel per hook trigger).
  804. if [[ -x /usr/sbin/update-initramfs ]]; then
  805. dpkg-divert --local --rename --add /usr/sbin/update-initramfs >/dev/null 2>&1 || true
  806. ln -sf /bin/true /usr/sbin/update-initramfs
  807. fi
  808. run_with_progress "Installing kiosk packages" apt-get install -y labwc chromium plymouth wlr-randr
  809. # Restore real update-initramfs
  810. if dpkg-divert --list /usr/sbin/update-initramfs 2>/dev/null | grep -q local; then
  811. rm -f /usr/sbin/update-initramfs
  812. dpkg-divert --local --rename --remove /usr/sbin/update-initramfs >/dev/null 2>&1 || true
  813. fi
  814. # ── config.txt tweaks ─────────────────────────────────────────────────
  815. local boot_config="/boot/firmware/config.txt"
  816. if [[ ! -f "$boot_config" ]]; then
  817. boot_config="/boot/config.txt"
  818. fi
  819. if [[ -f "$boot_config" ]]; then
  820. info "Configuring $boot_config for kiosk..."
  821. # Disable audio (change existing on→off)
  822. sed -i 's/^dtparam=audio=on/dtparam=audio=off/' "$boot_config"
  823. # Disable camera auto-detect (change existing 1→0)
  824. sed -i 's/^camera_auto_detect=1/camera_auto_detect=0/' "$boot_config"
  825. # Append if missing: gpu_mem=32
  826. if ! grep -q "^gpu_mem=" "$boot_config"; then
  827. echo "" >> "$boot_config"
  828. echo "# Kiosk: Minimal GPU firmware memory (KMS uses CMA from system RAM)" >> "$boot_config"
  829. echo "gpu_mem=32" >> "$boot_config"
  830. fi
  831. # Append if missing: dtoverlay=disable-bt
  832. if ! grep -q "^dtoverlay=disable-bt" "$boot_config"; then
  833. echo "" >> "$boot_config"
  834. echo "# Kiosk: Disable Bluetooth hardware" >> "$boot_config"
  835. echo "dtoverlay=disable-bt" >> "$boot_config"
  836. fi
  837. # Append if missing: disable_splash=1
  838. if ! grep -q "^disable_splash=" "$boot_config"; then
  839. echo "" >> "$boot_config"
  840. echo "# Kiosk: Disable Raspberry Pi firmware splash, use custom splash.png" >> "$boot_config"
  841. echo "disable_splash=1" >> "$boot_config"
  842. fi
  843. success "Boot config updated"
  844. fi
  845. # ── cmdline.txt tweaks ────────────────────────────────────────────────
  846. local cmdline="/boot/firmware/cmdline.txt"
  847. if [[ ! -f "$cmdline" ]]; then
  848. cmdline="/boot/cmdline.txt"
  849. fi
  850. if [[ -f "$cmdline" ]]; then
  851. info "Configuring $cmdline for kiosk..."
  852. # Remove serial console (Plymouth needs tty-only console)
  853. sed -i 's/console=serial0,[0-9]* //' "$cmdline"
  854. # Disable console blanking (kernel default is 600s, can blank during boot transition)
  855. grep -q "consoleblank=" "$cmdline" || sed -i 's/$/ consoleblank=0/' "$cmdline"
  856. # Add splash quiet loglevel=3 logo.nologo if missing
  857. grep -q "splash" "$cmdline" || sed -i 's/$/ splash quiet loglevel=3 logo.nologo/' "$cmdline"
  858. # Add video mode if missing
  859. grep -q "video=HDMI-A-1" "$cmdline" || sed -i 's/$/ video=HDMI-A-1:1024x600@60/' "$cmdline"
  860. success "Kernel cmdline updated"
  861. fi
  862. # ── Plymouth splash theme ─────────────────────────────────────────────
  863. info "Installing Plymouth boot splash..."
  864. local theme_dir="/usr/share/plymouth/themes/spoolbuddy"
  865. mkdir -p "$theme_dir"
  866. # Copy bundled splash image from the install directory
  867. local script_dir
  868. script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
  869. if [[ -f "$script_dir/splash.png" ]]; then
  870. cp "$script_dir/splash.png" "$theme_dir/splash.png"
  871. elif [[ -f "$INSTALL_PATH/spoolbuddy/install/splash.png" ]]; then
  872. cp "$INSTALL_PATH/spoolbuddy/install/splash.png" "$theme_dir/splash.png"
  873. else
  874. warn "splash.png not found — Plymouth splash will not display an image"
  875. fi
  876. # Write .plymouth theme file
  877. cat > "$theme_dir/spoolbuddy.plymouth" << 'EOF'
  878. [Plymouth Theme]
  879. Name=SpoolBuddy
  880. Description=SpoolBuddy boot splash
  881. ModuleName=script
  882. [script]
  883. ImageDir=/usr/share/plymouth/themes/spoolbuddy
  884. ScriptFile=/usr/share/plymouth/themes/spoolbuddy/spoolbuddy.script
  885. EOF
  886. # Write .script theme file
  887. cat > "$theme_dir/spoolbuddy.script" << 'EOF'
  888. wallpaper_image = Image("splash.png");
  889. screen_width = Window.GetWidth();
  890. screen_height = Window.GetHeight();
  891. resized_wallpaper_image = wallpaper_image.Scale(screen_width, screen_height);
  892. wallpaper_sprite = Sprite(resized_wallpaper_image);
  893. wallpaper_sprite.SetZ(-100);
  894. EOF
  895. plymouth-set-default-theme spoolbuddy
  896. run_with_progress "Updating initramfs" update-initramfs -u
  897. success "Plymouth splash installed"
  898. # ── Auto-login on tty1 ────────────────────────────────────────────────
  899. info "Configuring auto-login for $KIOSK_USER..."
  900. mkdir -p /etc/systemd/system/getty@tty1.service.d
  901. cat > /etc/systemd/system/getty@tty1.service.d/autologin.conf << EOF
  902. [Unit]
  903. After=network-online.target
  904. Wants=network-online.target
  905. [Service]
  906. ExecStart=
  907. ExecStart=-/sbin/agetty --autologin $KIOSK_USER --noclear %I \$TERM
  908. EOF
  909. success "Auto-login configured"
  910. # ── labwc rc.xml (no decorations, no keybinds) ────────────────────────
  911. info "Configuring labwc window manager..."
  912. local labwc_dir="$KIOSK_HOME/.config/labwc"
  913. mkdir -p "$labwc_dir"
  914. cat > "$labwc_dir/rc.xml" << 'EOF'
  915. <?xml version="1.0"?>
  916. <labwc_config>
  917. <!-- Disable screen blanking — kiosk must stay on -->
  918. <core>
  919. <screenBlankTimeout>0</screenBlankTimeout>
  920. </core>
  921. <theme>
  922. <name></name>
  923. <cornerRadius>0</cornerRadius>
  924. </theme>
  925. <!-- Disable all keybindings - kiosk lockdown -->
  926. <keyboard>
  927. </keyboard>
  928. <!-- Disable right-click menu -->
  929. <mouse>
  930. <default />
  931. </mouse>
  932. <!-- Remove window decorations, maximize Chromium, prevent unfullscreen -->
  933. <windowRules>
  934. <windowRule identifier="*">
  935. <serverDecoration>no</serverDecoration>
  936. </windowRule>
  937. <windowRule identifier="chromium">
  938. <skipTaskbar>yes</skipTaskbar>
  939. <fixedPosition>yes</fixedPosition>
  940. </windowRule>
  941. </windowRules>
  942. </labwc_config>
  943. EOF
  944. # ── Override Debian/RPi Chromium defaults for kiosk performance ──────
  945. cat > /etc/chromium.d/spoolbuddy-kiosk << 'CHROMIUM_EOF'
  946. # SpoolBuddy kiosk: add kiosk-specific flags on top of Pi defaults.
  947. # Preserves Pi GPU settings (gpu-rasterization, ANGLE/GLES) for stability.
  948. CHROMIUM_FLAGS="$CHROMIUM_FLAGS --disable-smooth-scrolling"
  949. CHROMIUM_FLAGS="$CHROMIUM_FLAGS --disable-extensions"
  950. CHROMIUM_FLAGS="$CHROMIUM_FLAGS --disable-background-timer-throttling"
  951. CHROMIUM_FLAGS="$CHROMIUM_FLAGS --disable-renderer-backgrounding"
  952. CHROMIUM_FLAGS="$CHROMIUM_FLAGS --disable-crash-reporter"
  953. CHROMIUM_EOF
  954. success "Chromium kiosk performance flags installed"
  955. # ── kiosk launcher (dynamic URL from spoolbuddy/.env) ─────────────────
  956. local kiosk_launcher="/usr/local/bin/spoolbuddy-kiosk-launch"
  957. cat > "$kiosk_launcher" << EOF
  958. #!/usr/bin/env bash
  959. set -euo pipefail
  960. ENV_FILE="$INSTALL_PATH/spoolbuddy/.env"
  961. FALLBACK_URL="$KIOSK_URL"
  962. backend_url=""
  963. api_key=""
  964. if [[ -r "\$ENV_FILE" ]]; then
  965. backend_url="\$(sed -n 's/^SPOOLBUDDY_BACKEND_URL=//p' "\$ENV_FILE" | tail -n1 | tr -d '\r')"
  966. api_key="\$(sed -n 's/^SPOOLBUDDY_API_KEY=//p' "\$ENV_FILE" | tail -n1 | tr -d '\r')"
  967. backend_url="\${backend_url%\"}"
  968. backend_url="\${backend_url#\"}"
  969. api_key="\${api_key%\"}"
  970. api_key="\${api_key#\"}"
  971. elif [[ -f "\$ENV_FILE" ]]; then
  972. echo "spoolbuddy-kiosk-launch: ERROR: \$ENV_FILE exists but is not readable" >&2
  973. echo "spoolbuddy-kiosk-launch: Fix permissions (group-readable by kiosk user) and restart kiosk" >&2
  974. exit 1
  975. fi
  976. if [[ -n "\$backend_url" && -n "\$api_key" ]]; then
  977. backend_url="\${backend_url%/}"
  978. kiosk_url="\${backend_url}/spoolbuddy?token=\${api_key}"
  979. else
  980. kiosk_url="\$FALLBACK_URL"
  981. fi
  982. exec chromium --kiosk --no-first-run --disable-infobars \
  983. --disable-session-crashed-bubble --disable-features=TranslateUI \
  984. --noerrdialogs --disable-component-update \
  985. --overscroll-history-navigation=0 \
  986. --ozone-platform=wayland \
  987. --disable-crash-reporter --disable-breakpad \
  988. "\$kiosk_url"
  989. EOF
  990. chmod 755 "$kiosk_launcher"
  991. # Tiny self-check: ensure sed command substitutions were not expanded
  992. # while generating the launcher script.
  993. if ! grep -Fq 'backend_url="$(sed -n' "$kiosk_launcher" || ! grep -Fq 'api_key="$(sed -n' "$kiosk_launcher"; then
  994. error "Kiosk launcher generation failed: dynamic env parsing commands were expanded unexpectedly"
  995. fi
  996. # ── labwc autostart ───────────────────────────────────────────────────
  997. cat > "$labwc_dir/autostart" << EOF
  998. # Force 1024x600 (panel doesn't advertise this natively)
  999. wlr-randr --output HDMI-A-1 --custom-mode 1024x600@60 &
  1000. # Prevent display blanking (labwc <0.8 lacks screenBlankTimeout config support)
  1001. (while true; do wlr-randr --output HDMI-A-1 --on 2>/dev/null; sleep 60; done) &
  1002. # Launch Chromium via helper that resolves URL from spoolbuddy/.env
  1003. $kiosk_launcher &
  1004. EOF
  1005. chown -R "$KIOSK_USER:$KIOSK_USER" "$labwc_dir"
  1006. # ── .bash_profile (source .bashrc, exec labwc on tty1) ────────────────
  1007. cat > "$KIOSK_HOME/.bash_profile" << 'EOF'
  1008. # Source .bashrc if it exists
  1009. if [ -f ~/.bashrc ]; then
  1010. . ~/.bashrc
  1011. fi
  1012. # Auto-start kiosk on tty1
  1013. if [ "$(tty)" = "/dev/tty1" ]; then
  1014. exec labwc
  1015. fi
  1016. EOF
  1017. chown "$KIOSK_USER:$KIOSK_USER" "$KIOSK_HOME/.bash_profile"
  1018. REBOOT_NEEDED="true"
  1019. success "Kiosk setup complete"
  1020. }
  1021. # ─────────────────────────────────────────────────────────────────────────────
  1022. # User Prompts
  1023. # ─────────────────────────────────────────────────────────────────────────────
  1024. parse_args() {
  1025. while [[ $# -gt 0 ]]; do
  1026. case "$1" in
  1027. --mode)
  1028. INSTALL_MODE="$2"
  1029. shift 2
  1030. ;;
  1031. --repo)
  1032. INSTALL_REPO="$(normalize_github_repo_url "$2")"
  1033. shift 2
  1034. ;;
  1035. --ref)
  1036. INSTALL_REF="$2"
  1037. shift 2
  1038. ;;
  1039. --bambuddy-url)
  1040. BAMBUDDY_URL="$2"
  1041. shift 2
  1042. ;;
  1043. --api-key)
  1044. API_KEY="$2"
  1045. shift 2
  1046. ;;
  1047. --path)
  1048. INSTALL_PATH="$2"
  1049. shift 2
  1050. ;;
  1051. --port)
  1052. BAMBUDDY_PORT="$2"
  1053. shift 2
  1054. ;;
  1055. --ssh-pubkey)
  1056. SSH_PUBKEY="$2"
  1057. shift 2
  1058. ;;
  1059. --yes|-y)
  1060. NON_INTERACTIVE="true"
  1061. shift
  1062. ;;
  1063. --help|-h)
  1064. show_help
  1065. ;;
  1066. *)
  1067. error "Unknown option: $1 (use --help for usage)"
  1068. ;;
  1069. esac
  1070. done
  1071. }
  1072. ask_install_mode() {
  1073. if [[ -n "$INSTALL_MODE" ]]; then
  1074. return
  1075. fi
  1076. echo ""
  1077. echo -e "${BOLD}How would you like to set up SpoolBuddy?${NC}"
  1078. echo ""
  1079. echo -e " ${CYAN}1)${NC} SpoolBuddy only"
  1080. echo " NFC reader + scale on this RPi, Bambuddy runs on another device"
  1081. echo ""
  1082. echo -e " ${CYAN}2)${NC} SpoolBuddy + Bambuddy"
  1083. echo " Both running natively on this Raspberry Pi"
  1084. echo ""
  1085. while true; do
  1086. echo -en "${BOLD}Choose${NC} [${CYAN}1${NC}/${CYAN}2${NC}]: "
  1087. read -r choice
  1088. case "$choice" in
  1089. 1) INSTALL_MODE="spoolbuddy"; return;;
  1090. 2) INSTALL_MODE="full"; return;;
  1091. *) echo "Please enter 1 or 2.";;
  1092. esac
  1093. done
  1094. }
  1095. gather_config() {
  1096. echo ""
  1097. echo -e "${BOLD}Configuration${NC}"
  1098. echo -e "${CYAN}─────────────────────────────────────────${NC}"
  1099. echo ""
  1100. # Set default install path based on mode
  1101. if [[ -z "$INSTALL_PATH" ]]; then
  1102. if [[ "$INSTALL_MODE" == "full" ]]; then
  1103. INSTALL_PATH="/opt/bambuddy"
  1104. else
  1105. INSTALL_PATH="/opt/bambuddy"
  1106. fi
  1107. fi
  1108. prompt "Installation directory" "$INSTALL_PATH" INSTALL_PATH
  1109. if [[ -z "$INSTALL_REPO" ]]; then
  1110. INSTALL_REPO="$GITHUB_REPO"
  1111. fi
  1112. prompt "Git repository URL" "$INSTALL_REPO" INSTALL_REPO
  1113. INSTALL_REPO="$(normalize_github_repo_url "$INSTALL_REPO")"
  1114. if [[ -z "$INSTALL_REF" ]]; then
  1115. INSTALL_REF="main"
  1116. fi
  1117. if [[ "$NON_INTERACTIVE" != "true" && -n "$DETECTED_INSTALLER_REF" && "$DETECTED_INSTALLER_REF" != "HEAD" ]]; then
  1118. echo ""
  1119. echo -e "${BOLD}Install Source Ref${NC}"
  1120. echo "1) main"
  1121. echo "2) $DETECTED_INSTALLER_REF (detected from installer context)"
  1122. echo "3) custom"
  1123. while true; do
  1124. echo -en "${BOLD}Choose${NC} [1/2/3]: "
  1125. read -r ref_choice
  1126. case "$ref_choice" in
  1127. ""|1)
  1128. INSTALL_REF="main"
  1129. break
  1130. ;;
  1131. 2)
  1132. INSTALL_REF="$DETECTED_INSTALLER_REF"
  1133. break
  1134. ;;
  1135. 3)
  1136. prompt "Git ref (branch/tag/commit)" "$INSTALL_REF" INSTALL_REF
  1137. break
  1138. ;;
  1139. *)
  1140. echo "Please enter 1, 2, or 3."
  1141. ;;
  1142. esac
  1143. done
  1144. else
  1145. prompt "Git ref (branch/tag/commit)" "$INSTALL_REF" INSTALL_REF
  1146. fi
  1147. if [[ "$INSTALL_MODE" == "spoolbuddy" ]]; then
  1148. # Need remote Bambuddy URL and API key
  1149. echo ""
  1150. info "SpoolBuddy needs to connect to your Bambuddy server."
  1151. info "You can find/create an API key in Bambuddy under Settings -> API Keys."
  1152. echo ""
  1153. while [[ -z "$BAMBUDDY_URL" ]]; do
  1154. prompt "Bambuddy server URL (e.g. http://192.168.1.100:8000)" "" BAMBUDDY_URL
  1155. if [[ -z "$BAMBUDDY_URL" ]]; then
  1156. warn "Bambuddy URL is required"
  1157. fi
  1158. done
  1159. while [[ -z "$API_KEY" ]]; do
  1160. prompt "Bambuddy API key" "" API_KEY
  1161. if [[ -z "$API_KEY" ]]; then
  1162. warn "API key is required"
  1163. fi
  1164. done
  1165. else
  1166. # Full mode — Bambuddy runs locally
  1167. prompt "Bambuddy port" "$BAMBUDDY_PORT" BAMBUDDY_PORT
  1168. BAMBUDDY_URL="http://localhost:$BAMBUDDY_PORT"
  1169. echo ""
  1170. info "After installation, create an API key in Bambuddy (Settings -> API Keys)"
  1171. info "and update it in: $INSTALL_PATH/spoolbuddy/.env"
  1172. API_KEY="CHANGE_ME_AFTER_SETUP"
  1173. fi
  1174. # Summary
  1175. echo ""
  1176. echo -e "${BOLD}Installation Summary${NC}"
  1177. echo -e "${CYAN}─────────────────────────────────────────${NC}"
  1178. echo -e " Mode: ${GREEN}$([ "$INSTALL_MODE" == "full" ] && echo "Bambuddy + SpoolBuddy" || echo "SpoolBuddy only")${NC}"
  1179. echo -e " Install path: ${GREEN}$INSTALL_PATH${NC}"
  1180. echo -e " Git repo: ${GREEN}$INSTALL_REPO${NC}"
  1181. echo -e " Git ref: ${GREEN}$INSTALL_REF${NC}"
  1182. if [[ "$INSTALL_MODE" == "full" ]]; then
  1183. echo -e " Bambuddy port: ${GREEN}$BAMBUDDY_PORT${NC}"
  1184. echo -e " Bambuddy URL: ${GREEN}$BAMBUDDY_URL${NC}"
  1185. else
  1186. echo -e " Bambuddy URL: ${GREEN}$BAMBUDDY_URL${NC}"
  1187. fi
  1188. echo ""
  1189. if ! prompt_yes_no "Proceed with installation?" "y"; then
  1190. echo "Installation cancelled."
  1191. exit 0
  1192. fi
  1193. }
  1194. # ─────────────────────────────────────────────────────────────────────────────
  1195. # Main
  1196. # ─────────────────────────────────────────────────────────────────────────────
  1197. main() {
  1198. parse_args "$@"
  1199. detect_installer_source_context
  1200. echo ""
  1201. echo -e "${CYAN}╔══════════════════════════════════════════════════════════╗${NC}"
  1202. echo -e "${CYAN}║ ║${NC}"
  1203. echo -e "${CYAN}║ ____ _ ____ _ _ ║${NC}"
  1204. echo -e "${CYAN}║ / ___| _ __ ___ ___ | | __ ) _ _ __| | __| |_ _ ║${NC}"
  1205. echo -e "${CYAN}║ \\___ \\| '_ \\ / _ \\ / _ \\| | _ \\| | | |/ _\` |/ _\` | | | |║${NC}"
  1206. echo -e "${CYAN}║ ___) | |_) | (_) | (_) | | |_) | |_| | (_| | (_| | |_| |║${NC}"
  1207. echo -e "${CYAN}║ |____/| .__/ \\___/ \\___/|_|____/ \\__,_|\\__,_|\\__,_|\\__, |║${NC}"
  1208. echo -e "${CYAN}║ |_| |___/ ║${NC}"
  1209. echo -e "${CYAN}║ ║${NC}"
  1210. echo -e "${CYAN}║ NFC Spool Management for Bambuddy ║${NC}"
  1211. echo -e "${CYAN}║ ║${NC}"
  1212. echo -e "${CYAN}╚══════════════════════════════════════════════════════════╝${NC}"
  1213. echo ""
  1214. # Check if running via pipe without -y
  1215. if [[ ! -t 0 ]] && [[ "$NON_INTERACTIVE" != "true" ]]; then
  1216. error "Interactive mode requires a terminal. Use -y for unattended install, or download and run directly."
  1217. fi
  1218. # Pre-flight checks
  1219. check_root
  1220. check_raspberry_pi
  1221. check_raspberry_pi_os
  1222. if ! detect_python; then
  1223. info "Python 3.10+ not found, will install..."
  1224. fi
  1225. # Gather user preferences
  1226. ask_install_mode
  1227. gather_config
  1228. # Validate mode
  1229. if [[ "$INSTALL_MODE" != "spoolbuddy" && "$INSTALL_MODE" != "full" ]]; then
  1230. error "Invalid mode: $INSTALL_MODE (must be 'spoolbuddy' or 'full')"
  1231. fi
  1232. echo ""
  1233. echo -e "${BOLD}Starting Installation${NC}"
  1234. echo -e "${CYAN}─────────────────────────────────────────${NC}"
  1235. echo ""
  1236. # ── Step 1: Raspberry Pi hardware config ──────────────────────────────
  1237. info "Configuring Raspberry Pi hardware..."
  1238. enable_spi
  1239. enable_i2c
  1240. configure_boot_config
  1241. echo ""
  1242. # ── Step 2: System packages ───────────────────────────────────────────
  1243. install_system_packages
  1244. install_wifi_safeguard
  1245. upgrade_system_packages
  1246. detect_python || error "Failed to install Python 3.10+"
  1247. echo ""
  1248. # ── Step 2b: Strip unnecessary services & packages ────────────────────
  1249. strip_services
  1250. strip_packages
  1251. echo ""
  1252. # ── Step 3: Download source code ──────────────────────────────────────
  1253. create_spoolbuddy_user
  1254. download_spoolbuddy
  1255. echo ""
  1256. # ── Step 3b: Kiosk setup (labwc + Chromium + squeekboard + Plymouth) ──
  1257. setup_kiosk
  1258. echo ""
  1259. # ── Step 4: SpoolBuddy setup ──────────────────────────────────────────
  1260. info "Setting up SpoolBuddy..."
  1261. setup_spoolbuddy_venv
  1262. create_spoolbuddy_env
  1263. # Kiosk env access: only needed if actual kiosk hardware is available
  1264. if [[ -f /boot/firmware/config.txt ]] || [[ -f /boot/config.txt ]]; then
  1265. ensure_kiosk_env_access
  1266. fi
  1267. setup_ssh_key
  1268. create_spoolbuddy_service
  1269. echo ""
  1270. # ── Step 5: Bambuddy setup (full mode only) ───────────────────────────
  1271. if [[ "$INSTALL_MODE" == "full" ]]; then
  1272. info "Setting up Bambuddy..."
  1273. create_bambuddy_user
  1274. setup_bambuddy_venv
  1275. install_nodejs
  1276. build_frontend
  1277. create_bambuddy_directories
  1278. create_bambuddy_env
  1279. create_bambuddy_service
  1280. echo ""
  1281. fi
  1282. # ── Done ──────────────────────────────────────────────────────────────
  1283. echo ""
  1284. echo -e "${GREEN}╔══════════════════════════════════════════════════════════╗${NC}"
  1285. echo -e "${GREEN}║ ║${NC}"
  1286. echo -e "${GREEN}║ Installation Complete! ║${NC}"
  1287. echo -e "${GREEN}║ ║${NC}"
  1288. echo -e "${GREEN}╚══════════════════════════════════════════════════════════╝${NC}"
  1289. echo ""
  1290. local ip_addr
  1291. ip_addr=$(hostname -I 2>/dev/null | awk '{print $1}') || ip_addr="<your-ip>"
  1292. if [[ "$INSTALL_MODE" == "full" ]]; then
  1293. echo -e " ${BOLD}Bambuddy:${NC} ${CYAN}http://$ip_addr:$BAMBUDDY_PORT${NC}"
  1294. else
  1295. echo -e " ${BOLD}SpoolBuddy:${NC} Connecting to ${CYAN}$BAMBUDDY_URL${NC}"
  1296. fi
  1297. echo -e " ${BOLD}Kiosk URL:${NC} ${CYAN}$KIOSK_URL${NC}"
  1298. echo -e " ${BOLD}Kiosk user:${NC} ${CYAN}$KIOSK_USER${NC}"
  1299. echo ""
  1300. if [[ "$INSTALL_MODE" == "full" ]]; then
  1301. echo -e " ${BOLD}Next steps:${NC}"
  1302. echo -e " 1. Reboot (required for kiosk, Plymouth splash, and hardware changes)"
  1303. echo -e " 2. The touchscreen kiosk will start automatically after reboot"
  1304. echo -e " 3. On another device, open ${CYAN}http://$ip_addr:$BAMBUDDY_PORT${NC}"
  1305. echo -e " 4. Go to Settings -> API Keys and create an API key"
  1306. echo -e " 5. Update the API key in: ${CYAN}$INSTALL_PATH/spoolbuddy/.env${NC}"
  1307. echo -e " 6. Restart SpoolBuddy: ${CYAN}sudo systemctl restart spoolbuddy${NC}"
  1308. fi
  1309. echo ""
  1310. echo -e " ${BOLD}Manage services:${NC}"
  1311. echo -e " SpoolBuddy status: ${CYAN}sudo systemctl status spoolbuddy${NC}"
  1312. echo -e " SpoolBuddy logs: ${CYAN}sudo journalctl -u spoolbuddy -f${NC}"
  1313. if [[ "$INSTALL_MODE" == "full" ]]; then
  1314. echo -e " Bambuddy status: ${CYAN}sudo systemctl status bambuddy${NC}"
  1315. echo -e " Bambuddy logs: ${CYAN}sudo journalctl -u bambuddy -f${NC}"
  1316. fi
  1317. echo ""
  1318. echo -e " ${BOLD}Configuration:${NC} ${CYAN}$INSTALL_PATH/spoolbuddy/.env${NC}"
  1319. echo -e " ${BOLD}Hardware wiring:${NC} ${CYAN}$INSTALL_PATH/spoolbuddy/README.md${NC}"
  1320. echo -e " ${BOLD}Diagnostics:${NC} ${CYAN}sudo $INSTALL_PATH/spoolbuddy/venv/bin/python $INSTALL_PATH/spoolbuddy/pn5180_diag.py${NC}"
  1321. echo ""
  1322. echo -e " ${YELLOW}A reboot is required to apply all changes (kiosk, Plymouth splash, hardware).${NC}"
  1323. echo ""
  1324. if prompt_yes_no "Reboot now?" "y"; then
  1325. reboot
  1326. else
  1327. echo -e " Run ${CYAN}sudo reboot${NC} when ready."
  1328. fi
  1329. echo ""
  1330. }
  1331. main "$@"