NZBGet
NZBGet is a binary downloader written in C++, which downloads files from Usenet based on the information given in nzb-files. It is designed with performance in mind to achieve maximum download speed by using minimal system resources. Some of the features are:
- Fast deobfuscation (par-rename)
- RSS with duplicate check
- Flexible news server management
- Smart par-repair
More information on this app can be found here.
In this section, we'll be setting up NZBGet for the first time. Here, we'll be doing the following tasks:
- Login to the NZBGet instance for the first time.
- Change ControlUsername and ControlPassword.
First Login
- To login, enter your Ultra username and the password you set during installation.
Add News Servers
You can add your news servers in Settings -> News-Servers section.
Active: Yes
Name: Chosen name for this server
Host: This varies depending on the provider; check your provided news provider details
Port: This varies depending on the provider; check your provided news provider details
Username: Username given to you by your provider
Password: Password given to you by your provider
Encryption: This depends on your provider; check your provided news provider details
Connections: This varies depending on the provider; check your provided news provider details
Once you have added the necessary information. Click Save all changes and Reload NZBGet to load the new configuration.
Install NZBGet Post-Processing Scripts
- Post-processing scripts (pp-scripts) on NZBGet help in further processing your downloaded files after downloading and unpacking, such as the following:
- Deleting unwanted files
- Renaming and sorting releases
- Unlocking password-protected archived files
In this section, we'll be showing you how to set up and enable Post-processing scripts for NZBGet.
Create NZBget Scripts Folder
- Connect to your Ultra service via SSH.
- Execute the following command to create the
scripts
subfolder inside nzbget's config folder:
mkdir -p "$HOME"/.apps/nzbget/scripts
Download Scripts
- After that, just put any scripts that you want on your newly created folder in
"$HOME"/.apps/nzbget/scripts
- The following section contains some of our recommended scripts.
- In this next step, we will be installing
flatten.py
.
ultradocs@spica:~$ wget -P "$HOME"/.apps/nzbget/scripts https://raw.githubusercontent.com/clinton-hall/GetScripts/master/flatten.py
--2020-06-02 13:01:17-- https://raw.githubusercontent.com/clinton-hall/GetScripts/master/flatten.py
Resolving raw.githubusercontent.com (raw.githubusercontent.com)... 151.101.192.133, 151.101.64.133, 151.101.128.133, ...
Connecting to raw.githubusercontent.com (raw.githubusercontent.com)|151.101.192.133|:443... connected.
HTTP request sent, awaiting response... 200 OK
Length: 5075 (5.0K) [text/plain]
Saving to: '/home/ultradocs/.apps/nzbget/scripts/flatten.py'
flatten.py 100%[=================================================>] 4.96K --.-KB/s in 0s
2020-06-02 13:01:17 (54.3 MB/s) - ‘/home/ultradocs/.apps/nzbget/scripts/flatten.py’ saved [5075/5075]
ultradocs@spica:~$
- Login to your NZBGet instance and go to Settings > Extension Scripts.
- Then, on Extensions, click Choose and check the extension scripts that you want If you have multiple scripts, you can also organize which scripts go first.
- After you've set the scripts to your liking, click Apply. Scroll down and click Save all changes.
- Restart NZBGet after to properly load up your scripts.
Recommended Post-Process Scripts
flatten.py
:
This script removes subdirectories and puts all downloaded files into the root download directory. You can specify a unique directory and append the category subdirectory if wanted.
wget -P "$HOME"/.apps/nzbget/scripts https://raw.githubusercontent.com/clinton-hall/GetScripts/master/flatten.py
DeleteSamples.py
:
This script deletes "-sample" files found alongside downloaded files.
wget -P "$HOME"/.apps/nzbget/scripts https://raw.githubusercontent.com/clinton-hall/GetScripts/master/DeleteSamples.py
HashRenamer.py
:
This script renames files with hashes from NZB's filename.
wget -P "$HOME"/.apps/nzbget/scripts https://raw.githubusercontent.com/Cloudbox/Cloudbox/master/roles/nzbget/files/HashRenamer.py
Passwordlist.py
:
This script attempts to extract password-protected archives using a list of possible passwords.
wget -P "$HOME"/.apps/nzbget/scripts https://raw.githubusercontent.com/clinton-hall/GetScripts/master/passwordList.py
reverse_name.py
:
This extension script will reverse filenames first, then rename to folder name on failure.
wget -P "$HOME"/.apps/nzbget/scripts https://raw.githubusercontent.com/Prinz23/nzbget-pp-reverse/master/reverse_name.py
VideoSort
:
This script uses scene-standard naming conventions to match TV shows and movies and rename/move/sort/organize them as you like.
cd "$HOME"/.apps/nzbget/scripts
git clone https://github.com/nzbget/VideoSort
If you require further assistance, you can open a support ticket here!
Feedback and suggestions regarding this article are welcome on our Discord server