Skip to content

woliveiras/corsarr

BranchesTags

Repository files navigation

Corsarr 🏴

🏴‍☠️ Navigate the high seas of media automation

Corsarr Logo

The easiest way to set up and manage your complete media automation stack with Docker Compose.

No configuration files to edit. No YAML to learn. Just answer a few questions.

📖 What is Corsarr?

Corsarr is a CLI tool that generates complete Docker Compose configurations for your media automation stack. It includes:

  • 🔍 Prowlarr - Search for torrents across multiple indexers
  • 🎬 Radarr - Automatically download and organize movies
  • 📺 Sonarr - Manage TV show downloads and library
  • 🎵 Lidarr - Music collection manager
  • 📚 LazyLibrarian - Book manager
  • 💬 Bazarr - Automatic subtitle downloads
  • ⬇️ qBittorrent - Torrent client for downloads
  • 🎭 Jellyfin - Stream your media library
  • 🎫 Jellyseerr - Request management interface
  • 🔓 FlareSolverr - Bypass Cloudflare restrictions
  • 📹 FileFlows - Transcode and optimize media
  • 🔒 Gluetun - VPN client (optional)

The CLI handles all the complexity - service dependencies, network configuration, environment variables, port management, and more.

⚡ Quick Start

Prerequisites

  • Docker & Docker Compose v2+ - Install here
  • Linux, macOS, or Windows with WSL2

Installation

Download the latest release for your platform:

Linux (AMD64) 
curl -sL https://github.com/woliveiras/corsarr/releases/latest/download/corsarr_linux_amd64.tar.gz | tar xz
sudo mv corsarr /usr/local/bin/
Linux (ARM64) 
curl -sL https://github.com/woliveiras/corsarr/releases/latest/download/corsarr_linux_arm64.tar.gz | tar xz
sudo mv corsarr /usr/local/bin/
macOS (Intel) 
curl -sL https://github.com/woliveiras/corsarr/releases/latest/download/corsarr_darwin_amd64.tar.gz | tar xz
sudo mv corsarr /usr/local/bin/
macOS (Apple Silicon) 
curl -sL https://github.com/woliveiras/corsarr/releases/latest/download/corsarr_darwin_arm64.tar.gz | tar xz
sudo mv corsarr /usr/local/bin/
Windows (PowerShell) 
# Download and extract
Invoke-WebRequest -Uri "https://github.com/woliveiras/corsarr/releases/latest/download/corsarr_windows_amd64.zip" -OutFile "corsarr.zip"
Expand-Archive -Path "corsarr.zip" -DestinationPath "C:\Program Files\corsarr"

# Add to PATH (permanent)
[Environment]::SetEnvironmentVariable("Path", $env:Path + ";C:\Program Files\corsarr", [EnvironmentVariableTarget]::Machine)

Or download manually from releases and extract to a folder in your PATH.

✨ Key Features

  • ✅ Interactive CLI - No configuration files to edit
  • ✅ Multi-language support - English, Portuguese, Spanish
  • ✅ VPN Support - Route traffic through Gluetun with WireGuard/OpenVPN
  • ✅ Automatic directory creation - Sets up all needed folders automatically
  • ✅ Port conflict detection - Validates ports before generating files
  • ✅ Profile management - Save and reuse configurations
  • ✅ Non-interactive mode - Perfect for automation and CI/CD
  • ✅ Cross-platform - Linux, macOS, Windows (AMD64 and ARM64)
  • ✅ Health monitoring - Check service status and resource usage
  • ✅ Dry-run mode - Preview configuration before creation

Usage

# 1. Generate your stack (interactive)
corsarr generate

# 2. Start everything
docker compose up -d

That's it! Your media automation stack is now running. 🎉

Access your services:

🎯 Usage

Interactive Mode

The CLI will ask you questions and generate everything automatically:

corsarr generate

You'll be asked about:

  1. Language - Choose your preferred language
  2. VPN - Do you want to route traffic through a VPN?
  3. Services - Select which services you need
  4. Configuration - Set paths, timezone, and user IDs
  5. Output Directory - Where to generate files (optional)
  6. VPN Details - If enabled, configure your VPN provider

The CLI creates:

  • docker-compose.yml - Complete service configuration
  • .env - All environment variables
  • All necessary directories - Config and data folders for each service

Then start your stack:

