@homebridge/homebridge-apt-pkg 1.5.0 → 1.5.2

package/README.md

@@ -1,228 +1,20 @@
-# Debian Package For Homebridge
+# @homebridge/homebridge-apt-pkg
 
-This project builds and publishes a debian-based package that can be installed using `apt` on Ubuntu / Debian / Raspberry Pi OS based Linux systems.
+This is a **stub package** used to track versions of the Homebridge APT package via npm and Dependabot.
 
-The project aims to deploy Homebridge and the Homebridge UI in a secure and stable way, with no dependencies outside those available in the standard distribution repos. It comes bundled with it's own Node.js runtime and runs Homebridge in an isolated environment as a service user with no sudo / admin priviledges.
+> **Note:** This package does **not** contain any actual code or binaries.
 
-Supported architectures:
+## 🔗 Related Projects
 
-* x86_64
-* armhf ( armv7)
-* aarch64 (arm64)
+- 🧩 APT Releases: https://github.com/homebridge/homebridge-apt-pkg/releases
+- 🐳 Docker Image: https://github.com/homebridge/docker-homebridge
+- 🏠 Homebridge Project: https://homebridge.io
 
-## Using APT
+## 🛠 Purpose
 
-Add package source:
+This package exists solely to:
+- Allow `dependabot` to track version updates via GitHub Releases.
+- Help downstream projects automate version syncing (e.g., Docker builds).
 
-```bash
-# make sure the tools needed to add the repo exist
-sudo apt-get update
-sudo apt-get install -y curl gpg
+---
 
-# add the homebridge gpg key
-curl -sSfL https://repo.homebridge.io/KEY.gpg | sudo gpg --dearmor | sudo tee /usr/share/keyrings/homebridge.gpg  > /dev/null
-
-# add the homebridge repo
-echo "deb [signed-by=/usr/share/keyrings/homebridge.gpg] https://repo.homebridge.io stable main" | sudo tee /etc/apt/sources.list.d/homebridge.list > /dev/null
-```
-
-Update and install:
-
-```bash
-sudo apt-get update
-sudo apt-get install homebridge
-```
-
-Remove:
-
-```
-sudo apt-get remove homebridge
-```
-
-Purge (this will delete `/var/lib/homebridge`):
-
-```
-sudo apt-get purge homebridge
-```
-
-## Manual Install
-
-Download the correct file for your system from https://github.com/homebridge/homebridge-apt-pkg/releases/latest
-
-```
-dpkg -i homebridge_x.x.x_xxxx.deb
-```
-
-Remove:
-
-```
-dpkg --remove homebridge
-```
-
-Purge (this will delete `/var/lib/homebridge`):
-
-```
-dpkg --purge homebridge
-```
-
-## Updating / Downgrading
-
-### To install the latest version
-
-To update Homebridge, Homebridge UI and NodeJS when installed via this APT package, run:
-
-```bash
-sudo apt update
-sudo apt install homebridge
-```
-
-This will upgrade all related components managed by this package.
-
-⚠️ Your configuration files and plugins are stored in /var/lib/homebridge and will not be affected by updates.
-
-### Downgrading to a previous release
-
-Downgrading will return NodeJS, Homebridge and the Homebridge UI to the version bundled within the apt package. You can view the release manifest of older versions from this page on GitHub - https://github.com/homebridge/homebridge-apt-pkg/releases
-
-If you need to install an older version or previous release of Homebridge:
-
-```bash
-sudo apt update
-apt list -a homebridge  # Shows available versions
-sudo apt install homebridge=<version>
-```
-
-NOTE: apt versions do not start with a v, while the verion on GitHub starts with v
-## About
-
-This package contains a self-contained Node.js installation and environment for Homebridge to run in.
-
-The bundled Node.js runtime is isolated and not exposed on the default PATH.
-
-To assist in debugging, a shell command `hb-shell` is added to the default PATH to allow the user to enter the Homebridge Shell Environment. When in the Homebridge Shell, users will have access to `node` and `npm` as they would expect.
-
-```shell
-# Node.js and package scripts are stored in /opt/homebridge
-
-/opt/homebridge # This directory is managed by the homebridge apt package and the contents are overwritten during updates
-  |-- bin
-  |   |-- node
-  |   |-- npm 
-  |   |-- npx
-  |-- lib
-  |   |-- node_modules
-  |       |-- npm
-  |       |-- homebridge-config-ui-x
-  |-- bashrc
-  |-- bashrc-hb-shell
-  |-- CHANGELOG.md
-  |-- hb-shell
-  |-- LICENSE
-  |-- README.md
-  |-- source.sh
-  |-- start.sh
-
-# "hb-shell" command to allow user access to the Homebridge env from the cli
-/usr/local/bin # These links are managed by the homebridge apt package and the contents are overwritten during updates
-  |-- hb-service -> /opt/homebridge/hb-service-shim
-  |-- hb-shell -> /opt/homebridge/hb-shell
-
-# homebridge storage directory, plugins are stored in node_modules
-/var/lib/homebridge
-  |-- node_modules
-  |   |-- homebridge
-  |   |-- homebridge-dummy
-  |   |-- homebridge-hue
-  |-- accessories
-  |-- persist
-  |-- config.json
-```
-
-## Customising Homebridge
-
-### Environment Variables
-
-The Homebridge systemd service will automatically load any environment variables defined in `/etc/default/homebridge`.
-
-This file can be used to customize the behavior of Homebridge or its plugins at runtime.
-
-After making changes to the file, please use `Restart HB Service & UI` for your changes to be picked up.
-
-#### Example
-
-To disable the terminal feature in the Homebridge UI, add the following:
-
-```bash
-# /etc/default/homebridge
-HOMEBRIDGE_CONFIG_UI_TERMINAL=0
-```
-### Customising the Systemd Service File
-
-You should not edit the service file included with the package as any changes made here will be overwritten during updates.
-
-You should use a systemd override file to make any changes.
-
-To preview the current unit file run:
-
-```bash
-cat /lib/systemd/system/homebridge.service
-```
-
-Use systemctl to create an override file at `/etc/systemd/system/homebridge.service.d/override.conf`:
-
-```bash
-sudo systemctl edit homebridge
-```
-
-Add the config items you want to override. **You should only add the settings you want to change.**
-
-For example, to change the user the service runs as:
-
-```bash
-[Service]
-User=pi    # replace with the user you want to run the service as
-```
-
-Or to add additional startup flags to Homebridge:
-
-```bash
-[Service]
-ExecStart=
-ExecStart=/opt/homebridge/start.sh -T
-```
-
-Or to run as root, and allow the UI to shutdown/restart the host:
-
-```
-[Service]
-User=root
-ExecStart=
-ExecStart=/opt/homebridge/start.sh --allow-root
-Environment="UIX_CAN_SHUTDOWN_RESTART_HOST=1"
-```
-
-Save the file and restart Homebridge:
-
-```bash
-sudo systemctl restart homebridge
-```
-
-To revert any changes run:
-
-```bash
-sudo systemctl revert homebridge
-```
-
-## Packaging Notes
-
-Package scripts workflow (preinst, postinst, postrm etc.):
-
-https://wiki.debian.org/MaintainerScripts
-
-## License
-
-Copyright (C) 2024 homebridge
-
-This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the [GNU General Public License](./LICENSE) for more details.

