Skip to content

docs: comprehensive wiki update and gap fill#38

Merged
austinwbest merged 5 commits into
Notifiarr:mainfrom
bakerboy448:docs/wiki-alignment
Jun 7, 2026
Merged

docs: comprehensive wiki update and gap fill#38
austinwbest merged 5 commits into
Notifiarr:mainfrom
bakerboy448:docs/wiki-alignment

Conversation

@bakerboy448

@bakerboy448 bakerboy448 commented Mar 12, 2026

Copy link
Copy Markdown
Collaborator

Summary

Comprehensive wiki audit + restructure cross-referenced against the live Notifiarr website integration UI (PHP under website-source/integrations/frontend/) and the client Go source (pkg/triggers/, pkg/apps/, pkg/configfile/). Rebased on top of upstream PR #36 (Apprise official link).

5 purposeful commits, +2,204 / −656 across 80 files. mkdocs build --strict passes with zero warnings.

Commits (in review order)

1. docs: replace COMING SOON integration stubs with full pages, add qui

Fills 12 integration pages that were stubs: Apprise, Cronitor, CrossSeed, DiscordApp, Duplicacy, PackageManager, QbitManage, Reciperr, SimonSays, StarrProxy, Synology, Watchtower. Adds a brand-new qui integration page (torrent / backup / directory-scan / orphan-scan / cross-seed / automation triggers). Apprise content merged with upstream PR #36's official notifiarr:// URL format.

2. docs: add new client feature pages

Seven previously-undocumented client features: Actions, Commands, Endpoints, File Watcher, Metrics, Site Tunnel, System. Defaults verified against the Go source (e.g. commands default Timeout is 15s per pkg/triggers/commands/setup.go defaultTimeout).

3. docs: audit and refresh existing integration pages

35 existing integration pages refreshed. Highlights:

  • Starr (Sonarr/Radarr/Lidarr/Readarr/Prowlarr) trigger labels now match the actual web UI: Imported (not Downloaded), Database Backup / Database Corrupt, Health Check / Health Notifications, Updates / Update Notifications, Grab Notifications (Prowlarr-only).
  • Sonarr step 1: WebhookNotifiarr (matches the intro line which already says "uses its built-in Notifiarr connection").
  • Dockwatch: added the missing Security trigger.
  • Kometa: removed the unverifiable "default error channel" routing claim.
  • mdblist: trigger names List Updates / Add Movie / Add Show; List Tags field; corrected Sonarr Season Monitoring option list.
  • channelstats: required permission is manage channels (not manage roles).
  • bazarr: "notification style" (Simple / Formatted) per PHP, not "notification format".
  • crowdsec: aligned YOUR_APIKEY_HERE placeholder + UI label Show a map for the IP.
  • crossseed: clarified Lookup is a Results sub-type, not a standalone toggleable trigger.
  • discordApp: replaced the unverifiable "8 channels" claim with the 7 actual UI tabs.
  • GitHub: brand normalized to GitHub.
  • jellyfin: section headers Title Case (not NOTIFIARR / JELLYFIN ALL CAPS).
  • network / snapshots / qbitmanage: H1 titles match filename + upstream branding.
  • websitestatus: pre-defined websites (the page previously said "pre-defined indexers", a copy-paste leftover).
  • fail2ban: sudo systemctl restart fail2ban (the previous fail2ban-client restart is not a valid subcommand).
  • passthrough: corrected the Powershell copy-paste bug (referenced $request.details.response but the assigned variable was $response).
  • Broad typo / grammar pass: tooto, Witch channelWhich channel, A APIan API, capitalize list items, missing apostrophes, etc.

4. docs: audit and refresh client, website, FAQ, and ancillary pages

