feat(guides): Re-work Hardlinks Section and Rename to 'File and Folder Structure'. (#2094)
* Rename Hardlinks navbar section to 'File and Folder Structure' Rename Hardlinks folder to 'File and Folder Structure' Amend redirect links from 'Hardlinks' to 'File and Folder Structure' * Global change from 'File and Folder Structure' to 'File-and-Folder-Structure' * Add new index page for File and Folder Structure section * Renamed 'How to setup for' to 'How To Set Up' across files, folders and references First draft of introduction page for File and Folder Structure * Amendments, tidying and formatting * Fix redirects for 'How To Set Up'. * Replace links in other pages to point to 'File-and-Folder-Structure' * Fix links for 'How-to-set-up' * Add links to new index page * Rename includes folder from 'hardlinks' to 'file-and-folder-structure' Correct links throughout guides to point to 'file-and-folder-structure' * Fix one broken link to 'file-and-folder-structure' includes folder * Added: Hardlink to File-and-Folder-Structure redirects * fix: for redirects * fix2: missed a few links that sonarr was using + copy/paste issue * Added: missing support banner on some pages * Tweaked language for better readability. --------- Co-authored-by: TRaSH <trash-pm@protonmail.ch>pull/2097/head^2
@ -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
|
@ -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"
|
Before Width: | Height: | Size: 110 KiB After Width: | Height: | Size: 110 KiB |
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 39 KiB |
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 25 KiB |
Before Width: | Height: | Size: 268 KiB After Width: | Height: | Size: 268 KiB |
Before Width: | Height: | Size: 5.7 KiB After Width: | Height: | Size: 5.7 KiB |
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
Before Width: | Height: | Size: 8.8 KiB After Width: | Height: | Size: 8.8 KiB |
Before Width: | Height: | Size: 8.0 KiB After Width: | Height: | Size: 8.0 KiB |
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 9.5 KiB After Width: | Height: | Size: 9.5 KiB |
Before Width: | Height: | Size: 5.4 KiB After Width: | Height: | Size: 5.4 KiB |
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 9.2 KiB After Width: | Height: | Size: 9.2 KiB |
Before Width: | Height: | Size: 3.9 KiB After Width: | Height: | Size: 3.9 KiB |
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 5.1 KiB After Width: | Height: | Size: 5.1 KiB |
Before Width: | Height: | Size: 65 KiB After Width: | Height: | Size: 65 KiB |
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 31 KiB |
Before Width: | Height: | Size: 259 KiB After Width: | Height: | Size: 259 KiB |
Before Width: | Height: | Size: 9.3 KiB After Width: | Height: | Size: 9.3 KiB |
Before Width: | Height: | Size: 1.8 KiB After Width: | Height: | Size: 1.8 KiB |
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 94 KiB |
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 28 KiB |
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 45 KiB |
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 21 KiB |
Before Width: | Height: | Size: 9.4 KiB After Width: | Height: | Size: 9.4 KiB |
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 27 KiB |
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
Before Width: | Height: | Size: 1.3 MiB After Width: | Height: | Size: 1.3 MiB |
Before Width: | Height: | Size: 104 KiB After Width: | Height: | Size: 104 KiB |
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |
Before Width: | Height: | Size: 2.8 MiB After Width: | Height: | Size: 2.8 MiB |
@ -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"
|
Before Width: | Height: | Size: 5.3 KiB After Width: | Height: | Size: 5.3 KiB |
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
Before Width: | Height: | Size: 1.9 KiB After Width: | Height: | Size: 1.9 KiB |
Before Width: | Height: | Size: 6.7 KiB After Width: | Height: | Size: 6.7 KiB |
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 25 KiB |
Before Width: | Height: | Size: 8.9 KiB After Width: | Height: | Size: 8.9 KiB |
Before Width: | Height: | Size: 7.0 KiB After Width: | Height: | Size: 7.0 KiB |
Before Width: | Height: | Size: 8.8 KiB After Width: | Height: | Size: 8.8 KiB |
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 38 KiB |
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 62 KiB |
Before Width: | Height: | Size: 5.1 KiB After Width: | Height: | Size: 5.1 KiB |
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
Before Width: | Height: | Size: 9.1 KiB After Width: | Height: | Size: 9.1 KiB |
Before Width: | Height: | Size: 3.3 KiB After Width: | Height: | Size: 3.3 KiB |
Before Width: | Height: | Size: 9.7 KiB After Width: | Height: | Size: 9.7 KiB |
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 46 KiB |
Before Width: | Height: | Size: 4.6 KiB After Width: | Height: | Size: 4.6 KiB |
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 64 KiB |
@ -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"
|
@ -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
|
@ -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"
|
@ -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/)
|