open-source-guides
/
TRaSH-Guides
mirror of https://github.com/TRaSH-/Guides
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[Guides Hardlinks] Improve readability paths

Browse Source 
# 2023-04-15 12:25
**[New]**
- None

**[Updated]**
- [Guides Hardlinks] Improve readability paths

**[Fixed]**
- None
pull/1263/head
TRaSH 1 year ago
parent 8145169090
commit 6cd03a35c7
9 changed files with 135 additions and 27 deletions
Show Stats Download Patch File Download Diff File

6
docs/Hardlinks/How-to-setup-for/Docker.md
Unescape View File

@ -14,9 +14,9 @@
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!
The paths mentioned below refer to internal paths (or `Container Path`) for the containers!
External paths depends where you mounted your share or your drives.
External paths (or `Host Path`) depends where you mounted your share or your drives.
For example `/<path_to_data>/data`, or even `/data`.
@ -26,7 +26,7 @@
{! include-markdown "../../../includes/hardlinks/bad-path-suggestion.md" !}
<!-- --8<-- "includes/hardlinks/bad-path-suggestion.md" -->
{! include-markdown "../../../includes/hardlinks/breakdown-folder-structure.md" !}
{! include-markdown "../../../includes/hardlinks/breakdown-folder-structure-docker.md" !}
<!-- --8<-- "includes/hardlinks/breakdown-folder-structure.md" -->
{! include-markdown "../../../includes/hardlinks/permissions.md" !}

24
docs/Hardlinks/How-to-setup-for/Dockstarter.md
Unescape View File

@ -13,20 +13,20 @@ In this example the mounted drive will be mounted to `/mnt/` with the following
storage
├── downloads
│ ├── torrents
│ │ ├── movies
│ │ ├── music
| | ├── books
│ │ └── tv
│ │ ├── movies
│ │ ├── music
│ │ ├── books
│ │ └── tv
│ └── usenet
│ ├── movies
│ ├── music
| ├── books
│ └── tv
│ ├── movies
│ ├── music
│ ├── books
│ └── tv
└── medialibrary
├── movies
├── music
├── books
└── tv
├── movies
├── music
├── books
└── tv
```
## Changes to the .env

2
docs/Hardlinks/How-to-setup-for/Synology.md
Unescape View File

@ -153,7 +153,7 @@ These subfolders you need to create your self.
{! include-markdown "../../../includes/hardlinks/bad-path-suggestion.md" !}
<!-- --8<-- "includes/hardlinks/bad-path-suggestion.md" -->
{! include-markdown "../../../includes/hardlinks/breakdown-folder-structure.md" !}
{! include-markdown "../../../includes/hardlinks/breakdown-folder-structure-synology.md" !}
<!-- --8<-- "includes/hardlinks/breakdown-folder-structure.md" -->
------

4
includes/hardlinks/bad-path-suggestion.md
Unescape View File

@ -1,3 +1,3 @@
!!! warning ""
### Bad path suggestion
The default path setup suggested by some docker developers that encourages people to use mounts like `/movies`, `/tv`, `/books` or `/downloads` is very suboptimal and it makes them look like two or three file systems, even if they aren’t (*Because of how Docker’s volumes work*). It is the easiest way to get started. While easy to use, it has a major drawback. Mainly losing the ability to hardlink or instant move, resulting in a slower and more I/O intensive copy + delete is used.
!!! warning "The default path setup suggested by some docker developers that encourages people to use mounts like `/movies`, `/tv`, `/books` or `/downloads` is very suboptimal and it makes them look like two or three file systems, even if they aren’t (*Because of how Docker’s volumes work*). It is the easiest way to get started. While easy to use, it has a major drawback. Mainly losing the ability to hardlink or instant move, resulting in a slower and more I/O intensive copy + delete is used."

53
includes/hardlinks/breakdown-folder-structure-docker.md
Unescape View File

@ -0,0 +1,53 @@
### 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}`.
{! include-markdown "docker-tree-torrents.md" !}
`Container Path:` => `/data/torrents/`
`Host Path:` => `/<path_to_data>/data/torrents/`
#### 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/complete/{tv|movies|music}`.
{! include-markdown "docker-tree-usenet.md" !}
`Container Path:` => `/data/usenet/`
`Host Path:` => `/<path_to_data>/data/usenet/`
#### The Starr Apps
Sonarr, Radarr, Readarr and Lidarr
Sonarr, Radarr, Readarr and Lidarr gets access to everything using `/data` because the download folder(s) and media folder will look like and be one file system. Hardlinks will work and moves will be atomic, instead of copy + delete.
{! include-markdown "docker-tree-full.md" !}
`Container Path:` => `/data`
`Host Path:` => `/<path_to_data>/data/`
#### Media Server
Plex, Emby, JellyFin and Bazarr
Plex, Emby, JellyFin and Bazarr only needs access to your media library using `/data/media`, which can have any number of sub folders like Movies, Kids Movies, TV, Documentary TV and/or Music as sub folders.
{! include-markdown "docker-tree-media.md" !}
`Container Path:` => `/data/media`
`Host Path:` => `/<path_to_data>/data/media/`
------
**Don't forget to look at the [Examples](/Hardlinks/Examples/) how to setup the paths inside the applications.**

53
includes/hardlinks/breakdown-folder-structure-synology.md
Unescape View File

@ -0,0 +1,53 @@
### 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}`.
{! include-markdown "docker-tree-torrents.md" !}
`Container Path:` => `/data/torrents/`
`Host Path:` => `/volume1/data/torrents/`
#### 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/complete/{tv|movies|music}`.
{! include-markdown "docker-tree-usenet.md" !}
`Container Path:` => `/data/usenet/`
`Host Path:` => `/volume1/data/usenet/`
#### The Starr Apps
Sonarr, Radarr, Readarr and Lidarr
Sonarr, Radarr, Readarr and Lidarr gets access to everything using `/data` because the download folder(s) and media folder will look like and be one file system. Hardlinks will work and moves will be atomic, instead of copy + delete.
{! include-markdown "docker-tree-full.md" !}
`Container Path:` => `/data`
`Host Path:` => `/volume1/data/`
#### Media Server
Plex, Emby, JellyFin and Bazarr
Plex, Emby, JellyFin and Bazarr only needs access to your media library using `/data/media`, which can have any number of sub folders like Movies, Kids Movies, TV, Documentary TV and/or Music as sub folders.
{! include-markdown "docker-tree-media.md" !}
`Container Path:` => `/data/media`
`Host Path:` => `/volume1/data/media/`
------
**Don't forget to look at the [Examples](/Hardlinks/Examples/) how to setup the paths inside the applications.**

2
includes/hardlinks/breakdown-folder-structure.md
Unescape View File

@ -12,7 +12,7 @@ The reason why we use `/data/torrents` for the torrent client is because it only
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}`.
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/complete/{tv|movies|music}`.
{! include-markdown "docker-tree-usenet.md" !}

9
includes/hardlinks/docker-tree-full.md
Unescape View File

@ -6,10 +6,11 @@ data
│ ├── music
│ └── tv
├── usenet
│ ├── books
│ ├── movies
│ ├── music
│ └── tv
│ └── complete
│ ├── books
│ ├── movies
│ ├── music
│ └── tv
└── media
├── books
├── movies

9
includes/hardlinks/docker-tree-usenet.md
Unescape View File

@ -1,8 +1,9 @@
```none
data
└── usenet
├── books
├── movies
├── music
└── tv
└── complete
├── books
├── movies
├── music
└── tv
```

Write Preview
Loading…
Cancel
Save