From 06be084cc9f1c29b401bdb5b6a029cf593e2872c Mon Sep 17 00:00:00 2001 From: David Newhall II Date: Tue, 20 Feb 2024 04:27:52 -0800 Subject: [PATCH] lint and remove broken links --- docs/install/choosemethod.md | 7 ++----- docs/install/truenas-scale.md | 34 ++++++++++++++++++++++++---------- 2 files changed, 26 insertions(+), 15 deletions(-) diff --git a/docs/install/choosemethod.md b/docs/install/choosemethod.md index 4662b09..4b938eb 100644 --- a/docs/install/choosemethod.md +++ b/docs/install/choosemethod.md @@ -35,10 +35,10 @@ Unpackerr uses a lot CPU, and tends not to work well when running on smaller sys Running Unpackerr on a system with a large CPU is ideal to avoid system performance degradation. ::: -- [Docker](/docs/install/docker): [Compose](/docs/install/compose), [unRAID](/docs/install/unraid) +- [Docker](/docs/install/docker): [Compose](/docs/install/compose), [unRAID](/docs/install/unraid), + [TrueNAS Scale](/docs/install/truenas-scale) - [FreeBSD](/docs/install/freebsd) - [Linux: with root](/docs/install/linux), [without root (seedbox)](/docs/install/seedbox) -- [TrueNAS Scale](/docs/install/truenas-scale) - [macOS](/docs/install/macos) - [Windows](/docs/install/windows) @@ -49,9 +49,6 @@ Running Unpackerr on a system with a large CPU is ideal to avoid system performa These guides are provided by community members. - Synology: https://drfrankenstein.co.uk/2022/07/02/unpackerr-in-docker-on-a-synology-nas/ -- Synology: https://neellik.com/how-to-install-unpackerr-on-your-synology-nas-with-docker/ -- TrueNAS: https://github.com/imjustleaving/trueNAS/wiki/A-Guide-to-go-from-a-bare-metal-TrueNAS-Scale-install-to-a-Fully-Automated-Media-Server -- TrueCharts: https://staging.artifacthub.io/packages/helm/truecharts/unpackerr/4.0.30 - HomeAssistant: https://github.com/alexbelgium/hassio-addons/tree/master/unpackerr ([open a pull request to add your guide](https://github.com/Unpackerr/unpackerr.github.io/blob/main/docs/install/choosemethod.md)) diff --git a/docs/install/truenas-scale.md b/docs/install/truenas-scale.md index 5379fad..e5688cf 100644 --- a/docs/install/truenas-scale.md +++ b/docs/install/truenas-scale.md @@ -10,16 +10,25 @@ description: Install Unpackerr on TrueNAS Scale using TrueCharts. ## TrueCharts -The easiest method to install this on TrueNAS Scale using the TrueCharts catalog. If you are not familiar with TrueCharts, see the [TrueCharts documentation](https://truecharts.org/manual/SCALE/guides/getting-started/). +The easiest method to install this on TrueNAS Scale using the TrueCharts catalog. +If you are not familiar with TrueCharts, see the +[TrueCharts documentation](https://truecharts.org/manual/SCALE/guides/getting-started/). -This document is intended to be a basic guide to get Unpackerr up and running with minimal options. You may want to tweak permissions or networking based on your particular setup. +This document is intended to be a basic guide to get Unpackerr up and running with minimal options. +You may want to tweak permissions or networking based on your particular setup. ## Pre-Setup You will need the following items before getting started: -- The location where your torrents are being downloaded to (relative to TrueNAS Scale). For example, if your torrents are in a dataset named `default` and in the subdirectory `qbittorent`, your path might be `/mnt/default/qbittorent` -- A persistent location to place the config file. For the purposes of this guide, we created a config file at `/mnt/default/unpackerr/unpackerr.conf`. Read more about the configuration file on the [Application Configuration](/docs/install/configuration.md) page. -- We recommend putting the config file in place before installing the application. Use the documentation from above and save your custom config file to the location you chose above. + +- The location where your torrents are being downloaded to (relative to TrueNAS Scale). + For example, if your torrents are in a dataset named `default` and in the subdirectory `qbittorent`, + your path might be `/mnt/default/qbittorent` +- A persistent location to place the config file. + For the purposes of this guide, we created a config file at `/mnt/default/unpackerr/unpackerr.conf`. + Read more about the configuration file on the [Application Configuration](/docs/install/configuration.md) page. +- We recommend putting the config file in place before installing the application. + Use the documentation from above and save your custom config file to the location you chose above. ## Installing the App @@ -33,15 +42,20 @@ You will need the following items before getting started: On the install screen, we are most concerned with the following two entries in the `Storage and Persistence` section: - 1. App Config Storage (`/config`): Change the Type of Storage to `Host Path` and use the path to the configuration **folder** that you created above.
+1. App Config Storage (`/config`): Change the Type of Storage to `Host Path` + and use the path to the configuration **folder** that you created above.
![App Config Storage example](/img/screenshots/truenas-scale/app-config.png) - 1. App downloads Storage (`/downloads`): Change the Type of Storage to `Host Path` and use the path to the torrent folder as mentioned above.
+1. App downloads Storage (`/downloads`): Change the Type of Storage to `Host Path` + and use the path to the torrent folder as mentioned above.
![App downloads Storage example](/img/screenshots/truenas-scale/download-config.png) -All other settings should be reviewed and modify to your specific use case. The defaults tend to work fine if you have the rest of the starr apps installed on TrueNAS Scale as well. +All other settings should be reviewed and modify to your specific use case. +The defaults tend to work fine if you have the rest of the starr apps installed on TrueNAS Scale as well. ## Verify -Once installed, TrueNAS Scale should boot the container immediately. You can verify the logs by clicking on the Unpackerr container, and using the `View Logs` button in the `Workloads` section. +Once installed, TrueNAS Scale should boot the container immediately. +You can verify the logs by clicking on the Unpackerr container, +and using the `View Logs` button in the `Workloads` section. -![View Logs button](/img/screenshots/truenas-scale/view-logs.png) \ No newline at end of file +![View Logs button](/img/screenshots/truenas-scale/view-logs.png)