Nixflix is a declarative media server configuration manager for NixOS. The aim of the project is to automate
all of the connective tissue required to get Starr and Jellyfin services (Sonarr, Radarr, Lidarr, Prowlarr, Jellyfin, Seerr) working
together. I want users to be able to configure this module and it just works.
Why Nixflix?
Dreading the thought of configuring a media server from scratch. Again...
Nixflix makes it so you never have to again!
Managing media server configuration can be very painful:
- No version control for settings
- Tedious navigation through UI systems
- And annoying interservice Configuration
All of these services have APIs, surely we can use this to automate the whole thing.
Nixflix is:
- ✅ Opinionated — Don't you hate having to think for yourself?
- ✅ API-based — Nixflix uses official REST APIs of each service (with a couple minor exceptions)
- ✅ Idempotent — All services safely execute repeatedly
- ✅ Commanding — Your code is the source of truth, no need to fear drift
Features
- Media Server Stack: Pre-configured modules for Sonarr, Radarr, Lidarr, and Prowlarr
- Declarative API Configuration: Configure services declaratively via NixOS options, automatically applied through their REST APIs
- PostgreSQL Integration: Optional PostgreSQL backend for all Arr services
- WireGuard VPN Integration: Built-in support for Wireguard VPN with kill switch and custom DNS
- Flexible Directory Management: Configurable media and state directories with automatic setup
- Service Dependencies: Configure custom systemd service dependencies
- Reverse Proxy Support: Configurable nginx or Caddy integration for all services, with per-service opt-out
- Unified Theming: All supported services can be themed to look the same, powered by theme.park
- TRaSH Guides: Default configuration follows TRaSH guidelines
Upcoming Features
Documentation
Check out the documentation to get started.
Services
Starr Stack
All Arr services (Sonarr, Radarr, Lidarr, Prowlarr) support:
- API-based configuration
- PostgreSQL integration
- Reverse proxy (nginx or Caddy)
- Automatic directory creation
- Root folder management
- Custom media directories
Jellyfin
- Basic server management
- Libraries are automatically configured based on selected media managers
- Plugin management
- Subtitle downloader management
Seerr
- Media request management
- Automatic integration with Starr services
- Automatic integration with Jellyfin libraries
Navidrome
- Music Server
- Supports OpenSubsonic API
SABnzbd
- Automatic integration with Starr services
qBittorrent
- Automatic integration with Starr services
Soulseek (slskd)
- Automatic integration with Aurral (comming soon)
WireGuard VPN
- Generic WireGuard support
- Kill switch
Maintainerr
- Automatic cleanup of old media
Development
Enter development shell:
nix develop
Format code:
nix fmt
Check formatting and linting:
nix flake check
License
MPL 2.0
