From e3316bec9fd80b492327621e7bd0e57341cf512b Mon Sep 17 00:00:00 2001 From: TRaSH Date: Sun, 20 Jun 2021 00:25:53 +0200 Subject: [PATCH] Changed: to Snippets for easier maintenace (insert content from other files) --- docs/Hardlinks/How-to-setup-for/Docker.md | 104 +--------------- docs/Hardlinks/How-to-setup-for/Native.md | 115 +----------------- docs/Hardlinks/How-to-setup-for/Synology.md | 79 +----------- .../hardlinks/breakdown-folder-structure.md | 69 +++++++++++ includes/hardlinks/docker-compose-commands.md | 8 ++ includes/hardlinks/folder-structure.md | 33 +++++ includes/hardlinks/permissions.md | 8 ++ 7 files changed, 130 insertions(+), 286 deletions(-) create mode 100644 includes/hardlinks/breakdown-folder-structure.md create mode 100644 includes/hardlinks/docker-compose-commands.md create mode 100644 includes/hardlinks/folder-structure.md create mode 100644 includes/hardlinks/permissions.md diff --git a/docs/Hardlinks/How-to-setup-for/Docker.md b/docs/Hardlinks/How-to-setup-for/Docker.md index a8808930b..b74c0d8e6 100644 --- a/docs/Hardlinks/How-to-setup-for/Docker.md +++ b/docs/Hardlinks/How-to-setup-for/Docker.md @@ -20,111 +20,15 @@ For example `//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 you’d pass to Plex, Emby or JellyFin. - -*In this examples I'm using lower case on all folder on purpose, being Linux is case sensitive.* - -```none -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 Docker’s 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 aren’t. This means hard links won’t 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, you’ll need to reconfigure paths and you can sort into sub-folders like `/data/torrents/{tv|movies|music}`. +--8<-- "includes/hardlinks/folder-structure.md" -```none -data -└── torrents - ├── movies - ├── music - └── tv -``` +--8<-- "includes/hardlinks/breakdown-folder-structure.md" -#### 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, you’ll need to reconfigure paths and you can sort into sub-folders like `/data/usenet/{tv|movies|music}`. - -```none -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. - -```none -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. - -```none -data -└── media - ├── movies - ├── music - └── tv -``` - -**Don't forget to look at the [Examples](/Hardlinks/Examples/) how to setup the paths inside your applications.** +--8<-- "includes/hardlinks/permissions.md" ## Docker-compose Example @@ -140,3 +44,5 @@ data ```yml --8<-- "includes/docker/docker-compose.yml" ``` + +--8<-- "includes/hardlinks/docker-compose-commands.md" diff --git a/docs/Hardlinks/How-to-setup-for/Native.md b/docs/Hardlinks/How-to-setup-for/Native.md index 64715aaa4..aa9368899 100644 --- a/docs/Hardlinks/How-to-setup-for/Native.md +++ b/docs/Hardlinks/How-to-setup-for/Native.md @@ -4,117 +4,10 @@ I'm not going to explain how to install all the applications, I will only explain which folder structure we recommend. ------- +--- -## Folder Structure +--8<-- "includes/hardlinks/folder-structure.md" -!!! attention +--8<-- "includes/hardlinks/breakdown-folder-structure.md" - It doesn't really matter which path you use for your media, - - 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 you’d pass to Plex, Emby or JellyFin. - -*I'm using lower case on all folder on purpose, being Linux is case sensitive.* - -```none -data -├── torrents -│ ├── movies -│ ├── music -│ └── tv -├── usenet -│ ├── movies -│ ├── music -│ └── tv -└── media - ├── movies - ├── music - └── tv -``` - -## Breakdown of the Folder Structure - -### 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, you’ll need to reconfigure paths and you can sort into sub-folders like `/data/torrents/{tv|movies|music}`. - -```none -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, you’ll need to reconfigure paths and you can sort into sub-folders like `/data/usenet/{tv|movies|music}`. - -```none -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. - -```none -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. - -```none -data -└── media - ├── movies - ├── music - └── tv -``` - ------- - -## Permissions - -Recursively chown user and group and Recursively chmod to 775/664 - -```bash -sudo chown -R $USER:$USER /data -sudo chmod -R a=,a+rX,u+w,g+w /data -``` - -**Don't forget to look at the [Examples](/Hardlinks/How-to-setup-for/) how to setup the paths inside the applications.** +--8<-- "includes/hardlinks/permissions.md" diff --git a/docs/Hardlinks/How-to-setup-for/Synology.md b/docs/Hardlinks/How-to-setup-for/Synology.md index 9c64d42e0..2808bfb80 100644 --- a/docs/Hardlinks/How-to-setup-for/Synology.md +++ b/docs/Hardlinks/How-to-setup-for/Synology.md @@ -74,75 +74,7 @@ data └── tv ``` -## Breakdown of the Folder Structure - -!!! info - - The paths you use on the inside matter. Because of how Docker’s 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 aren’t. This means hard links won’t 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, you’ll need to reconfigure paths and you can sort into sub-folders like `/data/torrents/{tv|movies|music}`. - -```none -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, you’ll need to reconfigure paths and you can sort into sub-folders like `/data/usenet/{tv|movies|music}`. - -```none -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. - -```none -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. - -```none -data -└── media - ├── movies - ├── music - └── tv -``` +--8<-- "includes/hardlinks/breakdown-folder-structure.md" ------ @@ -240,7 +172,7 @@ sudo chmod -R a=,a+rX,u+w,g+w /volume1/data /volume1/docker ------ -### Run the Docker Compose +## Run the Docker Compose !!! important make sure you deleted/removed all your existing dockers from the GUI and also remove your native installs of these applications !!! @@ -266,9 +198,4 @@ You will notice that all the images will be downloaded, and after that the conta Just don't use the GUI !!! -??? hint "docker-compose commands - [CLICK TO EXPAND]" - - - `sudo docker-compose up -d` (This Docker-compose command helps builds the image, then creates and starts Docker containers. The containers are from the services specified in the compose file. If the containers are already running and you run docker-compose up, it recreates the container.) - - `sudo docker-compose pull` (Pulls an image associated with a service defined in a docker-compose.yml) - - `sudo docker-compose down` (The Docker-compose down command also stops Docker containers like the stop command does. But it goes the extra mile. Docker-compose down, doesn’t just stop the containers, it also removes them.) - - `sudo docker system prune -a --volumes --force` (Remove all unused containers, networks, images (both dangling and unreferenced), and optionally, volumes.) +--8<-- "includes/hardlinks/docker-compose-commands.md" diff --git a/includes/hardlinks/breakdown-folder-structure.md b/includes/hardlinks/breakdown-folder-structure.md new file mode 100644 index 000000000..90a8f6b22 --- /dev/null +++ b/includes/hardlinks/breakdown-folder-structure.md @@ -0,0 +1,69 @@ +### Breakdown of the Folder Structure + +#### 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, you’ll need to reconfigure paths and you can sort into sub-folders like `/data/torrents/{tv|movies|music}`. + +```none +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, you’ll need to reconfigure paths and you can sort into sub-folders like `/data/usenet/{tv|movies|music}`. + +```none +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. + +```none +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. + +```none +data +└── media + ├── movies + ├── music + └── tv +``` + +------ + +**Don't forget to look at the [Examples](/Hardlinks/Examples/) how to setup the paths inside the applications.** diff --git a/includes/hardlinks/docker-compose-commands.md b/includes/hardlinks/docker-compose-commands.md new file mode 100644 index 000000000..57bba696a --- /dev/null +++ b/includes/hardlinks/docker-compose-commands.md @@ -0,0 +1,8 @@ +### Docker-Compose Commands + +??? hint "docker-compose commands - [CLICK TO EXPAND]" + + - `sudo docker-compose up -d` (This Docker-compose command helps builds the image, then creates and starts Docker containers. The containers are from the services specified in the compose file. If the containers are already running and you run docker-compose up, it recreates the container.) + - `sudo docker-compose pull` (Pulls an image associated with a service defined in a docker-compose.yml) + - `sudo docker-compose down` (The Docker-compose down command also stops Docker containers like the stop command does. But it goes the extra mile. Docker-compose down, doesn’t just stop the containers, it also removes them.) + - `sudo docker system prune -a --volumes --force` (Remove all unused containers, networks, images (both dangling and unreferenced), and optionally, volumes.) diff --git a/includes/hardlinks/folder-structure.md b/includes/hardlinks/folder-structure.md new file mode 100644 index 000000000..f7d64ea2b --- /dev/null +++ b/includes/hardlinks/folder-structure.md @@ -0,0 +1,33 @@ +## 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 you’d pass to Plex, Emby or JellyFin. + +*In this examples I'm using lower case on all folder on purpose, being Linux is case sensitive.* + +```none +data +├── torrents +│ ├── movies +│ ├── music +│ └── tv +├── usenet +│ ├── movies +│ ├── music +│ └── tv +└── media + ├── movies + ├── music + └── tv +``` diff --git a/includes/hardlinks/permissions.md b/includes/hardlinks/permissions.md new file mode 100644 index 000000000..3d93868fd --- /dev/null +++ b/includes/hardlinks/permissions.md @@ -0,0 +1,8 @@ +### Permissions + +Recursively chown user and group and Recursively chmod to 775/664 + +```bash +sudo chown -R $USER:$USER /data +sudo chmod -R a=,a+rX,u+w,g+w /data +```