Plex-Meta-Manager/docs/config/trakt.md

58 lines
2.3 KiB
Markdown
Raw Normal View History

2023-11-06 20:38:00 +00:00
---
search:
boost: 3
---
2022-03-08 08:06:22 +00:00
# Trakt Attributes
Configuring [Trakt.tv](https://trakt.tv/) is optional but is required for Trakt based collections to function.
A `trakt` mapping is in the root of the config file.
Below is a `trakt` mapping example and the full set of attributes:
```yaml
trakt:
client_id: ################################################################
client_secret: ################################################################
2022-03-24 14:10:27 +00:00
pin:
2022-03-08 08:06:22 +00:00
authorization:
access_token:
token_type:
expires_in:
refresh_token:
scope:
created_at:
```
2023-12-13 21:44:44 +00:00
| Attribute | Allowed Values | Default | Required |
|:----------------|:--------------------------------|:--------|:------------------------------------------:|
| `client_id` | Trakt Application Client ID | N/A | :fontawesome-solid-circle-check:{ .green } |
| `client_secret` | Trakt Application Client Secret | N/A | :fontawesome-solid-circle-check:{ .green } |
| `pin` | Trakt Pin | None | :fontawesome-solid-circle-xmark:{ .red } |
2022-03-08 08:06:22 +00:00
2023-11-06 20:38:00 +00:00
* All other attributes will be filled in by Plex Meta Manager.
2022-03-08 08:06:22 +00:00
2023-12-31 16:45:00 +00:00
To connect to Trakt.tv you must create a Trakt application and supply Plex Meta Manager the `client_id`,
`client_secret`, and `pin` provided, please do the following:
1. [Click here to create a Trakt API application.](https://trakt.tv/oauth/applications/new)
2. Enter a `Name` for the application.
3. Enter `urn:ietf:wg:oauth:2.0:oob` for `Redirect uri`.
4. Click the `SAVE APP` button.
5. Record the `Client ID` and `Client Secret` as `client_id` and `client_secret` in your Configuration File.
6. Click the Green Authorize Button next to the Redirect URI
2022-04-01 06:39:23 +00:00
2023-12-31 16:45:00 +00:00
![Trakt Authorize](images/trakt.png)
2022-03-08 08:06:22 +00:00
7. Record the `PIN` as `pin` in your Configuration File.
???+ warning
Run Plex Meta Manager shortly after obtaining your PIN; the PIN may expire at some point.
2022-11-16 14:30:04 +00:00
## Online Authorization
2022-11-16 14:30:04 +00:00
2023-12-31 16:45:00 +00:00
Plex Meta Manager requires interactive mode to be able to enter the Client ID and Client Secret. Some systems (namely
NAS) make this difficult to accomplish. Chazlarson has provided an online tool to generate the MAL and Trakt
authentication outside of Plex Meta Manager and then paste the end-result directly into the configuration file.
2022-11-16 14:30:04 +00:00
The tool can be found [here](auth.md).