assemblrr

Note

Developer’s note — vision & roadmap
assemblrr is infrastructure for self-hosted media automation (install, wire services, operate the stack). It does not provide media, indexers, or content. What you request, download, and host is entirely your responsibility and must comply with the laws that apply to you.

Future directions and ideas shall be discussed with the community here

Self-hosted media automation, set up in minutes, not a weekend.

Features

• Guided Multi-Platform Install: Interactive wizard for Linux or Windows (via WSL2).
• Automated Service Wiring: Automatically configures and connects Radarr, Sonarr, Prowlarr, qBittorrent, Seerr, Recyclarr, and your media server post-install.
• VPN-First Architecture: Gluetun integration forces download client traffic through the VPN, complete with start-time verification and a stalled-routing watchdog.
• Built-in Operator CLI: Manage the stack (start, stop, status), edit configurations, snapshot backups, and update containers from the command line.
• Optimized Media Layout: Built-in hardlinks-friendly structure for Jellyfin/Emby/Plex with out-of-the-box TRaSH Guides quality profiles.

The Stack

• Media Server: Jellyfin (recommended), Emby, or Plex
• Download Client: qBittorrent
• Managers: Sonarr, Radarr
• Indexing: Prowlarr
• Request Management: Seerr
• Quality Profiles: Recyclarr
• Management: Portainer

Installation

Linux / WSL2

Note: bash must be installed to run the setup script.

bash / zsh:

bash <(curl -fsSL https://raw.githubusercontent.com/soulis-1256/assemblrr/main/platform/linux/bootstrap.sh)

fish (no <(...) process substitution — use psub instead):

bash (curl -fsSL https://raw.githubusercontent.com/soulis-1256/assemblrr/main/platform/linux/bootstrap.sh | psub)

Windows (PowerShell)

Ensure Docker Desktop is running before execution.

irm https://raw.githubusercontent.com/soulis-1256/assemblrr/main/platform/windows/bootstrap.ps1 | iex

Usage (CLI)

After install, the CLI is on your PATH as assemblrr. Run assemblrr <command>:

Command	Description
start	Start all services (with VPN verification)
stop	Stop all services
restart	Restart all services
status	Show container status
health	Show healthcheck status of all services
logs [service]	Follow logs (all services, or one)
config	List config subcommands
config show	Show current configuration
config edit	Re-run the setup wizard (current values as defaults)
config sync	Re-wire service APIs (Radarr, Sonarr, Prowlarr, Seerr, …)
backup /target/dir	Snapshot configuration
restore /backup.tar.gz	Restore from a backup archive
update-containers	Pull latest images and restart (offers a backup first)
update-cli	Update the CLI to the latest version
check-vpn	Poll VPN health
uninstall	Remove everything (asks before deleting data)

Uninstall

assemblrr uninstall stops and removes the containers, network, CLI, and installation directory. Your media is kept unless you explicitly delete it. If the CLI is missing or the installation is broken, you can still run the bundled CLI directly (bash ~/assemblrr/cli.sh uninstall) or remove everything by hand.

See docs/uninstall.md for the complete removal guide, including a full inventory of what an installation creates.

Configuration & Architecture

Configuration lives in your installation directory (default: ~/assemblrr).

• .env: Generated at install from .env.example (all variables are documented there). Credentials live under secrets/, not in .env.
• compose/base.yaml: Core services.
• compose/vpn.yaml / compose/direct-access.yaml: Networking overlays.
• compose/custom.yaml: Optional services (from the example under compose/examples/).
• config/: Persistent service data.

Documentation

• TRaSH Guides & Quality Profiles: Details on how assemblrr handles quality profiles and what to do when community guide IDs change.
• Uninstall Guide: Complete removal guide, including a full inventory of what an installation creates.
• API Reference: Official API documentation links for all services in the stack.

Development

Windows (powershell)

git clone https://github.com/soulis-1256/assemblrr.git
cd assemblrr
.\platform\windows\bootstrap-dev.ps1 -Full        # Full setup (copies files to WSL2 and runs setup.sh)
.\platform\windows\bootstrap-dev.ps1 -Full -Clean # Uninstalls the existing installation, then does a full setup
.\platform\windows\bootstrap-dev.ps1 -Update      # Sync changed files to WSL2 (no setup re-run, useful for cli changes)

Linux/WSL2

git clone https://github.com/soulis-1256/assemblrr.git
cd assemblrr
bash bin/setup.sh

Tests

make test                 # unit + compose config + shellcheck (if installed)
make test-unit            # pure shell unit tests (no Docker)
make test-compose         # docker compose config validation
make test-integration     # live qBittorrent + vpn-watchdog (opt-in)

Live integration mutates a running stack — requires ASSEMBLRR_ALLOW_LIVE_TEST=1. See tests/README.md.

Acknowledgments

Originally inspired by YAMS (rogsme/yams); assemblrr has since been rewritten and expanded into its own project.

License

GNU General Public License v3.0