You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
TRaSH-Guides/docs/Hardlinks/How-to-setup-for/Docker.md

4.6 KiB

Docker

!!! tip

If you're new to dockers and want a easy setup I suggest to take a look at [DockSTARTer](https://dockstarter.com/){:target="_blank" rel="noopener noreferrer"}.
I've also created a short guide [HERE](/Hardlinks/How-to-setup-for/Dockstarter/) where I explain the settings for the most used applications.

The main goal of DockSTARTer is to make it quick and easy to get up and running with Docker.
You may choose to rely on DockSTARTer for various changes to your Docker system or use DockSTARTer as a stepping stone and learn to do more advanced configurations.

*DockSTARTer was actually my first steps in to the world of dockers.*

!!! note

I'm not going to explain how to get dockers installed and running, I will only explain which folder structure we recommend.

The paths mentioned below refer to internal paths for the containers!

External paths depends where you mounted your share or your drives.

For example `/<path_to_data>/data`, or even `/data`.

Folder Structure

!!! attention

It doesn't really matter which path you use for your media and appdata,

the only thing you should avoid is `/home`.

Because user folders in `/home` are expected to have some restrictive permissions.

It just could end up creating a permissions mess, so it's better to just avoid entirely.

For this example we're going to make use of a share called 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.

In this examples I'm using lower case on all folder on purpose, being Linux is case sensitive.

data
├── torrents
│  ├── movies
│  ├── music
│  └── tv
├── usenet
│  ├── movies
│  ├── music
│  └── tv
└── media
   ├── movies
   ├── music
   └── tv

Breakdown of the Folder Structure

!!! info

The paths you use on the inside matter. Because of how Dockers volumes work, passing in two or three volumes such as the commonly suggested `/tv`, `/movies` and `/downloads` makes them look like two or three file systems, even if they arent. This means hard links wont work and instead of an instant move, a slower and more I/O intensive copy + delete is used.

Torrent clients

qBittorrent, Deluge, ruTorrent

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}.

data
└── torrents
   ├── movies
   ├── music
   └── tv

Usenet clients

NZBGet or SABnzbd

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}.

data
└── usenet
   ├── movies
   ├── music
   └── tv

The arr(s)

Sonarr, Radarr and Lidarr

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.

data
├── torrents
│  ├── movies
│  ├── music
│  └── tv
├── usenet
│  ├── movies
│  ├── music
│  └── tv
└── media
   ├── movies
   ├── music
   └── tv

Media Server

Plex, Emby, JellyFin and Bazarr

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.

data
└── media
   ├── movies
   ├── music
   └── tv

Don't forget to look at the Examples how to setup the paths inside your applications.

Docker-compose Example

!!! example "" This is a docker-compose example based on a default Ubuntu install.

The storage location used for the host is actually the same as in the container to make it easier to understand in this case `/data`.

The appdata (`/config`) will be stored on the host in the `/docker/appdata/{appname}`

??? example "docker-compose"

```yml
--8<-- "includes/docker/docker-compose.yml"
```