SABmini for iPad

Documentation

Setting up SABnzbd

You need to have the SABnzbd application installed and running. This documentation provides no instructions for configuring newsprovider-settings or installing SABnzbd on specific operating systems/devices. You can find the quick setup guide and manual on how to install/configure SABnzbd on the official SABnzbd website.

A couple of settings are required when you want to access the SABnzbd application from other devices in your network. Make sure the SABnzbd Host is set to 0.0.0.0 in the SABnzbd webinterface. (Config > General)

Setup listen address

There are two ways of authentication. The standard setting is to use an API-key but you can also choose to set an username and password.

You can also enable HTTPS for secure communications. A restart of SABnzbd is required to apply the changes.

API key authentication Username and password authentication

Adding your server

To add a server you need the IP address and port of the computer running SABnzbd. You can find a lot of sites on Google that describe how to find the internal IP address for your operating system. Start SABmini for iPad and tap the '+' button to add a server.

In the first field you need to enter a friendly name for your server. The next two fields are the IP address/hostname and port of your server. Enter your API-key or username/password and tap 'Save'. Don't forget to enable the switch for HTTPS if you enabled HTTPS in the SABnzbd webinterface.

Your server will appear in the list on the left after tapping 'Save'. You can edit the server by tapping and holding the server and choosing 'Edit server' from the popup menu. You can only edit/remove the service when it is not connected.

Setting a default server

To setup a default server, tap and hold one of the servers in the list to access a popup-menu. Tap 'Set as default'. SABmini for iPad will automatically connect to this server on startup. You can only have one server as a default server.

Adding a fallback server (optional)

Every server you configure in SABmini for iPad can have a fallback server. If the app can't connect to the main server it will try to connect to the fallback server. When the main server is back up, SABmini will switch back to the main server. To configure a fallback server for a server, tap and hold a server in the server list. A menu will popup where you can tap 'Add fallback server' (If you have already configured a fallback server for this server you can remove it here also). The procedure for adding a fallback server is the same as adding a regular server.

The example image below shows two configured servers in SABmini for iPad. The icon represents the type of connection. The monitor-icon represents a normal connection and a lock-icon a secure connection (HTTPS).

Servers
Add server

The interface

Tap on one of the servers in the list to load it's queue (To disconnect a server, tap and hold the server. This will bring up a menu where you have the option to disconnect). All active and queued downloads will be listed on the right. You can see the progress, size of the download and the estimated time when it's finished downloading. To hide the queue panel in portrait mode, two-finger swipe the queue to the left or use the queue button on the left.

Tap the 'Edit' button in the top-right corner if you want to move or delete a download. To move a download, tap and hold the handle on the right of a download to move it down or up in the queue. To remove a download, tap the red button on the left and tap the delete button*. If you're done, tap 'Done' in the top-right corner.

On the bottom you can pause or resume the queue. If you want the pause the queue for a specific time, tap and hold the pause button for a second. This will show a popup where you can select predefined options or enter a custom number of minutes. (To pause/resume individual downloads, see Queue items) You can search using NZBIndex, Fanzub and your added Newznab indexers by going to the search tab. The history tab shows all downloaded items. Downloads which are in the state of repairing or extracting will also appear in this list. You can view the log of SABnzbd on the warnings tab. On the status tab you can view information about your active server and perform additional operations like restarting/shutting down SABnzbd, set the speed limit and set an action to perform when you queue is finished downloading.

* You can also remove a download without tapping the Edit button. Swipe left on the download you wish to remove and tap the Delete button when it appears.
The interface

Queue items

Tap a download in the queue to view details of the download. You can set the action to perform when the download is finished, run a script, change category, set the priority or change the name of your download. You can view the progress of individual parts by tapping 'View files'.

To pause and resume an individual download, use the pause and resume buttons at the bottom of the details pane. Alternatively you can tap and hold an item in the queue. This will bring up a popup menu. You can also use this menu to quickly change the priority of a download.

Quick menu
Item details

Server status

Go to the status tab to view information and set additional options for your server. Choose 'Set refresh interval' to set the refresh interval for your currently active server (default value is 10 seconds). Set this to a higher value when you are experiencing time-out errors. Select 0 to disable auto-refresh of the queue. This can be useful if you're on a 3G connection and don't want to waste bandwidth. You can manually refresh by pulling the queue down.

To set the download speed limit of the server, tap 'Speed limit'. This will show a popup where you can set the speed limit in KB. The speed limit can be disabled by leaving the box empty.

Tap 'Queue complete action' on the Status tab to choose an action to perform when your queue is finished downloading. Scripts that you have added to SABnzbd will also appear in this list.

You can configure some advanced options for SABnzbd by tapping 'Advanced configuration'. For a description of all the options, check the SABnzbd User Manual. RSS feeds can also be enabled/disabled in this section.

You can also restart/shutdown SABnzbd or open the SABnzbd webinterface for the server from this place.

Status

Adding NZB files

There are four ways to add NZB files to SABmini for iPad: Using a direct NZB link, the built-in search engines, through other applications like Safari or Mail or using custom Newznab indexers.

Manually adding NZB files
If you know the complete URL of the NZB file, go to the Search tab and tap 'Add by URL'. Enter the URL in the popup box.

Using other applications like Safari or Mail

SABmini for iPad can handle files from other applications.For example, you can browse to Binsearch with Safari, select the files that you want and tap 'Create NZB'. Safari will ask which application you would like to use to open this file. Tap 'Open in SABmini'. If SAbmini is not displayed here, tap the 'Open in' button and select SABmini in the list of applications. SABmini will upload the file to your server and it will be added to your queue after SABnzbd has checked the file contents. Supported extensions are NZB, gzip and GZ.

Newznab indexers

SABmini for iPad supports sites that use Newznab as backend. Newznab is a usenet indexing application for building a usenet community. Here you can find some indexers that use Newznab. Look for Newznab in the notes.

To add an indexer, go to the Search tab and tap the '+' button. Specify a friendly name, hostname (or IP address) and API key for the indexer. For example: to add the indexer 'Usenet Crawler', create an account on usenet-crawler.com. In SABmini, enter as hostname 'usenet-crawler.com'. Enter your Usenet Crawler API key in the API key field. (You can find this key on your profile page on usenet-crawler.com).

Tap 'Save' to add the indexer to your list of indexers. Tap the indexer in the list to search or browse categories/groups. You can view details, NFO files (if available) and comments by tapping a result. Tap and hold a result to quickly add it to your queue without viewing the details.

Note that some indexers might have limitations, like a maximum of x requests or x NZB downloads per day. It can also occur that an indexer has disabled their API or only allows paid access to their API.

Search Newznab