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
| Setting | Type | Default | Description |
|---|---|---|---|
POST_PROCESSING | bool | True | Enable post-processing of completed downloads. |
FILE_OPTS | string | move | File operation: move (move files to library) or copy (copy and keep originals). |
LOCAL_TORRENT_PP | bool | False | Enable 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.
| Setting | Type | Default | Description |
|---|---|---|---|
POST_PROCESSING_SCRIPT | string | — | Path to the script to execute after post-processing. |
PP_SHELL_LOCATION | string | — | Path to the shell interpreter (e.g. /bin/bash). Defaults to the system shell. |
The script receives the following arguments:
- Path to the imported file
- Series name
- Issue number
Run additional scripts after the main post-processing script.
| Setting | Type | Default | Description |
|---|---|---|---|
ENABLE_EXTRA_SCRIPTS | bool | False | Enable extra post-processing scripts. |
ES_SHELL_LOCATION | string | — | Shell interpreter path for extra scripts. |
EXTRA_SCRIPTS | string | — | Comma-separated list of script paths to execute. |
Run when a release is snatched (sent to a download client), before it finishes downloading.
| Setting | Type | Default | Description |
|---|---|---|---|
ENABLE_SNATCH_SCRIPT | bool | False | Enable snatch scripts. |
SNATCH_SHELL_LOCATION | string | — | Shell interpreter path for snatch scripts. |
SNATCH_SCRIPT | string | — | Path to the script to execute on snatch. |
The script receives the following arguments:
- Series name
- Issue number
- Provider name
- NZB/torrent name
Run before post-processing begins. Useful for cleanup or preparation steps.
| Setting | Type | Default | Description |
|---|---|---|---|
ENABLE_PRE_SCRIPTS | bool | False | Enable pre-processing scripts. |
PRE_SHELL_LOCATION | string | — | Shell interpreter path for pre scripts. |
PRE_SCRIPTS | string | — | Comma-separated list of script paths to execute. |
Snatch Notification
| Setting | Type | Default | Description |
|---|---|---|---|
SNATCHEDTORRENT_NOTIFY | bool | False | Send 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.
| Setting | Type | Default | Description |
|---|---|---|---|
ENABLE_CHECK_FOLDER | bool | False | Enable check folder monitoring. |
CHECK_FOLDER | string | — | Directory to watch for new files. |
MANUAL_PP_FOLDER | string | — | Directory 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.
Automatic import
Matched files are renamed, moved to the library, and tagged (if metadata tagging is enabled). Unmatched files are left in place.