Configuration

Services

Leave the '4K' environmental variables as is if running only one instance of either Radarr, Sonarr or Bazarr.

Overr-Syncerr supports 2 instances of each Radarr, Sonarr and Bazarr service - 4K and non-4K.

The examples below focus on the non-4K, but the process is the same in both cases.

Radarr

Configuration:

Replace the placeholder text with your Radarr instance IP address and API key.

You can find your API key navigating to Settings -> General -> API Keyin you Radarr instance.

RADARR_API_KEY: "YOUR_RADARR_API_KEY"
RADARR_URL: "http://RADARR_IP:RADARR_PORT/api/v3"

Ensure that you have entered the correct information, especially the URL.

Examples:

RADARR_URL: "http://192.168.0.101:7878/api/v3"

RADARR_URL: "http://192.168.0.101:7878/"

Sonarr

Configuration:

Replace the placeholder text with your Sonarr instance IP address and API key.

You can find your API key navigating to Settings -> General -> API Keyin you Sonarr instance.

SONARR_API_KEY: "YOUR_RADARR_API_KEY"
SONARR_URL: "http://RADARR_IP:RADARR_PORT/api/v3"

Ensure that you have entered the correct information, especially the URL.

Examples:

SONARR_URL: "http://192.168.0.101:7878/api/v3"

SONARR_URL: "http://192.168.0.101:7878/"

Bazarr

Configuration:

Replace the placeholder text with your Bazarr instance IP address and API key.

You can find your API key navigating to Settings -> General -> API Keyin you Bazarr instance.

BAZARR_API_KEY: "YOUR_RADARR_API_KEY"
BAZARR_URL: "http://RADARR_IP:RADARR_PORT/api/v3"

Ensure that you have entered the correct information, especially the URL.

Examples:

BAZARR_URL: "http://192.168.0.101:6767/api"

BAZARR_URL: "http://192.168.0.101:6767/"

Overseerr / Jellyseerr

Configuration:

Replace the placeholder text with either your Overrseerr or Jellyseerr instance IP address and API key.

You can find your API key navigating to Settings -> General -> API Keyin you Overseerr/Jellyseerr instance.

OVERSEERR_API_KEY: "YOUR_OVERSEERR_API"
OVERSEERR_URL: "http://YOUR_OVERSEERR_URL:OVERSEERR_PORT/api/v1"

Ensure that you have entered the correct information, especially the URL.

Examples:

OVERSEERR_URL: "http://192.168.0.101:5055/api/v1"

OVERSEERR_URL: "http://192.168.0.101:5055/"

Plex

You have to provide a valid Plex token, which can be found by following the Finding an authentication token / X-Plex-Token guide.

The token will be used to communicate with your Plex server for fething your librairy IDs and adding labels to media.

Plex Libraries (labelling)

Overr-Syncerr assumes that you have the following library layout:

• Movies

• TV

• Anime

Replace the library placeholder names in the docker-compose with the names of your own libraries.

Language Map

The language map is used to associate keywords to your 'Subtitle Language' profile in Bazarr to communicate which subtitle language needs to be synced or translated. Using the provided language map as example, add your own keywords and languages. You can add as many keywords as needed.

You can't map a language that is not already present in your language profile in Bazarr.

Keywords

Sync

In order to send a 'sync' request to Bazarr, Overr-Syncerr will look for any of the following keywords in message contained in the payload.

Using the provided list as example, create your own list of 'sync' keywords:

SYNC_KEYWORDS: '["sync", "out of sync", "messed up", "synchronization"]'

User-Label

This is an optional function and requires that you've entered your Plex server URL and Token.

Users can request their user-label to be added to an already available media in Overseerr/Jellyseerr.

This is useful, if you're someone that wants to create a more personalised experience for your users by having them see only the media they've requested in Plex with the use of labels. If a user wants to see media that has been requested by another user, they can add their label to that media and have it accessible to them within seconds.

Use the example below to create your own keywords that will tigger the 'Add User-Label' logic:

ADD_LABEL_KEYWORDS: '["add to library", "jeg vil se", "tilføj til bibliotek", "tilføj"]'

Labelling

Labels are used in this case to personalize the user experience by displaying only the media that the user has specifically requested.

This would require the server owner to set viewing restrictions to users adding their username as a label in the 'Allow only label' field located in Manage Library Access -> <Username> -> Restrictions -> Movies / TV Shows.

If you have another use case in mind, then the aformendioned viewing restrction setting can be ignored.

Request Monitoring & Media Availability (Optional)

Overr-Syncerr can auto-label media with the username of the requester and can also enable users to add their User-Label to media that's been requested by another users and is available in your library.

There are two types of 'auto-abelling': Media Available and Request Monitoring

Media Available

Will trigger once Overseerr/Jellyseerr has picked up the media as being available on the Plex server and apply the lable to it. This function is disabled by default and can be enabled by changing the Media Available variable to 'true'.

ENABLE_MEDIA_AVAILABLE_HANDLING: true

Request Monitoring

Will trigger at a given interval, scan all requests for ones that are either available or partially available and apply the label of the requester if missing. This functions is useful in the case where series are missing episodes in a requested season, which doesn't trigger the 'Media Available' response from Overseerr/Jellyseerr as it technically isn't; however, the episodes will still appear in your Plex library (unlabeled). This is especially true when there are unaired episodes in a season.

To have the labels being automatically added, enable the 'MONITOR_REQUEST' function and set an interval (in seconds) for how often you'd like Overr-Syncerr to check the status of your requests by using 'CHECK_REQUEST_INTERVAL'.

MONITOR_REQUESTS: true
CHECK_REQUEST_INTERVAL: 900 #interval set to 15 min

Request Monitoring runs every X amount of seconds, while Media Available is triggered as soon as the media is marked as such in Overseerr/Jellyseerr.

Webhook

To finish configuring Overr-Syncer, do the following in Overseerr/Jellyseerr:

1. Settings -> Notifications -> Webhook

2. Enable the webhook agent and paste the webhook URL http://your-ip-address:your-port/ into the Webhook URL field

3. Make sure 'Issue Reported' is ticked

   1. If you have enabled 'auto-labelling', make sure 'Request Available' is ticked as well

4. Test the webhook agent

   1. If you get a 'Webhook test notification sent!' response, they everything is correctly configured

5. Save