service-update-alerts/README.md
Jeena 7537de2f53 feat: Add authenticated service checks
Support FreshRSS login with challenge hashing, add GitHub token usage, and update service metadata for Immich and PeerTube.
2026-03-12 13:57:37 +00:00

47 lines
892 B
Markdown

# check-for-updates
Small Python script to compare running service versions against upstream releases.
## Requirements
- Python 3.10+
## Setup
Create and activate a virtual environment, then install dependencies:
```bash
python -m venv .venv
source .venv/bin/activate
pip install -e .[dev]
```
Copy `.env.sample` to `.env` and fill required values. Export the variables before running the script:
```bash
export PAPERLESS_API_TOKEN=...
export RADICALE_BASIC_AUTH=...
export FRESHRSS_USERNAME=...
export FRESHRSS_PASSWORD=...
```
The script also reads `.env` automatically if present.
## Usage
```bash
python3 check_updates.py --config services.yaml
python3 check_updates.py --config services.yaml --all
```
## Tests
```bash
python -m pytest
```
To run live integration checks against the real services:
```bash
RUN_LIVE_TESTS=1 python -m pytest tests/test_live_services.py
```