install.sh 58 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562
  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. SUDOERS
  448. chmod 440 /etc/sudoers.d/spoolbuddy
  449. success "Sudoers entries created for service and kiosk restart"
  450. }
  451. download_spoolbuddy() {
  452. if [[ -d "$INSTALL_PATH/.git" ]]; then
  453. info "Existing installation found, updating..."
  454. git config --global --add safe.directory "$INSTALL_PATH" 2>/dev/null || true
  455. cd "$INSTALL_PATH"
  456. git remote set-url origin "$INSTALL_REPO" 2>/dev/null || true
  457. run_with_progress "Fetching updates" git fetch origin
  458. resolve_install_ref "$INSTALL_REF"
  459. else
  460. mkdir -p "$INSTALL_PATH"
  461. run_with_progress "Cloning repository" git clone "$INSTALL_REPO" "$INSTALL_PATH"
  462. cd "$INSTALL_PATH"
  463. resolve_install_ref "$INSTALL_REF"
  464. fi
  465. chown -R "$SPOOLBUDDY_SERVICE_USER:$SPOOLBUDDY_SERVICE_USER" "$INSTALL_PATH"
  466. }
  467. setup_spoolbuddy_venv() {
  468. cd "$INSTALL_PATH/spoolbuddy"
  469. run_with_progress "Creating SpoolBuddy venv" $PYTHON_CMD -m venv --system-site-packages venv
  470. run_with_progress "Upgrading pip" "$INSTALL_PATH/spoolbuddy/venv/bin/pip" install --upgrade pip
  471. run_with_progress "Installing SpoolBuddy packages" "$INSTALL_PATH/spoolbuddy/venv/bin/pip" install $SPOOLBUDDY_PIP_PACKAGES
  472. chown -R "$SPOOLBUDDY_SERVICE_USER:$SPOOLBUDDY_SERVICE_USER" "$INSTALL_PATH/spoolbuddy/venv"
  473. }
  474. create_spoolbuddy_env() {
  475. info "Creating SpoolBuddy configuration..."
  476. local env_file="$INSTALL_PATH/spoolbuddy/.env"
  477. cat > "$env_file" << EOF
  478. # SpoolBuddy Configuration
  479. # Generated by install.sh on $(date)
  480. # Bambuddy backend URL
  481. SPOOLBUDDY_BACKEND_URL=$BAMBUDDY_URL
  482. # API key (create one in Bambuddy Settings -> API Keys)
  483. SPOOLBUDDY_API_KEY=$API_KEY
  484. # NAU7802 scale bus (RPi GPIO2/GPIO3)
  485. SPOOLBUDDY_I2C_BUS=1
  486. EOF
  487. chown "$SPOOLBUDDY_SERVICE_USER:$SPOOLBUDDY_SERVICE_USER" "$env_file"
  488. # Keep secrets owner-writable while allowing kiosk user (in spoolbuddy group)
  489. # to read backend URL/API key for dynamic launcher URL resolution.
  490. chgrp "$SPOOLBUDDY_SERVICE_USER" "$env_file"
  491. chmod 640 "$env_file"
  492. success "Configuration saved to $env_file"
  493. }
  494. ensure_kiosk_env_access() {
  495. local env_file="$INSTALL_PATH/spoolbuddy/.env"
  496. if [[ ! -f "$env_file" ]]; then
  497. warn "SpoolBuddy env file not found at $env_file"
  498. return
  499. fi
  500. # Ensure kiosk user is known even when this function is called outside setup_kiosk.
  501. if [[ -z "$KIOSK_USER" ]]; then
  502. KIOSK_USER="${SUDO_USER:-$(logname 2>/dev/null || echo pi)}"
  503. fi
  504. if id "$KIOSK_USER" &>/dev/null; then
  505. usermod -aG "$SPOOLBUDDY_SERVICE_USER" "$KIOSK_USER" 2>/dev/null || true
  506. fi
  507. chgrp "$SPOOLBUDDY_SERVICE_USER" "$env_file"
  508. chmod 640 "$env_file"
  509. if ! su -s /bin/sh -c "test -r '$env_file'" "$KIOSK_USER"; then
  510. error "Kiosk user '$KIOSK_USER' cannot read $env_file (required for dynamic kiosk URL). Check groups/permissions."
  511. fi
  512. success "Verified kiosk user '$KIOSK_USER' can read SpoolBuddy env"
  513. }
  514. setup_ssh_key() {
  515. info "Setting up SSH access for Bambuddy remote updates..."
  516. local ssh_dir="$INSTALL_PATH/.ssh"
  517. local auth_keys="$ssh_dir/authorized_keys"
  518. mkdir -p "$ssh_dir"
  519. chmod 700 "$ssh_dir"
  520. if [[ -n "$SSH_PUBKEY" ]]; then
  521. # Manual key provided via --ssh-pubkey flag
  522. if [[ -f "$auth_keys" ]] && grep -qF "$SSH_PUBKEY" "$auth_keys" 2>/dev/null; then
  523. info "SSH key already present in authorized_keys"
  524. else
  525. echo "$SSH_PUBKEY" >> "$auth_keys"
  526. success "SSH public key added"
  527. fi
  528. else
  529. # No manual key — the daemon will auto-deploy it on first registration
  530. info "SSH key will be deployed automatically when the daemon connects to Bambuddy"
  531. touch "$auth_keys"
  532. fi
  533. chmod 600 "$auth_keys"
  534. chown -R "$SPOOLBUDDY_SERVICE_USER:$SPOOLBUDDY_SERVICE_USER" "$ssh_dir"
  535. }
  536. create_spoolbuddy_service() {
  537. info "Creating SpoolBuddy systemd service..."
  538. local after_line="After=network-online.target"
  539. if [[ "$INSTALL_MODE" == "full" ]]; then
  540. after_line="After=network-online.target bambuddy.service"
  541. fi
  542. cat > /etc/systemd/system/spoolbuddy.service << EOF
  543. [Unit]
  544. Description=SpoolBuddy - NFC Spool Management Daemon
  545. Documentation=https://github.com/maziggy/bambuddy
  546. $after_line
  547. Wants=network-online.target
  548. [Service]
  549. Type=simple
  550. User=$SPOOLBUDDY_SERVICE_USER
  551. WorkingDirectory=$INSTALL_PATH/spoolbuddy
  552. EnvironmentFile=$INSTALL_PATH/spoolbuddy/.env
  553. ExecStart=$INSTALL_PATH/spoolbuddy/venv/bin/python -m daemon.main
  554. Restart=always
  555. RestartSec=5
  556. StandardOutput=journal
  557. StandardError=journal
  558. [Install]
  559. WantedBy=multi-user.target
  560. EOF
  561. systemctl daemon-reload
  562. systemctl enable spoolbuddy.service
  563. success "SpoolBuddy service created and enabled"
  564. }
  565. # ─────────────────────────────────────────────────────────────────────────────
  566. # Bambuddy Installation (full mode only)
  567. # ─────────────────────────────────────────────────────────────────────────────
  568. create_bambuddy_user() {
  569. if id "$BAMBUDDY_SERVICE_USER" &>/dev/null; then
  570. info "User '$BAMBUDDY_SERVICE_USER' already exists"
  571. return
  572. fi
  573. info "Creating service user '$BAMBUDDY_SERVICE_USER'..."
  574. useradd --system --shell /usr/sbin/nologin --home-dir "$INSTALL_PATH" "$BAMBUDDY_SERVICE_USER"
  575. success "Service user created"
  576. }
  577. setup_bambuddy_venv() {
  578. cd "$INSTALL_PATH"
  579. run_with_progress "Creating Bambuddy venv" $PYTHON_CMD -m venv venv
  580. run_with_progress "Upgrading pip" "$INSTALL_PATH/venv/bin/pip" install --upgrade pip
  581. run_with_progress "Installing Bambuddy dependencies" "$INSTALL_PATH/venv/bin/pip" install -r requirements.txt
  582. chown -R "$BAMBUDDY_SERVICE_USER:$BAMBUDDY_SERVICE_USER" "$INSTALL_PATH/venv"
  583. }
  584. install_nodejs() {
  585. if command -v node &>/dev/null; then
  586. local version
  587. version=$(node --version 2>/dev/null | sed 's/^v//')
  588. local major
  589. major=$(echo "$version" | cut -d'.' -f1)
  590. if [[ "$major" -ge 20 ]]; then
  591. success "Found Node.js v$version"
  592. return
  593. fi
  594. fi
  595. apt-get remove -y nodejs npm > /dev/null 2>&1 || true
  596. run_with_progress "Setting up Node.js repository" bash -c "curl -fsSL https://deb.nodesource.com/setup_22.x | bash -"
  597. run_with_progress "Installing Node.js" apt-get install -y nodejs
  598. hash -r 2>/dev/null || true
  599. success "Node.js installed: $(node --version)"
  600. }
  601. build_frontend() {
  602. cd "$INSTALL_PATH/frontend"
  603. run_with_progress "Installing frontend dependencies" npm ci
  604. run_with_progress "Building frontend" npm run build
  605. }
  606. create_bambuddy_env() {
  607. info "Creating Bambuddy configuration..."
  608. local env_file="$INSTALL_PATH/.env"
  609. cat > "$env_file" << EOF
  610. # Bambuddy Configuration
  611. # Generated by install.sh on $(date)
  612. DEBUG=false
  613. LOG_LEVEL=INFO
  614. LOG_TO_FILE=true
  615. EOF
  616. chown "$BAMBUDDY_SERVICE_USER:$BAMBUDDY_SERVICE_USER" "$env_file"
  617. chmod 600 "$env_file"
  618. success "Configuration saved to $env_file"
  619. }
  620. create_bambuddy_directories() {
  621. mkdir -p "$INSTALL_PATH/data" "$INSTALL_PATH/logs"
  622. chown -R "$BAMBUDDY_SERVICE_USER:$BAMBUDDY_SERVICE_USER" "$INSTALL_PATH/data" "$INSTALL_PATH/logs"
  623. success "Data directories created"
  624. }
  625. create_bambuddy_service() {
  626. info "Creating Bambuddy systemd service..."
  627. cat > /etc/systemd/system/bambuddy.service << EOF
  628. [Unit]
  629. Description=Bambuddy - Bambu Lab Print Management
  630. Documentation=https://github.com/maziggy/bambuddy
  631. After=network.target
  632. [Service]
  633. Type=simple
  634. User=$BAMBUDDY_SERVICE_USER
  635. Group=$BAMBUDDY_SERVICE_USER
  636. WorkingDirectory=$INSTALL_PATH
  637. EnvironmentFile=$INSTALL_PATH/.env
  638. Environment="DATA_DIR=$INSTALL_PATH/data"
  639. Environment="LOG_DIR=$INSTALL_PATH/logs"
  640. ExecStart=$INSTALL_PATH/venv/bin/uvicorn backend.app.main:app --host 0.0.0.0 --port $BAMBUDDY_PORT
  641. Restart=on-failure
  642. RestartSec=5
  643. StandardOutput=journal
  644. StandardError=journal
  645. NoNewPrivileges=true
  646. PrivateTmp=true
  647. ProtectSystem=strict
  648. ProtectHome=true
  649. ReadWritePaths=$INSTALL_PATH/data $INSTALL_PATH/logs $INSTALL_PATH
  650. [Install]
  651. WantedBy=multi-user.target
  652. EOF
  653. systemctl daemon-reload
  654. systemctl enable bambuddy.service
  655. success "Bambuddy service created and enabled"
  656. }
  657. # ─────────────────────────────────────────────────────────────────────────────
  658. # System Strip-Down (dedicated appliance — remove unnecessary services/packages)
  659. # ─────────────────────────────────────────────────────────────────────────────
  660. strip_services() {
  661. info "Disabling unnecessary services..."
  662. local services=(
  663. bluetooth.service
  664. lightdm.service
  665. cloud-init-local.service
  666. cloud-init.service
  667. cloud-init-network.service
  668. cloud-config.service
  669. cloud-final.service
  670. cloud-init-hotplugd.socket
  671. avahi-daemon.service
  672. avahi-daemon.socket
  673. ModemManager.service
  674. udisks2.service
  675. apparmor.service
  676. man-db.timer
  677. e2scrub_all.timer
  678. e2scrub_reap.service
  679. # Audio stack (no speakers on a spool reader)
  680. pipewire.service
  681. pipewire.socket
  682. pipewire-pulse.service
  683. pipewire-pulse.socket
  684. wireplumber.service
  685. # Printing
  686. cups.service
  687. cups.socket
  688. cups-browsed.service
  689. # Desktop services
  690. accounts-daemon.service
  691. upower.service
  692. polkit.service
  693. # Flatpak portals (not using Flatpak)
  694. xdg-desktop-portal.service
  695. xdg-desktop-portal-gtk.service
  696. xdg-document-portal.service
  697. xdg-permission-store.service
  698. # NFS/RPC (unnecessary + security surface)
  699. rpcbind.service
  700. rpcbind.socket
  701. # Bluetooth media proxy
  702. mpris-proxy.service
  703. )
  704. local disabled=0
  705. for svc in "${services[@]}"; do
  706. if systemctl is-enabled "$svc" &>/dev/null; then
  707. systemctl disable "$svc" 2>/dev/null || true
  708. systemctl mask "$svc" 2>/dev/null || true
  709. (( ++disabled ))
  710. fi
  711. done
  712. if (( disabled > 0 )); then
  713. success "Disabled $disabled unnecessary services"
  714. else
  715. success "No unnecessary services to disable"
  716. fi
  717. # Mask user-level services globally via /etc/systemd/user/ overrides.
  718. # The su-based approach doesn't reliably reach the user's systemd instance
  719. # when run from sudo, so we create global masks that apply before login.
  720. local user_services=(
  721. pipewire.service
  722. pipewire.socket
  723. pipewire-pulse.service
  724. pipewire-pulse.socket
  725. wireplumber.service
  726. xdg-desktop-portal.service
  727. xdg-desktop-portal-gtk.service
  728. xdg-document-portal.service
  729. xdg-permission-store.service
  730. mpris-proxy.service
  731. )
  732. mkdir -p /etc/systemd/user
  733. local user_masked=0
  734. for svc in "${user_services[@]}"; do
  735. if [[ ! -L "/etc/systemd/user/$svc" ]] || [[ "$(readlink /etc/systemd/user/$svc)" != "/dev/null" ]]; then
  736. ln -sf /dev/null "/etc/systemd/user/$svc"
  737. (( ++user_masked ))
  738. fi
  739. done
  740. if (( user_masked > 0 )); then
  741. success "Masked $user_masked unnecessary user services globally"
  742. fi
  743. }
  744. strip_packages() {
  745. info "Removing unnecessary packages..."
  746. local packages=(
  747. mkvtoolnix
  748. firmware-atheros
  749. firmware-mediatek
  750. cloud-init
  751. rpi-cloud-init-mods
  752. rpi-connect-lite
  753. avahi-daemon
  754. modemmanager
  755. udisks2
  756. pipewire
  757. pipewire-pulse
  758. wireplumber
  759. cups
  760. cups-browsed
  761. cups-common
  762. cups-client
  763. rpcbind
  764. )
  765. local to_remove=()
  766. for pkg in "${packages[@]}"; do
  767. if dpkg -l "$pkg" &>/dev/null 2>&1; then
  768. to_remove+=("$pkg")
  769. fi
  770. done
  771. if (( ${#to_remove[@]} > 0 )); then
  772. run_with_progress "Removing ${#to_remove[@]} packages" apt-get remove --purge -y "${to_remove[@]}"
  773. run_with_progress "Cleaning up dependencies" apt-get autoremove --purge -y
  774. else
  775. success "No unnecessary packages to remove"
  776. fi
  777. }
  778. # ─────────────────────────────────────────────────────────────────────────────
  779. # Kiosk Setup (labwc + Chromium + Plymouth splash)
  780. # ─────────────────────────────────────────────────────────────────────────────
  781. setup_kiosk() {
  782. info "Setting up touchscreen kiosk..."
  783. # Detect kiosk user (the human user who ran sudo)
  784. KIOSK_USER="${SUDO_USER:-$(logname 2>/dev/null || echo pi)}"
  785. KIOSK_URL="${BAMBUDDY_URL}/spoolbuddy?token=${API_KEY}"
  786. local KIOSK_HOME
  787. KIOSK_HOME=$(eval echo "~$KIOSK_USER")
  788. info "Kiosk user: $KIOSK_USER (home: $KIOSK_HOME)"
  789. info "Kiosk URL: $KIOSK_URL"
  790. # Allow kiosk user to read SpoolBuddy env so launcher can resolve backend URL
  791. # and API key dynamically instead of using stale install-time fallback values.
  792. local spoolbuddy_env="$INSTALL_PATH/spoolbuddy/.env"
  793. if [[ -f "$spoolbuddy_env" ]]; then
  794. usermod -aG "$SPOOLBUDDY_SERVICE_USER" "$KIOSK_USER" 2>/dev/null || true
  795. chgrp "$SPOOLBUDDY_SERVICE_USER" "$spoolbuddy_env" 2>/dev/null || true
  796. chmod 640 "$spoolbuddy_env" 2>/dev/null || true
  797. fi
  798. # ── Install kiosk packages ────────────────────────────────────────────
  799. # Temporarily block initramfs rebuilds during package install — we rebuild
  800. # once at the end after the Plymouth theme is configured, saving ~4 runs
  801. # (one per installed kernel per hook trigger).
  802. if [[ -x /usr/sbin/update-initramfs ]]; then
  803. dpkg-divert --local --rename --add /usr/sbin/update-initramfs >/dev/null 2>&1 || true
  804. ln -sf /bin/true /usr/sbin/update-initramfs
  805. fi
  806. run_with_progress "Installing kiosk packages" apt-get install -y labwc chromium plymouth wlr-randr
  807. # Restore real update-initramfs
  808. if dpkg-divert --list /usr/sbin/update-initramfs 2>/dev/null | grep -q local; then
  809. rm -f /usr/sbin/update-initramfs
  810. dpkg-divert --local --rename --remove /usr/sbin/update-initramfs >/dev/null 2>&1 || true
  811. fi
  812. # ── config.txt tweaks ─────────────────────────────────────────────────
  813. local boot_config="/boot/firmware/config.txt"
  814. if [[ ! -f "$boot_config" ]]; then
  815. boot_config="/boot/config.txt"
  816. fi
  817. if [[ -f "$boot_config" ]]; then
  818. info "Configuring $boot_config for kiosk..."
  819. # Disable audio (change existing on→off)
  820. sed -i 's/^dtparam=audio=on/dtparam=audio=off/' "$boot_config"
  821. # Disable camera auto-detect (change existing 1→0)
  822. sed -i 's/^camera_auto_detect=1/camera_auto_detect=0/' "$boot_config"
  823. # Append if missing: gpu_mem=32
  824. if ! grep -q "^gpu_mem=" "$boot_config"; then
  825. echo "" >> "$boot_config"
  826. echo "# Kiosk: Minimal GPU firmware memory (KMS uses CMA from system RAM)" >> "$boot_config"
  827. echo "gpu_mem=32" >> "$boot_config"
  828. fi
  829. # Append if missing: dtoverlay=disable-bt
  830. if ! grep -q "^dtoverlay=disable-bt" "$boot_config"; then
  831. echo "" >> "$boot_config"
  832. echo "# Kiosk: Disable Bluetooth hardware" >> "$boot_config"
  833. echo "dtoverlay=disable-bt" >> "$boot_config"
  834. fi
  835. # Append if missing: disable_splash=1
  836. if ! grep -q "^disable_splash=" "$boot_config"; then
  837. echo "" >> "$boot_config"
  838. echo "# Kiosk: Disable Raspberry Pi firmware splash, use custom splash.png" >> "$boot_config"
  839. echo "disable_splash=1" >> "$boot_config"
  840. fi
  841. success "Boot config updated"
  842. fi
  843. # ── cmdline.txt tweaks ────────────────────────────────────────────────
  844. local cmdline="/boot/firmware/cmdline.txt"
  845. if [[ ! -f "$cmdline" ]]; then
  846. cmdline="/boot/cmdline.txt"
  847. fi
  848. if [[ -f "$cmdline" ]]; then
  849. info "Configuring $cmdline for kiosk..."
  850. # Remove serial console (Plymouth needs tty-only console)
  851. sed -i 's/console=serial0,[0-9]* //' "$cmdline"
  852. # Disable console blanking (kernel default is 600s, can blank during boot transition)
  853. grep -q "consoleblank=" "$cmdline" || sed -i 's/$/ consoleblank=0/' "$cmdline"
  854. # Add splash quiet loglevel=3 logo.nologo if missing
  855. grep -q "splash" "$cmdline" || sed -i 's/$/ splash quiet loglevel=3 logo.nologo/' "$cmdline"
  856. # Add video mode if missing
  857. grep -q "video=HDMI-A-1" "$cmdline" || sed -i 's/$/ video=HDMI-A-1:1024x600@60/' "$cmdline"
  858. success "Kernel cmdline updated"
  859. fi
  860. # ── Plymouth splash theme ─────────────────────────────────────────────
  861. info "Installing Plymouth boot splash..."
  862. local theme_dir="/usr/share/plymouth/themes/spoolbuddy"
  863. mkdir -p "$theme_dir"
  864. # Copy bundled splash image from the install directory
  865. local script_dir
  866. script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
  867. if [[ -f "$script_dir/splash.png" ]]; then
  868. cp "$script_dir/splash.png" "$theme_dir/splash.png"
  869. elif [[ -f "$INSTALL_PATH/spoolbuddy/install/splash.png" ]]; then
  870. cp "$INSTALL_PATH/spoolbuddy/install/splash.png" "$theme_dir/splash.png"
  871. else
  872. warn "splash.png not found — Plymouth splash will not display an image"
  873. fi
  874. # Write .plymouth theme file
  875. cat > "$theme_dir/spoolbuddy.plymouth" << 'EOF'
  876. [Plymouth Theme]
  877. Name=SpoolBuddy
  878. Description=SpoolBuddy boot splash
  879. ModuleName=script
  880. [script]
  881. ImageDir=/usr/share/plymouth/themes/spoolbuddy
  882. ScriptFile=/usr/share/plymouth/themes/spoolbuddy/spoolbuddy.script
  883. EOF
  884. # Write .script theme file
  885. cat > "$theme_dir/spoolbuddy.script" << 'EOF'
  886. wallpaper_image = Image("splash.png");
  887. screen_width = Window.GetWidth();
  888. screen_height = Window.GetHeight();
  889. resized_wallpaper_image = wallpaper_image.Scale(screen_width, screen_height);
  890. wallpaper_sprite = Sprite(resized_wallpaper_image);
  891. wallpaper_sprite.SetZ(-100);
  892. EOF
  893. plymouth-set-default-theme spoolbuddy
  894. run_with_progress "Updating initramfs" update-initramfs -u
  895. success "Plymouth splash installed"
  896. # ── Auto-login on tty1 ────────────────────────────────────────────────
  897. info "Configuring auto-login for $KIOSK_USER..."
  898. mkdir -p /etc/systemd/system/getty@tty1.service.d
  899. cat > /etc/systemd/system/getty@tty1.service.d/autologin.conf << EOF
  900. [Unit]
  901. After=network-online.target
  902. Wants=network-online.target
  903. [Service]
  904. ExecStart=
  905. ExecStart=-/sbin/agetty --autologin $KIOSK_USER --noclear %I \$TERM
  906. EOF
  907. success "Auto-login configured"
  908. # ── labwc rc.xml (no decorations, no keybinds) ────────────────────────
  909. info "Configuring labwc window manager..."
  910. local labwc_dir="$KIOSK_HOME/.config/labwc"
  911. mkdir -p "$labwc_dir"
  912. cat > "$labwc_dir/rc.xml" << 'EOF'
  913. <?xml version="1.0"?>
  914. <labwc_config>
  915. <!-- Disable screen blanking — kiosk must stay on -->
  916. <core>
  917. <screenBlankTimeout>0</screenBlankTimeout>
  918. </core>
  919. <theme>
  920. <name></name>
  921. <cornerRadius>0</cornerRadius>
  922. </theme>
  923. <!-- Disable all keybindings - kiosk lockdown -->
  924. <keyboard>
  925. </keyboard>
  926. <!-- Disable right-click menu -->
  927. <mouse>
  928. <default />
  929. </mouse>
  930. <!-- Remove window decorations, maximize Chromium, prevent unfullscreen -->
  931. <windowRules>
  932. <windowRule identifier="*">
  933. <serverDecoration>no</serverDecoration>
  934. </windowRule>
  935. <windowRule identifier="chromium">
  936. <skipTaskbar>yes</skipTaskbar>
  937. <fixedPosition>yes</fixedPosition>
  938. </windowRule>
  939. </windowRules>
  940. </labwc_config>
  941. EOF
  942. # ── Override Debian/RPi Chromium defaults for kiosk performance ──────
  943. cat > /etc/chromium.d/spoolbuddy-kiosk << 'CHROMIUM_EOF'
  944. # SpoolBuddy kiosk: add kiosk-specific flags on top of Pi defaults.
  945. # Preserves Pi GPU settings (gpu-rasterization, ANGLE/GLES) for stability.
  946. CHROMIUM_FLAGS="$CHROMIUM_FLAGS --disable-smooth-scrolling"
  947. CHROMIUM_FLAGS="$CHROMIUM_FLAGS --disable-extensions"
  948. CHROMIUM_FLAGS="$CHROMIUM_FLAGS --disable-background-timer-throttling"
  949. CHROMIUM_FLAGS="$CHROMIUM_FLAGS --disable-renderer-backgrounding"
  950. CHROMIUM_FLAGS="$CHROMIUM_FLAGS --disable-crash-reporter"
  951. CHROMIUM_EOF
  952. success "Chromium kiosk performance flags installed"
  953. # ── kiosk launcher (dynamic URL from spoolbuddy/.env) ─────────────────
  954. local kiosk_launcher="/usr/local/bin/spoolbuddy-kiosk-launch"
  955. cat > "$kiosk_launcher" << EOF
  956. #!/usr/bin/env bash
  957. set -euo pipefail
  958. ENV_FILE="$INSTALL_PATH/spoolbuddy/.env"
  959. FALLBACK_URL="$KIOSK_URL"
  960. backend_url=""
  961. api_key=""
  962. if [[ -r "\$ENV_FILE" ]]; then
  963. backend_url="\$(sed -n 's/^SPOOLBUDDY_BACKEND_URL=//p' "\$ENV_FILE" | tail -n1 | tr -d '\r')"
  964. api_key="\$(sed -n 's/^SPOOLBUDDY_API_KEY=//p' "\$ENV_FILE" | tail -n1 | tr -d '\r')"
  965. backend_url="\${backend_url%\"}"
  966. backend_url="\${backend_url#\"}"
  967. api_key="\${api_key%\"}"
  968. api_key="\${api_key#\"}"
  969. elif [[ -f "\$ENV_FILE" ]]; then
  970. echo "spoolbuddy-kiosk-launch: ERROR: \$ENV_FILE exists but is not readable" >&2
  971. echo "spoolbuddy-kiosk-launch: Fix permissions (group-readable by kiosk user) and restart kiosk" >&2
  972. exit 1
  973. fi
  974. if [[ -n "\$backend_url" && -n "\$api_key" ]]; then
  975. backend_url="\${backend_url%/}"
  976. kiosk_url="\${backend_url}/spoolbuddy?token=\${api_key}"
  977. else
  978. kiosk_url="\$FALLBACK_URL"
  979. fi
  980. exec chromium --kiosk --no-first-run --disable-infobars \
  981. --disable-session-crashed-bubble --disable-features=TranslateUI \
  982. --noerrdialogs --disable-component-update \
  983. --overscroll-history-navigation=0 \
  984. --ozone-platform=wayland \
  985. --disable-crash-reporter --disable-breakpad \
  986. "\$kiosk_url"
  987. EOF
  988. chmod 755 "$kiosk_launcher"
  989. # Tiny self-check: ensure sed command substitutions were not expanded
  990. # while generating the launcher script.
  991. if ! grep -Fq 'backend_url="$(sed -n' "$kiosk_launcher" || ! grep -Fq 'api_key="$(sed -n' "$kiosk_launcher"; then
  992. error "Kiosk launcher generation failed: dynamic env parsing commands were expanded unexpectedly"
  993. fi
  994. # ── labwc autostart ───────────────────────────────────────────────────
  995. cat > "$labwc_dir/autostart" << EOF
  996. # Force 1024x600 (panel doesn't advertise this natively)
  997. wlr-randr --output HDMI-A-1 --custom-mode 1024x600@60 &
  998. # Prevent display blanking (labwc <0.8 lacks screenBlankTimeout config support)
  999. (while true; do wlr-randr --output HDMI-A-1 --on 2>/dev/null; sleep 60; done) &
  1000. # Launch Chromium via helper that resolves URL from spoolbuddy/.env
  1001. $kiosk_launcher &
  1002. EOF
  1003. chown -R "$KIOSK_USER:$KIOSK_USER" "$labwc_dir"
  1004. # ── .bash_profile (source .bashrc, exec labwc on tty1) ────────────────
  1005. cat > "$KIOSK_HOME/.bash_profile" << 'EOF'
  1006. # Source .bashrc if it exists
  1007. if [ -f ~/.bashrc ]; then
  1008. . ~/.bashrc
  1009. fi
  1010. # Auto-start kiosk on tty1
  1011. if [ "$(tty)" = "/dev/tty1" ]; then
  1012. exec labwc
  1013. fi
  1014. EOF
  1015. chown "$KIOSK_USER:$KIOSK_USER" "$KIOSK_HOME/.bash_profile"
  1016. REBOOT_NEEDED="true"
  1017. success "Kiosk setup complete"
  1018. }
  1019. # ─────────────────────────────────────────────────────────────────────────────
  1020. # User Prompts
  1021. # ─────────────────────────────────────────────────────────────────────────────
  1022. parse_args() {
  1023. while [[ $# -gt 0 ]]; do
  1024. case "$1" in
  1025. --mode)
  1026. INSTALL_MODE="$2"
  1027. shift 2
  1028. ;;
  1029. --repo)
  1030. INSTALL_REPO="$(normalize_github_repo_url "$2")"
  1031. shift 2
  1032. ;;
  1033. --ref)
  1034. INSTALL_REF="$2"
  1035. shift 2
  1036. ;;
  1037. --bambuddy-url)
  1038. BAMBUDDY_URL="$2"
  1039. shift 2
  1040. ;;
  1041. --api-key)
  1042. API_KEY="$2"
  1043. shift 2
  1044. ;;
  1045. --path)
  1046. INSTALL_PATH="$2"
  1047. shift 2
  1048. ;;
  1049. --port)
  1050. BAMBUDDY_PORT="$2"
  1051. shift 2
  1052. ;;
  1053. --ssh-pubkey)
  1054. SSH_PUBKEY="$2"
  1055. shift 2
  1056. ;;
  1057. --yes|-y)
  1058. NON_INTERACTIVE="true"
  1059. shift
  1060. ;;
  1061. --help|-h)
  1062. show_help
  1063. ;;
  1064. *)
  1065. error "Unknown option: $1 (use --help for usage)"
  1066. ;;
  1067. esac
  1068. done
  1069. }
  1070. ask_install_mode() {
  1071. if [[ -n "$INSTALL_MODE" ]]; then
  1072. return
  1073. fi
  1074. echo ""
  1075. echo -e "${BOLD}How would you like to set up SpoolBuddy?${NC}"
  1076. echo ""
  1077. echo -e " ${CYAN}1)${NC} SpoolBuddy only"
  1078. echo " NFC reader + scale on this RPi, Bambuddy runs on another device"
  1079. echo ""
  1080. echo -e " ${CYAN}2)${NC} SpoolBuddy + Bambuddy"
  1081. echo " Both running natively on this Raspberry Pi"
  1082. echo ""
  1083. while true; do
  1084. echo -en "${BOLD}Choose${NC} [${CYAN}1${NC}/${CYAN}2${NC}]: "
  1085. read -r choice
  1086. case "$choice" in
  1087. 1) INSTALL_MODE="spoolbuddy"; return;;
  1088. 2) INSTALL_MODE="full"; return;;
  1089. *) echo "Please enter 1 or 2.";;
  1090. esac
  1091. done
  1092. }
  1093. gather_config() {
  1094. echo ""
  1095. echo -e "${BOLD}Configuration${NC}"
  1096. echo -e "${CYAN}─────────────────────────────────────────${NC}"
  1097. echo ""
  1098. # Set default install path based on mode
  1099. if [[ -z "$INSTALL_PATH" ]]; then
  1100. if [[ "$INSTALL_MODE" == "full" ]]; then
  1101. INSTALL_PATH="/opt/bambuddy"
  1102. else
  1103. INSTALL_PATH="/opt/bambuddy"
  1104. fi
  1105. fi
  1106. prompt "Installation directory" "$INSTALL_PATH" INSTALL_PATH
  1107. if [[ -z "$INSTALL_REPO" ]]; then
  1108. INSTALL_REPO="$GITHUB_REPO"
  1109. fi
  1110. prompt "Git repository URL" "$INSTALL_REPO" INSTALL_REPO
  1111. INSTALL_REPO="$(normalize_github_repo_url "$INSTALL_REPO")"
  1112. if [[ -z "$INSTALL_REF" ]]; then
  1113. INSTALL_REF="main"
  1114. fi
  1115. if [[ "$NON_INTERACTIVE" != "true" && -n "$DETECTED_INSTALLER_REF" && "$DETECTED_INSTALLER_REF" != "HEAD" ]]; then
  1116. echo ""
  1117. echo -e "${BOLD}Install Source Ref${NC}"
  1118. echo "1) main"
  1119. echo "2) $DETECTED_INSTALLER_REF (detected from installer context)"
  1120. echo "3) custom"
  1121. while true; do
  1122. echo -en "${BOLD}Choose${NC} [1/2/3]: "
  1123. read -r ref_choice
  1124. case "$ref_choice" in
  1125. ""|1)
  1126. INSTALL_REF="main"
  1127. break
  1128. ;;
  1129. 2)
  1130. INSTALL_REF="$DETECTED_INSTALLER_REF"
  1131. break
  1132. ;;
  1133. 3)
  1134. prompt "Git ref (branch/tag/commit)" "$INSTALL_REF" INSTALL_REF
  1135. break
  1136. ;;
  1137. *)
  1138. echo "Please enter 1, 2, or 3."
  1139. ;;
  1140. esac
  1141. done
  1142. else
  1143. prompt "Git ref (branch/tag/commit)" "$INSTALL_REF" INSTALL_REF
  1144. fi
  1145. if [[ "$INSTALL_MODE" == "spoolbuddy" ]]; then
  1146. # Need remote Bambuddy URL and API key
  1147. echo ""
  1148. info "SpoolBuddy needs to connect to your Bambuddy server."
  1149. info "You can find/create an API key in Bambuddy under Settings -> API Keys."
  1150. echo ""
  1151. while [[ -z "$BAMBUDDY_URL" ]]; do
  1152. prompt "Bambuddy server URL (e.g. http://192.168.1.100:8000)" "" BAMBUDDY_URL
  1153. if [[ -z "$BAMBUDDY_URL" ]]; then
  1154. warn "Bambuddy URL is required"
  1155. fi
  1156. done
  1157. while [[ -z "$API_KEY" ]]; do
  1158. prompt "Bambuddy API key" "" API_KEY
  1159. if [[ -z "$API_KEY" ]]; then
  1160. warn "API key is required"
  1161. fi
  1162. done
  1163. else
  1164. # Full mode — Bambuddy runs locally
  1165. prompt "Bambuddy port" "$BAMBUDDY_PORT" BAMBUDDY_PORT
  1166. BAMBUDDY_URL="http://localhost:$BAMBUDDY_PORT"
  1167. echo ""
  1168. info "After installation, create an API key in Bambuddy (Settings -> API Keys)"
  1169. info "and update it in: $INSTALL_PATH/spoolbuddy/.env"
  1170. API_KEY="CHANGE_ME_AFTER_SETUP"
  1171. fi
  1172. # Summary
  1173. echo ""
  1174. echo -e "${BOLD}Installation Summary${NC}"
  1175. echo -e "${CYAN}─────────────────────────────────────────${NC}"
  1176. echo -e " Mode: ${GREEN}$([ "$INSTALL_MODE" == "full" ] && echo "Bambuddy + SpoolBuddy" || echo "SpoolBuddy only")${NC}"
  1177. echo -e " Install path: ${GREEN}$INSTALL_PATH${NC}"
  1178. echo -e " Git repo: ${GREEN}$INSTALL_REPO${NC}"
  1179. echo -e " Git ref: ${GREEN}$INSTALL_REF${NC}"
  1180. if [[ "$INSTALL_MODE" == "full" ]]; then
  1181. echo -e " Bambuddy port: ${GREEN}$BAMBUDDY_PORT${NC}"
  1182. echo -e " Bambuddy URL: ${GREEN}$BAMBUDDY_URL${NC}"
  1183. else
  1184. echo -e " Bambuddy URL: ${GREEN}$BAMBUDDY_URL${NC}"
  1185. fi
  1186. echo ""
  1187. if ! prompt_yes_no "Proceed with installation?" "y"; then
  1188. echo "Installation cancelled."
  1189. exit 0
  1190. fi
  1191. }
  1192. # ─────────────────────────────────────────────────────────────────────────────
  1193. # Main
  1194. # ─────────────────────────────────────────────────────────────────────────────
  1195. main() {
  1196. parse_args "$@"
  1197. detect_installer_source_context
  1198. echo ""
  1199. echo -e "${CYAN}╔══════════════════════════════════════════════════════════╗${NC}"
  1200. echo -e "${CYAN}║ ║${NC}"
  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}║ NFC Spool Management for Bambuddy ║${NC}"
  1209. echo -e "${CYAN}║ ║${NC}"
  1210. echo -e "${CYAN}╚══════════════════════════════════════════════════════════╝${NC}"
  1211. echo ""
  1212. # Check if running via pipe without -y
  1213. if [[ ! -t 0 ]] && [[ "$NON_INTERACTIVE" != "true" ]]; then
  1214. error "Interactive mode requires a terminal. Use -y for unattended install, or download and run directly."
  1215. fi
  1216. # Pre-flight checks
  1217. check_root
  1218. check_raspberry_pi
  1219. check_raspberry_pi_os
  1220. if ! detect_python; then
  1221. info "Python 3.10+ not found, will install..."
  1222. fi
  1223. # Gather user preferences
  1224. ask_install_mode
  1225. gather_config
  1226. # Validate mode
  1227. if [[ "$INSTALL_MODE" != "spoolbuddy" && "$INSTALL_MODE" != "full" ]]; then
  1228. error "Invalid mode: $INSTALL_MODE (must be 'spoolbuddy' or 'full')"
  1229. fi
  1230. echo ""
  1231. echo -e "${BOLD}Starting Installation${NC}"
  1232. echo -e "${CYAN}─────────────────────────────────────────${NC}"
  1233. echo ""
  1234. # ── Step 1: Raspberry Pi hardware config ──────────────────────────────
  1235. info "Configuring Raspberry Pi hardware..."
  1236. enable_spi
  1237. enable_i2c
  1238. configure_boot_config
  1239. echo ""
  1240. # ── Step 2: System packages ───────────────────────────────────────────
  1241. install_system_packages
  1242. install_wifi_safeguard
  1243. upgrade_system_packages
  1244. detect_python || error "Failed to install Python 3.10+"
  1245. echo ""
  1246. # ── Step 2b: Strip unnecessary services & packages ────────────────────
  1247. strip_services
  1248. strip_packages
  1249. echo ""
  1250. # ── Step 3: Download source code ──────────────────────────────────────
  1251. create_spoolbuddy_user
  1252. download_spoolbuddy
  1253. echo ""
  1254. # ── Step 3b: Kiosk setup (labwc + Chromium + squeekboard + Plymouth) ──
  1255. setup_kiosk
  1256. echo ""
  1257. # ── Step 4: SpoolBuddy setup ──────────────────────────────────────────
  1258. info "Setting up SpoolBuddy..."
  1259. setup_spoolbuddy_venv
  1260. create_spoolbuddy_env
  1261. # Kiosk env access: only needed if actual kiosk hardware is available
  1262. if [[ -f /boot/firmware/config.txt ]] || [[ -f /boot/config.txt ]]; then
  1263. ensure_kiosk_env_access
  1264. fi
  1265. setup_ssh_key
  1266. create_spoolbuddy_service
  1267. echo ""
  1268. # ── Step 5: Bambuddy setup (full mode only) ───────────────────────────
  1269. if [[ "$INSTALL_MODE" == "full" ]]; then
  1270. info "Setting up Bambuddy..."
  1271. create_bambuddy_user
  1272. setup_bambuddy_venv
  1273. install_nodejs
  1274. build_frontend
  1275. create_bambuddy_directories
  1276. create_bambuddy_env
  1277. create_bambuddy_service
  1278. echo ""
  1279. fi
  1280. # ── Done ──────────────────────────────────────────────────────────────
  1281. echo ""
  1282. echo -e "${GREEN}╔══════════════════════════════════════════════════════════╗${NC}"
  1283. echo -e "${GREEN}║ ║${NC}"
  1284. echo -e "${GREEN}║ Installation Complete! ║${NC}"
  1285. echo -e "${GREEN}║ ║${NC}"
  1286. echo -e "${GREEN}╚══════════════════════════════════════════════════════════╝${NC}"
  1287. echo ""
  1288. local ip_addr
  1289. ip_addr=$(hostname -I 2>/dev/null | awk '{print $1}') || ip_addr="<your-ip>"
  1290. if [[ "$INSTALL_MODE" == "full" ]]; then
  1291. echo -e " ${BOLD}Bambuddy:${NC} ${CYAN}http://$ip_addr:$BAMBUDDY_PORT${NC}"
  1292. else
  1293. echo -e " ${BOLD}SpoolBuddy:${NC} Connecting to ${CYAN}$BAMBUDDY_URL${NC}"
  1294. fi
  1295. echo -e " ${BOLD}Kiosk URL:${NC} ${CYAN}$KIOSK_URL${NC}"
  1296. echo -e " ${BOLD}Kiosk user:${NC} ${CYAN}$KIOSK_USER${NC}"
  1297. echo ""
  1298. if [[ "$INSTALL_MODE" == "full" ]]; then
  1299. echo -e " ${BOLD}Next steps:${NC}"
  1300. echo -e " 1. Reboot (required for kiosk, Plymouth splash, and hardware changes)"
  1301. echo -e " 2. The touchscreen kiosk will start automatically after reboot"
  1302. echo -e " 3. On another device, open ${CYAN}http://$ip_addr:$BAMBUDDY_PORT${NC}"
  1303. echo -e " 4. Go to Settings -> API Keys and create an API key"
  1304. echo -e " 5. Update the API key in: ${CYAN}$INSTALL_PATH/spoolbuddy/.env${NC}"
  1305. echo -e " 6. Restart SpoolBuddy: ${CYAN}sudo systemctl restart spoolbuddy${NC}"
  1306. fi
  1307. echo ""
  1308. echo -e " ${BOLD}Manage services:${NC}"
  1309. echo -e " SpoolBuddy status: ${CYAN}sudo systemctl status spoolbuddy${NC}"
  1310. echo -e " SpoolBuddy logs: ${CYAN}sudo journalctl -u spoolbuddy -f${NC}"
  1311. if [[ "$INSTALL_MODE" == "full" ]]; then
  1312. echo -e " Bambuddy status: ${CYAN}sudo systemctl status bambuddy${NC}"
  1313. echo -e " Bambuddy logs: ${CYAN}sudo journalctl -u bambuddy -f${NC}"
  1314. fi
  1315. echo ""
  1316. echo -e " ${BOLD}Configuration:${NC} ${CYAN}$INSTALL_PATH/spoolbuddy/.env${NC}"
  1317. echo -e " ${BOLD}Hardware wiring:${NC} ${CYAN}$INSTALL_PATH/spoolbuddy/README.md${NC}"
  1318. echo -e " ${BOLD}Diagnostics:${NC} ${CYAN}sudo $INSTALL_PATH/spoolbuddy/venv/bin/python $INSTALL_PATH/spoolbuddy/pn5180_diag.py${NC}"
  1319. echo ""
  1320. echo -e " ${YELLOW}A reboot is required to apply all changes (kiosk, Plymouth splash, hardware).${NC}"
  1321. echo ""
  1322. if prompt_yes_no "Reboot now?" "y"; then
  1323. reboot
  1324. else
  1325. echo -e " Run ${CYAN}sudo reboot${NC} when ready."
  1326. fi
  1327. echo ""
  1328. }
  1329. main "$@"