Skip to main content

Apprise Settings

These settings control how Cleanuperr sends notifications through Apprise.

APPRISE__URL

Apprise url where to send notifications.
The /notify endpoint is automatically appended.
Required: No
Type: text
Default value: Empty
Examples:
  • http://localhost:8000

APPRISE__KEY

Apprise configuration key containing all 3rd party notification providers which Cleanuperr would notify.
Required: No
Type: text
Default value: Empty

APPRISE__ON_IMPORT_FAILED_STRIKE

Controls whether to notify when an item receives a failed import strike.
Required: No
Type: boolean
Default value: false
Accepted values:
  • true
  • false

APPRISE__ON_STALLED_STRIKE

Controls whether to notify when an item receives a stalled download strike. This includes strikes for being stuck while downloading metadata.
Required: No
Type: boolean
Default value: false
Accepted values:
  • true
  • false

APPRISE__ON_SLOW_STRIKE

Controls whether to notify when an item receives a slow download strike. This includes strikes for having a low download speed or slow estimated finish time.
Required: No
Type: boolean
Default value: false
Accepted values:
  • true
  • false

APPRISE__ON_QUEUE_ITEM_DELETED

Controls whether to notify when a queue item is deleted.
Required: No
Type: boolean
Default value: false
Accepted values:
  • true
  • false

APPRISE__ON_DOWNLOAD_CLEANED

Controls whether to notify when a download is cleaned.
Required: No
Type: boolean
Default value: false
Accepted values:
  • true
  • false

APPRISE__ON_CATEGORY_CHANGED

Controls whether to notify when a download's category is changed.
Required: No
Type: boolean
Default value: false
Accepted values:
  • true
  • false