Skip to content
This repository has been archived by the owner on Dec 2, 2024. It is now read-only.

Configuration

Jump to bottom
Steven Hildreth edited this page Nov 27, 2019 · 21 revisions

The appsettings.json file settings for the roadie applications. These values are in a "RoadieSettings" root level configuration object.

General Settings

DbContextToUse

  • The database engine to use for your instance.
  • Options are: "File", "SQLite" and "MySQL"
  • No Default (must provide value)

SiteName

  • The name to display on your instance.
  • Default is "Roadie".

InboundFolder

  • The full path to a folder where you put music to be processed.
  • Default is "data\inbound"

LibraryFolder

  • The "storage_root" (or root path) to use for processed files. This is the topmost path for your processed media library.
  • Default is "data\library"

ImageFolder

  • The "image_storage_root" (or image root path) to use for storing images for Roadie. This is the image path which holds images for Collections, Labels, Playlists and User images.
  • Default is empty, which default to LibraryFolder.

DefaultTimeZone

  • When a new user is created this is the timezone set for them. Default is "US/Central".
  • Default is "US/Central"

DontDoMetaDataProvidersSearchArtists

  • When adding new music for these artists don't do metadata providers query.
  • Default is "Various Artists" and "Sound Tracks" (see "Special Artists")

RecordNoResultSearches

  • When a search is performed and no artist results are found then log the query.
  • Default is true (enabled)

ArtistNameReplace

  • When an artist is added to the database replace any found string with a replacement string.
  • Default is "AC/DC": [ "AC; DC", "AC;DC", "AC/ DC", "AC DC" ], "Love/Hate": [ "Love; Hate", "Love;Hate", "Love/ Hate", "Love Hate" ]

FileExtensionsToDelete

  • A collection of file extensions to delete after processing "inbound" folder.
  • Default is ".accurip", ".cue", ".dat", ".db", ".exe", ".html", ".ini", ".log", ".jpg", ".jpeg", ".par", ".par2", ".pdf", ".png", ".md5", ".mht", ".mpg", ".m3u", ".nfo", ".nzb", ".pls", ".sfv", ".srr", ".txt", ".url"

CORSOrigins

  • URI collection to setup for CORS allow domains, seperated by a pipe "|" character
  • No Default

UseRegistrationTokens

  • When true then require a Invite token to allow a user to register, without this token the user cannot register.
  • Default is false (disabled, allow any users to register; a public instance)

ConnectionString

  • EF Core connection string to the Roadie API database when using a server (not used on File database)
  • No default

FileDatabaseOptions

FileDatabaseFormat

  • Format to save data files in. Each table is stored as a single file.
  • Options are: "CSV", "BSON", "JSON", and "XML".
  • Default is "JSON"

DatabaseName

  • Name for the File database provider.
  • Default is "roadie"

DatabaseFolder

  • Name of the folder to store the database files
  • Default is "data\db"

Imaging

ThumbnailImageSize

  • Size of thumbnail images to serve on "thumbnail" requests.
  • Default is 80x80

MediumImageSize

  • Size of image to serve on a "medium" request.
  • Default is 160x160

LargeImageSize

  • Size of image to serve on a "medium" request.
  • Default is 320x320

Email Configuration

SmtpFromAddress

SmtpPort

  • Email server port for sending emails.
  • Default is 587

SmtpUsername

  • Email server username to send SMTP emails.
  • Default is "roadie"

SmtpHost

  • Email server to send SMTP emails.
  • Default is "smtp.roadie.rocks"

SmtpUseSSl

  • Use SSL when creating a connection to the SMTP server.
  • Default is true (enabled)

Integrations (meta data and search provider integrations)

ITunesProviderEnabled

  • Use iTunes as a metadata provider.
  • Default is true (enabled)

SpotifyProviderEnabled

  • Use Spotify as a metadata provider.
  • Default is true (enabled)

MusicBrainzProviderEnabled

  • Use MusicBrainz as a metadata provider (requires API Key).
  • Default is true (enabled)

LastFmProviderEnabled

  • Use LastFM as a metadata provider (requires API Key).
  • Default is true (enabled)

Integrations:ApiKeys

  • A object that has the ApiName and the Key value to use for the Api.
  • If a required API Key is not found for an integration that integration is disabled.
  • Example is { "ApiName": "BingImageSearch", "Key": "bing_api_key" }

Processing

ID3 Metadata is parsed/processed in this order: Read From ID3 Tags > Parse From FileName > Search MusicBrainz > Search LastFM > Search Discogs

DoAudioCleanup

  • When using Inspector if this is enabled then audio metadata is cleaned up.
  • Default is true (enabled)

DoSaveEditsToTags

  • When processing ID3 tags if any edits are done, and this is enabled, then the tags are written back to the file.
  • Default is true (enabled)

DoParseFromFileName

  • When processing if ID3 tags are invalid then attempt to parse information from filename.
  • Default is true (enabled)

DoParseFromMusicBrainz

  • When processing if ID3 tags are invalid, and other processing parsers failed, then attempt to parse information from MusicBrainz (API Key is required)
  • Default is true (enabled)

DoParseFromLastFM

  • When processing if ID3 tags are invalid, and other processing parsers failed, then attempt to parse information from LastFM (API Key is required)
  • Default is true (enabled)

DoParseFromDiscogsDB

  • When processing if ID3 tags are invalid, and other processing parsers failed, then attempt to parse information from Discogs (API Key is required)
  • Default is true (enabled)

MaximumArtistImagesToAdd

  • When processing and images are found this is the maximum number of Artist images to add to the database.
  • Default is 12

MaximumReleaseImagesToAdd

  • When processing and images are found this is the maximum number of Release images to add to the database.
  • Default is 12

MaxImageWidth

  • When processing and adding images to the database this is the maximum image size, images over this size are resized.
  • Default is 2048

MaximumImageSize

  • When serving an image request this is the maximum size of the image, any image found larger is resized.
  • Default is 2048

RemoveStringsRegex

  • When cleaning up any string (e.g., Artist Name, Release Title, Track Title) perform a Regex remove using this value and remove any matches.
  • Default is \b[0-9]+\s#\s\b

ReleaseRemoveStringsRegex

  • When cleaning up Release Title perform a Regex remove using this value and remove any matches.
  • No Default

TrackRemoveStringsRegex

  • When cleaning up Track Title perform a Regex remove using this value and remove any matches.
  • No Default

ReplaceStrings

  • A list of objects to iterate over and perform replacements when cleaning up any string (see RemoveStringsRegex).
  • Example would be { "order": 1, "key": "~", "replaceWith": "" } to replace all tildes (~) with space ("").
  • No Default

PreInspectScript

  • Powershell script filename to execute before running Inspector on a folder.
  • No Default

PostInspectScript

  • Powershell script filename to execute after running Inspector on a folder.
  • No Default
Clone this wiki locally