Care Package & Support Bundle

Generate a diagnostic archive for troubleshooting, either the in-app Support bundle or the fuller CLI care package.

Comicarr can produce two different diagnostic archives. Reach for the support bundle first; it is the safer of the two and covers most reports.

	Support bundle	Care package
Where	Settings → About, in the browser	CLI: `maintenance --carepackage`
Contains	Allowlisted diagnostic facts only	Redacted `config.ini`, log files, database copy, environment info
Does not contain	Your database, settings values, raw log lines, library names, paths, chat content, or any other free text	Very little; see the redaction list below
Reach for it when	Filing a GitHub issue	A maintainer asks for one, or the app will not start

Review either archive before sharing it publicly. The support bundle is built from an allowlist and is safe by construction; the care package's redaction is extensive but cannot guarantee that a custom secret pasted into a free-text log line is caught.

Support bundle (Settings → About)

Open Settings → About → Support bundle and choose Create support bundle. Comicarr builds the archive server-side, validates it against a published contract, and downloads it. Create it, inspect it, then share it.

The ZIP has exactly three members:

Member	Contents
`README.txt`	What the bundle is, and what to check before sharing it
`manifest.json`	Contract version, product version, generation timestamp, and a SHA-256 for each member
`diagnostics.json`	The diagnostic facts themselves, schema-validated

If some diagnostics could not be collected, the download still succeeds and the bundle status says so. Read manifest.json before drawing conclusions from a partial bundle. Creation is session-authenticated and one-at-a-time; a second request while one is building returns 409 with a Retry-After.

Care package: 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 --carepackage

maintenance 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>).zip

Docker default data dir: /config/comicarr → zip under /config/comicarr/logs/ (host: ./config/comicarr/logs/ with the usual volume mapping).

What the care package includes

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 the care package instead

The app will not start, so Settings → About is unreachable
A maintainer needs the actual log lines or the database to reproduce a failure
Suspected config corruption
Migration or upgrade issues

For a normal bug report on a running install, the Support bundle carries enough context and far less of your data.

# 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 --help

Database backend migration is a separate subcommand: see Database.