1
0
Fork 0
mirror of https://github.com/Sonarr/Sonarr synced 2024-12-22 15:56:58 +00:00

Updated Implementing a Torznab indexer (markdown)

Taloth 2016-08-06 16:57:18 +02:00
parent 91e4699b45
commit e0f8bc00a1

@ -61,11 +61,12 @@ Implementing this mode is mandatory.
The caps response for torznab is mostly the same as newznab. However, newznab specifies a list of default categories. The caps response for torznab is mostly the same as newznab. However, newznab specifies a list of default categories.
It's recommended to keep those categories intact, Client applications can then query one of the defaults, instea It's recommended to keep those categories intact, Client applications can then query one of the defaults, instea
Many torrent sites have their own rss categories starting at '1', it's recommended not to map these 1 to 1 on newznab categories but instead add 100000 to the number. That way it falls in the site specific range and does not interfere with the original newznab categories. Many torrent sites have their own rss categories starting at '1', it's recommended not to map these 1 to 1 on newznab categories but instead add 100000 to the number. That way it falls in the site specific range and does not interfere with the original newznab categories.
The api should then alias all site-specific categories in one of the original newznab category. The api should then alias all site-specific categories in one of the original newznab category.
For example, if you have category 10 as Blu-Ray 1080p TV, then releases in that category would use the torznab api cats 100010,5040,5000 (Site-specific, TV/HD, TV). For example, if you have category 10 as Blu-Ray 1080p TV, then releases in that category would use the torznab api cats 100010,5040,5000 (Site-specific, TV/HD, TV).
Any query that includes any of those numbers in the `cat=` parameter would return those releases as results. Any query that includes any of those numbers in the `cat=` parameter would return those releases as results.
Of course it's also allowed to omit the site-specific categories entirely, and map only on newznab categories. Of course it's also allowed to omit the site-specific categories entirely, and map only on newznab categories.
A full list of default categories can be found in the References at the bottom of this page. A full list of default categories can be found in the References at the bottom of this page.
@ -121,11 +122,12 @@ Torznab defines a couple of attributes using the ```xmlns:torznab="http://torzna
I'm keeping the list in the reference linked below, but here is a table with the torrent-specific stuff: I'm keeping the list in the reference linked below, but here is a table with the torrent-specific stuff:
```<torznab:attr name="seeders" value="1"/>``` ```<torznab:attr name="seeders" value="1"/>```
All these attributes are optional, the bold ones are recommended. All these attributes are optional, the bold ones are recommended. Please note that this list consists of the attributes added to torznab, please check out the basic newznab attributes as well.
| Name | Type | Description | | Name | Type | Description |
|:---------------------|:--------|:-----------------------------------------------| |:---------------------|:--------|:-----------------------------------------------|
| type | string | series,movie,music,book (if unknown just omit) | | type | string | series,movie,music,book (if unknown just omit) |
| **size** | integer | size of the release in bytes |
| **tvdbid** | integer | id for thetvdb.com | | **tvdbid** | integer | id for thetvdb.com |
| rageid | integer | id for tvrage.com | | rageid | integer | id for tvrage.com |
| **tvmazeid** | integer | id for tvmaze.com | | **tvmazeid** | integer | id for tvmaze.com |