Skip to content

Notify Sonarr/Radarr/Lidarr of tracker IRC announcements.

Notifications You must be signed in to change notification settings

weannounce/arrnounced

 
 

Repository files navigation

Arrnounced

Notify Sonarr/Radarr/Lidarr of tracker IRC announcements.

Built on the work of sonarrAnnounced with tracker configuration from autodl-trackers (used by autodl-irssi)

Features

  • All trackers from autodl-trackers are supported.
  • Web UI to list announcements and accepted notifications
    • Ability to search among the announcements remains to be implemented though
  • Notify based on announcement category
  • Configurable delay between IRC announcement and notification

Only a few of the supported trackers are tested at the moment. Please report any issues you find.

Screenshots

Main page

Index Page

Status page

Status Page

Setup

Release v0.7 updated the configuration format. See the release notes for more information.

Configuration

The default configuration path is ~/.arrnounced/settings.toml. example.toml is the acting configuration documentation.

The default XML tracker configuration path is ~/.arrnounced/autodl-trackers/trackers

Installation

# Optional virtual environment
$ python -m venv path/to/venv
$ source path/to/venv/bin/activate

# Install
$ pip install arrnounced

# Run
$ arrnounced

Configuration files path as well as log and database location may be changed with command line arguments.

Docker

Arrnounced on dockerhub

  • You must provide settings.toml in /config. This is also where logs and the database will be stored.
  • To access the web UI using bridged network the webui host in settings.toml must be 0.0.0.0.
  • As Arrnounced runs as a non-root user by default it is recommended to specify your own user to handle write access to /config.
# Default example
docker run -v /path/to/settings:/config \
           --user 1000 \
           -p 3467:3467 weannounce/arrnounced:latest

The docker image comes with a snapshot of XML tracker configurations located under /trackers. If you prefer your own version you can mount over it.

# Example with custom XML tracker configs and verbose logging
docker run -v /path/to/settings:/config \
           -v /path/to/autodl-trackers/trackers:/trackers \
           -e VERBOSE=Y \
           --user 1000 \
           -p 3467:3467 weannounce/arrnounced:latest

Database design update

The database design was updated in v0.3 (ef931ee). If you used Arrnounced prior to this or used its predecessor you have two options.

  • Convert your old database using convert_db.py
  • Move the old database file for safe keeping and let Arrnounced create a new file.

The default path to the database is ~/.arrnounced/brain.db

About

Notify Sonarr/Radarr/Lidarr of tracker IRC announcements.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 81.7%
  • HTML 8.8%
  • CSS 5.7%
  • JavaScript 3.4%
  • Dockerfile 0.4%