Skip to content

Document Unpackerr v1 upgrades - #54

Open
davidnewhall wants to merge 8 commits into
mainfrom
docs/whisparr-as-radarr
Open

davidnewhall wants to merge 8 commits into
mainfrom
docs/whisparr-as-radarr

Conversation

@davidnewhall

@davidnewhall davidnewhall commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add an Upgrading to v1 page: web UI on 5656, writable config, env vars locking UI fields, Prometheus API key, Docker /config, and unRAID migrate-or-reinstall.
  • Document Whisparr as a Radarr instance ([radarr.whisparr] / UN_RADARR_whisparr_*) and named Starr/folder/hook keys.
  • Document v1 folder watch (from Unpackerr #758+): per-path poll interval (no global folders.interval / Docker 1s auto-poll), restore after restart, wait_extensions, skip_empty.
  • Rewrite the unRAID install page for the v1 template (appdata, port 5656, configure in the UI). The Community Applications XML is staged locally and not in selfhosters yet.
  • Point intro, FAQ, and choose-method at the upgrade notes.

Test plan

  • https://unpackerr.zip/docs/install/upgrading after merge (Watched folders section)
  • Docker / Compose Folder Watcher: UN_FOLDER_<key>_INTERVAL=1s, not UN_FOLDERS_INTERVAL
  • Configuration: Watch folders + Whisparr + named-instance examples
  • FAQ / troubleshooting: Docker watch paths stay empty until a poll interval is set
  • unRAID page: appdata / 5656 / WebUI, not env-var Starr fields
  • Intro and FAQ do not list Whisparr as its own Starr app

davidnewhall and others added 4 commits September 10, 2026 23:52
Whisparr uses the Radarr API, so the docs should tell people to configure it as a named Radarr instance.

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
…xample.

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Comment thread docs/install/unraid.md
Comment thread docs/install/upgrading.md
Comment thread docs/install/configuration.md Outdated

@qwen-pr-bot qwen-pr-bot Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed all five commits at 516b9b1 against base 2d65270. This bundles more than the title says: the Whisparr→Radarr documentation, a new Upgrading to v1 page, a rewrite of the multi-instance config section (array rows → named keys), a unRAID page rewrite, and a sidebar entry — plus a real fix: the template link mainmaster, since selfhosters' default branch is master and the old link 404s.

The new page renders cleanly with its sidebar entry:

New Upgrading to v1 page, rendered from the head build

And the configuration page's rewritten sections (Web UI, Two+ Instances, Whisparr, Named instances) land as described:

Rewritten Application Configuration page, rendered from the head build

I cross-checked every v1 claim against Unpackerr/unpackerr@main (and v0.16.1 where it matters), and they all hold: port 5656 with listen_addr = "" as the off switch, the one-time temporary admin password plus --reset, UI Save rewriting the config file, env-owned values locked out of UI saves, named keys with legacy [[…]] rows loading as 0, 1, …, Whisparr as a plain Radarr instance (v0.16.1 already drove it with the Radarr client, so the rename is honest), /metrics requiring an API key with system:metrics:read, packages installing /etc/unpackerr/unpackerr.conf at 0644 with the post-install chown, and Docker writing /config/unpackerr.conf when the directory exists. The intro/FAQ wording matches the app's own v1 definitions.

One blocking item: the unRAID template descriptions are ahead of the public record — see the inlines on unraid.md:13 and upgrading.md:113. The linked selfhosters template is still env-var-only, and I found no v1 template in either public CA repo. As written, a user who pulls v1 and follows "remove the container, install again from Apps, open the WebUI" ends up with no port exposed and no appdata to leave in place. If the template update is already in flight, say so and soften the tense; otherwise hold the unRAID rewrite until it's public.

Executed validation (advanced mode — the docs repo's documented checks only; no app binaries were run):

  • yarn install --frozen-lockfile; yarn lint (markdownlint-cli2): 0 issues in 25 files
  • codespell docs: clean
  • yarn build (which runs ./generate.shgo run github.com/Unpackerr/unpackerr/init/config@maindocusaurus build): success at both head and base. Only warning is a broken anchor on /docs/install/windows — pre-existing at base, not introduced here.
  • Served the head build on loopback and rendered the pages with headless Chromium; verified the rendered sections in the built HTML (screenshots above).

@bakerboy448 bakerboy448 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems reasonable from human eyes. Can have Claude give it a whirl. Lemme know

@davidnewhall davidnewhall changed the title Document moving Unpackerr from Whisparr to Radarr Document Unpackerr v1 upgrades Sep 17, 2026
@davidnewhall

Copy link
Copy Markdown
Contributor Author

Don't need Claude. Just need you to breeze it over and let me know if something is confusing.

Docker no longer auto-polls via folders.interval; call out wait_extensions,
skip_empty, and history restore so upgrades do not leave an empty queue.

Co-authored-by: Cursor <cursoragent@cursor.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants