Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cardigann/cardigann

A proxy server for adding new indexers to Sonarr, SickRage and other media managers
https://github.com/cardigann/cardigann

Last synced: 3 months ago
JSON representation

A proxy server for adding new indexers to Sonarr, SickRage and other media managers

Host: GitHub
URL: https://github.com/cardigann/cardigann
Owner: cardigann
License: mit
Created: 2016-07-15T14:36:29.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2021-02-22T04:25:11.000Z (almost 4 years ago)
Last Synced: 2024-08-02T14:06:04.039Z (6 months ago)
Language: Go
Homepage:
Size: 49.3 MB
Stars: 443
Watchers: 29
Forks: 48
Open Issues: 194
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-pt - Cardigann

README

Cardigann [![Build Status](https://travis-ci.org/cardigann/cardigann.svg?branch=master)](https://travis-ci.org/cardigann/cardigann) [![Go Report Card](https://goreportcard.com/badge/github.com/cardigann/cardigann)](https://goreportcard.com/report/github.com/cardigann/cardigann) [![Gitter](https://badges.gitter.im/cardigann/cardigann.svg)](https://gitter.im/cardigann/cardigann?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge)
=========

**This project is looking for maintainers to help! Please see [#372](https://github.com/cardigann/cardigann/issues/372) for details.**

A server for adding extra indexers to Sonarr, SickRage and CouchPotato via [Torznab](https://github.com/Sonarr/Sonarr/wiki/Implementing-a-Torznab-indexer) and [TorrentPotato](https://github.com/CouchPotato/CouchPotatoServer/wiki/Couchpotato-torrent-provider) 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.

## Usage

Cardigann provides a cli tool for debugging and development:

```bash
cardigann query bithdtv t=tv-search "q=my show name" 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 `global.passphrase` in the [Configuration](#Configuration).

## Installation

Cardigann is distributed on equinox.io in a variety of formats for macOS, Linux and Windows.

https://dl.equinox.io/cardigann/cardigann/stable

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:

```bash
cardigann 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):

```bash
cardigann service install
cardigann service start
```

## Updating

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

Configuration is stored in a `config.json` file. It's searched for in a few different locations, in order of priority:

#### All Platforms
* `$CWD/config.json`
* `$CONFIG_DIR/config.json`

#### Linux/BSD:
* `$HOME/.config/cardigann/config.json`
* `/etc/xdg/cardigan/config.json`

#### OSX:
* `$HOME/Library/Preferences/cardigann/config.json`
* `/Library/Preferences/cardigann/config.json`
* `/Library/Application Support/cardigann/config.json`

#### Windows
* `%APPDATA%\cardigann\config.json`
* `%LOCALAPPDATA%\cardigann\config.json`

This configuration file will contain your tracker credentials in plain-text, so it's important to keep it secure.

## Definitions

Definitions are yaml files (see [definitions](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:

#### All Platforms
* `$CWD/definitions/`
* `$CONFIG_DIR/definitions/`

#### Linux/BSD:
* `$HOME/.config/cardigann/definitions/`
* `/etc/xdg/cardigann/definitions/`

#### OSX:
* `$HOME/Library/Preferences/cardigann/definitions/`
* `/Library/Preferences/cardigann/definitions/`
* `/Library/Application Support/cardigann/definitions/`

#### Windows
* `%APPDATA%\cardigann\definitions\`
* `%LOCALAPPDATA%\cardigann\definitions\`

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

## Supported Indexers

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.

### Public
* KickAssTorrent
* ThePirateBay (TPB)
* Torrentz2
* AvistaZ
* EZTV
* HDME

### Private
* Abnormal
* AlphaRatio
* BIT-HDTV
* BitMeTV
* Blu-bits
* BeyondHD
* CinemaZ
* DanishBits
* Demonoid
* EoT-Forum
* Ethor.net (Thor's Land)
* FileList
* FunFile
* HD-Torrents
* Immortalseed
* IPTorrents
* Metal-tracker.com
* MoreThanTV
* MyAnonamouse
* MySpleen
* NCore
* NetHD
* Norbits
* Orpheus (Apollo)
* PreToMe
* PrivateHD
* Redacted
* Speed.CD
* Sceneaccess
* SceneTime
* Shareisland
* The New Retro
* The Shinning
* Torrent Sector Crew
* Torrent-Syndikat
* Torrentbytes
* TorrentDay
* TorrentHeaven
* Torrentleech
* ToTheGlory
* UHDBits
* WorldOfP2P
* Xthor
* Transmithe.Net
* Tspate
* YggTorrent

### Dead
* AlphaReign
* Freshon
* HDArea
* 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.

## Development

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](https://medium.com/@patdhlk/how-to-install-go-1-8-on-ubuntu-16-04-710967aa53c9)):

```bash
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:

```bash
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs
```

### Setup for macOS

```bash
brew install golang node

export GOPATH=$HOME/go
export GOBIN=$HOME/go/bin
export PATH=$PATH:$GOBIN
```

### Installing cardigann

Golang needs things under a [`$GOPATH`](https://github.com/golang/go/wiki/SettingGOPATH) to work. Check you have one with `go env`. Mine is '$HOME/go'.

```bash
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 `$GOBIN` directory.

Finally, start your server!

```bash
cardigann server
```

## Reporting bugs

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][bug_report_template].

## Requests

* Start an issue on GitHub following one of these templates:
* [Feature request][feature_request_template]
* [Indexer/Tracker request][indexer_request_template]

## Questions? Wanna chat?

* If none of the templates above is appropriate, [open an issue](https://github.com/cardigann/cardigann/issues/new)
* Join us on [Gitter](https://gitter.im/cardigann/cardigann)

## Credits

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

[bug_report_template]: https://github.com/cardigann/cardigann/issues/new?title=Bug%20report%3A%20%5Bsummarise%20the%20issue%20here%5D&body=%23%23%23%20Issue%20experienced%0A%0A%23%23%23%20Steps%20to%20reproduce%0A%0A%23%23%23%20Cardigann%20version%20(in%20the%20footer%2C%20or%20via%20%60cardigann%20--version%60)%0A%0A%0A
[feature_request_template]: https://github.com/cardigann/cardigann/issues/new?title=Feature%20request%3A%20summarize%20the%20feature%20here&body=%0A%23%23%23%20Description%20of%20feature%2Fenhancement%0A%0A%23%23%23%20Justification%0A%0A%23%23%23%20Example%20use%20case
[indexer_request_template]: https://github.com/cardigann/cardigann/issues/new?title=Indexer%20Request%3A%20indexer%20title%20here&body=%23%23%23%20Indexer%20Name%0A%0A%23%23%23%20Is%20the%20indexer%20private%20or%20public%3F%20If%20private%2C%20can%20you%20provide%20an%20invite%3F%0A%0A%23%23%23%20Indexer%20URL%0A%0A%23%23%23%20Indexer%20language