Template:Installation

From Servarr


This template is expressly for the steps and processes of installing all the various ARR software on multiple different platforms

Template parameters

ParameterDescriptionTypeStatus
ARRNAMEARRNAME

Name of the ARR

Default
Fake Radarr
Example
Radarr
Stringrequired
RunArrCommandLinuxRunArrCommandLinux

Command to Start & Run ARR Linux

Example
./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/
Stringrequired
RunArrCommandOSXRunArrCommandOSX

Command to Start & Run ARR OSX

Example
./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/
Stringrequired
ArrExecutableNameWinArrExecutableNameWin

Executable Name for Windows

Example
Radarr.exe
Stringrequired
ArrDownloadLinkArrDownloadLink

Link to the Arr Downloads

URLrequired
ArrLinuxAutoStartArrLinuxAutoStart

Autostart file instructions

Unknownrequired
ARRPORTARRPORT

Port number for the ARR

Default
7878
Example
Radarr: 7878, Sonarr: 8989, Lidarr: 8686, Readarr: 8787
Numberrequired
ARRNAME2ARRNAME2

Used for lowercase ARR names, this is not a required field only used if needed

Example
radarr, sonarr, lidarr, readarr
Stringoptional


Installing

Windows

See the the {{{ARRNAME}}} website for the Windows installer.

OSX

Linux

Auto Start Using Systemd

Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. User account names and Group names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

Preparing the Unit Service File

Several items may need to be changed to match your installation:

  1. User should match the service account that {{{ARRNAME2}}} will run as.
  2. Group should match the service account group that {{{ARRNAME2}}} will run as.
  3. ExecStart has several items that should match your installation /opt/{{{ARRNAME}}}/{{{ARRNAME}}}
    1. Executable Path Default location is /opt/{{{ARRNAME}}}/{{{ARRNAME}}}, but you may need to update if you installed {{{ARRNAME}}} elsewhere.
    2. Data Directory Default location is -data=/home/$USER/.config/{{{ARRNAME}}}/, but you may need to update if you want to keep your database and settings elsewhere.

The unit service file should be named {{{ARRNAME}}}.service and the best place for it is /etc/systemd/system/. Alternative locations like /usr/lib/systemd/system/ and /lib/systemd/system/ may depend on the distribution used.

This example unit assumes that the User and Group are both {{{ARRNAME2}}}, {{{ARRNAME}}}'s executable is placed in /opt/{{{ARRNAME}}}/. Please update the data path to where you want the database, logs, and other metadata stored.


Verify Directory Permissions

Ensure the User that will be running {{{ARRNAME}}} has access to both the executable directory and data directory. Running the command ls -lad /directory/ will show the permissions for that folder. Example:

$ ls -lad /opt/{{{ARRNAME}}}
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /opt/{{{ARRNAME}}}/
$ ls -lad /home/$User/.config/{{{ARRNAME}}}/
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /home/$User/.config/{{{ARRNAME}}}/

Enabling and starting the Unit Service File

Once you have created {{{ARRNAME}}}.service, you will want to enable the service:

sudo systemctl enable {{{ARRNAME}}}.service

You are now ready to start {{{ARRNAME}}}. You can do so with the start command:

sudo systemctl start {{{ARRNAME}}}.service

If you want to verify {{{ARRNAME}}} is running, you can run the status command:

 $ sudo systemctl status {{{ARRNAME}}}.service
● {{{ARRNAME}}}.service - {{{ARRNAME}}}Service
   Loaded: loaded (/usr/lib/systemd/system/{{{ARRNAME}}}.service; enabled; vendor preset: disabled)
   Active: active (running) since Tue 2017-03-07 10:23:44 PST; 5min ago
 Main PID: 19978 ({{{ARRNAME}}})
    Tasks: 16 (limit: 4915)
   Memory: 114.6M
      CPU: 9.331s
   CGroup: /system.slice/{{{ARRNAME}}}.service
           └─19978 /opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/path/to/data/.config/{{{ARRNAME}}}/
Mar 07 10:23:44 apollo systemd[1]: Started {{{ARRNAME}}} Service.

NGINX Reverse Proxy

A reverse proxy allows you to set up {{{ARRNAME}}} so you can access it from the web without using the port number. Rather than mydomain.com:{{{ARRPORT}}} you would use mydomain.com/{{{ARRNAME}}} instead.

It is assumed you have NGINX installed.

