Post-Processing

Configure file handling, custom scripts, and check folder monitoring.

Post-processing controls what happens to files after they are downloaded: moving, renaming, running scripts, and importing into your library.

Core Settings

SettingTypeDefaultDescription
POST_PROCESSINGboolTrueEnable post-processing of completed downloads.
FILE_OPTSstringmoveFile operation: move (move files to library) or copy (copy and keep originals).
LOCAL_TORRENT_PPboolFalseEnable post-processing for torrent downloads. Required when using torrent clients since they seed after completion.

When using torrent clients, enable LOCAL_TORRENT_PP and set FILE_OPTS to copy so files remain available for seeding.

Scripts

Comicarr can run custom scripts at different stages of the download lifecycle. Each script type has an enable toggle, a shell location, and a script path.

Run after a download is imported into the library.

SettingTypeDefaultDescription
POST_PROCESSING_SCRIPTstringnonePath to the script to execute after post-processing.
PP_SHELL_LOCATIONstringnonePath to the shell interpreter (e.g. /bin/bash). Defaults to the system shell.

The script receives the following arguments:

  1. Path to the imported file
  2. Series name
  3. Issue number

Run additional scripts after the main post-processing script.

SettingTypeDefaultDescription
ENABLE_EXTRA_SCRIPTSboolFalseEnable extra post-processing scripts.
ES_SHELL_LOCATIONstringnoneShell interpreter path for extra scripts.
EXTRA_SCRIPTSstringnoneComma-separated list of script paths to execute.

Run when a release is snatched (sent to a download client), before it finishes downloading.

SettingTypeDefaultDescription
ENABLE_SNATCH_SCRIPTboolFalseEnable snatch scripts.
SNATCH_SHELL_LOCATIONstringnoneShell interpreter path for snatch scripts.
SNATCH_SCRIPTstringnonePath to the script to execute on snatch.

The script receives the following arguments:

  1. Series name
  2. Issue number
  3. Provider name
  4. NZB/torrent name

Run before post-processing begins. Useful for cleanup or preparation steps.

SettingTypeDefaultDescription
ENABLE_PRE_SCRIPTSboolFalseEnable pre-processing scripts.
PRE_SHELL_LOCATIONstringnoneShell interpreter path for pre scripts.
PRE_SCRIPTSstringnoneComma-separated list of script paths to execute.

Snatch Notification

SettingTypeDefaultDescription
SNATCHEDTORRENT_NOTIFYboolFalseSend a notification when a torrent is snatched. Uses your configured notification provider(s).

Check Folder

Monitor a directory for manually added comic files and import them into your library.

SettingTypeDefaultDescription
ENABLE_CHECK_FOLDERboolFalseEnable check folder monitoring.
CHECK_FOLDERstringnoneDirectory to watch for new files.
ADDITIONAL_CHECK_FOLDERSstringnoneExtra directories to watch, one absolute path per line. Scanned after CHECK_FOLDER on each pass, and only while CHECK_FOLDER is set. Editable in Settings → Download Clients → Completed downloads.
MANUAL_PP_FOLDERstringnoneDirectory for manual post-processing. Files placed here are processed on demand via the UI.

Set up the check folder

Enable ENABLE_CHECK_FOLDER and set CHECK_FOLDER to a directory path. In Docker, make sure this path is mapped as a volume.

Add files

Drop comic files (CBZ, CBR, PDF) into the check folder. Comicarr scans the folder on each DOWNLOAD_SCAN_INTERVAL cycle.

To watch more than one folder, for example a separate Magazines download category, list the extra folders in ADDITIONAL_CHECK_FOLDERS. A missing or unreadable extra folder is logged and skipped, and the others are still scanned.

Automatic import

Matched files are renamed, moved to the library, and tagged (if metadata tagging is enabled). Unmatched files are left in place.

Metadata

Configure ComicVine, MyAnimeList, Metron, and comic file tagging settings.

Notifications

Configure Discord, Telegram, Slack, email, and 8 more notification providers.

On this page

Core SettingsScriptsSnatch NotificationCheck FolderSet up the check folderAdd filesAutomatic import