Care Package (Support Bundle)
Generate a redacted support zip with config, logs, database, and environment info.
A care package is a zip archive Comicarr builds for troubleshooting. It includes runtime info, a redacted config, logs with secrets stripped, and a copy of the SQLite database.
Use it when filing a GitHub issue or debugging a failure with a maintainer. Always review the zip before sharing — redaction is extensive but not a guarantee against every custom secret in free-text logs.
Generate from the CLI
Run maintenance mode with the care package flag (app process should not already be using the same data directory exclusively if the DB is locked):
# Manual install — from the app directory
python3 Comicarr.py --datadir /path/to/data maintenance --carepackage
# Equivalent short flag for the care package option:
python3 Comicarr.py --datadir /path/to/data maintenance -care
# Docker (one-off container with the same config volume)
docker run --rm \
-v /path/to/config:/config \
ghcr.io/frankieramirez/comicarr:latest \
--datadir /config/comicarr maintenance --carepackagemaintenance is a subcommand (no GUI). --carepackage / -care builds the zip and exits.
On success the CLI prints the path to the zip, typically under the logs directory:
carepackage_<version>.zip
# or
carepackage_<commit>_(<branch>).zipDocker default data dir: /config/comicarr → zip under /config/comicarr/logs/ (host: ./config/comicarr/logs/ with the usual volume mapping).
What is included
| Artifact | Description |
|---|---|
ComicarrRunningEnvironment.txt | Version, branch, host uname/systeminfo, Python, pip freeze, selected env vars, git status |
Redacted config.ini | Secrets replaced; encrypted values and passwords not exported as plaintext |
comicarr.db | Full SQLite database copy (library metadata, history, journal, etc.) |
comicarr.log* | Log files with API keys / passwords / 32P tokens substituted as -REDACTED- |
.LASTRELEASE | Included when present (release marker) |
What is redacted
- All Fernet-encrypted config keys known to Comicarr (
ENCRYPTED_CONFIG_ITEMS) - Extra sensitive fields (usernames for download clients, bcrypt password field, various API key slots, seedbox/DDL external usernames, etc.)
- Host-like settings may be scrubbed in the cleaned config path used for the zip
- Newznab/Torznab API keys in extra provider lists
- Runtime 32P tokens (auth/authkey/passkey) when present in memory
- Structured legacy 32P credential lines in logs
Hostnames in logs are not always removed; treat the DB and logs as sensitive.
When to use it
- Unexplained search/download/post-process failures
- Migration or upgrade issues
- Suspected config corruption
- Providing maintainers with environment and version context without pasting secrets into chat
Related maintenance commands
# Force update check path (as if from GUI)
python3 Comicarr.py --datadir /path/to/data maintenance --update
# Export/import helpers (see --help)
python3 Comicarr.py --datadir /path/to/data maintenance --helpDatabase backend migration is a separate subcommand: see Database.