mirror of
https://github.com/plexguide/Huntarr.io.git
synced 2026-02-20 07:44:17 -05:00
2997382d37
- Move donate page from help/donate.html to donate.html (URL: .../donate.html) - Update all doc links and README to new donate URL - Sidebar Donate link: red border, left accent, subtle red glow and background - Applies to all doc pages via shared main.css
284 lines
13 KiB
HTML
284 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>Notifications - Huntarr Docs</title>
|
|
<link rel="icon" type="image/png" href="../images/huntarr-logo.png">
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
<link rel="stylesheet" href="../css/main.css">
|
|
</head>
|
|
<body>
|
|
|
|
<!-- Mobile Topbar -->
|
|
<div class="docs-mobile-topbar">
|
|
<button class="mob-hamburger" aria-label="Open navigation"><span></span><span></span><span></span></button>
|
|
<img src="../images/huntarr-logo.png" alt="Huntarr" class="mob-logo">
|
|
<span class="mob-title">Documentation</span>
|
|
</div>
|
|
|
|
<!-- Sidebar Backdrop (mobile) -->
|
|
<div class="docs-sidebar-backdrop"></div>
|
|
|
|
<div class="docs-layout">
|
|
|
|
<!-- ===== SIDEBAR ===== -->
|
|
<nav class="docs-sidebar" aria-label="Documentation navigation">
|
|
<a href="../index.html" class="sidebar-brand">
|
|
<img src="../images/huntarr-logo.png" alt="Huntarr">
|
|
<span>Huntarr</span>
|
|
</a>
|
|
|
|
<div class="sidebar-scroll">
|
|
|
|
<!-- Getting Started -->
|
|
<div class="nav-group">
|
|
<div class="nav-group-title">Getting Started</div>
|
|
<div class="nav-group-items">
|
|
<a href="../index.html"><i class="fas fa-home"></i> Welcome</a>
|
|
<a href="../getting-started/installation.html"><i class="fas fa-download"></i> Installation</a>
|
|
<a href="../getting-started/setup-wizard.html"><i class="fas fa-magic"></i> Setup Wizard</a>
|
|
<a href="../getting-started/first-steps.html"><i class="fas fa-rocket"></i> First Steps</a>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Apps -->
|
|
<div class="nav-group">
|
|
<div class="nav-group-title">Apps</div>
|
|
<div class="nav-group-items">
|
|
<a href="../apps/index.html"><i class="fas fa-th-large"></i> Overview</a>
|
|
<a href="../apps/sonarr.html"><i class="fas fa-tv"></i> Sonarr</a>
|
|
<a href="../apps/radarr.html"><i class="fas fa-film"></i> Radarr</a>
|
|
<a href="../apps/lidarr.html"><i class="fas fa-music"></i> Lidarr</a>
|
|
<a href="../apps/readarr.html"><i class="fas fa-book"></i> Readarr</a>
|
|
<a href="../apps/whisparr.html"><i class="fas fa-mask"></i> Whisparr</a>
|
|
<a href="../apps/prowlarr.html"><i class="fas fa-search"></i> Prowlarr</a>
|
|
<a href="../apps/swaparr.html"><i class="fas fa-exchange-alt"></i> Swaparr</a>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Movie Hunt -->
|
|
<div class="nav-group">
|
|
<div class="nav-group-title">Movie Hunt</div>
|
|
<div class="nav-group-items">
|
|
<a href="../movie-hunt/index.html"><i class="fas fa-clapperboard"></i> Overview <span class="nav-badge nav-badge-beta">Beta</span></a>
|
|
<a href="../movie-hunt/media-collection.html"><i class="fas fa-photo-film"></i> Media Collection</a>
|
|
<a href="../movie-hunt/indexers-clients.html"><i class="fas fa-server"></i> Indexers & Clients</a>
|
|
<a href="../movie-hunt/profiles.html"><i class="fas fa-sliders"></i> Profiles</a>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- NZB Hunt -->
|
|
<div class="nav-group">
|
|
<div class="nav-group-title">NZB Hunt</div>
|
|
<div class="nav-group-items">
|
|
<a href="../nzb-hunt/index.html"><i class="fas fa-newspaper"></i> Overview <span class="nav-badge nav-badge-beta">Beta</span></a>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Requestarr -->
|
|
<div class="nav-group">
|
|
<div class="nav-group-title">Requests</div>
|
|
<div class="nav-group-items">
|
|
<a href="../requestarr/index.html"><i class="fas fa-hand-paper"></i> Requests</a>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Settings -->
|
|
<div class="nav-group">
|
|
<div class="nav-group-title">Settings</div>
|
|
<div class="nav-group-items">
|
|
<a href="index.html"><i class="fas fa-cog"></i> Main Settings</a>
|
|
<a href="scheduling.html"><i class="fas fa-clock"></i> Scheduling</a>
|
|
<a href="notifications.html" class="active"><i class="fas fa-bell"></i> Notifications</a>
|
|
<a href="backup-restore.html"><i class="fas fa-database"></i> Backup & Restore</a>
|
|
<a href="log-settings.html"><i class="fas fa-file-alt"></i> Log Settings</a>
|
|
<a href="user-account.html"><i class="fas fa-user-shield"></i> User Account</a>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- System -->
|
|
<div class="nav-group">
|
|
<div class="nav-group-title">System</div>
|
|
<div class="nav-group-items">
|
|
<a href="../system/hunt-manager.html"><i class="fas fa-tasks"></i> Hunt Manager</a>
|
|
<a href="../system/logs.html"><i class="fas fa-scroll"></i> Logs</a>
|
|
<a href="../system/api.html"><i class="fas fa-code"></i> API Reference</a>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Help -->
|
|
<div class="nav-group">
|
|
<div class="nav-group-title">Help</div>
|
|
<div class="nav-group-items">
|
|
<a href="../help/faq.html"><i class="fas fa-question-circle"></i> FAQ</a>
|
|
<a href="../help/community.html"><i class="fas fa-users"></i> Community</a>
|
|
<a href="https://plexguide.github.io/Huntarr.io/donate.html"><i class="fas fa-heart"></i> Donate</a>
|
|
</div>
|
|
</div>
|
|
|
|
</div><!-- /sidebar-scroll -->
|
|
|
|
<div class="sidebar-footer">
|
|
<a href="https://discord.com/invite/PGJJjR5Cww" target="_blank" class="sf-discord" title="Discord"><i class="fab fa-discord"></i></a>
|
|
<a href="https://www.reddit.com/r/huntarr/" target="_blank" class="sf-reddit" title="Reddit"><i class="fab fa-reddit-alien"></i></a>
|
|
<a href="https://github.com/plexguide/Huntarr.io" target="_blank" class="sf-github" title="GitHub"><i class="fab fa-github"></i></a>
|
|
<a href="https://plexguide.github.io/Huntarr.io/donate.html" class="sf-heart" title="Donate"><i class="fas fa-heart"></i></a>
|
|
</div>
|
|
</nav>
|
|
|
|
<!-- ===== MAIN ===== -->
|
|
<main class="docs-main">
|
|
<div class="docs-content">
|
|
|
|
<h1>Notifications</h1>
|
|
<p class="page-subtitle">Get alerted when Huntarr finds, grabs, or downloads media.</p>
|
|
|
|
<h2>Overview</h2>
|
|
<ul>
|
|
<li>Huntarr supports multiple notification providers</li>
|
|
<li>Each connection can be scoped to specific apps and instances</li>
|
|
<li>Test notifications before relying on them</li>
|
|
</ul>
|
|
|
|
<h2>Supported Providers</h2>
|
|
<div class="card-grid">
|
|
<div class="card">
|
|
<div class="card-icon icon-blue"><i class="fab fa-discord"></i></div>
|
|
<h3>Discord</h3>
|
|
<p>Webhooks for Discord channels</p>
|
|
</div>
|
|
<div class="card">
|
|
<div class="card-icon icon-blue"><i class="fab fa-telegram"></i></div>
|
|
<h3>Telegram</h3>
|
|
<p>Bot messages to Telegram chats</p>
|
|
</div>
|
|
<div class="card">
|
|
<div class="card-icon icon-green"><i class="fas fa-envelope"></i></div>
|
|
<h3>Email</h3>
|
|
<p>SMTP email notifications</p>
|
|
</div>
|
|
<div class="card">
|
|
<div class="card-icon icon-purple"><i class="fas fa-mobile-alt"></i></div>
|
|
<h3>Pushover</h3>
|
|
<p>Push notifications to devices</p>
|
|
</div>
|
|
<div class="card">
|
|
<div class="card-icon icon-green"><i class="fas fa-paper-plane"></i></div>
|
|
<h3>Pushbullet</h3>
|
|
<p>Push notifications across devices</p>
|
|
</div>
|
|
<div class="card">
|
|
<div class="card-icon icon-cyan"><i class="fas fa-bell"></i></div>
|
|
<h3>Apprise</h3>
|
|
<p>Universal notification gateway</p>
|
|
</div>
|
|
<div class="card">
|
|
<div class="card-icon icon-gold"><i class="fab fa-slack"></i></div>
|
|
<h3>Slack</h3>
|
|
<p>Webhooks for Slack channels</p>
|
|
</div>
|
|
<div class="card">
|
|
<div class="card-icon icon-orange"><i class="fas fa-bell"></i></div>
|
|
<h3>Notifiarr</h3>
|
|
<p>Centralized notification management</p>
|
|
</div>
|
|
</div>
|
|
|
|
<h2>Adding a Connection</h2>
|
|
<ol>
|
|
<li>Go to Settings > Notifications</li>
|
|
<li>Click "Add Connection"</li>
|
|
<li>Select a provider</li>
|
|
<li>Configure the provider settings (see below)</li>
|
|
<li>Set the scope (which apps/instances trigger this notification)</li>
|
|
<li>Send a test notification</li>
|
|
<li>Save</li>
|
|
</ol>
|
|
|
|
<h2>Provider Configuration</h2>
|
|
|
|
<h3>Discord</h3>
|
|
<table>
|
|
<thead>
|
|
<tr><th>Setting</th><th>Description</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr><td><strong>Webhook URL</strong></td><td>Your Discord channel webhook URL</td></tr>
|
|
</tbody>
|
|
</table>
|
|
<p>How to get a webhook: Server Settings > Integrations > Webhooks > New Webhook > Copy URL</p>
|
|
|
|
<h3>Telegram</h3>
|
|
<table>
|
|
<thead>
|
|
<tr><th>Setting</th><th>Description</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr><td><strong>Bot Token</strong></td><td>From @BotFather on Telegram</td></tr>
|
|
<tr><td><strong>Chat ID</strong></td><td>Your chat or group ID</td></tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<h3>Email (SMTP)</h3>
|
|
<table>
|
|
<thead>
|
|
<tr><th>Setting</th><th>Description</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr><td><strong>SMTP Server</strong></td><td>Mail server hostname</td></tr>
|
|
<tr><td><strong>SMTP Port</strong></td><td>Usually 587 (TLS) or 465 (SSL)</td></tr>
|
|
<tr><td><strong>Username</strong></td><td>Email account username</td></tr>
|
|
<tr><td><strong>Password</strong></td><td>Email account password</td></tr>
|
|
<tr><td><strong>From Address</strong></td><td>Sender email address</td></tr>
|
|
<tr><td><strong>To Address</strong></td><td>Recipient email address</td></tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<h3>Pushover</h3>
|
|
<table>
|
|
<thead>
|
|
<tr><th>Setting</th><th>Description</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr><td><strong>User Key</strong></td><td>Your Pushover user key</td></tr>
|
|
<tr><td><strong>API Token</strong></td><td>Your Pushover application token</td></tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<h2>Scoping Notifications</h2>
|
|
<p>Each connection can be limited to specific apps:</p>
|
|
<ul>
|
|
<li><strong>All Apps</strong>: Triggers for any app</li>
|
|
<li><strong>Specific App Type</strong>: Only triggers for Sonarr, Radarr, etc.</li>
|
|
<li><strong>Specific Instance</strong>: Only triggers for a particular instance</li>
|
|
</ul>
|
|
<p>This lets you route different apps to different channels/recipients.</p>
|
|
|
|
<h2>Tips</h2>
|
|
<ul>
|
|
<li>Always send a test notification when setting up a new connection</li>
|
|
<li>Use scoping to avoid notification spam</li>
|
|
<li>Discord webhooks are the easiest to set up</li>
|
|
<li>Apprise supports 80+ services if your preferred one isn't listed directly</li>
|
|
</ul>
|
|
|
|
<div class="alert alert-info">
|
|
<strong>Multiple connections</strong>
|
|
<p>You can have multiple notification connections. For example, Discord for movies and Telegram for TV shows.</p>
|
|
</div>
|
|
|
|
</div><!-- /docs-content -->
|
|
|
|
<footer class="docs-footer">
|
|
<p>Huntarr is open source. <a href="https://github.com/plexguide/Huntarr.io" target="_blank">GitHub</a> · <a href="https://discord.com/invite/PGJJjR5Cww" target="_blank">Discord</a> · <a href="https://www.reddit.com/r/huntarr/" target="_blank">Reddit</a></p>
|
|
</footer>
|
|
</main>
|
|
|
|
</div><!-- /docs-layout -->
|
|
|
|
<button class="back-to-top" aria-label="Back to top"><i class="fas fa-arrow-up"></i></button>
|
|
<script src="../js/main.js"></script>
|
|
</body>
|
|
</html>
|