Files
nixarr/docs/wiki/examples/example-1/index.md
T
Alexander 8b4a4c67b2
Deploy / run-nix-build (push) Has been cancelled
Deploy / deploy-site (push) Has been cancelled
Lint / fmt (push) Has been cancelled
Lint / build-website (push) Has been cancelled
Lint / test (push) Has been cancelled
Add qBittorrent
2026-04-26 15:51:43 +02:00

65 lines
1.8 KiB
Markdown

---
title: Basic Example
---
This example does the following:
- Runs a jellyfin server and exposes it to the internet with HTTPS support.
- Runs a torrent client (Transmission or qBittorrent) through a VPN
- Runs all "*Arrs" supported by this module
```nix {.numberLines}
nixarr = {
enable = true;
# These two values are also the default, but you can set them to whatever
# else you want
# WARNING: Do _not_ set them to `/home/user/whatever`, it will not work!
mediaDir = "/data/media";
stateDir = "/data/media/.state/nixarr";
vpn = {
enable = true;
# WARNING: This file must _not_ be in the config git directory
# You can usually get this wireguard file from your VPN provider
wgConf = "/data/.secret/wg.conf";
};
jellyfin = {
enable = true;
# These options set up a nginx HTTPS reverse proxy, so you can access
# Jellyfin on your domain with HTTPS
expose.https = {
enable = true;
domainName = "your.domain.com";
acmeMail = "your@email.com"; # Required for ACME-bot
};
};
transmission = {
enable = true;
vpn.enable = true;
peerPort = 50000; # Set this to the port forwarded by your VPN
};
# It is possible for this module to run the *Arrs through a VPN, but it
# is generally not recommended, as it can cause rate-limiting issues.
bazarr.enable = true;
lidarr.enable = true;
prowlarr.enable = true;
radarr.enable = true;
readarr.enable = true;
sonarr.enable = true;
jellyseerr.enable = true;
};
```
To use qBittorrent instead of Transmission, replace the `transmission` block with:
```nix {.numberLines}
qbittorrent = {
enable = true;
vpn.enable = true;
peerPort = 50000; # Set this to the port forwarded by your VPN
};
```