Jackett/README.md

103 lines
4.6 KiB
Markdown
Raw Normal View History

2015-08-25 20:30:32 +00:00
## Jackett
2015-10-29 20:07:11 +00:00
This project is a new fork and is recruiting development help. If you are able to help out please contact us.
2015-08-25 20:30:32 +00:00
Jackett works as a proxy server: it translates queries from apps (Sonarr, SickRage, CouchPotato, Mylar, etc) into tracker-site-specific http queries, parses the html response, then sends results back to the requesting software. This allows for getting recent uploads (like RSS) and performing searches. Jackett is a single repository of maintained indexer scraping & translation logic - removing the burden from other apps.
2015-11-18 20:02:35 +00:00
Developer note: The software implements the [Torznab](https://github.com/Sonarr/Sonarr/wiki/Implementing-a-Torznab-indexer) (with [nZEDb](https://github.com/nZEDb/nZEDb/blob/master/docs/newznab_api_specification.txt) category numbering) and [TorrentPotato](https://github.com/RuudBurger/CouchPotatoServer/wiki/Couchpotato-torrent-provider) APIs.
2015-11-18 20:00:26 +00:00
2015-08-25 20:30:32 +00:00
#### Supported Systems
* Windows using .NET 4.5
* Linux and OSX using Mono 4 (v3 should work but you may experience crashes).
2015-11-18 20:00:26 +00:00
#### Supported Private Trackers
2016-01-09 02:08:39 +00:00
* Abnormal
2015-11-18 20:00:26 +00:00
* AlphaRatio
* AnimeBytes
* Avistaz
* bB
* BeyondHD
* BIT-HDTV
* BitMeTV
2016-01-03 20:40:59 +00:00
* BitSoup
2015-11-18 20:00:26 +00:00
* BlueTigers
* BTN
2015-11-20 10:50:33 +00:00
* DanishBits
* Demonoid
2015-11-18 20:00:26 +00:00
* EuTorrents
* FileList
2016-01-05 14:33:13 +00:00
* French-ADN
2015-11-18 20:00:26 +00:00
* Freshon
* HD-Space
* HD-Torrents
2015-11-20 10:50:33 +00:00
* Hounddawgs
* ILoveTorrents
2015-11-18 20:00:26 +00:00
* Immortalseed
* IPTorrents
2015-11-20 10:50:33 +00:00
* MoreThanTV
* NCore
2015-11-18 20:00:26 +00:00
* NextGen
2016-03-29 21:54:19 +00:00
* PhxBit
2015-11-18 20:00:26 +00:00
* Pretome
* PrivateHD
2015-12-28 11:50:33 +00:00
* RevolutionTT
2015-11-18 20:00:26 +00:00
* SceneAccess
* SceneTime
* Shazbat
2015-11-20 10:50:33 +00:00
* SpeedCD
2015-11-18 20:00:26 +00:00
* TehConnection
* TorrentBytes
* TorrentDay
* TorrentLeech
* TorrentShack
* TV Chaos UK
2015-12-29 11:07:34 +00:00
* World-In-HD
2016-01-03 20:40:59 +00:00
* XSpeeds
2015-08-25 20:30:32 +00:00
2015-09-21 18:42:17 +00:00
#### Installation on Windows
We recommend you install Jackett as a Windows service using the supplied installer. When installed as a service the tray icon acts as a way to open/start/stop Jackett. If you opted to not install it as a service then Jackett will run its web server from the tray tool.
Jackett can also be run from the command line using JackettConsole.exe if you would like to see log messages (Ensure the server isn't already running from the tray/service).
2015-08-25 20:30:32 +00:00
#### Installation on Linux/OSX
1. Install [Mono 4](http://www.mono-project.com/download/) or better
2. Install libcurl:
* Debian/Ubunutu: apt-get install libcurl-dev
* Redhat/Fedora: yum install libcurl-devel
* For other distros see the [Curl docs](http://curl.haxx.se/dlwiz/?type=devel).
2015-11-10 18:08:28 +00:00
3. Download and extract the latest ```.tar.gz``` release from the [releases page](https://github.com/Jackett/Jackett/releases) and run Jackett using mono with the command "mono JackettConsole.exe".
Detailed instructions for [Ubuntu 14.x](http://www.htpcguides.com/install-jackett-on-ubuntu-14-x-for-custom-torrents-in-sonarr/) and [Ubuntu 15.x](http://www.htpcguides.com/install-jackett-ubuntu-15-x-for-custom-torrents-in-sonarr/)
2015-08-25 20:30:32 +00:00
2015-09-21 18:42:17 +00:00
#### Installation on Synology
2015-12-06 19:48:10 +00:00
Jackett is available as beta package from [SynoCommuniy](https://synocommunity.com/)
2015-08-25 20:30:32 +00:00
#### Troubleshooting
* Command line switches
You can pass various options when running via the command line, see --help for details.
* Unable to connect to certain trackers on Linux
Try running with the "--SSLFix true" if you are on Redhat/Fedora/NNS based libcurl. If the tracker is currently configured try removing it and adding it again. Alternatively try running with a different client via --UseClient (Warning: safecurl just executes curl and your details may be seen from the process list). You can also try running with the "--IgnoreSslErrors true" option which is useful if the site has an invalid SSL certificate.
2015-08-25 20:30:32 +00:00
* Enable logging
You can get additional logging with the switches "-t -l". Please post logs if you are unable to resolve your issue with these switches ensuring to remove your username/password/cookies.
2015-11-20 10:37:46 +00:00
#### Creating an issue
Please supply as much information about the problem you are experiencing as possible. Your issue has a much greater chance of being resolved if logs are supplied so that we can see what is going on. Creating an issue with '### isn't working' doesn't help anyone to fix the problem.
2015-10-02 16:58:58 +00:00
### Contributing
2015-11-18 20:00:26 +00:00
All contributions are welcome just send a pull request. Jackett's framework allows our team (and any other volunteering dev) to implement new trackers in an hour or two. If you'd like support for a new tracker but are not a developer then feel free to leave a request on the [issues page](https://github.com/zone117x/Jackett/issues). It is recommended to use Visual studio 2015 when making code changes in this project. We currently only support private trackers.
2015-08-25 20:30:32 +00:00
### Screenshots
2015-11-20 10:37:46 +00:00
![screenshot](http://i.imgur.com/t1sVva6.png "screenshot")