Existing client install/config/troubleshooting + website-side integration management + FAQ / quickstart / custom bot / permissions / translations. Verified-against-source corrections:

  • client/commands default Timeout 15s (was 10s in docs).
  • client/endpoints adds the missing Valid SSL setting row (epconfig.Endpoint.ValidSSL).
  • client/install Synology section: link now points at install-synology.sh (matches the actual curl command on the next line); fixes the $USR$USER typo in the manual UltraCC systemd template; NotifarrNotifiarr; URLs wrapped in backticks in the Windows section.
  • client/healthChecks: pinned commit-SHA URLs replaced with /tree/main/ (so links don't rot); [website] reference now points to notifiarr.com, not nightly.notifiarr.app.
  • client/cloudflare: one.dash.cloudflare.com (lowercase, current production host).
  • client/troubleshooting: deduplicated Config File Compression and Gibberish Config File (same procedure was described twice).
  • website/clientConfig: Witch channelWhich channel; subscriber callout split for clarity.
  • faq: wherewere; legacy notifiarr.wiki URL replaced with the relative path used elsewhere on the page.
  • quickstart: completed the truncated Client Connection sentence.

5. docs: add Seerr integration, retire legacy pages, fix nav

In February 2026 the upstream Jellyseerr and Overseerr teams merged into a single project called Seerr (upstream announcement). Notifiarr followed by replacing both standalone integrations with a unified seerr.php in the web UI. This commit:

  • Adds docs/pages/integrations/seerr.md mirroring the unified integration: 7 triggers (Pending / Approved / Auto approved / Declined / Available / Failed / Issues), all notification fields, Local URL setting, /api/v1/notification/seerr/<api_key> webhook URL.
  • Converts jellyseerr.md and overseerr.md into short deprecation notices that point at the new Seerr page and explicitly attribute the unification to the upstream teams (not a Notifiarr decision).
  • mkdocs.yml: adds Seerr to the integrations nav.
  • Removes docs/pages/client/configuration.md and docs/pages/client/setup.md (deprecated stubs whose content moved into install.md / afterInstall.md and is now covered by the new feature pages in commit 2).

Verification

  • mkdocs build --strict passes with zero warnings
  • All internal links resolve
  • All referenced screenshot files exist
  • Trigger names match the actual web UI (integrations/frontend/*.php)
  • Client config defaults verified against pkg/configfile/ and pkg/triggers/
  • Apprise content reconciles with upstream PR Update Apprise documentation with official link #36
  • Seerr URL / endpoint verified against website-source/integrations/frontend/seerr.php + admin/tests.php

Fills 12 previously-stub integration pages with full content sourced from
the Notifiarr website integration UI (website-source/integrations/frontend):
Apprise, Cronitor, CrossSeed, DiscordApp, Duplicacy, PackageManager,
QbitManage, Reciperr, SimonSays, StarrProxy, Synology, Watchtower.

Adds a new qui.md integration page documenting torrent / backup /
directory-scan / orphan-scan / cross-seed / automation triggers and their
notification fields.

Apprise content merged with the upstream PR Notifiarr#36 official Apprise→Notifiarr
URL format documentation.
Documents seven Notifiarr client features that previously had no wiki page:
Actions, Commands, Endpoints, File Watcher, Metrics, Site Tunnel, System.

Content sourced from the client Go source under pkg/triggers/ (commands,
endpoints, fileupload, filewatch), pkg/configfile, and the client web UI.
Includes default values verified against the Go source (e.g. commands
Timeout default 15s) and the full set of per-instance settings including
env-var equivalents.
Comprehensive audit of 35 existing integration pages cross-referenced
against the Notifiarr website source (integrations/frontend/*.php) and
the client Go source (pkg/triggers/, pkg/apps/).

Highlights:
- Starr (Sonarr/Radarr/Lidarr/Readarr/Prowlarr) trigger labels now match
  the actual web UI: 'Imported' (not Downloaded), 'Database Backup' /
  'Database Corrupt', 'Health Check' / 'Health Notifications', 'Updates' /
  'Update Notifications', 'Grab Notifications' (Prowlarr).
- Sonarr: corrected step 1 'Webhook' -> 'Notifiarr' (matches the intro).
- Dockwatch: added missing Security trigger.
- Watchtower: aligned trigger options with PHP.
- Kometa: removed unverifiable 'default error channel' routing claim.
- mdblist: trigger names 'List Updates' / 'Add Movie' / 'Add Show', 'List
  Tags' field, corrected Sonarr Season Monitoring option list.
- channelstats: 'manage channels' permission (not 'manage roles').
- bazarr: 'notification style' (Simple/Formatted) per PHP.
- crowdsec: aligned YAML placeholder name + UI labels.
- crossseed: clarified 'Lookup' is a Results sub-type, not a standalone trigger.
- discordApp: 7 actual UI tabs replace the unverifiable '8 channels' claim.
- GitHub: title and body normalize to 'GitHub' (upstream brand).
- jellyfin: section headers Title Case (not ALL CAPS).
- network/snapshots/qbitmanage: H1 titles match filename + upstream branding.
- websitestatus: 'pre-defined websites' (not 'indexers').
- fail2ban: 'sudo systemctl restart fail2ban' (the previous 'fail2ban-client restart' is not a valid subcommand).
- passthrough: corrected Powershell variable bug (\$request.details.response -> \$response.details).

Plus broad typo, grammar, and consistency fixes from a phrasing-pass
review: 'too' -> 'to' across many pages, capitalize list items, fix
'Witch channel', 'A API' -> 'an API', missing apostrophes, etc.
Refreshes the existing client install/config/troubleshooting pages and
the website-side integration management pages, plus the FAQ, quickstart,
custom bot, permissions, and translations pages.

Verified-against-source corrections:
- client/commands default Timeout 15s (pkg/triggers/commands/setup.go).
- client/endpoints adds the missing Valid SSL setting row
  (pkg/triggers/endpoints/epconfig.Endpoint.ValidSSL).
- client/install: Synology link now points at install-synology.sh
  (matches the curl command); fixed '\$USR' typo in the manual UltraCC
  systemd unit template (-> '\$USER'); fixed 'Just the add the API key'
  and 'Notifarr' typos; backticks around URLs in the Windows section.
- client/healthChecks: replaced pinned commit-SHA URLs with /tree/main/
  (so links don't rot); [website] reference now points to notifiarr.com
  (not nightly.notifiarr.app).
- client/cloudflare: 'one.dash.cloudflare.com' (lowercase, current host).
- client/reverseProxy: 'poke a hole IN your firewall', 'A working SWAG
  example' word order fix.
- client/troubleshooting: deduplicated 'Config File Compression' and
  'Gibberish Config File' which described the same procedure twice.
- client/afterInstall: 'Enter it - you must provide the All API key...'
  rewrite, Docker users word order fix.
- website/clientConfig: 'Which channel' typo fix, split subscriber
  callout for clarity.
- faq: 'where' -> 'were'; legacy notifiarr.wiki URL replaced with the
  relative path used elsewhere on the page.
- quickstart: completed the truncated 'Client Connection' sentence;
  added missing apostrophe.
- discordbot/custombot, discordbot/permissions: typo and apostrophe fixes.

Plus broad typo and consistency fixes across the same pages from the
phrasing review.
In February 2026 the upstream Jellyseerr and Overseerr projects merged
into a single application named Seerr (https://seerr.dev). Notifiarr
followed by replacing both standalone integrations with a unified
seerr.php in the web UI.

- Add docs/pages/integrations/seerr.md mirroring the unified seerr.php
  integration: 7 triggers (Pending/Approved/Auto approved/Declined/
  Available/Failed/Issues), all notification fields, Local URL setting,
  and the /api/v1/notification/seerr/<api_key> webhook URL.
- Convert jellyseerr.md and overseerr.md into short deprecation notices
  that point at the new Seerr page and attribute the unification to the
  upstream teams (not a Notifiarr decision).
- mkdocs.yml: add Seerr to the integrations nav.
- Remove docs/pages/client/configuration.md and docs/pages/client/setup.md
  (deprecated stubs whose content moved to the install/afterInstall pages
  and is now covered by the new feature pages).

Upstream announcement:
https://docs.seerr.dev/blog/seerr-release/
@bakerboy448 bakerboy448 force-pushed the docs/wiki-alignment branch from 384300a to 6c6a6bb Compare June 7, 2026 14:29
@bakerboy448 bakerboy448 requested review from austinwbest and davidnewhall and removed request for davidnewhall June 7, 2026 15:17
@austinwbest austinwbest merged commit c8a748b into Notifiarr:main Jun 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants