DEPRECATION NOTICE¶

This image is deprecated. We will not offer support for this image and it will not be updated. We recommend current users switch to linuxserver/jackett.

linuxserver/cardigann¶

Cardigann a server for adding extra indexers to Sonarr, SickRage and CouchPotato via Torznab and TorrentPotato proxies. Behind the scenes Cardigann logs in and runs searches and then transforms the results into a compatible format.

Supported Architectures¶

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling linuxserver/cardigann should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Usage¶

Here are some example snippets to help you get started creating a container from this image.

docker¶

docker create \
  --name=cardigann \
  -e PUID=1000 \
  -e PGID=1000 \
  -e SOCKS_PROXY=IP:PORT \
  -e HTTP_PROXY=IP:PORT \
  -p 5060:5060 \
  -v <path to data>:/config \
  --restart unless-stopped \
  linuxserver/cardigann

docker-compose¶

Compatible with docker-compose v2 schemas.

---
version: "2"
services:
  cardigann:
    image: linuxserver/cardigann
    container_name: cardigann
    environment:
      - PUID=1000
      - PGID=1000
      - SOCKS_PROXY=IP:PORT
      - HTTP_PROXY=IP:PORT
    volumes:
      - <path to data>:/config
    ports:
      - 5060:5060
    restart: unless-stopped

Parameters¶

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)¶

Environment Variables (-e)¶

Volume Mappings (-v)¶

User / Group Identifiers¶

When using 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 any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Application Setup¶

Access the webui at <your-ip>:5060, for more information check out Cardigann.

By adding a variable to the run command, SOCKS_PROXY or HTTP_PROXY cardigann can be used with a proxy, eg -e SOCKS_PROXY=localhost:1080

The folder /config/definitions can be used to add additional tracker definitions (for more info see Additional definitions ).

Support Info¶

• Shell access whilst the container is running:
• docker exec -it cardigann /bin/bash
• To monitor the logs of the container in realtime:
• docker logs -f cardigann
• Container version number
• docker inspect -f '{{ index .Config.Labels "build_version" }}' cardigann
• Image version number
• docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/cardigann

Versions¶

• 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
• 01.02.19: - Multi arch images and pipeline build logic
• 14.01.19: - Add multi arch and pipeline logic
• 22.08.18: - Rebase to alpine 3.8
• 06.05.18: - Use buildstage in Dockerfile
• 06.12.17: - Rebase to alpine 3.7
• 12.08.17: - Add npm install to build stage
• 25.05.17: - Rebase to alpine 3.6
• 07.02.17: - Rebase to alpine 3.5
• 03.11.16: - Compiled using sstamoulis' method
• 01.11.16: - Initial Release