Skip to content

README.md

Latest commit

 

History

History
108 lines (75 loc) · 8.26 KB

README.md

File metadata and controls

108 lines (75 loc) · 8.26 KB

Renamarr

codecov

Quick Start

docker

  1. Copy/Rename config.yml.example to config.yml
  2. Update config.yml as needed.
  3. Bring up app using provided docker-compose.yml

How it works

Renamarr

This job uses the Sonarr API/Radarr API to do the following

  • Iterate over all items (Movies or Series)
    • Checks if any items need to be renamed
    • Triggers a rename on any item that need be renamed
      • Series renames are batched up, for one rename call per series
      • Movie renames are initiated per movie.
        • Example, 1 movie, 2 files. There will be 2 rename API calls

Analyze Files

This config option is useful if you have audio/video codec information as part of your mediaformat, and you are transcoding files after import. This will initiate a rescan of the files in your library, so that the mediainfo will be updated. Then renamarr will come through and detect changes, and rename the files

Rename Folders (Sonarr Only)

This config option will rename series folders, when they no longer match your configured MediaFormat

  • uses /api/v3/series/{id}/folder endpoint to determine if the series folder requires an update
  • uses /api/v3/series/editor endpoint to update series rootFolderPath to it's current value
    • moving the folder in place
  • Series are processed in bulk at the end of the run, per root folder

Series Scanner (Sonarr Only)

This job uses the Sonarr API to do the following

  • Iterate over continuing series
    • If a series has an episode airing within config.sonarr[].series_scanner.hours_before_air
      • default value of 4, max value of 12
    • OR
    • An episode that has aired previously
    • With a title of TBA (excluding specials)
      • will trigger a series refresh, to hopefully pull new info from The TVDB

This should prevent too many API calls to the TVDB, refreshing individual series, hourly

Usage

The application runs immediately on startup, and then continue to schedule jobs every hour (+- 5 minutes) after the first execution.

Logs are always written to stdout.

File Logging

Set sonarr[].renamarr.log_to_file or radarr[].renamarr.log_to_file to true to enable per-instance log files. If the target log path is not writable, renamarr logs a warning to stdout and continues running without logging to file.

When enabled, logs for that instance are written under /logs using one of these paths:

  • sonarr/<name>.log
  • radarr/<name>.log

Don't forget to mount /logs outside the container to persist log files

To avoid permission issues when creating log files, set the user option in docker-compose to match the desired runtime UID/GID.

Logging Configuration and Defaults

Environment Variable Description Default
LOG_LEVEL Log level passed to Loguru for stdout and file sinks. INFO
LOG_ROTATION Rotation schedule passed to Loguru for file log rotation. 00:00
LOG_RETENTION Retention period passed to Loguru for rotated log files. 7 days

For more details on LOG_RETENTION or LOG_ROTATION values, see the official documentation

Configuration

Name Type Required Default Value Description
sonarr Array Yes [] One or more sonarr instances
sonarr[].name string Yes N/A user friendly instance name, used in log messages
sonarr[].url string Yes N/A url for sonarr instance
sonarr[].api_key string Yes N/A api_key for sonarr instance
sonarr[].series_scanner.enabled boolean No False enables/disables series_scanner functionality
sonarr[].series_scanner.hourly_job boolean No False disables hourly job. App will exit after first execution
sonarr[].series_scanner.hours_before_air integer No 4 The number of hours before an episode has aired, to trigger a rescan when title is TBA
sonarr[].renamarr.enabled boolean No False enables/disables renamarr functionality
sonarr[].renamarr.hourly_job boolean No False disables hourly job. App will exit after first execution
sonarr[].renamarr.analyze_files boolean No False This will initiate a rescan of the files in your library. This is helpful if you are transcoding files, and the audio/video codecs have changed.
sonarr[].renamarr.rename_folders boolean No False This will rename series folders when the current series folder no longer matches your MediaFormat
sonarr[].renamarr.log_to_file boolean No False writes logs for this Sonarr instance to /logs/sonarr/<name>.log with daily rotation
radarr[].renamarr.enabled boolean No False enables/disables renamarr functionality
radarr[].renamarr.hourly_job boolean No False disables hourly job. App will exit after first execution
radarr[].renamarr.analyze_files boolean No False This will initiate a rescan of the files in your library. This is helpful if you are transcoding files, and the audio/video codecs have changed.
radarr[].renamarr.log_to_file boolean No False writes logs for this Radarr instance to /logs/radarr/<name>.log with daily rotation

Local Development

See Local Development for local development requirements, environment details, and startup commands.