docker compose up -d

Useful Commands

Check if everything is healthy:

corsarr health
corsarr health --detailed  # With CPU/memory stats

Check for port conflicts:

corsarr check-ports
corsarr check-ports --suggest  # Get alternative ports

Preview configuration without creating files:

corsarr preview

Save your setup for later:

corsarr generate --save-profile --save-as my-setup

Reuse a saved configuration:

corsarr generate --profile my-setup

🚀 Advanced Usage

Generate with Custom Options

Specify output directory:

corsarr generate --output ~/my-media-stack

Enable VPN mode directly:

corsarr generate --vpn

Preview without creating files:

corsarr generate --dry-run

Use a specific language:

corsarr generate --language pt-br  # Portuguese
corsarr generate --language es     # Spanish

Profile Management

Profiles let you save and reuse configurations:

List all profiles:

corsarr profile list

Load a profile to see details:

corsarr profile load my-setup

Delete a profile:

corsarr profile delete old-setup

Export profile to share:

corsarr profile export my-setup backup.json

Import profile from file:

corsarr profile import backup.json
corsarr profile import backup.json --name new-name

Non-Interactive Mode (CI/CD)

For scripts, automation, and continuous deployment:

corsarr generate --no-interactive \
  --services "prowlarr,radarr,sonarr,jellyfin,qbittorrent" \
  --arr-path "/home/user/media" \
  --timezone "America/Sao_Paulo" \
  --puid "1000" \
  --pgid "1000" \
  --output ./stack

With VPN:

corsarr generate --no-interactive \
  --vpn \
  --vpn-provider protonvpn \
  --vpn-password "your-wireguard-key" \
  --services "radarr,sonarr,qbittorrent" \
  --arr-path "/media" \
  --timezone "UTC" \
  --puid "1000" \
  --pgid "1000"

Using configuration file:

# config.yaml
services:
  - prowlarr
  - radarr
  - sonarr
  - jellyfin
  - qbittorrent
arr_path: /home/user/media
timezone: America/Sao_Paulo
puid: 1000
pgid: 1000
corsarr generate --config config.yaml --no-interactive

All non-interactive flags:

  • --no-interactive - Skip all prompts
  • --services - Comma-separated service list
  • --arr-path - Base path for media library
  • --timezone - Timezone (e.g., America/Sao_Paulo)
  • --puid - User ID for file permissions
  • --pgid - Group ID for file permissions
  • --umask - File creation mask (default: 002)
  • --project-name - Docker Compose project name
  • --vpn - Enable VPN mode
  • --vpn-provider - VPN provider (required with --vpn)
  • --vpn-password - WireGuard key or OpenVPN password
  • --vpn-type - wireguard or openvpn (default: wireguard)
  • --config - Load from YAML/JSON config file
  • --profile - Load from saved profile

⚙️ Configuration

Environment Variables

The CLI will prompt you for these values:

Variable Description Example
ARRPATH Base path for media library /home/user/media/
TZ Your timezone America/Sao_Paulo
PUID User ID (run id -u) 1000
PGID Group ID (run id -g) 1000
UMASK File creation mask 002

Finding your PUID/PGID:

id $(whoami)
# Output: uid=1000(user) gid=1000(user)

VPN Configuration

When VPN is enabled, you'll configure:

  • Provider - nordvpn, protonvpn, expressvpn, etc. (see all supported)
  • Type - WireGuard (recommended) or OpenVPN
  • Credentials - Username/password or WireGuard private key
  • Port Forwarding - Enable for better torrent connectivity
  • DNS - Custom DNS server (default: 1.1.1.1)

Directory Structure

Corsarr automatically creates all necessary directories when generating files:

/your/media/path/
├── config/              # Service configurations
│   ├── radarr/
│   ├── sonarr/
│   ├── prowlarr/
│   ├── jellyfin/
│   └── ...
├── data/                # Media library
│   ├── movies/
│   ├── tvshows/
│   ├── music/
│   ├── books/
│   └── downloads/
└── backup/              # Automatic backups

If directories already exist, Corsarr will detect and reuse them without overwriting.

Network Modes

VPN Mode: All traffic routes through Gluetun

services:
  radarr:
    network_mode: "service:gluetun"

Bridge Mode: Direct network access (no VPN)

services:
  radarr:
    networks:
      - media

