updates2mqtt 1.3.5__tar.gz → 1.3.6__tar.gz

{updates2mqtt-1.3.5 → updates2mqtt-1.3.6}/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.21.0
+    rev: v3.21.1
     hooks:
       - id: pyupgrade
         args: [--py313-plus]
@@ -17,7 +17,7 @@ repos:
       - id: check-shebang-scripts-are-executable
         name: Check shell scripts are executable
   - repo: https://github.com/astral-sh/uv-pre-commit
-    rev: 0.9.7
+    rev: 0.9.9
     hooks:
       - id: uv-lock
   - repo: https://github.com/astral-sh/ruff-pre-commit

updates2mqtt-1.3.6/CHANGELOG.md

@@ -0,0 +1,8 @@
+# CHANGELOG
+
+## 1.3.6
+- Changed exit code on graceful shutdown to 143
+- App now exits if the MQTT username / password is not authorized
+- Improved handling of env vars, default config now assumes MQTT_HOST etc unless overridden
+  - Will now run without a config if correct `MQTT_HOST`,`MQTT_USER`,`MQTT_PASS`,`MQTT_PORT` env vars set or match the defaults (`127.0.0.1:1883`)
+- Deps update

{updates2mqtt-1.3.5 → updates2mqtt-1.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: updates2mqtt
-Version: 1.3.5
+Version: 1.3.6
 Summary: System update and docker image notification and execution over MQTT
 Project-URL: Repository, https://github.com/rhizomatics/updates2mqtt
 Project-URL: Documentation, https://updates2mqtt.rhizomatics.org.uk
@@ -52,152 +52,25 @@ Use Home Assistant to notify you of updates to Docker images for your containers
 
 ## Description
 
-updates2mqtt perioidically checks for new versions of components being available, and publishes new version info to MQTT.
-HomeAssistant auto discovery is supported, so all updates can be seen in the same place as Home Assistant's
-own components and add-ins.
+updates2mqtt perioidically checks for new versions of components being available, and publishes new version info to MQTT. HomeAssistant auto discovery is supported, so all updates can be seen in the same place as Home Assistant's own components and add-ins.
 
-Currently only Docker containers are supported, either via an image registry check, or a git repo for source. The design is modular, so other update sources can be added, at least for notification. The next anticipated is **apt** for Debian based systems.
+Currently only Docker containers are supported, either via an image registry check, or a git repo for source (see [Local Builds](local_builds.md)). The design is modular, so other update sources can be added, at least for notification. The next anticipated is **apt** for Debian based systems.
 
-Components can also be updated, either automatically or triggered via MQTT, for example by hitting the *Install*
-button in the HomeAssistant update dialog. Icons and release notes can be specified for a better HA experience.
+Components can also be updated, either automatically or triggered via MQTT, for example by hitting the *Install* button in the HomeAssistant update dialog. Icons and release notes can be specified for a better HA experience.
 
-## Install
+To get started, read the [Installation](installation.md) and [Configuration](configuration.md) pages.
 
-updates2mqtt prefers to be run inside a Docker container.
-
-### Manual - Run without installing using uv
-```
-uv run --with updates2mqtt updates2mqtt
-```
-
-### Manual - Install and run with pip
-```
-pip install updates2mqtt
-python3 -m updates2mqtt
-```
-### Docker
-
-See `examples` directory for a working `docker-compose.yaml`.
-
-If you want to update and restart containers, then the file system paths to the location of the
-directory where the docker compose file lives must be available in the updates2mqtt container. 
-
-The example `docker-compose.yaml` mounts `/home/containers` for this purpose, so if your containers are in
-`/home/containers/app1`, `/home/containers/app2` etc, then updates2mqtt will be able to find them. Map as
-many root paths as needed.
-
-## Configuration
-
-Create file `config.yaml` in `conf` directory. If the file is not present, a default file will be generated.
-
-### Example configuration file
-
-This is a maximal config file, the minimum is no config file at all, which will generate a default config file. The only mandatory values are the MQTT user name and password, everything else can be omitted.
+For a quick spin, try this:
 
 ```yaml
-
-node:
-  name: docker-host-1 # Unique name for this instance, used to name MQTT entities. Defaults to O/S hostname
-  git_repo_path: /usr/bin/git # Path to git inside container, needed only if non-default and using local docker builds
-  healthcheck:
-    enabled: true
-    interval: 300 # publish a heartbeat every 5 minutes
-    topic_template: healthcheck/{node_name}/updates2mqtt
-mqtt:
-  host: ${oc.env:MQTT_HOST}
-  user: ${oc.env:MQTT_USER}
-  password: ${oc.env:MQTT_PASS}$ # Use an environment variable for secrets
-  port: ${oc.env:MQTT_PORT}
-  topic_root: updates2mqtt
-homeassistant:
-  discovery:
-    prefix: homeassistant # Matches the default MQTT discovery prefix in Home Assistant
-    enabled: true
-  state_topic_suffix: state
-docker:
-  enabled: true
-  allow_pull: true # if true, will do a `docker pull` if an update is available
-  allow_restart: true # if true, will do a `docker-compose up` if an update is installed
-  allow_build: true # if true, will do a `docker-compose build` if a git repo is configured
-  compose_version: v2 # Controls whether to use `docker-compose` (v1) or `docker compose` (v2) command
-  default_entity_picture_url: https://www.docker.com/wp-content/uploads/2022/03/Moby-logo.png # Picture for update dialog
-  device_icon: mdi:docker # Material Design Icon to use when browsing entities in Home Assistant
-  # device_icon: mdi:train-car-container # Alternative icon if you don't like Docker branding
-  discover_metadata:
-    linuxserver.io:
-      enabled: true
-      cache_ttl: 604800 # cache metadata for 1 week
-scan_interval: 10800 # sleep interval between scan runs, in seconds
-log:
-  level: INFO
-```
-
-### Moving Secrets Out of Config
-
-Example use of environment variables, e.g. for secrets:
-
-```
-mqtt:
-    password: ${oc.env:MQTT_PASS}
+docker run -e MQTT_USER=user1 -e MQTT_PASS=pass1 -e MQTT_HOST=192.168.1.5 ghcr.io/rhizomatics/updates2mqtt:release
 ```
-### Customizing images and release notes
-
-Individual docker containers can have customized entity pictures or release notes, using env variables, for example in the `docker-compose.yaml` or in a separate `.env` file:
-
-```
-    environment:
-      - UPD2MQTT_PICTURE=https://frigate.video/images/logo.svg
-      - UPD2MQTT_RELNOTES=https://github.com/blakeblackshear/frigate/releases
-```
-
-The images will show up in the *Update* section of *Settings* menu in HomeAssistant,
-as will the release notes link. SVG icons should be used.
-
-Some popular services have the icon and release note links pre-configured, in `common_packages.yaml`,
-and packages from `linuxserver.io` can have metadata automatically discovered.
-
-#### Icon Sources
-
-- [Homarr Dashboard Icons](https://github.com/homarr-labs/dashboard-icons)
-- [Self Hosted Icons](https://github.com/selfhst/icons)
-- [Simple Icons](https://github.com/simple-icons/simple-icons)
-- [Tabler Icons](https://tabler.io/icons)
-- [Papirus Icons](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme)
-- [Homelab SVG Assets](https://github.com/loganmarchione/homelab-svg-assets)
-
-### Automated updates
-
-If Docker containers should be immediately updated, without any confirmation
-or trigger, *e.g.* from the HomeAssistant update dialog, then set an environment variable `UPD2MQTT_UPDATE`
-in the target container to `Auto` ( it defaults to `Passive`)
-
-### Custom docker builds
-
-If the image is locally built from a checked out git repo, package update can be driven
-by the availability of git repo changes to pull rather than a new image on a Docker registry.
-
-Declare the git path using the env var in ``UPD2MQTT_GIT_REPO_PATH`` in the docker container ( directly or via an ``.env`` file).
-The git repo at this path will be used as the source of timestamps, and an update command will carry out a 
-``git pull`` and ``docker-compose build`` rather than pulling an image.
-
-Note that the updates2mqtt docker container needs access to this path declared in its volumes, and that has to
-be read/write if automated install required.
-
-### Environment Variables
-
-The following environment variables can be used to configure updates2mqtt:
-
-| Env Var | Description | Default  |
-|---------| ------------|----------|
-| `UPD2MQTT_UPDATE`  | Update mode, either `Passive` or `Auto`. If `Auto`, updates will be installed automatically. | `Passive` |
-| `UPD2MQTT_PICTURE`  | URL to an icon to use in Home Assistant.  | Docker logo URL   |
-| `UPD2MQTT_RELNOTES` | URL to release notes for the package.  |  | 
-| `UPD2MQTT_GIT_REPO_PATH` | Relative path to a local git repo if the image is built locally.  | |
-| `UPD2MQTT_IGNORE` | If set to `True`, the container will be ignored by updates2mqtt. | False |
-
 
 ## Release Support
 
+Presently only Docker containers are supported, although others are planned,
+probably with priority for `apt`.
+
 | Ecosystem | Support     | Comments                                                                                           |
 |-----------|-------------|----------------------------------------------------------------------------------------------------|
 | Docker    | Scan. Fetch | Fetch is ``docker pull`` only. Restart support only for ``docker-compose`` image based containers. |

updates2mqtt-1.3.6/README.md

@@ -0,0 +1,79 @@
+[![Rhizomatics Open Source](https://avatars.githubusercontent.com/u/162821163?s=96&v=4)](https://github.com/rhizomatics)
+
+# updates2mqtt
+
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/rhizomatics/supernotify)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/rhizomatics/updates2mqtt/main.svg)](https://results.pre-commit.ci/latest/github/rhizomatics/updates2mqtt/main)
+[![Publish Python 🐍 distribution 📦 to PyPI and TestPyPI](https://github.com/rhizomatics/updates2mqtt/actions/workflows/pypi-publish.yml/badge.svg)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/pypi-publish.yml)
+[![Github Deploy](https://github.com/rhizomatics/updates2mqtt/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/python-package.yml)
+[![CodeQL](https://github.com/rhizomatics/updates2mqtt/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/github-code-scanning/codeql)
+[![Dependabot Updates](https://github.com/rhizomatics/updates2mqtt/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/dependabot/dependabot-updates)
+
+## Summary
+
+Use Home Assistant to notify you of updates to Docker images for your containers and optionally perform the *pull* (or optionally *build*) and *update*.
+
+![Example Home Assistant update dialog](images/ha_update_detail.png "Home Assistant Updates")
+
+## Description
+
+updates2mqtt perioidically checks for new versions of components being available, and publishes new version info to MQTT. HomeAssistant auto discovery is supported, so all updates can be seen in the same place as Home Assistant's own components and add-ins.
+
+Currently only Docker containers are supported, either via an image registry check, or a git repo for source (see [Local Builds](local_builds.md)). The design is modular, so other update sources can be added, at least for notification. The next anticipated is **apt** for Debian based systems.
+
+Components can also be updated, either automatically or triggered via MQTT, for example by hitting the *Install* button in the HomeAssistant update dialog. Icons and release notes can be specified for a better HA experience.
+
+To get started, read the [Installation](installation.md) and [Configuration](configuration.md) pages.
+
+For a quick spin, try this:
+
+```yaml
+docker run -e MQTT_USER=user1 -e MQTT_PASS=pass1 -e MQTT_HOST=192.168.1.5 ghcr.io/rhizomatics/updates2mqtt:release
+```
+
+## Release Support
+
+Presently only Docker containers are supported, although others are planned,
+probably with priority for `apt`.
+
+| Ecosystem | Support     | Comments                                                                                           |
+|-----------|-------------|----------------------------------------------------------------------------------------------------|
+| Docker    | Scan. Fetch | Fetch is ``docker pull`` only. Restart support only for ``docker-compose`` image based containers. |
+  
+## Healthcheck
+
+A heartbeat JSON payload is optionally published periodically to a configurable MQTT topic, defaulting to `healthcheck/{node_name}/updates2mqtt`. It contains the current version of updates2mqtt, the node name, a timestamp, and some basic stats.
+
+A `healthcheck.sh` script is included in the Docker image, and can be used as a Docker healthcheck, if the container environment variables are set for `MQTT_HOST`, `MQTT_PORT`, `MQTT_USER` and `MQTT_PASS`.
+
+TIP: Check healthcheck is working using `docker inspect --format "{{json .State.Health }}" updates2mqtt | jq`
+  
+## HomeAssistant integration
+
+Any updates that have support for automated install will automatically show in the
+Home Assistant settings page if the [MQTT Integration](https://www.home-assistant.io/integrations/mqtt/) is installed and automatic discovery is not disabled.
+
+![Home Assistant MQTT Integraion configuration](images/ha_mqtt_discovery.png "Home Assistant MQTT Discovery")
+
+The `homeassistant` default topic prefix matches the default updates2mqtt config, if its changed in HomeAssistant, then the updates2mqtt config must be changed to match.
+
+![Home Assistant updates in Settings](images/ha_update_page.png "Home Assistant Updates")
+
+For Home Assistant integration, updates2mqtt represents each component being managed as a [MQTT Update](https://www.home-assistant.io/integrations/update.mqtt/) entity, and uses [MQTT discovery(https://www.home-assistant.io/integrations/mqtt/#mqtt-discovery)] so that HomeAssistant automatically picks up components discovered by updates2mqtt with zero configuration on HomeAssistant itself. 
+
+There are 3 separate types of MQTT topic used for HomeAssisstant integration:
+
+- *Config* to support auto discovery. A topic is created per component, with a name like `homeassistant/update/dockernuc_docker_jellyfin/update/config`. This can be disabled in the config file, and the `homeassistant` topic prefix can also be configured.
+- *State* to report the current version and the latest version available, again one topic per component, like `updates2mqtt/dockernuc/docker/jellyfin`.
+- *Command* to support triggering an update. These will be created on the fly by HomeAssistant when an update is requested, and updates2mqtt subscribes to pick up the changes, so you won't typically see these if browsing MQTT topics. Only one is needed per updates2mqtt agent, with a name like `updates2mqtt/dockernuc/docker`
+
+If the package supports automated update, then *Skip* and *Install* buttons will appear on the Home Assistant
+interface, and the package can be remotely fetched and the component restarted.
+
+## Related Projects
+
+- [psmqtt](https://github.com/eschava/psmqtt) - Report system health and metrics via MQTT
+- 
+## Development
+
+Access to Docker APIs uses the Python [docker-py](https://docker-py.readthedocs.io/en/stable/) SDK for Python. [Eclipse Paho](https://eclipse.dev/paho/files/paho.mqtt.python/html/client.html) is used for MQTT access, and [OmegaConf](https://omegaconf.readthedocs.io) for configuration.

updates2mqtt-1.3.6/docs/configuration.md

@@ -0,0 +1,98 @@
+# Configuration
+
+Create file `config.yaml` in `conf` directory. If the file is not present, a default file will be generated.
+
+### Example configuration file
+
+This is a maximal config file, the minimum is no config file at all, which will generate a default config file. The only mandatory values are the MQTT user name and password, everything else can be omitted.
+
+```yaml
+
+node:
+  name: docker-host-1 # Unique name for this instance, used to name MQTT entities. Defaults to O/S hostname
+  git_repo_path: /usr/bin/git # Path to git inside container, needed only if non-default and using local docker builds
+  healthcheck:
+    enabled: true
+    interval: 300 # publish a heartbeat every 5 minutes
+    topic_template: healthcheck/{node_name}/updates2mqtt
+mqtt:
+  host: ${oc.env:MQTT_HOST}
+  user: ${oc.env:MQTT_USER}
+  password: ${oc.env:MQTT_PASS}$ # Use an environment variable for secrets
+  port: ${oc.env:MQTT_PORT}
+  topic_root: updates2mqtt
+homeassistant:
+  discovery:
+    prefix: homeassistant # Matches the default MQTT discovery prefix in Home Assistant
+    enabled: true
+  state_topic_suffix: state
+docker:
+  enabled: true
+  allow_pull: true # if true, will do a `docker pull` if an update is available
+  allow_restart: true # if true, will do a `docker-compose up` if an update is installed
+  allow_build: true # if true, will do a `docker-compose build` if a git repo is configured
+  compose_version: v2 # Controls whether to use `docker-compose` (v1) or `docker compose` (v2) command
+  default_entity_picture_url: https://www.docker.com/wp-content/uploads/2022/03/Moby-logo.png # Picture for update dialog
+  device_icon: mdi:docker # Material Design Icon to use when browsing entities in Home Assistant
+  # device_icon: mdi:train-car-container # Alternative icon if you don't like Docker branding
+  discover_metadata:
+    linuxserver.io:
+      enabled: true
+      cache_ttl: 604800 # cache metadata for 1 week
+scan_interval: 10800 # sleep interval between scan runs, in seconds
+log:
+  level: INFO
+```
+
+### Moving Secrets Out of Config
+
+Example use of environment variables, e.g. for secrets:
+
+```
+mqtt:
+    password: ${oc.env:MQTT_PASS}
+```
+### Customizing images and release notes
+
+Individual docker containers can have customized entity pictures or release notes, using env variables, for example in the `docker-compose.yaml` or in a separate `.env` file:
+
+```
+    environment:
+      - UPD2MQTT_PICTURE=https://frigate.video/images/logo.svg
+      - UPD2MQTT_RELNOTES=https://github.com/blakeblackshear/frigate/releases
+```
+
+The images will show up in the *Update* section of *Settings* menu in HomeAssistant,
+as will the release notes link. SVG icons should be used.
+
+#### Icon Sources
+
+Updates look nicer in Home Assistant with a suitable icon. Updates2mqtt comes
+pre-packaged with some common ones, in `common_packages.yaml`, and can automatically fetch them (and release links) for the popular [linuxserver.io](https://www.linuxserver.io) packages.  
+
+If you have something not covered, here are some good places to look for self-hosted app icons:
+
+- [Homarr Dashboard Icons](https://github.com/homarr-labs/dashboard-icons)
+- [Self Hosted Icons](https://github.com/selfhst/icons)
+- [Simple Icons](https://github.com/simple-icons/simple-icons)
+- [Tabler Icons](https://tabler.io/icons)
+- [Papirus Icons](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme)
+- [Homelab SVG Assets](https://github.com/loganmarchione/homelab-svg-assets)
+
+### Automated updates
+
+If Docker containers should be immediately updated, without any confirmation
+or trigger, *e.g.* from the HomeAssistant update dialog, then set an environment variable `UPD2MQTT_UPDATE` in the target container to `Auto` ( it defaults to `Passive`)
+
+
+### Environment Variables
+
+The following environment variables can be used to configure updates2mqtt:
+
+| Env Var | Description | Default  |
+|---------| ------------|----------|
+| `UPD2MQTT_UPDATE`  | Update mode, either `Passive` or `Auto`. If `Auto`, updates will be installed automatically. | `Passive` |
+| `UPD2MQTT_PICTURE`  | URL to an icon to use in Home Assistant.  | Docker logo URL   |
+| `UPD2MQTT_RELNOTES` | URL to release notes for the package.  |  | 
+| `UPD2MQTT_GIT_REPO_PATH` | Relative path to a local git repo if the image is built locally.  | |
+| `UPD2MQTT_IGNORE` | If set to `True`, the container will be ignored by updates2mqtt. | False |

updates2mqtt-1.3.6/docs/examples/config_maximal.md

@@ -0,0 +1,7 @@
+# Maximal Configuration
+
+More extensive example configuration, using all the features
+
+``` yaml
+--8<-- "examples/config.yaml.minimal"
+```

updates2mqtt-1.3.6/docs/examples/config_minimal.md

@@ -0,0 +1,7 @@
+# Minimal Configuration
+
+Smallest working configuration
+
+``` yaml
+--8<-- "examples/config.yaml.maximal"
+```

updates2mqtt-1.3.6/docs/examples/docker_compose.md

@@ -0,0 +1,7 @@
+# Docker Compose
+
+Example Docker Compose configuration to run *updates2mqtt* as a container.
+
+``` yaml
+--8<-- "examples/docker-compose.yaml"
+```

updates2mqtt-1.3.6/docs/installation.md

@@ -0,0 +1,29 @@
+# Installation
+
+## Install
+
+updates2mqtt prefers to be run inside a Docker container, though can run standalone, for example scripted via cron or systemd.
+
+### Docker
+
+See `examples` directory for a working `docker-compose.yaml`.
+
+If you want to update and restart containers, then the file system paths to the location of the directory where the docker compose file lives must be available in the updates2mqtt container. 
+
+The example `docker-compose.yaml` mounts `/home/containers` for this purpose, so if your containers are in
+`/home/containers/app1`, `/home/containers/app2` etc, then updates2mqtt will be able to find them. Map as many root paths as needed.
+
+### Without Docker
+
+#### Run without installing using uv
+
+```
+uv run --with updates2mqtt updates2mqtt
+```
+
+#### Install and run with pip
+
+```
+pip install updates2mqtt
+python3 -m updates2mqtt
+```

updates2mqtt-1.3.6/docs/local_builds.md

@@ -0,0 +1,22 @@
+# Local Builds
+
+## Custom docker builds
+
+If the image is locally built from a checked out git repo, package update can be driven by the availability of git repo changes to pull rather than a new image on a Docker registry.
+
+(People sometimes do this as a quick way of forking and changing a repo that doesn't quite work for them, or if the app is a development work in progress).
+
+```yaml title="Example docker-compose.yaml snippet"
+services:
+  mymailserver:
+    build: ./build/mymailserver
+    environment:
+      - UPD2MQTT_GIT_REPO_PATH=build/mymailserver
+    volumes:
+      - /home/containers/mymailserver/build:/home/containers/mymailserver/build
+```
+
+Declare the git path using the env var in ``UPD2MQTT_GIT_REPO_PATH`` in the docker container ( directly or via an ``.env`` file). The git repo at this path will be used as the source of timestamps, and an update command will carry out a 
+``git pull`` and ``docker-compose build`` rather than pulling an image.
+
+Note that the updates2mqtt docker container needs access to this path declared in its volumes, and that has to be read/write if automated install required.

{updates2mqtt-1.3.5 → updates2mqtt-1.3.6}/examples/config.yaml.maximal

@@ -9,9 +9,9 @@ node:
     topic_template: healthcheck/{node_name}/updates2mqtt
 mqtt:
   host: localhost
-  port: ${oc.env:MQTT_PORT}
-  user: ${oc.env:MQTT_USER}
-  password: ${oc.env:MQTT_PASS}
+  port: 1883
+  user: mymqttuser
+  password: mysecret
   topic_root: updates2mqtt
 homeassistant:
   discovery:

updates2mqtt-1.3.6/examples/config.yaml.minimal

@@ -0,0 +1,9 @@
+mqtt:
+  host: ${oc.env:MQTT_HOST,"127.0.0.1"}
+  port: ${oc.env:MQTT_PORT,1883}
+  user: ${oc.env:MQTT_USER}
+  password: ${oc.env:MQTT_PASS}
+
+node:
+  name: dockernuc
+

updates2mqtt-1.3.6/no_config.yaml

@@ -0,0 +1,33 @@
+log:
+  level: INFO
+node:
+  name: Jeys-MacBook-Pro
+  git_path: /usr/bin/git
+  healthcheck:
+    enabled: true
+    interval: 300
+    topic_template: healthcheck/{node_name}/updates2mqtt
+mqtt:
+  host: ${oc.env:MQTT_HOST,localhost}
+  user: ${oc.env:MQTT_USER,null}
+  password: ${oc.env:MQTT_PASS,null}
+  port: ${oc.decode:${oc.env:MQTT_PORT,1883}}
+  topic_root: updates2mqtt
+homeassistant:
+  discovery:
+    prefix: homeassistant
+    enabled: true
+  state_topic_suffix: state
+docker:
+  enabled: true
+  allow_pull: true
+  allow_restart: true
+  allow_build: true
+  compose_version: v2
+  default_entity_picture_url: https://www.docker.com/wp-content/uploads/2022/03/Moby-logo.png
+  device_icon: mdi:docker
+  discover_metadata:
+    linuxserver.io:
+      enabled: true
+      cache_ttl: 604800
+scan_interval: 10800

{updates2mqtt-1.3.5 → updates2mqtt-1.3.6}/pyproject.toml

@@ -7,7 +7,7 @@ authors = [
 ]
 
 requires-python = ">=3.13"
-version = "1.3.5"
+version = "1.3.6"
 license="Apache-2.0"
 keywords=["mqtt", "docker", "updates", "automation","home-assistant","homeassistant","selfhosting"]
 

{updates2mqtt-1.3.5 → updates2mqtt-1.3.6}/src/updates2mqtt/app.py

@@ -99,12 +99,17 @@ class App:
         for scanner in self.scanners:
             self.publisher.subscribe_hass_command(scanner)
 
-        while not self.stopped.is_set():
+        while not self.stopped.is_set() and self.publisher.is_available():
             await self.scan()
-            if not self.stopped.is_set():
+            if not self.stopped.is_set() and self.publisher.is_available():
                 await asyncio.sleep(self.cfg.scan_interval)
             else:
                 log.info("Stop requested, exiting run loop and skipping sleep")
+
+        if not self.publisher.is_available():
+            log.error("MQTT fatal connection error - check host,port,user,password in config")
+            self.shutdown(exit_code=1)
+
         log.debug("Exiting run loop")
 
     async def on_discovery(self, discovery: Discovery) -> None:
@@ -144,8 +149,8 @@ class App:
         await asyncio.gather(*running_tasks, return_exceptions=True)
         log.debug("Cancellation task completed")
 
-    def shutdown(self, *args) -> None:  # noqa: ANN002
-        log.info("Shutting down on SIGTERM: %s", args)
+    def shutdown(self, *args, exit_code: int = 143) -> None:  # noqa: ANN002, ARG002
+        log.info("Shutting down, exit_code: %s", exit_code)
         self.stopped.set()
         for scanner in self.scanners:
             scanner.stop()
@@ -155,8 +160,11 @@ class App:
         self.publisher.stop()
         log.debug("Interrupt: %s", interrupt_task.done())
         log.info("Shutdown handling complete")
+        sys.exit(exit_code)  # SIGTERM Graceful Exit = 143
 
     async def healthcheck(self) -> None:
+        if not self.publisher.is_available():
+            return
         self.publisher.publish(
             topic=self.healthcheck_topic,
             payload={
@@ -178,7 +186,7 @@ async def repeated_call(func: Callable, interval: int = 60, *args: Any, **kwargs
             await func(*args, **kwargs)
             await asyncio.sleep(interval)
         except asyncio.CancelledError:
-            log.exception("Periodic task cancelled")
+            log.debug("Periodic task cancelled")
         except Exception:
             log.exception("Periodic task failed")
 

{updates2mqtt-1.3.5 → updates2mqtt-1.3.6}/src/updates2mqtt/config.py

@@ -4,17 +4,17 @@ from dataclasses import dataclass, field
 from pathlib import Path
 
 import structlog
-from omegaconf import MISSING, MissingMandatoryValue, OmegaConf, ValidationError
+from omegaconf import MISSING, DictConfig, MissingMandatoryValue, OmegaConf, ValidationError
 
 log = structlog.get_logger()
 
 
 @dataclass
 class MqttConfig:
-    host: str = "localhost"
-    user: str = MISSING
-    password: str = MISSING
-    port: int = 1883
+    host: str = "${oc.env:MQTT_HOST,localhost}"
+    user: str = f"${{oc.env:MQTT_USER,{MISSING}}}"
+    password: str = f"${{oc.env:MQTT_PASS,{MISSING}}}"
+    port: int = "${oc.decode:${oc.env:MQTT_PORT,1883}}"  # type: ignore[assignment]
     topic_root: str = "updates2mqtt"
 
 
@@ -111,10 +111,11 @@ def load_package_info(pkginfo_file_path: Path) -> UpdateInfoConfig:
     return typing.cast("UpdateInfoConfig", cfg)
 
 
-def load_app_config(conf_file_path: Path, return_new: bool = False) -> Config | None:
-    base_cfg = OmegaConf.structured(Config)
+def load_app_config(conf_file_path: Path, return_invalid: bool = False) -> Config | None:
+    base_cfg: DictConfig = OmegaConf.structured(Config)
+    is_new: bool = False
     if conf_file_path.exists():
-        cfg = OmegaConf.merge(base_cfg, OmegaConf.load(conf_file_path))
+        cfg: DictConfig = typing.cast("DictConfig", OmegaConf.merge(base_cfg, OmegaConf.load(conf_file_path)))
     else:
         if not conf_file_path.parent.exists():
             try:
@@ -126,9 +127,7 @@ def load_app_config(conf_file_path: Path, return_new: bool = False) -> Config |
             conf_file_path.write_text(OmegaConf.to_yaml(base_cfg))
             log.info(f"Auto-generated a new config file at {conf_file_path}")
             log.info("The config has place holders for MQTT user and password")
-            if return_new:
-                return base_cfg
-            return None
+            is_new = True
         except Exception:
             log.exception("Unable to write config file", path=conf_file_path)
         cfg = base_cfg
@@ -137,7 +136,15 @@ def load_app_config(conf_file_path: Path, return_new: bool = False) -> Config |
         # Validate that all required fields are present, throw exception now rather than when config first used
         OmegaConf.to_container(cfg, throw_on_missing=True)
         OmegaConf.set_readonly(cfg, True)
-        return typing.cast("Config", cfg)
+        config: Config = typing.cast("Config", cfg)
+        if config.mqtt.user == MISSING or config.mqtt.password == MISSING:
+            if not is_new:
+                log.warning("MQTT connection configuration has place holders")
+            if not is_new and not return_invalid:
+                return None
+        return config
     except (MissingMandatoryValue, ValidationError) as e:
         log.error("Configuration error %s", e, path=conf_file_path.as_posix())
-        return None
+        if return_invalid and cfg is not None:
+            return typing.cast("Config", cfg)
+        raise