From def8e6fec0ae830e841baee310d042a116506388 Mon Sep 17 00:00:00 2001 From: Hadi <112569860+anotherhadi@users.noreply.github.com> Date: Tue, 13 May 2025 22:35:45 +0200 Subject: [PATCH 1/7] DRAFT: setup Signed-off-by: Hadi <112569860+anotherhadi@users.noreply.github.com> --- docs/wiki/index.md | 1 + docs/wiki/setup/index.md | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 docs/wiki/setup/index.md diff --git a/docs/wiki/index.md b/docs/wiki/index.md index 58681fe..f257abe 100644 --- a/docs/wiki/index.md +++ b/docs/wiki/index.md @@ -10,6 +10,7 @@ This is an index of existing articles: - **Examples** - **[Basic Example](/wiki/examples/example-1)** - **[Example Configuration Where Port Forwarding Is Not an Option](/wiki/examples/example-2)** +- **[Setup the applications](/wiki/setup)** - **[Exposing Services Safely](/wiki/expose)** - **VPN** - **[Running Services Not Covered by Nixarr Through a VPN](/wiki/vpn/uncovered-services)** diff --git a/docs/wiki/setup/index.md b/docs/wiki/setup/index.md new file mode 100644 index 0000000..0456eb4 --- /dev/null +++ b/docs/wiki/setup/index.md @@ -0,0 +1,32 @@ +--- +title: Setup the applications +--- + +Here are some guides to help you set up the applications. +We asume you let the default ports, if you changed them, you will need to change the port in the URLs. +Same if you are using a domain name, change the URLs to your domain name. +We asume you are using the [first example](/wiki/examples/example-1) in your nix configuration. + +## Jellyfin + +- Open your browser and go to `http://localhost:8096`. +- Follow the setup wizard. + +## Jellyseerr + +## Radarr + +- Open your browser and go to `http://localhost:7878`. +- You will be asked to set up a new account. + +## Sonarr + +## Bazarr + +## Prowlarr + +- Open your browser and go to `http://localhost:9696`. +- You will be asked to set up a new account. +- Go to Settings > Apps and add your *Arrs. To get the API key, go to: + - Radarr: `http://localhost:7878/settings/general` + - Sonarr: `http://localhost:8989/settings/general` From 28d1be070deb1a064c1967889c11c8921752fa09 Mon Sep 17 00:00:00 2001 From: rasmus-kirk Date: Wed, 18 Jun 2025 16:20:41 +0200 Subject: [PATCH 2/7] Fixed cross-seed issue --- nixarr/transmission/cross-seed/default.nix | 1 + 1 file changed, 1 insertion(+) diff --git a/nixarr/transmission/cross-seed/default.nix b/nixarr/transmission/cross-seed/default.nix index b637b77..929b12b 100644 --- a/nixarr/transmission/cross-seed/default.nix +++ b/nixarr/transmission/cross-seed/default.nix @@ -6,6 +6,7 @@ }: with lib; let cfg = config.util-nixarr.services.cross-seed; + globals = config.util-nixarr.globals; settingsFormat = pkgs.formats.json {}; settingsFile = settingsFormat.generate "settings.json" cfg.settings; configJs = pkgs.writeText "config.js" '' From 966e637eec7aaf8561b76bec6fa4a134c00ed4f6 Mon Sep 17 00:00:00 2001 From: Hadi <112569860+anotherhadi@users.noreply.github.com> Date: Wed, 18 Jun 2025 18:34:56 +0200 Subject: [PATCH 3/7] Add instructions Signed-off-by: Hadi <112569860+anotherhadi@users.noreply.github.com> --- docs/wiki/setup/index.md | 107 ++++++++++++++++++++++++++++++++++----- 1 file changed, 95 insertions(+), 12 deletions(-) diff --git a/docs/wiki/setup/index.md b/docs/wiki/setup/index.md index 0456eb4..200dd7b 100644 --- a/docs/wiki/setup/index.md +++ b/docs/wiki/setup/index.md @@ -2,31 +2,114 @@ title: Setup the applications --- -Here are some guides to help you set up the applications. -We asume you let the default ports, if you changed them, you will need to change the port in the URLs. -Same if you are using a domain name, change the URLs to your domain name. -We asume you are using the [first example](/wiki/examples/example-1) in your nix configuration. +Here are some guides to help you set up the applications. We assume you left the +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) ## Jellyfin -- Open your browser and go to `http://localhost:8096`. -- Follow the setup wizard. +- Open your browser and go to `{URL}:8096`. +- Click "Add Server" and put your server address (e.g. `{URL}:8096`). +- Follow the setup wizard: + - Create your administrator account. + - Setup two libraries: + - Movies: Choose "Movies" as content type, then add the + `/data/media/library/movies` folder. + - TV Shows: Same with `/data/media/library` as the folder. + - You can add music, books, etc. + - Continue the setup. -## Jellyseerr +**Optimisation**: + +- Reduce the "Scan Media Library" interval for small libraries: See "Scheduled + Tasks": {URL}:8096/web/index.html#/dashboard/tasks/ + +## Transmission + +(Instructions missing) ## Radarr -- Open your browser and go to `http://localhost:7878`. +- Open your browser and go to `{URL}:7878`. - 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 Save Changes. +- Go to "Settings" > "Download Clients" and add Transmission. + +**Optimisation**: + +- Go to {URL}:7878/settings/mediamanagement and set "Unmonitor Deleted Movies" + to true. ## Sonarr +- Open your browser and go to `{URL}:8989`. +- 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 Save Changes. +- Go to "Settings" > "Download Clients" and add Transmission. Change the + category to "sonarr". + +**Optimisation**: + +- Go to {URL}:8989/settings/mediamanagement and set "Unmonitor Deleted Episodes" + to true. + +## Jellyseerr + +- 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). + - Click on "Sync Libraries" and toggle "Movies" and "Shows", click Next. + - Add your Radarr and Sonarr apps. + - To show your API keys, run `sudo nixarr list-api-keys`. + ## Bazarr +- Open your browser and go to `{URL}:6767`. +- Go to "Settings" > "Languages": + - select your preferred languages for subtitles in "Languages Filter", then + add a languages profile + - Add a default Language profiles for series and movies +- Go to "Settings" > "Sonarr" and "Settings" > "Radarr" to add your respective + Sonarr and Radarr instances. + - Get the API key by typing sudo nixarr list-api-keys in your terminal. + - Click "Test" to ensure the connection works, then "Save". +- Go to "Settings" > "Providers" and enable the subtitle providers you want. + +**Optimisation**: + +- Go to {URL}:6767/settings/general and set "Unmonitor Deleted Subtitles" to + true. + ## Prowlarr -- Open your browser and go to `http://localhost:9696`. +**Initial setup**: + +- Open your browser and go to `{URL}:9696`. - You will be asked to set up a new account. -- Go to Settings > Apps and add your *Arrs. To get the API key, go to: - - Radarr: `http://localhost:7878/settings/general` - - Sonarr: `http://localhost:8989/settings/general` + - Choose "Forms" as the auth method and choose a username & password. + - You can now log in. +- Go to Settings > Apps and add your \*Arrs. To get the API keys, run + `sudo nixarr list-api-keys`. + +**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. From 83d6acb3f969b88d5021697551031e6af2cbafae Mon Sep 17 00:00:00 2001 From: Hadi <112569860+anotherhadi@users.noreply.github.com> Date: Wed, 18 Jun 2025 18:42:52 +0200 Subject: [PATCH 4/7] Add quotes, fix typo Signed-off-by: Hadi <112569860+anotherhadi@users.noreply.github.com> --- docs/wiki/setup/index.md | 46 +++++++++++++++++++++------------------- 1 file changed, 24 insertions(+), 22 deletions(-) diff --git a/docs/wiki/setup/index.md b/docs/wiki/setup/index.md index 200dd7b..cf9d8ab 100644 --- a/docs/wiki/setup/index.md +++ b/docs/wiki/setup/index.md @@ -12,7 +12,7 @@ configuration. Replace {URL} in this document with your server IP or domain. ## Jellyfin - Open your browser and go to `{URL}:8096`. -- Click "Add Server" and put your server address (e.g. `{URL}:8096`). +- Click `Add Server` and put your server address - Follow the setup wizard: - Create your administrator account. - Setup two libraries: @@ -24,42 +24,44 @@ configuration. Replace {URL} in this document with your server IP or domain. **Optimisation**: -- Reduce the "Scan Media Library" interval for small libraries: See "Scheduled - Tasks": {URL}:8096/web/index.html#/dashboard/tasks/ +- Reduce the scan media library interval for small libraries: See + `Scheduled Tasks`: {URL}:8096/web/index.html#/dashboard/tasks/ ## Transmission -(Instructions missing) +- ... ? ## Radarr - Open your browser and go to `{URL}:7878`. - You will be asked to set up a new account. - - Choose "Forms" as the auth method and choose a username & password. + - 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 Save Changes. +- 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. **Optimisation**: -- Go to {URL}:7878/settings/mediamanagement and set "Unmonitor Deleted Movies" +- Go to {URL}:7878/settings/mediamanagement and set `Unmonitor Deleted Movies` to true. ## Sonarr - Open your browser and go to `{URL}:8989`. - You will be asked to set up a new account. - - Choose "Forms" as the auth method and choose a username & password. + - 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 Save Changes. +- Go to "Settings" > "Media Management" > "Root Folders" and click + `Add Root Folder`. Add `/data/media/library/shows/`, then click + `Save Changes`. - Go to "Settings" > "Download Clients" and add Transmission. Change the - category to "sonarr". + category to `sonarr`. **Optimisation**: -- Go to {URL}:8989/settings/mediamanagement and set "Unmonitor Deleted Episodes" +- Go to {URL}:8989/settings/mediamanagement and set `Unmonitor Deleted Episodes` to true. ## Jellyseerr @@ -69,9 +71,9 @@ configuration. Replace {URL} in this document with your server IP or domain. - Choose Jellyfin (or Plex). - 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. + - Click on `Sync Libraries` and toggle `Movies` and `Shows`, click `Next`. - Add your Radarr and Sonarr apps. - - To show your API keys, run `sudo nixarr list-api-keys`. + - Get the API key by typing `sudo nixarr list-api-keys` in your terminal. ## Bazarr @@ -79,16 +81,16 @@ configuration. Replace {URL} in this document with your server IP or domain. - Go to "Settings" > "Languages": - select your preferred languages for subtitles in "Languages Filter", then add a languages profile - - Add a default Language profiles for series and movies + - Add a "Default Language Profile" for "Series" and "Movies" - Go to "Settings" > "Sonarr" and "Settings" > "Radarr" to add your respective Sonarr and Radarr instances. - - Get the API key by typing sudo nixarr list-api-keys in your terminal. - - Click "Test" to ensure the connection works, then "Save". + - Get the API key by typing `sudo nixarr list-api-keys` in your terminal. + - Click `Test` to ensure the connection works, then `Save`. - Go to "Settings" > "Providers" and enable the subtitle providers you want. **Optimisation**: -- Go to {URL}:6767/settings/general and set "Unmonitor Deleted Subtitles" to +- Go to {URL}:6767/settings/general and set `Unmonitor Deleted Subtitles` to true. ## Prowlarr @@ -97,10 +99,10 @@ configuration. Replace {URL} in this document with your server IP or domain. - Open your browser and go to `{URL}:9696`. - You will be asked to set up a new account. - - Choose "Forms" as the auth method and choose a username & password. + - Choose `Forms` as the auth method and choose a username & password. - You can now log in. -- Go to Settings > Apps and add your \*Arrs. To get the API keys, run - `sudo nixarr list-api-keys`. +- Go to "Settings" > "Apps" and add your _Arrs_. + - Get the API key by typing `sudo nixarr list-api-keys` in your terminal. **Add indexers**: From c8834d8324921809e8eb73d4309aa85a3572fc2b Mon Sep 17 00:00:00 2001 From: rasmus-kirk Date: Thu, 19 Jun 2025 09:18:44 +0200 Subject: [PATCH 5/7] 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. From df523c209a5a2d0216f9344cb519715bf19a593e Mon Sep 17 00:00:00 2001 From: rasmus-kirk Date: Thu, 19 Jun 2025 09:20:56 +0200 Subject: [PATCH 6/7] Update website-builder --- flake.lock | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/flake.lock b/flake.lock index 2507403..86f3aaf 100644 --- a/flake.lock +++ b/flake.lock @@ -45,11 +45,11 @@ ] }, "locked": { - "lastModified": 1750078291, - "narHash": "sha256-VfEXZ2gcOB4M9y0fjxazJcChJyzNe5WiP7v3tgH04kM=", + "lastModified": 1750317638, + "narHash": "sha256-B4RWcXXOLO6gMeYyV+K4olu+kGGsYamKH+JAm0cIXqI=", "owner": "rasmus-kirk", "repo": "website-builder", - "rev": "f4605389da7159424a53bcd8781be0e59c63a325", + "rev": "b54192000a00e865947f45bacf3184d56363ee38", "type": "github" }, "original": { From 450d76583ae6ec025577bde7da2a38cfc7fb0510 Mon Sep 17 00:00:00 2001 From: rasmus-kirk Date: Thu, 19 Jun 2025 23:13:37 +0200 Subject: [PATCH 7/7] Fixed readarr-audiobook --- util/globals/default.nix | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/util/globals/default.nix b/util/globals/default.nix index 9283d07..8aff0ec 100644 --- a/util/globals/default.nix +++ b/util/globals/default.nix @@ -87,7 +87,7 @@ in { }; readarr-audiobook = { user = "readarr-audiobook"; - readarr-group = globals.libraryOwner.group; + group = globals.libraryOwner.group; }; recyclarr = { user = "recyclarr";