Skip to content

Update Apprise documentation with official link#36

Merged
austinwbest merged 3 commits into
mainfrom
apprise-link
May 24, 2026
Merged

Update Apprise documentation with official link#36
austinwbest merged 3 commits into
mainfrom
apprise-link

Conversation

@bakerboy448

Copy link
Copy Markdown
Collaborator

Updated Apprise documentation to include a link to official documentation and removed placeholder text.

Updated Apprise documentation to include a link to official documentation and removed placeholder text.
- Fix typo in link text (aprriseit.com → appriseit.com)
- Add URL format, required/optional parameters, and requirements
- Follow existing integration page format with admonitions and tables
- Source: appriseit.com/services/notifiarr/
Recommend integration-specific key generated on Notifiarr profile
page instead of requiring a global key. Both work, but integration-
specific is preferred.
@bakerboy448 bakerboy448 requested a review from austinwbest May 24, 2026 17:29
@austinwbest austinwbest merged commit ab1433a into main May 24, 2026
1 check passed
@austinwbest austinwbest deleted the apprise-link branch May 24, 2026 18:48
bakerboy448 added a commit to bakerboy448/mkdocs-wiki that referenced this pull request Jun 7, 2026
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.
austinwbest pushed a commit that referenced this pull request Jun 7, 2026
* docs: replace COMING SOON integration stubs with full pages, add qui

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 #36 official Apprise→Notifiarr
URL format documentation.

* docs: add new client feature pages

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.

* docs: audit and refresh existing integration pages

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.

* docs: audit and refresh client, website, FAQ, and ancillary pages

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.

* docs: add Seerr integration, retire legacy pages, fix nav

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/
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