Skip to content

Health checks

Setup

HolyArrs checks itself on a timer and tells you when something is wrong.

  1. Open Home. Anything that needs a look shows there.
  2. For the full list, open Settings > Health checks. Each result shows its state and since when.
  3. Select Check again to run every check now. You should see the results refresh.

Checks run every 5 minutes, at start, and right after an import is refused for lack of space. The Status page at /health shows free space per Library folder.

What each check means

Link to What each check means
Check Fine Warning Broken
Config folder /config is mapped to a host folder or named volume /config is not mapped to a host folder or named volume. Everything is lost when the container is removed. See Forgot to map /config?
Config folder space Room to spare Under 1 GB free on its disk Under 256 MB free. HolyArrs cannot save anything when it is full
Library folder There and writable On another disk than downloads, so imports are copied Gone (disk or share not mounted) or not writable
Free space Room to spare Under the warning size (1024 MB by default) An import was refused moments ago for space
Source Working, or paused by you Cannot be reached, or refused its key
Downloader Working, or paused by you Does not answer, or refused the sign-in
Waiting downloads No download waits for its files A download waits because the downloader cannot use its files, often a share that mounted late One has waited about 3 days
Backups A recent backup exists No backup yet, or the newest is old The last scheduled backup failed
Key kit A key kit was saved for the current master key No key kit saved yet
Trailer reader (when trailers are on) Lookups work 5 different videos failed in a row. If YouTube refuses the reader sooner, the row says so
Update You run the newest version A newer HolyArrs is out

A paused source or downloader counts as fine.

Create an Alert with the Health moment. You get one message when a check breaks and one when it is fixed. A downloader that stays down sends one message, not one per run.

On Settings > Health checks. The first two sit under the card’s advanced part.

Setting Default Change it when
Check every (minutes) 5 You want faster or slower checks: 1 to 1440
Alert after this many runs in a row 2 Blips still alert (raise) or alerts come late (lower): 1 to 20
Warn when free space is under (MB) 1024 Your disks are small or large. Per Library folder disk

The update settings live on the same card; see Updates.

If it does not work

Link to If it does not work

Symptom: a download waits for its files after a share came back. Cause: qBittorrent, Deluge and Transmission keep the error until the files are checked again. Fix: on Downloads, select Check again on that row, or recheck it in the downloader.

Symptom: a Library folder shows broken after a reboot. Cause: the disk or share was not mounted when HolyArrs started. Fix: mount it, then select Check again.

Symptom: the key kit warning stays. Cause: no key kit was saved for the current master key. Fix: the owner selects Settings > Backups > Download key kit. See Backups.

Symptom: Config folder is broken. Cause: /config lives inside the container. Fix: stop the container, copy the folder out with docker cp, map /config, copy it back in. See Install.

How alerting holds back blips

A new result must hold for Alert after this many runs in a row before it counts. With the default 2, a downloader that fails one run and recovers on the next stays quiet. Raising it makes real alerts arrive later too.

HolyArrs is free. If it saved you time, star it on GitHub, sponsor it or buy me a coffee.