Skip to content

Commit

Permalink
feat(guide): Unraid - Make certain steps clearer and add a few tips (#…
Browse files Browse the repository at this point in the history
…2113)

* feat(guide): Unraid - Make certain steps clearer and add a few tips

* Apply suggestions from code review

Co-authored-by: yammes08 <[email protected]>

---------

Co-authored-by: yammes08 <[email protected]>
  • Loading branch information
TRaSH- and yammes08 authored Oct 26, 2024
1 parent b877ba9 commit 2c33b43
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 10 deletions.
50 changes: 40 additions & 10 deletions docs/File-and-Folder-Structure/How-to-set-up/Unraid.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Make sure `Tunable (support Hard Links)` is enabled in your `Settings` => `Globa

!!! 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`.
In this example, I'm using my setup and the preferred share `data`.

Go to your dashboard and select `Shares` on the navigation bar, then choose `Add Share`.

Expand Down Expand Up @@ -69,7 +69,7 @@ On the host (unRAID) you will need to add `/mnt/user` before it. **So `/mnt/user

_I'm using lower-case on all folders on purpose, being Linux is case-sensitive._

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 you’d 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 you’d pass to Plex, Emby, or JellyFin.

You will need to create these subfolders yourself. You can do this in any way you prefer, but the fastest way to create all the necessary subfolders would be to use the terminal (explained below). Alternatively, Krusader or WinSCP are popular choices if you are unsure.

Expand All @@ -79,7 +79,7 @@ The fastest way to create all the necessary subfolders would be to use the termi
These options will automatically create the required subfolders for your media library as well as your preferred download client(s).
If you use both torrents and Usenet, use both commands.

#### If you use usenet
#### If you use Usenet

```bash
mkdir -p /mnt/user/data/{usenet/{incomplete,complete}/{tv,movies,music},media/{tv,movies,music}}
Expand All @@ -99,17 +99,45 @@ mkdir -p /mnt/user/data/{torrents/{tv,movies,music},media/{tv,movies,music}}

## Setting up the containers

!!! tip "Create a custom docker network"
Why would you want a custom docker network?

A major benefit of having your Docker containers on the same custom Docker network is that they will be able to communicate with other using their container names, rather than having to use IP addresses.

Unraid doesn't create a custom docker network by default, you need to create one yourself.

- Open a terminal window and type:

```none
docker network create your_uber_cool_network_name
```

- or watch the following video below on how to create a custom docker network

<iframe width="560" height="315" src="https://www.youtube.com/embed/7fzBDCI8O2w?si=itGS624rC7jxD8ly" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

---

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 the Docker container you want to edit, or, if you're starting fresh, add the container/App you want to use.

unRAID makes it pretty clear which is the Host Path and Container Path.
1. Make sure you enable the `Advanced View` at the top right corner.

![!Enable Advanced View](images/unraid-docker-enable-advanced-view.png)

`Container Path:` => The path that will be used from inside the container.
1. When adding/editing the paths make sure you click on the `EDIT` button to add/edit the paths correctly.

`Host Path:` => The actual/absolute path used on your unRAID Server (The Host).
![!Click on Edit](images/unraid-docker-click-edit.png)

!!! tip "Make sure you enabled the advanced view at the top right corner and click on the `EDIT` button to edit the paths correctly."
1. Don't forget to remove all individual location mounts, for example `/movies`, `/tv`, `/books`, or `/downloads`, so you can avoid making mistakes by using them. You only need the `/config` mount, and then whichever paths/mounts/volumes are described in this guide.

!!! info
unRAID makes it pretty clear which is the Host Path and Container Path.

`Container Path:` => The path that will be used from inside the container.

`Host Path:` => The actual/absolute path used on your unRAID Server (The Host).

---

Expand Down Expand Up @@ -161,7 +189,7 @@ Sonarr, Radarr and Lidarr

!!! info

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.
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/file-and-folder-structure/docker-tree-full.md" !}

Expand All @@ -179,7 +207,7 @@ Plex, Emby, JellyFin and Bazarr

!!! info

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).
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/file-and-folder-structure/docker-tree-media.md" !}

Expand All @@ -189,14 +217,16 @@ Plex, Emby, JellyFin and Bazarr

![!unraid-final-result](images/unraid-final-result.png)

### Examples how to set up your paths INSIDE your applications
### Examples - How to set up your paths INSIDE your applications

**Don't forget to look at the [Examples](/File-and-Folder-Structure/Examples/) of how to set up your paths INSIDE your applications.**

## Video Tutorial

!!! tip ""

!!! warning "Videos are generally outdated very fast, so make sure you always follow and double-check with the written guide."

Big Thanks to IBRACORP for noticing this Guide and creating a Video covering this unRAID section.

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 before going straight to a YouTube video.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2c33b43

Please sign in to comment.