🔧 Initial Service Configuration

After starting your stack, configure each service:

1. qBittorrent

Access http://localhost:8080

  • Default login: admin / run docker logs qbittorrent for password
  • Set download path: Tools → Options → Downloads → /downloads
  • Change password: Tools → Options → Web UI → Authentication

2. Prowlarr

Access http://localhost:9696

  1. Add qBittorrent: Settings → Download Clients → Add qBittorrent

    • Host: qbittorrent
    • Port: 8081
    • Username/password from step 1

  2. Add indexers: Indexers → Add Indexer

    • Choose your preferred torrent sites
    • Configure credentials

  3. Copy API Key: Settings → General → Security → Copy API Key

3. Radarr (Movies) / Sonarr (TV Shows)

Access http://localhost:7878 (Radarr) or http://localhost:8989 (Sonarr)

  1. Add media folder:

    • Settings → Media Management → Add Root Folder
    • Radarr: /data/movies
    • Sonarr: /data/tvshows

  2. Add qBittorrent: Settings → Download Clients → Add qBittorrent

    • Host: qbittorrent
    • Port: 8081

  3. Connect to Prowlarr: Settings → Indexers → Add → Prowlarr

    • URL: http://prowlarr:9696
    • API Key: (from Prowlarr)

  4. Copy API Key: Settings → General → Security → Copy API Key

4. Bazarr (Subtitles)

Access http://localhost:6767

  1. Add subtitle providers: Settings → Providers
  2. Connect to Radarr: Settings → Radarr
    • Address: radarr
    • Port: 7878
    • API Key: (from Radarr)
  3. Connect to Sonarr: Settings → Sonarr
    • Address: sonarr
    • Port: 8989
    • API Key: (from Sonarr)

5. Jellyfin (Streaming)

Access http://localhost:8096

  1. Create admin account during initial setup
  2. Add libraries:
    • Movies: /data/movies
    • TV Shows: /data/tvshows
    • Music: /data/music
  3. Install Jellyfin apps on your devices

6. Jellyseerr (Requests)

Access http://localhost:5055

  1. Sign in with Jellyfin account
  2. Connect to Radarr/Sonarr: Settings → Services
  3. Allow users to request content

🆘 Troubleshooting

The full troubleshooting guide is on a dedicated file: Troubleshooting

🔒 Security Best Practices

  • Use VPN - Route torrent traffic through a VPN
  • Change default passwords - Update all service credentials
  • Restrict external access - Use firewall rules to limit ports
  • Use reverse proxy - Set up Nginx/Traefik with HTTPS for remote access
  • Keep updated - Run docker compose pull && docker compose up -d regularly

📚 Example: Downloading Legal Content

Try downloading public domain content to test your setup:

  1. Open Radarr (http://localhost:7878)
  2. Add movie: Click "Add New Movie"
  3. Search: Try "Night of the Living Dead (1968)"
  4. Monitor: Select "Monitored"
  5. Search: Click "Search" to find torrents

Watch it appear in qBittorrent, download, and show up in Jellyfin!

More public domain movies:

📦 Backup and Restore

Backup your configuration:

# Backup config directory (includes databases)
cp -r config/ ~/corsarr-backup/

# Backup your media (optional, but recommended)
rsync -av data/ /path/to/external/drive/

Restore from backup:

# Restore configuration
cp -r ~/corsarr-backup/ config/

# Start services
docker compose up -d

Automated backups: Each service creates automatic backups in config/[service]/Backups/

🔄 Updating

Update Corsarr CLI:

Download the latest release from GitHub Releases or use these commands:

# Linux/macOS - Download and replace
curl -sL https://github.com/woliveiras/corsarr/releases/latest/download/corsarr_linux_amd64.tar.gz | tar xz
sudo mv corsarr /usr/local/bin/

Update Docker containers:

docker compose pull
docker compose up -d

📄 License

See LICENSE file.

🔗 Links

Made with ❤️ by me for the community

About

Fast way for running for Radarr, Lidarr, Readarr, and Bazarr

Resources

Readme

License

MIT license

Code of conduct

Code of conduct

Contributing

Contributing
Activity

Stars

13 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases 7

v1.1.1 Latest
Dec 5, 2025
+ 6 releases

Sponsor this project

 
Learn more about GitHub Sponsors

Packages

No packages published

Languages