Configuration

Configuration

Environment variables

All configuration is done via environment variables in your .env file. Copy env.example to .env and fill in your values.

Required

Variable	Description
ANTHROPIC_API_KEY	Claude API key. Not required if using OpenAI or Ollama.
NTFY_URL	ntfy topic URL, e.g. https://ntfy.sh/my-topic. Not required if using Home Assistant only.

AI provider

Variable	Default	Description
AI_PROVIDER	claude	AI provider to use: claude, openai, or ollama
OPENAI_API_KEY	—	Required if AI_PROVIDER=openai
OPENAI_MODEL	gpt-4o-mini	OpenAI model: gpt-4o-mini or gpt-4o
OLLAMA_URL	http://ollama:11434	Required if AI_PROVIDER=ollama
OLLAMA_MODEL	llama3.2	Ollama model name, e.g. mistral

Notification provider

Variable	Default	Description
NOTIFY_PROVIDER	ntfy	Notification provider: ntfy, homeassistant, or both
NTFY_TOKEN	—	ntfy access token for private topics
HASS_URL	—	Home Assistant URL, e.g. http://homeassistant.local:8123
HASS_TOKEN	—	Long-lived access token from your HA profile
HASS_NOTIFY_SERVICE	notify	Notify service name, e.g. mobile_app_your_phone

Other

Variable	Default	Description
GITHUB_TOKEN	—	GitHub PAT (no scopes needed). Raises rate limit from 60 to 5000 req/h. Strongly recommended.
API_KEY	—	Protects POST /api/check from unauthenticated triggers. Recommended if exposing via reverse proxy.

---

containers.yml

This file defines which GitHub repositories to watch.

settings block

settings:
  check_interval_hours: 6    # how often to check (default: 6)
  stable_only: true          # ignore pre-releases globally (default: true)

containers block

Each entry supports these fields:

Field	Required	Description
name	Yes	Display name shown in notifications
github	Yes	GitHub repo in owner/repo format
image	No	Docker image reference for digest tracking
container	No	Actual Docker container name if different from name
stable_only	No	Override global stable_only setting for this container

Example

settings:
  check_interval_hours: 6
  stable_only: true

containers:
  # Minimal — just release tracking, no digest tracking
  - name: Vaultwarden
    github: dani-garcia/vaultwarden

  # Full — release + digest tracking
  - name: Immich
    github: immich-app/immich
    image: ghcr.io/immich-app/immich-server

  # Container name different from display name
  - name: AdGuard Home
    github: AdguardTeam/AdGuardHome
    image: adguard/adguardhome
    container: adguardhome

  # Include pre-releases (useful for *arr apps)
  - name: Sonarr
    github: Sonarr/Sonarr
    image: lscr.io/linuxserver/sonarr
    stable_only: false

Notes on digest tracking

• image must match the registry image, not the Docker Hub shorthand. Use ghcr.io/... for GHCR images, lscr.io/linuxserver/... for LinuxServer images.
• LinuxServer images (lscr.io/linuxserver/...) append -ls### to their tags. Trivy digest lookup returns unknown for these — this is expected and unfixable.
• If image is not set, pull status will always show as unknown.