This project is looking for maintainers to help! Please see #372 for details.
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.
Cardigann is implemented in golang, which means it's simply a single binary to execute/install, no runtime. Windows, Linux and OSX will be supported, although it should run on any platform that golang supports.
Cardigann provides a cli tool for debugging and development:
cardigann query bithdtv t=tv-search "q=my show name" ep=1 season=2
Or you can run the proxy server:
Once the server is running, visit http://localhost:5060 and configure via the web interface.
You can set a password requirement by either passing the
--passphrase flag to the server command, or by setting
global.passphrase in the Configuration.
Cardigann is distributed on equinox.io in a variety of formats for macOS, Linux and Windows.
Follow the instructions on the above to install the cardigann binary, and then you can run the following to run the server in the foreground:
At this point you can visit the web interface on http://localhost:5060.
If you want to run this service non-interactively, you can install it as a service (supports windows services, macOS launchd, linux upstart, systemv and systemd):
cardigann service install cardigann service start
Cardigann has an experimental upgrade-in-place feature using equinox.io:
cardigann update --channel=stable
If you like to live dangerously, you can update to the edge channel:
cardigann update --channel=edge
Configuration is stored in a
config.json file. It's searched for in a few different locations, in order of priority:
This configuration file will contain your tracker credentials in plain-text, so it's important to keep it secure.
Definitions are yaml files (see definitions for their source) that define how to login and search on an indexer. You can either use the included definitions or write your own. Definitions are loaded from the following directories:
Using with a Proxy
Currently either a SOCKS5 proxy like Privoxy or Tor can be used:
SOCKS_PROXY=localhost:1080 cardigann server
Or, an http proxy works too:
HTTP_PROXY=localhost:8080 cardigann server
If you are running as a service, you will need to manually edit the service files to set the environment.
Cardigann simply provides a format for describing how to log into and scrape the search results of various forums and sites. It is not endorsed by the various sites, nor is it intended for piracy. You are using Cardigann at your own risk.
- ThePirateBay (TPB)
- Apollo (XANAX)
- Ethor.net (Thor's Land)
- The New Retro
- The Shinning
- Torrent Sector Crew
- Torrent411 (T411)
I'm happy to add new trackers, please either open a new issue, or a pull request with whatever details you have for the tracker.
You will need Golang 1.7+ for the server component and NodeJS and NPM if you want to modify the user interface.
Setup for Linux (Ubuntu/Debian)
If you don't have Go already set up, follow these steps (or read this guide):
sudo apt-get install software-properties-common sudo add-apt-repository ppa:longsleep/golang-backports sudo apt-get update sudo apt-get install golang-go git export GOPATH=$HOME/go export GOBIN=$HOME/go/bin export PATH=$PATH:$GOBIN
If you want to edit the web interface, you will need Node setup:
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash - sudo apt-get install -y nodejs
Setup for macOS
brew install golang node export GOPATH=$HOME/go export GOBIN=$HOME/go/bin export PATH=$PATH:$GOBIN
Golang needs things under a
$GOPATH to work. Check you have one with
go env. Mine is '$HOME/go'.
mkdir -p $HOME/go/src/github.com/cardigann git clone https://github.com/cardigann/cardigann.git $HOME/go/src/github.com/cardigann cd $HOME/go/src/github.com/cardigann/cardigann make setup make build make install
This will have installed
cardigann into your
Finally, start your server!
Cardigann is new software, and relies on scraping indexers, so is inherently prone to breaking. We try and reply as quickly as possible, but please make sure before you report a bug that you've update to the latest version.
If the issue persists, file a bug.
Questions? Wanna chat?
Inspired by Jackett, or at least born of frustration with it always crashing and requiring a mono runtime.