Cruncharr
Docker app from EasyMedia's Repository
Cruncharr is a self-hosted companion for keeping your personal anime media library organized.
Requirements
Overview
Readme
View on GitHubCruncharr
Cruncharr is a self-hosted app for organizing and maintaining your personal anime media library. It provides a headless backend, a REST API, and a single-page web interface.
Quick Deploy
Option 1: Docker Run (Recommended)
# Create directories
mkdir -p Cruncharr/config Cruncharr/downloads Cruncharr/widevine
# Run the container
docker run -d \
--name cruncharr \
-p 8585:8585 \
-v $(pwd)/Cruncharr/config:/config \
-v $(pwd)/Cruncharr/downloads:/downloads \
-v $(pwd)/Cruncharr/widevine:/widevine \
ghcr.io/mediavybz/cruncharr:latest
# Access the web interface
open http://localhost:8585
Option 2: Docker Compose
version: '3.8'
services:
cruncharr:
image: ghcr.io/mediavybz/cruncharr:latest
container_name: cruncharr
ports:
- "8585:8585"
volumes:
- ./config:/config
- ./downloads:/downloads
- ./widevine:/widevine
environment:
- CRUNCHYROLL_CONFIG_PATH=/config/cruncharr.yaml
restart: unless-stopped
docker-compose up -d
First Time Setup
- Open the web interface at
http://your-server:8585 - Browse or search without signing in. Direct Cruncharr downloads require Premium. With Sonarr enabled, guest and free-account requests can use Sonarr instead.
- Configure settings:
- Library directory:
/downloads(inside container) - Temp directory:
/tmp/cruncharr - Endpoints: use defaults (recommended)
- Audio languages:
ja-JP(Japanese) by default - Subtitles:
en-US(English) by default - Adjust these in Settings; changes save automatically
- Library directory:
See Sonarr requests for automatic series registration, completed-file imports, and guest requests.
Stable and beta versions
master contains the stable release; testing
contains beta changes. Compare matching branches when checking repository sync.
Use ghcr.io/mediavybz/cruncharr:testing to test beta fixes. The latest image follows
the stable release.
Volume Mounts
| Path | Purpose | Required |
|---|---|---|
/config |
Settings, tokens, catalog/activity history | Yes |
/downloads |
Your media library files | Yes |
/widevine |
Optional device files, if your source requires them | Optional |
Hardware Acceleration (GPU)
The image ships a full-GPU ffmpeg build (NVIDIA NVENC/CUDA, Intel QSV, AMD VAAPI/AMF, Vulkan). It is used by the Sync HW Accel option (Settings → Muxing). The dropdown lists only the GPUs currently available to the container — if you don't pass a GPU in, only "None (CPU)" appears.
Intel / AMD (VAAPI, QSV, AMF) — pass the render device:
devices:
- /dev/dri:/dev/dri
group_add:
- "video"
- "render"
NVIDIA (NVENC/CUDA) — requires the NVIDIA Container Toolkit on the host:
deploy:
resources:
reservations:
devices:
- driver: nvidia
count: all
capabilities: [gpu]
After (re)creating the container, open Settings → Muxing → Sync HW Accel and
the detected GPU(s) will be listed (e.g. NVIDIA (CUDA) or
Intel / AMD (VAAPI) (/dev/dri/renderD128)).
The runtime image is Debian-based; ffmpeg is a BtbN GPL build. NVIDIA encode needs the host driver injected by the NVIDIA Container Toolkit — the image alone does not bundle the driver.
Configuration
Config File
Create config/cruncharr.yaml:
crunchyroll:
email: "your@email.com"
password: "yourpassword"
use_beta_api: true
stream_endpoint:
endpoint: tv/android_tv
use_default: true
video: true
audio: true
download:
output_dir: /downloads
temp_dir: /tmp/cruncharr
filename: "${seriesTitle} - S${season}E${episode} [${height}p]"
quality_video: best
quality_audio: best
dub_languages:
- ja-JP # Default: Japanese only
soft_subs:
- en-US # Default: English only
simultaneous_downloads: 2
simultaneous_processing_jobs: 2
queue:
persist_queue: false
auto_download: false
history:
enabled: true
remove_missing_episodes: true
Building Images
The Dockerfile supports Linux AMD64 and ARM64. The published images include the
application and its media-processing tools. Use latest for stable releases or
testing for beta changes. See scripts/publish-docker.sh for the build command
and supported arguments.
API Endpoints
The backend exposes a REST API at http://localhost:8585/api/v1/:
GET /api/v1/auth/status- Auth statusPOST /api/v1/auth/login- Sign in with credentialsGET /api/v1/queue- Activity queuePOST /api/v1/queue- Add to queueGET /api/v1/series/search?query=QUERY- Search catalogGET /api/v1/series/{id}/episodes- Get episodesGET /api/v1/config- Get configurationPOST /api/v1/config- Update configuration
Features
- Web interface: Single-page app at
/- search the catalog, browse episodes, manage activity, configure settings - Sign-in: Account login with automatic token refresh
- Library: Select episodes with multi-track support and concurrent processing with progress tracking
- Queue: Add episodes to a queue, optional automatic processing, activity management
- History: Track your catalog, Sonarr integration, refresh series data
- Calendar: View upcoming release schedule
- Endpoints: Configurable device endpoints (Android TV, Web, Console) with working defaults
- Languages: Select audio and subtitle languages (default: Japanese audio, English subtitles)
- Muxing: Automatic muxing with ffmpeg/mkvtoolnix, MP4/MP3 output options
- Hardware acceleration: Full-GPU ffmpeg (NVENC/CUDA, QSV, VAAPI/AMF, Vulkan); GPU picker for sync that lists only the devices passed into the container
- Themes: Multiple selectable UI themes (Dark, Light, Cinematic, AMOLED, Nebula, Seerr) with a centralized design-token system
- Settings: Full settings panel with library, queue, history, notifications, and appearance options
- Notifications: Webhook support for completion/failure events
Troubleshooting
No Audio Track
- Check that
dub_languagesin config includes the item's audio language - Default is
ja-JPonly - add more languages in Settings if needed
Sign-in Issues
- Delete
config/token.jsonto force a fresh sign-in - Check that the stream endpoint "Use Default" is enabled
Reset All Settings
- Stop the container
- Delete
config/cruncharr.yaml - Restart the container - it will recreate with defaults
Device Files
- Some sources require
device_private_key.pemanddevice_client_id_blob.binin thewidevine/directory
Security
Cruncharr is built for private, self-hosted use (your LAN, or behind a reverse proxy). Before exposing it more widely:
- API key. The API is unauthenticated by default. If the container is reachable
from an untrusted network, set the
CRUNCHARR_API_KEYenv var — every/api/*request must then present it via theX-Api-Keyheader,Authorization: Bearer <key>, or (only for the browser Server-Sent-Events stream, which cannot send headers) the?apiKey=query param. The web interface prompts for the key once and stores it locally. Health checks stay exempt. - Allowed hosts. Set the
AllowedHostsenv var (semicolon-separated, e.g.192.168.1.10;cruncharr.lan;localhost) so the server only answers requests addressed to it. This stops DNS-rebinding, where a web page you visit points its own hostname at your LAN address to reach the API from your browser. State-changing API calls issued by other sites' pages are also refused outright (403); your own UI and anyCORS_ORIGINSentries are unaffected. - Brute-force limits.
POST /api/v1/auth/loginallows 10 attempts per minute per client address, and after 30 wrong API keys in a minute further wrong keys from that address are delayed and answered429. A correct key is never blocked. - TLS. The container serves plain HTTP. Terminate HTTPS at a reverse proxy (Caddy / nginx / Traefik) if it leaves your host.
- Credentials at rest. Your account login and any Sonarr/proxy keys live in
config/cruncharr.yamlin plaintext (file mode600) — the same model as Sonarr/Radarr. Protect the/configvolume accordingly. The config API never returns secrets (they read back as[configured]), and credentials are never written to logs. - CORS. Cross-origin API access defaults to
http://localhost:8585; override with theCORS_ORIGINSenv var (comma-separated) if you serve the UI elsewhere. - Outbound calls are guarded. Webhook URLs are rejected if they resolve to private/loopback/link-local addresses (SSRF protection); catalog images are proxied and cached server-side only from the source's own image host over HTTPS.
Development checks
See development checks for build and test prerequisites and validation commands.
Credits
This project is based on the original Crunchy-Downloader desktop application by Crunchy-DL. All core logic and media processing is ported from the upstream source, as required by its license.
- Upstream: https://github.com/Crunchy-DL/Crunchy-Downloader
- Upstream License: MIT License (Copyright (c) 2024 Crunchy DL)
- Port: Dockerized web interface with REST API and headless backend
License
MIT License - See upstream LICENSE for full text.
Categories
Related apps
Explore more like this
Explore allLinks
Details
ghcr.io/mediavybz/cruncharr:latestRuntime arguments
- Web UI
http://[IP]:[PORT:8585]/- Network
bridge- Shell
sh- Privileged
- false
- Extra Params
--security-opt=no-new-privileges:true --cap-drop=ALL --cap-add=CHOWN --cap-add=SETUID --cap-add=SETGID --cap-add=DAC_OVERRIDE --cap-add=FOWNER
Template configuration
HTTP port for the Cruncharr web interface.
- Target
- 8585
- Default
- 8585
- Value
- 8585
Stores settings, catalog, activity history and logs.
- Target
- /config
- Default
- /mnt/user/appdata/Cruncharr
- Value
- /mnt/user/appdata/Cruncharr
Where your library files are written and organized.
- Target
- /downloads
- Default
- /mnt/user/Media/Anime
- Value
- /mnt/user/Media/Anime
Optional path for source device files, if your source requires them.
- Target
- /widevine
- Default
- /mnt/user/appdata/Cruncharr/widevine
- Value
- /mnt/user/appdata/Cruncharr/widevine
User ID the container runs as. Match the owner of your config and media shares.
- Default
- 99
- Value
- 99
Group ID the container runs as.
- Default
- 100
- Value
- 100
Permission mask for new files. 002 creates group-writable files/directories so Sonarr can rename and import them when it shares PGID.
- Default
- 002
- Value
- 002
Optional: require this key to access the interface. Leave blank to disable.
- Target
- CRUNCHARR_API_KEY
Optional: pre-fill your source account email. Can also be set in the web interface.
- Target
- CRUNCHYROLL_EMAIL
Optional: pre-fill your source account password. Can also be set in the web interface.
- Target
- CRUNCHYROLL_PASSWORD
Optional: webhook for activity notifications.
- Target
- CRUNCHYROLL_WEBHOOK_URL