readme-vars.yml

project_name: cardigann
project_url: "https://github.com/cardigann/cardigann"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/cardigann.png"
project_blurb: |
  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.
  [{{ project_name|capitalize }}]({{ project_url }}) 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.
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"

# supported architectures
available_architectures:
  - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
  - { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"}

# container parameters
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - { vol_path: "/config", vol_host_path: "<path to data>", desc: "Cardigann config" }
param_usage_include_ports: true
param_ports:
  - { external_port: "5060", internal_port: "5060", port_desc: "The port for the Cardigann webinterface" }
param_usage_include_env: true
param_env_vars:
  - { env_var: "SOCKS_PROXY", env_value: "IP:PORT", desc: "for using a socks proxy (optional)"}
  - { env_var: "HTTP_PROXY", env_value: "IP:PORT", desc: "for using a HTTP proxy (optional)"}

# application setup block
app_setup_block_enabled: true
app_setup_block: |
  Access the webui at `<your-ip>:5060`, for more information check out [{{ project_name|capitalize }}]({{ project_url }}).

  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](https://github.com/cardigann/cardigann#definitions) ).
# changelog
changelogs:
  - { date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." }
  - { date: "01.02.19:", desc: "Multi arch images and pipeline build logic" }
  - { date: "14.01.19:", desc: "Add multi arch and pipeline logic" }
  - { date: "22.08.18:", desc: "Rebase to alpine 3.8" }
  - { date: "06.05.18:", desc: "Use buildstage in Dockerfile" }
  - { date: "06.12.17:", desc: "Rebase to alpine 3.7" }
  - { date: "12.08.17:", desc: "Add npm install to build stage" }
  - { date: "25.05.17:", desc: "Rebase to alpine 3.6" }
  - { date: "07.02.17:", desc: "Rebase to alpine 3.5" }
  - { date: "03.11.16:", desc: "Compiled using [sstamoulis'](https://github.com/sstamoulis) method" }
  - { date: "01.11.16:", desc: "Initial Release" }