Configuring NZB handling - spotweb/spotweb GitHub Wiki
Spotweb currently suppors the following NZB handling options:
- No integration with a download client
- Call Sabnzbd+ using HTTP by Spotweb
- Call Sabnzbd+ using the users’ browser
- Save file to disk
- Save file to disk and run a command
- Call NZBget using HTTP by Spotweb
- Call NZBVortex using HTTP by Spotweb
Whether these options are available depends on the permissions a user has, some operations can be ‘dangerous’ to be available for non-trusted users and are prohibited for several users.
By default all users which are a member of the ‘Administrators’ group, have access to all NZB handling options. However, we don’t suggest just adding everybody to the administrators group as this will expose your Spotweb installation.
For maximum control, you can create a separate security group for each of the (set of) NZB handling options you want to be able to grant access to.
To create a new group, login using a user with administrative permissions – the user ‘admin’ for example. Now open the ‘Admin panel’ and click on the tab ‘Grouplist’. Add a new group by clicking on the ‘+’-button.
Enter a new group name – eg: ‘NZB Handling – NZBGet’. Add this group, and click on the pencil icon in the ‘Permissions’-column. Add the ‘Download manager integration’-permission. For the ‘ObjectID’ you enter the value ‘nzbget’ (without quotes). The ObjectID basically defines which type of NZB handling is allowed for users which are a member of this group.
| NZB handling | Object-id | Download panel support | |
|---|---|---|---|
| No integration with download client | disable | No | All users |
| Call SABnzbd through HTTP by SpotWeb | push-sabnzbd | Yes | When permission is granted |
| Run SABnzbd through users’ browser | client-sabnzbd | No | All users |
| Save to file on disk | save | No | When permission is granted |
| Save file to disk and run a command | runcommand | No | When permission is granted |
| Call NZBGet through HTTP by SpotWeb | nzbget | Yes | When permission is granted |
| Call NZBVortex using HTTP by Spotweb | nzbvortex | Yes | When permission is granted |
Spotweb also supports a ‘download panel’. This is a way to check your download progress from another download client within Spotweb itself. If your chosen download method supports this, please add the following permission to your group.
Use downloads manager APIFollow these steps to achieve this:
- Click on the ‘config’ button
- Click on ‘User & group management’
- Click on Grouplist
- Press the + sign at the bottom of this group list
- Use the following as name: Use downloads manager API
- Go to the Userlist and click on the user you want to give this permission.
- Select the checkbox before Use downloads manager API and save it.
Now the user is able to select the granted download method using its’ preference screen.
This option is usually known as ‘push-sabnzbd’, its internal name and as used by the objectid.
The NZB file is uploaded to Sabnzbd by Spotweb itself. When the user also has the permission to use the Sabnzbd API, it allows the download panel.
When Sabnzbd needs to be accessed through the internet by Spotweb, this requires a setup on your router to make sure Spotweb can reach Sabnzbd directly. Usually this requires a portforward but this is outside of the scope of this documentation.
| URL to SABnzbd (HTTP included and portnumber where SABnzbd is installed) | When SpotWeb and Sabnzbd run on the same host, you can enter ‘http://localhost:8080/’ here (assuming Sabnzbd runs on port 8080). When Spotweb and Sabnzbd run on separate hosts, enter the hostname or IP address and the portname here. Please do not add ‘/sabnzbd’ here, Spotweb will automatically add it. |
| API key for sabnzbd? | You can lookup the API key in the Sabnzbd configuration. If you only enter the NZB key here, the download panel will not work. |
| Download panel is not working? | You need to run Sabnzbd 0.6.0 or higher to have this panel available. A howto is available on: http://wiki.sabnzbd.org/quick-setup |
This option is usually known as ‘client-sabnzbd’, its internal name and as used by the objectid.
The “NZB” download button links directly to your Sabnzbd client. When you click on this link, your browser (the client) will open the link to Sabnzbd. The passed parameters to Sabnzbd define where Sabnzbd should download the NZB file.
When you have locked down your Spotweb by either a firewall, or an username and password so Spotweb is not available for your Sabnzbd system, it fails to download the NZB file from Spotweb and it will also fail to download the file to your system.
Client-sabnzbd does not support the download panel.
| URL to SABnzbd (HTTP included and portnumber where SABnzbd is installed) | When SpotWeb and Sabnzbd run on the same host, you can enter ‘http://localhost:8080/’ here. This is usually not what you want. Please do not add ‘/sabnzbd’ here, Spotweb will automatically add it. |
| API key for sabnzbd? | You can lookup the API key in the Sabnzbd configuration. |
| Download panel is not working? | The download panel is not supported using client-sabnzbd |
Save the file to disk. Please note, Spotweb can only save on its local file system. If Spotweb runs on your NAS for example, it will save the NZB file on your NAS – not on your PC.
| Where shall we store the file? | Enter the full path where to save the NZB, for example /tmp/nzb. == >If you want to use the Sabnzdb category mapping, you can use the placeholder $SABNZBDCAT here. It will be replaced by the mapped category. For example /tmp/nzb/$SABNZBDCAT/ |
Save the file to disk. Please note, Spotweb can only save on its local file system. If Spotweb runs on your NAS for example, it will save the NZB file on your NAS – not on your PC. Of course, the same goes for the command to execute – this program will also be started on your NAS.
| Where shall we store the file? | Enter the full path where to save the NZB, for example /tmp/nzb. == >If you want to use the Sabnzdb category mapping, you can use the placeholder $SABNZBDCAT here. It will be replaced by the mapped category. For example /tmp/nzb/$SABNZBDCAT/ |
| What program should be executed? | Enter the full path to the program which needs to be run. if you want, you can use the placeholders $SPOTTITLE and $NZBPATH as parameters. $SPOTTITLE will be replaced by the title of the spot, and $NZBPATH will be replaced by the full path to the NZB file. |
The NZB file will be uploaded by Spotweb to NZBget. When the user has the appropriate permissions, the download panel will be avilable.
When NZBget needs to be accessed through the internet by Spotweb, this requires a setup on your router to make sure Spotweb can reach NZBget directly. Usually this requires a portforward but this is outside of the scope of this documentation.
| Host name of nzbget? | When SpotWeb and NZBget run on the same host, you can enter ‘localhost’ here. When Spotweb and NZBget run on separate hosts, enter the hostname or IP address here. |
| Port number of nzbget? | Enter portnumber which NZBget is listening on. The default setting of NZBGet is port 6789. You can change this portnumber in ‘nzbget.conf’, defined by the ‘ServerPort’ variable |
| Username for nzbget? | NZBGet currently does not support any other username than ‘nzbget’, but if one day it will, Spotweb is prepared.. Enter ‘nzbget’. |
| Password for nzbget? | Enter the NZBget password. you can find this in the variable ‘Serverpassword’ on the nzbget.conf file on your NZBget host. |
(Note: When editing this page, please select Textile Edit Mode!)