Installation

Overr-Syncerr does NOT have a web UI and instead prints messages in the log of the container in Docker.

Docker

It's recommended that you use docker-compose for setting up Overr-Syncerr.

Docker Compose

Installation:

Define the overr-syncerr service in your docker-compose.yml as follows:

services:
  overr-syncerr:
    image: gsariev/overr-syncerr:latest
    container_name: overr-syncerr
    ports:
      - "8089:8089"
    environment:
    
      BAZARR_API_KEY: "YOUR_BAZARR_API_KEY"
      BAZARR_URL: "http://BAZARR_IP:BAZARR_PORT/api"
      
      RADARR_API_KEY: "YOUR_RADARR_API_KEY"
      RADARR_URL: "http://RADARR_IP:RADARR_PORT/api/v3"
      
      SONARR_API_KEY: "YOUR_SONARR_API_KEY"
      SONARR_URL: "http://SONARR_IP:SONARR_PORT/api/v3"
      
      BAZARR_4K_API_KEY: "YOUR_BAZARR_4K_API_KEY"
      BAZARR_4K_URL: "http://BAZARR_4K_IP:BAZARR_4K_PORT/api"
      
      RADARR_4K_API_KEY: "YOUR_RADARR_4K_API_KEY"
      RADARR_4K_URL: "http://RADARR_4K_IP:RADARR_4K_PORT/api/v3"
      
      SONARR_4K_API_KEY: "YOUR_SONARR_4K_API_KEY"
      SONARR_4K_URL: "http://SONARR_4K_IP:SONARR_4K_PORT/api/v3"

      # Enter your Jellyseerr API Key and URL instead if using Jellyseerr
      OVERSEERR_API_KEY: "YOUR_OVERSEERR_API"
      OVERSEERR_URL: "http://YOUR_OVERSEERR_URL:OVERSEERR_PORT/api/v1"

      PLEX_TOKEN: "YOUR_PLEX_TOKEN"
      PLEX_HOST: "http://YOUR_PLEX_SERVER_URL:PLEX_SERVER_PORT"

      #Library names for getting library IDs and adding user-label to media. Example below:
      ANIME_LIBRARY_NAME: "Anime"
      MOVIES_LIBRARY_NAME: "Movies"
      SERIES_LIBRARY_NAME: "Series"

      #Optional auto-labeling of requested media in Plex using requester username
      #Default is set to 'false'
      ENABLE_MEDIA_AVAILABLE_HANDLING: false
      
      #Monitor partially available series requests (optional)
      MONITOR_REQUESTS: true
      
      #How often to check for partially available series requests (in seconds)
      CHECK_REQUEST_INTERVAL: 900

      PORT: 8089
      
      #Map specific keywords to your subtitle languages. Examples below:
      LANGUAGE_MAP: '{"da":"Danish",
      "en":"English",
      "bg":"Bulgarian",
      "dansk":"Danish",
      "english":"English",
      "danske":"Danish",
      "eng":"English"}'

      SYNC_KEYWORDS: '["sync", "out of sync", "messed up", "synchronization"]' # Replace with your actual sync keywords
      
      ADD_LABEL_KEYWORDS: '["add to library", "jeg vil se", "tilføj til bibliotek", "tilføj"]'
      
      ####### GPT TRANSLATION - IGNORE IF NOT USING
      ENABLE_GPT: false
      MODEL_GPT: "gpt-4o" # Use your preffered model
      OPEN_AI_API_KEY: "YOU_OPENAI_API_KEY"
      MAX_REQUEST_BYTES: 2000 # The amount of information send with each requests.
      MAX_TOKENS: 4000 # Max tokens for the chosel GPT model
      CHUNK_OVERLAP: 2  # Overlap of one subtitle line between chunks
      REQUEST_DELAY: 2 # Delay between server requests in seconds
      
      MOVIE_PATH_MAPPING: M:\Movies # Map to match the Bazarr path to your movies
      TV_PATH_MAPPING: M:\TV # Map to match the Bazarr path to your series 
      
    volumes:
      - M:\Movies:/mnt/movies
      - M:\TV:/mnt/tv
     ####### END OF GPT TRANSLATION
      
      restart: unless-stopped

Start all services defined in the Compose file:

Updating:

Pull the latest image:

docker-compose pull overr-syncerr

Restart all services defined in the Compose file:

docker-compose up -d

You can also use Watchtower or Ouroboros to keep Overr-Syncerr up-to-date automatically.

Docker CLI

Installation:

For details on the Docker CLI, please review the official docker run documentation.

docker run -d \
  --name overr-syncerr \
  -p 8089:8089 \
  -e BAZARR_API_KEY="YOUR_BAZARR_API_KEY" \
  -e BAZARR_URL="http://BAZARR_IP:BAZARR_PORT/api" \
  -e RADARR_API_KEY="YOUR_RADARR_API_KEY" \
  -e RADARR_URL="http://RADARR_IP:RADARR_PORT/api/v3" \
  -e SONARR_API_KEY="YOUR_SONARR_API_KEY" \
  -e SONARR_URL="http://SONARR_IP:SONARR_PORT/api/v3" \
  -e BAZARR_4K_API_KEY="YOUR_BAZARR_4K_API_KEY" \
  -e BAZARR_4K_URL="http://BAZARR_4K_IP:BAZARR_4K_PORT/api" \
  -e RADARR_4K_API_KEY="YOUR_RADARR_4K_API_KEY" \
  -e RADARR_4K_URL="http://RADARR_4K_IP:RADARR_4K_PORT/api/v3" \
  -e SONARR_4K_API_KEY="YOUR_SONARR_4K_API_KEY" \
  -e SONARR_4K_URL="http://SONARR_4K_IP:SONARR_4K_PORT/api/v3" \
  -e OVERSEERR_API_KEY="YOUR_OVERSEERR_API" \
  -e OVERSEERR_URL="http://YOUR_OVERSEERR_URL:OVERSEERR_PORT/api/v1" \
  -e PLEX_TOKEN="YOUR_PLEX_TOKEN" \
  -e PLEX_HOST="http://YOUR_PLEX_SERVER_URL:PLEX_SERVER_PORT" \
  -e ANIME_LIBRARY_NAME="Anime" \
  -e MOVIES_LIBRARY_NAME="Movies" \
  -e SERIES_LIBRARY_NAME="Series" \
  -e ENABLE_MEDIA_AVAILABLE_HANDLING=false \
  -e PORT=8089 \
  -e LANGUAGE_MAP='{"da":"Danish","en":"English","bg":"Bulgarian","dansk":"Danish","english":"English","danske":"Danish","eng":"English"}' \
  -e SYNC_KEYWORDS='["sync", "out of sync", "messed up", "synchronization"]' \
  -e ADD_LABEL_KEYWORDS='["add to library", "jeg vil se", "tilføj til bibliotek", "tilføj"]' \
  --restart unless-stopped \
  gsariev/overr-syncerr:latest

You can also use Watchtower or Ouroboros to keep Overr-Syncerr up-to-date automatically.

Windows

Refer to the Docker Desktop for Windows user manual for details on how to install Docker on Windows with WSL2.

Once you've installed Docker Desktop, you can create a docker-compose.yml file in a directory of your choosing and run it.

Unraid

No Unraid template is available.