Skip to content

matthewdias/kitsu-plex-scrobbler

Repository files navigation

Features/Constraints

  • Watches Plex log file for activity and submits to Kitsu
  • Supports kitsu, thetvdb and hama agents. (Use kitsu for best results)
  • thetvdb and hama agents require tvdb/anidb mappings for the media to exist in Kitsu's database
  • Must run on same machine as Plex Media Server

Run it

Running with Node.js
  1. Install PostgreSQL
  2. Create a database
  3. Install current Node.js
  4. Run npm install
  5. Set env vars and run npm start
Running with Docker
  1. Install Docker
  2. Set env vars and run docker-compose up
Env vars
Var Default Value Description Node Docker
PLEX_HOST http://localhost:32400 Plex Media Server host Optional Optional
(Docker for Mac/Windows users should set this to http://host.docker.internal:<plex port>)
PLEX_LOGS none Location of your Plex Media Server log files (instructions)
Common locations:
  • macOS: "~/Library/Logs/Plex Media Server"
  • Linux: "/var/lib/plexmediaserver/Library/Application Support/Plex Media Server/Logs"
  • Windows: "~\\AppData\\Local\\Plex Media Server\\Logs"
  • FreeBSD: "/usr/local/plexdata/Plex Media Server/Logs"
    Required Required
    PORT 8929 Port for web server to listen on Optional Optional
    DATABASE_URL postgres://postgres@localhost:5432/kitsu-plex-scrobbler Connection URL for your PostgreSQL database Optional Ignored
    POSTGRES_PORT 5434 Port for included PostgreSQL database to listen on Ignored Optional
    Setting env vars for a command
    • Unix/Bash-like Shell: VAR1="value 1" docker-compose up
    • Windows PowerShell: $env:VAR1 = "value 1"; docker-compose up

    Use it

    • After starting the scrobbler, navigate to http://localhost:<PORT> in your browser
    • Login with your Plex account credentials. Important: The owner of the Plex server must be the first to login
    • Configure settings (These will only apply when watching via your Plex account)
      • Choose which libraries you want to scrobble for your Plex account
      • Connect your Kitsu account
    • Watch something on Plex and your Kitsu library will be updated

    Screenshots

    Acknowledgements

    Thanks to

    About

    Update your Kitsu library from Plex

    Topics

    Resources

    Stars

    Watchers

    Forks

    Packages

    No packages published