Difference between revisions of "SABnzbd"

From ArchWiki
Jump to: navigation, search
(Tips and tricks: typo)
(Stopping SABnzbd: Mention API)
Line 29: Line 29:
  
 
=== Stopping SABnzbd ===
 
=== Stopping SABnzbd ===
{{Note|SABnzbd can be easily shutdown by opening the main menu from the web-interface.}}
+
SABnzbd can be easily shutdown in the web-interface or the [[systemd]] {{ic|sabnzbd}} unit.
  
You need to know the {{ic|host}}, {{ic|port}} and {{ic|API-key}}, which can all be found using the WebUI or by searching through {{ic|sabnzbd.ini}}.
+
It is however also possible to shutdown a running remote SABnzbd client using the provided API:
  
Execute the following command to shutdown SABnzbd:
+
  $ curl "http(s)://host:port/sabnzbd/api?mode=shutdown&apikey=API-key"
 
 
  $ curl "http://host:port/sabnzbd/api?mode=shutdown&apikey=API-key"
 
  
 
=== Accessing the web-interface ===
 
=== Accessing the web-interface ===

Revision as of 18:39, 22 December 2016

SABnzbd is an open-source binary newsreader written in Python.

From sabnzbd.org:

It's totally free, incredibly easy to use, and works practically everywhere. SABnzbd makes Usenet as simple and streamlined as possible by automating everything we can. All you have to do is add an .nzb. SABnzbd takes over from there, where it will be automatically downloaded, verified, repaired, extracted and filed away with zero human interaction.

Installation

Install the sabnzbdAUR or sabnzbd-gitAUR package.

Usage

SABnzbd is able to run globally (settings apply to all users) and locally (per user settings). The way of setting up SABnzbd depends on the way it is intended to be used. A local configuration may prove more useful on a desktop system when used by several people simultaneously.

If SABnzbd is started for the first time, the webinterface will present a setup wizard for configuring UI language and a single news server.

Further configuration can be done from within the UI (adding additional servers, setting folder paths etc.) or by editing sabnzbd.ini.

Using systemd

Both sabnzbdAUR and sabnzbd-gitAUR provide a systemd service, create the user and group sabnzbd, and use /opt/sabnzbd/sabnzbd.ini for configuration.

Add users to the sabnzbd group to allow access to SABnzbd files.

Starting SABnzbd as user

Running $ sabnzbd, without any configuration, results in two processes owned by the launching user: /usr/bin/sabnzbd and /opt/sabnzbd/SABnzbd.py -f /home/user/.sabnzbd.ini.

Append the -d parameter to start SABnzbd as daemon:

$ sabnzbd -d

Stopping SABnzbd

SABnzbd can be easily shutdown in the web-interface or the systemd sabnzbd unit.

It is however also possible to shutdown a running remote SABnzbd client using the provided API:

$ curl "http(s)://host:port/sabnzbd/api?mode=shutdown&apikey=API-key"

Accessing the web-interface

Tip:
  • SABnzbd can only be accessed on the running computer. Change host = 127.0.0.1 in /opt/sabnzbd/sabnzbd.ini to host = 0.0.0.0 (or the host IP-address) to allow access from another computer.
  • SABnzbd listens on port 8080. Change port = 8080 in sabnzbd.ini to the preferred port.

After starting SABnzbd, access the web-interface by browsing to http://127.0.0.1:8080.

Tips and tricks

Enable SSL-support for news servers

Install python2-pyopenssl to enable SSL support for news servers.

The usage of SSL connections is recommend (if supported by the news server):

  • Transmission of data from the server to the NNTP client is encrypted, protecting your privacy.
  • Decreasing the chance of throttling NNTP traffic by the ISP.

See also