Skip to content

Notif - Ntfy

Configuration options for notif ntfy.

Available Options

This page documents 13 configuration options.

nixflix.notif.ntfy.enable

Whether or not this notification is enabled.

Typeboolean
Default 
false
Declared inmodules/notif/options.nix

nixflix.notif.ntfy

ntfy notification definition for Starr services.

Typeopen submodule of attribute set of anything
Default 
{ }
Declared inmodules/notif/options.nix

nixflix.notif.ntfy.accessToken

Access token for the ntfy server.

Warning

Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use { _secret = path; } for sensitive data.

Typenull or string or (submodule)
Default 
null
Example 
{ _secret = "/run/secrets/secret-file"; }
Declared inmodules/notif/options.nix

nixflix.notif.ntfy.clickUrl

URL to open when the notification is clicked.

Typestring
Default 
""
Declared inmodules/notif/options.nix

nixflix.notif.ntfy.dependencies

systemd services that this integration depends on

Typelist of string
Default 
[ ]
Declared inmodules/notif/options.nix

nixflix.notif.ntfy.name

User-defined name for the notification instance.

Typestring
Default 
"ntfy.sh"
Declared inmodules/notif/options.nix

nixflix.notif.ntfy.password

Password for the ntfy server.

Warning

Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use { _secret = path; } for sensitive data.

Typenull or string or (submodule)
Default 
null
Example 
{ _secret = "/run/secrets/secret-file"; }
Declared inmodules/notif/options.nix

nixflix.notif.ntfy.priority

Priority of the notification.

Typeinteger between 1 and 5 (both inclusive)
Default 
3
Declared inmodules/notif/options.nix

nixflix.notif.ntfy.serverUrl

ntfy server URL.

Typestring
Default 
"https://ntfy.sh"
Declared inmodules/notif/options.nix

nixflix.notif.ntfy.services

Which Starr services to configure this notification on.

Typelist of string
Default 
[
  "sonarr"
  "sonarr-anime"
  "radarr"
  "lidarr"
]
Declared inmodules/notif/options.nix

nixflix.notif.ntfy.tags

Tags/emojis to include on the notification.

Typelist of string
Default 
[ ]
Declared inmodules/notif/options.nix

nixflix.notif.ntfy.topics

Topics to publish notifications to.

Typelist of string
Default 
[ ]
Declared inmodules/notif/options.nix

nixflix.notif.ntfy.username

Username for the ntfy server.

Warning

Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use { _secret = path; } for sensitive data.

Typenull or string or (submodule)
Default 
null
Example 
{ _secret = "/run/secrets/secret-file"; }
Declared inmodules/notif/options.nix