knowledge base
Knowledge base Article
Warning: The Unpacker app works with CLI only, meaning you will need to login to your slot via SSH and type words to get it working. This guide will cover the basic setup only, please use the Unpackerr GitHub page for more advanced questions.
Step 1: Install Unpackerr
Use the appropriate tile on your dashboard to install Unpackerr, it will install all the necesarry components on your slot so you can start working via CLI.
Step 2: Connect to your slot via SSH
Use our SSH guide if you are unsure how to proceed.
Step 3: Configure Unpackerr
Once connected you can start working with the CLI. The first thing you need to do is open up the config file, you can do that by typing:
sudo nano /etc/unpackerr/unpackerr.conf
Hit the enter key to confirm and the system will ask for your password once again, put it in and hit enter again. A new screen will pop up with the config file now showing and ready to be edited.
Step 4a: Configure Sonarr / Radarr / Lidarr / Readarr
Depending on what application you want Unpackerr to work with you will need to edit a few lines in this config file. Scroll down to the appropriate line. For example if you want to use Unpackerr with Sonarr you scroll down to #[[sonarr]], where you will see a block of text all needed to properly configure Unpackerr to work with Sonarr. You will need to edit this text block.
For each application you will need to input the correct settings, we will list them all below. For this basic setup guide you will only have to edit the first 3 variables, being URL, API_KEY and PATHS. Be sure to remove the # in front of the lines you are editing. To find your API key and double check the IP / port number open up Sonarr on your slot and head over to [Settings] - [General]. We use the default path here, if you have altered this on your slot then you will also need to alter it in the settings.
Sonarr
url = "http://127.0.0.1:8989"
api_key = "YOUR_API_KEY_HERE"
paths = ["/home/seedit4me/torrents/rtorrent"]
Radarr
url = "http://127.0.0.1:7878"
api_key = "YOUR_API_KEY_HERE"
paths = ["/home/seedit4me/torrents/rtorrent"]
Lidarr
url = "http://127.0.0.1:8686"
api_key = "YOUR_API_KEY_HERE"
paths = ["/home/seedit4me/torrents/rtorrent"]
Readarr
url = "http://127.0.0.1:8787"
api_key = "YOUR_API_KEY_HERE"
paths = ["/home/seedit4me/torrents/rtorrent"]
Step 4b: Configure stand-alone
If you do not use any of the apps above, or want to configure stand-alone functions as well you can also enter the following details. In the config file be sure to scroll down to the FOLDERS text block. There you can edit the path to enter a watch dir, for example our default dir:
path = "/home/seedit4me/torrents/rtorrent"
The other options are self-explanatory and you can defer the required settings from the guide above.
Step 5: Save your settings
Once you are done altering the config file be sure to follow these steps to save it to the file:
- Hit CTRL+X
- input the letter Y only
- Hit enter
You will now see your SSH connection again and you are done configuring Unpackerr.