SABside ✨ The side panel for SABnzbd

Designed for those who want to see more and take better control of their Usenet setup 👍

(be among the first!)

✨ Features | 🚀 Getting started | 📖 Usage & Tips | 📌 Additional notes

See more screenshots (may not be up to date)

---

  Still in ALPHA stage  

 

✨ Features

• Manage the servers On/Off 👮 directly from the queue: switch servers & change priorities on the fly! ✈️

• Instant speed bar 🚥 for each server/location with customizable style 🌈

• Customizable displayable characters (emoji support) based on minimum 🐢 and/or maximum ⚡ speed thresholds, optionally for specified durations/delays 🕑

• Customizable polling/fetching interval 🔄 and ignore threshold to exclude insignificant speed values 🫣

• Peak cursor 🔼 with optional and customizable persistent freeze duration ❄️🕑

• Separate collapsible sections 📂 for storage and enabled/disabled servers

• Auto-grouping servers 📂 based on display names

• Storage info 💾 with state icons ✔️, early warning system ⚠️ with customizable threshold and queued items extraction anticipation

• Many useful details displayed on hover/tooltips 💬 like periodic stats (d, w, m, y)
  ╰➤ Powered by Hint.css (credit: Kushagra Gour and contributors)

• Settings explanations 📋 via modals

• Direct access link 🔗 to SABnzbd's server configuration page

• Freely positionable, resizable and collapsible panel ✨

• User preferences are persistent 💾 using your script manager's store (i.e. GM API)

 

🚀 Getting started

Install the userscript using your favorite script manager (Greasemonkey or Violentmonkey recommended).

In SABnzbd, make sure that Configuration > General > Settings > Maximum line speed (bandwidth_max_value) is > 0 to allow SABside's speed bar calculation and display.

For custom domain/port (local or remote)

By default, SABside only targets the default SABnzbd host and port (127.0.0.1:8080, localhost:8080). You will need to update the @match values to match your own setup.

Caution

@match is not and cannot be made persistent, so your value will be overridden at each update and needs to be set again after.
Read the Disclaimer for a better understanding of this approach.

For large screen resolutions

To limit or avoid overlap with the SABnzbd interface, it is highly recommended to disable Always use full screen width (displayFullWidth) option in SABnzbd's Status and interface options. Full width for SABnzbd is useless on large screens anyway.

For more accurate Storage info

It is recommended to enable Pause downloading during post-processing (pause_on_post_processing) option in Configuration > Switches > # Post processing.

This makes the calculation of the Queued value (optimized for this script) more accurate in SABside's Storage section, since it takes into account the volume consumed on the drive during file extraction (only for NZBs with a status of Downloading, excluding Paused).

Note

If you have explicitly disabled auto-extraction after download, the script won't care at all and will continue to act as if the files were scheduled to be extracted after each download.

 

📖 Usage & Tips

Force refresh

For optimization purposes, some automatic refresh mechanisms in SABside are put on hold when there is no activity in the queue or when SABnzbd is paused. This particularly affects server stats and storage info. If necessary, the refresh button at the top of the panel allows you to force a poll/fetch of this data (especially if you have explicitly paused auto polling).

Servers quick On/Off switch

Very simple:

• To Enable 🟢: click on the server name from the 🔴 Disabled servers section.
• To Disable 🔴: click on the server name from the 🟢 Enabled servers section.

Servers priorities quick edit

Easy too: just click on the priority square (before a server name in the list), set a new value, then press Enter or click anywhere to apply (press Esc to cancel).

Note

After applying a new value, queue activity is briefly suspended to force the daemon to reload the servers list and new priorities. If several servers have the same priority number, priorities will then be managed as usual by SABnzbd (i.e. alphabetical order).

Allow SABside outside the queue

If you want to display SABside panel from any page of SABnzbd UI, you can add a wildcard at the end of @match URL. Example: @match http://localhost:8080/*

Important

Remember that any change directly in the script will be lost to the next update.

Custom style

Tip

To change or create your speed bar linear-gradient, check some examples, then paste your background: property in the settings textarea.
Get more info about supported formats in the settings modal from SABside.

Any other custom style overrides can be performed non-destructive / update-resistant using Stylus.

 

📌 Additional notes

About graceful shutdown

SABnzbd performs a graceful shutdown of connections as possible. This means that requests sent to the servers before the shutdown signal will be honored, and the associated content will be downloaded. In practice, this means that downloads may continue for a few seconds after the shutdown signal is sent, which also explains why SABside continues to display positive speeds (even though the SABnzbd graph bar displays 0...) until all connections have actually stopped.

Known issues

• Some tooltips may be cut off the panel (depending on your setup).

• Except for first run, panel can doesn't display from a compact viewport, needs to expand to display it again.

• If you use DarkReader on Chromium-based browser, expect some unwanted overrides (recommended to add SABnzbd as exclusion).

• Server switches can cause some queue warning messages (without consequences).

• In rare scenarios, you may need to reload the page to see expected changes in SABside
  (ex: "No servers configured" message may persist even after the servers have been re-enabled.).

• And other reported issues.

Disclaimer

Before reporting issues, keep all this in mind:

• Firefox-based first — Full Firefox-based browsers compatibility support, DarkReader (any mode) included.

• Remote instances — No guarantee of full stability over remote connections, depends on many factors.

• Stats polling — Stats calculation can be resource-heavy. Any value under 10–15s is not recommended.

• Custom configs / post-processing scripts — May cause undesirable effects: check with and without.

• No i18n — Strings are and will still hard-coded in english to keep the UI (and code) compact.

• SABside is limited — It's a userscript, not a rework of SABnzbd UI or a dashboard for nerds.

 

ﮩﮩﮩ٨ـﮩﮩ٨ـ𖹭ﮩ٨ـﮩﮩ٨ـﮩ