README
¶
This is the unified client for Notifiarr.com. Written in Go & Svelte; works on most operating systems.
Features
- Secure. Built with the safety of your data as top priority.
- Because we use it too.
- Beautiful and intuitive user interface.
- Service and network health checks and notifications.
- Trigger scripts and commands from Discord.
- Media requests from Discord.
- Sync TRaSH profiles to Radarr & Sonarr.
- Backup corruption checks for all starr applications.
- Scheduled system snapshot notifications.
- Scheduled media and downloads dashboard notifications.
- Scheduled URL polling to custom notifications.
- Scheduled Plex sessions notifications.
- Finished-watching notifications for Plex.
- Tautulli user map integration.
- Automated Plex trash emptying.
- Radarr collection gaps.
- MDBList and Radarr/Sonarr library syncing.
- Scheduler offloading for website tasks.
Installation
We maintain a wiki with the install instructions.
Configuration Information
The data that was once in this section is no longer super relevant, but can also be found in the wiki.
Troubleshooting
We have a client troubleshooting section in the wiki too.
Contributing
Join us on Discord and we can discuss.
License
MIT - Copyright (c) 2020-2025 Go Lift
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
src/api
command
Package main is used to generate the backend data model as typescript interfaces.
|
Package main is used to generate the backend data model as typescript interfaces. |
|
pkg
|
|
|
apps
Package apps provides the _incoming_ HTTP methods for notifiarr.com integrations.
|
Package apps provides the _incoming_ HTTP methods for notifiarr.com integrations. |
|
apps/apppkg/plex
Package plex provides the methods the Notifiarr client uses to interface with Plex.
|
Package plex provides the methods the Notifiarr client uses to interface with Plex. |
|
bindata
Package bindata provides file system assets to the running binary.
|
Package bindata provides file system assets to the running binary. |
|
checkapp
Package checkapp provides a suite of small procedures to check integration URLs and commands.
|
Package checkapp provides a suite of small procedures to check integration URLs and commands. |
|
client
Package client provides the low level assembly of the Notifiarr client application.
|
Package client provides the low level assembly of the Notifiarr client application. |
|
configfile
Package configfile handles all the base configuration-file routines.
|
Package configfile handles all the base configuration-file routines. |
|
logs
Package logs provides the low-level routines for directing log messages.
|
Package logs provides the low-level routines for directing log messages. |
|
logs/share
Package share is here so we can keep website cruft out of the logs package.
|
Package share is here so we can keep website cruft out of the logs package. |
|
mnd
Package mnd provides reusable constants for the Notifiarr application packages.
|
Package mnd provides reusable constants for the Notifiarr application packages. |
|
services
Package services provides service-checks to the notifiarr client application.
|
Package services provides service-checks to the notifiarr client application. |
|
snapshot
Package snapshot generates system reports and sends them to notifiarr.com.
|
Package snapshot generates system reports and sends them to notifiarr.com. |
|
triggers
Pcakage triggers provides a simple interface to setup all sub-module triggers.
|
Pcakage triggers provides a simple interface to setup all sub-module triggers. |
|
triggers/commands
package commands provides the interfaces and structures to trigger and run shell commands.
|
package commands provides the interfaces and structures to trigger and run shell commands. |
|
triggers/commands/cmdconfig
cmdconfig contains the input config for commands.
|
cmdconfig contains the input config for commands. |
|
triggers/crontimer
Package crontimer is used to kick off events on the website.
|
Package crontimer is used to kick off events on the website. |
|
triggers/endpoints
Package endpoints allows the user to configure a list of urls, along with cron schedules.
|
Package endpoints allows the user to configure a list of urls, along with cron schedules. |
|
triggers/endpoints/epconfig
Package epconfig contains the config input for the endpoints package.
|
Package epconfig contains the config input for the endpoints package. |
|
update
Package update checks for an available update on GitHub.
|
Package update checks for an available update on GitHub. |
Click to show internal directories.
Click to hide internal directories.