Servarr - User contributions [en]

Cloud Setup

2021-01-01T22:05:25Z

Logvin: /* Nightly Cloud Upload Example */

== Rclone, Mergerfs, and Google Drive ==

With many options for storing 'unlimited' data in the cloud, configuring your system to allow your Arr's and media serving apps to access the data securely is possible. For this guide we will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service. We will also use a utility called Mergerfs to help keep our uploads organized.

Please note that this guide is for information only and you should only store legally obtained media.

Please Note: To get unlimited storage with Google Drive, you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive''' - Download to a local disk and move the data later w/ Rclone
* '''Don't import to your Gdrive''' - Set up a merged local cache disk and move the data later w/ Rclone
* '''Do all large writes locally'''
* '''Move to cloud on a schedule''' - Easily scriptable
* '''Absolutely do not write (large files) directly to the rclone mount'''

To connect with your Gdrive, you will need to use three applications:
# Rclone - https://rclone.org/install/
# mergerfs - https://github.com/trapexit/mergerfs
# fuse - https://manpages.ubuntu.com/manpages/eoan/man8/mount.fuse.8.html

Once you have set up these applications, it is highly recommended to set up a cron job to automatically move files from your local drive to the cloud using Rclone. Animosity22 has [https://github.com/animosity22/homescripts a terrific Github page] with a sample script, or [[Cloud_Setup#Nightly_Cloud_Upload_Example|see the example below.]]

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

To install Rclone, run the following command:
<pre>curl https://rclone.org/install.sh | sudo bash </pre>

==== Setting up Rclone ====
Before we can run Rclone's config tool, we must create a Google API Client ID for your system. The default Rclone config will use the Rclone client ID, which is not recommended: Everyone should create a personal client ID.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access) https://console.developers.google.com/apis/dashboard
# Select a project or create a new project.
# Under "ENABLE APIS AND SERVICES" search for "Google Drive", and <code>enable</code> the "Google Drive API". [[File:ENABLE APIS AND SERVICES.png|thumb|ENABLE APIS AND SERVICES]]
# Click "Credentials" in the left-side panel, then "Create Credentials" in the upper right. [[File:Google Drive Credentials Screenshot.png|thumb|Create New Credentials]]
# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.
# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".
# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)
# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.
# go to "IAM & admin" -> "Service Accounts".
# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code>mount</code>Leave "Role" Empty
# Tick "Furnish a new private key" - select "Key type JSON".
# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

Now that you have the API access squared away, you can run the rclone <code>config</code> utility to create your rclone.conf file.

<code>rclone config</code>
# <code>n</code> - New Remote
# <code>cloud</code> - Name of your new remote
# <code>13</code> - Google Drive
# <code>abunchofnumbersandletters.apps.googleusercontent.com</code> Enter your Google Application Client Id
# <code>yourgoogleapplicationclientsecret</code>Enter your Google Application Client Secret
# <code>1</code> - Full Access
# Leave Blank ID of the root folder
# Enter the path and filename to your Google Drive SA Json
# <code>n</code> - Do Not Use Auto Config
# <code>y</code> - Use Team Drive
# Review for Accuracy

You can now mount your newly created remote to access your cloud storage:
rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
<code>rclone config</code>
# <code>n</code> - New Remote
# <code>cloudcrypt</code> - Name of your new encrypted remote
# <code>crypt</code> - Encrypt/Decrypt a remote
# <code>cloud:crypt</code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code>standard</code> - How to encrypt the filenames.
# <code>true</code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== Mergerfs ===
Mergerfs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergerfs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergerfs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up Mergerfs ====
Mergefs has a dependency on Fuse, so we will start by installing that:
sudo apt install fuse
Next, we must modify the <code>fuse.conf</code> file to enable the <code>allow_other</code> funtion:
sudo nano /etc/fuse.conf
Modify the last line by removing the # before <code>user_allow_other</code>. It should look like this:
# Allow non-root users to specify the allow_other or allow_root mount options.
user_allow_other
Now we can install Mergerfs. Go to the [https://github.com/trapexit/mergerfs/releases Mergerfs github page] and download the newest release that matches your install.
<pre>wget https://github.com/trapexit/mergerfs/releases/download/2.32.0/mergerfs_2.32.0.ubuntu-focal_amd64.deb</pre>
And then install it:
dpkg -i mergefs*.deb

To execute Mergerfs, run the following command. This assumes your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>. ''Note:'' There are no spaces in the variables passed to the <code>-o</code> flag, so it looks like a giant run on list and should be a single line.
/usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty

Once you verify that everything is working, it is recommended to use an autostart file configured to start after Rclone.

==== Mergerfs Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Mergerfs will run as.
# <code>Group</code> should match the service account group that Mergerfs will run as.

The unit service file should be named to match your merged folder name. If you have followed along with this wiki, that name would be <code>merge</code> so your service file would be named<code>merge.service</code>, and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Mergerfs's executable is placed in <code>/usr/local/bin/</code>, your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>.

[Unit]
Description=Mergerfs Mount (merge)
Requires=rclone.service
After=rclone.service

[Service]
Type=forking
ExecStart=/usr/local/bin/mergerfs /local:/cloud /merge \
-o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty
KillMode=process
Restart=on-failure
User=plex
Group=plex

[Install]
WantedBy=multi-user.target

===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Mergerfs has access to all data directories.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /local
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /local
$ ls -lad /merge
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /merge

===== Enabling and starting the Unit Service File =====
Once you have created <code>merge.service</code>, you will want to enable the service:
sudo systemctl enable merge.service

You are now ready to start Mergerfs. You can do so with the <code>start</code> command:
sudo systemctl start merge.service

If you want to verify Mergerfs is running, you can run the <code>status</code> command:
$ sudo systemctl status merge.service
● merge.service - Mergerfs Mount (merge)
Loaded: loaded (/etc/systemd/system/merge.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (mergerfs)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/merge.service
└─2392484 /usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest, >
Nov 15 16:28:25 systemname systemd[1]: Starting Mergerfs Mount (merge)...
Nov 15 16:28:26 systemname systemd[1]: Started Mergerfs Mount (merge).
=== Nightly Cloud Upload Example ===
Once Rclone and Mergefs are set up and configured, all data should be written on your local disk first. You will want to sync this data to your cloud drive then remove it to ensure your local disk does not run out of space. Below is an example bash shell script you may want to use, modeled on Animosity22's [https://github.com/animosity22/homescripts/blob/master/scripts/upload_cloud upload_cloud script].

First start by creating your script.
nano ~/.config/scripts/nightly_cloud_sync.sh
Example Script:
<syntaxhighlight lang=bash>
#!/bin/bash
# Variables to verify match your installation
# Rclone Config file
RCLONE_CONFIG=/home/plex/.config/rclone/rclone.conf
export RCLONE_CONFIG
# User account that Rclone is running as
RCLONE_USER_AGENT=plex
export RCLONE_USER_AGENT
# Local Mount - Ensure this is set to your local disk only.
LOCAL=/local
EXCLUDES=/home/plex/.config/scripts/excludes.log
LOGFILE=/home/plex/.config/scripts/upload.log
# Name of your Rclone Remote, likely cloud or cloudcrypt
REMOTE=cloud
# This will allow for 3 days for media analysis / intro generation. Feel free to reduce if needed.
MOVEAGE=3d

# Checks
# Running Check
if [[ $(pidof -x "$(basename "$0")" -o %PPID) ]]; then exit; fi
# Exclude File Check
if [[ ! -f $EXCLUDES ]] ; then
echo 'Warning: No excludes.log file found at $EXCLUDES'
exit 1
fi
# Local Disk Check
if /bin/findmnt $LOCAL -o FSTYPE -n | grep fuse; then
echo "Warning: $LOCAL is not a local disk!"
exit 1
fi
# Rclone Move Command
/usr/bin/rclone move $LOCAL $REMOTE: --log-file $LOGFILE -v --exclude-from $EXCLUDES --delete-empty-src-dirs --fast-list --min-age $MOVEAGE
</syntaxhighlight>

To add this file to your cron job list, edit your crontab. Ensure your are logged in as the users you want the crontab to run as.
crontab -e
Add the following lines at the bottom of the folder.
# Nightly Cloud Sync
12 3 * * * ~/.config/scripts/nightly_cloud_sync.sh

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.
=== Increase the number of file watchers ===
Helps performance when you have a lot of files and directories in cloud storage. [https://forums.plex.tv/t/linux-tips/276247/9 Source.]
Edit your <code>sysctl.conf</code> file:
sudo nano /etc/sysctl.conf
Add the following lines at the bottom:
# Increase File Watchers for Plex
fs.inotify.max_user_watches=262144

You will need to restart your system for this change to take effect.

Cloud Setup

2021-01-01T20:42:59Z

Logvin: /* Setting up Rclone */

== Rclone, Mergerfs, and Google Drive ==

With many options for storing 'unlimited' data in the cloud, configuring your system to allow your Arr's and media serving apps to access the data securely is possible. For this guide we will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service. We will also use a utility called Mergerfs to help keep our uploads organized.

Please note that this guide is for information only and you should only store legally obtained media.

Please Note: To get unlimited storage with Google Drive, you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive''' - Download to a local disk and move the data later w/ Rclone
* '''Don't import to your Gdrive''' - Set up a merged local cache disk and move the data later w/ Rclone
* '''Do all large writes locally'''
* '''Move to cloud on a schedule''' - Easily scriptable
* '''Absolutely do not write (large files) directly to the rclone mount'''

To connect with your Gdrive, you will need to use three applications:
# Rclone - https://rclone.org/install/
# mergerfs - https://github.com/trapexit/mergerfs
# fuse - https://manpages.ubuntu.com/manpages/eoan/man8/mount.fuse.8.html

Once you have set up these applications, it is highly recommended to set up a cron job to automatically move files from your local drive to the cloud using Rclone. Animosity22 has [https://github.com/animosity22/homescripts a terrific Github page] with a sample script, or [[Cloud_Setup#Nightly_Cloud_Upload_Example|see the example below.]]

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

To install Rclone, run the following command:
<pre>curl https://rclone.org/install.sh | sudo bash </pre>

==== Setting up Rclone ====
Before we can run Rclone's config tool, we must create a Google API Client ID for your system. The default Rclone config will use the Rclone client ID, which is not recommended: Everyone should create a personal client ID.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access) https://console.developers.google.com/apis/dashboard
# Select a project or create a new project.
# Under "ENABLE APIS AND SERVICES" search for "Google Drive", and <code>enable</code> the "Google Drive API". [[File:ENABLE APIS AND SERVICES.png|thumb|ENABLE APIS AND SERVICES]]
# Click "Credentials" in the left-side panel, then "Create Credentials" in the upper right. [[File:Google Drive Credentials Screenshot.png|thumb|Create New Credentials]]
# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.
# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".
# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)
# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.
# go to "IAM & admin" -> "Service Accounts".
# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code>mount</code>Leave "Role" Empty
# Tick "Furnish a new private key" - select "Key type JSON".
# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

Now that you have the API access squared away, you can run the rclone <code>config</code> utility to create your rclone.conf file.

<code>rclone config</code>
# <code>n</code> - New Remote
# <code>cloud</code> - Name of your new remote
# <code>13</code> - Google Drive
# <code>abunchofnumbersandletters.apps.googleusercontent.com</code> Enter your Google Application Client Id
# <code>yourgoogleapplicationclientsecret</code>Enter your Google Application Client Secret
# <code>1</code> - Full Access
# Leave Blank ID of the root folder
# Enter the path and filename to your Google Drive SA Json
# <code>n</code> - Do Not Use Auto Config
# <code>y</code> - Use Team Drive
# Review for Accuracy

You can now mount your newly created remote to access your cloud storage:
rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
<code>rclone config</code>
# <code>n</code> - New Remote
# <code>cloudcrypt</code> - Name of your new encrypted remote
# <code>crypt</code> - Encrypt/Decrypt a remote
# <code>cloud:crypt</code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code>standard</code> - How to encrypt the filenames.
# <code>true</code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== Mergerfs ===
Mergerfs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergerfs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergerfs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up Mergerfs ====
Mergefs has a dependency on Fuse, so we will start by installing that:
sudo apt install fuse
Next, we must modify the <code>fuse.conf</code> file to enable the <code>allow_other</code> funtion:
sudo nano /etc/fuse.conf
Modify the last line by removing the # before <code>user_allow_other</code>. It should look like this:
# Allow non-root users to specify the allow_other or allow_root mount options.
user_allow_other
Now we can install Mergerfs. Go to the [https://github.com/trapexit/mergerfs/releases Mergerfs github page] and download the newest release that matches your install.
<pre>wget https://github.com/trapexit/mergerfs/releases/download/2.32.0/mergerfs_2.32.0.ubuntu-focal_amd64.deb</pre>
And then install it:
dpkg -i mergefs*.deb

To execute Mergerfs, run the following command. This assumes your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>. ''Note:'' There are no spaces in the variables passed to the <code>-o</code> flag, so it looks like a giant run on list and should be a single line.
/usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty

Once you verify that everything is working, it is recommended to use an autostart file configured to start after Rclone.

==== Mergerfs Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Mergerfs will run as.
# <code>Group</code> should match the service account group that Mergerfs will run as.

The unit service file should be named to match your merged folder name. If you have followed along with this wiki, that name would be <code>merge</code> so your service file would be named<code>merge.service</code>, and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Mergerfs's executable is placed in <code>/usr/local/bin/</code>, your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>.

[Unit]
Description=Mergerfs Mount (merge)
Requires=rclone.service
After=rclone.service

[Service]
Type=forking
ExecStart=/usr/local/bin/mergerfs /local:/cloud /merge \
-o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty
KillMode=process
Restart=on-failure
User=plex
Group=plex

[Install]
WantedBy=multi-user.target

===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Mergerfs has access to all data directories.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /local
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /local
$ ls -lad /merge
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /merge

===== Enabling and starting the Unit Service File =====
Once you have created <code>merge.service</code>, you will want to enable the service:
sudo systemctl enable merge.service

You are now ready to start Mergerfs. You can do so with the <code>start</code> command:
sudo systemctl start merge.service

If you want to verify Mergerfs is running, you can run the <code>status</code> command:
$ sudo systemctl status merge.service
● merge.service - Mergerfs Mount (merge)
Loaded: loaded (/etc/systemd/system/merge.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (mergerfs)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/merge.service
└─2392484 /usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest, >
Nov 15 16:28:25 systemname systemd[1]: Starting Mergerfs Mount (merge)...
Nov 15 16:28:26 systemname systemd[1]: Started Mergerfs Mount (merge).
=== Nightly Cloud Upload Example ===
Once Rclone and Mergefs are set up and configured, all data should be written on your local disk first. You will want to sync this data to your cloud drive then remove it to ensure your local disk does not run out of space. Below is an example bash shell script you may want to use, modeled on Animosity22's [https://github.com/animosity22/homescripts/blob/master/scripts/upload_cloud upload_cloud script].

First start by creating your script.
nano ~/home/.config/scripts/nightly_cloud_sync.sh
Example Script:
<syntaxhighlight lang=bash>
#!/bin/bash
# Variables to verify match your installation
# Rclone Config file
RCLONE_CONFIG=/home/plex/.config/rclone/rclone.conf
export RCLONE_CONFIG
# User account that Rclone is running as
RCLONE_USER_AGENT=plex
export RCLONE_USER_AGENT
# Local Mount - Ensure this is set to your local disk only.
LOCAL=/local
EXCLUDES=/home/plex/.config/scripts/excludes.log
LOGFILE=/home/plex/.config/scripts/upload.log
# Name of your Rclone Remote, likely cloud or cloudcrypt
REMOTE=cloud
# This will allow for 3 days for media analysis / intro generation. Feel free to reduce if needed.
MOVEAGE=3d

# Checks
# Running Check
if [[ $(pidof -x "$(basename "$0")" -o %PPID) ]]; then exit; fi
# Exclude File Check
if [[ ! -f $EXCLUDES ]] ; then
echo 'Warning: No excludes.log file found at $EXCLUDES'
exit 1
fi
# Local Disk Check
if /bin/findmnt $LOCAL -o FSTYPE -n | grep fuse; then
echo "Warning: $LOCAL is not a local disk!"
exit 1
fi
# Rclone Move Command
/usr/bin/rclone move $LOCAL $REMOTE: --log-file $LOGFILE -v --exclude-from $EXCLUDES --delete-empty-src-dirs --fast-list --min-age $MOVEAGE
</syntaxhighlight>

To add this file to your cron job list, edit your crontab. Ensure your are logged in as the users you want the crontab to run as.
crontab -e
Add the following lines at the bottom of the folder.
# Nightly Cloud Sync
12 3 * * * ~/home/.config/scripts/nightly_cloud_sync.sh

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.
=== Increase the number of file watchers ===
Helps performance when you have a lot of files and directories in cloud storage. [https://forums.plex.tv/t/linux-tips/276247/9 Source.]
Edit your <code>sysctl.conf</code> file:
sudo nano /etc/sysctl.conf
Add the following lines at the bottom:
# Increase File Watchers for Plex
fs.inotify.max_user_watches=262144

You will need to restart your system for this change to take effect.

Cloud Setup

2020-12-04T19:48:27Z

Logvin: /* Application Overview */

== Rclone, Mergerfs, and Google Drive ==

With many options for storing 'unlimited' data in the cloud, configuring your system to allow your Arr's and media serving apps to access the data securely is possible. For this guide we will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service. We will also use a utility called Mergerfs to help keep our uploads organized.

Please note that this guide is for information only and you should only store legally obtained media.

Please Note: To get unlimited storage with Google Drive, you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive''' - Download to a local disk and move the data later w/ Rclone
* '''Don't import to your Gdrive''' - Set up a merged local cache disk and move the data later w/ Rclone
* '''Do all large writes locally'''
* '''Move to cloud on a schedule''' - Easily scriptable
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use three applications:
# Rclone - https://rclone.org/install/
# mergerfs - https://github.com/trapexit/mergerfs
# fuse - https://manpages.ubuntu.com/manpages/eoan/man8/mount.fuse.8.html

Once you have set up these applications, it is highly recommended to set up a cron job to automatically move files from your local drive to the cloud using Rclone. Animosity22 has [https://github.com/animosity22/homescripts a terrific Github page] with a sample script, or [[Cloud_Setup#Nightly_Cloud_Upload_Example|see the example below.]]

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

To install Rclone, run the following command:
curl https://rclone.org/install.sh | sudo bash

==== Setting up Rclone ====
Before we can run Rclone's config tool, we must create a Google API Client ID for your system. The default Rclone config will use the Rclone client ID, which is not recommended: Everyone should create a personal client ID.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access) https://console.developers.google.com/apis/dashboard
# Select a project or create a new project.
# Under "ENABLE APIS AND SERVICES" search for "Google Drive", and <code>enable</code> the "Google Drive API". [[File:ENABLE APIS AND SERVICES.png|thumb|ENABLE APIS AND SERVICES]]
# Click "Credentials" in the left-side panel, then "Create Credentials" in the upper right. [[File:Google Drive Credentials Screenshot.png|thumb|Create New Credentials]]
# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.
# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".
# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)
# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.
# go to "IAM & admin" -> "Service Accounts".
# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty
# Tick "Furnish a new private key" - select "Key type JSON".
# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

Now that you have the API access squared away, you can run the rclone <code>config</code> utility to create your rclone.conf file.

<code> rclone config</code>
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

<code> rclone config</code>
# <code> n </code> - New Remote
# <code> cloud </code> - Name of your new remote
# <code> 13 </code> - Google Drive
# <code> abunchofnumbersandletters.apps.googleusercontent.com </code> Enter your Google Application Client Id
# <code> yourgoogleapplicationclientsecret </code> Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# Enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - Use Team Drive
# Review for Accuracy

You can now mount your newly created remote to access your cloud storage:
rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== Mergerfs ===
Mergerfs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergerfs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergerfs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up Mergerfs ====
Mergefs has a dependency on Fuse, so we will start by installing that:
sudo apt install fuse
Next, we must modify the <code>fuse.conf</code> file to enable the <code>allow_other</code> funtion:
sudo nano /etc/fuse.conf
Modify the last line by removing the # before <code>user_allow_other</code>. It should look like this:
# Allow non-root users to specify the allow_other or allow_root mount options.
user_allow_other
Now we can install Mergerfs. Go to the [https://github.com/trapexit/mergerfs/releases Mergerfs github page] and download the newest release that matches your install.
wget https://github.com/trapexit/mergerfs/releases/download/2.32.0/mergerfs_2.32.0.ubuntu-focal_amd64.deb
And then install it:
dpkg -i mergefs*.deb

To execute Mergerfs, run the following command. This assumes your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>. ''Note:'' There are no spaces in the variables passed to the <code>-o</code> flag, so it looks like a giant run on list and should be a single line.
/usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty

Once you verify that everything is working, it is recommended to use an autostart file configured to start after Rclone.

==== Mergerfs Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Mergerfs will run as.
# <code>Group</code> should match the service account group that Mergerfs will run as.

The unit service file should be named to match your merged folder name. If you have followed along with this wiki, that name would be <code>merge</code> so your service file would be named<code>merge.service</code>, and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Mergerfs's executable is placed in <code>/usr/local/bin/</code>, your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>.

[Unit]
Description=Mergerfs Mount (merge)
Requires=rclone.service
After=rclone.service

[Service]
Type=forking
ExecStart=/usr/local/bin/mergerfs /local:/cloud /merge \
-o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty
KillMode=process
Restart=on-failure
User=plex
Group=plex

[Install]
WantedBy=multi-user.target

===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Mergerfs has access to all data directories.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /local
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /local
$ ls -lad /merge
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /merge

===== Enabling and starting the Unit Service File =====
Once you have created <code>merge.service</code>, you will want to enable the service:
sudo systemctl enable merge.service

You are now ready to start Mergerfs. You can do so with the <code>start</code> command:
sudo systemctl start merge.service

If you want to verify Mergerfs is running, you can run the <code>status</code> command:
$ sudo systemctl status merge.service
● merge.service - Mergerfs Mount (merge)
Loaded: loaded (/etc/systemd/system/merge.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (mergerfs)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/merge.service
└─2392484 /usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest, >
Nov 15 16:28:25 systemname systemd[1]: Starting Mergerfs Mount (merge)...
Nov 15 16:28:26 systemname systemd[1]: Started Mergerfs Mount (merge).
=== Nightly Cloud Upload Example ===
Once Rclone and Mergefs are set up and configured, all data should be written on your local disk first. You will want to sync this data to your cloud drive then remove it to ensure your local disk does not run out of space. Below is an example bash shell script you may want to use, modeled on Animosity22's [https://github.com/animosity22/homescripts/blob/master/scripts/upload_cloud upload_cloud script].

First start by creating your script.
nano ~/home/.config/scripts/nightly_cloud_sync.sh
Example Script:
#!/bin/bash
# Variables to verify match your installation
# Rclone Config file
RCLONE_CONFIG=/home/plex/.config/rclone/rclone.conf
export RCLONE_CONFIG
# User account that Rclone is running as
RCLONE_USER_AGENT=plex
export RCLONE_USER_AGENT
# Local Mount - Ensure this is set to your local disk only.
LOCAL=/local
EXCLUDES=/home/plex/.config/scripts/excludes.log
LOGFILE=/home/plex/.config/scripts/upload.log
# Name of your Rclone Remote, likely cloud or cloudcrypt
REMOTE=cloud
# This will allow for 3 days for media analysis / intro generation. Feel free to reduce if needed.
MOVEAGE=3d

# Checks
# Running Check
if [[ $(pidof -x "$(basename "$0")" -o %PPID) ]]; then exit; fi
# Exclude File Check
if [[ ! -f $EXCLUDES ]] ; then
echo 'Warning: No excludes.log file found at $EXCLUDES'
exit 1
fi
# Local Disk Check
if /bin/findmnt $LOCAL -o FSTYPE -n | grep fuse; then
echo "Warning: $LOCAL is not a local disk!"
exit 1
fi

# Rclone Move Command
/usr/bin/rclone move $LOCAL $REMOTE: --log-file $LOGFILE -v --exclude-from $EXCLUDES --delete-empty-src-dirs --fast-list --min-age $MOVEAGE

To add this file to your cron job list, edit your crontab. Ensure your are logged in as the users you want the crontab to run as.
crontab -e
Add the following lines at the bottom of the folder.
# Nightly Cloud Sync
12 3 * * * ~/home/.config/scripts/nightly_cloud_sync.sh

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.
=== Increase the number of file watchers ===
Helps performance when you have a lot of files and directories in cloud storage. [https://forums.plex.tv/t/linux-tips/276247/9 Source.]
Edit your <code>sysctl.conf</code> file:
sudo nano /etc/sysctl.conf
Add the following lines at the bottom:
# Increase File Watchers for Plex
fs.inotify.max_user_watches=262144

You will need to restart your system for this change to take effect.

Cloud Setup

2020-12-04T19:47:24Z

Logvin: /* Recommended Plex Server Changes */

== Rclone, Mergerfs, and Google Drive ==

With many options for storing 'unlimited' data in the cloud, configuring your system to allow your Arr's and media serving apps to access the data securely is possible. For this guide we will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service. We will also use a utility called Mergerfs to help keep our uploads organized.

Please note that this guide is for information only and you should only store legally obtained media.

Please Note: To get unlimited storage with Google Drive, you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive''' - Download to a local disk and move the data later w/ Rclone
* '''Don't import to your Gdrive''' - Set up a merged local cache disk and move the data later w/ Rclone
* '''Do all large writes locally'''
* '''Move to cloud on a schedule''' - Easily scriptable
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use three applications:
# Rclone - https://rclone.org/install/
# mergerfs - https://github.com/trapexit/mergerfs
# fuse - https://manpages.ubuntu.com/manpages/eoan/man8/mount.fuse.8.html

Once you have set up these applications, it is highly recommended to set up a cron job to automatically move files from your local drive to the cloud using Rclone. Animosity22 has [https://github.com/animosity22/homescripts a terrific Github page] with a sample script, or see the example below.

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

To install Rclone, run the following command:
curl https://rclone.org/install.sh | sudo bash

==== Setting up Rclone ====
Before we can run Rclone's config tool, we must create a Google API Client ID for your system. The default Rclone config will use the Rclone client ID, which is not recommended: Everyone should create a personal client ID.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access) https://console.developers.google.com/apis/dashboard
# Select a project or create a new project.
# Under "ENABLE APIS AND SERVICES" search for "Google Drive", and <code>enable</code> the "Google Drive API". [[File:ENABLE APIS AND SERVICES.png|thumb|ENABLE APIS AND SERVICES]]
# Click "Credentials" in the left-side panel, then "Create Credentials" in the upper right. [[File:Google Drive Credentials Screenshot.png|thumb|Create New Credentials]]
# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.
# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".
# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)
# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.
# go to "IAM & admin" -> "Service Accounts".
# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty
# Tick "Furnish a new private key" - select "Key type JSON".
# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

Now that you have the API access squared away, you can run the rclone <code>config</code> utility to create your rclone.conf file.

<code> rclone config</code>
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

<code> rclone config</code>
# <code> n </code> - New Remote
# <code> cloud </code> - Name of your new remote
# <code> 13 </code> - Google Drive
# <code> abunchofnumbersandletters.apps.googleusercontent.com </code> Enter your Google Application Client Id
# <code> yourgoogleapplicationclientsecret </code> Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# Enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - Use Team Drive
# Review for Accuracy

You can now mount your newly created remote to access your cloud storage:
rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== Mergerfs ===
Mergerfs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergerfs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergerfs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up Mergerfs ====
Mergefs has a dependency on Fuse, so we will start by installing that:
sudo apt install fuse
Next, we must modify the <code>fuse.conf</code> file to enable the <code>allow_other</code> funtion:
sudo nano /etc/fuse.conf
Modify the last line by removing the # before <code>user_allow_other</code>. It should look like this:
# Allow non-root users to specify the allow_other or allow_root mount options.
user_allow_other
Now we can install Mergerfs. Go to the [https://github.com/trapexit/mergerfs/releases Mergerfs github page] and download the newest release that matches your install.
wget https://github.com/trapexit/mergerfs/releases/download/2.32.0/mergerfs_2.32.0.ubuntu-focal_amd64.deb
And then install it:
dpkg -i mergefs*.deb

To execute Mergerfs, run the following command. This assumes your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>. ''Note:'' There are no spaces in the variables passed to the <code>-o</code> flag, so it looks like a giant run on list and should be a single line.
/usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty

Once you verify that everything is working, it is recommended to use an autostart file configured to start after Rclone.

==== Mergerfs Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Mergerfs will run as.
# <code>Group</code> should match the service account group that Mergerfs will run as.

The unit service file should be named to match your merged folder name. If you have followed along with this wiki, that name would be <code>merge</code> so your service file would be named<code>merge.service</code>, and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Mergerfs's executable is placed in <code>/usr/local/bin/</code>, your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>.

[Unit]
Description=Mergerfs Mount (merge)
Requires=rclone.service
After=rclone.service

[Service]
Type=forking
ExecStart=/usr/local/bin/mergerfs /local:/cloud /merge \
-o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty
KillMode=process
Restart=on-failure
User=plex
Group=plex

[Install]
WantedBy=multi-user.target

===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Mergerfs has access to all data directories.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /local
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /local
$ ls -lad /merge
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /merge

===== Enabling and starting the Unit Service File =====
Once you have created <code>merge.service</code>, you will want to enable the service:
sudo systemctl enable merge.service

You are now ready to start Mergerfs. You can do so with the <code>start</code> command:
sudo systemctl start merge.service

If you want to verify Mergerfs is running, you can run the <code>status</code> command:
$ sudo systemctl status merge.service
● merge.service - Mergerfs Mount (merge)
Loaded: loaded (/etc/systemd/system/merge.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (mergerfs)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/merge.service
└─2392484 /usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest, >
Nov 15 16:28:25 systemname systemd[1]: Starting Mergerfs Mount (merge)...
Nov 15 16:28:26 systemname systemd[1]: Started Mergerfs Mount (merge).
=== Nightly Cloud Upload Example ===
Once Rclone and Mergefs are set up and configured, all data should be written on your local disk first. You will want to sync this data to your cloud drive then remove it to ensure your local disk does not run out of space. Below is an example bash shell script you may want to use, modeled on Animosity22's [https://github.com/animosity22/homescripts/blob/master/scripts/upload_cloud upload_cloud script].

First start by creating your script.
nano ~/home/.config/scripts/nightly_cloud_sync.sh
Example Script:
#!/bin/bash
# Variables to verify match your installation
# Rclone Config file
RCLONE_CONFIG=/home/plex/.config/rclone/rclone.conf
export RCLONE_CONFIG
# User account that Rclone is running as
RCLONE_USER_AGENT=plex
export RCLONE_USER_AGENT
# Local Mount - Ensure this is set to your local disk only.
LOCAL=/local
EXCLUDES=/home/plex/.config/scripts/excludes.log
LOGFILE=/home/plex/.config/scripts/upload.log
# Name of your Rclone Remote, likely cloud or cloudcrypt
REMOTE=cloud
# This will allow for 3 days for media analysis / intro generation. Feel free to reduce if needed.
MOVEAGE=3d

# Checks
# Running Check
if [[ $(pidof -x "$(basename "$0")" -o %PPID) ]]; then exit; fi
# Exclude File Check
if [[ ! -f $EXCLUDES ]] ; then
echo 'Warning: No excludes.log file found at $EXCLUDES'
exit 1
fi
# Local Disk Check
if /bin/findmnt $LOCAL -o FSTYPE -n | grep fuse; then
echo "Warning: $LOCAL is not a local disk!"
exit 1
fi

# Rclone Move Command
/usr/bin/rclone move $LOCAL $REMOTE: --log-file $LOGFILE -v --exclude-from $EXCLUDES --delete-empty-src-dirs --fast-list --min-age $MOVEAGE

To add this file to your cron job list, edit your crontab. Ensure your are logged in as the users you want the crontab to run as.
crontab -e
Add the following lines at the bottom of the folder.
# Nightly Cloud Sync
12 3 * * * ~/home/.config/scripts/nightly_cloud_sync.sh

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.
=== Increase the number of file watchers ===
Helps performance when you have a lot of files and directories in cloud storage. [https://forums.plex.tv/t/linux-tips/276247/9 Source.]
Edit your <code>sysctl.conf</code> file:
sudo nano /etc/sysctl.conf
Add the following lines at the bottom:
# Increase File Watchers for Plex
fs.inotify.max_user_watches=262144

You will need to restart your system for this change to take effect.

Cloud Setup

2020-12-04T19:39:56Z

Logvin: /* Nightly Cloud Upload Example */

== Rclone, Mergerfs, and Google Drive ==

With many options for storing 'unlimited' data in the cloud, configuring your system to allow your Arr's and media serving apps to access the data securely is possible. For this guide we will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service. We will also use a utility called Mergerfs to help keep our uploads organized.

Please note that this guide is for information only and you should only store legally obtained media.

Please Note: To get unlimited storage with Google Drive, you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive''' - Download to a local disk and move the data later w/ Rclone
* '''Don't import to your Gdrive''' - Set up a merged local cache disk and move the data later w/ Rclone
* '''Do all large writes locally'''
* '''Move to cloud on a schedule''' - Easily scriptable
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use three applications:
# Rclone - https://rclone.org/install/
# mergerfs - https://github.com/trapexit/mergerfs
# fuse - https://manpages.ubuntu.com/manpages/eoan/man8/mount.fuse.8.html

Once you have set up these applications, it is highly recommended to set up a cron job to automatically move files from your local drive to the cloud using Rclone. Animosity22 has [https://github.com/animosity22/homescripts a terrific Github page] with a sample script, or see the example below.

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

To install Rclone, run the following command:
curl https://rclone.org/install.sh | sudo bash

==== Setting up Rclone ====
Before we can run Rclone's config tool, we must create a Google API Client ID for your system. The default Rclone config will use the Rclone client ID, which is not recommended: Everyone should create a personal client ID.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access) https://console.developers.google.com/apis/dashboard
# Select a project or create a new project.
# Under "ENABLE APIS AND SERVICES" search for "Google Drive", and <code>enable</code> the "Google Drive API". [[File:ENABLE APIS AND SERVICES.png|thumb|ENABLE APIS AND SERVICES]]
# Click "Credentials" in the left-side panel, then "Create Credentials" in the upper right. [[File:Google Drive Credentials Screenshot.png|thumb|Create New Credentials]]
# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.
# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".
# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)
# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.
# go to "IAM & admin" -> "Service Accounts".
# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty
# Tick "Furnish a new private key" - select "Key type JSON".
# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

Now that you have the API access squared away, you can run the rclone <code>config</code> utility to create your rclone.conf file.

<code> rclone config</code>
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

<code> rclone config</code>
# <code> n </code> - New Remote
# <code> cloud </code> - Name of your new remote
# <code> 13 </code> - Google Drive
# <code> abunchofnumbersandletters.apps.googleusercontent.com </code> Enter your Google Application Client Id
# <code> yourgoogleapplicationclientsecret </code> Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# Enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - Use Team Drive
# Review for Accuracy

You can now mount your newly created remote to access your cloud storage:
rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== Mergerfs ===
Mergerfs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergerfs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergerfs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up Mergerfs ====
Mergefs has a dependency on Fuse, so we will start by installing that:
sudo apt install fuse
Next, we must modify the <code>fuse.conf</code> file to enable the <code>allow_other</code> funtion:
sudo nano /etc/fuse.conf
Modify the last line by removing the # before <code>user_allow_other</code>. It should look like this:
# Allow non-root users to specify the allow_other or allow_root mount options.
user_allow_other
Now we can install Mergerfs. Go to the [https://github.com/trapexit/mergerfs/releases Mergerfs github page] and download the newest release that matches your install.
wget https://github.com/trapexit/mergerfs/releases/download/2.32.0/mergerfs_2.32.0.ubuntu-focal_amd64.deb
And then install it:
dpkg -i mergefs*.deb

To execute Mergerfs, run the following command. This assumes your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>. ''Note:'' There are no spaces in the variables passed to the <code>-o</code> flag, so it looks like a giant run on list and should be a single line.
/usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty

Once you verify that everything is working, it is recommended to use an autostart file configured to start after Rclone.

==== Mergerfs Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Mergerfs will run as.
# <code>Group</code> should match the service account group that Mergerfs will run as.

The unit service file should be named to match your merged folder name. If you have followed along with this wiki, that name would be <code>merge</code> so your service file would be named<code>merge.service</code>, and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Mergerfs's executable is placed in <code>/usr/local/bin/</code>, your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>.

[Unit]
Description=Mergerfs Mount (merge)
Requires=rclone.service
After=rclone.service

[Service]
Type=forking
ExecStart=/usr/local/bin/mergerfs /local:/cloud /merge \
-o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty
KillMode=process
Restart=on-failure
User=plex
Group=plex

[Install]
WantedBy=multi-user.target

===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Mergerfs has access to all data directories.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /local
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /local
$ ls -lad /merge
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /merge

===== Enabling and starting the Unit Service File =====
Once you have created <code>merge.service</code>, you will want to enable the service:
sudo systemctl enable merge.service

You are now ready to start Mergerfs. You can do so with the <code>start</code> command:
sudo systemctl start merge.service

If you want to verify Mergerfs is running, you can run the <code>status</code> command:
$ sudo systemctl status merge.service
● merge.service - Mergerfs Mount (merge)
Loaded: loaded (/etc/systemd/system/merge.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (mergerfs)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/merge.service
└─2392484 /usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest, >
Nov 15 16:28:25 systemname systemd[1]: Starting Mergerfs Mount (merge)...
Nov 15 16:28:26 systemname systemd[1]: Started Mergerfs Mount (merge).
=== Nightly Cloud Upload Example ===
Once Rclone and Mergefs are set up and configured, all data should be written on your local disk first. You will want to sync this data to your cloud drive then remove it to ensure your local disk does not run out of space. Below is an example bash shell script you may want to use, modeled on Animosity22's [https://github.com/animosity22/homescripts/blob/master/scripts/upload_cloud upload_cloud script].

First start by creating your script.
nano ~/home/.config/scripts/nightly_cloud_sync.sh
Example Script:
#!/bin/bash
# Variables to verify match your installation
# Rclone Config file
RCLONE_CONFIG=/home/plex/.config/rclone/rclone.conf
export RCLONE_CONFIG
# User account that Rclone is running as
RCLONE_USER_AGENT=plex
export RCLONE_USER_AGENT
# Local Mount - Ensure this is set to your local disk only.
LOCAL=/local
EXCLUDES=/home/plex/.config/scripts/excludes.log
LOGFILE=/home/plex/.config/scripts/upload.log
# Name of your Rclone Remote, likely cloud or cloudcrypt
REMOTE=cloud
# This will allow for 3 days for media analysis / intro generation. Feel free to reduce if needed.
MOVEAGE=3d

# Checks
# Running Check
if [[ $(pidof -x "$(basename "$0")" -o %PPID) ]]; then exit; fi
# Exclude File Check
if [[ ! -f $EXCLUDES ]] ; then
echo 'Warning: No excludes.log file found at $EXCLUDES'
exit 1
fi
# Local Disk Check
if /bin/findmnt $LOCAL -o FSTYPE -n | grep fuse; then
echo "Warning: $LOCAL is not a local disk!"
exit 1
fi

# Rclone Move Command
/usr/bin/rclone move $LOCAL $REMOTE: --log-file $LOGFILE -v --exclude-from $EXCLUDES --delete-empty-src-dirs --fast-list --min-age $MOVEAGE

To add this file to your cron job list, edit your crontab. Ensure your are logged in as the users you want the crontab to run as.
crontab -e
Add the following lines at the bottom of the folder.
# Nightly Cloud Sync
12 3 * * * ~/home/.config/scripts/nightly_cloud_sync.sh

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T19:38:48Z

Logvin: /* Setting up Rclone */

== Rclone, Mergerfs, and Google Drive ==

With many options for storing 'unlimited' data in the cloud, configuring your system to allow your Arr's and media serving apps to access the data securely is possible. For this guide we will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service. We will also use a utility called Mergerfs to help keep our uploads organized.

Please note that this guide is for information only and you should only store legally obtained media.

Please Note: To get unlimited storage with Google Drive, you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive''' - Download to a local disk and move the data later w/ Rclone
* '''Don't import to your Gdrive''' - Set up a merged local cache disk and move the data later w/ Rclone
* '''Do all large writes locally'''
* '''Move to cloud on a schedule''' - Easily scriptable
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use three applications:
# Rclone - https://rclone.org/install/
# mergerfs - https://github.com/trapexit/mergerfs
# fuse - https://manpages.ubuntu.com/manpages/eoan/man8/mount.fuse.8.html

Once you have set up these applications, it is highly recommended to set up a cron job to automatically move files from your local drive to the cloud using Rclone. Animosity22 has [https://github.com/animosity22/homescripts a terrific Github page] with a sample script, or see the example below.

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

To install Rclone, run the following command:
curl https://rclone.org/install.sh | sudo bash

==== Setting up Rclone ====
Before we can run Rclone's config tool, we must create a Google API Client ID for your system. The default Rclone config will use the Rclone client ID, which is not recommended: Everyone should create a personal client ID.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access) https://console.developers.google.com/apis/dashboard
# Select a project or create a new project.
# Under "ENABLE APIS AND SERVICES" search for "Google Drive", and <code>enable</code> the "Google Drive API". [[File:ENABLE APIS AND SERVICES.png|thumb|ENABLE APIS AND SERVICES]]
# Click "Credentials" in the left-side panel, then "Create Credentials" in the upper right. [[File:Google Drive Credentials Screenshot.png|thumb|Create New Credentials]]
# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.
# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".
# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)
# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.
# go to "IAM & admin" -> "Service Accounts".
# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty
# Tick "Furnish a new private key" - select "Key type JSON".
# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

Now that you have the API access squared away, you can run the rclone <code>config</code> utility to create your rclone.conf file.

<code> rclone config</code>
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

<code> rclone config</code>
# <code> n </code> - New Remote
# <code> cloud </code> - Name of your new remote
# <code> 13 </code> - Google Drive
# <code> abunchofnumbersandletters.apps.googleusercontent.com </code> Enter your Google Application Client Id
# <code> yourgoogleapplicationclientsecret </code> Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# Enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - Use Team Drive
# Review for Accuracy

You can now mount your newly created remote to access your cloud storage:
rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== Mergerfs ===
Mergerfs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergerfs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergerfs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up Mergerfs ====
Mergefs has a dependency on Fuse, so we will start by installing that:
sudo apt install fuse
Next, we must modify the <code>fuse.conf</code> file to enable the <code>allow_other</code> funtion:
sudo nano /etc/fuse.conf
Modify the last line by removing the # before <code>user_allow_other</code>. It should look like this:
# Allow non-root users to specify the allow_other or allow_root mount options.
user_allow_other
Now we can install Mergerfs. Go to the [https://github.com/trapexit/mergerfs/releases Mergerfs github page] and download the newest release that matches your install.
wget https://github.com/trapexit/mergerfs/releases/download/2.32.0/mergerfs_2.32.0.ubuntu-focal_amd64.deb
And then install it:
dpkg -i mergefs*.deb

To execute Mergerfs, run the following command. This assumes your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>. ''Note:'' There are no spaces in the variables passed to the <code>-o</code> flag, so it looks like a giant run on list and should be a single line.
/usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty

Once you verify that everything is working, it is recommended to use an autostart file configured to start after Rclone.

==== Mergerfs Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Mergerfs will run as.
# <code>Group</code> should match the service account group that Mergerfs will run as.

The unit service file should be named to match your merged folder name. If you have followed along with this wiki, that name would be <code>merge</code> so your service file would be named<code>merge.service</code>, and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Mergerfs's executable is placed in <code>/usr/local/bin/</code>, your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>.

[Unit]
Description=Mergerfs Mount (merge)
Requires=rclone.service
After=rclone.service

[Service]
Type=forking
ExecStart=/usr/local/bin/mergerfs /local:/cloud /merge \
-o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty
KillMode=process
Restart=on-failure
User=plex
Group=plex

[Install]
WantedBy=multi-user.target

===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Mergerfs has access to all data directories.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /local
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /local
$ ls -lad /merge
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /merge

===== Enabling and starting the Unit Service File =====
Once you have created <code>merge.service</code>, you will want to enable the service:
sudo systemctl enable merge.service

You are now ready to start Mergerfs. You can do so with the <code>start</code> command:
sudo systemctl start merge.service

If you want to verify Mergerfs is running, you can run the <code>status</code> command:
$ sudo systemctl status merge.service
● merge.service - Mergerfs Mount (merge)
Loaded: loaded (/etc/systemd/system/merge.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (mergerfs)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/merge.service
└─2392484 /usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest, >
Nov 15 16:28:25 systemname systemd[1]: Starting Mergerfs Mount (merge)...
Nov 15 16:28:26 systemname systemd[1]: Started Mergerfs Mount (merge).
=== Nightly Cloud Upload Example ===
Once Rclone and Mergefs are set up and configured, all data should be written on your local disk first. You will want to sync this data to your cloud drive then remove it to ensure your local disk does not run out of space. Below is an example bash shell script you may want to use, modeled on Animosity22's [https://github.com/animosity22/homescripts/blob/master/scripts/upload_cloud upload_cloud script].

First start by creating your script.
nano ~/home/.config/scripts/nightly_cloud_sync.sh
Example Script:
#!/bin/bash
# Variables to verify match your installation
# Rclone Config file
RCLONE_CONFIG=/home/plex/.config/rclone/rclone.conf
export RCLONE_CONFIG
# User account that Rclone is running as
RCLONE_USER_AGENT=plex
export RCLONE_USER_AGENT
# Local Mount - Ensure this is set to your local disk only.
LOCAL=/local
EXCLUDES=/home/plex/.config/scripts/excludes.log
LOGFILE=/home/plex/.config/scripts/upload.log
# Name of your Rclone Remote, likely cloud or cloudcrypt
REMOTE=cloud
# This will allow for 3 days for media analysis / intro generation. Feel free to reduce if needed.
MOVEAGE=3d

# Checks
# Running Check
if [[ $(pidof -x "$(basename "$0")" -o %PPID) ]]; then exit; fi
# Exclude File Check
if [[ ! -f $EXCLUDES ]] ; then
echo 'Warning: No excludes.log file found at $EXCLUDES'
exit 1
fi
# Local Disk Check
if /bin/findmnt $LOCAL -o FSTYPE -n | grep fuse; then
echo "Warning: $LOCAL is not a local disk!"
exit 1
fi

# Rclone Move Command
/usr/bin/rclone move $LOCAL $REMOTE: --log-file $LOGFILE -v --exclude-from $EXCLUDES --delete-empty-src-dirs --fast-list --min-age $MOVEAGE

To add this file to your cron job list, edit your crontab. Ensure your are logged in as the users you want the crontab to run as.
crontab -e
Add the following lines at the bottom of the folder.
# Nightly Cloud Sync
12 3 * * * ~/home/.config/scripts/nightly_cloud_sync.sh

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T19:37:59Z

Logvin: /* Rclone */

== Rclone, Mergerfs, and Google Drive ==

With many options for storing 'unlimited' data in the cloud, configuring your system to allow your Arr's and media serving apps to access the data securely is possible. For this guide we will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service. We will also use a utility called Mergerfs to help keep our uploads organized.

Please note that this guide is for information only and you should only store legally obtained media.

Please Note: To get unlimited storage with Google Drive, you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive''' - Download to a local disk and move the data later w/ Rclone
* '''Don't import to your Gdrive''' - Set up a merged local cache disk and move the data later w/ Rclone
* '''Do all large writes locally'''
* '''Move to cloud on a schedule''' - Easily scriptable
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use three applications:
# Rclone - https://rclone.org/install/
# mergerfs - https://github.com/trapexit/mergerfs
# fuse - https://manpages.ubuntu.com/manpages/eoan/man8/mount.fuse.8.html

Once you have set up these applications, it is highly recommended to set up a cron job to automatically move files from your local drive to the cloud using Rclone. Animosity22 has [https://github.com/animosity22/homescripts a terrific Github page] with a sample script, or see the example below.

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

To install Rclone, run the following command:
curl https://rclone.org/install.sh | sudo bash

==== Setting up Rclone ====
Before we can run Rclone's config tool, we must create a Google API Client ID for your system. The default Rclone config will use the Rclone client ID, which is not recommended: Everyone should create a personal client ID.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access) https://console.developers.google.com/apis/dashboard
# Select a project or create a new project.
# Under "ENABLE APIS AND SERVICES" search for "Google Drive", and <code>enable</code> the "Google Drive API". [[File:ENABLE APIS AND SERVICES.png|thumb|ENABLE APIS AND SERVICES]]
# Click "Credentials" in the left-side panel, then "Create Credentials" in the upper right.
[[File:Google Drive Credentials Screenshot.png|thumb|Create New Credentials]]
# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.
# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".
# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)
# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.
# go to "IAM & admin" -> "Service Accounts".
# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty
# Tick "Furnish a new private key" - select "Key type JSON".
# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

Now that you have the API access squared away, you can run the rclone <code>config</code> utility to create your rclone.conf file.

<code> rclone config</code>
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

<code> rclone config</code>
# <code> n </code> - New Remote
# <code> cloud </code> - Name of your new remote
# <code> 13 </code> - Google Drive
# <code> abunchofnumbersandletters.apps.googleusercontent.com </code> Enter your Google Application Client Id
# <code> yourgoogleapplicationclientsecret </code> Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# Enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - Use Team Drive
# Review for Accuracy

You can now mount your newly created remote to access your cloud storage:
rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== Mergerfs ===
Mergerfs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergerfs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergerfs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up Mergerfs ====
Mergefs has a dependency on Fuse, so we will start by installing that:
sudo apt install fuse
Next, we must modify the <code>fuse.conf</code> file to enable the <code>allow_other</code> funtion:
sudo nano /etc/fuse.conf
Modify the last line by removing the # before <code>user_allow_other</code>. It should look like this:
# Allow non-root users to specify the allow_other or allow_root mount options.
user_allow_other
Now we can install Mergerfs. Go to the [https://github.com/trapexit/mergerfs/releases Mergerfs github page] and download the newest release that matches your install.
wget https://github.com/trapexit/mergerfs/releases/download/2.32.0/mergerfs_2.32.0.ubuntu-focal_amd64.deb
And then install it:
dpkg -i mergefs*.deb

To execute Mergerfs, run the following command. This assumes your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>. ''Note:'' There are no spaces in the variables passed to the <code>-o</code> flag, so it looks like a giant run on list and should be a single line.
/usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty

Once you verify that everything is working, it is recommended to use an autostart file configured to start after Rclone.

==== Mergerfs Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Mergerfs will run as.
# <code>Group</code> should match the service account group that Mergerfs will run as.

The unit service file should be named to match your merged folder name. If you have followed along with this wiki, that name would be <code>merge</code> so your service file would be named<code>merge.service</code>, and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Mergerfs's executable is placed in <code>/usr/local/bin/</code>, your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>.

[Unit]
Description=Mergerfs Mount (merge)
Requires=rclone.service
After=rclone.service

[Service]
Type=forking
ExecStart=/usr/local/bin/mergerfs /local:/cloud /merge \
-o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty
KillMode=process
Restart=on-failure
User=plex
Group=plex

[Install]
WantedBy=multi-user.target

===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Mergerfs has access to all data directories.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /local
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /local
$ ls -lad /merge
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /merge

===== Enabling and starting the Unit Service File =====
Once you have created <code>merge.service</code>, you will want to enable the service:
sudo systemctl enable merge.service

You are now ready to start Mergerfs. You can do so with the <code>start</code> command:
sudo systemctl start merge.service

If you want to verify Mergerfs is running, you can run the <code>status</code> command:
$ sudo systemctl status merge.service
● merge.service - Mergerfs Mount (merge)
Loaded: loaded (/etc/systemd/system/merge.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (mergerfs)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/merge.service
└─2392484 /usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest, >
Nov 15 16:28:25 systemname systemd[1]: Starting Mergerfs Mount (merge)...
Nov 15 16:28:26 systemname systemd[1]: Started Mergerfs Mount (merge).
=== Nightly Cloud Upload Example ===
Once Rclone and Mergefs are set up and configured, all data should be written on your local disk first. You will want to sync this data to your cloud drive then remove it to ensure your local disk does not run out of space. Below is an example bash shell script you may want to use, modeled on Animosity22's [https://github.com/animosity22/homescripts/blob/master/scripts/upload_cloud upload_cloud script].

First start by creating your script.
nano ~/home/.config/scripts/nightly_cloud_sync.sh
Example Script:
#!/bin/bash
# Variables to verify match your installation
# Rclone Config file
RCLONE_CONFIG=/home/plex/.config/rclone/rclone.conf
export RCLONE_CONFIG
# User account that Rclone is running as
RCLONE_USER_AGENT=plex
export RCLONE_USER_AGENT
# Local Mount - Ensure this is set to your local disk only.
LOCAL=/local
EXCLUDES=/home/plex/.config/scripts/excludes.log
LOGFILE=/home/plex/.config/scripts/upload.log
# Name of your Rclone Remote, likely cloud or cloudcrypt
REMOTE=cloud
# This will allow for 3 days for media analysis / intro generation. Feel free to reduce if needed.
MOVEAGE=3d

# Checks
# Running Check
if [[ $(pidof -x "$(basename "$0")" -o %PPID) ]]; then exit; fi
# Exclude File Check
if [[ ! -f $EXCLUDES ]] ; then
echo 'Warning: No excludes.log file found at $EXCLUDES'
exit 1
fi
# Local Disk Check
if /bin/findmnt $LOCAL -o FSTYPE -n | grep fuse; then
echo "Warning: $LOCAL is not a local disk!"
exit 1
fi

# Rclone Move Command
/usr/bin/rclone move $LOCAL $REMOTE: --log-file $LOGFILE -v --exclude-from $EXCLUDES --delete-empty-src-dirs --fast-list --min-age $MOVEAGE

To add this file to your cron job list, edit your crontab. Ensure your are logged in as the users you want the crontab to run as.
crontab -e
Add the following lines at the bottom of the folder.
# Nightly Cloud Sync
12 3 * * * ~/home/.config/scripts/nightly_cloud_sync.sh

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T19:28:53Z

Logvin: /* Setting up Rclone */

== Rclone, Mergerfs, and Google Drive ==

With many options for storing 'unlimited' data in the cloud, configuring your system to allow your Arr's and media serving apps to access the data securely is possible. For this guide we will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service. We will also use a utility called Mergerfs to help keep our uploads organized.

Please note that this guide is for information only and you should only store legally obtained media.

Please Note: To get unlimited storage with Google Drive, you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive''' - Download to a local disk and move the data later w/ Rclone
* '''Don't import to your Gdrive''' - Set up a merged local cache disk and move the data later w/ Rclone
* '''Do all large writes locally'''
* '''Move to cloud on a schedule''' - Easily scriptable
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use three applications:
# Rclone - https://rclone.org/install/
# mergerfs - https://github.com/trapexit/mergerfs
# fuse - https://manpages.ubuntu.com/manpages/eoan/man8/mount.fuse.8.html

Once you have set up these applications, it is highly recommended to set up a cron job to automatically move files from your local drive to the cloud using Rclone. Animosity22 has [https://github.com/animosity22/homescripts a terrific Github page] with a sample script, or see the example below.

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

To install Rclone, run the following command:
curl https://rclone.org/install.sh | sudo bash

==== Setting up Rclone ====
Before we can run Rclone's config tool, we must create a Google API Client ID for your system. The default Rclone config will use the Rclone client ID, which is not recommended: Everyone should create a personal client ID.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access) https://console.developers.google.com/apis/dashboard
# Select a project or create a new project.
# Under "ENABLE APIS AND SERVICES" search for "Google Drive", and <code>enable</code> the "Google Drive API". [[File:ENABLE APIS AND SERVICES.png|thumb|ENABLE APIS AND SERVICES]]
# Click "Credentials" in the left-side panel, then "Create Credentials" in the upper right.
[[File:Google Drive Credentials Screenshot.png|thumb|Create New Credentials]]
# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.
# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".
# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)
# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.
# go to "IAM & admin" -> "Service Accounts".
# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty
# Tick "Furnish a new private key" - select "Key type JSON".
# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

Now that you have the API access squared away, you can run the rclone <code>config</code> utility to create your rclone.conf file.
<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== Mergerfs ===
Mergerfs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergerfs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergerfs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up Mergerfs ====
Mergefs has a dependency on Fuse, so we will start by installing that:
sudo apt install fuse
Next, we must modify the <code>fuse.conf</code> file to enable the <code>allow_other</code> funtion:
sudo nano /etc/fuse.conf
Modify the last line by removing the # before <code>user_allow_other</code>. It should look like this:
# Allow non-root users to specify the allow_other or allow_root mount options.
user_allow_other
Now we can install Mergerfs. Go to the [https://github.com/trapexit/mergerfs/releases Mergerfs github page] and download the newest release that matches your install.
wget https://github.com/trapexit/mergerfs/releases/download/2.32.0/mergerfs_2.32.0.ubuntu-focal_amd64.deb
And then install it:
dpkg -i mergefs*.deb

To execute Mergerfs, run the following command. This assumes your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>. ''Note:'' There are no spaces in the variables passed to the <code>-o</code> flag, so it looks like a giant run on list and should be a single line.
/usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty

Once you verify that everything is working, it is recommended to use an autostart file configured to start after Rclone.

==== Mergerfs Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Mergerfs will run as.
# <code>Group</code> should match the service account group that Mergerfs will run as.

The unit service file should be named to match your merged folder name. If you have followed along with this wiki, that name would be <code>merge</code> so your service file would be named<code>merge.service</code>, and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Mergerfs's executable is placed in <code>/usr/local/bin/</code>, your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>.

[Unit]
Description=Mergerfs Mount (merge)
Requires=rclone.service
After=rclone.service

[Service]
Type=forking
ExecStart=/usr/local/bin/mergerfs /local:/cloud /merge \
-o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty
KillMode=process
Restart=on-failure
User=plex
Group=plex

[Install]
WantedBy=multi-user.target

===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Mergerfs has access to all data directories.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /local
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /local
$ ls -lad /merge
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /merge

===== Enabling and starting the Unit Service File =====
Once you have created <code>merge.service</code>, you will want to enable the service:
sudo systemctl enable merge.service

You are now ready to start Mergerfs. You can do so with the <code>start</code> command:
sudo systemctl start merge.service

If you want to verify Mergerfs is running, you can run the <code>status</code> command:
$ sudo systemctl status merge.service
● merge.service - Mergerfs Mount (merge)
Loaded: loaded (/etc/systemd/system/merge.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (mergerfs)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/merge.service
└─2392484 /usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest, >
Nov 15 16:28:25 systemname systemd[1]: Starting Mergerfs Mount (merge)...
Nov 15 16:28:26 systemname systemd[1]: Started Mergerfs Mount (merge).
=== Nightly Cloud Upload Example ===
Once Rclone and Mergefs are set up and configured, all data should be written on your local disk first. You will want to sync this data to your cloud drive then remove it to ensure your local disk does not run out of space. Below is an example bash shell script you may want to use, modeled on Animosity22's [https://github.com/animosity22/homescripts/blob/master/scripts/upload_cloud upload_cloud script].

First start by creating your script.
nano ~/home/.config/scripts/nightly_cloud_sync.sh
Example Script:
#!/bin/bash
# Variables to verify match your installation
# Rclone Config file
RCLONE_CONFIG=/home/plex/.config/rclone/rclone.conf
export RCLONE_CONFIG
# User account that Rclone is running as
RCLONE_USER_AGENT=plex
export RCLONE_USER_AGENT
# Local Mount - Ensure this is set to your local disk only.
LOCAL=/local
EXCLUDES=/home/plex/.config/scripts/excludes.log
LOGFILE=/home/plex/.config/scripts/upload.log
# Name of your Rclone Remote, likely cloud or cloudcrypt
REMOTE=cloud
# This will allow for 3 days for media analysis / intro generation. Feel free to reduce if needed.
MOVEAGE=3d

# Checks
# Running Check
if [[ $(pidof -x "$(basename "$0")" -o %PPID) ]]; then exit; fi
# Exclude File Check
if [[ ! -f $EXCLUDES ]] ; then
echo 'Warning: No excludes.log file found at $EXCLUDES'
exit 1
fi
# Local Disk Check
if /bin/findmnt $LOCAL -o FSTYPE -n | grep fuse; then
echo "Warning: $LOCAL is not a local disk!"
exit 1
fi

# Rclone Move Command
/usr/bin/rclone move $LOCAL $REMOTE: --log-file $LOGFILE -v --exclude-from $EXCLUDES --delete-empty-src-dirs --fast-list --min-age $MOVEAGE

To add this file to your cron job list, edit your crontab. Ensure your are logged in as the users you want the crontab to run as.
crontab -e
Add the following lines at the bottom of the folder.
# Nightly Cloud Sync
12 3 * * * ~/home/.config/scripts/nightly_cloud_sync.sh

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

File:Google Drive Credentials Screenshot.png

2020-12-04T19:26:29Z

Logvin:

Screenshot showing the credentials creation for Google Drive

File:ENABLE APIS AND SERVICES.png

2020-12-04T19:18:26Z

Logvin:

Screenshot from a Google API Dashboard Project showing the ENABLE APIS AND SERVICES button.

Cloud Setup

2020-12-04T17:39:38Z

Logvin:

== Rclone, Mergerfs, and Google Drive ==

With many options for storing 'unlimited' data in the cloud, configuring your system to allow your Arr's and media serving apps to access the data securely is possible. For this guide we will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service. We will also use a utility called Mergerfs to help keep our uploads organized.

Please note that this guide is for information only and you should only store legally obtained media.

Please Note: To get unlimited storage with Google Drive, you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive''' - Download to a local disk and move the data later w/ Rclone
* '''Don't import to your Gdrive''' - Set up a merged local cache disk and move the data later w/ Rclone
* '''Do all large writes locally'''
* '''Move to cloud on a schedule''' - Easily scriptable
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use three applications:
# Rclone - https://rclone.org/install/
# mergerfs - https://github.com/trapexit/mergerfs
# fuse - https://manpages.ubuntu.com/manpages/eoan/man8/mount.fuse.8.html

Once you have set up these applications, it is highly recommended to set up a cron job to automatically move files from your local drive to the cloud using Rclone. Animosity22 has [https://github.com/animosity22/homescripts a terrific Github page] with a sample script, or see the example below.

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

To install Rclone, run the following command:
curl https://rclone.org/install.sh | sudo bash

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== Mergerfs ===
Mergerfs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergerfs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergerfs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up Mergerfs ====
Mergefs has a dependency on Fuse, so we will start by installing that:
sudo apt install fuse
Next, we must modify the <code>fuse.conf</code> file to enable the <code>allow_other</code> funtion:
sudo nano /etc/fuse.conf
Modify the last line by removing the # before <code>user_allow_other</code>. It should look like this:
# Allow non-root users to specify the allow_other or allow_root mount options.
user_allow_other
Now we can install Mergerfs. Go to the [https://github.com/trapexit/mergerfs/releases Mergerfs github page] and download the newest release that matches your install.
wget https://github.com/trapexit/mergerfs/releases/download/2.32.0/mergerfs_2.32.0.ubuntu-focal_amd64.deb
And then install it:
dpkg -i mergefs*.deb

To execute Mergerfs, run the following command. This assumes your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>. ''Note:'' There are no spaces in the variables passed to the <code>-o</code> flag, so it looks like a giant run on list and should be a single line.
/usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty

Once you verify that everything is working, it is recommended to use an autostart file configured to start after Rclone.

==== Mergerfs Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Mergerfs will run as.
# <code>Group</code> should match the service account group that Mergerfs will run as.

The unit service file should be named to match your merged folder name. If you have followed along with this wiki, that name would be <code>merge</code> so your service file would be named<code>merge.service</code>, and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Mergerfs's executable is placed in <code>/usr/local/bin/</code>, your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>.

[Unit]
Description=Mergerfs Mount (merge)
Requires=rclone.service
After=rclone.service

[Service]
Type=forking
ExecStart=/usr/local/bin/mergerfs /local:/cloud /merge \
-o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty
KillMode=process
Restart=on-failure
User=plex
Group=plex

[Install]
WantedBy=multi-user.target

===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Mergerfs has access to all data directories.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /local
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /local
$ ls -lad /merge
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /merge

===== Enabling and starting the Unit Service File =====
Once you have created <code>merge.service</code>, you will want to enable the service:
sudo systemctl enable merge.service

You are now ready to start Mergerfs. You can do so with the <code>start</code> command:
sudo systemctl start merge.service

If you want to verify Mergerfs is running, you can run the <code>status</code> command:
$ sudo systemctl status merge.service
● merge.service - Mergerfs Mount (merge)
Loaded: loaded (/etc/systemd/system/merge.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (mergerfs)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/merge.service
└─2392484 /usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest, >
Nov 15 16:28:25 systemname systemd[1]: Starting Mergerfs Mount (merge)...
Nov 15 16:28:26 systemname systemd[1]: Started Mergerfs Mount (merge).
=== Nightly Cloud Upload Example ===
Once Rclone and Mergefs are set up and configured, all data should be written on your local disk first. You will want to sync this data to your cloud drive then remove it to ensure your local disk does not run out of space. Below is an example bash shell script you may want to use, modeled on Animosity22's [https://github.com/animosity22/homescripts/blob/master/scripts/upload_cloud upload_cloud script].

First start by creating your script.
nano ~/home/.config/scripts/nightly_cloud_sync.sh
Example Script:
#!/bin/bash
# Variables to verify match your installation
# Rclone Config file
RCLONE_CONFIG=/home/plex/.config/rclone/rclone.conf
export RCLONE_CONFIG
# User account that Rclone is running as
RCLONE_USER_AGENT=plex
export RCLONE_USER_AGENT
# Local Mount - Ensure this is set to your local disk only.
LOCAL=/local
EXCLUDES=/home/plex/.config/scripts/excludes.log
LOGFILE=/home/plex/.config/scripts/upload.log
# Name of your Rclone Remote, likely cloud or cloudcrypt
REMOTE=cloud
# This will allow for 3 days for media analysis / intro generation. Feel free to reduce if needed.
MOVEAGE=3d

# Checks
# Running Check
if [[ $(pidof -x "$(basename "$0")" -o %PPID) ]]; then exit; fi
# Exclude File Check
if [[ ! -f $EXCLUDES ]] ; then
echo 'Warning: No excludes.log file found at $EXCLUDES'
exit 1
fi
# Local Disk Check
if /bin/findmnt $LOCAL -o FSTYPE -n | grep fuse; then
echo "Warning: $LOCAL is not a local disk!"
exit 1
fi

# Rclone Move Command
/usr/bin/rclone move $LOCAL $REMOTE: --log-file $LOGFILE -v --exclude-from $EXCLUDES --delete-empty-src-dirs --fast-list --min-age $MOVEAGE

To add this file to your cron job list, edit your crontab. Ensure your are logged in as the users you want the crontab to run as.
crontab -e
Add the following lines at the bottom of the folder.
# Nightly Cloud Sync
12 3 * * * ~/home/.config/scripts/nightly_cloud_sync.sh

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T17:19:14Z

Logvin: /* Application Overview */

== Rclone, Mergerfs, and Google Drive ==

With many options for storing 'unlimited' data in the cloud, configuring your system to allow your Arr's and media serving apps to access the data securely is possible. For this guide we will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service. We will also use a utility called Mergerfs to help keep our uploads organized.

Please note that this guide is for information only and you should only store legally obtained media.

Please Note: To get unlimited storage with Google Drive, you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive''' - Download to a local disk and move the data later w/ Rclone
* '''Don't import to your Gdrive''' - Set up a merged local cache disk and move the data later w/ Rclone
* '''Do all large writes locally'''
* '''Move to cloud on a schedule''' - Easily scriptable
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use three applications:
# Rclone - https://rclone.org/install/
# mergerfs - https://github.com/trapexit/mergerfs
# fuse - https://manpages.ubuntu.com/manpages/eoan/man8/mount.fuse.8.html

Once you have set up these applications, it is highly recommended to set up a cron job to automatically move files from your local drive to the cloud using Rclone. Animosity22 has [https://github.com/animosity22/homescripts a terrific Github page] with a sample script, or see the example below.

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

To install Rclone, run the following command:
curl https://rclone.org/install.sh | sudo bash

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== Mergerfs ===
Mergerfs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergerfs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergerfs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up Mergerfs ====
Mergefs has a dependency on Fuse, so we will start by installing that:
sudo apt install fuse
Next, we must modify the <code>fuse.conf</code> file to enable the <code>allow_other</code> funtion:
sudo nano /etc/fuse.conf
Modify the last line by removing the # before <code>user_allow_other</code>. It should look like this:
# Allow non-root users to specify the allow_other or allow_root mount options.
user_allow_other
Now we can install Mergerfs. Go to the [https://github.com/trapexit/mergerfs/releases Mergerfs github page] and download the newest release that matches your install.
wget https://github.com/trapexit/mergerfs/releases/download/2.32.0/mergerfs_2.32.0.ubuntu-focal_amd64.deb
And then install it:
dpkg -i mergefs*.deb

To execute Mergerfs, run the following command. This assumes your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>. ''Note:'' There are no spaces in the variables passed to the <code>-o</code> flag, so it looks like a giant run on list and should be a single line.
/usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty

Once you verify that everything is working, it is recommended to use an autostart file configured to start after Rclone.

==== Mergerfs Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Mergerfs will run as.
# <code>Group</code> should match the service account group that Mergerfs will run as.

The unit service file should be named to match your merged folder name. If you have followed along with this wiki, that name would be <code>merge</code> so your service file would be named<code>merge.service</code>, and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Mergerfs's executable is placed in <code>/usr/local/bin/</code>, your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>.

[Unit]
Description=Mergerfs Mount (merge)
Requires=rclone.service
After=rclone.service

[Service]
Type=forking
ExecStart=/usr/local/bin/mergerfs /local:/cloud /merge \
-o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty
KillMode=process
Restart=on-failure
User=plex
Group=plex

[Install]
WantedBy=multi-user.target

===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Mergerfs has access to all data directories.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /local
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /local
$ ls -lad /merge
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /merge

===== Enabling and starting the Unit Service File =====
Once you have created <code>merge.service</code>, you will want to enable the service:
sudo systemctl enable merge.service

You are now ready to start Mergerfs. You can do so with the <code>start</code> command:
sudo systemctl start merge.service

If you want to verify Mergerfs is running, you can run the <code>status</code> command:
$ sudo systemctl status merge.service
● merge.service - Mergerfs Mount (merge)
Loaded: loaded (/etc/systemd/system/merge.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (mergerfs)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/merge.service
└─2392484 /usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest, >
Nov 15 16:28:25 systemname systemd[1]: Starting Mergerfs Mount (merge)...
Nov 15 16:28:26 systemname systemd[1]: Started Mergerfs Mount (merge).

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T17:11:30Z

Logvin:

== Rclone, Mergerfs, and Google Drive ==

With many options for storing 'unlimited' data in the cloud, configuring your system to allow your Arr's and media serving apps to access the data securely is possible. For this guide we will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service. We will also use a utility called Mergerfs to help keep our uploads organized.

Please note that this guide is for information only and you should only store legally obtained media.

Please Note: To get unlimited storage with Google Drive, you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive''' - Download to a local disk and move the data later w/ Rclone
* '''Don't import to your Gdrive''' - Set up a merged local cache disk and move the data later w/ Rclone
* '''Do all large writes locally'''
* '''Move to cloud on a schedule''' - Easily scriptable
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use two applications:
# Rclone - https://rclone.org/install/
# mergerfs - https://github.com/trapexit/mergerfs

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

To install Rclone, run the following command:
curl https://rclone.org/install.sh | sudo bash

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== Mergerfs ===
Mergerfs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergerfs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergerfs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up Mergerfs ====
Mergefs has a dependency on Fuse, so we will start by installing that:
sudo apt install fuse
Next, we must modify the <code>fuse.conf</code> file to enable the <code>allow_other</code> funtion:
sudo nano /etc/fuse.conf
Modify the last line by removing the # before <code>user_allow_other</code>. It should look like this:
# Allow non-root users to specify the allow_other or allow_root mount options.
user_allow_other
Now we can install Mergerfs. Go to the [https://github.com/trapexit/mergerfs/releases Mergerfs github page] and download the newest release that matches your install.
wget https://github.com/trapexit/mergerfs/releases/download/2.32.0/mergerfs_2.32.0.ubuntu-focal_amd64.deb
And then install it:
dpkg -i mergefs*.deb

To execute Mergerfs, run the following command. This assumes your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>. ''Note:'' There are no spaces in the variables passed to the <code>-o</code> flag, so it looks like a giant run on list and should be a single line.
/usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty

Once you verify that everything is working, it is recommended to use an autostart file configured to start after Rclone.

==== Mergerfs Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Mergerfs will run as.
# <code>Group</code> should match the service account group that Mergerfs will run as.

The unit service file should be named to match your merged folder name. If you have followed along with this wiki, that name would be <code>merge</code> so your service file would be named<code>merge.service</code>, and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Mergerfs's executable is placed in <code>/usr/local/bin/</code>, your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>.

[Unit]
Description=Mergerfs Mount (merge)
Requires=rclone.service
After=rclone.service

[Service]
Type=forking
ExecStart=/usr/local/bin/mergerfs /local:/cloud /merge \
-o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty
KillMode=process
Restart=on-failure
User=plex
Group=plex

[Install]
WantedBy=multi-user.target

===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Mergerfs has access to all data directories.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /local
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /local
$ ls -lad /merge
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /merge

===== Enabling and starting the Unit Service File =====
Once you have created <code>merge.service</code>, you will want to enable the service:
sudo systemctl enable merge.service

You are now ready to start Mergerfs. You can do so with the <code>start</code> command:
sudo systemctl start merge.service

If you want to verify Mergerfs is running, you can run the <code>status</code> command:
$ sudo systemctl status merge.service
● merge.service - Mergerfs Mount (merge)
Loaded: loaded (/etc/systemd/system/merge.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (mergerfs)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/merge.service
└─2392484 /usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest, >
Nov 15 16:28:25 systemname systemd[1]: Starting Mergerfs Mount (merge)...
Nov 15 16:28:26 systemname systemd[1]: Started Mergerfs Mount (merge).

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T16:54:55Z

Logvin: /* Application Overview */

== Rclone, Mergerfs, and Google Drive ==

With many options for storing 'unlimited' data in the cloud, configuring your system to allow your Arr's and media serving apps to access the data securely is possible. For this guide we will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service. We will also use a utility called Mergerfs to help keep our uploads organized.

Please note that this guide is for information only and you should only store legally obtained media.

Please Note: To get unlimited storage with Google Drive, you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive''' - Download to a local disk and move the data later w/ Rclone
* '''Don't import to your Gdrive''' - Set up a merged local cache disk and move the data later w/ Rclone
* '''Do all large writes locally'''
* '''Move to cloud on a schedule''' - Easily scriptable
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use two applications:
# Rclone - https://rclone.org/install/
# mergerfs - https://github.com/trapexit/mergerfs

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

To install Rclone, run the following command:
curl https://rclone.org/install.sh | sudo bash

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== Mergerfs ===
Mergerfs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergerfs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergerfs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up Mergerfs ====
Mergefs has a dependency on Fuse, so we will start by installing that:
sudo apt install fuse
Next, we must modify the <code>fuse.conf</code> file to enable the <code>allow_other</code> funtion:
sudo nano /etc/fuse.conf
Modify the last line by removing the # before <code>user_allow_other</code>. It should look like this:
# Allow non-root users to specify the allow_other or allow_root mount options.
user_allow_other
Now we can install Mergerfs. Go to the [https://github.com/trapexit/mergerfs/releases Mergerfs github page] and download the newest release that matches your install.
wget https://github.com/trapexit/mergerfs/releases/download/2.32.0/mergerfs_2.32.0.ubuntu-focal_amd64.deb
And then install it:
dpkg -i mergefs*.deb

To execute Mergerfs, run the following command. This assumes your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>. ''Note:'' There are no spaces in the variables passed to the <code>-o</code> flag, so it looks like a giant run on list and should be a single line.
/usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty

== Setup ==
Set your download client to download to say <code> /merge/usenet/{tv|movies} </code> and your library to say <code>/merge/media/{TV|Movies}</code>.
Then what happens is the download is local, the import is local. And it all looks like it is in the same place.
In the background, you have a cron or systemd timer that does rsync move from your local storage to your cloud storage.
You can rotate service accounts if needed.
It is also way more efficient at uploading vs. just the rclone mount.

The cloud mount allows sonarr/radarr to delete, rename and read stuff, but big writes don't need to go right to cloud.

If you do get rate limited, it won't impact your imports because they're all local.

<code>/local/media/{tv|movies}</code> //this is where ARR imports to. 
<code>/local/{usenet|torrents}/{tv/movies}</code> // this is where downloads should be dropped to

<code>/cloud/</code> //this is your rclone crypt mount (if going crypt) or GDrive Mount /cloud/media //this is your media folder in Gdrive

<code>/merge/</code> //is /cloud merged into /local/ using mergerfs

<code>/merge/media/{tv|movies}</code> //point plex and ARRs here as library/root folder

and setup remote path in ARR to say remote /local/ is the same as remote /merge/

Files will be downloaded into local and then imported into /local/media/ on a scheduled basis an rclone job would be created to move from local to gdrive so they will then automatically appear in cloud and it'll be like they never left merge

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T16:51:56Z

Logvin: /* Application Overview */

== Rclone, Mergerfs, and Google Drive ==

With many options for storing 'unlimited' data in the cloud, configuring your system to allow your Arr's and media serving apps to access the data securely is possible. For this guide we will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service. We will also use a utility called Mergerfs to help keep our uploads organized.

Please note that this guide is for information only and you should only store legally obtained media.

Please Note: To get unlimited storage with Google Drive, you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive''' - Download to a local disk and move the data later w/ Rclone
* '''Don't import to your Gdrive''' - Set up a merged local cache disk and move the data later w/ Rclone
* '''Do all large writes locally'''
* '''Move to cloud on a schedule''' - Easily scriptable
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use two applications:
# Rclone - https://rclone.org/install/
# mergerfs - https://github.com/trapexit/mergerfs

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

To install Rclone, run the following command:
curl https://rclone.org/install.sh | sudo bash

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== Mergerfs ===
Mergerfs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergerfs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergerfs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up Mergerfs ====
Mergefs has a dependency on Fuse, so we will start by installing that:
sudo apt install fuse
Next, we must modify the <code>fuse.conf</code> file to enable the <code>allow_other</code> funtion:
sudo nano /etc/fuse.conf
Modify the last line by removing the # before <code>user_allow_other</code>. It should look like this:
# Allow non-root users to specify the allow_other or allow_root mount options.
user_allow_other
Now we can install Mergerfs. Go to the [https://github.com/trapexit/mergerfs/releases Mergerfs github page] and download the newest release that matches your install.
wget https://github.com/trapexit/mergerfs/releases/download/2.32.0/mergerfs_2.32.0.ubuntu-focal_amd64.deb
And then install it:
dpkg -i mergefs*.deb

To execute Mergerfs, run the following command. This assumes your local storage is mounted at <code>/local</code>, your cloud storage is mounted at <code>/cloud</code>, and your merged mount is <code>/merge</code>.
/usr/local/bin/mergerfs /local:/cloud /merge -o rw,use_ino,allow_other,func.getattr=newest,category.action=all,category.create=ff,cache.files=auto-full,statfs_ignore=nc,func.getattr=newest,dropcacheonclose=true,nonempty

== Setup ==
Set your download client to download to say <code> /merge/usenet/{tv|movies} </code> and your library to say <code>/merge/media/{TV|Movies}</code>.
Then what happens is the download is local, the import is local. And it all looks like it is in the same place.
In the background, you have a cron or systemd timer that does rsync move from your local storage to your cloud storage.
You can rotate service accounts if needed.
It is also way more efficient at uploading vs. just the rclone mount.

The cloud mount allows sonarr/radarr to delete, rename and read stuff, but big writes don't need to go right to cloud.

If you do get rate limited, it won't impact your imports because they're all local.

<code>/local/media/{tv|movies}</code> //this is where ARR imports to. 
<code>/local/{usenet|torrents}/{tv/movies}</code> // this is where downloads should be dropped to

<code>/cloud/</code> //this is your rclone crypt mount (if going crypt) or GDrive Mount /cloud/media //this is your media folder in Gdrive

<code>/merge/</code> //is /cloud merged into /local/ using mergerfs

<code>/merge/media/{tv|movies}</code> //point plex and ARRs here as library/root folder

and setup remote path in ARR to say remote /local/ is the same as remote /merge/

Files will be downloaded into local and then imported into /local/media/ on a scheduled basis an rclone job would be created to move from local to gdrive so they will then automatically appear in cloud and it'll be like they never left merge

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T15:56:03Z

Logvin: /* Rclone */

== Rclone, Mergerfs, and Google Drive ==

With many options for storing 'unlimited' data in the cloud, configuring your system to allow your Arr's and media serving apps to access the data securely is possible. For this guide we will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service. We will also use a utility called Mergerfs to help keep our uploads organized.

Please note that this guide is for information only and you should only store legally obtained media.

Please Note: To get unlimited storage with Google Drive, you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive''' - Download to a local disk and move the data later w/ Rclone
* '''Don't import to your Gdrive''' - Set up a merged local cache disk and move the data later w/ Rclone
* '''Do all large writes locally'''
* '''Move to cloud on a schedule''' - Easily scriptable
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use two applications:
# Rclone - https://rclone.org/install/
# mergerfs - https://github.com/trapexit/mergerfs

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

To install Rclone, run the following command:
curl https://rclone.org/install.sh | sudo bash

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== Mergerfs ===
Mergerfs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergerfs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergerfs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up mergerfs ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.
Instead, setup a <code>/merge</code> with <code>mergerfs</code> that has some <code>/local</code> storage where downloads and imports will live, merge that with your <code>/cloud</code> rclone mount and use the mergerfs create [https://github.com/trapexit/mergerfs#policy-descriptions policy of <code>ff</code> or <code>epff</code>].

<code> /home/{user}/local:/home/{user}/cloud=NC /home/{user}/merge -o rw,async_read=false,statfs_ignore=nc,use_ino,func.getattr=newest,category.action=all,category.create=ff,cache.files=partial,dropcacheonclose=true,nonempty </code>

== Setup ==
Set your download client to download to say <code> /merge/usenet/{tv|movies} </code> and your library to say <code>/merge/media/{TV|Movies}</code>.
Then what happens is the download is local, the import is local. And it all looks like it is in the same place.
In the background, you have a cron or systemd timer that does rsync move from your local storage to your cloud storage.
You can rotate service accounts if needed.
It is also way more efficient at uploading vs. just the rclone mount.

The cloud mount allows sonarr/radarr to delete, rename and read stuff, but big writes don't need to go right to cloud.

If you do get rate limited, it won't impact your imports because they're all local.

<code>/local/media/{tv|movies}</code> //this is where ARR imports to. 
<code>/local/{usenet|torrents}/{tv/movies}</code> // this is where downloads should be dropped to

<code>/cloud/</code> //this is your rclone crypt mount (if going crypt) or GDrive Mount /cloud/media //this is your media folder in Gdrive

<code>/merge/</code> //is /cloud merged into /local/ using mergerfs

<code>/merge/media/{tv|movies}</code> //point plex and ARRs here as library/root folder

and setup remote path in ARR to say remote /local/ is the same as remote /merge/

Files will be downloaded into local and then imported into /local/media/ on a scheduled basis an rclone job would be created to move from local to gdrive so they will then automatically appear in cloud and it'll be like they never left merge

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T15:53:01Z

Logvin: /* mergerfs */

== Rclone, Mergerfs, and Google Drive ==

With many options for storing 'unlimited' data in the cloud, configuring your system to allow your Arr's and media serving apps to access the data securely is possible. For this guide we will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service. We will also use a utility called Mergerfs to help keep our uploads organized.

Please note that this guide is for information only and you should only store legally obtained media.

Please Note: To get unlimited storage with Google Drive, you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive''' - Download to a local disk and move the data later w/ Rclone
* '''Don't import to your Gdrive''' - Set up a merged local cache disk and move the data later w/ Rclone
* '''Do all large writes locally'''
* '''Move to cloud on a schedule''' - Easily scriptable
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use two applications:
# Rclone - https://rclone.org/install/
# mergerfs - https://github.com/trapexit/mergerfs

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== Mergerfs ===
Mergerfs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergerfs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergerfs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up mergerfs ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.
Instead, setup a <code>/merge</code> with <code>mergerfs</code> that has some <code>/local</code> storage where downloads and imports will live, merge that with your <code>/cloud</code> rclone mount and use the mergerfs create [https://github.com/trapexit/mergerfs#policy-descriptions policy of <code>ff</code> or <code>epff</code>].

<code> /home/{user}/local:/home/{user}/cloud=NC /home/{user}/merge -o rw,async_read=false,statfs_ignore=nc,use_ino,func.getattr=newest,category.action=all,category.create=ff,cache.files=partial,dropcacheonclose=true,nonempty </code>

== Setup ==
Set your download client to download to say <code> /merge/usenet/{tv|movies} </code> and your library to say <code>/merge/media/{TV|Movies}</code>.
Then what happens is the download is local, the import is local. And it all looks like it is in the same place.
In the background, you have a cron or systemd timer that does rsync move from your local storage to your cloud storage.
You can rotate service accounts if needed.
It is also way more efficient at uploading vs. just the rclone mount.

The cloud mount allows sonarr/radarr to delete, rename and read stuff, but big writes don't need to go right to cloud.

If you do get rate limited, it won't impact your imports because they're all local.

<code>/local/media/{tv|movies}</code> //this is where ARR imports to. 
<code>/local/{usenet|torrents}/{tv/movies}</code> // this is where downloads should be dropped to

<code>/cloud/</code> //this is your rclone crypt mount (if going crypt) or GDrive Mount /cloud/media //this is your media folder in Gdrive

<code>/merge/</code> //is /cloud merged into /local/ using mergerfs

<code>/merge/media/{tv|movies}</code> //point plex and ARRs here as library/root folder

and setup remote path in ARR to say remote /local/ is the same as remote /merge/

Files will be downloaded into local and then imported into /local/media/ on a scheduled basis an rclone job would be created to move from local to gdrive so they will then automatically appear in cloud and it'll be like they never left merge

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T15:51:06Z

Logvin: /* Application Overview */

== Rclone, Mergerfs, and Google Drive ==

With many options for storing 'unlimited' data in the cloud, configuring your system to allow your Arr's and media serving apps to access the data securely is possible. For this guide we will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service. We will also use a utility called Mergerfs to help keep our uploads organized.

Please note that this guide is for information only and you should only store legally obtained media.

Please Note: To get unlimited storage with Google Drive, you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive''' - Download to a local disk and move the data later w/ Rclone
* '''Don't import to your Gdrive''' - Set up a merged local cache disk and move the data later w/ Rclone
* '''Do all large writes locally'''
* '''Move to cloud on a schedule''' - Easily scriptable
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use two applications:
# Rclone - https://rclone.org/install/
# mergerfs - https://github.com/trapexit/mergerfs

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== mergerfs ===
mergerfs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergerfs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergerfs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up mergerfs ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.
Instead, setup a <code>/merge</code> with <code>mergerfs</code> that has some <code>/local</code> storage where downloads and imports will live, merge that with your <code>/cloud</code> rclone mount and use the mergerfs create [https://github.com/trapexit/mergerfs#policy-descriptions policy of <code>ff</code> or <code>epff</code>].

<code> /home/{user}/local:/home/{user}/cloud=NC /home/{user}/merge -o rw,async_read=false,statfs_ignore=nc,use_ino,func.getattr=newest,category.action=all,category.create=ff,cache.files=partial,dropcacheonclose=true,nonempty </code>

== Setup ==
Set your download client to download to say <code> /merge/usenet/{tv|movies} </code> and your library to say <code>/merge/media/{TV|Movies}</code>.
Then what happens is the download is local, the import is local. And it all looks like it is in the same place.
In the background, you have a cron or systemd timer that does rsync move from your local storage to your cloud storage.
You can rotate service accounts if needed.
It is also way more efficient at uploading vs. just the rclone mount.

The cloud mount allows sonarr/radarr to delete, rename and read stuff, but big writes don't need to go right to cloud.

If you do get rate limited, it won't impact your imports because they're all local.

<code>/local/media/{tv|movies}</code> //this is where ARR imports to. 
<code>/local/{usenet|torrents}/{tv/movies}</code> // this is where downloads should be dropped to

<code>/cloud/</code> //this is your rclone crypt mount (if going crypt) or GDrive Mount /cloud/media //this is your media folder in Gdrive

<code>/merge/</code> //is /cloud merged into /local/ using mergerfs

<code>/merge/media/{tv|movies}</code> //point plex and ARRs here as library/root folder

and setup remote path in ARR to say remote /local/ is the same as remote /merge/

Files will be downloaded into local and then imported into /local/media/ on a scheduled basis an rclone job would be created to move from local to gdrive so they will then automatically appear in cloud and it'll be like they never left merge

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T05:55:35Z

Logvin:

== Rclone, Mergerfs, and Google Drive ==

With many options for storing 'unlimited' data in the cloud, configuring your system to allow your Arr's and media serving apps to access the data securely is possible. For this guide we will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service. We will also use a utility called Mergerfs to help keep our uploads organized.

Please note that this guide is for information only and you should only store legally obtained media.

Please Note: To get unlimited storage with Google Drive, you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive.'''
* '''Don't import to your Gdrive.'''
* '''Do all large writes locally.'''
* '''Move to cloud on a schedule.'''
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use two applications:
# Rclone - https://rclone.org/install/
# mergerfs - https://github.com/trapexit/mergerfs

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== mergerfs ===
mergerfs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergerfs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergerfs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up mergerfs ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.
Instead, setup a <code>/merge</code> with <code>mergerfs</code> that has some <code>/local</code> storage where downloads and imports will live, merge that with your <code>/cloud</code> rclone mount and use the mergerfs create [https://github.com/trapexit/mergerfs#policy-descriptions policy of <code>ff</code> or <code>epff</code>].

<code> /home/{user}/local:/home/{user}/cloud=NC /home/{user}/merge -o rw,async_read=false,statfs_ignore=nc,use_ino,func.getattr=newest,category.action=all,category.create=ff,cache.files=partial,dropcacheonclose=true,nonempty </code>

== Setup ==
Set your download client to download to say <code> /merge/usenet/{tv|movies} </code> and your library to say <code>/merge/media/{TV|Movies}</code>.
Then what happens is the download is local, the import is local. And it all looks like it is in the same place.
In the background, you have a cron or systemd timer that does rsync move from your local storage to your cloud storage.
You can rotate service accounts if needed.
It is also way more efficient at uploading vs. just the rclone mount.

The cloud mount allows sonarr/radarr to delete, rename and read stuff, but big writes don't need to go right to cloud.

If you do get rate limited, it won't impact your imports because they're all local.

<code>/local/media/{tv|movies}</code> //this is where ARR imports to. 
<code>/local/{usenet|torrents}/{tv/movies}</code> // this is where downloads should be dropped to

<code>/cloud/</code> //this is your rclone crypt mount (if going crypt) or GDrive Mount /cloud/media //this is your media folder in Gdrive

<code>/merge/</code> //is /cloud merged into /local/ using mergerfs

<code>/merge/media/{tv|movies}</code> //point plex and ARRs here as library/root folder

and setup remote path in ARR to say remote /local/ is the same as remote /merge/

Files will be downloaded into local and then imported into /local/media/ on a scheduled basis an rclone job would be created to move from local to gdrive so they will then automatically appear in cloud and it'll be like they never left merge

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T05:54:32Z

Logvin: /* Rclone Mergerfs and Google Drive */

== Rclone, Mergerfs, and Google Drive ==

With many options for storing 'unlimited' data in the cloud, configuring your system to allow your Arr's and media serving apps to access the data securely is possible. For this guide we will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service. We will also use a utility called Mergerfs to help keep our uploads organized.

Please note that this guide is for information only and you should only store legally obtained media.

Please Note: To get unlimited storage with Google Drive, you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive.'''
* '''Don't import to your Gdrive.'''
* '''Do all large writes locally.'''
* '''Move to cloud on a schedule.'''
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use two applications:
# Rclone - https://rclone.org/install/
# mergefs - https://github.com/trapexit/mergerfs

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== mergefs ===
mergefs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergefs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergefs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up mergefs ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.
Instead, setup a <code>/merge</code> with <code>mergerfs</code> that has some <code>/local</code> storage where downloads and imports will live, merge that with your <code>/cloud</code> rclone mount and use the mergerfs create [https://github.com/trapexit/mergerfs#policy-descriptions policy of <code>ff</code> or <code>epff</code>].

<code> /home/{user}/local:/home/{user}/cloud=NC /home/{user}/merge -o rw,async_read=false,statfs_ignore=nc,use_ino,func.getattr=newest,category.action=all,category.create=ff,cache.files=partial,dropcacheonclose=true,nonempty </code>

== Setup ==
Set your download client to download to say <code> /merge/usenet/{tv|movies} </code> and your library to say <code>/merge/media/{TV|Movies}</code>.
Then what happens is the download is local, the import is local. And it all looks like it is in the same place.
In the background, you have a cron or systemd timer that does rsync move from your local storage to your cloud storage.
You can rotate service accounts if needed.
It is also way more efficient at uploading vs. just the rclone mount.

The cloud mount allows sonarr/radarr to delete, rename and read stuff, but big writes don't need to go right to cloud.

If you do get rate limited, it won't impact your imports because they're all local.

<code>/local/media/{tv|movies}</code> //this is where ARR imports to. 
<code>/local/{usenet|torrents}/{tv/movies}</code> // this is where downloads should be dropped to

<code>/cloud/</code> //this is your rclone crypt mount (if going crypt) or GDrive Mount /cloud/media //this is your media folder in Gdrive

<code>/merge/</code> //is /cloud merged into /local/ using mergerfs

<code>/merge/media/{tv|movies}</code> //point plex and ARRs here as library/root folder

and setup remote path in ARR to say remote /local/ is the same as remote /merge/

Files will be downloaded into local and then imported into /local/media/ on a scheduled basis an rclone job would be created to move from local to gdrive so they will then automatically appear in cloud and it'll be like they never left merge

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T05:49:28Z

Logvin: /* Rclone */

== Rclone Mergerfs and Google Drive ==

So you want to become a 'cloud pirate'? You want to store your media in the cloud, but still be able to use the Arrs and Plex? For this guide you will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service.

Please note that this guide is for information only and you should only store legally obtained media.

Additionally, to get unlimited storage you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive.'''
* '''Don't import to your Gdrive.'''
* '''Do all large writes locally.'''
* '''Move to cloud on a schedule.'''
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use two applications:
# Rclone - https://rclone.org/install/
# mergefs - https://github.com/trapexit/mergerfs

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Verify Directory Permissions =====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

=== mergefs ===
mergefs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergefs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergefs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up mergefs ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.
Instead, setup a <code>/merge</code> with <code>mergerfs</code> that has some <code>/local</code> storage where downloads and imports will live, merge that with your <code>/cloud</code> rclone mount and use the mergerfs create [https://github.com/trapexit/mergerfs#policy-descriptions policy of <code>ff</code> or <code>epff</code>].

<code> /home/{user}/local:/home/{user}/cloud=NC /home/{user}/merge -o rw,async_read=false,statfs_ignore=nc,use_ino,func.getattr=newest,category.action=all,category.create=ff,cache.files=partial,dropcacheonclose=true,nonempty </code>

== Setup ==
Set your download client to download to say <code> /merge/usenet/{tv|movies} </code> and your library to say <code>/merge/media/{TV|Movies}</code>.
Then what happens is the download is local, the import is local. And it all looks like it is in the same place.
In the background, you have a cron or systemd timer that does rsync move from your local storage to your cloud storage.
You can rotate service accounts if needed.
It is also way more efficient at uploading vs. just the rclone mount.

The cloud mount allows sonarr/radarr to delete, rename and read stuff, but big writes don't need to go right to cloud.

If you do get rate limited, it won't impact your imports because they're all local.

<code>/local/media/{tv|movies}</code> //this is where ARR imports to. 
<code>/local/{usenet|torrents}/{tv/movies}</code> // this is where downloads should be dropped to

<code>/cloud/</code> //this is your rclone crypt mount (if going crypt) or GDrive Mount /cloud/media //this is your media folder in Gdrive

<code>/merge/</code> //is /cloud merged into /local/ using mergerfs

<code>/merge/media/{tv|movies}</code> //point plex and ARRs here as library/root folder

and setup remote path in ARR to say remote /local/ is the same as remote /merge/

Files will be downloaded into local and then imported into /local/media/ on a scheduled basis an rclone job would be created to move from local to gdrive so they will then automatically appear in cloud and it'll be like they never left merge

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T05:47:50Z

Logvin: /* Rclone Linux Autostart using Systemd */

== Rclone Mergerfs and Google Drive ==

So you want to become a 'cloud pirate'? You want to store your media in the cloud, but still be able to use the Arrs and Plex? For this guide you will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service.

Please note that this guide is for information only and you should only store legally obtained media.

Additionally, to get unlimited storage you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive.'''
* '''Don't import to your Gdrive.'''
* '''Do all large writes locally.'''
* '''Move to cloud on a schedule.'''
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use two applications:
# Rclone - https://rclone.org/install/
# mergefs - https://github.com/trapexit/mergerfs

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
===== Enabling and starting the Unit Service File =====
Once you have created <code>Rclone.service</code>, you will want to enable the service:
sudo systemctl enable Rclone.service

You are now ready to start Rclone. You can do so with the <code>start</code> command:
sudo systemctl start Rclone.service

If you want to verify Rclone is running, you can run the <code>status</code> command:
$ sudo systemctl status rclone.service
● rclone.service - Google Drive Encrypted (rclone)
Loaded: loaded (/etc/systemd/system/rclone.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2020-11-15 16:28:26 MST; 2 weeks 4 days ago
Main PID: 2392484 (rclone)
Tasks: 31 (limit: 76935)
Memory: 21.9G
CGroup: /system.slice/rclone.service
└─2392484 /usr/bin/rclone mount cloud: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h >
Nov 15 16:28:25 systemname systemd[1]: Starting Google Drive Encrypted (rclone)...
Nov 15 16:28:26 systemname systemd[1]: Started Google Drive Encrypted (rclone).

==== Verify Directory Permissions ====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

=== mergefs ===
mergefs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergefs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergefs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up mergefs ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.
Instead, setup a <code>/merge</code> with <code>mergerfs</code> that has some <code>/local</code> storage where downloads and imports will live, merge that with your <code>/cloud</code> rclone mount and use the mergerfs create [https://github.com/trapexit/mergerfs#policy-descriptions policy of <code>ff</code> or <code>epff</code>].

<code> /home/{user}/local:/home/{user}/cloud=NC /home/{user}/merge -o rw,async_read=false,statfs_ignore=nc,use_ino,func.getattr=newest,category.action=all,category.create=ff,cache.files=partial,dropcacheonclose=true,nonempty </code>

== Setup ==
Set your download client to download to say <code> /merge/usenet/{tv|movies} </code> and your library to say <code>/merge/media/{TV|Movies}</code>.
Then what happens is the download is local, the import is local. And it all looks like it is in the same place.
In the background, you have a cron or systemd timer that does rsync move from your local storage to your cloud storage.
You can rotate service accounts if needed.
It is also way more efficient at uploading vs. just the rclone mount.

The cloud mount allows sonarr/radarr to delete, rename and read stuff, but big writes don't need to go right to cloud.

If you do get rate limited, it won't impact your imports because they're all local.

<code>/local/media/{tv|movies}</code> //this is where ARR imports to. 
<code>/local/{usenet|torrents}/{tv/movies}</code> // this is where downloads should be dropped to

<code>/cloud/</code> //this is your rclone crypt mount (if going crypt) or GDrive Mount /cloud/media //this is your media folder in Gdrive

<code>/merge/</code> //is /cloud merged into /local/ using mergerfs

<code>/merge/media/{tv|movies}</code> //point plex and ARRs here as library/root folder

and setup remote path in ARR to say remote /local/ is the same as remote /merge/

Files will be downloaded into local and then imported into /local/media/ on a scheduled basis an rclone job would be created to move from local to gdrive so they will then automatically appear in cloud and it'll be like they never left merge

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T05:40:28Z

Logvin: /* mergefs */

== Rclone Mergerfs and Google Drive ==

So you want to become a 'cloud pirate'? You want to store your media in the cloud, but still be able to use the Arrs and Plex? For this guide you will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service.

Please note that this guide is for information only and you should only store legally obtained media.

Additionally, to get unlimited storage you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive.'''
* '''Don't import to your Gdrive.'''
* '''Do all large writes locally.'''
* '''Move to cloud on a schedule.'''
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use two applications:
# Rclone - https://rclone.org/install/
# mergefs - https://github.com/trapexit/mergerfs

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target

==== Verify Directory Permissions ====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

=== mergefs ===
mergefs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</code>, <code>mergefs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergefs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up mergefs ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.
Instead, setup a <code>/merge</code> with <code>mergerfs</code> that has some <code>/local</code> storage where downloads and imports will live, merge that with your <code>/cloud</code> rclone mount and use the mergerfs create [https://github.com/trapexit/mergerfs#policy-descriptions policy of <code>ff</code> or <code>epff</code>].

<code> /home/{user}/local:/home/{user}/cloud=NC /home/{user}/merge -o rw,async_read=false,statfs_ignore=nc,use_ino,func.getattr=newest,category.action=all,category.create=ff,cache.files=partial,dropcacheonclose=true,nonempty </code>

== Setup ==
Set your download client to download to say <code> /merge/usenet/{tv|movies} </code> and your library to say <code>/merge/media/{TV|Movies}</code>.
Then what happens is the download is local, the import is local. And it all looks like it is in the same place.
In the background, you have a cron or systemd timer that does rsync move from your local storage to your cloud storage.
You can rotate service accounts if needed.
It is also way more efficient at uploading vs. just the rclone mount.

The cloud mount allows sonarr/radarr to delete, rename and read stuff, but big writes don't need to go right to cloud.

If you do get rate limited, it won't impact your imports because they're all local.

<code>/local/media/{tv|movies}</code> //this is where ARR imports to. 
<code>/local/{usenet|torrents}/{tv/movies}</code> // this is where downloads should be dropped to

<code>/cloud/</code> //this is your rclone crypt mount (if going crypt) or GDrive Mount /cloud/media //this is your media folder in Gdrive

<code>/merge/</code> //is /cloud merged into /local/ using mergerfs

<code>/merge/media/{tv|movies}</code> //point plex and ARRs here as library/root folder

and setup remote path in ARR to say remote /local/ is the same as remote /merge/

Files will be downloaded into local and then imported into /local/media/ on a scheduled basis an rclone job would be created to move from local to gdrive so they will then automatically appear in cloud and it'll be like they never left merge

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T05:35:44Z

Logvin: /* Encrypting your Cloud Storage */

== Rclone Mergerfs and Google Drive ==

So you want to become a 'cloud pirate'? You want to store your media in the cloud, but still be able to use the Arrs and Plex? For this guide you will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service.

Please note that this guide is for information only and you should only store legally obtained media.

Additionally, to get unlimited storage you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive.'''
* '''Don't import to your Gdrive.'''
* '''Do all large writes locally.'''
* '''Move to cloud on a schedule.'''
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use two applications:
# Rclone - https://rclone.org/install/
# mergefs - https://github.com/trapexit/mergerfs

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names

The next few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</code>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target

==== Verify Directory Permissions ====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

=== mergefs ===
mergefs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</cloud>, <code>mergefs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergefs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up mergefs ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.
Instead, setup a <code>/merge</code> with <code>mergerfs</code> that has some <code>/local</code> storage where downloads and imports will live, merge that with your <code>/cloud</code> rclone mount and use the mergerfs create [https://github.com/trapexit/mergerfs#policy-descriptions policy of <code>ff</code> or <code>epff</code>].

<code> /home/{user}/local:/home/{user}/cloud=NC /home/{user}/merge -o rw,async_read=false,statfs_ignore=nc,use_ino,func.getattr=newest,category.action=all,category.create=ff,cache.files=partial,dropcacheonclose=true,nonempty </code>

== Setup ==
Set your download client to download to say <code> /merge/usenet/{tv|movies} </code> and your library to say <code>/merge/media/{TV|Movies}</code>.
Then what happens is the download is local, the import is local. And it all looks like it is in the same place.
In the background, you have a cron or systemd timer that does rsync move from your local storage to your cloud storage.
You can rotate service accounts if needed.
It is also way more efficient at uploading vs. just the rclone mount.

The cloud mount allows sonarr/radarr to delete, rename and read stuff, but big writes don't need to go right to cloud.

If you do get rate limited, it won't impact your imports because they're all local.

<code>/local/media/{tv|movies}</code> //this is where ARR imports to. 
<code>/local/{usenet|torrents}/{tv/movies}</code> // this is where downloads should be dropped to

<code>/cloud/</code> //this is your rclone crypt mount (if going crypt) or GDrive Mount /cloud/media //this is your media folder in Gdrive

<code>/merge/</code> //is /cloud merged into /local/ using mergerfs

<code>/merge/media/{tv|movies}</code> //point plex and ARRs here as library/root folder

and setup remote path in ARR to say remote /local/ is the same as remote /merge/

Files will be downloaded into local and then imported into /local/media/ on a scheduled basis an rclone job would be created to move from local to gdrive so they will then automatically appear in cloud and it'll be like they never left merge

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T05:33:08Z

Logvin: /* Rclone */

== Rclone Mergerfs and Google Drive ==

So you want to become a 'cloud pirate'? You want to store your media in the cloud, but still be able to use the Arrs and Plex? For this guide you will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service.

Please note that this guide is for information only and you should only store legally obtained media.

Additionally, to get unlimited storage you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive.'''
* '''Don't import to your Gdrive.'''
* '''Do all large writes locally.'''
* '''Move to cloud on a schedule.'''
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use two applications:
# Rclone - https://rclone.org/install/
# mergefs - https://github.com/trapexit/mergerfs

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Encrypting your Cloud Storage ====
If you followed the previous steps, you created an unencrypted Google Drive mount. If you would like to encrypt your storage so that Google can not scan your files (good idea!), then follows these optional steps:

Start by running Rclone's config tool again, as you did previously:
rclone config
# <code> n </code> - New Remote
# <code> cloudcrypt </code> - Name of your new encrypted remote
# <code> crypt </code> - Encrypt/Decrypt a remote
# <code> cloud:crypt </code> - Remote to encrypt/decrypt, followed by a semicolon and a name indicating the function.
# <code> standard </code> - How to encrypt the filenames.
# <code> true </code> - Encrypt directory names
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder

The new few questions will ask you to create two passwords, one for the encryption and one for the salt. It is recommended to choose two different passwords, and for the best protection, allow them to be generated for you and document them somewhere safe.

Once the password section is finished, it should present you with the new config, which should look similar to this:
[cloudcrypt]
type = crypt
remote = cloud:crypt
filename_encryption = standard
directory_name_encryption = true
password = **Encrypted PW1**
password2 = **Encrypted PW2**

Finally, make sure when you run rclone (either manually or via autostart script), you mount <code>cloudcrypt</code> rather than calling <code>cloud</cloud>.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount cloud: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target

==== Verify Directory Permissions ====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

=== mergefs ===
mergefs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</cloud>, <code>mergefs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergefs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up mergefs ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.
Instead, setup a <code>/merge</code> with <code>mergerfs</code> that has some <code>/local</code> storage where downloads and imports will live, merge that with your <code>/cloud</code> rclone mount and use the mergerfs create [https://github.com/trapexit/mergerfs#policy-descriptions policy of <code>ff</code> or <code>epff</code>].

<code> /home/{user}/local:/home/{user}/cloud=NC /home/{user}/merge -o rw,async_read=false,statfs_ignore=nc,use_ino,func.getattr=newest,category.action=all,category.create=ff,cache.files=partial,dropcacheonclose=true,nonempty </code>

== Setup ==
Set your download client to download to say <code> /merge/usenet/{tv|movies} </code> and your library to say <code>/merge/media/{TV|Movies}</code>.
Then what happens is the download is local, the import is local. And it all looks like it is in the same place.
In the background, you have a cron or systemd timer that does rsync move from your local storage to your cloud storage.
You can rotate service accounts if needed.
It is also way more efficient at uploading vs. just the rclone mount.

The cloud mount allows sonarr/radarr to delete, rename and read stuff, but big writes don't need to go right to cloud.

If you do get rate limited, it won't impact your imports because they're all local.

<code>/local/media/{tv|movies}</code> //this is where ARR imports to. 
<code>/local/{usenet|torrents}/{tv/movies}</code> // this is where downloads should be dropped to

<code>/cloud/</code> //this is your rclone crypt mount (if going crypt) or GDrive Mount /cloud/media //this is your media folder in Gdrive

<code>/merge/</code> //is /cloud merged into /local/ using mergerfs

<code>/merge/media/{tv|movies}</code> //point plex and ARRs here as library/root folder

and setup remote path in ARR to say remote /local/ is the same as remote /merge/

Files will be downloaded into local and then imported into /local/media/ on a scheduled basis an rclone job would be created to move from local to gdrive so they will then automatically appear in cloud and it'll be like they never left merge

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T05:10:58Z

Logvin: /* Setting up Rclone */

== Rclone Mergerfs and Google Drive ==

So you want to become a 'cloud pirate'? You want to store your media in the cloud, but still be able to use the Arrs and Plex? For this guide you will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service.

Please note that this guide is for information only and you should only store legally obtained media.

Additionally, to get unlimited storage you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive.'''
* '''Don't import to your Gdrive.'''
* '''Do all large writes locally.'''
* '''Move to cloud on a schedule.'''
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use two applications:
# Rclone - https://rclone.org/install/
# mergefs - https://github.com/trapexit/mergerfs

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=full --vfs-cache-max-age=6h --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessible by the user you have in your .conf file.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount gdrive: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target

==== Verify Directory Permissions ====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

=== mergefs ===
mergefs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</cloud>, <code>mergefs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergefs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up mergefs ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.
Instead, setup a <code>/merge</code> with <code>mergerfs</code> that has some <code>/local</code> storage where downloads and imports will live, merge that with your <code>/cloud</code> rclone mount and use the mergerfs create [https://github.com/trapexit/mergerfs#policy-descriptions policy of <code>ff</code> or <code>epff</code>].

<code> /home/{user}/local:/home/{user}/cloud=NC /home/{user}/merge -o rw,async_read=false,statfs_ignore=nc,use_ino,func.getattr=newest,category.action=all,category.create=ff,cache.files=partial,dropcacheonclose=true,nonempty </code>

== Setup ==
Set your download client to download to say <code> /merge/usenet/{tv|movies} </code> and your library to say <code>/merge/media/{TV|Movies}</code>.
Then what happens is the download is local, the import is local. And it all looks like it is in the same place.
In the background, you have a cron or systemd timer that does rsync move from your local storage to your cloud storage.
You can rotate service accounts if needed.
It is also way more efficient at uploading vs. just the rclone mount.

The cloud mount allows sonarr/radarr to delete, rename and read stuff, but big writes don't need to go right to cloud.

If you do get rate limited, it won't impact your imports because they're all local.

<code>/local/media/{tv|movies}</code> //this is where ARR imports to. 
<code>/local/{usenet|torrents}/{tv/movies}</code> // this is where downloads should be dropped to

<code>/cloud/</code> //this is your rclone crypt mount (if going crypt) or GDrive Mount /cloud/media //this is your media folder in Gdrive

<code>/merge/</code> //is /cloud merged into /local/ using mergerfs

<code>/merge/media/{tv|movies}</code> //point plex and ARRs here as library/root folder

and setup remote path in ARR to say remote /local/ is the same as remote /merge/

Files will be downloaded into local and then imported into /local/media/ on a scheduled basis an rclone job would be created to move from local to gdrive so they will then automatically appear in cloud and it'll be like they never left merge

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T05:09:01Z

Logvin: /* Rclone */

== Rclone Mergerfs and Google Drive ==

So you want to become a 'cloud pirate'? You want to store your media in the cloud, but still be able to use the Arrs and Plex? For this guide you will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service.

Please note that this guide is for information only and you should only store legally obtained media.

Additionally, to get unlimited storage you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive.'''
* '''Don't import to your Gdrive.'''
* '''Do all large writes locally.'''
* '''Move to cloud on a schedule.'''
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use two applications:
# Rclone - https://rclone.org/install/
# mergefs - https://github.com/trapexit/mergerfs

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud. More Rclone information can be found on [https://github.com/animosity22/homescripts animosity22's Github page.]

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=writes --vfs-read-chunk-size-limit=off --vfs-cache-max-age=6h --vfs-read-chunk-size=128M --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessable by the user you have in your .conf file.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount gdrive: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target

==== Verify Directory Permissions ====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

=== mergefs ===
mergefs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</cloud>, <code>mergefs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergefs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up mergefs ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.
Instead, setup a <code>/merge</code> with <code>mergerfs</code> that has some <code>/local</code> storage where downloads and imports will live, merge that with your <code>/cloud</code> rclone mount and use the mergerfs create [https://github.com/trapexit/mergerfs#policy-descriptions policy of <code>ff</code> or <code>epff</code>].

<code> /home/{user}/local:/home/{user}/cloud=NC /home/{user}/merge -o rw,async_read=false,statfs_ignore=nc,use_ino,func.getattr=newest,category.action=all,category.create=ff,cache.files=partial,dropcacheonclose=true,nonempty </code>

== Setup ==
Set your download client to download to say <code> /merge/usenet/{tv|movies} </code> and your library to say <code>/merge/media/{TV|Movies}</code>.
Then what happens is the download is local, the import is local. And it all looks like it is in the same place.
In the background, you have a cron or systemd timer that does rsync move from your local storage to your cloud storage.
You can rotate service accounts if needed.
It is also way more efficient at uploading vs. just the rclone mount.

The cloud mount allows sonarr/radarr to delete, rename and read stuff, but big writes don't need to go right to cloud.

If you do get rate limited, it won't impact your imports because they're all local.

<code>/local/media/{tv|movies}</code> //this is where ARR imports to. 
<code>/local/{usenet|torrents}/{tv/movies}</code> // this is where downloads should be dropped to

<code>/cloud/</code> //this is your rclone crypt mount (if going crypt) or GDrive Mount /cloud/media //this is your media folder in Gdrive

<code>/merge/</code> //is /cloud merged into /local/ using mergerfs

<code>/merge/media/{tv|movies}</code> //point plex and ARRs here as library/root folder

and setup remote path in ARR to say remote /local/ is the same as remote /merge/

Files will be downloaded into local and then imported into /local/media/ on a scheduled basis an rclone job would be created to move from local to gdrive so they will then automatically appear in cloud and it'll be like they never left merge

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-04T05:07:56Z

Logvin: /* Preparing the Unit Service File */

== Rclone Mergerfs and Google Drive ==

So you want to become a 'cloud pirate'? You want to store your media in the cloud, but still be able to use the Arrs and Plex? For this guide you will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service.

Please note that this guide is for information only and you should only store legally obtained media.

Additionally, to get unlimited storage you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive.'''
* '''Don't import to your Gdrive.'''
* '''Do all large writes locally.'''
* '''Move to cloud on a schedule.'''
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use two applications:
# Rclone - https://rclone.org/install/
# mergefs - https://github.com/trapexit/mergerfs

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud.

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=writes --vfs-read-chunk-size-limit=off --vfs-cache-max-age=6h --vfs-read-chunk-size=128M --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessable by the user you have in your .conf file.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code> Feel free to remove the <code># comment</code> lines, they are there for those who want to know what those flags are doing and were taken from the rclone documentation.

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount gdrive: /cloud \
# Allow mounting over a non-empty directory (not Windows).
--allow-non-empty \
# In memory buffer size when reading files for each --transfer. (default 16M)
--buffer-size=128M \
# Use mmap allocator (see docs).
--use-mmap \
# Time to cache directory entries for. (default 5m0s)
--dir-cache-time=48h \
# How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
--cache-info-age=48h \
# Cache mode off|minimal|writes|full (default off)
--vfs-cache-mode=full \
# Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-age=6h \
# Override the permission bits set by the filesystem.
--umask 002 \
# Location where rclone logs will be stored
--log-file=~/.config/rclone/logs/rclone.log \
# Logging level for rclone logs
--log-level INFO \
# Location where the rclone.conf file is located
--config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target

==== Verify Directory Permissions ====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

=== mergefs ===
mergefs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</cloud>, <code>mergefs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergefs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up mergefs ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.
Instead, setup a <code>/merge</code> with <code>mergerfs</code> that has some <code>/local</code> storage where downloads and imports will live, merge that with your <code>/cloud</code> rclone mount and use the mergerfs create [https://github.com/trapexit/mergerfs#policy-descriptions policy of <code>ff</code> or <code>epff</code>].

<code> /home/{user}/local:/home/{user}/cloud=NC /home/{user}/merge -o rw,async_read=false,statfs_ignore=nc,use_ino,func.getattr=newest,category.action=all,category.create=ff,cache.files=partial,dropcacheonclose=true,nonempty </code>

== Setup ==
Set your download client to download to say <code> /merge/usenet/{tv|movies} </code> and your library to say <code>/merge/media/{TV|Movies}</code>.
Then what happens is the download is local, the import is local. And it all looks like it is in the same place.
In the background, you have a cron or systemd timer that does rsync move from your local storage to your cloud storage.
You can rotate service accounts if needed.
It is also way more efficient at uploading vs. just the rclone mount.

The cloud mount allows sonarr/radarr to delete, rename and read stuff, but big writes don't need to go right to cloud.

If you do get rate limited, it won't impact your imports because they're all local.

<code>/local/media/{tv|movies}</code> //this is where ARR imports to. 
<code>/local/{usenet|torrents}/{tv/movies}</code> // this is where downloads should be dropped to

<code>/cloud/</code> //this is your rclone crypt mount (if going crypt) or GDrive Mount /cloud/media //this is your media folder in Gdrive

<code>/merge/</code> //is /cloud merged into /local/ using mergerfs

<code>/merge/media/{tv|movies}</code> //point plex and ARRs here as library/root folder

and setup remote path in ARR to say remote /local/ is the same as remote /merge/

Files will be downloaded into local and then imported into /local/media/ on a scheduled basis an rclone job would be created to move from local to gdrive so they will then automatically appear in cloud and it'll be like they never left merge

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Cloud Setup

2020-12-03T22:04:08Z

Logvin: /* Overview */

== Rclone Mergerfs and Google Drive ==

So you want to become a 'cloud pirate'? You want to store your media in the cloud, but still be able to use the Arrs and Plex? For this guide you will use [https://gsuite.google.com/products/drive/ Google Suite Unlimited Storage] or a similar [https://rclone.org/ Rclone] compatible storage service.

Please note that this guide is for information only and you should only store legally obtained media.

Additionally, to get unlimited storage you should have 5 users (as of writing $12*5 users = $60/mo). If you have less users you ''technically'' do not have unlimited storage and Google may enforce said limits at any time.

== Application Overview ==

Recommendations:
* '''Don't download into your Gdrive.'''
* '''Don't import to your Gdrive.'''
* '''Do all large writes locally.'''
* '''Move to cloud on a schedule.'''
* '''Absolutely do not write (large files) directly to the rclone mount

To connect with your Gdrive, you will need to use two applications:
# Rclone - https://rclone.org/install/
# mergefs - https://github.com/trapexit/mergerfs

=== Rclone ===
Rclone's core purpose for the Arr's is to allow access to your data depository that is located in Gdrive. Rclone will mount and serve your file automatically, with your apps not knowing they are accessing data in the cloud.

==== Setting up Rclone ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.

Making your own Google API Client ID
When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. It is strongly recommended to use your own client ID as the default rclone ID is heavily used.

# Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)

# Select a project or create a new project.

# Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".

# Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"

# If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.

# Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".

# Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)

# It will show you a client ID and client secret. Write or copy these values down. Use these values in rclone config to add a new remote or edit an existing remote.

Setup your Google Service Account (SA) file this allows it to not be tied to a single user account.
# go to the Google Developer Console.

# go to "IAM & admin" -> "Service Accounts".

# Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. e.g. <code> mount </code> Leave "Role" Empty

# Tick "Furnish a new private key" - select "Key type JSON".

# Tick "Enable G Suite Domain-wide Delegation". These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.

Allow API access to Google Drive
# go to admin console
# Go into "Security" (or use the search bar)
# Select "Show more" and then "Advanced settings"
# Select "Manage API client access" in the "Authentication" section
# In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
# In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.

<code> rclone config </code>
# <code> n </code> - New Remote
# Enter a name for your mount e.g. <code> cloud </code>
# <code> 13 </code> - Google Drive
# Enter your Google Application Client Id
# Enter your Google Application Client Secret
# <code> 1 </code> - Full Access
# Leave Blank ID of the root folder
# enter the path and filename to your Google Drive SA Json
# <code> n </code> - Do Not Use Auto Config
# <code> y </code> - use team drive
# Review for Accuracy
# mount the drive using <Code>rclone mount --daemon --daemon-timeout=5m --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=writes --vfs-read-chunk-size-limit=off --vfs-cache-max-age=6h --vfs-read-chunk-size=128M --log-file=~/.config/rclone/logs/rclone.log --log-level INFO cloud: /cloud </code>

When you executed <code>rclone config</code> above, it created a file <code>rclone.conf</code> and placed it at <code>~/.config/rclone.conf</code>. If you intend to have your OS auto-mount your new rclone mount using systemd, ensure this file is accessable by the user you have in your .conf file.

==== Rclone Linux Autostart using Systemd ====
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.
===== Preparing the Unit Service File =====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that Rclone will run as.
# <code>Group</code> should match the service account group that Rclone will run as.

The unit service file should be named <code>Rclone.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>plex</code>, Rclone's executable is placed in <code>/usr/bin/</code>, your cloud storage is being mounted to <code>/cloud</code>, and you have previously ran Rclone and set up a config file, which is located at <code>~/.config/rclone/rclone.conf</code>

[Unit]
Description=Google Drive Encrypted (rclone)
Wants=network-online.target
After=network-online.target

[Service]
Type=notify
ExecStart=/usr/bin/rclone mount gdrive: /cloud --allow-non-empty --buffer-size=128M --use-mmap --dir-cache-time=48h --cache-info-age=48h --vfs-cache-mode=writes --vfs-read-chunk-size-limit=off --vfs-cache-max-age=6h --vfs-read-chunk-size=128M --log-file=~/.config/rclone/logs/rclone.log --log-level INFO --config ~/.config/rclone/rclone.conf
ExecStop=/bin/fusermount -uz /cloud
Restart=on-abort
User=plex
KillMode=none
RestartSec=5

[Install]
WantedBy=default.target
==== Verify Directory Permissions ====
Ensure the <code>User</code> that will be running Rclone has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder. In the example below, the user and group are both <code>plex</code>.
Example:
$ ls -lad /cloud
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /cloud
$ ls -lad /home/plex/.config/rclone/
drwxr-xr-x 6 plex plex 24576 Nov 28 21:30 /home/plex/.config/rclone/

=== mergefs ===
mergefs core purpose for the Arr's is to allow you to have a single merged directory structure, based on two different directories. For example, if you used rclone to mount a directory named <code>/cloud</code> and you have a locally mounted directory named <code>/local</cloud>, <code>mergefs</code> would create a single merged directory of those two, which you could call <code>/merge</code>. Your media server and Arrs would access <code>/merge</code> and see the combination of local + cloud storage.

Example:
You have the first 4 episodes of 'Popular TV Show' located on your cloud drive, and Sonarr just downloaded and imported episode 5. If you looked in your cloud drive (/cloud), you would see:
/cloud/TV Shows/Popular TV Show/S01E01.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E02.mkv
/cloud/TV Shows/Popular TV Show/S01E04.mkv
If you looked in your local storage (/local) you would see:
/local/TV Shows/Popular TV Show/S01E05.mkv
And if you looked in the merged directory thanks to mergefs (/merge) you would see:
/merge/TV Shows/Popular TV Show/S01E01.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E02.mkv
/merge/TV Shows/Popular TV Show/S01E04.mkv
/merge/TV Shows/Popular TV Show/S01E05.mkv
None of your applications know that these files have two different real file paths. All new files would always be written to your local HD, then you can use Rclone to sync them to the cloud later. When that sync is completed, its invisible to your apps so you do not need to worry about missing episodes or movies.

==== Setting up mergefs ====
To get started with an Rclone Google Suite Team Drive Mount follow the below instructions.
Instead, setup a <code>/merge</code> with <code>mergerfs</code> that has some <code>/local</code> storage where downloads and imports will live, merge that with your <code>/cloud</code> rclone mount and use the mergerfs create [https://github.com/trapexit/mergerfs#policy-descriptions policy of <code>ff</code> or <code>epff</code>].

<code> /home/{user}/local:/home/{user}/cloud=NC /home/{user}/merge -o rw,async_read=false,statfs_ignore=nc,use_ino,func.getattr=newest,category.action=all,category.create=ff,cache.files=partial,dropcacheonclose=true,nonempty </code>

== Setup ==
Set your download client to download to say <code> /merge/usenet/{tv|movies} </code> and your library to say <code>/merge/media/{TV|Movies}</code>.
Then what happens is the download is local, the import is local. And it all looks like it is in the same place.
In the background, you have a cron or systemd timer that does rsync move from your local storage to your cloud storage.
You can rotate service accounts if needed.
It is also way more efficient at uploading vs. just the rclone mount.

The cloud mount allows sonarr/radarr to delete, rename and read stuff, but big writes don't need to go right to cloud.

If you do get rate limited, it won't impact your imports because they're all local.

<code>/local/media/{tv|movies}</code> //this is where ARR imports to. 
<code>/local/{usenet|torrents}/{tv/movies}</code> // this is where downloads should be dropped to

<code>/cloud/</code> //this is your rclone crypt mount (if going crypt) or GDrive Mount /cloud/media //this is your media folder in Gdrive

<code>/merge/</code> //is /cloud merged into /local/ using mergerfs

<code>/merge/media/{tv|movies}</code> //point plex and ARRs here as library/root folder

and setup remote path in ARR to say remote /local/ is the same as remote /merge/

Files will be downloaded into local and then imported into /local/media/ on a scheduled basis an rclone job would be created to move from local to gdrive so they will then automatically appear in cloud and it'll be like they never left merge

== Recommended Plex Server Changes ==
=== Increase the Default Cache Size of your Plex DB ===
With unlimited storage, some servers may run into database locking/timeout issues. Increasing the default cache size could help alleviate this.
# Stop Plex
# Locate your Plex DB. cd plex/Library/Application Support/Plex Media Server/Plug-in Support/Databases
# Run this command: <code>sqlite3 com.plexapp.plugins.library.db</code>
# The SQLLite prompt will open up. Type this next: <code>PRAGMA default_cache_size = 6000000;</code> and don't forget the trailing semicolon.
# There will be no confirmation that anything happened. Press CTRL + D to exit SqlLite.
# Start Plex.

Template:Installation

2020-12-03T21:01:45Z

Logvin: /* Linux */

<noinclude>
<templatedata>
{
"params": {
"ARRNAME": {
"description": "Name of the ARR",
"example": "Radarr",
"type": "string",
"required": true,
"default": "Fake Radarr"
},
"RunArrCommandLinux": {
"description": "Command to Start & Run ARR Linux",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"RunArrCommandOSX": {
"description": "Command to Start & Run ARR OSX",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"ArrExecutableNameWin": {
"description": "Executable Name for Windows",
"example": "Radarr.exe",
"type": "string",
"required": true
},
"ArrDownloadLink": {
"description": "Link to the Arr Downloads",
"type": "url",
"required": true
},
"ArrLinuxAutoStart": {
"description": "Autostart file instructions",
"required": true
},
"ARRPORT": {
"description": "Port number for the ARR",
"example": "Radarr: 7878, Sonarr: 8989, Lidarr: 8686, Readarr: 8787",
"type": "number",
"default": "7878",
"required": true
},
"ARRNAME2": {
"description": "Used for lowercase ARR names, this is not a required field only used if needed",
"example": "radarr, sonarr, lidarr, readarr",
"type": "string"
}
},
"paramOrder": [
"ARRNAME",
"RunArrCommandLinux",
"RunArrCommandOSX",
"ArrExecutableNameWin",
"ArrDownloadLink",
"ArrLinuxAutoStart",
"ARRPORT",
"ARRNAME2"
],
"description": "This template is expressly for the steps and processes of installing all the various ARR software on multiple different platforms"
}
</templatedata>
</noinclude>

= Installing =
== Windows ==

== OSX ==
{{#lst::Installation Misc|{{{ARRNAME2}}}_osx_big_sur_installation}}

== Linux ==

=== Debian / Ubuntu ===
Most of the "arr" software runs on mono, however newer version may run on .NET Core. If a .NET Core version is available, it will likely offer significant speed and resource enhancements. Some "arr" software supports repository based automatic installs, and some must be installed manually.

===== Mono Install =====
{{#lst::Installation Misc|{{{ARRNAME2}}}_linux_ubuntu_repository_installation}}

====== Manual Install (Mono) ======
Manual Installs need to have dependencies installed first.

Mono:
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
echo "deb https://download.mono-project.com/repo/ubuntu stable-focal main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
sudo apt update && sudo apt install mono-devel
Curl
sudo apt install curl
Mediainfo:
sudo apt install mediainfo
sqlite3:
sudo apt install sqlite3

Now download the newest mono version release of {{{ARRNAME}}}:
wget --content-disposition '{{{ARRPackageFileMono}}}'

Uncompress:
tar -xvzf {{{ARRNAME}}}*.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser

{{#lst::Installation Misc|{{{ARRNAME2}}}_linux_ubuntu_NetCore_manual_installation}}

=== Auto Start Using Systemd ===
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

==== Preparing the Unit Service File ====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that {{{ARRNAME2}}} will run as.
# <code>Group</code> should match the service account group that {{{ARRNAME2}}} will run as.
# <code>ExecStart</code> has several items that should match your installation <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>
## Executable Path Default location is <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>, but you may need to update if you installed {{{ARRNAME}}} elsewhere.
## Data Directory Default location is <code>-data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/</code>, but you may need to update if you want to keep your database and settings elsewhere.
## Mono Path (if Mono is being used) Default location is <code>/usr/bin/mono</code>, but you may need to update if you installed Mono elsewhere.

The unit service file should be named <code>{{{ARRNAME}}}.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>{{{ARRNAME2}}}</code>, {{{ARRNAME}}}'s executable is placed in <code>/opt/{{{ARRNAME}}}/</code>, the data directory is placed in <code>/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}</code>, and the Mono executable (if being used) is placed in <code>/usr/bin/mono</code>.

'''Important note:''' Both <code>ExecStart</code> lines are commented out below. Remove the # from the line matching your install type (Mono vs NetCore).

[Unit]
Description={{{ARRNAME}}} Daemon
After=syslog.target network.target

[Service]
# Change the user and group variables here.
User={{{ARRNAME2}}}
Group={{{ARRNAME2}}}

Type=simple

# NOTE: Uncomment one of the two below ExecStart lines, based on if {{{ARRNAME}}} is using NetCore or Mono.
# NetCore install:
#ExecStart=/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

# Mono Install:
#ExecStart=/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

TimeoutStopSec=20
KillMode=process
Restart=on-failure

[Install]
WantedBy=multi-user.target

==== Verify Directory Permissions ====
Ensure the <code>User</code> that will be running {{{ARRNAME}}} has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder.
Example:
$ ls -lad /opt/{{{ARRNAME}}}
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /opt/{{{ARRNAME}}}/
$ ls -lad /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

==== Enabling and starting the Unit Service File ====
Once you have created <code>{{{ARRNAME}}}.service</code>, you will want to enable the service:
sudo systemctl enable {{{ARRNAME}}}.service

You are now ready to start {{{ARRNAME}}}. You can do so with the <code>start</code> command:
sudo systemctl start {{{ARRNAME}}}.service

If you want to verify {{{ARRNAME}}} is running, you can run the <code>status</code> command:
$ sudo systemctl status {{{ARRNAME}}}.service
● {{{ARRNAME}}}.service - {{{ARRNAME}}}Service
Loaded: loaded (/usr/lib/systemd/system/{{{ARRNAME}}}.service; enabled; vendor preset: disabled)
Active: active (running) since Tue 2017-03-07 10:23:44 PST; 5min ago
Main PID: 19978 ({{{ARRNAME}}})
Tasks: 16 (limit: 4915)
Memory: 114.6M
CPU: 9.331s
CGroup: /system.slice/{{{ARRNAME}}}.service
└─19978 /opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
Mar 07 10:23:44 apollo systemd[1]: Started {{{ARRNAME}}} Service.
=== NGINX Reverse Proxy ===
A reverse proxy allows you to set up {{{ARRNAME}}} so you can access it from the web without using the port number. Rather than mydomain.com:{{{ARRPORT}}} you would use mydomain.com/{{{ARRNAME}}} instead.

(Link to NGINX Install Wiki Page)

Create a text file named {{{ARRNAME}}}.conf and place it in your default NGINX App directory, typically <code>/etc/nginx/conf.d/apps</code>

# {{{ARRNAME}}} Reverse Proxy
# Be sure to set your Base-URL in {{{ARRNAME}}}
location /{{{ARRNAME2}}} {
proxy_pass http://127.0.0.1:{{{ARRPORT}}}/{{{ARRNAME2}}};
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_http_version 1.1;
proxy_no_cache $cookie_session;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $http_connection;
# Allow the {{{ARRNAME}}} API
location /{{{ARRNAME2}}}/api { auth_request off;
proxy_pass http://127.0.0.1:{{{ARRPORT}}}/{{{ARRNAME2}}}/api;
}
}
Please note: It is important to ensure that the line <code>proxy_set_header Connection $http_connection;</code> is accurate. The NGINX documentation recommends setting this to <code>Upgrade</code> rather than <code>$http_connection;</code> but this will NOT work.

Once you have saved the file, test your NGINX config:
sudo nginx -t
Which should show this:
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf test is successful
Now you can have NGINX reload it's configuration to use the new file:
sudo nginx -s reload
Finally, make sure you add your URL Base to {{{ARRNAME}}}. This should match what you have next to the word Location in the {{{ARRNAME}}}.conf file, with the leading slash, likely this: <code>/{{{ARRNAME2}}}</code>
The URL base can be set here: https://wiki.servarr.com/{{{ARRNAME}}}_Settings#Host

== NAS ==
=== FreeNAS ===
=== Qnap ===
=== Synology ===

== Docker ==

== Docker on unRAID ==
* Installation of {{{ARRNAME}}} is quite simple when it comes to unRAID as they have made installing Docker containers a breeze.
<ol style="list-style-type: decimal;">
<li>Simply head on over to the community applications store on the top bar of your browser. </li>
[[File:unraid-install1.png|frameless|750px|alt=Community Applications|Communitty Applications]]
<li>In the search field type in {{{ARRNAME}}} 
</li>
<li>Select which docker image you would like to install. There are several to choose from 
</li>
[[File:{{{ARRNAME}}}-unraid-install.png|frameless|none|750px|alt=Installation Options|Installation Options]]
<li> Depending on which container you go with will determine the steps in which you take. Some containers come preloaded with volumes mapped already. This is really up to your liking how you would like your container volumes to be laid out. It is highly recommended to follow the guide listed [[Docker Guide|here]] for your volume mapping 
</li>
 Depending on which container you select you may recieve a pop up asking you to '''Choose A Branch To Install''' when in doubt go with the <code>Default :latest</code> branch
<li> Once you have selected which container you are going to go with, you will need to either create the volumes for {{{ARRNAME}}} to be able to use or simply use the pre-filled ones. (Highly recommended to remove the pre-filled and use your own, to remove the pre-filled ones). </li>
 To remove the pre-filled paths simply select the toggle in the upper right from '''Basic''' to '''Advanced''' view then scroll down to the pre-filled path and click '''Remove'''
[[File:unraid-install3.png|frameless|750px|alt=Toggle Advanced|Toggle Advanced]]
<ol>
<li> To create new volumes simply select the <code> Add another Path, Port, Variable, Label or Device</code> text at the bottom above the '''Apply''' button. 
</li>
<li> Once the new window appears you will want to use the drop down box next to '''Config Type:''' and make sure that it is set to '''Path'''. 
</li>
<li> From here you will want to fill out all pertinant information: 
</li>
<ol>
<li>'''Name:''' The name of this path, this can be any unique name more like a note to know what this path is for. 
</li>
<li>'''Container Path:''' This will be the path that {{{ARRNAME}}} will see inside the container <code>/data</code> is a favorite 
</li>
<li>'''Host Path:''' This is the path to the host (unRAID) machine, This will be <code>/mnt/user/<Your User Share></code> 
</li>
 '''NOTE''' If you follow the [[Docker Guide]] you will only need one Volume path to be made as all information that {{{ARRNAME}}} will need will be in one share <code>/mnt/user/data</code>
<li> The last three items '''Default Value:''', '''Access Mode"''', and '''Description:''' Can be left alone. 
</li>
<li> Click '''ADD''' 
</li>
[[File:unraid-install4.png|frameless|750px|alt=Add New path|Add New Path]]
</ol>
<li> Last thing to check is to make sure Host Port for {{{ARRPORT}}} is filled in with <code>{{{ARRPORT}}}</code>, ''UNLESS'' This port causes any conflicts with any other container. If it does please choose a different port that is not in use. 
</li>
<li> Click '''APPLY''' 
</li>
</ol>
<li> Now the {{{ARRNAME}}}'s container is being downloaded, once complete simply click the '''OK''' button at the bottom of the new pop up window 
</li>
<li> Click '''DOCKER''' on the top row of your browser. 
</li>
<li> Now all you will need to do is simply left click on your newly created container and select '''WebUI'''. 
</li>
[[File:unraid-install2.png|frameless|none|250x240px|alt=Select WebUI|Select WebUI]]
<li> Now a new browser tab should show up with {{{ARRNAME}}} running in all its glory. '''ENJOY''' 
</li>
</ol>

Cloud Setup

2020-12-02T19:17:10Z

Logvin: /* Increase the Default Cache Size of your Plex DB */

Cloud Setup

2020-12-02T19:14:10Z

Logvin:

Installation Misc

2020-12-02T18:38:48Z

Logvin: /* Manual Install */

== Installation ==
=== Radarr ===
<section begin=radarr_linux_ubuntu_NetCore_manual_installation />
===== .NET Core Install =====
There are no dependencies needed for the .NET Core Install path.

====== Manual Install ======
Go to the Radarr download page, and pick the appropriate file: https://github.com/Radarr/Radarr/releases

[[File:ARR Download Link Example.png|thumb|right|Example of Radarr download options]]
In the example screenshot here, you can see multiple options. Choose the option that matches your OS and processor best. For most users, this would be <code>.linux-core-x64.tar.gz</code> if it is available.

Download this file onto your system: (Note: The link below will target the Linux .NET Core x64 file. Replace if needed with the file you chose previously)
wget --content-disposition 'http://radarr.servarr.com/v1/update/master/updatefile?os=linux&runtime=netcore&arch=x64'
Uncompress:
tar -xvzf Radarr*.linux-core-x64.tar.gz
Move to your preferred install location (typically <code>/opt/Radarr/</code>
sudo mv Radarr/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown radarr:radarr /opt/Radarr

You can start Radarr with the following command:
/opt/Radarr/Radarr -nobrowser
<section end=radarr_linux_ubuntu_NetCore_manual_installation />

=== Sonarr ===
<section begin=sonarr_linux_ubuntu_repository_installation />
====== Repository Install (Mono) ======
Repository installs will typically automatically install needed dependencies.
Add the Sonarr Repository:
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 0xA236C58F409091A18ACA53CBEBFF6B99D9B78493
echo "deb http://apt.sonarr.tv/ master main" | sudo tee /etc/apt/sources.list.d/sonarr.list
Update and install:
sudo apt update
sudo apt install nzbdrone
To start Sonarr, you need to call the mono executable:
/usr/bin/mono --debug /opt/NzbDrone/NzbDrone.exe
<section end=sonarr_linux_ubuntu_repository_installation />

====Big Sur====
<section begin=sonarr_osx_big_sur_installation />
<ol>
<li>After downloading Sonarr V3 from [https://services.sonarr.tv/v1/download/phantom-develop/latest?version=3&os=macos&installer=true here]The <code>zip</code> file will be located in your downloads directory.</li>
<li>After the downlaod has finished you'll need to unzip the file from there you'll have a '''Sonarr.app''' in your downloads folder simply move the '''Sonarr.app''' to your Applications directory.</li>
[[File:Move-sonarr-to-applications.gif|center|frameless|750x750px]]
<li> From there if you go to your launch pad you'll notice that Sonarr is now in there, double click on Sonarr</li>
<li> You'll probably get a pop up that says "Sonarr.app" cannot be opened because the developer cannot be verified.</li>
[[File:sonarr-developer-cannot-be-verified.png|none|frameless|250px]]
<li> Dont fret we can get this fixed.</li>
<ol>
<li>Click on System Preferences in your dock</li>
<li>Click Security and Privacy</li>
<li> Click '''Open Anyways'''</li>
<li> You'll get a pop up that looks something like this:</li>
[[File:sonarr-developer-cannot-be-verified2.png|none|framless|250px]]
<li> Click Open </li>
</ol>
<li> Now since Sonarr uses the Mono Framework Version 5.20 or later if you do not already have that installed you'll recieve a pop up like this</li>
[[File:sonarr-cannot-launch-sonarr-mono.png|none|frameless|250px]]
<ul>
<li>Note: If Mono is already installed skip these steps</li>
</ul>
<ol>
<li> Click Download </li>
<li> Safari (or default browser) will now open up to [https://www.mono-project.com/download/stable/#download-mac the Mono Project] for macOS. Click '''Download mono (Stable channel)'''</li>
<li> Once the download is complete go to your downloads folder and click the new pkg file that was downloaded and install it</li>
<li> After installation is complete go back and reopen Sonarr </li>
</ol>
<li> Now browse to <code>http://localhost:8989</code></li>
</ol>
Now you're all set Sonarr is now up and running on your system Have fun
<section end=sonarr_osx_big_sur_installation />

Installation Misc

2020-12-02T18:38:12Z

Logvin: /* Radarr */

== Installation ==
=== Radarr ===
<section begin=radarr_linux_ubuntu_NetCore_manual_installation />
===== .NET Core Install =====
There are no dependencies needed for the .NET Core Install path.

====== Manual Install ======
Go to the Radarr download page, and pick the appropriate file: https://github.com/Radarr/Radarr/releases

In the example screenshot here, you can see multiple options. Choose the option that matches your OS and processor best. For most users, this would be <code>.linux-core-x64.tar.gz</code> if it is available.
[[File:ARR Download Link Example.png|thumb|right|Example of Radarr download options]]

Download this file onto your system: (Note: The link below will target the Linux .NET Core x64 file. Replace if needed with the file you chose previously)
wget --content-disposition 'http://radarr.servarr.com/v1/update/master/updatefile?os=linux&runtime=netcore&arch=x64'
Uncompress:
tar -xvzf Radarr*.linux-core-x64.tar.gz
Move to your preferred install location (typically <code>/opt/Radarr/</code>
sudo mv Radarr/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown radarr:radarr /opt/Radarr

You can start Radarr with the following command:
/opt/Radarr/Radarr -nobrowser
<section end=radarr_linux_ubuntu_NetCore_manual_installation />

=== Sonarr ===
<section begin=sonarr_linux_ubuntu_repository_installation />
====== Repository Install (Mono) ======
Repository installs will typically automatically install needed dependencies.
Add the Sonarr Repository:
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 0xA236C58F409091A18ACA53CBEBFF6B99D9B78493
echo "deb http://apt.sonarr.tv/ master main" | sudo tee /etc/apt/sources.list.d/sonarr.list
Update and install:
sudo apt update
sudo apt install nzbdrone
To start Sonarr, you need to call the mono executable:
/usr/bin/mono --debug /opt/NzbDrone/NzbDrone.exe
<section end=sonarr_linux_ubuntu_repository_installation />

====Big Sur====
<section begin=sonarr_osx_big_sur_installation />
<ol>
<li>After downloading Sonarr V3 from [https://services.sonarr.tv/v1/download/phantom-develop/latest?version=3&os=macos&installer=true here]The <code>zip</code> file will be located in your downloads directory.</li>
<li>After the downlaod has finished you'll need to unzip the file from there you'll have a '''Sonarr.app''' in your downloads folder simply move the '''Sonarr.app''' to your Applications directory.</li>
[[File:Move-sonarr-to-applications.gif|center|frameless|750x750px]]
<li> From there if you go to your launch pad you'll notice that Sonarr is now in there, double click on Sonarr</li>
<li> You'll probably get a pop up that says "Sonarr.app" cannot be opened because the developer cannot be verified.</li>
[[File:sonarr-developer-cannot-be-verified.png|none|frameless|250px]]
<li> Dont fret we can get this fixed.</li>
<ol>
<li>Click on System Preferences in your dock</li>
<li>Click Security and Privacy</li>
<li> Click '''Open Anyways'''</li>
<li> You'll get a pop up that looks something like this:</li>
[[File:sonarr-developer-cannot-be-verified2.png|none|framless|250px]]
<li> Click Open </li>
</ol>
<li> Now since Sonarr uses the Mono Framework Version 5.20 or later if you do not already have that installed you'll recieve a pop up like this</li>
[[File:sonarr-cannot-launch-sonarr-mono.png|none|frameless|250px]]
<ul>
<li>Note: If Mono is already installed skip these steps</li>
</ul>
<ol>
<li> Click Download </li>
<li> Safari (or default browser) will now open up to [https://www.mono-project.com/download/stable/#download-mac the Mono Project] for macOS. Click '''Download mono (Stable channel)'''</li>
<li> Once the download is complete go to your downloads folder and click the new pkg file that was downloaded and install it</li>
<li> After installation is complete go back and reopen Sonarr </li>
</ol>
<li> Now browse to <code>http://localhost:8989</code></li>
</ol>
Now you're all set Sonarr is now up and running on your system Have fun
<section end=sonarr_osx_big_sur_installation />

Installation Misc

2020-12-02T18:33:16Z

Logvin: /* Installation */

== Installation ==
=== Radarr ===
<section begin=radarr_linux_ubuntu_NetCore_manual_installation />
===== .NET Core Install =====
There are no dependencies needed for the .NET Core Install path.

====== Manual Install ======
Go to the {{{ARRNAME}}} download page, and pick the appropriate file: {{{ArrDownloadLink}}}

In the example screenshot here, you can see multiple options. Choose the option that matches your OS and processor best. For most users, this would be <code>.linux-core-x64.tar.gz</code> if it is available.
[[File:ARR Download Link Example.png|thumb|right|Example of Radarr download options]]

Download this file onto your system:
wget --content-disposition 'http://radarr.servarr.com/v1/update/master/updatefile?os=linux&runtime=netcore&arch=x64'
Uncompress:
tar -xvzf {{{ARRNAME}}}*.linux-core-x64.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser
<section end=radarr_linux_ubuntu_NetCore_manual_installation />

=== Sonarr ===
<section begin=sonarr_linux_ubuntu_repository_installation />
====== Repository Install (Mono) ======
Repository installs will typically automatically install needed dependencies.
Add the Sonarr Repository:
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 0xA236C58F409091A18ACA53CBEBFF6B99D9B78493
echo "deb http://apt.sonarr.tv/ master main" | sudo tee /etc/apt/sources.list.d/sonarr.list
Update and install:
sudo apt update
sudo apt install nzbdrone
To start Sonarr, you need to call the mono executable:
/usr/bin/mono --debug /opt/NzbDrone/NzbDrone.exe
<section end=sonarr_linux_ubuntu_repository_installation />

====Big Sur====
<section begin=sonarr_osx_big_sur_installation />
<ol>
<li>After downloading Sonarr V3 from [https://services.sonarr.tv/v1/download/phantom-develop/latest?version=3&os=macos&installer=true here]The <code>zip</code> file will be located in your downloads directory.</li>
<li>After the downlaod has finished you'll need to unzip the file from there you'll have a '''Sonarr.app''' in your downloads folder simply move the '''Sonarr.app''' to your Applications directory.</li>
[[File:Move-sonarr-to-applications.gif|center|frameless|750x750px]]
<li> From there if you go to your launch pad you'll notice that Sonarr is now in there, double click on Sonarr</li>
<li> You'll probably get a pop up that says "Sonarr.app" cannot be opened because the developer cannot be verified.</li>
[[File:sonarr-developer-cannot-be-verified.png|none|frameless|250px]]
<li> Dont fret we can get this fixed.</li>
<ol>
<li>Click on System Preferences in your dock</li>
<li>Click Security and Privacy</li>
<li> Click '''Open Anyways'''</li>
<li> You'll get a pop up that looks something like this:</li>
[[File:sonarr-developer-cannot-be-verified2.png|none|framless|250px]]
<li> Click Open </li>
</ol>
<li> Now since Sonarr uses the Mono Framework Version 5.20 or later if you do not already have that installed you'll recieve a pop up like this</li>
[[File:sonarr-cannot-launch-sonarr-mono.png|none|frameless|250px]]
<ul>
<li>Note: If Mono is already installed skip these steps</li>
</ul>
<ol>
<li> Click Download </li>
<li> Safari (or default browser) will now open up to [https://www.mono-project.com/download/stable/#download-mac the Mono Project] for macOS. Click '''Download mono (Stable channel)'''</li>
<li> Once the download is complete go to your downloads folder and click the new pkg file that was downloaded and install it</li>
<li> After installation is complete go back and reopen Sonarr </li>
</ol>
<li> Now browse to <code>http://localhost:8989</code></li>
</ol>
Now you're all set Sonarr is now up and running on your system Have fun
<section end=sonarr_osx_big_sur_installation />

Template:Installation

2020-12-02T18:28:43Z

Logvin: /* Debian / Ubuntu */

<noinclude>
<templatedata>
{
"params": {
"ARRNAME": {
"description": "Name of the ARR",
"example": "Radarr",
"type": "string",
"required": true,
"default": "Fake Radarr"
},
"RunArrCommandLinux": {
"description": "Command to Start & Run ARR Linux",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"RunArrCommandOSX": {
"description": "Command to Start & Run ARR OSX",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"ArrExecutableNameWin": {
"description": "Executable Name for Windows",
"example": "Radarr.exe",
"type": "string",
"required": true
},
"ArrDownloadLink": {
"description": "Link to the Arr Downloads",
"type": "url",
"required": true
},
"ArrLinuxAutoStart": {
"description": "Autostart file instructions",
"required": true
},
"ARRPORT": {
"description": "Port number for the ARR",
"example": "Radarr: 7878, Sonarr: 8989, Lidarr: 8686, Readarr: 8787",
"type": "number",
"default": "7878",
"required": true
},
"ARRNAME2": {
"description": "Used for lowercase ARR names, this is not a required field only used if needed",
"example": "radarr, sonarr, lidarr, readarr",
"type": "string"
}
},
"paramOrder": [
"ARRNAME",
"RunArrCommandLinux",
"RunArrCommandOSX",
"ArrExecutableNameWin",
"ArrDownloadLink",
"ArrLinuxAutoStart",
"ARRPORT",
"ARRNAME2"
],
"description": "This template is expressly for the steps and processes of installing all the various ARR software on multiple different platforms"
}
</templatedata>
</noinclude>

= Installing =
== Windows ==

== OSX ==
{{#lst::Installation Misc|{{{ARRNAME2}}}_osx_big_sur_installation}}

== Linux ==

=== Debian / Ubuntu ===
Most of the "arr" software runs on mono, however newer version may run on .NET Core. If a .NET Core version is available, it will likely offer significant speed and resource enhancements. Some "arr" software supports repository based automatic installs, and some must be installed manually.

===== Mono Install =====
{{#lst::Installation Misc|{{{ARRNAME2}}}_linux_ubuntu_repository_installation}}

====== Manual Install (Mono) ======
Manual Installs need to have dependencies installed first.

Mono:
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
echo "deb https://download.mono-project.com/repo/ubuntu stable-focal main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
sudo apt update && sudo apt install mono-devel
Curl
sudo apt install curl
Mediainfo:
sudo apt install mediainfo
sqlite3:
sudo apt install sqlite3

Now download the newest mono version release of {{{ARRNAME}}}:
wget --content-disposition '{{{ARRPackageFileMono}}}'

Uncompress:
tar -xvzf {{{ARRNAME}}}*.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser

{{#lst::Installation Misc|{{{ARRNAME2}}}_linux_ubuntu_NetCore_manual_installation}}

=== Auto Start Using Systemd ===
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

==== Preparing the Unit Service File ====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that {{{ARRNAME2}}} will run as.
# <code>Group</code> should match the service account group that {{{ARRNAME2}}} will run as.
# <code>ExecStart</code> has several items that should match your installation <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>
## Executable Path Default location is <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>, but you may need to update if you installed {{{ARRNAME}}} elsewhere.
## Data Directory Default location is <code>-data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/</code>, but you may need to update if you want to keep your database and settings elsewhere.
## Mono Path (if Mono is being used) Default location is <code>/usr/bin/mono</code>, but you may need to update if you installed Mono elsewhere.

The unit service file should be named <code>{{{ARRNAME}}}.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>{{{ARRNAME2}}}</code>, {{{ARRNAME}}}'s executable is placed in <code>/opt/{{{ARRNAME}}}/</code>, the data directory is placed in <code>/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}</code>, and the Mono executable (if being used) is placed in <code>/usr/bin/mono</code>.

'''Important note:''' Both <code>ExecStart</code> lines are commented out below. Remove the # from the line matching your install type (Mono vs NetCore).

[Unit]
Description={{{ARRNAME}}} Daemon
After=syslog.target network.target

[Service]
# Change the user and group variables here.
User={{{ARRNAME2}}}
Group={{{ARRNAME2}}}

Type=simple

# NOTE: Uncomment one of the two below ExecStart lines, based on if {{{ARRNAME}}} is using NetCore or Mono.
# NetCore install:
#ExecStart=/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

# Mono Install:
#ExecStart=/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

TimeoutStopSec=20
KillMode=process
Restart=on-failure

[Install]
WantedBy=multi-user.target

==== Verify Directory Permissions ====
Ensure the <code>User</code> that will be running {{{ARRNAME}}} has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder.
Example:
$ ls -lad /opt/{{{ARRNAME}}}
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /opt/{{{ARRNAME}}}/
$ ls -lad /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

==== Enabling and starting the Unit Service File ====
Once you have created <code>{{{ARRNAME}}}.service</code>, you will want to enable the service:
sudo systemctl enable {{{ARRNAME}}}.service

You are now ready to start {{{ARRNAME}}}. You can do so with the <code>start</code> command:
sudo systemctl start {{{ARRNAME}}}.service

If you want to verify {{{ARRNAME}}} is running, you can run the <code>status</code> command:
$ sudo systemctl status {{{ARRNAME}}}.service
● {{{ARRNAME}}}.service - {{{ARRNAME}}}Service
Loaded: loaded (/usr/lib/systemd/system/{{{ARRNAME}}}.service; enabled; vendor preset: disabled)
Active: active (running) since Tue 2017-03-07 10:23:44 PST; 5min ago
Main PID: 19978 ({{{ARRNAME}}})
Tasks: 16 (limit: 4915)
Memory: 114.6M
CPU: 9.331s
CGroup: /system.slice/{{{ARRNAME}}}.service
└─19978 /opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
Mar 07 10:23:44 apollo systemd[1]: Started {{{ARRNAME}}} Service.

== NAS ==
=== FreeNAS ===
=== Qnap ===
=== Synology ===

== Docker ==

== Docker on unRAID ==
* Installation of {{{ARRNAME}}} is quite simple when it comes to unRAID as they have made installing Docker containers a breeze.
<ol style="list-style-type: decimal;">
<li>Simply head on over to the community applications store on the top bar of your browser. </li>
[[File:unraid-install1.png|frameless|750px|alt=Community Applications|Communitty Applications]]
<li>In the search field type in {{{ARRNAME}}} 
</li>
<li>Select which docker image you would like to install. There are several to choose from 
</li>
[[File:{{{ARRNAME}}}-unraid-install.png|frameless|none|750px|alt=Installation Options|Installation Options]]
<li> Depending on which container you go with will determine the steps in which you take. Some containers come preloaded with volumes mapped already. This is really up to your liking how you would like your container volumes to be laid out. It is highly recommended to follow the guide listed [[Docker Guide|here]] for your volume mapping 
</li>
 Depending on which container you select you may recieve a pop up asking you to '''Choose A Branch To Install''' when in doubt go with the <code>Default :latest</code> branch
<li> Once you have selected which container you are going to go with, you will need to either create the volumes for {{{ARRNAME}}} to be able to use or simply use the pre-filled ones. (Highly recommended to remove the pre-filled and use your own, to remove the pre-filled ones). </li>
 To remove the pre-filled paths simply select the toggle in the upper right from '''Basic''' to '''Advanced''' view then scroll down to the pre-filled path and click '''Remove'''
[[File:unraid-install3.png|frameless|750px|alt=Toggle Advanced|Toggle Advanced]]
<ol>
<li> To create new volumes simply select the <code> Add another Path, Port, Variable, Label or Device</code> text at the bottom above the '''Apply''' button. 
</li>
<li> Once the new window appears you will want to use the drop down box next to '''Config Type:''' and make sure that it is set to '''Path'''. 
</li>
<li> From here you will want to fill out all pertinant information: 
</li>
<ol>
<li>'''Name:''' The name of this path, this can be any unique name more like a note to know what this path is for. 
</li>
<li>'''Container Path:''' This will be the path that {{{ARRNAME}}} will see inside the container <code>/data</code> is a favorite 
</li>
<li>'''Host Path:''' This is the path to the host (unRAID) machine, This will be <code>/mnt/user/<Your User Share></code> 
</li>
 '''NOTE''' If you follow the [[Docker Guide]] you will only need one Volume path to be made as all information that {{{ARRNAME}}} will need will be in one share <code>/mnt/user/data</code>
<li> The last three items '''Default Value:''', '''Access Mode"''', and '''Description:''' Can be left alone. 
</li>
<li> Click '''ADD''' 
</li>
[[File:unraid-install4.png|frameless|750px|alt=Add New path|Add New Path]]
</ol>
<li> Last thing to check is to make sure Host Port for {{{ARRPORT}}} is filled in with <code>{{{ARRPORT}}}</code>, ''UNLESS'' This port causes any conflicts with any other container. If it does please choose a different port that is not in use. 
</li>
<li> Click '''APPLY''' 
</li>
</ol>
<li> Now the {{{ARRNAME}}}'s container is being downloaded, once complete simply click the '''OK''' button at the bottom of the new pop up window 
</li>
<li> Click '''DOCKER''' on the top row of your browser. 
</li>
<li> Now all you will need to do is simply left click on your newly created container and select '''WebUI'''. 
</li>
[[File:unraid-install2.png|frameless|none|250x240px|alt=Select WebUI|Select WebUI]]
<li> Now a new browser tab should show up with {{{ARRNAME}}} running in all its glory. '''ENJOY''' 
</li>
</ol>

Installation Misc

2020-12-02T18:25:55Z

Logvin: /* Installation */

== Installation ==
=== Radarr ===
<section begin=radarr_linux_ubuntu_NetCore_manual_installation />
===== .NET Core Install =====
There are no dependencies needed for the .NET Core Install path.

====== Manual Install ======
Go to the {{{ARRNAME}}} download page, and pick the appropriate file: {{{ArrDownloadLink}}}

In the example screenshot here, you can see multiple options. Choose the option that matches your OS and processor best. For most users, this would be <code>.linux-core-x64.tar.gz</code> if it is available.
[[File:ARR Download Link Example.png|thumb|right|Example of Radarr download options]]

Download this file onto your system:
wget --content-disposition 'http://radarr.servarr.com/v1/update/master/updatefile?os=linux&runtime=netcore&arch=x64'
Uncompress:
tar -xvzf {{{ARRNAME}}}*.linux-core-x64.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser
<section end=radarr_linux_ubuntu_NetCore_manual_installation />
=== Sonarr ===
<section begin=sonarr_linux_ubuntu_repository_installation />
====== Repository Install ======
Repository installs will typically automatically install needed dependencies.
Add the Sonarr Repository:
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 0xA236C58F409091A18ACA53CBEBFF6B99D9B78493
echo "deb http://apt.sonarr.tv/ master main" | sudo tee /etc/apt/sources.list.d/sonarr.list
Update and install:
sudo apt update
sudo apt install nzbdrone
To start Sonarr, you need to call the mono executable:
/usr/bin/mono --debug /opt/NzbDrone/NzbDrone.exe
<section end=sonarr_linux_ubuntu_repository_installation />

====Big Sur====
<section begin=sonarr_osx_big_sur_installation />
<ol>
<li>After downloading Sonarr V3 from [https://services.sonarr.tv/v1/download/phantom-develop/latest?version=3&os=macos&installer=true here]The <code>zip</code> file will be located in your downloads directory.</li>
<li>After the downlaod has finished you'll need to unzip the file from there you'll have a '''Sonarr.app''' in your downloads folder simply move the '''Sonarr.app''' to your Applications directory.</li>
[[File:Move-sonarr-to-applications.gif|center|frameless|750x750px]]
<li> From there if you go to your launch pad you'll notice that Sonarr is now in there, double click on Sonarr</li>
<li> You'll probably get a pop up that says "Sonarr.app" cannot be opened because the developer cannot be verified.</li>
[[File:sonarr-developer-cannot-be-verified.png|none|frameless|250px]]
<li> Dont fret we can get this fixed.</li>
<ol>
<li>Click on System Preferences in your dock</li>
<li>Click Security and Privacy</li>
<li> Click '''Open Anyways'''</li>
<li> You'll get a pop up that looks something like this:</li>
[[File:sonarr-developer-cannot-be-verified2.png|none|framless|250px]]
<li> Click Open </li>
</ol>
<li> Now since Sonarr uses the Mono Framework Version 5.20 or later if you do not already have that installed you'll recieve a pop up like this</li>
[[File:sonarr-cannot-launch-sonarr-mono.png|none|frameless|250px]]
<ul>
<li>Note: If Mono is already installed skip these steps</li>
</ul>
<ol>
<li> Click Download </li>
<li> Safari (or default browser) will now open up to [https://www.mono-project.com/download/stable/#download-mac the Mono Project] for macOS. Click '''Download mono (Stable channel)'''</li>
<li> Once the download is complete go to your downloads folder and click the new pkg file that was downloaded and install it</li>
<li> After installation is complete go back and reopen Sonarr </li>
</ol>
<li> Now browse to <code>http://localhost:8989</code></li>
</ol>
Now you're all set Sonarr is now up and running on your system Have fun
<section end=sonarr_osx_big_sur_installation />

Installation Misc

2020-12-02T18:25:12Z

Logvin: /* Installation */

== Installation ==
=== Radarr ===
<section begin=radarr_linux_ubuntu_NetCore_manual_installation />
===== .NET Core Install =====
There are no dependencies needed for the .NET Core Install path.

====== Manual Install ======
Go to the {{{ARRNAME}}} download page, and pick the appropriate file: {{{ArrDownloadLink}}}

In the example screenshot here, you can see multiple options. Choose the option that matches your OS and processor best. For most users, this would be <code>.linux-core-x64.tar.gz</code> if it is available.
[[File:ARR Download Link Example.png|thumb|right|Example of Radarr download options]]

Download this file onto your system:
wget --content-disposition 'http://radarr.servarr.com/v1/update/master/updatefile?os=linux&runtime=netcore&arch=x64'
Uncompress:
tar -xvzf {{{ARRNAME}}}*.linux-core-x64.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser
<section end=radarr_linux_ubuntu_NetCore_manual_installation />
=== Sonarr ===
<section begin=sonarr_linux_ubuntu_repository_installation />
====== Repository Install ======
Repository installs will typically automatically install needed dependencies.
Add the Sonarr Repository:
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 0xA236C58F409091A18ACA53CBEBFF6B99D9B78493
echo "deb http://apt.sonarr.tv/ master main" | sudo tee /etc/apt/sources.list.d/sonarr.list
Update and install:
sudo apt update
sudo apt install nzbdrone
To start Sonarr, you need to call the mono executable:
/usr/bin/mono --debug /opt/NzbDrone/NzbDrone.exe
<section end=sonarr_linux_ubuntu_repository_installation />
<section begin=sonarr_linux_ubuntu_NetCore_manual_installation />
Sonarr does not currently support NetCore.
<section end=sonarr_linux_ubuntu_NetCore_manual_installation />
====Big Sur====
<section begin=sonarr_osx_big_sur_installation />
<ol>
<li>After downloading Sonarr V3 from [https://services.sonarr.tv/v1/download/phantom-develop/latest?version=3&os=macos&installer=true here]The <code>zip</code> file will be located in your downloads directory.</li>
<li>After the downlaod has finished you'll need to unzip the file from there you'll have a '''Sonarr.app''' in your downloads folder simply move the '''Sonarr.app''' to your Applications directory.</li>
[[File:Move-sonarr-to-applications.gif|center|frameless|750x750px]]
<li> From there if you go to your launch pad you'll notice that Sonarr is now in there, double click on Sonarr</li>
<li> You'll probably get a pop up that says "Sonarr.app" cannot be opened because the developer cannot be verified.</li>
[[File:sonarr-developer-cannot-be-verified.png|none|frameless|250px]]
<li> Dont fret we can get this fixed.</li>
<ol>
<li>Click on System Preferences in your dock</li>
<li>Click Security and Privacy</li>
<li> Click '''Open Anyways'''</li>
<li> You'll get a pop up that looks something like this:</li>
[[File:sonarr-developer-cannot-be-verified2.png|none|framless|250px]]
<li> Click Open </li>
</ol>
<li> Now since Sonarr uses the Mono Framework Version 5.20 or later if you do not already have that installed you'll recieve a pop up like this</li>
[[File:sonarr-cannot-launch-sonarr-mono.png|none|frameless|250px]]
<ul>
<li>Note: If Mono is already installed skip these steps</li>
</ul>
<ol>
<li> Click Download </li>
<li> Safari (or default browser) will now open up to [https://www.mono-project.com/download/stable/#download-mac the Mono Project] for macOS. Click '''Download mono (Stable channel)'''</li>
<li> Once the download is complete go to your downloads folder and click the new pkg file that was downloaded and install it</li>
<li> After installation is complete go back and reopen Sonarr </li>
</ol>
<li> Now browse to <code>http://localhost:8989</code></li>
</ol>
Now you're all set Sonarr is now up and running on your system Have fun
<section end=sonarr_osx_big_sur_installation />

Template:Installation

2020-12-02T18:23:37Z

Logvin: /* Linux */

<noinclude>
<templatedata>
{
"params": {
"ARRNAME": {
"description": "Name of the ARR",
"example": "Radarr",
"type": "string",
"required": true,
"default": "Fake Radarr"
},
"RunArrCommandLinux": {
"description": "Command to Start & Run ARR Linux",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"RunArrCommandOSX": {
"description": "Command to Start & Run ARR OSX",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"ArrExecutableNameWin": {
"description": "Executable Name for Windows",
"example": "Radarr.exe",
"type": "string",
"required": true
},
"ArrDownloadLink": {
"description": "Link to the Arr Downloads",
"type": "url",
"required": true
},
"ArrLinuxAutoStart": {
"description": "Autostart file instructions",
"required": true
},
"ARRPORT": {
"description": "Port number for the ARR",
"example": "Radarr: 7878, Sonarr: 8989, Lidarr: 8686, Readarr: 8787",
"type": "number",
"default": "7878",
"required": true
},
"ARRNAME2": {
"description": "Used for lowercase ARR names, this is not a required field only used if needed",
"example": "radarr, sonarr, lidarr, readarr",
"type": "string"
}
},
"paramOrder": [
"ARRNAME",
"RunArrCommandLinux",
"RunArrCommandOSX",
"ArrExecutableNameWin",
"ArrDownloadLink",
"ArrLinuxAutoStart",
"ARRPORT",
"ARRNAME2"
],
"description": "This template is expressly for the steps and processes of installing all the various ARR software on multiple different platforms"
}
</templatedata>
</noinclude>

= Installing =
== Windows ==

== OSX ==
{{#lst::Installation Misc|{{{ARRNAME2}}}_osx_big_sur_installation}}

== Linux ==

=== Debian / Ubuntu ===
Most of the "arr" software runs on mono, however newer version may run on .NET Core. If a .NET Core version is available, it will likely offer significant speed and resource enhancements. Some "arr" software supports repository based automatic installs, and some must be installed manually.

===== Mono Install =====
{{#lst::Installation Misc|{{{ARRNAME2}}}_linux_ubuntu_repository_installation}}

====== Manual Install ======
Manual Installs need to have dependencies installed first.

Mono:
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
echo "deb https://download.mono-project.com/repo/ubuntu stable-focal main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
sudo apt update && sudo apt install mono-devel
Curl
sudo apt install curl
Mediainfo:
sudo apt install mediainfo
sqlite3:
sudo apt install sqlite3

Now download the newest mono version release of {{{ARRNAME}}}:
wget --content-disposition '{{{ARRPackageFileMono}}}'

Uncompress:
tar -xvzf {{{ARRNAME}}}*.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser

{{#lst::Installation Misc|{{{ARRNAME2}}}_linux_ubuntu_NetCore_manual_installation}}

=== Auto Start Using Systemd ===
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

==== Preparing the Unit Service File ====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that {{{ARRNAME2}}} will run as.
# <code>Group</code> should match the service account group that {{{ARRNAME2}}} will run as.
# <code>ExecStart</code> has several items that should match your installation <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>
## Executable Path Default location is <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>, but you may need to update if you installed {{{ARRNAME}}} elsewhere.
## Data Directory Default location is <code>-data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/</code>, but you may need to update if you want to keep your database and settings elsewhere.
## Mono Path (if Mono is being used) Default location is <code>/usr/bin/mono</code>, but you may need to update if you installed Mono elsewhere.

The unit service file should be named <code>{{{ARRNAME}}}.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>{{{ARRNAME2}}}</code>, {{{ARRNAME}}}'s executable is placed in <code>/opt/{{{ARRNAME}}}/</code>, the data directory is placed in <code>/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}</code>, and the Mono executable (if being used) is placed in <code>/usr/bin/mono</code>.

'''Important note:''' Both <code>ExecStart</code> lines are commented out below. Remove the # from the line matching your install type (Mono vs NetCore).

[Unit]
Description={{{ARRNAME}}} Daemon
After=syslog.target network.target

[Service]
# Change the user and group variables here.
User={{{ARRNAME2}}}
Group={{{ARRNAME2}}}

Type=simple

# NOTE: Uncomment one of the two below ExecStart lines, based on if {{{ARRNAME}}} is using NetCore or Mono.
# NetCore install:
#ExecStart=/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

# Mono Install:
#ExecStart=/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

TimeoutStopSec=20
KillMode=process
Restart=on-failure

[Install]
WantedBy=multi-user.target

==== Verify Directory Permissions ====
Ensure the <code>User</code> that will be running {{{ARRNAME}}} has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder.
Example:
$ ls -lad /opt/{{{ARRNAME}}}
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /opt/{{{ARRNAME}}}/
$ ls -lad /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

==== Enabling and starting the Unit Service File ====
Once you have created <code>{{{ARRNAME}}}.service</code>, you will want to enable the service:
sudo systemctl enable {{{ARRNAME}}}.service

You are now ready to start {{{ARRNAME}}}. You can do so with the <code>start</code> command:
sudo systemctl start {{{ARRNAME}}}.service

If you want to verify {{{ARRNAME}}} is running, you can run the <code>status</code> command:
$ sudo systemctl status {{{ARRNAME}}}.service
● {{{ARRNAME}}}.service - {{{ARRNAME}}}Service
Loaded: loaded (/usr/lib/systemd/system/{{{ARRNAME}}}.service; enabled; vendor preset: disabled)
Active: active (running) since Tue 2017-03-07 10:23:44 PST; 5min ago
Main PID: 19978 ({{{ARRNAME}}})
Tasks: 16 (limit: 4915)
Memory: 114.6M
CPU: 9.331s
CGroup: /system.slice/{{{ARRNAME}}}.service
└─19978 /opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
Mar 07 10:23:44 apollo systemd[1]: Started {{{ARRNAME}}} Service.

== NAS ==
=== FreeNAS ===
=== Qnap ===
=== Synology ===

== Docker ==

== Docker on unRAID ==
* Installation of {{{ARRNAME}}} is quite simple when it comes to unRAID as they have made installing Docker containers a breeze.
<ol style="list-style-type: decimal;">
<li>Simply head on over to the community applications store on the top bar of your browser. </li>
[[File:unraid-install1.png|frameless|750px|alt=Community Applications|Communitty Applications]]
<li>In the search field type in {{{ARRNAME}}} 
</li>
<li>Select which docker image you would like to install. There are several to choose from 
</li>
[[File:{{{ARRNAME}}}-unraid-install.png|frameless|none|750px|alt=Installation Options|Installation Options]]
<li> Depending on which container you go with will determine the steps in which you take. Some containers come preloaded with volumes mapped already. This is really up to your liking how you would like your container volumes to be laid out. It is highly recommended to follow the guide listed [[Docker Guide|here]] for your volume mapping 
</li>
 Depending on which container you select you may recieve a pop up asking you to '''Choose A Branch To Install''' when in doubt go with the <code>Default :latest</code> branch
<li> Once you have selected which container you are going to go with, you will need to either create the volumes for {{{ARRNAME}}} to be able to use or simply use the pre-filled ones. (Highly recommended to remove the pre-filled and use your own, to remove the pre-filled ones). </li>
 To remove the pre-filled paths simply select the toggle in the upper right from '''Basic''' to '''Advanced''' view then scroll down to the pre-filled path and click '''Remove'''
[[File:unraid-install3.png|frameless|750px|alt=Toggle Advanced|Toggle Advanced]]
<ol>
<li> To create new volumes simply select the <code> Add another Path, Port, Variable, Label or Device</code> text at the bottom above the '''Apply''' button. 
</li>
<li> Once the new window appears you will want to use the drop down box next to '''Config Type:''' and make sure that it is set to '''Path'''. 
</li>
<li> From here you will want to fill out all pertinant information: 
</li>
<ol>
<li>'''Name:''' The name of this path, this can be any unique name more like a note to know what this path is for. 
</li>
<li>'''Container Path:''' This will be the path that {{{ARRNAME}}} will see inside the container <code>/data</code> is a favorite 
</li>
<li>'''Host Path:''' This is the path to the host (unRAID) machine, This will be <code>/mnt/user/<Your User Share></code> 
</li>
 '''NOTE''' If you follow the [[Docker Guide]] you will only need one Volume path to be made as all information that {{{ARRNAME}}} will need will be in one share <code>/mnt/user/data</code>
<li> The last three items '''Default Value:''', '''Access Mode"''', and '''Description:''' Can be left alone. 
</li>
<li> Click '''ADD''' 
</li>
[[File:unraid-install4.png|frameless|750px|alt=Add New path|Add New Path]]
</ol>
<li> Last thing to check is to make sure Host Port for {{{ARRPORT}}} is filled in with <code>{{{ARRPORT}}}</code>, ''UNLESS'' This port causes any conflicts with any other container. If it does please choose a different port that is not in use. 
</li>
<li> Click '''APPLY''' 
</li>
</ol>
<li> Now the {{{ARRNAME}}}'s container is being downloaded, once complete simply click the '''OK''' button at the bottom of the new pop up window 
</li>
<li> Click '''DOCKER''' on the top row of your browser. 
</li>
<li> Now all you will need to do is simply left click on your newly created container and select '''WebUI'''. 
</li>
[[File:unraid-install2.png|frameless|none|250x240px|alt=Select WebUI|Select WebUI]]
<li> Now a new browser tab should show up with {{{ARRNAME}}} running in all its glory. '''ENJOY''' 
</li>
</ol>

Installation Misc

2020-12-02T18:23:31Z

Logvin:

== Installation ==
=== Radarr ===
<section begin=radarr_linux_ubuntu_repository_installation />
Radarr does not currently support repository installation.
<section end=radarr_linux_ubuntu_repository_installation />
<section begin=radarr_linux_ubuntu_NetCore_manual_installation />
===== .NET Core Install =====
There are no dependencies needed for the .NET Core Install path.

====== Manual Install ======
Go to the {{{ARRNAME}}} download page, and pick the appropriate file: {{{ArrDownloadLink}}}

In the example screenshot here, you can see multiple options. Choose the option that matches your OS and processor best. For most users, this would be <code>.linux-core-x64.tar.gz</code> if it is available.
[[File:ARR Download Link Example.png|thumb|right|Example of Radarr download options]]

Download this file onto your system:
wget --content-disposition 'http://radarr.servarr.com/v1/update/master/updatefile?os=linux&runtime=netcore&arch=x64'
Uncompress:
tar -xvzf {{{ARRNAME}}}*.linux-core-x64.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser
<section end=radarr_linux_ubuntu_NetCore_manual_installation />
=== Sonarr ===
<section begin=sonarr_linux_ubuntu_repository_installation />
====== Repository Install ======
Repository installs will typically automatically install needed dependencies.
Add the Sonarr Repository:
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 0xA236C58F409091A18ACA53CBEBFF6B99D9B78493
echo "deb http://apt.sonarr.tv/ master main" | sudo tee /etc/apt/sources.list.d/sonarr.list
Update and install:
sudo apt update
sudo apt install nzbdrone
To start Sonarr, you need to call the mono executable:
/usr/bin/mono --debug /opt/NzbDrone/NzbDrone.exe
<section end=sonarr_linux_ubuntu_repository_installation />
<section begin=sonarr_linux_ubuntu_NetCore_manual_installation />
Sonarr does not currently support NetCore.
<section end=sonarr_linux_ubuntu_NetCore_manual_installation />
====Big Sur====
<section begin=sonarr_osx_big_sur_installation />
<ol>
<li>After downloading Sonarr V3 from [https://services.sonarr.tv/v1/download/phantom-develop/latest?version=3&os=macos&installer=true here]The <code>zip</code> file will be located in your downloads directory.</li>
<li>After the downlaod has finished you'll need to unzip the file from there you'll have a '''Sonarr.app''' in your downloads folder simply move the '''Sonarr.app''' to your Applications directory.</li>
[[File:Move-sonarr-to-applications.gif|center|frameless|750x750px]]
<li> From there if you go to your launch pad you'll notice that Sonarr is now in there, double click on Sonarr</li>
<li> You'll probably get a pop up that says "Sonarr.app" cannot be opened because the developer cannot be verified.</li>
[[File:sonarr-developer-cannot-be-verified.png|none|frameless|250px]]
<li> Dont fret we can get this fixed.</li>
<ol>
<li>Click on System Preferences in your dock</li>
<li>Click Security and Privacy</li>
<li> Click '''Open Anyways'''</li>
<li> You'll get a pop up that looks something like this:</li>
[[File:sonarr-developer-cannot-be-verified2.png|none|framless|250px]]
<li> Click Open </li>
</ol>
<li> Now since Sonarr uses the Mono Framework Version 5.20 or later if you do not already have that installed you'll recieve a pop up like this</li>
[[File:sonarr-cannot-launch-sonarr-mono.png|none|frameless|250px]]
<ul>
<li>Note: If Mono is already installed skip these steps</li>
</ul>
<ol>
<li> Click Download </li>
<li> Safari (or default browser) will now open up to [https://www.mono-project.com/download/stable/#download-mac the Mono Project] for macOS. Click '''Download mono (Stable channel)'''</li>
<li> Once the download is complete go to your downloads folder and click the new pkg file that was downloaded and install it</li>
<li> After installation is complete go back and reopen Sonarr </li>
</ol>
<li> Now browse to <code>http://localhost:8989</code></li>
</ol>
Now you're all set Sonarr is now up and running on your system Have fun
<section end=sonarr_osx_big_sur_installation />

Installation Misc

2020-12-02T18:21:16Z

Logvin:

== Installation ==
=== Radarr ===
<section begin=radarr_linux_ubuntu_repository_installation />
Radarr does not currently support repository installation.
<section end=radarr_linux_ubuntu_repository_installation />
<section begin=radarr_linux_ubuntu_NetCore_manual_installation />
====== Manual Install ======
Go to the {{{ARRNAME}}} download page, and pick the appropriate file: {{{ArrDownloadLink}}}

In the example screenshot here, you can see multiple options. Choose the option that matches your OS and processor best. For most users, this would be <code>.linux-core-x64.tar.gz</code> if it is available.
[[File:ARR Download Link Example.png|thumb|right|Example of Radarr download options]]

Download this file onto your system:
wget --content-disposition 'http://radarr.servarr.com/v1/update/master/updatefile?os=linux&runtime=netcore&arch=x64'
Uncompress:
tar -xvzf {{{ARRNAME}}}*.linux-core-x64.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser
<section end=radarr_linux_ubuntu_NetCore_manual_installation />
=== Sonarr ===
<section begin=sonarr_linux_ubuntu_repository_installation />
====== Repository Install ======
Repository installs will typically automatically install needed dependencies.
Add the Sonarr Repository:
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 0xA236C58F409091A18ACA53CBEBFF6B99D9B78493
echo "deb http://apt.sonarr.tv/ master main" | sudo tee /etc/apt/sources.list.d/sonarr.list
Update and install:
sudo apt update
sudo apt install nzbdrone
To start Sonarr, you need to call the mono executable:
/usr/bin/mono --debug /opt/NzbDrone/NzbDrone.exe
<section end=sonarr_linux_ubuntu_repository_installation />
<section begin=sonarr_linux_ubuntu_NetCore_manual_installation />
Sonarr does not currently support NetCore.
<section end=sonarr_linux_ubuntu_NetCore_manual_installation />
====Big Sur====
<section begin=sonarr_osx_big_sur_installation />
<ol>
<li>After downloading Sonarr V3 from [https://services.sonarr.tv/v1/download/phantom-develop/latest?version=3&os=macos&installer=true here]The <code>zip</code> file will be located in your downloads directory.</li>
<li>After the downlaod has finished you'll need to unzip the file from there you'll have a '''Sonarr.app''' in your downloads folder simply move the '''Sonarr.app''' to your Applications directory.</li>
[[File:Move-sonarr-to-applications.gif|center|frameless|750x750px]]
<li> From there if you go to your launch pad you'll notice that Sonarr is now in there, double click on Sonarr</li>
<li> You'll probably get a pop up that says "Sonarr.app" cannot be opened because the developer cannot be verified.</li>
[[File:sonarr-developer-cannot-be-verified.png|none|frameless|250px]]
<li> Dont fret we can get this fixed.</li>
<ol>
<li>Click on System Preferences in your dock</li>
<li>Click Security and Privacy</li>
<li> Click '''Open Anyways'''</li>
<li> You'll get a pop up that looks something like this:</li>
[[File:sonarr-developer-cannot-be-verified2.png|none|framless|250px]]
<li> Click Open </li>
</ol>
<li> Now since Sonarr uses the Mono Framework Version 5.20 or later if you do not already have that installed you'll recieve a pop up like this</li>
[[File:sonarr-cannot-launch-sonarr-mono.png|none|frameless|250px]]
<ul>
<li>Note: If Mono is already installed skip these steps</li>
</ul>
<ol>
<li> Click Download </li>
<li> Safari (or default browser) will now open up to [https://www.mono-project.com/download/stable/#download-mac the Mono Project] for macOS. Click '''Download mono (Stable channel)'''</li>
<li> Once the download is complete go to your downloads folder and click the new pkg file that was downloaded and install it</li>
<li> After installation is complete go back and reopen Sonarr </li>
</ol>
<li> Now browse to <code>http://localhost:8989</code></li>
</ol>
Now you're all set Sonarr is now up and running on your system Have fun
<section end=sonarr_osx_big_sur_installation />

Installation Misc

2020-12-02T18:10:26Z

Logvin:

Template:Installation

2020-12-02T18:07:36Z

Logvin: /* Mono Install */

<noinclude>
<templatedata>
{
"params": {
"ARRNAME": {
"description": "Name of the ARR",
"example": "Radarr",
"type": "string",
"required": true,
"default": "Fake Radarr"
},
"RunArrCommandLinux": {
"description": "Command to Start & Run ARR Linux",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"RunArrCommandOSX": {
"description": "Command to Start & Run ARR OSX",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"ArrExecutableNameWin": {
"description": "Executable Name for Windows",
"example": "Radarr.exe",
"type": "string",
"required": true
},
"ArrDownloadLink": {
"description": "Link to the Arr Downloads",
"type": "url",
"required": true
},
"ArrLinuxAutoStart": {
"description": "Autostart file instructions",
"required": true
},
"ARRPORT": {
"description": "Port number for the ARR",
"example": "Radarr: 7878, Sonarr: 8989, Lidarr: 8686, Readarr: 8787",
"type": "number",
"default": "7878",
"required": true
},
"ARRNAME2": {
"description": "Used for lowercase ARR names, this is not a required field only used if needed",
"example": "radarr, sonarr, lidarr, readarr",
"type": "string"
}
},
"paramOrder": [
"ARRNAME",
"RunArrCommandLinux",
"RunArrCommandOSX",
"ArrExecutableNameWin",
"ArrDownloadLink",
"ArrLinuxAutoStart",
"ARRPORT",
"ARRNAME2"
],
"description": "This template is expressly for the steps and processes of installing all the various ARR software on multiple different platforms"
}
</templatedata>
</noinclude>

= Installing =
== Windows ==

== OSX ==
{{#lst::Installation Misc|{{{ARRNAME2}}}_osx_big_sur_installation}}

== Linux ==

=== Debian / Ubuntu ===
Most of the "arr" software runs on mono, however newer version may run on .NET Core. If a .NET Core version is available, it will likely offer significant speed and resource enhancements.

===== Mono Install =====
Some "arr" software supports repository based automatic installs, and some must be installed manually.

====== Repository Install ======
Repository installs will typically automatically install needed dependencies.
{{#lst::Installation Misc|{{{ARRNAME2}}}_linux_ubuntu_repository_installation}}

====== Manual Install ======
Manual Installs need to have dependencies installed first.

Mono:
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
echo "deb https://download.mono-project.com/repo/ubuntu stable-focal main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
sudo apt update && sudo apt install mono-devel
Curl
sudo apt install curl
Mediainfo:
sudo apt install mediainfo
sqlite3:
sudo apt install sqlite3

Now download the newest mono version release of {{{ARRNAME}}}:
wget --content-disposition '{{{ARRPackageFileMono}}}'

Uncompress:
tar -xvzf {{{ARRNAME}}}*.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser

===== .NET Core Install =====
There are no dependencies needed for the .NET Core Install path.

====== Manual Install ======
Go to the {{{ARRNAME}}} download page, and pick the appropriate file. Note that only Radarr currently has a .NET Core install path right now.

In the example screenshot here, you can see multiple options. Choose the option that matches your OS and processor best. For most users, this would be <code>.linux-core-x64.tar.gz</code> if it is available.
[[File:ARR Download Link Example.png|thumb|right|Example of Radarr download options]]

Download this file onto your system:
{{{ArrDownloadLink}}}

Radarr:
wget --content-disposition 'http://radarr.servarr.com/v1/update/master/updatefile?os=linux&runtime=netcore&arch=x64'
Uncompress:
tar -xvzf {{{ARRNAME}}}*.linux-core-x64.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser

=== Auto Start Using Systemd ===
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

==== Preparing the Unit Service File ====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that {{{ARRNAME2}}} will run as.
# <code>Group</code> should match the service account group that {{{ARRNAME2}}} will run as.
# <code>ExecStart</code> has several items that should match your installation <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>
## Executable Path Default location is <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>, but you may need to update if you installed {{{ARRNAME}}} elsewhere.
## Data Directory Default location is <code>-data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/</code>, but you may need to update if you want to keep your database and settings elsewhere.
## Mono Path (if Mono is being used) Default location is <code>/usr/bin/mono</code>, but you may need to update if you installed Mono elsewhere.

The unit service file should be named <code>{{{ARRNAME}}}.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>{{{ARRNAME2}}}</code>, {{{ARRNAME}}}'s executable is placed in <code>/opt/{{{ARRNAME}}}/</code>, the data directory is placed in <code>/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}</code>, and the Mono executable (if being used) is placed in <code>/usr/bin/mono</code>.

'''Important note:''' Both <code>ExecStart</code> lines are commented out below. Remove the # from the line matching your install type (Mono vs NetCore).

[Unit]
Description={{{ARRNAME}}} Daemon
After=syslog.target network.target

[Service]
# Change the user and group variables here.
User={{{ARRNAME2}}}
Group={{{ARRNAME2}}}

Type=simple

# NOTE: Uncomment one of the two below ExecStart lines, based on if {{{ARRNAME}}} is using NetCore or Mono.
# NetCore install:
#ExecStart=/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

# Mono Install:
#ExecStart=/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

TimeoutStopSec=20
KillMode=process
Restart=on-failure

[Install]
WantedBy=multi-user.target

==== Verify Directory Permissions ====
Ensure the <code>User</code> that will be running {{{ARRNAME}}} has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder.
Example:
$ ls -lad /opt/{{{ARRNAME}}}
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /opt/{{{ARRNAME}}}/
$ ls -lad /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

==== Enabling and starting the Unit Service File ====
Once you have created <code>{{{ARRNAME}}}.service</code>, you will want to enable the service:
sudo systemctl enable {{{ARRNAME}}}.service

You are now ready to start {{{ARRNAME}}}. You can do so with the <code>start</code> command:
sudo systemctl start {{{ARRNAME}}}.service

If you want to verify {{{ARRNAME}}} is running, you can run the <code>status</code> command:
$ sudo systemctl status {{{ARRNAME}}}.service
● {{{ARRNAME}}}.service - {{{ARRNAME}}}Service
Loaded: loaded (/usr/lib/systemd/system/{{{ARRNAME}}}.service; enabled; vendor preset: disabled)
Active: active (running) since Tue 2017-03-07 10:23:44 PST; 5min ago
Main PID: 19978 ({{{ARRNAME}}})
Tasks: 16 (limit: 4915)
Memory: 114.6M
CPU: 9.331s
CGroup: /system.slice/{{{ARRNAME}}}.service
└─19978 /opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
Mar 07 10:23:44 apollo systemd[1]: Started {{{ARRNAME}}} Service.

== NAS ==
=== FreeNAS ===
=== Qnap ===
=== Synology ===

== Docker ==

== Docker on unRAID ==
* Installation of {{{ARRNAME}}} is quite simple when it comes to unRAID as they have made installing Docker containers a breeze.
<ol style="list-style-type: decimal;">
<li>Simply head on over to the community applications store on the top bar of your browser. </li>
[[File:unraid-install1.png|frameless|750px|alt=Community Applications|Communitty Applications]]
<li>In the search field type in {{{ARRNAME}}} 
</li>
<li>Select which docker image you would like to install. There are several to choose from 
</li>
[[File:{{{ARRNAME}}}-unraid-install.png|frameless|none|750px|alt=Installation Options|Installation Options]]
<li> Depending on which container you go with will determine the steps in which you take. Some containers come preloaded with volumes mapped already. This is really up to your liking how you would like your container volumes to be laid out. It is highly recommended to follow the guide listed [[Docker Guide|here]] for your volume mapping 
</li>
 Depending on which container you select you may recieve a pop up asking you to '''Choose A Branch To Install''' when in doubt go with the <code>Default :latest</code> branch
<li> Once you have selected which container you are going to go with, you will need to either create the volumes for {{{ARRNAME}}} to be able to use or simply use the pre-filled ones. (Highly recommended to remove the pre-filled and use your own, to remove the pre-filled ones). </li>
 To remove the pre-filled paths simply select the toggle in the upper right from '''Basic''' to '''Advanced''' view then scroll down to the pre-filled path and click '''Remove'''
[[File:unraid-install3.png|frameless|750px|alt=Toggle Advanced|Toggle Advanced]]
<ol>
<li> To create new volumes simply select the <code> Add another Path, Port, Variable, Label or Device</code> text at the bottom above the '''Apply''' button. 
</li>
<li> Once the new window appears you will want to use the drop down box next to '''Config Type:''' and make sure that it is set to '''Path'''. 
</li>
<li> From here you will want to fill out all pertinant information: 
</li>
<ol>
<li>'''Name:''' The name of this path, this can be any unique name more like a note to know what this path is for. 
</li>
<li>'''Container Path:''' This will be the path that {{{ARRNAME}}} will see inside the container <code>/data</code> is a favorite 
</li>
<li>'''Host Path:''' This is the path to the host (unRAID) machine, This will be <code>/mnt/user/<Your User Share></code> 
</li>
 '''NOTE''' If you follow the [[Docker Guide]] you will only need one Volume path to be made as all information that {{{ARRNAME}}} will need will be in one share <code>/mnt/user/data</code>
<li> The last three items '''Default Value:''', '''Access Mode"''', and '''Description:''' Can be left alone. 
</li>
<li> Click '''ADD''' 
</li>
[[File:unraid-install4.png|frameless|750px|alt=Add New path|Add New Path]]
</ol>
<li> Last thing to check is to make sure Host Port for {{{ARRPORT}}} is filled in with <code>{{{ARRPORT}}}</code>, ''UNLESS'' This port causes any conflicts with any other container. If it does please choose a different port that is not in use. 
</li>
<li> Click '''APPLY''' 
</li>
</ol>
<li> Now the {{{ARRNAME}}}'s container is being downloaded, once complete simply click the '''OK''' button at the bottom of the new pop up window 
</li>
<li> Click '''DOCKER''' on the top row of your browser. 
</li>
<li> Now all you will need to do is simply left click on your newly created container and select '''WebUI'''. 
</li>
[[File:unraid-install2.png|frameless|none|250x240px|alt=Select WebUI|Select WebUI]]
<li> Now a new browser tab should show up with {{{ARRNAME}}} running in all its glory. '''ENJOY''' 
</li>
</ol>

Template:Installation

2020-12-02T17:39:25Z

Logvin: /* Manual Install */

<noinclude>
<templatedata>
{
"params": {
"ARRNAME": {
"description": "Name of the ARR",
"example": "Radarr",
"type": "string",
"required": true,
"default": "Fake Radarr"
},
"RunArrCommandLinux": {
"description": "Command to Start & Run ARR Linux",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"RunArrCommandOSX": {
"description": "Command to Start & Run ARR OSX",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"ArrExecutableNameWin": {
"description": "Executable Name for Windows",
"example": "Radarr.exe",
"type": "string",
"required": true
},
"ArrDownloadLink": {
"description": "Link to the Arr Downloads",
"type": "url",
"required": true
},
"ArrLinuxAutoStart": {
"description": "Autostart file instructions",
"required": true
},
"ARRPORT": {
"description": "Port number for the ARR",
"example": "Radarr: 7878, Sonarr: 8989, Lidarr: 8686, Readarr: 8787",
"type": "number",
"default": "7878",
"required": true
},
"ARRNAME2": {
"description": "Used for lowercase ARR names, this is not a required field only used if needed",
"example": "radarr, sonarr, lidarr, readarr",
"type": "string"
}
},
"paramOrder": [
"ARRNAME",
"RunArrCommandLinux",
"RunArrCommandOSX",
"ArrExecutableNameWin",
"ArrDownloadLink",
"ArrLinuxAutoStart",
"ARRPORT",
"ARRNAME2"
],
"description": "This template is expressly for the steps and processes of installing all the various ARR software on multiple different platforms"
}
</templatedata>
</noinclude>

= Installing =
== Windows ==

== OSX ==
{{#lst::Installation Misc|{{{ARRNAME2}}}_osx_big_sur_installation}}

== Linux ==

=== Debian / Ubuntu ===
Most of the "arr" software runs on mono, however newer version may run on .NET Core. If a .NET Core version is available, it will likely offer significant speed and resource enhancements.

===== Mono Install =====
Some "arr" software supports repository based automatic installs, and some must be installed manually. Repository installs will typically automatically install needed dependencies.

====== Repository Install ======

Sonarr:
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 0xA236C58F409091A18ACA53CBEBFF6B99D9B78493
echo "deb http://apt.sonarr.tv/ master main" | sudo tee /etc/apt/sources.list.d/sonarr.list
sudo apt update
sudo apt install nzbdrone
To start Sonarr, you need to call the mono executable:
/usr/bin/mono --debug /opt/NzbDrone/NzbDrone.exe

====== Manual Install ======
First start by installing the dependencies:

Mono:
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
echo "deb https://download.mono-project.com/repo/ubuntu stable-focal main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
sudo apt update && sudo apt install mono-devel
Curl
sudo apt install curl
Mediainfo:
sudo apt install mediainfo
sqlite3:
sudo apt install sqlite3

Now download the newest mono version release of {{{ARRNAME}}}:
wget --content-disposition '{{{ARRPackageFileMono}}}'

Uncompress:
tar -xvzf {{{ARRNAME}}}*.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser

===== .NET Core Install =====
There are no dependencies needed for the .NET Core Install path.

====== Manual Install ======
Go to the {{{ARRNAME}}} download page, and pick the appropriate file. Note that only Radarr currently has a .NET Core install path right now.

In the example screenshot here, you can see multiple options. Choose the option that matches your OS and processor best. For most users, this would be <code>.linux-core-x64.tar.gz</code> if it is available.
[[File:ARR Download Link Example.png|thumb|right|Example of Radarr download options]]

Download this file onto your system:
{{{ArrDownloadLink}}}

Radarr:
wget --content-disposition 'http://radarr.servarr.com/v1/update/master/updatefile?os=linux&runtime=netcore&arch=x64'
Uncompress:
tar -xvzf {{{ARRNAME}}}*.linux-core-x64.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser

=== Auto Start Using Systemd ===
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

==== Preparing the Unit Service File ====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that {{{ARRNAME2}}} will run as.
# <code>Group</code> should match the service account group that {{{ARRNAME2}}} will run as.
# <code>ExecStart</code> has several items that should match your installation <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>
## Executable Path Default location is <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>, but you may need to update if you installed {{{ARRNAME}}} elsewhere.
## Data Directory Default location is <code>-data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/</code>, but you may need to update if you want to keep your database and settings elsewhere.
## Mono Path (if Mono is being used) Default location is <code>/usr/bin/mono</code>, but you may need to update if you installed Mono elsewhere.

The unit service file should be named <code>{{{ARRNAME}}}.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>{{{ARRNAME2}}}</code>, {{{ARRNAME}}}'s executable is placed in <code>/opt/{{{ARRNAME}}}/</code>, the data directory is placed in <code>/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}</code>, and the Mono executable (if being used) is placed in <code>/usr/bin/mono</code>.

'''Important note:''' Both <code>ExecStart</code> lines are commented out below. Remove the # from the line matching your install type (Mono vs NetCore).

[Unit]
Description={{{ARRNAME}}} Daemon
After=syslog.target network.target

[Service]
# Change the user and group variables here.
User={{{ARRNAME2}}}
Group={{{ARRNAME2}}}

Type=simple

# NOTE: Uncomment one of the two below ExecStart lines, based on if {{{ARRNAME}}} is using NetCore or Mono.
# NetCore install:
#ExecStart=/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

# Mono Install:
#ExecStart=/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

TimeoutStopSec=20
KillMode=process
Restart=on-failure

[Install]
WantedBy=multi-user.target

==== Verify Directory Permissions ====
Ensure the <code>User</code> that will be running {{{ARRNAME}}} has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder.
Example:
$ ls -lad /opt/{{{ARRNAME}}}
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /opt/{{{ARRNAME}}}/
$ ls -lad /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

==== Enabling and starting the Unit Service File ====
Once you have created <code>{{{ARRNAME}}}.service</code>, you will want to enable the service:
sudo systemctl enable {{{ARRNAME}}}.service

You are now ready to start {{{ARRNAME}}}. You can do so with the <code>start</code> command:
sudo systemctl start {{{ARRNAME}}}.service

If you want to verify {{{ARRNAME}}} is running, you can run the <code>status</code> command:
$ sudo systemctl status {{{ARRNAME}}}.service
● {{{ARRNAME}}}.service - {{{ARRNAME}}}Service
Loaded: loaded (/usr/lib/systemd/system/{{{ARRNAME}}}.service; enabled; vendor preset: disabled)
Active: active (running) since Tue 2017-03-07 10:23:44 PST; 5min ago
Main PID: 19978 ({{{ARRNAME}}})
Tasks: 16 (limit: 4915)
Memory: 114.6M
CPU: 9.331s
CGroup: /system.slice/{{{ARRNAME}}}.service
└─19978 /opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
Mar 07 10:23:44 apollo systemd[1]: Started {{{ARRNAME}}} Service.

== NAS ==
=== FreeNAS ===
=== Qnap ===
=== Synology ===

== Docker ==

== Docker on unRAID ==
* Installation of {{{ARRNAME}}} is quite simple when it comes to unRAID as they have made installing Docker containers a breeze.
<ol style="list-style-type: decimal;">
<li>Simply head on over to the community applications store on the top bar of your browser. </li>
[[File:unraid-install1.png|frameless|750px|alt=Community Applications|Communitty Applications]]
<li>In the search field type in {{{ARRNAME}}} 
</li>
<li>Select which docker image you would like to install. There are several to choose from 
</li>
[[File:{{{ARRNAME}}}-unraid-install.png|frameless|none|750px|alt=Installation Options|Installation Options]]
<li> Depending on which container you go with will determine the steps in which you take. Some containers come preloaded with volumes mapped already. This is really up to your liking how you would like your container volumes to be laid out. It is highly recommended to follow the guide listed [[Docker Guide|here]] for your volume mapping 
</li>
 Depending on which container you select you may recieve a pop up asking you to '''Choose A Branch To Install''' when in doubt go with the <code>Default :latest</code> branch
<li> Once you have selected which container you are going to go with, you will need to either create the volumes for {{{ARRNAME}}} to be able to use or simply use the pre-filled ones. (Highly recommended to remove the pre-filled and use your own, to remove the pre-filled ones). </li>
 To remove the pre-filled paths simply select the toggle in the upper right from '''Basic''' to '''Advanced''' view then scroll down to the pre-filled path and click '''Remove'''
[[File:unraid-install3.png|frameless|750px|alt=Toggle Advanced|Toggle Advanced]]
<ol>
<li> To create new volumes simply select the <code> Add another Path, Port, Variable, Label or Device</code> text at the bottom above the '''Apply''' button. 
</li>
<li> Once the new window appears you will want to use the drop down box next to '''Config Type:''' and make sure that it is set to '''Path'''. 
</li>
<li> From here you will want to fill out all pertinant information: 
</li>
<ol>
<li>'''Name:''' The name of this path, this can be any unique name more like a note to know what this path is for. 
</li>
<li>'''Container Path:''' This will be the path that {{{ARRNAME}}} will see inside the container <code>/data</code> is a favorite 
</li>
<li>'''Host Path:''' This is the path to the host (unRAID) machine, This will be <code>/mnt/user/<Your User Share></code> 
</li>
 '''NOTE''' If you follow the [[Docker Guide]] you will only need one Volume path to be made as all information that {{{ARRNAME}}} will need will be in one share <code>/mnt/user/data</code>
<li> The last three items '''Default Value:''', '''Access Mode"''', and '''Description:''' Can be left alone. 
</li>
<li> Click '''ADD''' 
</li>
[[File:unraid-install4.png|frameless|750px|alt=Add New path|Add New Path]]
</ol>
<li> Last thing to check is to make sure Host Port for {{{ARRPORT}}} is filled in with <code>{{{ARRPORT}}}</code>, ''UNLESS'' This port causes any conflicts with any other container. If it does please choose a different port that is not in use. 
</li>
<li> Click '''APPLY''' 
</li>
</ol>
<li> Now the {{{ARRNAME}}}'s container is being downloaded, once complete simply click the '''OK''' button at the bottom of the new pop up window 
</li>
<li> Click '''DOCKER''' on the top row of your browser. 
</li>
<li> Now all you will need to do is simply left click on your newly created container and select '''WebUI'''. 
</li>
[[File:unraid-install2.png|frameless|none|250x240px|alt=Select WebUI|Select WebUI]]
<li> Now a new browser tab should show up with {{{ARRNAME}}} running in all its glory. '''ENJOY''' 
</li>
</ol>

Template:Installation

2020-12-02T17:33:14Z

Logvin: /* Linux */

<noinclude>
<templatedata>
{
"params": {
"ARRNAME": {
"description": "Name of the ARR",
"example": "Radarr",
"type": "string",
"required": true,
"default": "Fake Radarr"
},
"RunArrCommandLinux": {
"description": "Command to Start & Run ARR Linux",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"RunArrCommandOSX": {
"description": "Command to Start & Run ARR OSX",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"ArrExecutableNameWin": {
"description": "Executable Name for Windows",
"example": "Radarr.exe",
"type": "string",
"required": true
},
"ArrDownloadLink": {
"description": "Link to the Arr Downloads",
"type": "url",
"required": true
},
"ArrLinuxAutoStart": {
"description": "Autostart file instructions",
"required": true
},
"ARRPORT": {
"description": "Port number for the ARR",
"example": "Radarr: 7878, Sonarr: 8989, Lidarr: 8686, Readarr: 8787",
"type": "number",
"default": "7878",
"required": true
},
"ARRNAME2": {
"description": "Used for lowercase ARR names, this is not a required field only used if needed",
"example": "radarr, sonarr, lidarr, readarr",
"type": "string"
}
},
"paramOrder": [
"ARRNAME",
"RunArrCommandLinux",
"RunArrCommandOSX",
"ArrExecutableNameWin",
"ArrDownloadLink",
"ArrLinuxAutoStart",
"ARRPORT",
"ARRNAME2"
],
"description": "This template is expressly for the steps and processes of installing all the various ARR software on multiple different platforms"
}
</templatedata>
</noinclude>

= Installing =
== Windows ==

== OSX ==
{{#lst::Installation Misc|{{{ARRNAME2}}}_osx_big_sur_installation}}

== Linux ==

=== Debian / Ubuntu ===
Most of the "arr" software runs on mono, however newer version may run on .NET Core. If a .NET Core version is available, it will likely offer significant speed and resource enhancements.

===== Mono Install =====
Some "arr" software supports repository based automatic installs, and some must be installed manually. Repository installs will typically automatically install needed dependencies.

====== Repository Install ======

Sonarr:
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 0xA236C58F409091A18ACA53CBEBFF6B99D9B78493
echo "deb http://apt.sonarr.tv/ master main" | sudo tee /etc/apt/sources.list.d/sonarr.list
sudo apt update
sudo apt install nzbdrone
To start Sonarr, you need to call the mono executable:
/usr/bin/mono --debug /opt/NzbDrone/NzbDrone.exe

====== Manual Install ======
First start by installing the dependencies:

Mono:
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
echo "deb https://download.mono-project.com/repo/ubuntu stable-focal main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
sudo apt update && sudo apt install mono-devel
Curl
sudo apt install curl
Mediainfo:
sudo apt install mediainfo
sqlite3:
sudo apt install sqlite3

Now download the newest mono version release of {{{ARRNAME}}}:
wget --content-disposition '{{{ARRPackageFileMono}}}'

Uncompress:
tar -xvzf {{{ARRNAME}}}*.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser

===== .NET Core Install =====
There are no dependencies needed for the .NET Core Install path.

====== Manual Install ======
Go to the {{{ARRNAME}}} download page, and pick the appropriate file. Note that only Radarr currently has a .NET Core install path right now.

In the example screenshot here, you can see multiple options. Choose the option that matches your OS and processor best. For most users, this would be <code>.linux-core-x64.tar.gz</code> if it is available.
[[File:ARR Download Link Example.png|thumb|right|Example of Radarr download options]]

Download this file onto your system:

Radarr: {{{ArrDownloadLink}}}
wget --content-disposition 'http://radarr.servarr.com/v1/update/master/updatefile?os=linux&runtime=netcore&arch=x64'
Uncompress:
tar -xvzf {{{ARRNAME}}}*.linux-core-x64.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser

=== Auto Start Using Systemd ===
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

==== Preparing the Unit Service File ====
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that {{{ARRNAME2}}} will run as.
# <code>Group</code> should match the service account group that {{{ARRNAME2}}} will run as.
# <code>ExecStart</code> has several items that should match your installation <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>
## Executable Path Default location is <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>, but you may need to update if you installed {{{ARRNAME}}} elsewhere.
## Data Directory Default location is <code>-data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/</code>, but you may need to update if you want to keep your database and settings elsewhere.
## Mono Path (if Mono is being used) Default location is <code>/usr/bin/mono</code>, but you may need to update if you installed Mono elsewhere.

The unit service file should be named <code>{{{ARRNAME}}}.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>{{{ARRNAME2}}}</code>, {{{ARRNAME}}}'s executable is placed in <code>/opt/{{{ARRNAME}}}/</code>, the data directory is placed in <code>/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}</code>, and the Mono executable (if being used) is placed in <code>/usr/bin/mono</code>.

'''Important note:''' Both <code>ExecStart</code> lines are commented out below. Remove the # from the line matching your install type (Mono vs NetCore).

[Unit]
Description={{{ARRNAME}}} Daemon
After=syslog.target network.target

[Service]
# Change the user and group variables here.
User={{{ARRNAME2}}}
Group={{{ARRNAME2}}}

Type=simple

# NOTE: Uncomment one of the two below ExecStart lines, based on if {{{ARRNAME}}} is using NetCore or Mono.
# NetCore install:
#ExecStart=/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

# Mono Install:
#ExecStart=/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

TimeoutStopSec=20
KillMode=process
Restart=on-failure

[Install]
WantedBy=multi-user.target

==== Verify Directory Permissions ====
Ensure the <code>User</code> that will be running {{{ARRNAME}}} has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder.
Example:
$ ls -lad /opt/{{{ARRNAME}}}
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /opt/{{{ARRNAME}}}/
$ ls -lad /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

==== Enabling and starting the Unit Service File ====
Once you have created <code>{{{ARRNAME}}}.service</code>, you will want to enable the service:
sudo systemctl enable {{{ARRNAME}}}.service

You are now ready to start {{{ARRNAME}}}. You can do so with the <code>start</code> command:
sudo systemctl start {{{ARRNAME}}}.service

If you want to verify {{{ARRNAME}}} is running, you can run the <code>status</code> command:
$ sudo systemctl status {{{ARRNAME}}}.service
● {{{ARRNAME}}}.service - {{{ARRNAME}}}Service
Loaded: loaded (/usr/lib/systemd/system/{{{ARRNAME}}}.service; enabled; vendor preset: disabled)
Active: active (running) since Tue 2017-03-07 10:23:44 PST; 5min ago
Main PID: 19978 ({{{ARRNAME}}})
Tasks: 16 (limit: 4915)
Memory: 114.6M
CPU: 9.331s
CGroup: /system.slice/{{{ARRNAME}}}.service
└─19978 /opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
Mar 07 10:23:44 apollo systemd[1]: Started {{{ARRNAME}}} Service.

== NAS ==
=== FreeNAS ===
=== Qnap ===
=== Synology ===

== Docker ==

== Docker on unRAID ==
* Installation of {{{ARRNAME}}} is quite simple when it comes to unRAID as they have made installing Docker containers a breeze.
<ol style="list-style-type: decimal;">
<li>Simply head on over to the community applications store on the top bar of your browser. </li>
[[File:unraid-install1.png|frameless|750px|alt=Community Applications|Communitty Applications]]
<li>In the search field type in {{{ARRNAME}}} 
</li>
<li>Select which docker image you would like to install. There are several to choose from 
</li>
[[File:{{{ARRNAME}}}-unraid-install.png|frameless|none|750px|alt=Installation Options|Installation Options]]
<li> Depending on which container you go with will determine the steps in which you take. Some containers come preloaded with volumes mapped already. This is really up to your liking how you would like your container volumes to be laid out. It is highly recommended to follow the guide listed [[Docker Guide|here]] for your volume mapping 
</li>
 Depending on which container you select you may recieve a pop up asking you to '''Choose A Branch To Install''' when in doubt go with the <code>Default :latest</code> branch
<li> Once you have selected which container you are going to go with, you will need to either create the volumes for {{{ARRNAME}}} to be able to use or simply use the pre-filled ones. (Highly recommended to remove the pre-filled and use your own, to remove the pre-filled ones). </li>
 To remove the pre-filled paths simply select the toggle in the upper right from '''Basic''' to '''Advanced''' view then scroll down to the pre-filled path and click '''Remove'''
[[File:unraid-install3.png|frameless|750px|alt=Toggle Advanced|Toggle Advanced]]
<ol>
<li> To create new volumes simply select the <code> Add another Path, Port, Variable, Label or Device</code> text at the bottom above the '''Apply''' button. 
</li>
<li> Once the new window appears you will want to use the drop down box next to '''Config Type:''' and make sure that it is set to '''Path'''. 
</li>
<li> From here you will want to fill out all pertinant information: 
</li>
<ol>
<li>'''Name:''' The name of this path, this can be any unique name more like a note to know what this path is for. 
</li>
<li>'''Container Path:''' This will be the path that {{{ARRNAME}}} will see inside the container <code>/data</code> is a favorite 
</li>
<li>'''Host Path:''' This is the path to the host (unRAID) machine, This will be <code>/mnt/user/<Your User Share></code> 
</li>
 '''NOTE''' If you follow the [[Docker Guide]] you will only need one Volume path to be made as all information that {{{ARRNAME}}} will need will be in one share <code>/mnt/user/data</code>
<li> The last three items '''Default Value:''', '''Access Mode"''', and '''Description:''' Can be left alone. 
</li>
<li> Click '''ADD''' 
</li>
[[File:unraid-install4.png|frameless|750px|alt=Add New path|Add New Path]]
</ol>
<li> Last thing to check is to make sure Host Port for {{{ARRPORT}}} is filled in with <code>{{{ARRPORT}}}</code>, ''UNLESS'' This port causes any conflicts with any other container. If it does please choose a different port that is not in use. 
</li>
<li> Click '''APPLY''' 
</li>
</ol>
<li> Now the {{{ARRNAME}}}'s container is being downloaded, once complete simply click the '''OK''' button at the bottom of the new pop up window 
</li>
<li> Click '''DOCKER''' on the top row of your browser. 
</li>
<li> Now all you will need to do is simply left click on your newly created container and select '''WebUI'''. 
</li>
[[File:unraid-install2.png|frameless|none|250x240px|alt=Select WebUI|Select WebUI]]
<li> Now a new browser tab should show up with {{{ARRNAME}}} running in all its glory. '''ENJOY''' 
</li>
</ol>

Template:Installation

2020-12-02T17:31:31Z

Logvin: /* Debian / Ubuntu */

<noinclude>
<templatedata>
{
"params": {
"ARRNAME": {
"description": "Name of the ARR",
"example": "Radarr",
"type": "string",
"required": true,
"default": "Fake Radarr"
},
"RunArrCommandLinux": {
"description": "Command to Start & Run ARR Linux",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"RunArrCommandOSX": {
"description": "Command to Start & Run ARR OSX",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"ArrExecutableNameWin": {
"description": "Executable Name for Windows",
"example": "Radarr.exe",
"type": "string",
"required": true
},
"ArrDownloadLink": {
"description": "Link to the Arr Downloads",
"type": "url",
"required": true
},
"ArrLinuxAutoStart": {
"description": "Autostart file instructions",
"required": true
},
"ARRPORT": {
"description": "Port number for the ARR",
"example": "Radarr: 7878, Sonarr: 8989, Lidarr: 8686, Readarr: 8787",
"type": "number",
"default": "7878",
"required": true
},
"ARRNAME2": {
"description": "Used for lowercase ARR names, this is not a required field only used if needed",
"example": "radarr, sonarr, lidarr, readarr",
"type": "string"
}
},
"paramOrder": [
"ARRNAME",
"RunArrCommandLinux",
"RunArrCommandOSX",
"ArrExecutableNameWin",
"ArrDownloadLink",
"ArrLinuxAutoStart",
"ARRPORT",
"ARRNAME2"
],
"description": "This template is expressly for the steps and processes of installing all the various ARR software on multiple different platforms"
}
</templatedata>
</noinclude>

= Installing =
== Windows ==

== OSX ==
{{#lst::Installation Misc|{{{ARRNAME2}}}_osx_big_sur_installation}}

== Linux ==

=== Debian / Ubuntu ===
Most of the "arr" software runs on mono, however newer version may run on .NET Core. If a .NET Core version is available, it will likely offer significant speed and resource enhancements.

===== Mono Install =====
Some "arr" software supports repository based automatic installs, and some must be installed manually. Repository installs will typically automatically install needed dependencies.

====== Repository Install ======

Sonarr:
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 0xA236C58F409091A18ACA53CBEBFF6B99D9B78493
echo "deb http://apt.sonarr.tv/ master main" | sudo tee /etc/apt/sources.list.d/sonarr.list
sudo apt update
sudo apt install nzbdrone
To start Sonarr, you need to call the mono executable:
/usr/bin/mono --debug /opt/NzbDrone/NzbDrone.exe

====== Manual Install ======
First start by installing the dependencies:

Mono:
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
echo "deb https://download.mono-project.com/repo/ubuntu stable-focal main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
sudo apt update && sudo apt install mono-devel
Curl
sudo apt install curl
Mediainfo:
sudo apt install mediainfo
sqlite3:
sudo apt install sqlite3

Now download the newest mono version release of {{{ARRNAME}}}:
wget --content-disposition '{{{ARRPackageFileMono}}}'

Uncompress:
tar -xvzf {{{ARRNAME}}}*.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser

===== .NET Core Install =====
There are no dependencies needed for the .NET Core Install path.

====== Manual Install ======
Go to the {{{ARRNAME}}} download page, and pick the appropriate file. Note that only Radarr currently has a .NET Core install path right now.

In the example screenshot here, you can see multiple options. Choose the option that matches your OS and processor best. For most users, this would be <code>.linux-core-x64.tar.gz</code> if it is available.
[[File:ARR Download Link Example.png|thumb|right|Example of Radarr download options]]

Download this file onto your system:

Radarr: {{{ArrDownloadLink}}}
wget --content-disposition 'http://radarr.servarr.com/v1/update/master/updatefile?os=linux&runtime=netcore&arch=x64'
Uncompress:
tar -xvzf {{{ARRNAME}}}*.linux-core-x64.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser

=== Auto Start Using Systemd ===
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

=== Preparing the Unit Service File ===
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that {{{ARRNAME2}}} will run as.
# <code>Group</code> should match the service account group that {{{ARRNAME2}}} will run as.
# <code>ExecStart</code> has several items that should match your installation <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>
## Executable Path Default location is <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>, but you may need to update if you installed {{{ARRNAME}}} elsewhere.
## Data Directory Default location is <code>-data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/</code>, but you may need to update if you want to keep your database and settings elsewhere.
## Mono Path (if Mono is being used) Default location is <code>/usr/bin/mono</code>, but you may need to update if you installed Mono elsewhere.

The unit service file should be named <code>{{{ARRNAME}}}.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>{{{ARRNAME2}}}</code>, {{{ARRNAME}}}'s executable is placed in <code>/opt/{{{ARRNAME}}}/</code>, the data directory is placed in <code>/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}</code>, and the Mono executable (if being used) is placed in <code>/usr/bin/mono</code>.

'''Important note:''' Both <code>ExecStart</code> lines are commented out below. Remove the # from the line matching your install type (Mono vs NetCore).

[Unit]
Description={{{ARRNAME}}} Daemon
After=syslog.target network.target

[Service]
# Change the user and group variables here.
User={{{ARRNAME2}}}
Group={{{ARRNAME2}}}

Type=simple

# NOTE: Uncomment one of the two below ExecStart lines, based on if {{{ARRNAME}}} is using NetCore or Mono.
# NetCore install:
#ExecStart=/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

# Mono Install:
#ExecStart=/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

TimeoutStopSec=20
KillMode=process
Restart=on-failure

[Install]
WantedBy=multi-user.target

=== Verify Directory Permissions ===
Ensure the <code>User</code> that will be running {{{ARRNAME}}} has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder.
Example:
$ ls -lad /opt/{{{ARRNAME}}}
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /opt/{{{ARRNAME}}}/
$ ls -lad /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

=== Enabling and starting the Unit Service File ===
Once you have created <code>{{{ARRNAME}}}.service</code>, you will want to enable the service:
sudo systemctl enable {{{ARRNAME}}}.service

You are now ready to start {{{ARRNAME}}}. You can do so with the <code>start</code> command:
sudo systemctl start {{{ARRNAME}}}.service

If you want to verify {{{ARRNAME}}} is running, you can run the <code>status</code> command:
$ sudo systemctl status {{{ARRNAME}}}.service
● {{{ARRNAME}}}.service - {{{ARRNAME}}}Service
Loaded: loaded (/usr/lib/systemd/system/{{{ARRNAME}}}.service; enabled; vendor preset: disabled)
Active: active (running) since Tue 2017-03-07 10:23:44 PST; 5min ago
Main PID: 19978 ({{{ARRNAME}}})
Tasks: 16 (limit: 4915)
Memory: 114.6M
CPU: 9.331s
CGroup: /system.slice/{{{ARRNAME}}}.service
└─19978 /opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
Mar 07 10:23:44 apollo systemd[1]: Started {{{ARRNAME}}} Service.

== NAS ==
=== FreeNAS ===
=== Qnap ===
=== Synology ===

== Docker ==

== Docker on unRAID ==
* Installation of {{{ARRNAME}}} is quite simple when it comes to unRAID as they have made installing Docker containers a breeze.
<ol style="list-style-type: decimal;">
<li>Simply head on over to the community applications store on the top bar of your browser. </li>
[[File:unraid-install1.png|frameless|750px|alt=Community Applications|Communitty Applications]]
<li>In the search field type in {{{ARRNAME}}} 
</li>
<li>Select which docker image you would like to install. There are several to choose from 
</li>
[[File:{{{ARRNAME}}}-unraid-install.png|frameless|none|750px|alt=Installation Options|Installation Options]]
<li> Depending on which container you go with will determine the steps in which you take. Some containers come preloaded with volumes mapped already. This is really up to your liking how you would like your container volumes to be laid out. It is highly recommended to follow the guide listed [[Docker Guide|here]] for your volume mapping 
</li>
 Depending on which container you select you may recieve a pop up asking you to '''Choose A Branch To Install''' when in doubt go with the <code>Default :latest</code> branch
<li> Once you have selected which container you are going to go with, you will need to either create the volumes for {{{ARRNAME}}} to be able to use or simply use the pre-filled ones. (Highly recommended to remove the pre-filled and use your own, to remove the pre-filled ones). </li>
 To remove the pre-filled paths simply select the toggle in the upper right from '''Basic''' to '''Advanced''' view then scroll down to the pre-filled path and click '''Remove'''
[[File:unraid-install3.png|frameless|750px|alt=Toggle Advanced|Toggle Advanced]]
<ol>
<li> To create new volumes simply select the <code> Add another Path, Port, Variable, Label or Device</code> text at the bottom above the '''Apply''' button. 
</li>
<li> Once the new window appears you will want to use the drop down box next to '''Config Type:''' and make sure that it is set to '''Path'''. 
</li>
<li> From here you will want to fill out all pertinant information: 
</li>
<ol>
<li>'''Name:''' The name of this path, this can be any unique name more like a note to know what this path is for. 
</li>
<li>'''Container Path:''' This will be the path that {{{ARRNAME}}} will see inside the container <code>/data</code> is a favorite 
</li>
<li>'''Host Path:''' This is the path to the host (unRAID) machine, This will be <code>/mnt/user/<Your User Share></code> 
</li>
 '''NOTE''' If you follow the [[Docker Guide]] you will only need one Volume path to be made as all information that {{{ARRNAME}}} will need will be in one share <code>/mnt/user/data</code>
<li> The last three items '''Default Value:''', '''Access Mode"''', and '''Description:''' Can be left alone. 
</li>
<li> Click '''ADD''' 
</li>
[[File:unraid-install4.png|frameless|750px|alt=Add New path|Add New Path]]
</ol>
<li> Last thing to check is to make sure Host Port for {{{ARRPORT}}} is filled in with <code>{{{ARRPORT}}}</code>, ''UNLESS'' This port causes any conflicts with any other container. If it does please choose a different port that is not in use. 
</li>
<li> Click '''APPLY''' 
</li>
</ol>
<li> Now the {{{ARRNAME}}}'s container is being downloaded, once complete simply click the '''OK''' button at the bottom of the new pop up window 
</li>
<li> Click '''DOCKER''' on the top row of your browser. 
</li>
<li> Now all you will need to do is simply left click on your newly created container and select '''WebUI'''. 
</li>
[[File:unraid-install2.png|frameless|none|250x240px|alt=Select WebUI|Select WebUI]]
<li> Now a new browser tab should show up with {{{ARRNAME}}} running in all its glory. '''ENJOY''' 
</li>
</ol>

Template:Installation

2020-12-02T17:21:20Z

Logvin: /* Debian / Ubuntu */

<noinclude>
<templatedata>
{
"params": {
"ARRNAME": {
"description": "Name of the ARR",
"example": "Radarr",
"type": "string",
"required": true,
"default": "Fake Radarr"
},
"RunArrCommandLinux": {
"description": "Command to Start & Run ARR Linux",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"RunArrCommandOSX": {
"description": "Command to Start & Run ARR OSX",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"ArrExecutableNameWin": {
"description": "Executable Name for Windows",
"example": "Radarr.exe",
"type": "string",
"required": true
},
"ArrDownloadLink": {
"description": "Link to the Arr Downloads",
"type": "url",
"required": true
},
"ArrLinuxAutoStart": {
"description": "Autostart file instructions",
"required": true
},
"ARRPORT": {
"description": "Port number for the ARR",
"example": "Radarr: 7878, Sonarr: 8989, Lidarr: 8686, Readarr: 8787",
"type": "number",
"default": "7878",
"required": true
},
"ARRNAME2": {
"description": "Used for lowercase ARR names, this is not a required field only used if needed",
"example": "radarr, sonarr, lidarr, readarr",
"type": "string"
}
},
"paramOrder": [
"ARRNAME",
"RunArrCommandLinux",
"RunArrCommandOSX",
"ArrExecutableNameWin",
"ArrDownloadLink",
"ArrLinuxAutoStart",
"ARRPORT",
"ARRNAME2"
],
"description": "This template is expressly for the steps and processes of installing all the various ARR software on multiple different platforms"
}
</templatedata>
</noinclude>

= Installing =
== Windows ==

== OSX ==
{{#lst::Installation Misc|{{{ARRNAME2}}}_osx_big_sur_installation}}

== Linux ==

=== Debian / Ubuntu ===
Most of the "arr" software runs on mono, however newer version may run on .NET Core. If a .NET Core version is available, it will likely offer significant speed and resource enhancements.

===== Mono Install =====
First start by installing the dependencies:

Mono:
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
echo "deb https://download.mono-project.com/repo/ubuntu stable-focal main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
sudo apt update && sudo apt install mono-devel
Curl
sudo apt install curl
Mediainfo:
sudo apt install mediainfo
sqlite3:
sudo apt install sqlite3

Now download the newest mono version release of {{{ARRNAME}}}:
wget --content-disposition '{{{ARRPackageFileMono}}}'

Uncompress:
tar -xvzf {{{ARRNAME}}}*.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser

===== .NET Core Install =====
There are no dependencies needed for the .NET Core Install path.

====== Manual Install ======
Go to the {{{ARRNAME}}} download page, and pick the appropriate file. Note that only Radarr currently has a .NET Core install path right now.

In the example screenshot here, you can see multiple options. Choose the option that matches your OS and processor best. For most users, this would be <code>.linux-core-x64.tar.gz</code> if it is available.
[[File:ARR Download Link Example.png|thumb|right|Example of Radarr download options]]

Download this file onto your system:

Radarr: {{{ArrDownloadLink}}}
wget --content-disposition 'http://radarr.servarr.com/v1/update/master/updatefile?os=linux&runtime=netcore&arch=x64'
Uncompress:
tar -xvzf {{{ARRNAME}}}*.linux-core-x64.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser

=== Auto Start Using Systemd ===
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

=== Preparing the Unit Service File ===
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that {{{ARRNAME2}}} will run as.
# <code>Group</code> should match the service account group that {{{ARRNAME2}}} will run as.
# <code>ExecStart</code> has several items that should match your installation <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>
## Executable Path Default location is <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>, but you may need to update if you installed {{{ARRNAME}}} elsewhere.
## Data Directory Default location is <code>-data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/</code>, but you may need to update if you want to keep your database and settings elsewhere.
## Mono Path (if Mono is being used) Default location is <code>/usr/bin/mono</code>, but you may need to update if you installed Mono elsewhere.

The unit service file should be named <code>{{{ARRNAME}}}.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>{{{ARRNAME2}}}</code>, {{{ARRNAME}}}'s executable is placed in <code>/opt/{{{ARRNAME}}}/</code>, the data directory is placed in <code>/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}</code>, and the Mono executable (if being used) is placed in <code>/usr/bin/mono</code>.

'''Important note:''' Both <code>ExecStart</code> lines are commented out below. Remove the # from the line matching your install type (Mono vs NetCore).

[Unit]
Description={{{ARRNAME}}} Daemon
After=syslog.target network.target

[Service]
# Change the user and group variables here.
User={{{ARRNAME2}}}
Group={{{ARRNAME2}}}

Type=simple

# NOTE: Uncomment one of the two below ExecStart lines, based on if {{{ARRNAME}}} is using NetCore or Mono.
# NetCore install:
#ExecStart=/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

# Mono Install:
#ExecStart=/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

TimeoutStopSec=20
KillMode=process
Restart=on-failure

[Install]
WantedBy=multi-user.target

=== Verify Directory Permissions ===
Ensure the <code>User</code> that will be running {{{ARRNAME}}} has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder.
Example:
$ ls -lad /opt/{{{ARRNAME}}}
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /opt/{{{ARRNAME}}}/
$ ls -lad /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

=== Enabling and starting the Unit Service File ===
Once you have created <code>{{{ARRNAME}}}.service</code>, you will want to enable the service:
sudo systemctl enable {{{ARRNAME}}}.service

You are now ready to start {{{ARRNAME}}}. You can do so with the <code>start</code> command:
sudo systemctl start {{{ARRNAME}}}.service

If you want to verify {{{ARRNAME}}} is running, you can run the <code>status</code> command:
$ sudo systemctl status {{{ARRNAME}}}.service
● {{{ARRNAME}}}.service - {{{ARRNAME}}}Service
Loaded: loaded (/usr/lib/systemd/system/{{{ARRNAME}}}.service; enabled; vendor preset: disabled)
Active: active (running) since Tue 2017-03-07 10:23:44 PST; 5min ago
Main PID: 19978 ({{{ARRNAME}}})
Tasks: 16 (limit: 4915)
Memory: 114.6M
CPU: 9.331s
CGroup: /system.slice/{{{ARRNAME}}}.service
└─19978 /opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
Mar 07 10:23:44 apollo systemd[1]: Started {{{ARRNAME}}} Service.

== NAS ==
=== FreeNAS ===
=== Qnap ===
=== Synology ===

== Docker ==

== Docker on unRAID ==
* Installation of {{{ARRNAME}}} is quite simple when it comes to unRAID as they have made installing Docker containers a breeze.
<ol style="list-style-type: decimal;">
<li>Simply head on over to the community applications store on the top bar of your browser. </li>
[[File:unraid-install1.png|frameless|750px|alt=Community Applications|Communitty Applications]]
<li>In the search field type in {{{ARRNAME}}} 
</li>
<li>Select which docker image you would like to install. There are several to choose from 
</li>
[[File:{{{ARRNAME}}}-unraid-install.png|frameless|none|750px|alt=Installation Options|Installation Options]]
<li> Depending on which container you go with will determine the steps in which you take. Some containers come preloaded with volumes mapped already. This is really up to your liking how you would like your container volumes to be laid out. It is highly recommended to follow the guide listed [[Docker Guide|here]] for your volume mapping 
</li>
 Depending on which container you select you may recieve a pop up asking you to '''Choose A Branch To Install''' when in doubt go with the <code>Default :latest</code> branch
<li> Once you have selected which container you are going to go with, you will need to either create the volumes for {{{ARRNAME}}} to be able to use or simply use the pre-filled ones. (Highly recommended to remove the pre-filled and use your own, to remove the pre-filled ones). </li>
 To remove the pre-filled paths simply select the toggle in the upper right from '''Basic''' to '''Advanced''' view then scroll down to the pre-filled path and click '''Remove'''
[[File:unraid-install3.png|frameless|750px|alt=Toggle Advanced|Toggle Advanced]]
<ol>
<li> To create new volumes simply select the <code> Add another Path, Port, Variable, Label or Device</code> text at the bottom above the '''Apply''' button. 
</li>
<li> Once the new window appears you will want to use the drop down box next to '''Config Type:''' and make sure that it is set to '''Path'''. 
</li>
<li> From here you will want to fill out all pertinant information: 
</li>
<ol>
<li>'''Name:''' The name of this path, this can be any unique name more like a note to know what this path is for. 
</li>
<li>'''Container Path:''' This will be the path that {{{ARRNAME}}} will see inside the container <code>/data</code> is a favorite 
</li>
<li>'''Host Path:''' This is the path to the host (unRAID) machine, This will be <code>/mnt/user/<Your User Share></code> 
</li>
 '''NOTE''' If you follow the [[Docker Guide]] you will only need one Volume path to be made as all information that {{{ARRNAME}}} will need will be in one share <code>/mnt/user/data</code>
<li> The last three items '''Default Value:''', '''Access Mode"''', and '''Description:''' Can be left alone. 
</li>
<li> Click '''ADD''' 
</li>
[[File:unraid-install4.png|frameless|750px|alt=Add New path|Add New Path]]
</ol>
<li> Last thing to check is to make sure Host Port for {{{ARRPORT}}} is filled in with <code>{{{ARRPORT}}}</code>, ''UNLESS'' This port causes any conflicts with any other container. If it does please choose a different port that is not in use. 
</li>
<li> Click '''APPLY''' 
</li>
</ol>
<li> Now the {{{ARRNAME}}}'s container is being downloaded, once complete simply click the '''OK''' button at the bottom of the new pop up window 
</li>
<li> Click '''DOCKER''' on the top row of your browser. 
</li>
<li> Now all you will need to do is simply left click on your newly created container and select '''WebUI'''. 
</li>
[[File:unraid-install2.png|frameless|none|250x240px|alt=Select WebUI|Select WebUI]]
<li> Now a new browser tab should show up with {{{ARRNAME}}} running in all its glory. '''ENJOY''' 
</li>
</ol>

Template:Installation

2020-12-02T17:16:32Z

Logvin: /* Debian / Ubuntu */

<noinclude>
<templatedata>
{
"params": {
"ARRNAME": {
"description": "Name of the ARR",
"example": "Radarr",
"type": "string",
"required": true,
"default": "Fake Radarr"
},
"RunArrCommandLinux": {
"description": "Command to Start & Run ARR Linux",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"RunArrCommandOSX": {
"description": "Command to Start & Run ARR OSX",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"ArrExecutableNameWin": {
"description": "Executable Name for Windows",
"example": "Radarr.exe",
"type": "string",
"required": true
},
"ArrDownloadLink": {
"description": "Link to the Arr Downloads",
"type": "url",
"required": true
},
"ArrLinuxAutoStart": {
"description": "Autostart file instructions",
"required": true
},
"ARRPORT": {
"description": "Port number for the ARR",
"example": "Radarr: 7878, Sonarr: 8989, Lidarr: 8686, Readarr: 8787",
"type": "number",
"default": "7878",
"required": true
},
"ARRNAME2": {
"description": "Used for lowercase ARR names, this is not a required field only used if needed",
"example": "radarr, sonarr, lidarr, readarr",
"type": "string"
}
},
"paramOrder": [
"ARRNAME",
"RunArrCommandLinux",
"RunArrCommandOSX",
"ArrExecutableNameWin",
"ArrDownloadLink",
"ArrLinuxAutoStart",
"ARRPORT",
"ARRNAME2"
],
"description": "This template is expressly for the steps and processes of installing all the various ARR software on multiple different platforms"
}
</templatedata>
</noinclude>

= Installing =
== Windows ==

== OSX ==
{{#lst::Installation Misc|{{{ARRNAME2}}}_osx_big_sur_installation}}

== Linux ==

=== Debian / Ubuntu ===
Most of the "arr" software runs on mono, however newer version may run on .NET Core. If a .NET Core version is available, it will likely offer significant speed and resource enhancements.

===== Mono Install =====
First start by installing the dependencies:

Mono:
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
echo "deb https://download.mono-project.com/repo/ubuntu stable-focal main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
sudo apt update && sudo apt install mono-devel
Curl
sudo apt install curl
Mediainfo:
sudo apt install mediainfo
sqlite3:
sudo apt install sqlite3

Now download the newest mono version release of {{{ARRNAME}}}:

Radarr: https://api.github.com/repos/Radarr/Radarr/releases
wget --content-disposition '{{{ARRPackageFileMono}}}'
Sonarr: https://sonarr.tv/#download
wget --content-disposition 'https://services.sonarr.tv/v1/download/phantom-develop/latest?version=3&os=linux'

Uncompress:
tar -xvzf {{{ARRNAME}}}*.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser

===== .NET Core Install =====
There are no dependencies needed for the .NET Core Install path.

====== Manual Install ======
Go to the {{{ARRNAME}}} download page, and pick the appropriate file.
{{{ArrDownloadLink}}}

In the example screenshot here, you can see multiple options. Chose the option that matches your OS and processor best. For most users, this would be <code>.linux-core-x64.tar.gz</code> if it is available.
[[File:ARR Download Link Example.png|thumb|right|Example of Radarr download options]]

Download this file onto your system:

Radarr: https://api.github.com/repos/Radarr/Radarr/releases
wget --content-disposition 'http://radarr.servarr.com/v1/update/master/updatefile?os=linux&runtime=netcore&arch=x64'
Uncompress:
tar -xvzf {{{ARRNAME}}}*.linux-core-x64.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser

=== Auto Start Using Systemd ===
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

=== Preparing the Unit Service File ===
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that {{{ARRNAME2}}} will run as.
# <code>Group</code> should match the service account group that {{{ARRNAME2}}} will run as.
# <code>ExecStart</code> has several items that should match your installation <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>
## Executable Path Default location is <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>, but you may need to update if you installed {{{ARRNAME}}} elsewhere.
## Data Directory Default location is <code>-data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/</code>, but you may need to update if you want to keep your database and settings elsewhere.
## Mono Path (if Mono is being used) Default location is <code>/usr/bin/mono</code>, but you may need to update if you installed Mono elsewhere.

The unit service file should be named <code>{{{ARRNAME}}}.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>{{{ARRNAME2}}}</code>, {{{ARRNAME}}}'s executable is placed in <code>/opt/{{{ARRNAME}}}/</code>, the data directory is placed in <code>/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}</code>, and the Mono executable (if being used) is placed in <code>/usr/bin/mono</code>.

'''Important note:''' Both <code>ExecStart</code> lines are commented out below. Remove the # from the line matching your install type (Mono vs NetCore).

[Unit]
Description={{{ARRNAME}}} Daemon
After=syslog.target network.target

[Service]
# Change the user and group variables here.
User={{{ARRNAME2}}}
Group={{{ARRNAME2}}}

Type=simple

# NOTE: Uncomment one of the two below ExecStart lines, based on if {{{ARRNAME}}} is using NetCore or Mono.
# NetCore install:
#ExecStart=/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

# Mono Install:
#ExecStart=/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

TimeoutStopSec=20
KillMode=process
Restart=on-failure

[Install]
WantedBy=multi-user.target

=== Verify Directory Permissions ===
Ensure the <code>User</code> that will be running {{{ARRNAME}}} has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder.
Example:
$ ls -lad /opt/{{{ARRNAME}}}
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /opt/{{{ARRNAME}}}/
$ ls -lad /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

=== Enabling and starting the Unit Service File ===
Once you have created <code>{{{ARRNAME}}}.service</code>, you will want to enable the service:
sudo systemctl enable {{{ARRNAME}}}.service

You are now ready to start {{{ARRNAME}}}. You can do so with the <code>start</code> command:
sudo systemctl start {{{ARRNAME}}}.service

If you want to verify {{{ARRNAME}}} is running, you can run the <code>status</code> command:
$ sudo systemctl status {{{ARRNAME}}}.service
● {{{ARRNAME}}}.service - {{{ARRNAME}}}Service
Loaded: loaded (/usr/lib/systemd/system/{{{ARRNAME}}}.service; enabled; vendor preset: disabled)
Active: active (running) since Tue 2017-03-07 10:23:44 PST; 5min ago
Main PID: 19978 ({{{ARRNAME}}})
Tasks: 16 (limit: 4915)
Memory: 114.6M
CPU: 9.331s
CGroup: /system.slice/{{{ARRNAME}}}.service
└─19978 /opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
Mar 07 10:23:44 apollo systemd[1]: Started {{{ARRNAME}}} Service.

== NAS ==
=== FreeNAS ===
=== Qnap ===
=== Synology ===

== Docker ==

== Docker on unRAID ==
* Installation of {{{ARRNAME}}} is quite simple when it comes to unRAID as they have made installing Docker containers a breeze.
<ol style="list-style-type: decimal;">
<li>Simply head on over to the community applications store on the top bar of your browser. </li>
[[File:unraid-install1.png|frameless|750px|alt=Community Applications|Communitty Applications]]
<li>In the search field type in {{{ARRNAME}}} 
</li>
<li>Select which docker image you would like to install. There are several to choose from 
</li>
[[File:{{{ARRNAME}}}-unraid-install.png|frameless|none|750px|alt=Installation Options|Installation Options]]
<li> Depending on which container you go with will determine the steps in which you take. Some containers come preloaded with volumes mapped already. This is really up to your liking how you would like your container volumes to be laid out. It is highly recommended to follow the guide listed [[Docker Guide|here]] for your volume mapping 
</li>
 Depending on which container you select you may recieve a pop up asking you to '''Choose A Branch To Install''' when in doubt go with the <code>Default :latest</code> branch
<li> Once you have selected which container you are going to go with, you will need to either create the volumes for {{{ARRNAME}}} to be able to use or simply use the pre-filled ones. (Highly recommended to remove the pre-filled and use your own, to remove the pre-filled ones). </li>
 To remove the pre-filled paths simply select the toggle in the upper right from '''Basic''' to '''Advanced''' view then scroll down to the pre-filled path and click '''Remove'''
[[File:unraid-install3.png|frameless|750px|alt=Toggle Advanced|Toggle Advanced]]
<ol>
<li> To create new volumes simply select the <code> Add another Path, Port, Variable, Label or Device</code> text at the bottom above the '''Apply''' button. 
</li>
<li> Once the new window appears you will want to use the drop down box next to '''Config Type:''' and make sure that it is set to '''Path'''. 
</li>
<li> From here you will want to fill out all pertinant information: 
</li>
<ol>
<li>'''Name:''' The name of this path, this can be any unique name more like a note to know what this path is for. 
</li>
<li>'''Container Path:''' This will be the path that {{{ARRNAME}}} will see inside the container <code>/data</code> is a favorite 
</li>
<li>'''Host Path:''' This is the path to the host (unRAID) machine, This will be <code>/mnt/user/<Your User Share></code> 
</li>
 '''NOTE''' If you follow the [[Docker Guide]] you will only need one Volume path to be made as all information that {{{ARRNAME}}} will need will be in one share <code>/mnt/user/data</code>
<li> The last three items '''Default Value:''', '''Access Mode"''', and '''Description:''' Can be left alone. 
</li>
<li> Click '''ADD''' 
</li>
[[File:unraid-install4.png|frameless|750px|alt=Add New path|Add New Path]]
</ol>
<li> Last thing to check is to make sure Host Port for {{{ARRPORT}}} is filled in with <code>{{{ARRPORT}}}</code>, ''UNLESS'' This port causes any conflicts with any other container. If it does please choose a different port that is not in use. 
</li>
<li> Click '''APPLY''' 
</li>
</ol>
<li> Now the {{{ARRNAME}}}'s container is being downloaded, once complete simply click the '''OK''' button at the bottom of the new pop up window 
</li>
<li> Click '''DOCKER''' on the top row of your browser. 
</li>
<li> Now all you will need to do is simply left click on your newly created container and select '''WebUI'''. 
</li>
[[File:unraid-install2.png|frameless|none|250x240px|alt=Select WebUI|Select WebUI]]
<li> Now a new browser tab should show up with {{{ARRNAME}}} running in all its glory. '''ENJOY''' 
</li>
</ol>

Template:Installation

2020-12-01T23:10:11Z

Logvin: /* Debian / Ubuntu */

<noinclude>
<templatedata>
{
"params": {
"ARRNAME": {
"description": "Name of the ARR",
"example": "Radarr",
"type": "string",
"required": true,
"default": "Fake Radarr"
},
"RunArrCommandLinux": {
"description": "Command to Start & Run ARR Linux",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"RunArrCommandOSX": {
"description": "Command to Start & Run ARR OSX",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"ArrExecutableNameWin": {
"description": "Executable Name for Windows",
"example": "Radarr.exe",
"type": "string",
"required": true
},
"ArrDownloadLink": {
"description": "Link to the Arr Downloads",
"type": "url",
"required": true
},
"ArrLinuxAutoStart": {
"description": "Autostart file instructions",
"required": true
},
"ARRPORT": {
"description": "Port number for the ARR",
"example": "Radarr: 7878, Sonarr: 8989, Lidarr: 8686, Readarr: 8787",
"type": "number",
"default": "7878",
"required": true
},
"ARRNAME2": {
"description": "Used for lowercase ARR names, this is not a required field only used if needed",
"example": "radarr, sonarr, lidarr, readarr",
"type": "string"
}
},
"paramOrder": [
"ARRNAME",
"RunArrCommandLinux",
"RunArrCommandOSX",
"ArrExecutableNameWin",
"ArrDownloadLink",
"ArrLinuxAutoStart",
"ARRPORT",
"ARRNAME2"
],
"description": "This template is expressly for the steps and processes of installing all the various ARR software on multiple different platforms"
}
</templatedata>
</noinclude>

= Installing =
== Windows ==

== OSX ==
{{#lst::Installation Misc|{{{ARRNAME2}}}_osx_big_sur_installation}}

== Linux ==

=== Debian / Ubuntu ===
Most of the "arr" software runs on mono, however newer version may run on .NET Core. If a .NET Core version is available, it will likely offer significant speed and resource enhancements.

===== Mono Install =====
First start by installing the dependencies:

Mono:
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
echo "deb https://download.mono-project.com/repo/ubuntu stable-focal main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
sudo apt update && sudo apt install mono-devel
Curl
sudo apt install curl
Mediainfo:
sudo apt install mediainfo
sqlite3:
sudo apt install sqlite3

Now download the newest mono version release of {{{ARRNAME}}}:
{{{ARRPackageFileMono}}}

Radarr: https://api.github.com/repos/Radarr/Radarr/releases
wget --content-disposition 'https://radarr.servarr.com/v1/update/master/updatefile?os=linux'
Sonarr: https://sonarr.tv/#download
wget --content-disposition 'https://services.sonarr.tv/v1/download/phantom-develop/latest?version=3&os=linux'

Uncompress:
tar -xvzf {{{ARRNAME}}}*.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser

===== .NET Core Install =====
There are no dependencies needed for the .NET Core Install path.

====== Manual Install ======
Go to the {{{ARRNAME}}} download page, and pick the appropriate file.
{{{ArrDownloadLink}}}

In the example screenshot here, you can see multiple options. Chose the option that matches your OS and processor best. For most users, this would be <code>.linux-core-x64.tar.gz</code> if it is available.
[[File:ARR Download Link Example.png|thumb|right|Example of Radarr download options]]

Download this file onto your system:

Radarr: https://api.github.com/repos/Radarr/Radarr/releases
wget --content-disposition 'http://radarr.servarr.com/v1/update/master/updatefile?os=linux&runtime=netcore&arch=x64'
Uncompress:
tar -xvzf {{{ARRNAME}}}*.linux-core-x64.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser

=== Auto Start Using Systemd ===
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

=== Preparing the Unit Service File ===
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that {{{ARRNAME2}}} will run as.
# <code>Group</code> should match the service account group that {{{ARRNAME2}}} will run as.
# <code>ExecStart</code> has several items that should match your installation <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>
## Executable Path Default location is <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>, but you may need to update if you installed {{{ARRNAME}}} elsewhere.
## Data Directory Default location is <code>-data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/</code>, but you may need to update if you want to keep your database and settings elsewhere.
## Mono Path (if Mono is being used) Default location is <code>/usr/bin/mono</code>, but you may need to update if you installed Mono elsewhere.

The unit service file should be named <code>{{{ARRNAME}}}.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>{{{ARRNAME2}}}</code>, {{{ARRNAME}}}'s executable is placed in <code>/opt/{{{ARRNAME}}}/</code>, the data directory is placed in <code>/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}</code>, and the Mono executable (if being used) is placed in <code>/usr/bin/mono</code>.

'''Important note:''' Both <code>ExecStart</code> lines are commented out below. Remove the # from the line matching your install type (Mono vs NetCore).

[Unit]
Description={{{ARRNAME}}} Daemon
After=syslog.target network.target

[Service]
# Change the user and group variables here.
User={{{ARRNAME2}}}
Group={{{ARRNAME2}}}

Type=simple

# NOTE: Uncomment one of the two below ExecStart lines, based on if {{{ARRNAME}}} is using NetCore or Mono.
# NetCore install:
#ExecStart=/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

# Mono Install:
#ExecStart=/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

TimeoutStopSec=20
KillMode=process
Restart=on-failure

[Install]
WantedBy=multi-user.target

=== Verify Directory Permissions ===
Ensure the <code>User</code> that will be running {{{ARRNAME}}} has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder.
Example:
$ ls -lad /opt/{{{ARRNAME}}}
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /opt/{{{ARRNAME}}}/
$ ls -lad /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

=== Enabling and starting the Unit Service File ===
Once you have created <code>{{{ARRNAME}}}.service</code>, you will want to enable the service:
sudo systemctl enable {{{ARRNAME}}}.service

You are now ready to start {{{ARRNAME}}}. You can do so with the <code>start</code> command:
sudo systemctl start {{{ARRNAME}}}.service

If you want to verify {{{ARRNAME}}} is running, you can run the <code>status</code> command:
$ sudo systemctl status {{{ARRNAME}}}.service
● {{{ARRNAME}}}.service - {{{ARRNAME}}}Service
Loaded: loaded (/usr/lib/systemd/system/{{{ARRNAME}}}.service; enabled; vendor preset: disabled)
Active: active (running) since Tue 2017-03-07 10:23:44 PST; 5min ago
Main PID: 19978 ({{{ARRNAME}}})
Tasks: 16 (limit: 4915)
Memory: 114.6M
CPU: 9.331s
CGroup: /system.slice/{{{ARRNAME}}}.service
└─19978 /opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
Mar 07 10:23:44 apollo systemd[1]: Started {{{ARRNAME}}} Service.

== NAS ==
=== FreeNAS ===
=== Qnap ===
=== Synology ===

== Docker ==

== Docker on unRAID ==
* Installation of {{{ARRNAME}}} is quite simple when it comes to unRAID as they have made installing Docker containers a breeze.
<ol style="list-style-type: decimal;">
<li>Simply head on over to the community applications store on the top bar of your browser. </li>
[[File:unraid-install1.png|frameless|750px|alt=Community Applications|Communitty Applications]]
<li>In the search field type in {{{ARRNAME}}} 
</li>
<li>Select which docker image you would like to install. There are several to choose from 
</li>
[[File:{{{ARRNAME}}}-unraid-install.png|frameless|none|750px|alt=Installation Options|Installation Options]]
<li> Depending on which container you go with will determine the steps in which you take. Some containers come preloaded with volumes mapped already. This is really up to your liking how you would like your container volumes to be laid out. It is highly recommended to follow the guide listed [[Docker Guide|here]] for your volume mapping 
</li>
 Depending on which container you select you may recieve a pop up asking you to '''Choose A Branch To Install''' when in doubt go with the <code>Default :latest</code> branch
<li> Once you have selected which container you are going to go with, you will need to either create the volumes for {{{ARRNAME}}} to be able to use or simply use the pre-filled ones. (Highly recommended to remove the pre-filled and use your own, to remove the pre-filled ones). </li>
 To remove the pre-filled paths simply select the toggle in the upper right from '''Basic''' to '''Advanced''' view then scroll down to the pre-filled path and click '''Remove'''
[[File:unraid-install3.png|frameless|750px|alt=Toggle Advanced|Toggle Advanced]]
<ol>
<li> To create new volumes simply select the <code> Add another Path, Port, Variable, Label or Device</code> text at the bottom above the '''Apply''' button. 
</li>
<li> Once the new window appears you will want to use the drop down box next to '''Config Type:''' and make sure that it is set to '''Path'''. 
</li>
<li> From here you will want to fill out all pertinant information: 
</li>
<ol>
<li>'''Name:''' The name of this path, this can be any unique name more like a note to know what this path is for. 
</li>
<li>'''Container Path:''' This will be the path that {{{ARRNAME}}} will see inside the container <code>/data</code> is a favorite 
</li>
<li>'''Host Path:''' This is the path to the host (unRAID) machine, This will be <code>/mnt/user/<Your User Share></code> 
</li>
 '''NOTE''' If you follow the [[Docker Guide]] you will only need one Volume path to be made as all information that {{{ARRNAME}}} will need will be in one share <code>/mnt/user/data</code>
<li> The last three items '''Default Value:''', '''Access Mode"''', and '''Description:''' Can be left alone. 
</li>
<li> Click '''ADD''' 
</li>
[[File:unraid-install4.png|frameless|750px|alt=Add New path|Add New Path]]
</ol>
<li> Last thing to check is to make sure Host Port for {{{ARRPORT}}} is filled in with <code>{{{ARRPORT}}}</code>, ''UNLESS'' This port causes any conflicts with any other container. If it does please choose a different port that is not in use. 
</li>
<li> Click '''APPLY''' 
</li>
</ol>
<li> Now the {{{ARRNAME}}}'s container is being downloaded, once complete simply click the '''OK''' button at the bottom of the new pop up window 
</li>
<li> Click '''DOCKER''' on the top row of your browser. 
</li>
<li> Now all you will need to do is simply left click on your newly created container and select '''WebUI'''. 
</li>
[[File:unraid-install2.png|frameless|none|250x240px|alt=Select WebUI|Select WebUI]]
<li> Now a new browser tab should show up with {{{ARRNAME}}} running in all its glory. '''ENJOY''' 
</li>
</ol>

Template:Installation

2020-12-01T20:45:12Z

Logvin: /* Linux */

<noinclude>
<templatedata>
{
"params": {
"ARRNAME": {
"description": "Name of the ARR",
"example": "Radarr",
"type": "string",
"required": true,
"default": "Fake Radarr"
},
"RunArrCommandLinux": {
"description": "Command to Start & Run ARR Linux",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"RunArrCommandOSX": {
"description": "Command to Start & Run ARR OSX",
"example": "./opt/Radarr/Radarr -nobrowser -data=/home/radarr/.config/Radarr/",
"type": "string",
"required": true
},
"ArrExecutableNameWin": {
"description": "Executable Name for Windows",
"example": "Radarr.exe",
"type": "string",
"required": true
},
"ArrDownloadLink": {
"description": "Link to the Arr Downloads",
"type": "url",
"required": true
},
"ArrLinuxAutoStart": {
"description": "Autostart file instructions",
"required": true
},
"ARRPORT": {
"description": "Port number for the ARR",
"example": "Radarr: 7878, Sonarr: 8989, Lidarr: 8686, Readarr: 8787",
"type": "number",
"default": "7878",
"required": true
},
"ARRNAME2": {
"description": "Used for lowercase ARR names, this is not a required field only used if needed",
"example": "radarr, sonarr, lidarr, readarr",
"type": "string"
}
},
"paramOrder": [
"ARRNAME",
"RunArrCommandLinux",
"RunArrCommandOSX",
"ArrExecutableNameWin",
"ArrDownloadLink",
"ArrLinuxAutoStart",
"ARRPORT",
"ARRNAME2"
],
"description": "This template is expressly for the steps and processes of installing all the various ARR software on multiple different platforms"
}
</templatedata>
</noinclude>

= Installing =
== Windows ==

== OSX ==
{{#lst::Installation Misc|{{{ARRNAME2}}}_osx_big_sur_installation}}

== Linux ==

=== Debian / Ubuntu ===
Most of the "arr" software runs on mono, however newer version may run on .NET Core. If a .NET Core version is available, it will likely offer significant speed and resource enhancements.

===== Mono Install =====
First start by installing the dependencies:

Mono:
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
echo "deb https://download.mono-project.com/repo/ubuntu stable-focal main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
sudo apt update && sudo apt install mono-devel
Curl
sudo apt install curl
Mediainfo:
sudo apt install mediainfo
sqlite3:
sudo apt install sqlite3

Now download the newest mono version release of {{{ARRNAME}}}:

Radarr: https://api.github.com/repos/Radarr/Radarr/releases
wget --content-disposition 'https://radarr.servarr.com/v1/update/master/updatefile?os=linux'
Sonarr: https://sonarr.tv/#download
wget --content-disposition 'https://services.sonarr.tv/v1/download/phantom-develop/latest?version=3&os=linux'

Uncompress:
tar -xvzf {{{ARRNAME}}}*.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser

===== .NET Core Install =====
There are no dependencies needed for the .NET Core Install path.

====== Manual Install ======
Go to the {{{ARRNAME}}} download page, and pick the appropriate file.
{{{ArrDownloadLink}}}

In the example screenshot here, you can see multiple options. Chose the option that matches your OS and processor best. For most users, this would be <code>.linux-core-x64.tar.gz</code> if it is available.
[[File:ARR Download Link Example.png|thumb|right|Example of Radarr download options]]

Download this file onto your system:

Radarr: https://api.github.com/repos/Radarr/Radarr/releases
wget --content-disposition 'http://radarr.servarr.com/v1/update/master/updatefile?os=linux&runtime=netcore&arch=x64'
Uncompress:
tar -xvzf {{{ARRNAME}}}*.linux-core-x64.tar.gz
Move to your preferred install location (typically <code>/opt/{{{ARRNAME}}}/</code>
sudo mv {{{ARRNAME}}}/ /opt
Finally, make sure you grant the needed permission to your install directory:
sudo chown {{{ARRNAME2}}}:{{{ARRNAME2}}} /opt/{{{ARRNAME}}}

You can start {{{ARRNAME}}} with the following command:
/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser

=== Auto Start Using Systemd ===
Most modern Linux distributions have switched to systemd, which involves a simple unit service file which gets enabled and started. It is important to remember that in Linux, capitalization matters. <code>User</code> account names and <code>Group</code> names are typically all lowercase, as are the directory structures mapped to them as part of the home directory.

=== Preparing the Unit Service File ===
Several items may need to be changed to match your installation:

# <code>User</code> should match the service account that {{{ARRNAME2}}} will run as.
# <code>Group</code> should match the service account group that {{{ARRNAME2}}} will run as.
# <code>ExecStart</code> has several items that should match your installation <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>
## Executable Path Default location is <code>/opt/{{{ARRNAME}}}/{{{ARRNAME}}}</code>, but you may need to update if you installed {{{ARRNAME}}} elsewhere.
## Data Directory Default location is <code>-data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/</code>, but you may need to update if you want to keep your database and settings elsewhere.
## Mono Path (if Mono is being used) Default location is <code>/usr/bin/mono</code>, but you may need to update if you installed Mono elsewhere.

The unit service file should be named <code>{{{ARRNAME}}}.service</code> and the best place for it is <code>/etc/systemd/system/</code>. Alternative locations like <code>/usr/lib/systemd/system/</code> and <code>/lib/systemd/system/</code> may depend on the distribution used.

This example unit assumes that the <code>User</code> and <code>Group</code> are both <code>{{{ARRNAME2}}}</code>, {{{ARRNAME}}}'s executable is placed in <code>/opt/{{{ARRNAME}}}/</code>, the data directory is placed in <code>/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}</code>, and the Mono executable (if being used) is placed in <code>/usr/bin/mono</code>.

'''Important note:''' Both <code>ExecStart</code> lines are commented out below. Remove the # from the line matching your install type (Mono vs NetCore).

[Unit]
Description={{{ARRNAME}}} Daemon
After=syslog.target network.target

[Service]
# Change the user and group variables here.
User={{{ARRNAME2}}}
Group={{{ARRNAME2}}}

Type=simple

# NOTE: Uncomment one of the two below ExecStart lines, based on if {{{ARRNAME}}} is using NetCore or Mono.
# NetCore install:
#ExecStart=/opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

# Mono Install:
#ExecStart=/usr/bin/mono --debug /opt/{{{ARRNAME}}}/{{{ARRNAME}}}.exe -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

TimeoutStopSec=20
KillMode=process
Restart=on-failure

[Install]
WantedBy=multi-user.target

=== Verify Directory Permissions ===
Ensure the <code>User</code> that will be running {{{ARRNAME}}} has access to both the executable directory and data directory.
Running the command <code>ls -lad /directory/</code> will show the permissions for that folder.
Example:
$ ls -lad /opt/{{{ARRNAME}}}
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /opt/{{{ARRNAME}}}/
$ ls -lad /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
drwxr-xr-x 6 {{{ARRNAME2}}} {{{ARRNAME2}}} 24576 Nov 28 21:30 /home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/

=== Enabling and starting the Unit Service File ===
Once you have created <code>{{{ARRNAME}}}.service</code>, you will want to enable the service:
sudo systemctl enable {{{ARRNAME}}}.service

You are now ready to start {{{ARRNAME}}}. You can do so with the <code>start</code> command:
sudo systemctl start {{{ARRNAME}}}.service

If you want to verify {{{ARRNAME}}} is running, you can run the <code>status</code> command:
$ sudo systemctl status {{{ARRNAME}}}.service
● {{{ARRNAME}}}.service - {{{ARRNAME}}}Service
Loaded: loaded (/usr/lib/systemd/system/{{{ARRNAME}}}.service; enabled; vendor preset: disabled)
Active: active (running) since Tue 2017-03-07 10:23:44 PST; 5min ago
Main PID: 19978 ({{{ARRNAME}}})
Tasks: 16 (limit: 4915)
Memory: 114.6M
CPU: 9.331s
CGroup: /system.slice/{{{ARRNAME}}}.service
└─19978 /opt/{{{ARRNAME}}}/{{{ARRNAME}}} -nobrowser -data=/home/{{{ARRNAME2}}}/.config/{{{ARRNAME}}}/
Mar 07 10:23:44 apollo systemd[1]: Started {{{ARRNAME}}} Service.

== NAS ==
=== FreeNAS ===
=== Qnap ===
=== Synology ===

== Docker ==

== Docker on unRAID ==
* Installation of {{{ARRNAME}}} is quite simple when it comes to unRAID as they have made installing Docker containers a breeze.
<ol style="list-style-type: decimal;">
<li>Simply head on over to the community applications store on the top bar of your browser. </li>
[[File:unraid-install1.png|frameless|750px|alt=Community Applications|Communitty Applications]]
<li>In the search field type in {{{ARRNAME}}} 
</li>
<li>Select which docker image you would like to install. There are several to choose from 
</li>
[[File:{{{ARRNAME}}}-unraid-install.png|frameless|none|750px|alt=Installation Options|Installation Options]]
<li> Depending on which container you go with will determine the steps in which you take. Some containers come preloaded with volumes mapped already. This is really up to your liking how you would like your container volumes to be laid out. It is highly recommended to follow the guide listed [[Docker Guide|here]] for your volume mapping 
</li>
 Depending on which container you select you may recieve a pop up asking you to '''Choose A Branch To Install''' when in doubt go with the <code>Default :latest</code> branch
<li> Once you have selected which container you are going to go with, you will need to either create the volumes for {{{ARRNAME}}} to be able to use or simply use the pre-filled ones. (Highly recommended to remove the pre-filled and use your own, to remove the pre-filled ones). </li>
 To remove the pre-filled paths simply select the toggle in the upper right from '''Basic''' to '''Advanced''' view then scroll down to the pre-filled path and click '''Remove'''
[[File:unraid-install3.png|frameless|750px|alt=Toggle Advanced|Toggle Advanced]]
<ol>
<li> To create new volumes simply select the <code> Add another Path, Port, Variable, Label or Device</code> text at the bottom above the '''Apply''' button. 
</li>
<li> Once the new window appears you will want to use the drop down box next to '''Config Type:''' and make sure that it is set to '''Path'''. 
</li>
<li> From here you will want to fill out all pertinant information: 
</li>
<ol>
<li>'''Name:''' The name of this path, this can be any unique name more like a note to know what this path is for. 
</li>
<li>'''Container Path:''' This will be the path that {{{ARRNAME}}} will see inside the container <code>/data</code> is a favorite 
</li>
<li>'''Host Path:''' This is the path to the host (unRAID) machine, This will be <code>/mnt/user/<Your User Share></code> 
</li>
 '''NOTE''' If you follow the [[Docker Guide]] you will only need one Volume path to be made as all information that {{{ARRNAME}}} will need will be in one share <code>/mnt/user/data</code>
<li> The last three items '''Default Value:''', '''Access Mode"''', and '''Description:''' Can be left alone. 
</li>
<li> Click '''ADD''' 
</li>
[[File:unraid-install4.png|frameless|750px|alt=Add New path|Add New Path]]
</ol>
<li> Last thing to check is to make sure Host Port for {{{ARRPORT}}} is filled in with <code>{{{ARRPORT}}}</code>, ''UNLESS'' This port causes any conflicts with any other container. If it does please choose a different port that is not in use. 
</li>
<li> Click '''APPLY''' 
</li>
</ol>
<li> Now the {{{ARRNAME}}}'s container is being downloaded, once complete simply click the '''OK''' button at the bottom of the new pop up window 
</li>
<li> Click '''DOCKER''' on the top row of your browser. 
</li>
<li> Now all you will need to do is simply left click on your newly created container and select '''WebUI'''. 
</li>
[[File:unraid-install2.png|frameless|none|250x240px|alt=Select WebUI|Select WebUI]]
<li> Now a new browser tab should show up with {{{ARRNAME}}} running in all its glory. '''ENJOY''' 
</li>
</ol>