Difference between revisions of "Template:Installation"
| Line 8: | Line 8: | ||
"example": "Radarr", | "example": "Radarr", | ||
"type": "string", | "type": "string", | ||
| − | "required": true | + | "required": true, |
| + | "default": "Fake Radarr" | ||
}, | }, | ||
"RunArrCommandLinux": { | "RunArrCommandLinux": { | ||
| Line 36: | Line 37: | ||
"description": "Autostart file instructions", | "description": "Autostart file instructions", | ||
"required": true | "required": true | ||
| + | }, | ||
| + | "ARRPORT": { | ||
| + | "description": "Port number for the ARR", | ||
| + | "example": "7878", | ||
| + | "type": "number", | ||
| + | "default": "Fake 7878" | ||
} | } | ||
}, | }, | ||
| Line 44: | Line 51: | ||
"ArrExecutableNameWin", | "ArrExecutableNameWin", | ||
"ArrDownloadLink", | "ArrDownloadLink", | ||
| − | "ArrLinuxAutoStart" | + | "ArrLinuxAutoStart", |
| + | "ARRPORT" | ||
] | ] | ||
} | } | ||
Revision as of 18:04, 25 November 2020
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| ARRNAME | ARRNAME | Name of the ARR
| String | required |
| RunArrCommandLinux | RunArrCommandLinux | Command to Start & Run ARR Linux
| String | required |
| RunArrCommandOSX | RunArrCommandOSX | Command to Start & Run ARR OSX
| String | required |
| ArrExecutableNameWin | ArrExecutableNameWin | Executable Name for Windows
| String | required |
| ArrDownloadLink | ArrDownloadLink | Link to the Arr Downloads | URL | required |
| ArrLinuxAutoStart | ArrLinuxAutoStart | Autostart file instructions | Unknown | required |
| ARRPORT | ARRPORT | Port number for the ARR
| Number | optional |
Installing
Windows
OSX
Linux
Auto Start Using Systemd
NAS
FreeNAS
Qnap
Synology
Docker
Docker on unRAID
- Installation of {{{ARRNAME}}} is quite simple when it comes to unRAID as they have made installing Docker containers a breeze.
Simply head on over to the community applications store on the top bar of your browser.
In the search field type in {{{ARRNAME}}}
Select which docker image you would like to install. There are several to choose from
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
Once you have selected which container you are going to go with, you will need to either create the volumes in for {{{ARRNAME}}} to be able to use or simply use the prefilled ones. (Highly recommended to remove the prefilled and use your own).
To create new volumes simply select the
Add another Path, Port, Variable, Label or Devicetext at the bottom above the Apply button.
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.
From here you will want to fill out all pertinant information:
Name: The name of this path, this can be any unique name more like a note to know what this path is for.
Container Path: This will be the path that {{{ARRNAME}}} will see inside the container
/datais a favorite
Host Path: This is the path to the host (unRAID) machine, This will be
/mnt/user/<Your User Share>
The last three items Default Value:, Access Mode", and Description: Can be left alone.
Click ADD
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.
Click APPLY
Now the {{{ARRNAME}}}'s container is being downloaded, once complete simply click the OK button at the bottom of the new pop up window
Click DOCKER on the top row of your browser.
Now all you will need to do is simply left click on your newly created container and select WebUI.
Now a new browser tab should show up with {{{ARRNAME}}} running in all its glory. ENJOY
[[File:{{{ARRNAME}}}-unraid-install.png|thumb|none|alt=Installation Options|Installation Options]]
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
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
Manual Updates
Windows
OSX
Linux
Docker
Getting Started
// Do we need sub sections that much?