tronyx/sonarrannounced repository overview

A Docker container for the SonarrAnnounced⁠ project from l3uddz⁠.

⁠sonarrAnnounced

Python script to notify sonarr of tracker announcements from IRC announce channels.

⁠Usage

Create the container:

docker create \
  --name=sonarrannounced \
  -v <path to data>:/config \
  -e PGID=<gid> -e PUID=<uid> \
  -e TZ=<timezone> \
  -p 3467:3467 \
  tronyx/sonarrannounced

Then start it:

docker start sonarrannounced

Docker-Compose:

sonarrannounced:
  container_name: sonarrannounced
  image: tronyx/sonarrannounced
  restart: on-failure
  environment:
    - "TZ=America/New_York"
  volumes:
    - "<path to data>:/config"
  ports:
    - "3467:3467"

⁠Setting up the application

1. After the initial run, the whole application will be in your <appData>/config directory.
2. You will need to edit the settings.cfg file with the required information for your Sonarr installation.
3. You will need to have at least one tracker configured in the settings.cfg before it will work.
4. After editing the settings.cfg you will need to restart the container.
5. Access the webUI at: <docker-host-ip>:3467

⁠Parameters

The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080. Browsing to http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.

• -p 3467 - the port(s)
• -v /config - sonarrannounced Application Data
• -e PGID for for GroupID - see below for explanation
• -e PUID for for UserID - see below for explanation
• -e TZ for timezone information, eg Europe/London

It is based on alpine-linux with S6 overlay, for shell access whilst the container is running do docker exec -it sonarrannounced /bin/bash.

⁠User / Group Identifiers

Sometimes when using data volumes (-v flags) permissions issues can arise between the host OS and the container. We avoid this issue by allowing you to specify the user PUID and group PGID. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" ™.

In this instance PUID=1001 and PGID=1001. To find yours use id user as below:

  $ id <dockeruser>
    uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)

⁠Info

• To monitor the logs of the container in realtime docker logs -f sonarrannounced.

⁠Version Log

• 2017-02-28: initial