Create a text file named {{{ARRNAME}}}.conf and place it in your default NGINX App directory, typically /etc/nginx/conf.d/apps

  1. {{{ARRNAME}}} Reverse Proxy
  2. Be sure to set your Base-URL in {{{ARRNAME}}}
   location /{{{ARRNAME2}}} {
           proxy_pass http://127.0.0.1:{{{ARRPORT}}}/{{{ARRNAME2}}};
           proxy_set_header X-Real-IP $remote_addr;
           proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
           proxy_set_header X-Forwarded-Proto $scheme;
           proxy_http_version 1.1;
           proxy_no_cache $cookie_session;
           proxy_set_header Upgrade $http_upgrade;
           proxy_set_header Connection $http_connection;
           # Allow the {{{ARRNAME}}} API
           location /{{{ARRNAME2}}}/api { auth_request off;
                   proxy_pass http://127.0.0.1:{{{ARRPORT}}}/{{{ARRNAME2}}}/api;
           }
   }

Please note: It is important to ensure that the line proxy_set_header Connection $http_connection; is accurate. The NGINX documentation recommends setting this to Upgrade rather than $http_connection; but this will NOT work.

Once you have saved the file, test your NGINX config:

 sudo nginx -t

Which should show this:

 nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
 nginx: configuration file /etc/nginx/nginx.conf test is successful

Now you can have NGINX reload it's configuration to use the new file:

 sudo nginx -s reload

Finally, make sure you add your URL Base to {{{ARRNAME}}}. This should match what you have next to the word Location in the {{{ARRNAME}}}.conf file, with the leading slash, likely this: /{{{ARRNAME2}}} The URL base can be set here: https://wiki.servarr.com/{{{ARRNAME}}}_Settings#Host

Docker

Please refer to TRaSH's Guide.

Docker on unRAID

  • Installation of {{{ARRNAME}}} is quite simple when it comes to unRAID as they have made installing Docker containers a breeze.
  1. Simply head on over to the community applications store on the top bar of your browser.

  2.  Community Applications
    
  3. In the search field type in {{{ARRNAME}}}

  4. Select which docker image you would like to install. There are several to choose from

  5.  [[File:{{{ARRNAME}}}-unraid-install.png|frameless|none|750px|alt=Installation Options|Installation Options]]
    
  6. Depending on which container you go with will determine the steps in which you take. Some containers come preloaded with volumes mapped already. This is really up to your liking how you would like your container volumes to be laid out. It is highly recommended to follow the guide listed here for your volume mapping

  7. Depending on which container you select you may recieve a pop up asking you to Choose A Branch To Install when in doubt go with the Default :latest branch

  8. Once you have selected which container you are going to go with, you will need to either create the volumes for {{{ARRNAME}}} to be able to use or simply use the pre-filled ones. (Highly recommended to remove the pre-filled and use your own, to remove the pre-filled ones).

  9. To remove the pre-filled paths simply select the toggle in the upper right from Basic to Advanced view then scroll down to the pre-filled path and click Remove

    Toggle Advanced

    1. To create new volumes simply select the Add another Path, Port, Variable, Label or Device text at the bottom above the Apply button.

    2. Once the new window appears you will want to use the drop down box next to Config Type: and make sure that it is set to Path.

    3. From here you will want to fill out all pertinent information:

      1. Name: The name of this path, this can be any unique name more like a note to know what this path is for.

      2. Container Path: This will be the path that {{{ARRNAME}}} will see inside the container /data is a favorite

      3. Host Path: This is the path to the host (unRAID) machine, This will be /mnt/user/<Your User Share>

      4. NOTE If you follow the Docker Guide you will only need one Volume path to be made as all information that {{{ARRNAME}}} will need will be in one share /mnt/user/data

      5. The last three items Default Value:, Access Mode", and Description: Can be left alone.

      6. Click ADD

      7. Add New path

    4. Last thing to check is to make sure Host Port for {{{ARRPORT}}} is filled in with {{{ARRPORT}}}, UNLESS This port causes any conflicts with any other container. If it does please choose a different port that is not in use.

    5. Click APPLY

  10. Now the {{{ARRNAME}}}'s container is being downloaded, once complete simply click the OK button at the bottom of the new pop up window

  11. Click DOCKER on the top row of your browser.

  12. Now all you will need to do is simply left click on your newly created container and select WebUI.

  13. Select WebUI
  14. Now a new browser tab should show up with {{{ARRNAME}}} running in all its glory.