From c8834d8324921809e8eb73d4309aa85a3572fc2b Mon Sep 17 00:00:00 2001 From: rasmus-kirk Date: Thu, 19 Jun 2025 09:18:44 +0200 Subject: [PATCH] More docs --- docs/wiki/setup/index.md | 56 +++++++++++++++++++++------------------- 1 file changed, 29 insertions(+), 27 deletions(-) diff --git a/docs/wiki/setup/index.md b/docs/wiki/setup/index.md index cf9d8ab..202298a 100644 --- a/docs/wiki/setup/index.md +++ b/docs/wiki/setup/index.md @@ -7,7 +7,9 @@ default ports; if you changed them, you will need to change the ports in the URLs. Same if you are using a domain name—change the URLs to match. We assume you are using the [first example](/wiki/examples/example-1) in your Nix configuration. Replace {URL} in this document with your server IP or domain. -(You also can remove the port if not needed) + +In the below setup, we assume you also didn't set the `nixarr.mediaDir` +option, which by defuault is set to `/data/media`. ## Jellyfin @@ -22,14 +24,19 @@ configuration. Replace {URL} in this document with your server IP or domain. - You can add music, books, etc. - Continue the setup. -**Optimisation**: +**Recommendations:**: - Reduce the scan media library interval for small libraries: See `Scheduled Tasks`: {URL}:8096/web/index.html#/dashboard/tasks/ ## Transmission -- ... ? +Transmission should already be setupup and running since it's configured +with JSON, and can therefore be configured with nix. The most basic settings are already set. See the following links for more info: + +- [The configured Nixarr defaults for transmission](https://github.com/rasmus-kirk/nixarr/blob/28d1be070deb1a064c1967889c11c8921752fa09/nixarr/transmission/default.nix#L355) +- [The `nixarr.transmission` options](https://nixarr.com/nixos-options/#nixarr.transmission.enable) +- [Settings that can be passed through `nixarr.transmission.settings`] ## Radarr @@ -37,12 +44,15 @@ configuration. Replace {URL} in this document with your server IP or domain. - You will be asked to set up a new account. - Choose `Forms` as the auth method and choose a username & password. - You can now log in. -- Go to "Settings" > "Media Management" > "Root Folders" and click - `Add Root Folder`. Add `/data/media/library/movies/`, then click - `Save Changes`. -- Go to "Settings" > "Download Clients" and add Transmission. +- Go to "Settings" > "Media Management": + - Click on `Show Advanced` + - Under `Importing`, enable `Use Hardlinks instead of Copy` + - Under `Root Folders`, click `Add Root Folder`. Add + `/data/media/library/movies/`, then click `Save Changes`. +- Go to "Settings" > "Download Clients" and add Transmission. Change the + category to `radarr`. -**Optimisation**: +**Recommendations:**: - Go to {URL}:7878/settings/mediamanagement and set `Unmonitor Deleted Movies` to true. @@ -53,13 +63,15 @@ configuration. Replace {URL} in this document with your server IP or domain. - You will be asked to set up a new account. - Choose `Forms` as the auth method and choose a username & password. - You can now log in. -- Go to "Settings" > "Media Management" > "Root Folders" and click - `Add Root Folder`. Add `/data/media/library/shows/`, then click - `Save Changes`. +- Go to "Settings" > "Media Management": + - Click on `Show Advanced` + - Under `Importing`, enable `Use Hardlinks instead of Copy` + - Under `Root Folders`, click `Add Root Folder`. Add + `/data/media/library/movies/`, then click `Save Changes`. - Go to "Settings" > "Download Clients" and add Transmission. Change the category to `sonarr`. -**Optimisation**: +**Recommendations:**: - Go to {URL}:8989/settings/mediamanagement and set `Unmonitor Deleted Episodes` to true. @@ -69,8 +81,8 @@ configuration. Replace {URL} in this document with your server IP or domain. - Open your browser and go to `{URL}:5055`. - Follow the installation wizard: - Choose Jellyfin (or Plex). - - Add your Jellyfin URL, username & password (you can leave the path empty and - use a dummy email). + - Add your Jellyfin URL, username & password (you can leave the path + empty and use a dummy email). - Click on `Sync Libraries` and toggle `Movies` and `Shows`, click `Next`. - Add your Radarr and Sonarr apps. - Get the API key by typing `sudo nixarr list-api-keys` in your terminal. @@ -88,10 +100,12 @@ configuration. Replace {URL} in this document with your server IP or domain. - Click `Test` to ensure the connection works, then `Save`. - Go to "Settings" > "Providers" and enable the subtitle providers you want. -**Optimisation**: +**Recommendations:**: - Go to {URL}:6767/settings/general and set `Unmonitor Deleted Subtitles` to true. +- Go to "Settings" > "Audio Synchronization / Alignment" > "Automatic + Subtitles Audio Synchronization" ## Prowlarr @@ -103,15 +117,3 @@ configuration. Replace {URL} in this document with your server IP or domain. - You can now log in. - Go to "Settings" > "Apps" and add your _Arrs_. - Get the API key by typing `sudo nixarr list-api-keys` in your terminal. - -**Add indexers**: - -- Open your browser and go to `{URL}:9696`. -- Click on the `Add Indexer` button. -- You can now add as many indexers as you want. We recommend filtering them by: - - Protocol - - Language - - Privacy: - - **Public**: Trackers/indexing sites open to anyone without registration. - - **Semi-Private**: Require registration, but generally accessible. - - **Private**: Require invitations or strict applications.