docs: comprehensive wiki update and gap fill#38
Merged
Conversation
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/
384300a to
6c6a6bb
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 --strictpasses with zero warnings.Commits (in review order)
1.
docs: replace COMING SOON integration stubs with full pages, add quiFills 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 pagesSeven previously-undocumented client features: Actions, Commands, Endpoints, File Watcher, Metrics, Site Tunnel, System. Defaults verified against the Go source (e.g.
commandsdefault Timeout is15sperpkg/triggers/commands/setup.godefaultTimeout).3.
docs: audit and refresh existing integration pages35 existing integration pages refreshed. Highlights:
Imported(notDownloaded),Database Backup/Database Corrupt,Health Check/Health Notifications,Updates/Update Notifications,Grab Notifications(Prowlarr-only).Webhook→Notifiarr(matches the intro line which already says "uses its built-in Notifiarr connection").Securitytrigger.List Updates/Add Movie/Add Show;List Tagsfield; corrected Sonarr Season Monitoring option list.manage channels(notmanage roles).YOUR_APIKEY_HEREplaceholder + UI labelShow a map for the IP.Lookupis a Results sub-type, not a standalone toggleable trigger.GitHub.NOTIFIARR/JELLYFINALL CAPS).pre-defined websites(the page previously said "pre-defined indexers", a copy-paste leftover).sudo systemctl restart fail2ban(the previousfail2ban-client restartis not a valid subcommand).$request.details.responsebut the assigned variable was$response).too→to,Witch channel→Which channel,A API→an API, capitalize list items, missing apostrophes, etc.4.
docs: audit and refresh client, website, FAQ, and ancillary pagesExisting client install/config/troubleshooting + website-side integration management + FAQ / quickstart / custom bot / permissions / translations. Verified-against-source corrections:
client/commandsdefault Timeout 15s (was 10s in docs).client/endpointsadds the missing Valid SSL setting row (epconfig.Endpoint.ValidSSL).client/installSynology section: link now points atinstall-synology.sh(matches the actualcurlcommand on the next line); fixes the$USR→$USERtypo in the manual UltraCC systemd template;Notifarr→Notifiarr; 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 tonotifiarr.com, notnightly.notifiarr.app.client/cloudflare:one.dash.cloudflare.com(lowercase, current production host).client/troubleshooting: deduplicatedConfig File CompressionandGibberish Config File(same procedure was described twice).website/clientConfig:Witch channel→Which channel; subscriber callout split for clarity.faq:where→were; legacynotifiarr.wikiURL replaced with the relative path used elsewhere on the page.quickstart: completed the truncatedClient Connectionsentence.5.
docs: add Seerr integration, retire legacy pages, fix navIn 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.phpin the web UI. This commit:docs/pages/integrations/seerr.mdmirroring 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.jellyseerr.mdandoverseerr.mdinto 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.docs/pages/client/configuration.mdanddocs/pages/client/setup.md(deprecated stubs whose content moved intoinstall.md/afterInstall.mdand is now covered by the new feature pages in commit 2).Verification
mkdocs build --strictpasses with zero warningsintegrations/frontend/*.php)pkg/configfile/andpkg/triggers/website-source/integrations/frontend/seerr.php+admin/tests.php