Skip to content

Trakt Attributes

Configuring Trakt.tv is optional but is required for Trakt based collections to function.

A trakt mapping is in the root of the config file, sampled below.

config.yml Trakt sample
trakt:
  client_id: 1a2b3c4d5e6f7g8h9i
  client_secret: 1a12b23c34d45e56f6
  pin:
  authorization:
    access_token: 4cc355t0k3nh3r3
    token_type: Bearer
    expires_in: 1928374655
    refresh_token: r3fr35ht0k3nh3r3
    scope: public 
    created_at: 137946258
Attribute Description Allowed Values (default in bold) Required
client_id Trakt application client ID. Any valid ID or leave blank
client_secret Trakt application client secret. Any valid secret or leave blank
pin Trakt PIN. PIN string or leave blank

All other attributes will be filled in by Kometa as part of the authentication process*

Trakt Authentication

To connect to Trakt.tv you must create a Trakt application and supply Kometa the client_id,client_secret, and pin provided, please do the following:

  1. Click here to create a Trakt API application.
  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.

    Trakt Authorize

  7. Record the PIN as pin in your Configuration File.

Warning

Run Kometa shortly after obtaining your PIN; the PIN may expire at some point.

Online Authorization

When trying to authorize Trakt or MyAnimeList, Kometa needs to run in interactive mode so that you can enter details. This is problematic on some setups [namely docker] where entering interactive mode is not always simple.

These scripts allow you to authorize Trakt and MyAnimeList here on the wiki. Once authorized, the script will give you a YAML block that you will copy into the config.yml, replacing the existing trakt and/or myanimelist sections.

The source code for these scripts can be found on the Trakt-MAL-OAuth Repository.

Usage

  1. Enter client ID and secret.
  2. For Trakt, if you didn't retrieve a PIN yourself less than ten minutes ago, click the button, and enter the PIN in the field.
  3. For MyAnimeList, click the button to authenticate and get the required "localhost URL".
  4. Click "Submit".
  5. Copy and paste the result into your Kometa config.

Running the Authentication Scripts Locally

For users who want full control over the scripts and would prefer the run them locally, you can run the script in docker or python by following the instructions in the Trakt-MAL-OAuth Repository.

Click for instructions on how to run the scripts locally

Ensure you have downloaded a copy of the Trakt-MAL-OAuth Repository. If you have downloaded the ZIP file, extract it to your desired location.

python3 -m venv kometa-auth-venv
. kometa-auth-venv/bin/activate
python -m pip install -r requirements.txt

Running in Docker

  1. build the image with docker build -t kometa-auth-image .
  2. run the container with docker run --rm kometa-auth-image
  3. If you get a message complaining that something else is already running on port 5000, run the container with docker run --rm -p 5001:5000 kometa-auth-image
  4. go to http://127.0.0.1:5000 OR http://127.0.0.1:5001.
  5. see instructions above

Running in Python

  1. Make sure you are running a recent Python [this was developed on Python 3.11]
  2. Run these commands to create a virtual environment and install requirements.
  3. run the script with python app.py
  4. If you get a message complaining that something else is already running on port 5000, open app.py and change the 5000 on the last line to 5001; repeat step 3.
  5. go to http://127.0.0.1:5000 OR http://127.0.0.1:5001.
  6. see instructions above

Docker or the already deployed version are recommended.