Skip to content

Commit 73590c2

Browse files
davidnewhallphyco1991
authored andcommitted
Update truenas page to include instructions and screenshots
1 parent 240ee11 commit 73590c2

File tree

2 files changed

+8
-70
lines changed

2 files changed

+8
-70
lines changed

docs/install/freebsd.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@ import ArchiveAccess from './includes/archiveaccess.md';
1919

2020
## Permissions
2121

22-
On FreeBSD the app runs as user `nobody`. That's not very good and will probably change in the future.
23-
If you know how to change it, please
24-
[let me know](https://github.com/Unpackerr/unpackerr/issues/new) so we can update this page.
22+
On FreeBSD the app runs as user `unpackerr`.
23+
The username is hard coded in [the rc file](https://github.com/Unpackerr/unpackerr/blob/main/init/bsd/freebsd.rc.d).
24+
If you wish to change the user, edit the rc file. This process will change and get better in the future.

docs/install/truenas-scale.md

Lines changed: 5 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -10,72 +10,10 @@ description: Install Unpackerr on TrueNAS Scale using TrueCharts.
1010

1111
## TrueCharts
1212

13-
The easiest method to install this on TrueNAS Scale using the TrueCharts catalog.
14-
If you are not familiar with TrueCharts, see the
15-
[TrueCharts documentation](https://truecharts.org/manual/SCALE/guides/getting-started/).
13+
This no longer exists, and these directions were removed.
1614

17-
This document is intended to be a basic guide to get Unpackerr up and running with minimal options.
18-
You may want to tweak permissions or networking based on your particular setup.
15+
## Future
1916

20-
## Pre-Setup
21-
22-
You will need the following items before getting started:
23-
24-
- The location where your torrents are being downloaded to (relative to TrueNAS Scale).
25-
For example, if your torrents are in a dataset named `default` and in the subdirectory `qbittorent`,
26-
your path might be `/mnt/default/qbittorent`
27-
- A persistent location to place the config file.
28-
For the purposes of this guide, we created a config file at `/mnt/default/unpackerr/unpackerr.conf`.
29-
Read more about the configuration file on the [Application Configuration](/docs/install/configuration.md) page.
30-
- We recommend putting the config file in place before installing the application.
31-
Use the documentation from above and save your custom config file to the location you chose above.
32-
33-
:::caution Configuration Notes
34-
The goal is make the config file available @ `/config/unpackerr.conf` inside the container.
35-
Using this container path will allow Unpackerr to find your configuration automatically.
36-
You may also need to correct ownership of the file on the host so unpackerr can read it.
37-
Use `chown` to do that; something like: `chown apps:apps /mnt/default/unpackerr/unpackerr.conf`
38-
:::
39-
40-
## Installing the App
41-
42-
1. After TrueCharts is added as a catalog, go to the Apps section.
43-
1. Then click on Discover Apps
44-
1. Then search for Unpackerr, it should show in the list.
45-
1. Click Install. <br/>
46-
![TrueNAS Scale Discover Apps page](/img/screenshots/truenas-scale/discover.png)
47-
48-
## Configuration
49-
50-
On the install screen, we are most concerned with the following two entries in the `Storage and Persistence` section:
51-
52-
1. App Config Storage (`/config`): Change the Type of Storage to `Host Path`
53-
and use the path to the configuration **folder** that you created above.<br/>
54-
![App Config Storage example](/img/screenshots/truenas-scale/app-config.png)
55-
1. App downloads Storage (`/downloads`): Change the Type of Storage to `Host Path`
56-
and use the path to the torrent folder as mentioned above.<br/>
57-
![App downloads Storage example](/img/screenshots/truenas-scale/download-config.png)
58-
59-
All other settings should be reviewed and modify to your specific use case.
60-
The defaults tend to work fine if you have the rest of the starr apps installed on TrueNAS Scale as well.
61-
62-
## Advanced
63-
64-
The default container mount path for the `App downloads Storage` mentioned above is `/downloads`.
65-
While this works for a majority of users, it does not work for everyone. Check your download client's
66-
download location(s), and be sure to add the exact same mount to Unpackerr. This ensures unpackerr
67-
can locate your downloaded files.
68-
69-
- In the Unpackerr application (in your TrueNAS Scale UI), scroll down to `Additional App Storage` and click `Add`.
70-
- Once added, match the information from the download application into the Unpackerr application.
71-
- The screenshot below shows an example mounting `/mnt` in the container directly to the download path.
72-
73-
![App Additional Storage example](/img/screenshots/truenas-scale/app-storage.png)
74-
75-
## Verify
76-
77-
Once installed, TrueNAS Scale should boot the container immediately.
78-
You can verify the logs by clicking on the Unpackerr container,
79-
and using the `View Logs` button in the `Workloads` section.
80-
81-
![View Logs button](/img/screenshots/truenas-scale/view-logs.png)
17+
You install Unpackerr with a custom app. Once you figure it out, please
18+
[edit this page](https://github.com/Unpackerr/unpackerr.github.io/blob/main/docs/install/truenas-scale.md)
19+
so others can benefit from your tribulations.

0 commit comments

Comments
 (0)