Skip to content

UI Guide

chodeus edited this page Oct 22, 2026 · 19 revisions

🏠 Home › UI Guide

UI Guide

A page-by-page tour of CHUB's web interface, in sidebar order.

On this page

Dashboard

Dashboard

The landing page: what's running, what ran, what's next.

  • Header — module and instance counts, and live (updates pushed over SSE) or polling. Refresh reloads everything; New run opens a module picker, then asks you to confirm the run.
  • Status strip — Scheduler, Running, Pending, Failed, Instances, and Last failure.
  • Modules table — one row per module with its Schedule, Last run, Next run, and an Action button: Run now, or Running while a run is in progress (click it to cancel). Rows with profiles or schedule blocks expand.
  • Up next — upcoming scheduled runs, with running modules at the top.
  • Storage — disk usage of the mounted folders.

Which modules show, the refresh rate, and the Up next count are set on Settings → General.

Library

Pages under /media/….

/media/search — Search

Media search

  • One search box across every Radarr, Sonarr, and Lidarr instance.
  • Filter by type (movies / shows), sort, and order — remembered per browser.
  • Recent searches on this device.
  • Each result links out to IMDb, TMDB, TVDB or MusicBrainz, and can be deleted from its ARR.

/media/manage — Manage

  • Refresh re-syncs all media from your instances into CHUB's cache; Export downloads the library data as JSON.
  • Duplicate Files — the same title found in more than one place. Resolve keeps the copy you pick and removes the others, optionally deleting their files. Instances you list as a Quality Instance Group on Settings → General (for example radarr and radarr4k) aren't flagged. Bulk delete is available too.
  • Folder collisions — items with the same title but missing or unclear external IDs; review them before resolving.
  • Unmatched & Nested Media — the nestarr results, with a button to scan now.
  • Collections — rename or delete a collection (its media is not deleted).
  • Library Maintenance — orphaned cache rows (cache entries whose ARR item is gone, with a purge) and items with incomplete metadata.

/media/statistics — Library Statistics

  • Totals across Radarr, Sonarr, Lidarr and Plex: total media, in library, missing, monitored, upcoming. Sonarr is counted at the episode level, with series and seasons as context.
  • By type and By instance cards.
  • Breakdowns by genre, decade, rating, language, status, studio, runtime, root folder and tags, plus Recently Added.

/media/labelarr — Label Sync

  • One card per labelarr mapping: ARR instance, labels, Plex targets, status and last sync.
  • Add, edit, enable or remove mappings inline.
  • Sync now starts a Labelarr run.

Assets

Pages under /poster/….

/poster/search/gdrive — GDrive Sources

  • Every drive configured in sync_gdrive: folder, source, poster count, last sync, and status (Synced, Syncing, Stale over 7 days, Never synced).
  • Filter and sort the list, or sync one folder on its own.

/poster/search/assets — Assets Search

  • Browse every indexed poster and additional artwork image; filter by image type. Filters are remembered per browser.
  • Each matched poster shows which configured drive supplied it.
  • Toolbar: run Poster Renamerr, scan the poster folder for file count and size, optimize (resize oversized posters and compress), and upload a poster.
  • Per poster: download, delete, or add it to a collection.

/poster/cleanarr — Poster Cleanarr

Poster Cleanarr

  • Browse Plex's Metadata folder by title and find poster variants Plex no longer uses ("bloat"). Filter by title or type (movies/shows/collections); click a title for its variant grid (active / bloat / in use). Libraries in excluded_libraries are hidden.
  • Pills on each card: red ● N bloat (unused variants) and amber ⧉ N stale (outdated Kometa asset folders for that item).
  • Orphaned assets below the grid lists asset files with no media, with a delete button each.
  • Run scan runs the passes you tick — Bloat, Stale, Orphan — in the chosen mode: Report, Move (to <plex_path>/Poster Cleanarr Restore/), Remove, Restore, Clear (empty the restore folder) or Nothing. Remove and Clear can't be undone. Overlays only spares your own uploads. See Modules → poster_cleanarr.

/poster/manage is an old bookmark path that redirects here.

/poster/border-replacerr — Border Replacerr

  • Default border colors — the colors used outside any holiday window.
  • Holidays — per-holiday colors and themed border art (Bundled or Custom thumbnails). Add holidays and their date windows in the module settings.
  • Preview — real posters before and after, with the default colors, today's state, or any holiday. Needs at least one poster_renamerr run.

/poster/unmatched — Unmatched Assets

Items missing a poster or other artwork. Switch between Posters and Additional artwork, and filter by movies, series, seasons or collections. Four tabs:

  • Unmatched — nothing linked. Ignore a row, or just one season of a series.
  • Needs Review — a match with a real identity conflict. Choose a poster (applies it at once, to the destination and Plex), Approve the current match, or Ignore.
  • Locked — items you chose or approved; later runs leave them alone. Unlock lets the next run match again.
  • Ignored — grouped by show, kept across re-scans. Restore un-ignores.

