Tsarr Documentation - v2.16.0
    Preparing search index...

    Type Alias ServerConfiguration

    Represents the server configuration.

    type ServerConfiguration = {
        LogFileRetentionDays?: number;
        IsStartupWizardCompleted?: boolean;
        CachePath?: string | null;
        PreviousVersion?: string | null;
        PreviousVersionStr?: string | null;
        EnableMetrics?: boolean;
        EnableNormalizedItemByNameIds?: boolean;
        IsPortAuthorized?: boolean;
        QuickConnectAvailable?: boolean;
        EnableCaseSensitiveItemIds?: boolean;
        DisableLiveTvChannelUserDataName?: boolean;
        MetadataPath?: string;
        PreferredMetadataLanguage?: string;
        MetadataCountryCode?: string;
        SortReplaceCharacters?: string[];
        SortRemoveCharacters?: string[];
        SortRemoveWords?: string[];
        MinResumePct?: number;
        MaxResumePct?: number;
        MinResumeDurationSeconds?: number;
        MinAudiobookResume?: number;
        MaxAudiobookResume?: number;
        InactiveSessionThreshold?: number;
        LibraryMonitorDelay?: number;
        LibraryUpdateDuration?: number;
        CacheSize?: number;
        ImageSavingConvention?: "Legacy" | "Compatible";
        MetadataOptions?: MetadataOptions[];
        SkipDeserializationForBasicTypes?: boolean;
        ServerName?: string;
        UICulture?: string;
        SaveMetadataHidden?: boolean;
        ContentTypes?: NameValuePair[];
        RemoteClientBitrateLimit?: number;
        EnableFolderView?: boolean;
        EnableGroupingMoviesIntoCollections?: boolean;
        EnableGroupingShowsIntoCollections?: boolean;
        DisplaySpecialsWithinSeasons?: boolean;
        CodecsUsed?: string[];
        PluginRepositories?: RepositoryInfo[];
        EnableExternalContentInSuggestions?: boolean;
        ImageExtractionTimeoutMs?: number;
        PathSubstitutions?: PathSubstitution[];
        EnableSlowResponseWarning?: boolean;
        SlowResponseThresholdMs?: number;
        CorsHosts?: string[];
        ActivityLogRetentionDays?: number | null;
        LibraryScanFanoutConcurrency?: number;
        LibraryMetadataRefreshConcurrency?: number;
        AllowClientLogUpload?: boolean;
        DummyChapterDuration?: number;
        ChapterImageResolution?:
            | "MatchSource"
            | "P144"
            | "P240"
            | "P360"
            | "P480"
            | "P720"
            | "P1080"
            | "P1440"
            | "P2160";
        ParallelImageEncodingLimit?: number;
        CastReceiverApplications?: CastReceiverApplication[];
        TrickplayOptions?: TrickplayOptions;
        EnableLegacyAuthorization?: boolean;
    }
    Index
    LogFileRetentionDays? IsStartupWizardCompleted? CachePath? PreviousVersion? PreviousVersionStr? EnableMetrics? EnableNormalizedItemByNameIds? IsPortAuthorized? QuickConnectAvailable? EnableCaseSensitiveItemIds? DisableLiveTvChannelUserDataName? MetadataPath? PreferredMetadataLanguage? MetadataCountryCode? SortReplaceCharacters? SortRemoveCharacters? SortRemoveWords? MinResumePct? MaxResumePct? MinResumeDurationSeconds? MinAudiobookResume? MaxAudiobookResume? InactiveSessionThreshold? LibraryMonitorDelay? LibraryUpdateDuration? CacheSize? ImageSavingConvention? MetadataOptions? SkipDeserializationForBasicTypes? ServerName? UICulture? SaveMetadataHidden? ContentTypes? RemoteClientBitrateLimit? EnableFolderView? EnableGroupingMoviesIntoCollections? EnableGroupingShowsIntoCollections? DisplaySpecialsWithinSeasons? CodecsUsed? PluginRepositories? EnableExternalContentInSuggestions? ImageExtractionTimeoutMs? PathSubstitutions? EnableSlowResponseWarning? SlowResponseThresholdMs? CorsHosts? ActivityLogRetentionDays? LibraryScanFanoutConcurrency? LibraryMetadataRefreshConcurrency? AllowClientLogUpload? DummyChapterDuration? ChapterImageResolution? ParallelImageEncodingLimit? CastReceiverApplications? TrickplayOptions? EnableLegacyAuthorization?
    LogFileRetentionDays?: number

    Gets or sets the number of days we should retain log files.

    IsStartupWizardCompleted?: boolean

    Gets or sets a value indicating whether this instance is first run.

    CachePath?: string | null

    Gets or sets the cache path.

    PreviousVersion?: string | null

    Gets or sets the last known version that was ran using the configuration.

    PreviousVersionStr?: string | null

    Gets or sets the stringified PreviousVersion to be stored/loaded, because System.Version itself isn't xml-serializable.

    EnableMetrics?: boolean

    Gets or sets a value indicating whether to enable prometheus metrics exporting.

    EnableNormalizedItemByNameIds?: boolean
    IsPortAuthorized?: boolean

    Gets or sets a value indicating whether this instance is port authorized.

    QuickConnectAvailable?: boolean

    Gets or sets a value indicating whether quick connect is available for use on this server.

    EnableCaseSensitiveItemIds?: boolean

    Gets or sets a value indicating whether [enable case-sensitive item ids].

    DisableLiveTvChannelUserDataName?: boolean
    MetadataPath?: string

    Gets or sets the metadata path.

    PreferredMetadataLanguage?: string

    Gets or sets the preferred metadata language.

    MetadataCountryCode?: string

    Gets or sets the metadata country code.

    SortReplaceCharacters?: string[]

    Gets or sets characters to be replaced with a ' ' in strings to create a sort name.

    SortRemoveCharacters?: string[]

    Gets or sets characters to be removed from strings to create a sort name.

    SortRemoveWords?: string[]

    Gets or sets words to be removed from strings to create a sort name.

    MinResumePct?: number

    Gets or sets the minimum percentage of an item that must be played in order for playstate to be updated.

    MaxResumePct?: number

    Gets or sets the maximum percentage of an item that can be played while still saving playstate. If this percentage is crossed playstate will be reset to the beginning and the item will be marked watched.

    MinResumeDurationSeconds?: number

    Gets or sets the minimum duration that an item must have in order to be eligible for playstate updates..

    MinAudiobookResume?: number

    Gets or sets the minimum minutes of a book that must be played in order for playstate to be updated.

    MaxAudiobookResume?: number

    Gets or sets the remaining minutes of a book that can be played while still saving playstate. If this percentage is crossed playstate will be reset to the beginning and the item will be marked watched.

    InactiveSessionThreshold?: number

    Gets or sets the threshold in minutes after a inactive session gets closed automatically. If set to 0 the check for inactive sessions gets disabled.

    LibraryMonitorDelay?: number

    Gets or sets the delay in seconds that we will wait after a file system change to try and discover what has been added/removed Some delay is necessary with some items because their creation is not atomic. It involves the creation of several different directories and files.

    LibraryUpdateDuration?: number

    Gets or sets the duration in seconds that we will wait after a library updated event before executing the library changed notification.

    CacheSize?: number

    Gets or sets the maximum amount of items to cache.

    ImageSavingConvention?: "Legacy" | "Compatible"

    Gets or sets the image saving convention.

    MetadataOptions?: MetadataOptions[]
    SkipDeserializationForBasicTypes?: boolean
    ServerName?: string
    UICulture?: string
    SaveMetadataHidden?: boolean
    ContentTypes?: NameValuePair[]
    RemoteClientBitrateLimit?: number
    EnableFolderView?: boolean
    EnableGroupingMoviesIntoCollections?: boolean
    EnableGroupingShowsIntoCollections?: boolean
    DisplaySpecialsWithinSeasons?: boolean
    CodecsUsed?: string[]
    PluginRepositories?: RepositoryInfo[]
    EnableExternalContentInSuggestions?: boolean
    ImageExtractionTimeoutMs?: number
    PathSubstitutions?: PathSubstitution[]
    EnableSlowResponseWarning?: boolean

    Gets or sets a value indicating whether slow server responses should be logged as a warning.

    SlowResponseThresholdMs?: number

    Gets or sets the threshold for the slow response time warning in ms.

    CorsHosts?: string[]

    Gets or sets the cors hosts.

    ActivityLogRetentionDays?: number | null

    Gets or sets the number of days we should retain activity logs.

    LibraryScanFanoutConcurrency?: number

    Gets or sets the how the library scan fans out.

    LibraryMetadataRefreshConcurrency?: number

    Gets or sets the how many metadata refreshes can run concurrently.

    AllowClientLogUpload?: boolean

    Gets or sets a value indicating whether clients should be allowed to upload logs.

    DummyChapterDuration?: number

    Gets or sets the dummy chapter duration in seconds, use 0 (zero) or less to disable generation altogether.

    ChapterImageResolution?:
        | "MatchSource"
        | "P144"
        | "P240"
        | "P360"
        | "P480"
        | "P720"
        | "P1080"
        | "P1440"
        | "P2160"

    Gets or sets the chapter image resolution.

    ParallelImageEncodingLimit?: number

    Gets or sets the limit for parallel image encoding.

    CastReceiverApplications?: CastReceiverApplication[]

    Gets or sets the list of cast receiver applications.

    TrickplayOptions?: TrickplayOptions

    Gets or sets the trickplay options.

    EnableLegacyAuthorization?: boolean

    Gets or sets a value indicating whether old authorization methods are allowed.

    Settings
    Member Visibility

    On This Page
    Properties
    LogFileRetentionDaysIsStartupWizardCompletedCachePathPreviousVersionPreviousVersionStrEnableMetricsEnableNormalizedItemByNameIdsIsPortAuthorizedQuickConnectAvailableEnableCaseSensitiveItemIdsDisableLiveTvChannelUserDataNameMetadataPathPreferredMetadataLanguageMetadataCountryCodeSortReplaceCharactersSortRemoveCharactersSortRemoveWordsMinResumePctMaxResumePctMinResumeDurationSecondsMinAudiobookResumeMaxAudiobookResumeInactiveSessionThresholdLibraryMonitorDelayLibraryUpdateDurationCacheSizeImageSavingConventionMetadataOptionsSkipDeserializationForBasicTypesServerNameUICultureSaveMetadataHiddenContentTypesRemoteClientBitrateLimitEnableFolderViewEnableGroupingMoviesIntoCollectionsEnableGroupingShowsIntoCollectionsDisplaySpecialsWithinSeasonsCodecsUsedPluginRepositoriesEnableExternalContentInSuggestionsImageExtractionTimeoutMsPathSubstitutionsEnableSlowResponseWarningSlowResponseThresholdMsCorsHostsActivityLogRetentionDaysLibraryScanFanoutConcurrencyLibraryMetadataRefreshConcurrencyAllowClientLogUploadDummyChapterDurationChapterImageResolutionParallelImageEncodingLimitCastReceiverApplicationsTrickplayOptionsEnableLegacyAuthorization