linuxserver/cardigann repository overview

undefined

The LinuxServer.io⁠ team brings you another container release featuring :-

• regular and timely application updates
• easy user mappings (PGID, PUID)
• custom base image with s6 overlay
• weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
• regular security updates

Find us at:

• Blog⁠ - all the things you can do with our containers including How-To guides, opinions and much more!
• Discord⁠ - realtime support / chat with the community and the team.
• Discourse⁠ - post on our community forum.
• Fleet⁠ - an online web interface which displays all of our maintained images.
• GitHub⁠ - view the source for all of our repositories.
• Open Collective⁠ - please consider helping us by either donating or contributing to our budget

⁠linuxserver/cardigann⁠

THIS IMAGE IS DEPRECATED. We will no longer be making updates or rebuilding this image. The Dockerhub endpoint will stay online with the current tags for this software. We recommend current users switch to linuxserver/jackett. 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.

⁠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

Container 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.

⁠Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

⁠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

⁠Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the Application Setup⁠ section above to see if it is recommended for the image.

Below are the instructions for updating containers:

⁠Via Docker Run/Create

• Update the image: docker pull linuxserver/cardigann
• Stop the running container: docker stop cardigann
• Delete the container: docker rm cardigann
• Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
• Start the new container: docker start cardigann
• You can also remove the old dangling images: docker image prune

⁠Via Docker Compose

• Update all images: docker-compose pull
  • or update a single image: docker-compose pull cardigann
• Let compose update all containers as necessary: docker-compose up -d
  • or update a single container: docker-compose up -d cardigann
• You can also remove the old dangling images: docker image prune

⁠Via Watchtower auto-updater (especially useful if you don't remember the original parameters)

• Pull the latest image at its tag and replace it with the same env variables in one run:

  docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  containrrr/watchtower \
  --run-once cardigann
  

  Copy

Note: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.

• You can also remove the old dangling images: docker image prune

⁠Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-cardigann.git
cd docker-cardigann
docker build \
  --no-cache \
  --pull \
  -t linuxserver/cardigann:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

⁠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