package/README.npm.md

@@ -0,0 +1,20 @@
+# @homebridge/homebridge-apt-pkg
+
+This is a **stub package** used to track versions of the Homebridge APT package via npm and Dependabot.
+
+> **Note:** This package does **not** contain any actual code or binaries.
+
+## 🔗 Related Projects
+
+- 🧩 APT Releases: https://github.com/homebridge/homebridge-apt-pkg/releases
+- 🐳 Docker Image: https://github.com/homebridge/docker-homebridge
+- 🏠 Homebridge Project: https://homebridge.io
+
+## 🛠 Purpose
+
+This package exists solely to:
+- Allow `dependabot` to track version updates via GitHub Releases.
+- Help downstream projects automate version syncing (e.g., Docker builds).
+
+---
+

package/package.json

@@ -1,13 +1,18 @@
 {
   "name": "@homebridge/homebridge-apt-pkg",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "description": "Stub package for tracking Homebridge APT release versions via npm",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepublishOnly": "cp README.npm.md README.md",
+    "postpublish": "git restore README.md || true"
   },
+  "files": [
+    "README.md"
+  ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/homebridge/homebridge-apt-pkg"
+    "url": "git+https://github.com/homebridge/homebridge-apt-pkg.git"
   },
   "author": "Homebridge",
   "license": "ISC",
@@ -17,8 +22,8 @@
   "homepage": "https://github.com/homebridge/homebridge-apt-pkg#readme",
   "private": false,
   "dependencies": {
-    "homebridge": "^1.9.0",
-    "homebridge-config-ui-x": "^4.75.0",
+    "homebridge": "^1.10.0",
+    "homebridge-config-ui-x": "^4.76.0",
     "node": "^22.16.0"
   }
-}
+}

package/.npmignore

@@ -1,4 +0,0 @@
-# Just a stub package.json to prevent npm from publishing this directory
-*
-!package.json
-!.npmignore