cardigann

README

Cardigann

Provides Torznab and TorrentPotato interfaces for private torrent trackers.

Cardigann can be used to add any supported private tracker to your software of choice (e.g Sonarr, SickRage, CouchPotato). This is done by proxying requests to the individual trackers and scraping the responses and converting them to the correct format. The rules for scraping sites is expressed in a custom YAML format to make updating it easy without having to write code.

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.

Usage

Cardigann provides a cli tool for debugging and development:

cardigann query bithdtv t=tv-search "q=mr robot" ep=1 season=2

Or you can run the proxy server:

cardigann 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 a password in the global config file.

Configuration

Config is stored in a config.json file that is read from the current directory or your user level config dir (e.g $HOME/.config in linux). Tracker credentials will be stored here, but you can also set the following keys:

Key	Values
apikey	A 16 character hex value

Installation

Cardigann is distributed as a binary and a collection of tracker definition files. These are available from the releases page for macOS, Linux and Windows. The following example shows how to run the daemon interactively under Linux:

curl https://github.com/cardigann/cardigann/releases/download/(VERSION)/cardigann-linux-amd64 
chmod +x cardigann-linux-amd64 
curl https://github.com/cardigann/cardigann/releases/download/(VERSION)/defs.zip
unzip defs.zip
./cardigann-linux-amd64 server

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-linux-amd64 service install
./cardigann-linux-amd64 service start

Supported Trackers

• BIT-HDTV
• IPTorrents
• Freshon
• Demonoid
• HD-Torrents
• BeyondHD
• FileList

Planned Trackers

I'd love assistance adding these trackers, either via invites or pull-requests.

• Abnormal
• AlphaRatio
• AnimeBytes
• Avistaz
• bB
• BitMeTV
• BitSoup
• BlueTigers
• BTN
• DanishBits
• EuTorrents
• Fuzer
• HD-Space
• Hebits
• Hounddawgs
• ILoveTorrents
• Immortalseed
• PassThePopcorn
• MoreThanTV
• MyAnonamouse
• NCore
• NextGen
• Pretome
• PrivateHD
• RevolutionTT
• SceneAccess
• SceneFZ
• SceneTime
• Shazbat
• SpeedCD
• TehConnection
• TorrentBytes
• TorrentDay
• TorrentLeech
• TorrentShack
• TransmitheNet
• TV Chaos UK
• World-In-HD
• XSpeeds
• Xthor

Credits

Inspired by Jackett, or at least born of frustration with it always crashing and requiring a mono runtime.