aforty/sabnzbd-knockstrap

An interface/theme for SABnzbd

Knockstrap

What is this?

Knockstrap is a theme for SABnzbd, the popular automated Usenet download tool. It brings a larger, more modern, brighter and cleaner look to one of your favorite tools.

Features

• Clean interface: Large fonts, clean layout, easy to navigate
• Responsive design: looks great on all your devices
• Rewritten: Completely rewritten from scratch, not based on Plush
• Update system: it will inform you when a new version of Knockstrap is available
• Uses KnockoutJS and Bootstrap

How to I install it?

• Download the latest version
• Extract the Knockstrap folder into /path/to/sabnzbd/interfaces/knockstrap
• Select Knockstrap from the available skins (config->general->skin)
• Restart SABnzbd to see the changes take effect

Alternatively, you can clone directly from GitHub and I trust you to know how to do that.

It's missing something!

Yes I'm aware that despite my best efforts this still lacks in a few aspects behind the built-in Plush theme. Good news though, this is GitHub! So, fork the project, grab your favorite text editor, make the changes you need and send me a pull request.

Code? I only want to change the look...

So you know CSS? Right on, I made it so that you can easily change the look and feel while keeping the code base. Fork the project, add a new CSS file as Knockstrap/templates/static/stylesheets/colorschemes/yourname.css. Next time you relaunch SABnzbd you will see your color scheme in the themes drop down as 'Knockstrap - yourname'. Cool huh?

Is it good enough to share with everyone else? I'd love to include it, send a pull request so that you can get proper credit.

Why did you do this?

Why does anyone do anything? I got bored. Well, I also wanted a theme that would play well on both mobile and desktop, since mobile and tablet are quickly becoming my #1 way of using this tool. SABnzbd offers a secondary mobile skin, but separate sites for desktop and mobile? How 2005. I needed a responsive design. I found that there were some core layout problems and oddities that stopped me from giving this kind of responsive makeover to Plush. So I needed to redo this from scratch and the fastest way I knew how was Twitter's Bootstrap. So out of the box Knockstrap is responsive and looks great at any screen size.

While I was at it, I wasn't going to use Cheetah's somewhat arcane markup language either. Template files with special markup that get parsed on the server on every request? No thanks. So I was going to rebuild this as a client side javascript app, pulling info as needed from the available json api. Client side MVVM anyone? Enter Knockout.

Combine these two and you have the magic sauce for a beautiful and responsive client side application worthy of SABnzbd. Hope you enjoy!

I need to contact you!

Ok, follow me on Twitter @aforty, or head over to the original forum thread and post your thoughts or questions.

sabnzbd-knockstrap's Issues

Not responding in IE 11

Hi,

Just checking out this promising skin and found an issue. It looks like it is not responding to clicks at for instance the garbage bin. Also pressing on the download name is not doing anything. I see progress info and can go to the next page. In chrome it works fine. I'm running windows 8.1. Any clues?

Access to the log

I can't seem to find a way to get to the log through your interface. I can see an error in the status list and i need to get to the log to see more detail.

Love the theme by the way, its awesome!

issues

my two cents, feel free to ignore if you want :)

using latest version of firefox, noticed that the top nav ui doesn't really do much.. i would assume it should have loaded a different view (history/queue/home) but it doesn't.. so i thought it should at least jump down to where it is on the page.. it doesn't. told it to restart and you don't get any indication that its doing anything.. looks like a interesting start of a theme.. but that's what it feels like.. just a partial theme for right now.

the responsive ui works great when you are really changing devices, not so much when your on a desktop and your just changing the browser size. should adapt that to be a little smarter. desktop resolution and desktop app's viewpoint are two different things.

anyways if you wanna talk more jump on the sabnzbd channel.

Smooth scroll to Queue/History/Status sections

When selected from top nav make the browser smooth-scroll to the selected section.

Bug: Landscape tablet layout

