From 25dc6d6bed264516a8b9f29b707b733306d0057b Mon Sep 17 00:00:00 2001
From: TRaSH <trash-pm@protonmail.ch>
Date: Tue, 10 Nov 2020 19:05:59 +0100
Subject: [PATCH] Added: How To Set Up Hardlinks and Atomic-Moves

How To Set Up Hardlinks and Atomic-Moves for DockSTARTer
---
 ...ow-to-set-up-hardlinks-and-atomic-moves.md | 158 ++++++++++++++++++
 1 file changed, 158 insertions(+)
 create mode 100644 docs/Misc/how-to-set-up-hardlinks-and-atomic-moves.md

diff --git a/docs/Misc/how-to-set-up-hardlinks-and-atomic-moves.md b/docs/Misc/how-to-set-up-hardlinks-and-atomic-moves.md
new file mode 100644
index 000000000..0e3372f78
--- /dev/null
+++ b/docs/Misc/how-to-set-up-hardlinks-and-atomic-moves.md
@@ -0,0 +1,158 @@
+# How To Set Up Hardlinks and Atomic-Moves
+
+## Description
+
+- Instant moves (Atomic-Moves) during import of the *arr (useful when using Usenet).
+- You want to perma seed.
+- You don't want to use twice the storage when using torrents. (hardlinks).
+
+### FAQ
+
+??? faq "FAQ"
+
+    1. Q: **What are the `*arr`?**
+
+        - Sonarr, Radarr, Lidarr, etc.
+
+    1. Q: **What are hardlinks?**
+
+        - Short answer is "having a file in multiple folders" without using up your storage.
+        - [Long Answer](https://medium.com/@krisbredemeier/the-difference-between-hard-links-and-soft-or-symbolic-links-780149244f7d){:target="_blank"}.
+
+    1. Q: **What's Atomic Moves?**
+
+        - A real move and not a copy file from download folder to media folder and then delete file from download folder.
+
+------
+
+The default [linuxserver](https://hub.docker.com/u/linuxserver){:target="_blank"} default path suggestions (`/tv`, `/movies` , `/downloads`) will break hard links and atomic moves. because they are seen as different volumes inside the container, resulting in a slow copy.
+
+------
+
+### How to Setup for
+
+   - [DockSTARTer](#dockstarter)
+   - [UnRaid](#unraid) (soon)
+
+#### DockSTARTer
+
+??? summary "DockSTARTer"
+
+    !!! note
+
+        I'm using the default paths in this example, and will keep the other paths unchanged so nothing will break if you make a mistake.
+
+    We're going to use a mounted drive that we're going to use as storage for downloads and your media.
+    In this example the mounted drive will be mounted to `/mnt/` with the following folder structure.
+
+    ```
+    storage
+    ├── downloads
+    |  ├── torrents
+    │  |   ├── movies
+    │  |   ├── music
+    │  |   └── tv
+    |  └── usenet
+    │     ├── movies
+    │     ├── music
+    │     └── tv
+    └── medialibrary
+       ├── movies
+       ├── music
+       └── tv
+    ```
+    ##### Step 1
+    To accomplisch this we need to change first a few paths in your `.env` (Usually `~/.docker/compose/.env`)
+
+    ```yaml
+    # Global Settings
+    COMPOSE_HTTP_TIMEOUT=60
+    DOCKERCONFDIR=~/.config/appdata
+    DOCKERGID=999
+    DOCKERHOSTNAME=DockSTARTer
+    DOCKERLOGGING_MAXFILE=10
+    DOCKERLOGGING_MAXSIZE=200k
+    DOCKERSTORAGEDIR=/mnt/storage
+    PGID=1000
+    PUID=1000
+    TZ=America/Chicago
+
+    # DEPRECATED Settings (will be removed at the end of 2020)
+    DOCKERSHAREDDIR=~/shared
+    DOWNLOADSDIR=/mnt/downloads
+    MEDIADIR_AUDIOBOOKS=/mnt/medialibrary/audiobooks
+    MEDIADIR_BOOKS=/mnt/medialibrary/books
+    MEDIADIR_COMICS=/mnt/medialibrary/comics
+    MEDIADIR_MOVIES=/mnt/medialibrary/movies
+    MEDIADIR_MUSIC=/mnt/medialibrary/music
+    MEDIADIR_TV=/mnt/medialibrary/tv
+    ```
+
+    ##### Step 2
+
+    When that's all set then you will need to change the paths you're going to use in the containers from:
+
+    `/downloads` => `/storage/downloads`
+
+    `/audiobooks` => `/storage/medialibrary/audiobooks`
+
+    `/books` => `/storage/medialibrary/books`
+
+    `/comics`  => `/storage/medialibrary/comics`
+
+    `/movies` => `/storage/medialibrary/movies`
+
+    `/music` => `/storage/medialibrary/music`
+
+    `/tv` => `/storage/medialibrary/tv`
+
+#### UnRaid
+
+??? summary "UnRaid"
+
+    Soon
+
+------
+
+!!! info
+
+    Pick one path layout and use it for all of them.
+
+    It doesn't matter if you like to use `/data`, `/shared`, `/storage` or whatever.
+
+### Examples
+
+   - [Sonarr](#sonarr)
+   - [Radarr](#radarr)
+   - [SABnzbd](#sabnzbd)
+   - [NZBget](#nzbget)
+   - [Qbittorent](#qbittorent)
+   - [Deluge](#deluge)
+
+#### Sonarr
+
+placeholder
+
+#### Radarr
+
+placeholder
+
+#### SABnzbd
+
+placeholder
+
+#### NZBget
+
+placeholder
+
+#### Qbittorent
+
+placeholder
+
+#### Deluge
+
+placeholder
+
+------
+
+Big Thnx to [fryfrog](https://github.com/fryfrog){:target="_blank"} for his [Docker Guide](https://wiki.servarr.com/Docker_Guide){:target="_blank"} that I used as basis for this guide.