Metadata

Configure ComicVine, Metron, and comic file tagging settings.

Comicarr pulls series and issue metadata from external databases and can embed that metadata directly into comic files using ComicTagger.

ComicVine

ComicVine is the primary metadata source. You need a free API key from the ComicVine website.

API Settings

SettingTypeDefaultDescription
CVAPI_RATEint2Maximum API requests per second. ComicVine's limit is 200/min; 2 per second is safe.
CV_VERIFYboolTrueVerify TLS certificates for ComicVine API calls.
CV_TIMEOUTint30Request timeout in seconds.
CV_ONLYboolFalseUse ComicVine as the sole metadata source (disable all others).
CV_ONETIMERboolFalseRun a single metadata refresh on startup, then stop.
CV_USER_AGENTstringCustom User-Agent header for ComicVine requests. Leave blank for the default.

Caching

Comicarr caches ComicVine responses to reduce API calls and speed up repeated lookups.

SettingTypeDefaultDescription
CV_CACHE_ENABLEDboolTrueEnable the ComicVine response cache.
CV_CACHE_TTL_SEARCHint86400Cache TTL for search results in seconds (default: 24 hours).
CV_CACHE_TTL_METADATAint604800Cache TTL for issue/series metadata in seconds (default: 7 days).
CV_CACHE_TTL_ARCint259200Cache TTL for story arc data in seconds (default: 3 days).

Imprint Handling

SettingTypeDefaultDescription
CV_SKIP_IMPRINT_VALIDATIONboolFalseSkip publisher imprint validation checks.
IMPRINT_MAPPING_TYPEstringCVSource for imprint-to-publisher mapping: CV (ComicVine) or JSON (local mapping file).

Parallel Requests

SettingTypeDefaultDescription
CV_PARALLEL_PAGINATIONboolFalseFetch multiple pages of results in parallel. Speeds up large series lookups.
CV_MAX_PARALLEL_REQUESTSint3Maximum concurrent requests when parallel pagination is enabled.

Batch Limits

ComicVine may throttle or block accounts that make too many requests in a short window.

SettingTypeDefaultDescription
CV_BATCH_LIMIT_PROTECTIONboolTrueEnable automatic throttling when approaching batch limits.
CV_BATCH_LIMIT_THRESHOLDint200Number of requests in a batch window before throttling kicks in.

Disabling CV_BATCH_LIMIT_PROTECTION risks getting your API key temporarily blocked by ComicVine. Leave it enabled unless you have a specific reason.

Ignored Publishers

Configure a list of publishers to exclude from metadata lookups. Issues from ignored publishers are skipped during searches and imports. This setting is managed through the UI on the Settings > Metadata page.

Metron

Metron is an alternative comic metadata database. It can supplement or replace ComicVine.

SettingTypeDefaultDescription
USE_METRONboolFalseEnable Metron as a metadata source.
METRON_USERNAMEstringMetron account username.
METRON_PASSWORDstringMetron account password. Encrypted at rest.
USE_METRON_SEARCHboolFalseUse Metron for search results in addition to metadata.

Comic Tagging

Comicarr can embed metadata directly into CBZ/CBR files using ComicTagger.

General

SettingTypeDefaultDescription
ENABLE_METAboolFalseEnable comic file tagging.
CMTAGGER_PATHstringPath to the ComicTagger binary. Leave blank if it is on $PATH.
CBR2CBZ_ONLYboolFalseOnly convert CBR to CBZ without writing metadata tags.
UNRAR_CMDstringPath to the unrar binary, required for CBR conversion.

Tag Formats

SettingTypeDefaultDescription
CT_TAG_CRboolTrueWrite ComicRack (CR) tags.
CT_TAG_CBLboolFalseWrite Comic Book Lover (CBL) tags.
CT_CBZ_OVERWRITEboolFalseOverwrite existing tags in CBZ files.
CT_NOTES_FORMATstringTemplate for the Notes field in tagged files.

Volume Handling

SettingTypeDefaultDescription
CMTAG_VOLUMEboolFalseInclude the volume number in tags.
CMTAG_START_YEAR_AS_VOLUMEboolFalseUse the series start year as the volume number.
SETDEFAULTVOLUMEboolFalseSet volume to 1 when no volume information is available.

On this page