add(guide/unRAID): updates screenshots and language (#1642)

pull/1648/head
zakary 7 months ago committed by GitHub
parent da8574c446
commit 3966d6ce0b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -1,56 +1,69 @@
# Unraid
!!! note
The first thing you need to do is forget the suggested paths from the Spaceinvader One YouTube Tutorials,
and don't use the predefined paths from the unraid templates.
(Spaceinvader One YouTube guides are great to learn how to start with unraid or how to setup certain applications, and yes I did and still do use them. Probably the main reason why he's using those path is because they are predefined in the template)
# unRAID
!!! warning "**DO NOT** use the template paths from unRAID or the suggested paths from SpaceInvader One."
SpaceInvader One YouTube guides are great for learning how to start with unRAID or how to set up certain applications - and yes I did and still do use them.<br><br>The main reason why he's probably using those paths is because they are predefined in the templates.
------
## Preparation
Make sure hardlinks support is enabled in your `Settings` => `Global Share Settings`.
Make sure `Tunable (support Hard Links)` is enabled in your `Settings` => `Global Share Settings`.
![Enable Hardlink support](images/unraid-enable-hardlinks.png)
=== "unRAID 6.12"
![Enable Hardlink support (New)](images/unraid-enable-hardlinks_612.png)
=== "unRAID 6.11"
![Enable Hardlink support](images/unraid-enable-hardlinks.png)
## Create the main share
!!! warning "To get Hardlinks and Atomic-Moves working with Unraid,<br>You will need to make use of <u>**ONE**</u> share with subfolders."
!!! warning "To get Hardlinks and Atomic-Moves working with unRAID,<br>You will need to make use of <u>**ONE**</u> share with subfolders."
In this example, I'm using my own setup and the preferred share `data`.
Go to your dashboard and select `Shares` on the navigation bar, then choose `Add Share`.
For this example I'm using my own setup and preferred share `data`.
=== "unRAID 6.12 (No Cache)"
![!unraid-main-share-array-6-12](images/unraid_main_share_array_612.png)
=== "unRAID 6.12 (Cache)"
![!unraid-main-share-cache-6-12](images/unraid_main_share_cache_612.png)
=== "unRAID 6.11"
![!unraid-main-share](images/unraid-main-share.png)
Go to your dashboard and on the top select `shares` select `add share` .
1. Use `data`
1. Set up your share with the applicable settings.
![!unraid-main-share](images/unraid-main-share.png)
=== "unRAID 6.12 (No Cache)"
Select the `Primary storage` as `Array` (shown in the `No Cache` tab above).
=== "unRAID 6.12 (Cache)"
1. Select the `Primary storage` as `Cache` (shown in the `Cache` tab above).
1. Select the `Secondary storage` as `Array`
1. Make sure `Mover action` is set to `Cache -> Array`
=== "unRAID 6.11"
Choose `Yes` on step (2) (unRAID 6.11 tab above). If not using a cache drive, keep this option disabled.
!!! info "Hardlinks will stay intact if you're using a cache"
1. use `data`
1. if you got a cache drive and want to make use of it put it on `Yes` or keep it disabled (Hardlinks will stay in tact if you're using the cache)
1. click on `ADD SHARE`
1. Click on `ADD SHARE`
!!! note
Keep in mind regarding the use of the Cache drive, The mover can't move files that are in use, like when seeding with torrents. You will need to stop/pause the torrents so the mover can move them to your Array.
Keep in mind, regarding the use of the cache drive, unRAID's integrated mover cannot move files that are in use, like seeding torrents. You will need to stop/pause the torrents so the mover can move the files from the cache to your array.
!!! tip "If you use qBittorrent you can automate the process by following the following Guide [HERE](/Downloaders/qBittorrent/Tips/How-to-run-the-unRaid-mover-for-qBittorrent/){:target="_blank" rel="noopener noreferrer"}<br>If you use Deluge you can automate the process by following the following Guide [HERE](/Downloaders/Deluge/Tips/Unraid-Mover/){:target="_blank" rel="noopener noreferrer"}"
With Usenet you won't have any issues.
With Usenet, you won't have any issues.
------
## Folder Structure
On the host (Unraid) you will need to add `/mnt/user` before it. **So `/mnt/user/data`**
On the host (unRAID) you will need to add `/mnt/user` before it. **So `/mnt/user/data`**
The `data` folder has sub-folders for `torrents` and `usenet` and each of these have sub-folders for `tv`, `movie` and `music` downloads to keep things neat. The `media` folder has nicely named `TV`, `Movies` and `Music` sub-folders, this is your library and what youd pass to Plex, Emby or JellyFin.
The `data` folder has sub-folders for `torrents` and `usenet`, and each of these has sub-folders for `tv`, `movie` and `music` downloads to keep things organized. The `media` folder has nicely named `TV`, `Movies` and `Music` sub-folders, this is where your library resides, and what youd pass to Plex, Emby or JellyFin.
These subfolders you need to create your self, you can use krusader or winscp to create them or any other way you prefer.
You will need to create these subfolders yourself. You can do this any way you prefer, but Krusader or WinSCP are popular choices if you are unsure.
{! include-markdown "../../../includes/hardlinks/docker-tree-full.md" !}
*I'm using lower case on all folder on purpose, being Linux is case sensitive.*
*I'm using lower-case on all folders on purpose, being Linux is case-sensitive.*
------
@ -61,15 +74,15 @@ These subfolders you need to create your self, you can use krusader or winscp to
## Setting up the containers
After you created all the needed folders it's time to setup the paths in the docker containers.
After you've created all the necessary folders, it's time to set up the Docker container's paths.
Go to your dashboard and select your docker container you want to edit or if you're starting fresh add the docker containers you want to use or prefer.
Go to your dashboard and select the Docker container you want to edit, or, if you're starting fresh, add the container/App you want to use.
Unraid makes it actually pretty clear what's the Host Path and what's the Container Path.
unRAID makes it pretty clear which is the Host Path and Container Path.
`Container Path:` => The path that will be used inside the container.
`Container Path:` => The path that will be used from inside the container.
`Host Path:` => The path on your Unraid Server (The Host).
`Host Path:` => The actual/absolute path used on your unRAID Server (The Host).
------
@ -85,7 +98,7 @@ qBittorrent, Deluge, ruTorrent
!!! info
The reason why we use `/data/torrents/` for the torrent client is because it only needs access to the torrent files. In the torrent software settings, youll need to reconfigure paths and you can sort into sub-folders like `/data/torrents/{tv|movies|music}`.
The reason why we use `/data/torrents/` for the torrent client is because it only needs access to the torrent data. In the torrent software settings, youll need to configure your categories/labels to utilize the right path for specific content. You can sort into sub-folders like `/data/torrents/{tv|movies|music}`.
{! include-markdown "../../../includes/hardlinks/docker-tree-torrents.md" !}
@ -103,7 +116,7 @@ NZBGet or SABnzbd
!!! info
The reason why we use `/data/usenet/` for the usenet client is because it only needs access to the usenet files. In the usenet software settings, youll need to reconfigure paths and you can sort into sub-folders like `/data/usenet/{tv|movies|music}`.
The reason why we use `/data/usenet/` for the usenet client is that it only needs access to the usenet data. In the usenet software settings, youll need to configure your paths to sort content into sub-folders like `/data/usenet/{tv|movies|music}`.
{! include-markdown "../../../includes/hardlinks/docker-tree-usenet.md" !}
@ -121,7 +134,7 @@ Sonarr, Radarr and Lidarr
!!! info
Sonarr, Radarr and Lidarr gets access to everything because the download folder(s) and media folder will look like and be one file system. Hard links will work and moves will be atomic, instead of copy + delete.
Sonarr, Radarr and Lidarr get access to everything because the download folder(s) and media folder will need to look like, and be one mount, on the file system. Hard links will work properly and any moves will be atomic, rather than copying and deleting.
{! include-markdown "../../../includes/hardlinks/docker-tree-full.md" !}
@ -139,7 +152,7 @@ Plex, Emby, JellyFin and Bazarr
!!! info
Plex, Emby, JellyFin and Bazarr only needs access to your media library, which can have any number of sub folders like Movies, Kids Movies, TV, Documentary TV and/or Music as sub folders.
Plex, Emby, JellyFin and Bazarr only need access to your media library, which can have any number of sub-folders (Movies, Kids Movies, TV, Documentary TV and/or Music).
{! include-markdown "../../../includes/hardlinks/docker-tree-media.md" !}
@ -149,19 +162,19 @@ Plex, Emby, JellyFin and Bazarr
![!unraid-final-result](images/unraid-final-result.png)
**Don't forget to look at the [Examples](/Hardlinks/Examples/) how to setup the paths inside your applications.**
**Don't forget to look at the [Examples](/Hardlinks/Examples/) of how to set up your paths INSIDE your applications.**
### Video Tutorial
!!! tip ""
Big Thanks to IBRACORP for noticing this Guide and creating a Video covering this unraid section.
Big Thanks to IBRACORP for noticing this Guide and creating a Video covering this unRAID section.
The reason why I added the video to the end is because I want the user to actually learn and understand why it's recommended to use this folder structure, before going straight to the YouTube video.
The reason why I have this video at the end is because I want the users to ACTUALLY LEARN and UNDERSTAND why it's recommended to use this folder structure prior to going straight to a YouTube video.
<iframe width="560" height="315" src="https://www.youtube.com/embed/AMcHsQJ7My0" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
Also check out other videos from IBRACORP [HERE](https://www.youtube.com/c/IBRACORP/videos){:target="_blank" rel="noopener noreferrer"}
Check out other videos from IBRACORP [HERE](https://www.youtube.com/c/IBRACORP/videos){:target="_blank" rel="noopener noreferrer"}
{! include-markdown "../../../includes/support.md" !}
<!-- --8<-- "includes/support.md" -->

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 MiB

Loading…
Cancel
Save