diff --git a/docs/pages/client/gui.md b/docs/pages/client/gui.md index 792adcb..5979c2e 100644 --- a/docs/pages/client/gui.md +++ b/docs/pages/client/gui.md @@ -37,7 +37,7 @@ The Web UI sidebar is organized into two main sections: - **Configuration** - General settings including API key, bind address, URL base, SSL, logging, and system options. - **Site Tunnel** - Manage the persistent websocket tunnel to notifiarr.com. Select primary and backup tunnels. - **Starr Apps** - Configure Radarr, Sonarr, Lidarr, Readarr, and Prowlarr instances. -- **Download Apps** - Configure Deluge, qBittorrent, rTorrent, SABnzbd, NZBGet, and Transmission. +- **Download Apps** - Configure Deluge, qBittorrent, rTorrent, SABnzbd, NZBGet, and Transmission. Remote-playback turtle mode is toggled from Plex, Jellyfin, and Emby Client Settings on the website; set the alternative limits in qBittorrent first. - **Media Apps** - Configure Plex and Tautulli. - **Snapshot Apps** - Configure MySQL and Nvidia GPU monitoring for snapshots. - **File Watcher** - Watch log files for lines matching regular expressions. diff --git a/docs/pages/integrations/emby.md b/docs/pages/integrations/emby.md index 0015136..91fa828 100644 --- a/docs/pages/integrations/emby.md +++ b/docs/pages/integrations/emby.md @@ -49,6 +49,20 @@ Click the **cog icon** to open the configuration options for Emby. - `Unmonitor movies on finish` - Automatically unmonitor a movie after a user finishes watching (Patron feature, requires valid Radarr information in client) - `Unmonitor episodes on finish` - Automatically unmonitor an episode after a user finishes watching (Patron feature, requires valid Sonarr information in client) +### Client Settings + +The same **qBittorrent Speed Limit** block is on Plex, Jellyfin, and Emby Client Settings so saving any of those pages keeps the others. + +1. `Enabled` - Turn on qBittorrent alternative (turtle) speed limits when remote playback is active. Set the alternative limits in qBittorrent first. +1. `Plex WAN` - Throttle while a Plex movie or episode is playing or paused on WAN (not LAN). +1. `Jellyfin` - Throttle on Jellyfin PlaybackStart and PlaybackStop for movies and episodes. +1. `Emby` - Throttle on Emby playback.start, playback.unpause, playback.stop, and playback.scrobble for movies and episodes. Pause does not turn turtle off. +1. `Cooldown` - How long to wait after remote playback ends before turning alternative speed limits back off. + +Emby webhooks include `Session.RemoteEndPoint`. If that IP is private (LAN or Docker), throttle is skipped. If the field is missing, throttle still runs. + +Plex uses WAN sessions on the client. Emby uses playback webhooks from the website. Plex and qBit must be on the same Notifiarr client. + --- ### Instructions diff --git a/docs/pages/integrations/jellyfin.md b/docs/pages/integrations/jellyfin.md index 7c95721..702127f 100644 --- a/docs/pages/integrations/jellyfin.md +++ b/docs/pages/integrations/jellyfin.md @@ -39,6 +39,20 @@ Click the **cog icon** to open the configuration options for Jellyfin. 1. Notification content options that you can turn on/off to show in the notifications +### Client Settings + +The same **qBittorrent Speed Limit** block is on Plex, Jellyfin, and Emby Client Settings so saving any of those pages keeps the others. + +1. `Enabled` - Turn on qBittorrent alternative (turtle) speed limits when remote playback is active. Set the alternative limits in qBittorrent first. +1. `Plex WAN` - Throttle while a Plex movie or episode is playing or paused on WAN (not LAN). +1. `Jellyfin` - Throttle on Jellyfin PlaybackStart and PlaybackStop for movies and episodes. +1. `Emby` - Throttle on Emby playback.start, playback.unpause, playback.stop, and playback.scrobble for movies and episodes. Pause does not turn turtle off. +1. `Cooldown` - How long to wait after remote playback ends before turning alternative speed limits back off. + +Jellyfin webhooks usually do not include LAN vs WAN. If `RemoteEndPoint` is present and is a private IP, throttle is skipped. If the field is missing, throttle still runs. + +Plex uses WAN sessions on the client. Jellyfin and Emby use playback webhooks from the website. Plex and qBit must be on the same Notifiarr client. + ### Notifiarr ![instructions.png](../../assets/screenshots/integrations/jellyfin/instructions.png) diff --git a/docs/pages/integrations/plex.md b/docs/pages/integrations/plex.md index 5e89dfb..8634593 100644 --- a/docs/pages/integrations/plex.md +++ b/docs/pages/integrations/plex.md @@ -52,7 +52,7 @@ Click the **cog icon** to open the integration settings for Plex. 1. `Triggers` - Adjust which webhooks will send notifications to you. 1. `Integration Settings` - Allows the user to further configure the integration. 1. `Extra Settings` - Adjust the extra settings for this integration. -1. `Client Settings` - Allows the user to set the scanning interval. +1. `Client Settings` - Allows the user to set the scanning interval and qBittorrent alternative speed limits. 1. `Custom Icon` - Assign another icon to notifications from this integration. (Subscriber Feature) 1. `Content Lines` - Add a message to the top of notifications for wearable/toast purposes. 1. `Screenshots` - Shows the expected output once all correctly configured. @@ -133,6 +133,14 @@ Additional settings such as automatically unmonitor an episode or movie once a u 1. `Cooldown` - Minimum time between notifications to ensure duplicates are not sent (such as media.play and playback.started) 1. `Interval` - This is how often to send a notification for the Plex Sessions trigger, nothing sends if there is no media playing or paused. ![interval.png](../../assets/screenshots/integrations/plex/interval.png) +1. `qBittorrent Speed Limit` - Turn on qBittorrent alternative (turtle) speed limits when remote playback is active. Set the alternative limits in qBittorrent first. Plex and qBit must be on the same client. + - `Enabled` - Master switch for this feature. + - `Plex WAN` - Throttle while a Plex movie or episode is playing or paused on WAN (not LAN). + - `Jellyfin` - Throttle on Jellyfin PlaybackStart for movies and episodes. + - `Emby` - Throttle on Emby playback.start and playback.stop for movies and episodes. Pause does not turn turtle off. + - `Cooldown` - How long to wait after remote playback ends before turning alternative speed limits back off. + +The client only turns turtle mode off if it turned turtle mode on. If alternative limits were already enabled in qBittorrent, they stay on when playback ends. ### Custom Icon