Minor layout bug with Tablet (e.g. Apple iPad 2-3rd, mini).
To simulate this I used Viewport Resizer (http://lab.maltewassermann.com/viewport-resizer/).

Size: 768x1024 (Portrait), Ratio: 3:4:

Size: 1024x768 (Landscape), Ratio: 4:3

More "Clear History" Options

The default skin has 3 options for clearing history.

$URL/config/ gives 500 Error

On Debian Wheezy with sabnzbdplus in Version 0.6.15-1 from Debian Repository ( CherryPy 3.2.0 / Version: 2.3.0-3 from Repository) there is:

500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

Traceback (most recent call last):
  File "/usr/share/sabnzbdplus/cherrypy/_cprequest.py", line 618, in respond
    cherrypy.response.body = self.handler()
  File "/usr/share/sabnzbdplus/cherrypy/_cpdispatch.py", line 25, in __call__
    return self.callable(*self.args, **self.kwargs)
  File "/usr/share/sabnzbdplus/sabnzbd/interface.py", line 1015, in index
    filter=FILTER, searchList=[conf], compilerSettings=DIRECTIVES)
  File "/usr/lib/python2.7/dist-packages/Cheetah/Template.py", line 1259, in __init__
    self._compile(source, file, compilerSettings=compilerSettings)
  File "/usr/lib/python2.7/dist-packages/Cheetah/Template.py", line 1546, in _compile
    self._fileMtime = os.path.getmtime(file)
  File "/usr/lib/python2.7/genericpath.py", line 54, in getmtime
    return os.stat(filename).st_mtime
OSError: [Errno 2] Datei oder Verzeichnis nicht gefunden: '/usr/share/sabnzbdplus/interfaces/Knockstrap/templates/config.tmpl'

Search/Filter feature

When the queue gets large, the Search/Filter feature in the default skin is super useful. Would love to see it here.

Bug: Queue items per page

Queue items per page does not work.
When I set it to 10 or 5 it won't change, it's still showing 20 items.

Show disk space and other stats

Somewhere, and hidden by default, should be a nice clean way to view certain stats that are available through the SABnzbd API. Thinking there has to be a way to display these rich and visual way that provides value at a glance but details upon inspect, not a boring table with labels and text stats.

Pause for XX minutes

Hi,

Is there any way to add the pause for X minutes into this skin? I use this all the time otherwise I forgot that it was paused.

Thanks for creating a such a great skin.

Add Restart/Shutdown handler

When restarting or shutting down I'd like to handle via API and show a message within the skin rather than the ugly SABnzbd black-text-on-white default.

When shutting down it should continue pinging the server and once deemed shutdown (requests start being refused/timing out) then display a message on an overlay "SABnzbd has been shut down."

Similarly when restarting never show SABnzbd's default, instead show an overlay with a progress spinner and a message urging patience. In the background we continue polling the server via AJAX, once the server has come back up it should refresh from all the endpoints, etc.

The goal of this is to eliminate the SABnzbd default. This will of course only apply when a restart/shutdown in performed from WITHIN Knockstrap since the SABnzbd Config pages cannot be changed.

"Processing" mode not set correctly

When a new download is added, "Processing" settings (I have "+Delete" set) are ignored and the skin sets "Download" instead.

Changing the Category correctly updates the Processing mode to the right value.

Change how queue re-ordering works

Implement a "re-ordering mode" (think iOS homescreen icon re-ordering, with icon wiggle and all). When enabled queue items become re-orderable though drag/touch. New positions will be locked immediately but the re-ordering mode is disageged by pressing a button or clicking anywhere outside the queue area.

This should also allow queues to be re-ordering on mobile/touch devices since there is now a specific mode where Knockstrap starts paying attention to move/drag events. Otherwise this might interfere with normal scrolling on a touch device.

How to set NZB Password?

How does one set a password for a download? I cant figure it out.