Skip to content

Commit f19242f

Browse files
bakerboy448bakerboy448
authored
Installation Doc Updates (#27)
* point installation docs at the wiki and update for v4 * Add QNAP Package and warning * macos 10.15 required * macos self-sign * update windows download links
1 parent b423395 commit f19242f

File tree

10 files changed

+811
-839
lines changed

10 files changed

+811
-839
lines changed

‎index.html‎

Lines changed: 727 additions & 742 deletions
Large diffs are not rendered by default.

‎src/sections/downloads-v3/bsd.marko‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<install-step title="Installation">
33
<p>
44
The Radarr team provides
5-
<a href="https://radarr.servarr.com/v1/update/master/updatefile?os=bsd&arch=x64&runtime=netcore">builds for BSD</a>.<br/>
6-
Additional details can be found on Frank's GH
7-
<a href="https://github.com/Thefrank/freebsd-port-sooners/blob/main/Radarr_Installation_TrueNAS_GUI.md/">Link</a>
5+
<a href="https://radarr.servarr.com/v1/update/master/updatefile?os=bsd&arch=x64&runtime=netcore">builds for BSD and the BSD Community creates the Port</a>.<br/>
6+
Please see our Servarr Wiki for installation instructions.
7+
<a href="https://wiki.servarr.com/radarr/installation#freebsd">Link</a>
88
</p>
9-
<migration-alert>Radarr v3 will convert any existing v0.2 directory automatically on startup.</migration-alert>
9+
<migration-alert>Radarr v4 will convert any existing v0.2 or v3 directory automatically on startup.</migration-alert>
1010
</install-step>
1111
</install-steps>

‎src/sections/downloads-v3/components/migration-alert.marko‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
<alert level="info">
2-
<h4 class="alert-heading">Radarr v0.2 migration</h4>
2+
<h4 class="alert-heading">Radarr v0.2 and v3 migration</h4>
33
<${input.renderBody}/>
44
</alert>

‎src/sections/downloads-v3/docker.marko‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
Most docker containers use
99
<code>/config</code>
1010
volume to mount the data directory and supply that path to Radarr as parameter.
11-
Radarr v3 will convert the given directory on startup if a Radarr v0.2 database is found.
11+
Radarr v4 will convert the given directory on startup if a Radarr v0.2 or v3 database is found.
1212
</migration-alert>
1313
</install-step>
1414
<install-step num="1" title="Avoid common pitfalls">
@@ -61,7 +61,7 @@
6161
<ul>
6262
<li>
6363
<h5>
64-
<a href="https://ghcr.io/hotio/radarr:latest">ghcr.io/hotio/radarr:release</a>
64+
<a href="https://hotio.dev/containers/radarr/">hotio/radarr:release</a>
6565
</h5>
6666
<p>
6767
<a href="https://hotio.dev">hotio</a>
@@ -74,10 +74,10 @@
7474
</li>
7575
<li>
7676
<h5>
77-
<a href="https://ghcr.io/linuxserver/radarr:latest">ghcr.io/linuxserver/radarr:latest</a>
77+
<a href="https://docs.linuxserver.io/images/docker-radarr">lscr.io/linuxserver/radarr:latest</a>
7878
</h5>
7979
<p>
80-
<a href="https://www.linuxserver.io">linuxserver.io</a>
80+
<a href="https://docs.linuxserver.io/images/docker-radarr">linuxserver.io</a>
8181
is one of the most prolific and popular Docker image maintainers. They also maintain images for most of the popular download clients as well.
8282
LinuxServer specifies a couple of optional default volumes such as
8383
<code>/movies</code>

‎src/sections/downloads-v3/linux-archlinux.marko‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
The existing radarr AUR packages already used
1212
<code>/var/lib/radarr</code>
1313
to store the Radarr database.
14-
Radarr v3 will convert that directory automatically on startup.
14+
Radarr v4 will convert that directory automatically on startup.
1515
</migration-alert>
1616
</install-step>
1717
<install-step num="1" title="Install Radarr">

‎src/sections/downloads-v3/linux-debianubuntu.marko‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
<install-steps>
22
<install-step title="Installation">
33
<p>
4-
The community has put together an
5-
<a href="https://wiki.servarr.com/radarr/installation#linux">Installation Guide</a>
6-
to help you install this on Debian or Ubuntu.
4+
Please see our Servarr Wiki for installation instructions.
5+
<a href="https://wiki.servarr.com/radarr/installation#linux">Link</a>
76
</p>
8-
<migration-alert>Radarr v3 will convert any existing v0.2 directory automatically on startup.</migration-alert>
7+
<migration-alert>Radarr v4 will convert any existing v0.2 or v3 directory automatically on startup.</migration-alert>
98
</install-step>
109
</install-steps>

‎src/sections/downloads-v3/linux.marko‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
<tabview-pane id="downloads-v3-linux-other">
1111
<install-description>
1212
<alert level="info">
13-
Please contact us if you wish to port Radarr v3 for any other distribution that the ones already listed.<br/>
14-
Radarr v0.2 was supported by various third-parties on other platforms and we prefer to coordinate the port of v3.
13+
Please contact us if you wish to port Radarr v4 for any other distribution that the ones already listed.<br/>
14+
Radarr v0.2 was supported by various third-parties on other platforms and we prefer to coordinate the port of v4.
1515
</alert>
1616
<p>Generic .tar.gz downloads are available for linux, but dependencies, installation and permissions will need to be done manually.</p>
1717
<div>

‎src/sections/downloads-v3/macos.marko‎

Lines changed: 45 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,45 @@
1-
<install-steps>
2-
<install-step title="Introduction">
3-
<p>The easiest way to install Radarr on macOS is to use the App archive with the steps described below.</p>
4-
<!-- TODO: Check mac migration support -->
5-
<migration-alert>
6-
The Radarr v3 package will attempt to automatically migrate an existing Radarr v0.2 database.
7-
Radarr v0.2 used the user's home directory
8-
<code>~/.config/Radarr</code>
9-
to store the application data which v3 also uses.<br/>
10-
</migration-alert>
11-
</install-step>
12-
<install-step num="1" title="Download App package">
13-
<a class="btn btn-radarr" href="https://radarr.servarr.com/v1/update/master/updatefile?os=osx&runtime=netcore&arch=x64&installer=true">Download macOS App</a>
14-
</install-step>
15-
<install-step num="2" title="Install App">
16-
<p>Open the archive and drag the Radarr icon to your Application folder.</p>
17-
<alert level="warning">Radarr v3 is not compatible with OSX versions < 10.13 (High Sierra) due to netcore incompatibilities.</alert>
18-
</install-step>
19-
<install-step num="3" title="Start Radarr">
20-
<p>Open Radarr.app in your Application folder.</p>
21-
</install-step>
22-
<install-step num="4" title="View Radarr">
23-
<p>
24-
Browse to
25-
<code>http://localhost:7878</code>
26-
to start using Radarr.
27-
</p>
28-
</install-step>
29-
</install-steps>
30-
<install-alternatives id="downloads-v3-macos-alternatives">
31-
<h5>Manual Install</h5>
32-
<p>
33-
It is possible to install Radarr manually using the
34-
<a href="https://radarr.servarr.com/v1/update/master/updatefile?os=osx&runtime=netcore&arch=x64">.tar.gz download</a>. However in that case you must manually deal with dependencies, installation and permissions.
35-
</p>
36-
<h5>Docker container</h5>
37-
<p>
38-
You can follow the
39-
<a href="#downloads-v3-docker">Docker guide</a>
40-
to install Radarr as a Docker container instead.
41-
</p>
42-
</install-alternatives>
1+
<install-steps>
2+
<install-step title="Introduction">
3+
<p>The easiest way to install Radarr on macOS is to use the App archive with the steps described below.</p>
4+
<!-- TODO: Check mac migration support -->
5+
<migration-alert>
6+
The Radarr v4 package will attempt to automatically migrate an existing Radarr v0.2 or v3 database.
7+
Radarr v0.2 used the user's home directory
8+
<code>~/.config/Radarr</code>
9+
to store the application data which v4 also uses.<br/>
10+
</migration-alert>
11+
</install-step>
12+
<install-step num="1" title="Download App package">
13+
<a class="btn btn-radarr" href="https://radarr.servarr.com/v1/update/master/updatefile?os=osx&runtime=netcore&arch=x64&installer=true">Download macOS App</a>
14+
</install-step>
15+
<install-step num="2" title="Install App">
16+
<p>Open the archive and drag the Radarr icon to your Application folder.</p>
17+
<alert level="warning">Radarr v4 is not compatible with OSX versions < 10.15 (Catalina) due to .NET incompatibilities.</alert>
18+
</install-step>
19+
<install-step num="3" title="Self-sign Radarr">
20+
<p>Self-sign Radarr `codesign --force --deep -s - Radarr.app`</p>
21+
</install-step>
22+
<install-step num="4" title="Start Radarr">
23+
<p>Open Radarr.app in your Application folder.</p>
24+
</install-step>
25+
<install-step num="5" title="View Radarr">
26+
<p>
27+
Browse to
28+
<code>http://localhost:7878</code>
29+
to start using Radarr.
30+
</p>
31+
</install-step>
32+
</install-steps>
33+
<install-alternatives id="downloads-v3-macos-alternatives">
34+
<h5>Manual Install</h5>
35+
<p>
36+
It is possible to install Radarr manually using the
37+
<a href="https://radarr.servarr.com/v1/update/master/updatefile?os=osx&runtime=netcore&arch=x64">.tar.gz download</a>. However in that case you must manually deal with dependencies, installation and permissions.
38+
</p>
39+
<h5>Docker container</h5>
40+
<p>
41+
You can follow the
42+
<a href="#downloads-v3-docker">Docker guide</a>
43+
to install Radarr as a Docker container instead.
44+
</p>
45+
</install-alternatives>

‎src/sections/downloads-v3/nas.marko‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,17 @@
77
<div class="tab-content" id="download-v3-nas-tabcontent">
88
<tabview-pane active id="downloads-v3-nas-synology">
99
<alert level="info">
10-
A V3 package and installation instructions are provided by SynoCommunity at:
10+
A NAS package and installation instructions are provided by SynoCommunity at:
1111
<a href="https://synocommunity.com/package/radarr">https://synocommunity.com/package/radarr</a>.
1212
Please note that the SynoCommunity typically has signifcant lag in providing updated packages, thus you may want to check out Docker.
1313
</alert>
1414
</tabview-pane>
1515
<tabview-pane id="downloads-v3-nas-qnap">
1616
<alert level="info">
17-
The Radarr v0.2 Qnap port was maintained by the Qnap forum community.<br/>
18-
Please contact us if you wish to maintain a v3 package so that we can include the appropriate install instructions.
17+
A NAS packages that requires a paid dependency is created by the QNAP community<br/>
18+
<a href="https://www.qnapclub.eu/en/qpkg/1007">https://www.qnapclub.eu/en/qpkg/1007</a>.
19+
Please note that the QNAP Community typically has signifcant lag in providing updated packages, thus you may want to check out Docker.
20+
Additionally, the QNAP Community requires a paid dependency which the Radarr Team does not condone.
1921
</alert>
2022
</tabview-pane>
2123
<tabview-pane id="downloads-v3-nas-other">

‎src/sections/downloads-v3/windows.marko‎

Lines changed: 19 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,19 @@
1-
<install-steps>
2-
<install-step title="Introduction">
3-
<p>Radarr is supported natively on Windows. Radarr can be installed on Windows as Windows Service or system tray application.</p>
4-
<p>
5-
A Windows Service runs even when the user is not logged in, but special care must be taken since Windows Services cannot access network drives (X:\ mapped drives or \\server\share UNC paths) without special configuration steps.<br/>
6-
Additionally the Windows Service runs under the 'Local Service' account, by default this account does not have permissions to access your user's home directory unless permissions have been assigned manually. This is particularly relevant when using download clients that are configured to download to your home directory.<br/>
7-
'Local Service' also generally has very limited permissions. It's therefore advisable to install Radarr as a system tray application if the user can remain logged in. The option to do so is provided during the installer.
8-
</p>
9-
<alert level="warning">
10-
Radarr is supported on Windows 8.1 and Server 2012 or later. Pre-release or earlier versions of Windows are not supported.
11-
</alert>
12-
<migration-alert>
13-
Radarr v3 will automatically convert the existing Radarr v0.2 installation. Radarr v0.2 already used
14-
<code>C:\ProgramData\Radarr</code>, which will be automatically converted to v3 on startup.
15-
</migration-alert>
16-
</install-step>
17-
<install-step num="1" title="Install Radarr">
18-
<p>Download the Windows Installer with the following link and execute it.</p>
19-
<a class="btn btn-radarr" href="https://radarr.servarr.com/v1/update/master/updatefile?os=windows&runtime=netcore&arch=x64&installer=true">Download Windows x64 Installer</a>
20-
<a class="btn btn-radarr" href="https://radarr.servarr.com/v1/update/master/updatefile?os=windows&runtime=netcore&arch=x86&installer=true">Download Windows x86 Installer</a>
21-
</install-step>
22-
<install-step num="2" title="View Radarr">
23-
<p>
24-
Browse to
25-
<code>http://localhost:7878</code>
26-
to start using Radarr.
27-
</p>
28-
</install-step>
29-
</install-steps>
30-
<install-alternatives id="downloads-v3-windows-alternatives">
31-
<h5>Manual Install</h5>
32-
<p>
33-
It is possible to install Radarr manually using the x64
34-
<a href="https://radarr.servarr.com/v1/update/master/updatefile?os=windows&runtime=netcore&arch=x64">.zip download</a>. However in that case you must manually deal with dependencies, installation and permissions.
35-
</p>
36-
</install-alternatives>
1+
<install-steps>
2+
<install-step title="Installation">
3+
<p>
4+
Please see our Servarr Wiki for
5+
<a href="https://wiki.servarr.com/radarr/installation#windows"> installation instructions.</a>
6+
</p>
7+
<p>Download the Windows Installer with the following link and execute it.</p>
8+
<a class="btn btn-radarr" href="https://radarr.servarr.com/v1/update/master/updatefile?os=windows&runtime=netcore&arch=x64&installer=true">Download Windows x64 Installer</a>
9+
<a class="btn btn-radarr" href="https://radarr.servarr.com/v1/update/master/updatefile?os=windows&runtime=netcore&arch=x86&installer=true">Download Windows x86 Installer</a>
10+
<migration-alert>Radarr v4 will convert any existing v0.2 or v3 directory automatically on startup.</migration-alert>
11+
</install-step>
12+
</install-steps>
13+
<install-alternatives id="downloads-v3-windows-alternatives">
14+
<h5>Manual Install</h5>
15+
<p>
16+
It is possible to install Radarr manually using the x64
17+
<a href="https://radarr.servarr.com/v1/update/master/updatefile?os=windows&runtime=netcore&arch=x64">.zip download</a>. However in that case you must manually deal with dependencies, installation and permissions.
18+
</p>
19+
</install-alternatives>

0 commit comments

Comments
 (0)