@ -213,7 +218,8 @@ You can repeat this process for as many users as you like.
"blacklisted_max_year": 2019,
"blacklisted_min_runtime": 60,
"blacklisted_min_year": 2000,
"blacklisted_tmdb_ids": []
"blacklisted_tmdb_ids": [],
"rating_limit": ""
},
"shows": {
"disabled_for": [],
@ -286,6 +292,9 @@ You can repeat this process for as many users as you like.
"trakt": {
"client_id": "",
"client_secret": ""
},
"omdb": {
"api_key": ""
}
}
```
@ -299,8 +308,9 @@ You can repeat this process for as many users as you like.
},
```
`debug` - show debug messages.
- Default is `false` (keep it off unless your having issues).
`debug` - Toggle debug messages in the log. Default is `false`.
- Set to `true`, if you are having issues and want to diagnose why.
## Automatic
@ -308,7 +318,7 @@ Used for automatic / scheduled traktarr tasks.
Movies can be run on a separate schedule then from Shows.
_Note: These settings are only needed if you plan to use traktarr on a schedule (i.e. via manual/CLI command only); see [Usage](#usage)._
_Note: These settings are only needed if you plan to use traktarr on a schedule (vs just using it as a CLI command only; see [Usage](#usage))._
```json
"automatic": {
@ -318,27 +328,51 @@ _Note: These settings are only needed if you plan to use traktarr on a schedule
"interval": 24,
"popular": 3,
"trending": 2,
"watched": 2,
"played_all": 2,
"watchlist": {},
"lists": {}
"lists": {},
},
"shows": {
"anticipated": 10,
"interval": 48,
"popular": 1,
"trending": 2,
"watched_monthly": 2,
"played": 2,
"watchlist": {},
"lists": {}
}
},
```
`interval` - specify how often (in hours) to run traktarr task.
`interval` - Specify how often (in hours) to run traktarr task.
`anticipated`, `popular`, `trending`, `boxoffice` (movies only) - Specify how many items from each Trakt list to find.
`watched` - Adds items that are the most watched by unique Trakt users (mutliple viewings excluded).
`anticipated`, `popular`, `trending`, `boxoffice` (movies only) - specify how many items from each Trakt list to find.
- `watched` / `watched_weekly` - Most watched in the week.
`watchlist` - specify which watchlists to fetch (see explanation below)
- `watched_monthly` - Most watched in the month.
`lists` - specify which custom lists to fetch (see explanation below)
- `watched_yearly` - Most watched in the year.
- `watched_all` - Most watched of all time.
`played` - Adds items that are most the played items by Trakt users (mutliple viewings included).
- `played` / `played_weekly` - Most played in the week.
- `played_monthly` - Most played in the month.
- `played_yearly` - Most played in the year.
- `played_all` Most played of all time.
`watchlist` - Specify which watchlists to fetch (see explanation below).
`lists` - Specify which custom lists to fetch (see explanation below).
### Personal Watchlists
@ -466,40 +500,54 @@ Use filters to specify the movie/shows's country of origin or blacklist (i.e. fi
"blacklisted_max_year": 2019,
"blacklisted_min_runtime": 60,
"blacklisted_min_year": 2000,
"blacklisted_tmdb_ids": []
"blacklisted_tmdb_ids": [],
"rating_limit": ""
},
```
`disabled_for` - specify for which lists the blacklist must be disabled when running in automatic mode
`disabled_for` - Specify for which lists the blacklist is disabled for, when running in automatic mode.
Example:
- This is similar to running `--ignore-blacklist` via the CLI command.
```
"disabled_for": [
"anticipated",
"watchlist:user1",
"list:http://url-to-list"
],
```
- Example:
`allowed_countries` - only add movies from these countries.
```
"disabled_for": [
"anticipated",
"watchlist:user1",
"list:http://url-to-list"
],
```
`allowed_languages` - only add movies with these languages (default/blank=English).
`allowed_countries` - Only add movies from these countries. Listed as two-letter country codes.
- [List of available country codes](list_of_country_codes.md).
`allowed_languages` - Only add movies with these languages. Listed as two-letter language codes.
- By default, traktarr will only query movies in English. If you need to search for other languages (e.g. Japanese for anime), you must add those languages here.
- By default, traktarr will only query shows in English. If you need to search for other languages (e.g. Japanese for anime), you must add those languages here.
- Languages are in [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format (e.g. `ja` for Japanese.)
- [List of available language codes](list_of_language_codes.md).
`blacklist_title_keywords` - blacklist certain words in titles.
`blacklisted_genres` - blacklist certain genres.
`blacklisted_genres` - Blacklist certain genres.
- [List of available genres](list_of_movie_genres.md).
- For an updated list, visit [here](https://trakt.docs.apiary.io/#reference/genres/list/get-genres).
`blacklisted_max_year` - blacklist release dates after specified year.
`blacklisted_max_year` - Blacklist release dates after specified year.
`blacklisted_min_runtime` - blacklist runtime duration lower than specified time (in minutes).
`blacklisted_min_runtime` - Blacklist runtime duration lower than specified time (in minutes).
`blacklisted_min_year` - blacklist release dates before specified year.
`blacklisted_min_year` - Blacklist release dates before specified year.
`blacklisted_tmdb_ids` - blacklist certain movies with their TMDB IDs.
`blacklisted_tmdb_ids` - Blacklist certain movies with their TMDB IDs.
`rating_limit` - Only add movies above this Rotten Tomatoes score.
### Shows
@ -546,7 +594,10 @@ Example:
}
```
`disabled_for` - specify for which lists the blacklist must be disabled when running in automatic mode
`disabled_for` - Specify for which lists the blacklist is disabled for, when running in automatic mode.
- This is similar to running `--ignore-blacklist` via the CLI command.
Example:
@ -558,24 +609,33 @@ Example:
],
```
`allowed_countries` - only add shows from these countries.
`allowed_countries` - Only add shows from these countries. Listed as two-letter country codes.
`allowed_languages` - only add shows with these languages (default/blank=English).
- [List of available country codes](list_of_country_codes.md).
`allowed_languages` - Only add shows with these languages.
- By default, traktarr will only query shows in English. If you need to search for other languages (e.g. Japanese for anime), you must add those languages here.
- Languages are in [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format (e.g. `ja` for Japanese.)
`blacklisted_genres` - blacklist certain genres.
- [List of available language codes](list_of_language_codes.md).
`blacklisted_genres` - Blacklist certain genres.
- [List of available genres](list_of_show_genres.md).
- For an updated list, visit [here](https://trakt.docs.apiary.io/#reference/genres/list/get-genres).
`blacklisted_max_year` - blacklist release dates after specified year.
`blacklisted_max_year` - Blacklist release dates after specified year.
`blacklisted_min_runtime` - blacklist runtime duration lower than specified time (in minutes).
`blacklisted_min_runtime` - Blacklist runtime duration lower than specified time (in minutes).
`blacklisted_min_year` - blacklist release dates before specified year.
`blacklisted_min_year` - Blacklist release dates before specified year.
`blacklisted_networks` - blacklist certain network.
`blacklisted_networks` - Blacklist certain network.
`blacklisted_tvdb_ids` - blacklist certain shows with their TVDB IDs.
`blacklisted_tvdb_ids` - Blacklist certain shows with their TVDB IDs.
## Notifications
@ -603,13 +663,14 @@ Currently, only Pushover and Slack are supported. More will be added later.
},
```
`verbose` - toggle detailed notifications.
- Default is `true` (keep it off unless your having issues).
`verbose` - Toggle detailed notifications. Default is `true`.
- Set to `false`, if you want to reduce the amount of detailed notifications (e.g. the names of the movies/shows added vs just the total).
### Pushover
`app_token` and `user_token` - retrieve from Pushover.net.
`app_token` and `user_token` - Retrieve from Pushover.net.
You can specify a priority for the messages send via Pushover using the `priority` key. It can be any Pushover priority value (https://pushover.net/api#priority).
@ -618,7 +679,7 @@ _Note: The key name (i.e the name right under notifications) can be anything, bu
### Slack
`webhook_url` - webhook URL you get after creating an "Incoming Webhook" under "Custom Integrations".
`webhook_url` - Webhook URL you get after creating an "Incoming Webhook" under "Custom Integrations".
_Note: The key name (i.e the name right under notifications) can be anything, but the `"service":` must be exactly `"slack"`._
@ -665,7 +726,7 @@ Sonarr configuration.
`root_folder` - Root folder for TV shows.
`tags` - assign tags to shows based the network it airs on. More details on this below.
`tags` - Assign tags to shows based the network it airs on. More details on this below.
`url` - Sonarr's URL.
@ -726,9 +787,18 @@ Trakt Authentication info:
`client_id` - Fill in your Trakt API key (_Client ID_).
`client_secret` - Fill in your Trakt Secret key (_Client Scret_)
`client_secret` - Fill in your Trakt Secret key (_Client Secret_)
## OMDB
OMDB Authentication info:
```json
"omdb": {
"api_key":""
}
```
`api_key` - Fill in your OMDB API key (*This is only needed if you wish to use rating filtering on adding movies from command line/automatic*)
# Usage
## Automatic (Scheduled)
@ -739,7 +809,7 @@ To have traktarr get Movies and Shows for you automatically, on set interval, do
desimaniac
6 years ago
committed by
GitHub