diff --git a/docs/.pages b/docs/.pages index 1c2c92bfc..8e874752b 100644 --- a/docs/.pages +++ b/docs/.pages @@ -5,10 +5,9 @@ nav: - Prowlarr - Lidarr - Bazarr + - File-and-Folder-Structure - Downloaders - Plex - Guide-Sync - Misc - - Hardlinks - - How-to-setup-for: Hardlinks/How-to-setup-for - Glossary diff --git a/docs/Downloaders/NZBGet/Paths-and-Categories.md b/docs/Downloaders/NZBGet/Paths-and-Categories.md index 1e70ab518..b9ce5b6c8 100644 --- a/docs/Downloaders/NZBGet/Paths-and-Categories.md +++ b/docs/Downloaders/NZBGet/Paths-and-Categories.md @@ -8,11 +8,11 @@ `Settings` => `PATHS` -![nzbget-settings-paths](/Hardlinks/images/nzbget-settings-paths.png) +![nzbget-settings-paths](/File-and-Folder-Structure/images/nzbget-settings-paths.png) `Settings` => `CATEGORIES` -![nzbget-settings-categories](/Hardlinks/images/nzbget-settings-categories.png) +![nzbget-settings-categories](/File-and-Folder-Structure/images/nzbget-settings-categories.png) {! include-markdown "../../../includes/downloaders/warning-path-location.md" !} diff --git a/docs/Downloaders/qBittorrent/How-to-add-categories.md b/docs/Downloaders/qBittorrent/How-to-add-categories.md index c78824440..126df2363 100644 --- a/docs/Downloaders/qBittorrent/How-to-add-categories.md +++ b/docs/Downloaders/qBittorrent/How-to-add-categories.md @@ -6,7 +6,7 @@ This basic example is based on the use of docker images Keep in mind the path are set up so it works with hardlinks and instant moves. - More info [HERE](/Hardlinks/Hardlinks-and-Instant-Moves/){:target="_blank" rel="noopener noreferrer"} + More info [HERE](/File-and-Folder-Structure/Hardlinks-and-Instant-Moves/){:target="_blank" rel="noopener noreferrer"} !!! info diff --git a/docs/Downloaders/qBittorrent/Paths.md b/docs/Downloaders/qBittorrent/Paths.md index 81216409f..c772c5420 100644 --- a/docs/Downloaders/qBittorrent/Paths.md +++ b/docs/Downloaders/qBittorrent/Paths.md @@ -6,4 +6,4 @@ `Options` => `Downloads` -![qbt-options-downloads](/Hardlinks/images/qbt-options-downloads.png) +![qbt-options-downloads](/File-and-Folder-Structure/images/qbt-options-downloads.png) diff --git a/docs/File-and-Folder-Structure/.pages b/docs/File-and-Folder-Structure/.pages new file mode 100644 index 000000000..58f7bf2e9 --- /dev/null +++ b/docs/File-and-Folder-Structure/.pages @@ -0,0 +1,7 @@ +nav: + - Home: index.md + - Hardlinks and Instant Moves: Hardlinks-and-Instant-Moves.md + - How To Set Up: How-to-set-up + - Examples: Examples.md + - Check if Hardlinks Are Working: Check-if-hardlinks-are-working.md + - Replace Copies With Hardlinks: Replace-copies-with-hardlinks.md diff --git a/docs/Hardlinks/Check-if-hardlinks-are-working.md b/docs/File-and-Folder-Structure/Check-if-hardlinks-are-working.md similarity index 98% rename from docs/Hardlinks/Check-if-hardlinks-are-working.md rename to docs/File-and-Folder-Structure/Check-if-hardlinks-are-working.md index aefefe681..fb09b2778 100644 --- a/docs/Hardlinks/Check-if-hardlinks-are-working.md +++ b/docs/File-and-Folder-Structure/Check-if-hardlinks-are-working.md @@ -73,3 +73,5 @@ It will list all files linked with the same inode number. - In the command line type: `fsutil hardlink list c:\path\to\your\download\location\file.mkv` It will list all hardlinked files. + +--8<-- "includes/support.md" diff --git a/docs/Hardlinks/Examples.md b/docs/File-and-Folder-Structure/Examples.md similarity index 99% rename from docs/Hardlinks/Examples.md rename to docs/File-and-Folder-Structure/Examples.md index 10e23e7e9..6305c9b93 100644 --- a/docs/Hardlinks/Examples.md +++ b/docs/File-and-Folder-Structure/Examples.md @@ -126,3 +126,5 @@ --- Big Thanks to [fryfrog](https://github.com/fryfrog){:target="\_blank" rel="noopener noreferrer"} for his [Docker Guide](https://wiki.servarr.com/docker-guide){:target="\_blank" rel="noopener noreferrer"} that we used as a basis for this guide. + +--8<-- "includes/support.md" diff --git a/docs/Hardlinks/Hardlinks-and-Instant-Moves.md b/docs/File-and-Folder-Structure/Hardlinks-and-Instant-Moves.md similarity index 84% rename from docs/Hardlinks/Hardlinks-and-Instant-Moves.md rename to docs/File-and-Folder-Structure/Hardlinks-and-Instant-Moves.md index bd358129c..1e3236621 100644 --- a/docs/Hardlinks/Hardlinks-and-Instant-Moves.md +++ b/docs/File-and-Folder-Structure/Hardlinks-and-Instant-Moves.md @@ -11,9 +11,9 @@ This guide consists of 4 sections. 1. This page with a short description. -1. [How to set up for](/Hardlinks/How-to-setup-for/) your installation method. -1. [Examples](/Hardlinks/Examples/) What you should use for your path settings in your used applications. -1. [Check if hardlinks are working](/Hardlinks/Check-if-hardlinks-are-working/) +2. [How to set up](/File-and-Folder-Structure/How-to-set-up/) for your installation method. +3. [Examples](/File-and-Folder-Structure/Examples/) What you should use for your path settings in your used applications. +4. [Check if hardlinks are working](/File-and-Folder-Structure/Check-if-hardlinks-are-working/) So you want one of the following? @@ -21,7 +21,7 @@ So you want one of the following? - You don't want to use twice the storage when using torrents. (hardlinks)? - You want to perma-seed? -Then Continue to [How to set up for](/Hardlinks/How-to-setup-for/) your installation method. +Then Continue to [How to set up](/File-and-Folder-Structure/How-to-set-up/) for your installation method. ## FAQ @@ -52,7 +52,7 @@ Then Continue to [How to set up for](/Hardlinks/How-to-setup-for/) your installa [More info from Wikipedia, the free encyclopedia](https://en.wikipedia.org/wiki/Hard_link){:target="_blank" rel="noopener noreferrer"} - !!! warning "Don't forget to read the [Hardlinks limitations](/Hardlinks/Hardlinks-and-Instant-Moves/#hardlinks-limitations)" + !!! warning "Don't forget to read the [Hardlinks limitations](/File-and-Folder-Structure/Hardlinks-and-Instant-Moves/#hardlinks-limitations)" ### What are Instant Moves (Atomic Moves) @@ -65,3 +65,5 @@ Then Continue to [How to set up for](/Hardlinks/How-to-setup-for/) your installa ??? question "**What are the `Starr Apps`?** - [Click to show/hide]" Sonarr, Radarr, Lidarr, etc. + +--8<-- "includes/support.md" diff --git a/docs/Hardlinks/How-to-setup-for/Docker.md b/docs/File-and-Folder-Structure/How-to-set-up/Docker.md similarity index 69% rename from docs/Hardlinks/How-to-setup-for/Docker.md rename to docs/File-and-Folder-Structure/How-to-set-up/Docker.md index 0143844c0..39f410e90 100644 --- a/docs/Hardlinks/How-to-setup-for/Docker.md +++ b/docs/File-and-Folder-Structure/How-to-set-up/Docker.md @@ -3,7 +3,7 @@ !!! tip If you're new to dockers and want an easy setup, we suggest taking a look at [DockSTARTer](https://dockstarter.com/){:target="_blank" rel="noopener noreferrer"}. - We've also created a short guide [HERE](/Hardlinks/How-to-setup-for/Dockstarter/) where we explain the settings for the most used applications. + We've also created a short guide [HERE](/File-and-Folder-Structure/How-to-set-up/Dockstarter/) where we 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. @@ -20,13 +20,13 @@ For example `//data`, or even `/data`. -{! include-markdown "../../../includes/hardlinks/folder-structure.md" !} +{! include-markdown "../../../includes/file-and-folder-structure/folder-structure.md" !} -{! include-markdown "../../../includes/hardlinks/bad-path-suggestion.md" !} +{! include-markdown "../../../includes/file-and-folder-structure/bad-path-suggestion.md" !} -{! include-markdown "../../../includes/hardlinks/breakdown-folder-structure-docker.md" !} +{! include-markdown "../../../includes/file-and-folder-structure/breakdown-folder-structure-docker.md" !} -{! include-markdown "../../../includes/hardlinks/permissions.md" !} +{! include-markdown "../../../includes/file-and-folder-structure/permissions.md" !} ## Docker-compose Example @@ -44,6 +44,6 @@ --8<-- "includes/docker/docker-compose.yml" ``` -{! include-markdown "../../../includes/hardlinks/docker-compose-commands.md" !} +{! include-markdown "../../../includes/file-and-folder-structure/docker-compose-commands.md" !} --8<-- "includes/support.md" diff --git a/docs/Hardlinks/How-to-setup-for/Dockstarter.md b/docs/File-and-Folder-Structure/How-to-set-up/Dockstarter.md similarity index 95% rename from docs/Hardlinks/How-to-setup-for/Dockstarter.md rename to docs/File-and-Folder-Structure/How-to-set-up/Dockstarter.md index dc7a963cb..0a20a7366 100644 --- a/docs/Hardlinks/How-to-setup-for/Dockstarter.md +++ b/docs/File-and-Folder-Structure/How-to-set-up/Dockstarter.md @@ -85,7 +85,7 @@ When that's all set then you will need to change the paths you're going to use i `Settings` => `Media Management` => `Importing` - ![sonarr-enable-hardlinks](/Hardlinks/images/sonarr-enable-hardlinks.png) + ![sonarr-enable-hardlinks](/File-and-Folder-Structure/images/sonarr-enable-hardlinks.png) `Settings` => `Media Management` => `Root Folders` @@ -103,7 +103,7 @@ When that's all set then you will need to change the paths you're going to use i `Settings` => `Media Management` => `Importing` - ![radarr-enable-hardlinks](/Hardlinks/images/radarr-enable-hardlinks.png) + ![radarr-enable-hardlinks](/File-and-Folder-Structure/images/radarr-enable-hardlinks.png) `Settings` => `Media Management` => `Root Folders` diff --git a/docs/File-and-Folder-Structure/How-to-set-up/Native.md b/docs/File-and-Folder-Structure/How-to-set-up/Native.md new file mode 100644 index 000000000..479858ba3 --- /dev/null +++ b/docs/File-and-Folder-Structure/How-to-set-up/Native.md @@ -0,0 +1,15 @@ +# Native + +!!! note + + We're not going to explain how to install all the applications, but we will explain which folder structure we recommend. + +--- + +{! include-markdown "../../../includes/file-and-folder-structure/folder-structure.md" !} + +{! include-markdown "../../../includes/file-and-folder-structure/breakdown-folder-structure.md" !} + +{! include-markdown "../../../includes/file-and-folder-structure/permissions.md" !} + +--8<-- "includes/support.md" diff --git a/docs/Hardlinks/How-to-setup-for/Synology.md b/docs/File-and-Folder-Structure/How-to-set-up/Synology.md similarity index 96% rename from docs/Hardlinks/How-to-setup-for/Synology.md rename to docs/File-and-Folder-Structure/How-to-set-up/Synology.md index 0089687cb..6719716b0 100644 --- a/docs/Hardlinks/How-to-setup-for/Synology.md +++ b/docs/File-and-Folder-Structure/How-to-set-up/Synology.md @@ -137,9 +137,9 @@ Let's create a good folder structure on the shares we use (`docker` and `data`). The structure will look like this. You can of course edit this, but do this when you know what you are doing. _We are using lowercase on all folders on purpose, being Linux is case-sensitive._ -{! include-markdown "../../../includes/hardlinks/docker-tree-full.md" !} +{! include-markdown "../../../includes/file-and-folder-structure/docker-tree-full.md" !} -{! include-markdown "../../../includes/hardlinks/bad-path-suggestion.md" !} +{! include-markdown "../../../includes/file-and-folder-structure/bad-path-suggestion.md" !} To create the folder structure for your media library and also for your preferred download client, run one or both of the following commands: @@ -333,7 +333,7 @@ You will notice that all the images will be downloaded, and after that, the cont --- -**If you need help setting up the applications, look at the [Examples](/Hardlinks/Examples/) of how to set up the paths inside your applications.** +**If you need help setting up the applications, look at the [Examples](/File-and-Folder-Structure/Examples/) of how to set up the paths inside your applications.** !!! warning @@ -343,7 +343,7 @@ You will notice that all the images will be downloaded, and after that, the cont Just don't use the GUI, only for information purposes !!! -{! include-markdown "../../../includes/hardlinks/docker-compose-commands.md" !} +{! include-markdown "../../../includes/file-and-folder-structure/docker-compose-commands.md" !} --8<-- "includes/support.md" @@ -360,5 +360,7 @@ To fix this, you will need to add a Scheduled Task that executes at boot as the ??? question "Task bash command - [Click to show/hide]" ```bash - --8<-- "includes/hardlinks/docker-iptables-fix.sh" + --8<-- "includes/file-and-folder-structure/docker-iptables-fix.sh" ``` + +--8<-- "includes/support.md" diff --git a/docs/Hardlinks/How-to-setup-for/TrueNAS-Core.md b/docs/File-and-Folder-Structure/How-to-set-up/TrueNAS-Core.md similarity index 99% rename from docs/Hardlinks/How-to-setup-for/TrueNAS-Core.md rename to docs/File-and-Folder-Structure/How-to-set-up/TrueNAS-Core.md index 9c11c89be..18d4cfd41 100644 --- a/docs/Hardlinks/How-to-setup-for/TrueNAS-Core.md +++ b/docs/File-and-Folder-Structure/How-to-set-up/TrueNAS-Core.md @@ -128,7 +128,7 @@ Regardless of the method, make sure that the device ends up with a `data` mount Now that you have a `data` folder, you can follow the normal folder structure recommendations, such as the one below. -{! include-markdown "../../../includes/hardlinks/docker-tree-full.md" !} +{! include-markdown "../../../includes/file-and-folder-structure/docker-tree-full.md" !} These subfolders you need to create yourself using your preferred method. Set your permissions accordingly as well. If you use ACLs on the datasets you can replicate the usual 775/664 (UMASK 002) or 755/644 (UMASK 022) recommendation, but this guide only covers the use of basic permissions for mounting and expects the end user to fine-tune permissions via chmod, chown, and uid/gid/umask settings on the applications that will be utilizing the share. diff --git a/docs/Hardlinks/How-to-setup-for/Unraid.md b/docs/File-and-Folder-Structure/How-to-set-up/Unraid.md similarity index 91% rename from docs/Hardlinks/How-to-setup-for/Unraid.md rename to docs/File-and-Folder-Structure/How-to-set-up/Unraid.md index 9a8cdf3ac..d5d91b9e0 100644 --- a/docs/Hardlinks/How-to-setup-for/Unraid.md +++ b/docs/File-and-Folder-Structure/How-to-set-up/Unraid.md @@ -65,7 +65,7 @@ Go to your dashboard and select `Shares` on the navigation bar, then choose `Add On the host (unRAID) you will need to add `/mnt/user` before it. **So `/mnt/user/data`** -{! include-markdown "../../../includes/hardlinks/docker-tree-full.md" !} +{! include-markdown "../../../includes/file-and-folder-structure/docker-tree-full.md" !} _I'm using lower-case on all folders on purpose, being Linux is case-sensitive._ @@ -95,7 +95,7 @@ mkdir -p /mnt/user/data/{torrents/{tv,movies,music},media/{tv,movies,music}} ### Breakdown of the Folder Structure -{! include-markdown "../../../includes/hardlinks/bad-path-suggestion.md" !} +{! include-markdown "../../../includes/file-and-folder-structure/bad-path-suggestion.md" !} ## Setting up the containers @@ -127,7 +127,7 @@ qBittorrent, Deluge, ruTorrent 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, you’ll 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" !} +{! include-markdown "../../../includes/file-and-folder-structure/docker-tree-torrents.md" !} --- @@ -145,7 +145,7 @@ NZBGet or SABnzbd 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, you’ll 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" !} +{! include-markdown "../../../includes/file-and-folder-structure/docker-tree-usenet.md" !} --- @@ -163,7 +163,7 @@ Sonarr, Radarr and Lidarr 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" !} +{! include-markdown "../../../includes/file-and-folder-structure/docker-tree-full.md" !} --- @@ -181,7 +181,7 @@ Plex, Emby, JellyFin and Bazarr 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" !} +{! include-markdown "../../../includes/file-and-folder-structure/docker-tree-media.md" !} --- @@ -191,7 +191,7 @@ Plex, Emby, JellyFin and Bazarr ### Examples how to set up your paths INSIDE your applications -**Don't forget to look at the [Examples](/Hardlinks/Examples/) of 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 diff --git a/docs/Hardlinks/How-to-setup-for/Windows.md b/docs/File-and-Folder-Structure/How-to-set-up/Windows.md similarity index 98% rename from docs/Hardlinks/How-to-setup-for/Windows.md rename to docs/File-and-Folder-Structure/How-to-set-up/Windows.md index 4ec574908..84a8eb7f6 100644 --- a/docs/Hardlinks/How-to-setup-for/Windows.md +++ b/docs/File-and-Folder-Structure/How-to-set-up/Windows.md @@ -87,7 +87,7 @@ After you create the base folders to use it's time to follow the #examples-how-t At the moment, we do not have Windows-based screenshots for all of the apps, but they might be added later. -So, in the meantime, use the [Examples](/Hardlinks/Examples/) of how to setup your paths INSIDE your applications. +So, in the meantime, use the [Examples](/File-and-Folder-Structure/Examples/) of how to setup your paths INSIDE your applications. However, for the paths, use the info provided below depending on whether you have a one-disk setup or a two-disk setup. !!! warning "Linux used forward slash `/` and Windows uses backslash `\`
So if you see paths with a forward slash replace it with a backslash for Windows" diff --git a/docs/Hardlinks/How-to-setup-for/images/adduser.PNG b/docs/File-and-Folder-Structure/How-to-set-up/images/adduser.PNG similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/adduser.PNG rename to docs/File-and-Folder-Structure/How-to-set-up/images/adduser.PNG diff --git a/docs/Hardlinks/How-to-setup-for/images/adduser_2.PNG b/docs/File-and-Folder-Structure/How-to-set-up/images/adduser_2.PNG similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/adduser_2.PNG rename to docs/File-and-Folder-Structure/How-to-set-up/images/adduser_2.PNG diff --git a/docs/Hardlinks/How-to-setup-for/images/adduser_3.PNG b/docs/File-and-Folder-Structure/How-to-set-up/images/adduser_3.PNG similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/adduser_3.PNG rename to docs/File-and-Folder-Structure/How-to-set-up/images/adduser_3.PNG diff --git a/docs/Hardlinks/How-to-setup-for/images/create_share.png b/docs/File-and-Folder-Structure/How-to-set-up/images/create_share.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/create_share.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/create_share.png diff --git a/docs/Hardlinks/How-to-setup-for/images/ds-deluge-preferences-downloads.png b/docs/File-and-Folder-Structure/How-to-set-up/images/ds-deluge-preferences-downloads.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/ds-deluge-preferences-downloads.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/ds-deluge-preferences-downloads.png diff --git a/docs/Hardlinks/How-to-setup-for/images/ds-nzbget-settings-categories.png b/docs/File-and-Folder-Structure/How-to-set-up/images/ds-nzbget-settings-categories.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/ds-nzbget-settings-categories.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/ds-nzbget-settings-categories.png diff --git a/docs/Hardlinks/How-to-setup-for/images/ds-nzbget-settings-paths.png b/docs/File-and-Folder-Structure/How-to-set-up/images/ds-nzbget-settings-paths.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/ds-nzbget-settings-paths.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/ds-nzbget-settings-paths.png diff --git a/docs/Hardlinks/How-to-setup-for/images/ds-qbt-options-downloads.png b/docs/File-and-Folder-Structure/How-to-set-up/images/ds-qbt-options-downloads.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/ds-qbt-options-downloads.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/ds-qbt-options-downloads.png diff --git a/docs/Hardlinks/How-to-setup-for/images/ds-radarr-add-new.png b/docs/File-and-Folder-Structure/How-to-set-up/images/ds-radarr-add-new.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/ds-radarr-add-new.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/ds-radarr-add-new.png diff --git a/docs/Hardlinks/How-to-setup-for/images/ds-radarr-movies.png b/docs/File-and-Folder-Structure/How-to-set-up/images/ds-radarr-movies.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/ds-radarr-movies.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/ds-radarr-movies.png diff --git a/docs/Hardlinks/How-to-setup-for/images/ds-radarr-root-folder.png b/docs/File-and-Folder-Structure/How-to-set-up/images/ds-radarr-root-folder.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/ds-radarr-root-folder.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/ds-radarr-root-folder.png diff --git a/docs/Hardlinks/How-to-setup-for/images/ds-rtorrent-settings-autotools.png b/docs/File-and-Folder-Structure/How-to-set-up/images/ds-rtorrent-settings-autotools.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/ds-rtorrent-settings-autotools.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/ds-rtorrent-settings-autotools.png diff --git a/docs/Hardlinks/How-to-setup-for/images/ds-rtorrent-settings-downloads.png b/docs/File-and-Folder-Structure/How-to-set-up/images/ds-rtorrent-settings-downloads.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/ds-rtorrent-settings-downloads.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/ds-rtorrent-settings-downloads.png diff --git a/docs/Hardlinks/How-to-setup-for/images/ds-rtorrent.rc.png b/docs/File-and-Folder-Structure/How-to-set-up/images/ds-rtorrent.rc.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/ds-rtorrent.rc.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/ds-rtorrent.rc.png diff --git a/docs/Hardlinks/How-to-setup-for/images/ds-sabnzbd-categories.png b/docs/File-and-Folder-Structure/How-to-set-up/images/ds-sabnzbd-categories.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/ds-sabnzbd-categories.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/ds-sabnzbd-categories.png diff --git a/docs/Hardlinks/How-to-setup-for/images/ds-sabnzbd-folders.png b/docs/File-and-Folder-Structure/How-to-set-up/images/ds-sabnzbd-folders.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/ds-sabnzbd-folders.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/ds-sabnzbd-folders.png diff --git a/docs/Hardlinks/How-to-setup-for/images/ds-sonarr-add-new.png b/docs/File-and-Folder-Structure/How-to-set-up/images/ds-sonarr-add-new.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/ds-sonarr-add-new.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/ds-sonarr-add-new.png diff --git a/docs/Hardlinks/How-to-setup-for/images/ds-sonarr-root-folder.png b/docs/File-and-Folder-Structure/How-to-set-up/images/ds-sonarr-root-folder.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/ds-sonarr-root-folder.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/ds-sonarr-root-folder.png diff --git a/docs/Hardlinks/How-to-setup-for/images/ds-sonarr-tv.png b/docs/File-and-Folder-Structure/How-to-set-up/images/ds-sonarr-tv.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/ds-sonarr-tv.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/ds-sonarr-tv.png diff --git a/docs/Hardlinks/How-to-setup-for/images/home-folders.png b/docs/File-and-Folder-Structure/How-to-set-up/images/home-folders.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/home-folders.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/home-folders.png diff --git a/docs/Hardlinks/How-to-setup-for/images/synology-control-panel.png b/docs/File-and-Folder-Structure/How-to-set-up/images/synology-control-panel.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/synology-control-panel.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/synology-control-panel.png diff --git a/docs/Hardlinks/How-to-setup-for/images/synology-create-task.png b/docs/File-and-Folder-Structure/How-to-set-up/images/synology-create-task.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/synology-create-task.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/synology-create-task.png diff --git a/docs/Hardlinks/How-to-setup-for/images/synology-id.png b/docs/File-and-Folder-Structure/How-to-set-up/images/synology-id.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/synology-id.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/synology-id.png diff --git a/docs/Hardlinks/How-to-setup-for/images/synology-ssh.png b/docs/File-and-Folder-Structure/How-to-set-up/images/synology-ssh.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/synology-ssh.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/synology-ssh.png diff --git a/docs/Hardlinks/How-to-setup-for/images/synology-task-settings.png b/docs/File-and-Folder-Structure/How-to-set-up/images/synology-task-settings.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/synology-task-settings.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/synology-task-settings.png diff --git a/docs/Hardlinks/How-to-setup-for/images/truenas-create-dataset.png b/docs/File-and-Folder-Structure/How-to-set-up/images/truenas-create-dataset.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/truenas-create-dataset.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/truenas-create-dataset.png diff --git a/docs/Hardlinks/How-to-setup-for/images/truenas-dataset-options.png b/docs/File-and-Folder-Structure/How-to-set-up/images/truenas-dataset-options.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/truenas-dataset-options.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/truenas-dataset-options.png diff --git a/docs/Hardlinks/How-to-setup-for/images/truenas-dataset-permissions.png b/docs/File-and-Folder-Structure/How-to-set-up/images/truenas-dataset-permissions.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/truenas-dataset-permissions.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/truenas-dataset-permissions.png diff --git a/docs/Hardlinks/How-to-setup-for/images/truenas-group-options.png b/docs/File-and-Folder-Structure/How-to-set-up/images/truenas-group-options.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/truenas-group-options.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/truenas-group-options.png diff --git a/docs/Hardlinks/How-to-setup-for/images/truenas-nfs-service-options.png b/docs/File-and-Folder-Structure/How-to-set-up/images/truenas-nfs-service-options.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/truenas-nfs-service-options.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/truenas-nfs-service-options.png diff --git a/docs/Hardlinks/How-to-setup-for/images/truenas-nfs-share-options.png b/docs/File-and-Folder-Structure/How-to-set-up/images/truenas-nfs-share-options.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/truenas-nfs-share-options.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/truenas-nfs-share-options.png diff --git a/docs/Hardlinks/How-to-setup-for/images/truenas-user-options.png b/docs/File-and-Folder-Structure/How-to-set-up/images/truenas-user-options.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/truenas-user-options.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/truenas-user-options.png diff --git a/docs/Hardlinks/How-to-setup-for/images/unraid-arr.png b/docs/File-and-Folder-Structure/How-to-set-up/images/unraid-arr.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/unraid-arr.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/unraid-arr.png diff --git a/docs/Hardlinks/How-to-setup-for/images/unraid-enable-hardlinks.png b/docs/File-and-Folder-Structure/How-to-set-up/images/unraid-enable-hardlinks.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/unraid-enable-hardlinks.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/unraid-enable-hardlinks.png diff --git a/docs/Hardlinks/How-to-setup-for/images/unraid-enable-hardlinks_612.png b/docs/File-and-Folder-Structure/How-to-set-up/images/unraid-enable-hardlinks_612.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/unraid-enable-hardlinks_612.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/unraid-enable-hardlinks_612.png diff --git a/docs/Hardlinks/How-to-setup-for/images/unraid-final-result.png b/docs/File-and-Folder-Structure/How-to-set-up/images/unraid-final-result.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/unraid-final-result.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/unraid-final-result.png diff --git a/docs/Hardlinks/How-to-setup-for/images/unraid-main-share.png b/docs/File-and-Folder-Structure/How-to-set-up/images/unraid-main-share.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/unraid-main-share.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/unraid-main-share.png diff --git a/docs/Hardlinks/How-to-setup-for/images/unraid-media-server.png b/docs/File-and-Folder-Structure/How-to-set-up/images/unraid-media-server.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/unraid-media-server.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/unraid-media-server.png diff --git a/docs/Hardlinks/How-to-setup-for/images/unraid-torrent-clients.png b/docs/File-and-Folder-Structure/How-to-set-up/images/unraid-torrent-clients.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/unraid-torrent-clients.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/unraid-torrent-clients.png diff --git a/docs/Hardlinks/How-to-setup-for/images/unraid-usenet-client.png b/docs/File-and-Folder-Structure/How-to-set-up/images/unraid-usenet-client.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/unraid-usenet-client.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/unraid-usenet-client.png diff --git a/docs/Hardlinks/How-to-setup-for/images/unraid_main_share_array_612.png b/docs/File-and-Folder-Structure/How-to-set-up/images/unraid_main_share_array_612.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/unraid_main_share_array_612.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/unraid_main_share_array_612.png diff --git a/docs/Hardlinks/How-to-setup-for/images/unraid_main_share_cache_612.png b/docs/File-and-Folder-Structure/How-to-set-up/images/unraid_main_share_cache_612.png similarity index 100% rename from docs/Hardlinks/How-to-setup-for/images/unraid_main_share_cache_612.png rename to docs/File-and-Folder-Structure/How-to-set-up/images/unraid_main_share_cache_612.png diff --git a/docs/File-and-Folder-Structure/How-to-set-up/index.md b/docs/File-and-Folder-Structure/How-to-set-up/index.md new file mode 100644 index 000000000..1760eb43b --- /dev/null +++ b/docs/File-and-Folder-Structure/How-to-set-up/index.md @@ -0,0 +1,17 @@ +# How To Set Up + +In this section, you will find several how-to guides for installation of the Starr Apps. +This is all done in a way to achieve [Hardlinks and Instant Moves (Atomic-Moves)](/File-and-Folder-Structure/Hardlinks-and-Instant-Moves/). + +Select your desired method of installation: + +- [Docker](/File-and-Folder-Structure/How-to-set-up/Docker/) +- [Dockstarter](/File-and-Folder-Structure/How-to-set-up/Dockstarter/) +- [Native](/File-and-Folder-Structure/How-to-set-up/Native/) +- [Synology](/File-and-Folder-Structure/How-to-set-up/Synology/) +- [TrueNAS Core](/File-and-Folder-Structure/How-to-set-up/TrueNAS-Core/) +- TrueNAS Scale users can follow the same concepts as the Docker method, until someone provides a guide and is willing to maintain and give support for it in the Guide Discord. +- [Unraid](/File-and-Folder-Structure/How-to-set-up/Unraid/) +- [Windows](/File-and-Folder-Structure/How-to-set-up/Windows/) + +--8<-- "includes/support.md" diff --git a/docs/Hardlinks/Replace-copies-with-hardlinks.md b/docs/File-and-Folder-Structure/Replace-copies-with-hardlinks.md similarity index 100% rename from docs/Hardlinks/Replace-copies-with-hardlinks.md rename to docs/File-and-Folder-Structure/Replace-copies-with-hardlinks.md diff --git a/docs/Hardlinks/images/deluge-preferences-downloads.png b/docs/File-and-Folder-Structure/images/deluge-preferences-downloads.png similarity index 100% rename from docs/Hardlinks/images/deluge-preferences-downloads.png rename to docs/File-and-Folder-Structure/images/deluge-preferences-downloads.png diff --git a/docs/Hardlinks/images/hardlinks-inode.png b/docs/File-and-Folder-Structure/images/hardlinks-inode.png similarity index 100% rename from docs/Hardlinks/images/hardlinks-inode.png rename to docs/File-and-Folder-Structure/images/hardlinks-inode.png diff --git a/docs/Hardlinks/images/hardlinks-ls-al.png b/docs/File-and-Folder-Structure/images/hardlinks-ls-al.png similarity index 100% rename from docs/Hardlinks/images/hardlinks-ls-al.png rename to docs/File-and-Folder-Structure/images/hardlinks-ls-al.png diff --git a/docs/Hardlinks/images/hardlinks-ls-i.png b/docs/File-and-Folder-Structure/images/hardlinks-ls-i.png similarity index 100% rename from docs/Hardlinks/images/hardlinks-ls-i.png rename to docs/File-and-Folder-Structure/images/hardlinks-ls-i.png diff --git a/docs/Hardlinks/images/hardlinks-stat.png b/docs/File-and-Folder-Structure/images/hardlinks-stat.png similarity index 100% rename from docs/Hardlinks/images/hardlinks-stat.png rename to docs/File-and-Folder-Structure/images/hardlinks-stat.png diff --git a/docs/Hardlinks/images/nzbget-settings-categories.png b/docs/File-and-Folder-Structure/images/nzbget-settings-categories.png similarity index 100% rename from docs/Hardlinks/images/nzbget-settings-categories.png rename to docs/File-and-Folder-Structure/images/nzbget-settings-categories.png diff --git a/docs/Hardlinks/images/nzbget-settings-paths.png b/docs/File-and-Folder-Structure/images/nzbget-settings-paths.png similarity index 100% rename from docs/Hardlinks/images/nzbget-settings-paths.png rename to docs/File-and-Folder-Structure/images/nzbget-settings-paths.png diff --git a/docs/Hardlinks/images/qbt-options-downloads.png b/docs/File-and-Folder-Structure/images/qbt-options-downloads.png similarity index 100% rename from docs/Hardlinks/images/qbt-options-downloads.png rename to docs/File-and-Folder-Structure/images/qbt-options-downloads.png diff --git a/docs/Hardlinks/images/radarr-add-new.png b/docs/File-and-Folder-Structure/images/radarr-add-new.png similarity index 100% rename from docs/Hardlinks/images/radarr-add-new.png rename to docs/File-and-Folder-Structure/images/radarr-add-new.png diff --git a/docs/Hardlinks/images/radarr-enable-hardlinks.png b/docs/File-and-Folder-Structure/images/radarr-enable-hardlinks.png similarity index 100% rename from docs/Hardlinks/images/radarr-enable-hardlinks.png rename to docs/File-and-Folder-Structure/images/radarr-enable-hardlinks.png diff --git a/docs/Hardlinks/images/radarr-movies.png b/docs/File-and-Folder-Structure/images/radarr-movies.png similarity index 100% rename from docs/Hardlinks/images/radarr-movies.png rename to docs/File-and-Folder-Structure/images/radarr-movies.png diff --git a/docs/Hardlinks/images/radarr-root-folder.png b/docs/File-and-Folder-Structure/images/radarr-root-folder.png similarity index 100% rename from docs/Hardlinks/images/radarr-root-folder.png rename to docs/File-and-Folder-Structure/images/radarr-root-folder.png diff --git a/docs/Hardlinks/images/rtorrent-settings-autotools.png b/docs/File-and-Folder-Structure/images/rtorrent-settings-autotools.png similarity index 100% rename from docs/Hardlinks/images/rtorrent-settings-autotools.png rename to docs/File-and-Folder-Structure/images/rtorrent-settings-autotools.png diff --git a/docs/Hardlinks/images/rtorrent-settings-downloads.png b/docs/File-and-Folder-Structure/images/rtorrent-settings-downloads.png similarity index 100% rename from docs/Hardlinks/images/rtorrent-settings-downloads.png rename to docs/File-and-Folder-Structure/images/rtorrent-settings-downloads.png diff --git a/docs/Hardlinks/images/rtorrent.rc.png b/docs/File-and-Folder-Structure/images/rtorrent.rc.png similarity index 100% rename from docs/Hardlinks/images/rtorrent.rc.png rename to docs/File-and-Folder-Structure/images/rtorrent.rc.png diff --git a/docs/Hardlinks/images/sonarr-add-new.png b/docs/File-and-Folder-Structure/images/sonarr-add-new.png similarity index 100% rename from docs/Hardlinks/images/sonarr-add-new.png rename to docs/File-and-Folder-Structure/images/sonarr-add-new.png diff --git a/docs/Hardlinks/images/sonarr-enable-hardlinks.png b/docs/File-and-Folder-Structure/images/sonarr-enable-hardlinks.png similarity index 100% rename from docs/Hardlinks/images/sonarr-enable-hardlinks.png rename to docs/File-and-Folder-Structure/images/sonarr-enable-hardlinks.png diff --git a/docs/Hardlinks/images/sonarr-root-folder.png b/docs/File-and-Folder-Structure/images/sonarr-root-folder.png similarity index 100% rename from docs/Hardlinks/images/sonarr-root-folder.png rename to docs/File-and-Folder-Structure/images/sonarr-root-folder.png diff --git a/docs/Hardlinks/images/sonarr-tv.png b/docs/File-and-Folder-Structure/images/sonarr-tv.png similarity index 100% rename from docs/Hardlinks/images/sonarr-tv.png rename to docs/File-and-Folder-Structure/images/sonarr-tv.png diff --git a/docs/File-and-Folder-Structure/index.md b/docs/File-and-Folder-Structure/index.md new file mode 100644 index 000000000..aa78e533a --- /dev/null +++ b/docs/File-and-Folder-Structure/index.md @@ -0,0 +1,23 @@ +# File and Folder Structure + +## Introduction + +It is important that your media server has a well organised file and folder structure. Along with generally easier file and folder management, you will benefit from: + +- Improved security, by only granting the appropriate applications and tools access to your files. +- [Hardlinks](/File-and-Folder-Structure/Hardlinks-and-instant-moves#what-are-hardlinks), so that the same file can appear in multiple places whilst only taking up the disk space of one copy. +- [Instant moves](/File-and-Folder-Structure/Hardlinks-and-instant-moves#what-are-instant-moves-atomic-moves) (also known as 'Atomic Moves') so that files can be moved to other parts of the file system instantaneously. + +The first requirement is that all your media files and folders should be part of the same file system. That is, everything must be contained on a single physical or virtual drive. Second, all of your applications should have a consistent view of where your files and folders are - i.e., your files should appear in the same place to all of your applications. + +We recommend setting up a file and folder structure on your host server that looks like this: + +{! include-markdown "../../includes/file-and-folder-structure/docker-tree-full.md" !} + +The `data` folder can be placed wherever you like. As an example, in Unraid, you would set up a share called `data`. This would then be accessible within Unraid's file system at `/mnt/user/data`. + +If you are installing applications directly on the host system (natively), then they will already have visibility of that file and folder structure, assuming permissions are set correctly. If you are installing applications non-natively, for example via Docker, then each application should be granted access to the lowest level folder that is required whilst maintaining consistent pathing to the top level folder, which here is `data`. For example, a torrent client installed via Docker would have `/mnt/user/data/torrents` mapped to `/data/torrents`. This means that the download client would see the contents of the host's `/mnt/user/data/torrents` folder in the `/data/torrents` folder inside the container. + +More detailed examples can be found in the [How To Set Up](/File-and-Folder-Structure/How-to-set-up/) section. + +--8<-- "includes/support.md" diff --git a/docs/Glossary/index.md b/docs/Glossary/index.md index 3e3fd25ed..471971e93 100644 --- a/docs/Glossary/index.md +++ b/docs/Glossary/index.md @@ -150,7 +150,7 @@ A general term that collectively refers to both [Seeders](#seeder) and [Leechers ### Perma-Seed -Seeding your torrents permanently ("forever"). Most often this is done in conjunction with [hard linked](/Hardlinks/Hardlinks-and-Instant-Moves/) files, which allows files to 'exist' in two places without taking up any additional hard disk space. +Seeding your torrents permanently ("forever"). Most often this is done in conjunction with [hard linked](/File-and-Folder-Structure/Hardlinks-and-Instant-Moves/) files, which allows files to 'exist' in two places without taking up any additional hard disk space. ### [Prowlarr](../Prowlarr/index.md) diff --git a/docs/Hardlinks/.pages b/docs/Hardlinks/.pages deleted file mode 100644 index 60d28d24c..000000000 --- a/docs/Hardlinks/.pages +++ /dev/null @@ -1,6 +0,0 @@ -nav: - - Hardlinks - Atomic Moves: Hardlinks-and-Instant-Moves.md - - How-to-setup-for - - Examples: Examples.md - - Check if hardlinks are working: Check-if-hardlinks-are-working.md - - Replace copies with hardlinks: Replace-copies-with-hardlinks.md diff --git a/docs/Hardlinks/How-to-setup-for/Native.md b/docs/Hardlinks/How-to-setup-for/Native.md deleted file mode 100644 index 9f6794e7e..000000000 --- a/docs/Hardlinks/How-to-setup-for/Native.md +++ /dev/null @@ -1,15 +0,0 @@ -# Native - -!!! note - - We're not going to explain how to install all the applications, but we will explain which folder structure we recommend. - ---- - -{! include-markdown "../../../includes/hardlinks/folder-structure.md" !} - -{! include-markdown "../../../includes/hardlinks/breakdown-folder-structure.md" !} - -{! include-markdown "../../../includes/hardlinks/permissions.md" !} - ---8<-- "includes/support.md" diff --git a/docs/Hardlinks/How-to-setup-for/index.md b/docs/Hardlinks/How-to-setup-for/index.md deleted file mode 100644 index 3c5b6d0de..000000000 --- a/docs/Hardlinks/How-to-setup-for/index.md +++ /dev/null @@ -1,15 +0,0 @@ -# How to setup for - -In this section, you will find several how-to's for installation of the Starr Apps. -This is all done in a way to achieve [Hardlinks and Instant Moves (Atomic-Moves)](/Hardlinks/Hardlinks-and-Instant-Moves/). - -Select your desired method of installation: - -- [Docker](/Hardlinks/How-to-setup-for/Docker/) -- [Dockstarter](/Hardlinks/How-to-setup-for/Dockstarter/) -- [Native](/Hardlinks/How-to-setup-for/Native/) -- [Synology](/Hardlinks/How-to-setup-for/Synology/) -- [TrueNAS Core](/Hardlinks/How-to-setup-for/TrueNAS-Core/) -- TrueNAS Scale users can follow the same concepts as the Docker method, till someone provides a guide and is willing to maintain and give support for it in the Guide Discord. -- [Unraid](/Hardlinks/How-to-setup-for/Unraid/) -- [Windows](/Hardlinks/How-to-setup-for/Windows/) diff --git a/docs/Radarr/Tips/Radarr-remote-path-mapping.md b/docs/Radarr/Tips/Radarr-remote-path-mapping.md index c0a08cc56..6181bca9b 100644 --- a/docs/Radarr/Tips/Radarr-remote-path-mapping.md +++ b/docs/Radarr/Tips/Radarr-remote-path-mapping.md @@ -16,7 +16,7 @@ Remote Path Mapping acts as a dumb find `Remote Path` and replace it with the `L - [Radarr Wiki Servarr - Docker Guide](https://wiki.servarr.com/docker-guide#consistent-and-well-planned-paths){:target="_blank" rel="noopener noreferrer"} - - [TRaSH Guides](/Hardlinks/Hardlinks-and-Instant-Moves/){:target="_blank" rel="noopener noreferrer"} + - [TRaSH Guides](/File-and-Folder-Structure/Hardlinks-and-Instant-Moves/){:target="_blank" rel="noopener noreferrer"} --- diff --git a/docs/Radarr/index.md b/docs/Radarr/index.md index 8cd5bc7f4..ee32cbcb4 100644 --- a/docs/Radarr/index.md +++ b/docs/Radarr/index.md @@ -10,7 +10,7 @@ For Installation, Quick Start Guide, and the basics of Radarr, please check the ## Available guides -After setting up your optimal volume/paths found [HERE](/Hardlinks/Hardlinks-and-Instant-Moves/), follow the steps below to improve your setup. +After setting up your optimal volume/paths found [HERE](/File-and-Folder-Structure/Hardlinks-and-Instant-Moves/), follow the steps below to improve your setup. 1. [Quality Settings (File Size)](/Radarr/Radarr-Quality-Settings-File-Size/) - Some recommendations to prevent low-quality or fake releases. These quality file size settings have been created and tested with information gathered from release comparisons from various sources and information provided by the community. 1. [Recommended naming scheme](/Radarr/Radarr-recommended-naming-scheme/) - Recommended naming scheme provided with the help of the Sonarr/Radarr (Support) Team and information provided by the community to prevent download loops. diff --git a/docs/Sonarr/Tips/Sonarr-remote-path-mapping.md b/docs/Sonarr/Tips/Sonarr-remote-path-mapping.md index af00ddcd4..29cd6cd1b 100644 --- a/docs/Sonarr/Tips/Sonarr-remote-path-mapping.md +++ b/docs/Sonarr/Tips/Sonarr-remote-path-mapping.md @@ -16,7 +16,7 @@ Remote Path Mapping acts as a dumb find `Remote Path` and replaces it with the ` - [Sonarr Wiki Servarr - Docker Guide](https://wiki.servarr.com/docker-guide#consistent-and-well-planned-paths){:target="_blank" rel="noopener noreferrer"} - - [TRaSH Guides](/Hardlinks/Hardlinks-and-Instant-Moves/){:target="_blank" rel="noopener noreferrer"} + - [TRaSH Guides](/File-and-Folder-Structure/Hardlinks-and-Instant-Moves/){:target="_blank" rel="noopener noreferrer"} --- diff --git a/docs/Sonarr/index.md b/docs/Sonarr/index.md index 69b627043..66de446a3 100644 --- a/docs/Sonarr/index.md +++ b/docs/Sonarr/index.md @@ -10,7 +10,7 @@ For Installation, Quick Start Guide, and the basics of Sonarr, please check the ## Available guides -After setting up your optimal volume/paths found [HERE](/Hardlinks/Hardlinks-and-Instant-Moves/), follow the steps below to improve your setup. +After setting up your optimal volume/paths found [HERE](/File-and-Folder-Structure/Hardlinks-and-Instant-Moves/), follow the steps below to improve your setup. 1. [Quality Settings (File Size)](/Sonarr/Sonarr-Quality-Settings-File-Size/) - Some recommendations to prevent low-quality or fake releases. These quality file size settings have been created and tested with information gathered from release comparisons from various sources and information provided by the community. 1. [Recommended naming scheme](/Sonarr/Sonarr-recommended-naming-scheme/) - Recommended naming scheme provided with the help of the Sonarr/Radarr (Support) Team and information provided by the community to prevent download loops. diff --git a/includes/downloaders/basic-setup.md b/includes/downloaders/basic-setup.md index 079ac4c10..65a00b462 100644 --- a/includes/downloaders/basic-setup.md +++ b/includes/downloaders/basic-setup.md @@ -4,9 +4,9 @@ This basic example is based on the use of docker images Keep in mind the path are setup so it works with hardlinks and instant moves. - More info [HERE](/Hardlinks/Hardlinks-and-Instant-Moves/){:target="_blank" rel="noopener noreferrer"} + More info [HERE](/File-and-Folder-Structure/Hardlinks-and-Instant-Moves/){:target="_blank" rel="noopener noreferrer"} -{! include-markdown "../hardlinks/bad-path-suggestion.md" !} +{! include-markdown "../file-and-folder-structure/bad-path-suggestion.md" !} !!! warning "" diff --git a/includes/downloaders/path.md b/includes/downloaders/path.md index 6ddad9312..cec3c0281 100644 --- a/includes/downloaders/path.md +++ b/includes/downloaders/path.md @@ -4,7 +4,7 @@ This basic example is based on the use of docker images Keep in mind the path are setup so it works with hardlinks and instant moves. - More info [HERE](/Hardlinks/Hardlinks-and-Instant-Moves/){:target="_blank" rel="noopener noreferrer"} + More info [HERE](/File-and-Folder-Structure/Hardlinks-and-Instant-Moves/){:target="_blank" rel="noopener noreferrer"} !!! info diff --git a/includes/hardlinks/bad-path-suggestion.md b/includes/file-and-folder-structure/bad-path-suggestion.md similarity index 100% rename from includes/hardlinks/bad-path-suggestion.md rename to includes/file-and-folder-structure/bad-path-suggestion.md diff --git a/includes/hardlinks/breakdown-folder-structure-docker.md b/includes/file-and-folder-structure/breakdown-folder-structure-docker.md similarity index 93% rename from includes/hardlinks/breakdown-folder-structure-docker.md rename to includes/file-and-folder-structure/breakdown-folder-structure-docker.md index aea288349..4932cc868 100644 --- a/includes/hardlinks/breakdown-folder-structure-docker.md +++ b/includes/file-and-folder-structure/breakdown-folder-structure-docker.md @@ -50,4 +50,4 @@ Plex, Emby, JellyFin and Bazarr only needs access to your media library using `/ --- -**Don't forget to look at the [Examples](/Hardlinks/Examples/) how to set up the paths inside the applications.** +**Don't forget to look at the [Examples](/File-and-Folder-Structure/Examples/) how to set up the paths inside the applications.** diff --git a/includes/hardlinks/breakdown-folder-structure-synology.md b/includes/file-and-folder-structure/breakdown-folder-structure-synology.md similarity index 92% rename from includes/hardlinks/breakdown-folder-structure-synology.md rename to includes/file-and-folder-structure/breakdown-folder-structure-synology.md index fa3238c96..ff9655671 100644 --- a/includes/hardlinks/breakdown-folder-structure-synology.md +++ b/includes/file-and-folder-structure/breakdown-folder-structure-synology.md @@ -50,4 +50,4 @@ Plex, Emby, JellyFin and Bazarr only need access to your media library using `/d --- -**Don't forget to look at the [Examples](/Hardlinks/Examples/) how to set up the paths inside the applications.** +**Don't forget to look at the [Examples](/File-and-Folder-Structure/Examples/) how to set up the paths inside the applications.** diff --git a/includes/hardlinks/breakdown-folder-structure.md b/includes/file-and-folder-structure/breakdown-folder-structure.md similarity index 91% rename from includes/hardlinks/breakdown-folder-structure.md rename to includes/file-and-folder-structure/breakdown-folder-structure.md index 402d6e748..4ab8c1f0b 100644 --- a/includes/hardlinks/breakdown-folder-structure.md +++ b/includes/file-and-folder-structure/breakdown-folder-structure.md @@ -34,4 +34,4 @@ Plex, Emby, JellyFin and Bazarr only needs access to your media library using `/ --- -**Don't forget to look at the [Examples](/Hardlinks/Examples/) how to set up the paths inside the applications.** +**Don't forget to look at the [Examples](/File-and-Folder-Structure/Examples/) how to set up the paths inside the applications.** diff --git a/includes/hardlinks/docker-compose-commands.md b/includes/file-and-folder-structure/docker-compose-commands.md similarity index 100% rename from includes/hardlinks/docker-compose-commands.md rename to includes/file-and-folder-structure/docker-compose-commands.md diff --git a/includes/hardlinks/docker-iptables-fix.sh b/includes/file-and-folder-structure/docker-iptables-fix.sh similarity index 100% rename from includes/hardlinks/docker-iptables-fix.sh rename to includes/file-and-folder-structure/docker-iptables-fix.sh diff --git a/includes/hardlinks/docker-tree-full.md b/includes/file-and-folder-structure/docker-tree-full.md similarity index 100% rename from includes/hardlinks/docker-tree-full.md rename to includes/file-and-folder-structure/docker-tree-full.md diff --git a/includes/hardlinks/docker-tree-media.md b/includes/file-and-folder-structure/docker-tree-media.md similarity index 100% rename from includes/hardlinks/docker-tree-media.md rename to includes/file-and-folder-structure/docker-tree-media.md diff --git a/includes/hardlinks/docker-tree-torrents.md b/includes/file-and-folder-structure/docker-tree-torrents.md similarity index 100% rename from includes/hardlinks/docker-tree-torrents.md rename to includes/file-and-folder-structure/docker-tree-torrents.md diff --git a/includes/hardlinks/docker-tree-usenet.md b/includes/file-and-folder-structure/docker-tree-usenet.md similarity index 100% rename from includes/hardlinks/docker-tree-usenet.md rename to includes/file-and-folder-structure/docker-tree-usenet.md diff --git a/includes/hardlinks/folder-structure.md b/includes/file-and-folder-structure/folder-structure.md similarity index 100% rename from includes/hardlinks/folder-structure.md rename to includes/file-and-folder-structure/folder-structure.md diff --git a/includes/hardlinks/permissions.md b/includes/file-and-folder-structure/permissions.md similarity index 100% rename from includes/hardlinks/permissions.md rename to includes/file-and-folder-structure/permissions.md diff --git a/mkdocs.yml b/mkdocs.yml index 8c708ced9..a92ecb2f9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -108,18 +108,32 @@ plugins: Sonarr/Sonarr-Release-Profile-RegEx-Anime.md: Sonarr/sonarr-v3-eol.md Sonarr/Sonarr-remote-path-mapping.md: Sonarr/Tips/Sonarr-remote-path-mapping.md # How to old redirects - How-to-setup-for/index.md: Hardlinks/How-to-setup-for/index.md - How-to-setup-for/Docker.md: Hardlinks/How-to-setup-for/Docker.md - How-to-setup-for/Dockstarter.md: Hardlinks/How-to-setup-for/Dockstarter.md - How-to-setup-for/Native.md: Hardlinks/How-to-setup-for/Native.md - How-to-setup-for/Synology.md: Hardlinks/How-to-setup-for/Synology.md - How-to-setup-for/Unraid.md: Hardlinks/How-to-setup-for/Unraid.md + How-to-setup-for/index.md: File-and-Folder-Structure/How-to-set-up/index.md + How-to-setup-for/Docker.md: File-and-Folder-Structure/How-to-set-up/Docker.md + How-to-setup-for/Dockstarter.md: File-and-Folder-Structure/How-to-set-up/Dockstarter.md + How-to-setup-for/Native.md: File-and-Folder-Structure/How-to-set-up/Native.md + How-to-setup-for/Synology.md: File-and-Folder-Structure/How-to-set-up/Synology.md + How-to-setup-for/Unraid.md: File-and-Folder-Structure/How-to-set-up/Unraid.md + # Hardlink to File-and-Folder-Structure redirects + Hardlinks/Check-if-hardlinks-are-working.md: File-and-Folder-Structure/Check-if-hardlinks-are-working.md + Hardlinks/Examples.md: File-and-Folder-Structure/Examples.md + Hardlinks/Hardlinks-and-Instant-Moves.md: File-and-Folder-Structure/Hardlinks-and-Instant-Moves.md + Hardlinks/index.md: File-and-Folder-Structure/index.md + Hardlinks/Replace-copies-with-hardlinks.md: File-and-Folder-Structure/Replace-copies-with-hardlinks.md + Hardlinks/How-to-setup-for/Docker.md: File-and-Folder-Structure/How-to-set-up/Docker.md + Hardlinks/How-to-setup-for/Dockstarter.md: File-and-Folder-Structure/How-to-set-up/Dockstarter.md + Hardlinks/How-to-setup-for/index.md: File-and-Folder-Structure/How-to-set-up/index.md + Hardlinks/How-to-setup-for/Native.md: File-and-Folder-Structure/How-to-set-up/Native.md + Hardlinks/How-to-setup-for/Synology.md: File-and-Folder-Structure/How-to-set-up/Synology.md + Hardlinks/How-to-setup-for/TrueNAS-Core.md: File-and-Folder-Structure/How-to-set-up/TrueNAS-Core.md + Hardlinks/How-to-setup-for/Unraid.md: File-and-Folder-Structure/How-to-set-up/Unraid.md + Hardlinks/How-to-setup-for/Windows.md: File-and-Folder-Structure/How-to-set-up/Windows.md # Random redirects Misc/trash-sync.md: Guide-Sync/index.md # Shortcuts redirects - hardlinks.md: Hardlinks/Hardlinks-and-Instant-Moves.md - hardlink.md: Hardlinks/Hardlinks-and-Instant-Moves.md - check-hardlinks.md: Hardlinks/Check-if-hardlinks-are-working.md + hardlinks.md: File-and-Folder-Structure/Hardlinks-and-Instant-Moves.md + hardlink.md: File-and-Folder-Structure/Hardlinks-and-Instant-Moves.md + check-hardlinks.md: File-and-Folder-Structure/Check-if-hardlinks-are-working.md custom-formats.md: Radarr/Radarr-collection-of-custom-formats.md cf.md: Radarr/Radarr-collection-of-custom-formats.md TorGuard.md: Misc/How-to-setup-Torguard-for-port-forwarding.md @@ -128,7 +142,7 @@ plugins: Golden-Rule.md: Misc/x265-4k.md show-unknown.md: Radarr/Tips/Radarr-show-unknown-movie-items.md merge-quality.md: Radarr/Tips/Merge-quality.md - jdupes.md: Hardlinks/Replace-copies-with-hardlinks.md + jdupes.md: File-and-Folder-Structure/Replace-copies-with-hardlinks.md # Recyclarr redirects Recyclarr/recyclarr-configs.md: https://recyclarr.dev/wiki/guide-configs/ Recyclarr/recyclarr-configs-sqp.md: https://recyclarr.dev/wiki/sqp-configs/