publish_active_windows/README.md

30 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2025-01-06 20:22:30 +01:00
# publish_active_windows
## Requirements
2025-01-06 21:55:07 +01:00
- Only Gnome on Wayland is supported.
2025-01-06 21:57:08 +01:00
- You need to install the Gnome Extension [Window Calls Extended](https://extensions.gnome.org/extension/4974/window-calls-extended/) for each user to monitor.
2025-01-06 21:55:07 +01:00
- You need to run this script in the Gnome Session of the user, via creating a .desktop file and adding the application to Startup Applications with Gnome Tweaks for example.
2025-01-06 20:22:30 +01:00
2025-01-06 21:55:07 +01:00
## Installation
2025-01-06 20:22:30 +01:00
To install for example in your ~/.local/bin folder:
```bash
./install.sh --destination ~/.local/bin
```
To install system-wide:
```bash
sudo ./install.sh --destination /usr/local/bin
```
Change your configuration file in "${HOME}/.config/publish_active_windows.conf" (see the example in the config folder).
## Usage
```bash
2025-01-06 21:55:07 +01:00
publish_active_windows.sh [--debug-level|-d CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET] --ha-url <URL> --ha-token <TOKEN>
2025-01-06 20:22:30 +01:00
```
2025-01-06 21:55:07 +01:00
- URL should be something like https://myhomeassistant.example.org:8443
- The TOKEN must be generated in HomeAssistant, under your profile, Security, Create token. This token will be readable to the user you want to monitor, and it could be able to publish and read any other data from HomeAssistant. At the moment HomeAssistant doesn't support more granular permissions that allow you to limit the access of this token.