On the full image, artwork rows also offer a CL2K build action.

/poster/statistics — Poster Statistics

  • Summary cards: cached assets, matched, unmatched, and synced size, for the last 7, 30 or 90 days or all time.
  • Low-resolution posters below a width you choose (default 1000 px). Backfill dimensions fills in sizes for older posters, 200 per click.
  • Unmatched movies, series, and collections (same rules as unmatched_assets), with a Request button that copies a Discord-ready request.

full image pages

  • /poster/cl2k-maker — CL2K Poster Maker — search a title, pick art, frame the backdrop, preview, and save. See Modules → cl2k_maker.
  • /poster/heal-review — Poster Healer Review — apply or dismiss poster_self_heal proposals.

Settings

/settings/general

  • Appearance — theme (light, dark, or follow system) and accent color. Sets the server-wide default; each browser remembers its own choice.
  • General — log level, max log files, webhook delay/retries, webhook secret, trusted proxies, the webhook base URL, dashboard modules and refresh, the Up next count, and Quality Instance Groups. See Configuration → general.
  • TMDB and fanart.tv — API keys and cache lifetimes.
  • Access — turn the login on or off, with the current password. See Configuration → auth.
  • First-run setup — run the setup wizard again.

/settings/interface redirects here.

/settings/modules

  • Every module with an on/off switch and a short description. A module switched off is skipped by the scheduler, can't be run by hand, and its webhook jobs are skipped.
  • Click a module for its settings page (/settings/modules/<module>): Dry run, Run now and Save in the header, then the module's settings in cards. A warning appears when something the module needs is missing.

/settings/schedule

  • Each module's schedule and next run time. Edit it with the hourly / daily / weekly / monthly / cron picker.
  • Schedule blocks — extra schedules for one module, each with its own settings overrides. Upgradinatorr profiles with their own schedule are listed too.
  • Saving updates the live scheduler — no restart. A schedule that could never run is refused.

/settings/instances

  • One card per Radarr, Sonarr, Lidarr, and Plex connection, with a health dot and ping: Test, Sync, Edit (including renaming the instance), Delete, and an enable switch.
  • Expand a card for the last test time and cache freshness. A Plex card also lists its libraries: tick the ones CHUB may use, or refresh the list.
  • Force re-upload on webhook — see Webhooks → Force re-uploads per instance.
  • The media-sync cadence (Off, Every 6 hours, Daily, Weekly) is set here too.

See First Run for connecting instances.

/settings/notifications

  • One row per destination (Discord or Notifiarr): name, target, the modules it covers, On success / On failure switches, and an enable switch.
  • Test sends a real notification to that destination. See Configuration → notifications.

/settings/jobs

  • Queue view with filters for status, module, and type; the trigger column shows what started each job.
  • Expand a row for its details (phases, error). Finished jobs can be retried. Clear removes completed jobs older than 30 days.

/settings/webhooks

  • Auto-setup — CHUB adds its poster webhook to each Radarr/Sonarr for you, with instance routing and your secret built in. Fix all repairs connections that have drifted.
  • Ready-to-paste URLs for Sonarr / Radarr / Tautulli, with the secret applied if set.
  • Recent callers shows which hosts/endpoints fired webhooks in the last 7 days. See Webhooks.

/settings/system

  • Version — the running version and Check for updates.
  • Logging — log level and how long rotated logs are kept.
  • Backups & database — automatic daily backups and where they go, a manual backup download and restore, and the database: size, row count per table, applied schema migrations, and Vacuum to reclaim space.
  • Danger zone — Clear poster cache wipes poster_cache; the next poster_renamerr run rescans and repopulates it.

Logs

/logs

Combined log viewer — pick a module (and one of its rotated files) and the page tails it. /logs?module=<name> opens a module directly.

  • Level filter (critical/error/warning/info/debug) — pills toggle independently.
  • Hide heartbeat — hides repetitive progress lines (scheduler ticks, rclone stats, merge progress); on by default.
  • Search — case-insensitive text filter.
  • Download or copy the file; jump to the top or bottom.

Secrets (API keys, tokens, webhook URLs) are replaced with placeholders before anything is written to disk — log excerpts are safe to paste into issue reports.

Conventions

  • Deep links — every page is URL-addressable; media/poster filters persist per browser.
  • Theme — toggle in the header; applies instantly, remembered per device.
  • Responsive — below 768px the sidebar collapses to a drawer; grids reduce to one or two columns.
  • Shortcuts — / → /dashboard, /media → /media/search, /poster → /poster/search/gdrive, /settings → /settings/general. Unknown URLs bounce to the dashboard.

Next: Webhooks · Related: Modules, Troubleshooting

Clone this wiki locally