mediasorter.yml.sample

---
# Example configuration file for mediasorter
# Copy this sample to /etc/mediasorter/mediasorter.yml and replace the various attributes
# with the values for your environment. For more details please see the README.

mediasorter:

    # Logging configuration
    logging:

        # Enable or disable file logging
        file: true

        # Log messages to this file - ensure the user running mediasorter can write to it
        logfile: "/var/log/mediasorter.log"

    # Metadata API configuration
    api:

        # TVDB API configuration (for TV metadata)
        tvdb:

            # API key for TVDB; YOU DO NOT NEED TO CHANGE THIS, it is registered to this project,
            # though you may change it if you wish to and have your own key
            key: "c658d42b-d1d1-403d-ae39-9c96997b29a8"

            # Base URL for TVDB; should generally not be changed
            url: "https://api4.thetvdb.com/v4"

            # Search path for TVDB; should generally not be changed
            # Variables replaced at runtime:
            #   * "show": the show name query, extracted from the source filename
            search_path: "search?query={show}&type=series"

            # Series path for TVDB to get episode; should generally not be changed
            # Variables replaced at runtime:
            #   * "id": the series ID from the search
            #   * "season": the season number
            #   * "episode": the episode number
            series_path: "series/{id}/episodes/default?page=0&season={season}&episodeNumber={episode}"

        # The Movie DB API configuration (for Movie metadata)
        tmdb:

            # API key for TMDB; CHANGE THIS TO YOUR OWN VALID API KEY
            key: "acdefghijklmnopqrstuvwxyz1234567"

            # Base URL for TMDB; should generally not be changed
            url: "https://api.themoviedb.org/3"

            # Search path for TMDB; should generally not be changed
            # Variables replaced at runtime:
            #  * "key": the TMDB API key specified above
            #  * "title": the movie name query, extracted from the source filename
            path: "search/movie?api_key={key}&query={title}"
       
    # Source file parameters
    parameters:

        # Valid file extensions for media files to parse; useful to specify which files should
        # be parsed inside source directories when operating recursively
        valid_extensions:
          - '.mkv'
          - '.avi'
          - '.mp4'

        # Filename split characters for source files; specifies the possible characters used
        # to split filenames, usually either periods or spaces (e.g. `My.Show.EXXYXX.mkv` or
        # `The Great Movie 2019.mkv`); additional characters can be added if needed, tried
        # in the order specified
        split_characters:
          - ' '
          - '.'

        # Minimum split length; specifies the minimum number of split fields to be considered
        # a valid result for the given split_character; 3 is usually a good default; note that
        # the source file extension is *not* counted towards this length
        min_split_length: 3

        # Whether or not to move "The" at the start of titles to the end of the name (e.g.
        # "The Movie" -> "Movie, The")
        suffix_the: true

        # Map of metainfo from filenames to file appends; see readme for a detailed explanation
        metainfo_map:
          # Cuts
          - 'Extended.*': "Extended Edition"
          - 'Director.*': "Directors Cut"
          - 'Theatr.*': "Theatrical Cut"
          # Resolutions
          - '720[pP]': 720p
          - '720[iI]': 720i
          - '1080[pP]': 1080p
          - '1080[iI]': 1080i
          - '2160[pP]': 2160p
          - '4[kK]': 2160p
          - 'UHD': 2160p
          # Qualities/Sources
          - '[Ww][Ee][Bb].*': Web
          - 'BD': BD
          - '[Bb]lu': BD
          - '[Bb]lu[Rr]ay': BD
          - '[Bb]lu-[Rr]ay': BD
          - '[Dd][Vv][Dd]': DVD
          - '.*[Rr][Ee][Mm][Uu][Xx].*': Remux
          # HDR
          - 'DoVi': DoVi
          - 'Vision': DoVi
          - 'HDR.*': HDR
          # Audio (first three match "X.Y surround" types, but the "." will cause them to be solo)
          - '5': 5.x
          - '7': 7.x
          - '2': 2.x
          - 'Atmos': Atmos
          - 'TrueHD': TrueHD

    # Search overrides
    # Useful if you have some search term that sortfile is generating which does not work reliably.
    # Use this dictionary, where the key is whatever sortfile generates, and the value is what you
    # want to search instead, to override the actual search with another one.
    # For example, "S.W.A.T." (TV show) ends up searching "s w a t" which matches another show, so
    # you can use this example entry to override that.
    # Add your own as needed; this list is populated by my own findings. PRs to add to this list
    # are also welcome if you find shows or movies affected.
    # NOTE: Movies are joined by "+" before this list is checked, so use + in place of spaces here.
    search_overrides:
      "s w a t": "swat"
      "law and order": "law & order"

    # Name overrides
    # Useful if there is a show you want to "rename" to a different name than what the metadata
    # providers return. For instance, a purist might want "Start Trek: The Original Series" instead
    # of the returned "Star Trek". Separated by media type (tv or movie) to avoid cross-changes.
    name_overrides:
      tv:
        "Star Trek": "Star Trek: The Original Series"